├── screenshots ├── boom.jpg ├── lms_webui.jpg ├── menuicon.png ├── githubstar.png ├── rl_repo_icon.png ├── contextmenu_years.jpg ├── ratedtracksmenu.jpg ├── rl_settings_preview.gif ├── ratings_npscreen_radio.jpg ├── ratings_npscreen_jivelite.jpg └── picoreplayer_show_more_rated_tracks.jpg ├── RatingsLight ├── HTML │ └── EN │ │ └── plugins │ │ └── RatingsLight │ │ ├── html │ │ ├── images │ │ │ ├── rl_icon.png │ │ │ ├── allsongs.png │ │ │ ├── coverplaceholder.png │ │ │ ├── ratedtracksmenuicon_svg.png │ │ │ └── ratedtracksmenuicon.svg │ │ ├── font │ │ │ └── fontawesome-light.woff │ │ ├── showratedtracks.html │ │ ├── showratedtrackslist.html │ │ ├── trackratinginfo.html │ │ └── ratealbumtracksoptions.html │ │ └── settings │ │ ├── subpage_chooser.html │ │ ├── dstm.html │ │ ├── export.html │ │ ├── basic.html │ │ ├── menus.html │ │ ├── backup.html │ │ └── import.html ├── custom-types.conf ├── install.xml ├── Settings │ ├── BaseSettings.pm │ ├── Basic.pm │ ├── Backup.pm │ ├── Menus.pm │ ├── Import.pm │ ├── DSTM.pm │ └── Export.pm ├── Importer.pm ├── Common.pm └── DontStopTheMusic.pm ├── .github ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── 02-featurerequest.yml │ └── 01-bug.yml └── workflows │ └── close_stale_issues.yml ├── README.md └── LICENSE /screenshots/boom.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/boom.jpg -------------------------------------------------------------------------------- /screenshots/lms_webui.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/lms_webui.jpg -------------------------------------------------------------------------------- /screenshots/menuicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/menuicon.png -------------------------------------------------------------------------------- /screenshots/githubstar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/githubstar.png -------------------------------------------------------------------------------- /screenshots/rl_repo_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/rl_repo_icon.png -------------------------------------------------------------------------------- /screenshots/contextmenu_years.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/contextmenu_years.jpg -------------------------------------------------------------------------------- /screenshots/ratedtracksmenu.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/ratedtracksmenu.jpg -------------------------------------------------------------------------------- /screenshots/rl_settings_preview.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/rl_settings_preview.gif -------------------------------------------------------------------------------- /screenshots/ratings_npscreen_radio.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/ratings_npscreen_radio.jpg -------------------------------------------------------------------------------- /screenshots/ratings_npscreen_jivelite.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/ratings_npscreen_jivelite.jpg -------------------------------------------------------------------------------- /screenshots/picoreplayer_show_more_rated_tracks.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/screenshots/picoreplayer_show_more_rated_tracks.jpg -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/images/rl_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/RatingsLight/HTML/EN/plugins/RatingsLight/html/images/rl_icon.png -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/images/allsongs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/RatingsLight/HTML/EN/plugins/RatingsLight/html/images/allsongs.png -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/font/fontawesome-light.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/RatingsLight/HTML/EN/plugins/RatingsLight/html/font/fontawesome-light.woff -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/images/coverplaceholder.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/RatingsLight/HTML/EN/plugins/RatingsLight/html/images/coverplaceholder.png -------------------------------------------------------------------------------- /RatingsLight/custom-types.conf: -------------------------------------------------------------------------------- 1 | svg svg image/svg+xml - 2 | ttf ttf application/x-font-ttf - 3 | woff woff application/font-woff - 4 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/images/ratedtracksmenuicon_svg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AF-1/lms-ratingslight/HEAD/RatingsLight/HTML/EN/plugins/RatingsLight/html/images/ratedtracksmenuicon_svg.png -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Lyrion Community Support Forum 4 | url: https://forums.lyrion.org/forum/user-forums/3rd-party-software/110057-announce-ratings-light 5 | about: Please ask questions that are not related to bug reports or feature requests in the Lyrion Community Forum. 6 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/showratedtracks.html: -------------------------------------------------------------------------------- 1 | [% item.prefix %] [% item.objectname %] 2 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/images/ratedtracksmenuicon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /RatingsLight/install.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | afc9f784-9381-2021-5477-479eca380cf5 4 | PLUGIN_RATINGSLIGHT 5 | Plugins::RatingsLight::Plugin 6 | 2.8.9 7 | PLUGIN_RATINGSLIGHT_DESC 8 | AF 9 | Plugins::RatingsLight::Importer 10 | plugins/RatingsLight/settings/basic.html 11 | plugins/RatingsLight/html/images/rl_icon.png 12 | https://github.com/AF-1/lms-ratingslight 13 | enabled 14 | 15 | Lyrion Music Server 16 | 8.2 17 | * 18 | 19 | 20 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/subpage_chooser.html: -------------------------------------------------------------------------------- 1 | 2 |
3 | [% IF subpages.size>1 %] 4 | [% WRAPPER settingGroup title="PLUGIN_RATINGSLIGHT_SETTINGS_SUBPAGE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_SUBPAGE_DESC" %] 5 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_FAQ_LINK_TEXT" | string %] 10 | [% END %] 11 |
12 | [% END %] 13 | -------------------------------------------------------------------------------- /.github/workflows/close_stale_issues.yml: -------------------------------------------------------------------------------- 1 | name: Close inactive issues 2 | on: 3 | workflow_dispatch: 4 | inputs: 5 | logLevel: 6 | description: 'Log level' 7 | required: true 8 | default: 'warning' 9 | type: choice 10 | options: 11 | - info 12 | - warning 13 | - debug 14 | schedule: 15 | - cron: "40 1 * * *" 16 | 17 | jobs: 18 | close-issues: 19 | runs-on: ubuntu-latest 20 | permissions: 21 | issues: write 22 | steps: 23 | - uses: actions/stale@v5 24 | with: 25 | days-before-issue-stale: 30 26 | days-before-issue-close: 14 27 | exempt-issue-assignees: "AF-1" 28 | stale-issue-label: "stale - closing soon" 29 | stale-issue-message: "This issue is stale because it has been open for 30 days with no activity. It will be closed after another 14 days of inactivity." 30 | close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale." 31 | days-before-pr-stale: -1 32 | days-before-pr-close: -1 33 | repo-token: ${{ secrets.GITHUB_TOKEN }} 34 | -------------------------------------------------------------------------------- /RatingsLight/Settings/BaseSettings.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::BaseSettings; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Slim::Web::Settings); 28 | 29 | use Slim::Utils::Log; 30 | use Slim::Utils::Prefs; 31 | use Slim::Utils::Misc; 32 | use Slim::Utils::Strings qw(string); 33 | 34 | my $prefs = preferences('plugin.ratingslight'); 35 | my $log = logger('plugin.ratingslight'); 36 | 37 | my $plugin; 38 | my %subPages = (); 39 | 40 | sub new { 41 | my $class = shift; 42 | $plugin = shift; 43 | my $default = shift; 44 | 45 | if (!defined($default) || !$default) { 46 | if ($class->can('page') && $class->can('handler')) { 47 | if (UNIVERSAL::can("Slim::Web::Pages","addPageFunction")) { 48 | Slim::Web::Pages->addPageFunction($class->page, $class); 49 | } else { 50 | Slim::Web::HTTP::addPageFunction($class->page, $class); 51 | } 52 | } 53 | } else { 54 | $class->SUPER::new(); 55 | } 56 | $subPages{$class->name()} = $class; 57 | return $class; 58 | } 59 | 60 | sub handler { 61 | my ($class, $client, $params) = @_; 62 | 63 | my %currentSubPages = (); 64 | for my $key (keys %subPages) { 65 | my $pages = $subPages{$key}->pages($client,$params); 66 | for my $page (@{$pages}) { 67 | $currentSubPages{$page->{'name'}} = $page->{'page'}; 68 | } 69 | } 70 | $params->{'subpages'} = \%currentSubPages; 71 | $params->{'subpage'} = $class->currentPage($client,$params); 72 | return $class->SUPER::handler($client, $params); 73 | } 74 | 75 | 1; 76 | -------------------------------------------------------------------------------- /RatingsLight/Importer.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Importer; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use Slim::Utils::Prefs; 28 | use Slim::Utils::Log; 29 | use Slim::Schema; 30 | use Plugins::RatingsLight::Common ':all'; 31 | 32 | my $log = logger('plugin.ratingslight'); 33 | my $prefs = preferences('plugin.ratingslight'); 34 | my $serverPrefs = preferences('server'); 35 | 36 | sub initPlugin { 37 | main::DEBUGLOG && $log->is_debug && $log->debug('importer module init'); 38 | if ($prefs->get('prescanbackup')) { 39 | main::DEBUGLOG && $log->is_debug && $log->debug('creating pre-scan backup before scan process starts'); 40 | createBackup(); 41 | } 42 | toggleUseImporter(); 43 | } 44 | 45 | sub toggleUseImporter { 46 | if ($prefs->get('autoscan')) { 47 | main::DEBUGLOG && $log->is_debug && $log->debug('enabling importer'); 48 | Slim::Music::Import->addImporter('Plugins::RatingsLight::Importer', { 49 | 'type' => 'post', 50 | 'weight' => 199, 51 | 'use' => 1, 52 | }); 53 | } else { 54 | main::DEBUGLOG && $log->is_debug && $log->debug('disabling importer'); 55 | Slim::Music::Import->useImporter('Plugins::RatingsLight::Importer',0); 56 | } 57 | } 58 | 59 | sub startScan { 60 | main::DEBUGLOG && $log->is_debug && $log->debug('starting importer'); 61 | my $filetagtype = $prefs->get('filetagtype'); 62 | if ($prefs->get('filetagtype')) { 63 | importRatingsFromCommentTags(); 64 | } else { 65 | importRatingsFromBPMTags(); 66 | } 67 | Slim::Music::Import->endImporter(__PACKAGE__); 68 | } 69 | 70 | 1; 71 | -------------------------------------------------------------------------------- /RatingsLight/Settings/Basic.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::Basic; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Plugins::RatingsLight::Settings::BaseSettings); 28 | 29 | use Slim::Utils::Log; 30 | use Slim::Utils::Prefs; 31 | use Slim::Utils::Misc; 32 | use Slim::Utils::Strings; 33 | 34 | my $prefs = preferences('plugin.ratingslight'); 35 | my $log = logger('plugin.ratingslight'); 36 | 37 | my $plugin; 38 | 39 | sub new { 40 | my $class = shift; 41 | $plugin = shift; 42 | $class->SUPER::new($plugin,1); 43 | } 44 | 45 | sub name { 46 | return Slim::Web::HTTP::CSRF->protectName('PLUGIN_RATINGSLIGHT'); 47 | } 48 | 49 | sub page { 50 | return Slim::Web::HTTP::CSRF->protectURI('plugins/RatingsLight/settings/basic.html'); 51 | } 52 | 53 | sub currentPage { 54 | return Slim::Utils::Strings::string('PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS'); 55 | } 56 | 57 | sub pages { 58 | my %page = ( 59 | 'name' => Slim::Utils::Strings::string('PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS'), 60 | 'page' => page(), 61 | ); 62 | my @pages = (\%page); 63 | return \@pages; 64 | } 65 | 66 | sub prefs { 67 | return ($prefs, qw(enableIRremotebuttons topratedminrating rlparentfolderpath uselogfile userecentlyratedplaylist recentlymaxcount postscanscheduledelay)); 68 | } 69 | 70 | sub handler { 71 | my ($class, $client, $paramRef) = @_; 72 | my $result = undef; 73 | my $callHandler = 1; 74 | if ($paramRef->{'saveSettings'}) { 75 | $result = $class->SUPER::handler($client, $paramRef); 76 | $callHandler = 0; 77 | } 78 | if ($paramRef->{'clearallratingsnow'}) { 79 | if ($callHandler) { 80 | $result = $class->SUPER::handler($client, $paramRef); 81 | } 82 | Plugins::RatingsLight::Plugin::clearAllRatings(); 83 | } elsif ($paramRef->{'adjustallratingsnow'}) { 84 | if ($callHandler) { 85 | $result = $class->SUPER::handler($client, $paramRef); 86 | } 87 | Plugins::RatingsLight::Plugin::adjustRatings(); 88 | } elsif ($callHandler) { 89 | $result = $class->SUPER::handler($client, $paramRef); 90 | } 91 | return $result; 92 | } 93 | 94 | sub beforeRender { 95 | my ($class, $paramRef) = @_; 96 | my $advMode = $prefs->get('advmode'); 97 | $paramRef->{'advmode'} = 1 if $advMode; 98 | } 99 | 100 | 1; 101 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/02-featurerequest.yml: -------------------------------------------------------------------------------- 1 | name: 💡 Feature request 2 | description: Suggest an idea for this project 3 | title: "[FEATURE REQUEST] your title here" 4 | labels: ["feature request / enhancement"] 5 | assignees: 6 | - AF-1 7 | 8 | body: 9 | - type: checkboxes 10 | attributes: 11 | label: Is there an existing issue for this? 12 | description: Please search to see if an issue (open or closed) already exists for your feature request. 13 | options: 14 | - label: I have searched the existing issues 15 | required: true 16 | - type: markdown 17 | attributes: 18 | value: "

" 19 | - type: checkboxes 20 | attributes: 21 | label: Is your request mentioned in the FAQ? 22 | description: If the repository has a FAQ section, please see if your feature request is mentioned there. 23 | options: 24 | - label: I have searched the FAQ 25 | required: true 26 | - type: markdown 27 | attributes: 28 | value: "

" 29 | - type: textarea 30 | attributes: 31 | label: Is your feature request related to a problem? 32 | description: A clear and concise description of what the problem is. 33 | validations: 34 | required: false 35 | - type: markdown 36 | attributes: 37 | value: "

" 38 | - type: textarea 39 | attributes: 40 | label: Describe the solution / feature you'd like 41 | description: A clear and concise description of what you want to happen 42 | validations: 43 | required: true 44 | - type: markdown 45 | attributes: 46 | value: "

" 47 | - type: textarea 48 | attributes: 49 | label: "Describe alternatives you've considered" 50 | description: "A clear and concise description of any alternative solutions or features you've considered." 51 | validations: 52 | required: false 53 | - type: markdown 54 | attributes: 55 | value: "

" 56 | - type: input 57 | attributes: 58 | label: LMS version 59 | description: What version of LMS are you running? 60 | placeholder: "Example: 9.0.1" 61 | validations: 62 | required: true 63 | - type: markdown 64 | attributes: 65 | value: "
" 66 | - type: input 67 | attributes: 68 | label: Plugin version 69 | description: What version of the plugin are you running? 70 | placeholder: "Example: 1.0.3" 71 | validations: 72 | required: true 73 | - type: markdown 74 | attributes: 75 | value: "

" 76 | - type: textarea 77 | attributes: 78 | label: Anything else? 79 | description: | 80 | Add any other context or **screenshots** about the feature request here. 81 | 82 | Tip: You can attach images (screenshots) or files by clicking this area to highlight it and then dragging files in. 83 | validations: 84 | required: false 85 | - type: markdown 86 | attributes: 87 | value: "

" 88 | - type: markdown 89 | attributes: 90 | value: | 91 | ## ⭐ Help others discover this project 92 | If you find this project useful, giving it a [**star**](https://github.com/AF-1/lms-ratingslight#-help-others-discover-this-project) is a great way to show your support and help others discover it. Thank you. 93 | - type: markdown 94 | attributes: 95 | value: "

" 96 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/dstm.html: -------------------------------------------------------------------------------- 1 | 2 | [% page = "PLUGIN_RATINGSLIGHT" %] 3 | [% PROCESS settings/header.html %] 4 | 5 | [% PROCESS plugins/RatingsLight/settings/subpage_chooser.html %] 6 | 7 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_PERCENTAGE_RATED" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_PERCENTAGE_RATED_DESC" %] 8 | 9 | [% END %] 10 |
11 | 12 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_PERCENTAGE_TOPRATED" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_PERCENTAGE_TOPRATED_DESC" %] 13 | 14 | [% END %] 15 |
16 | 17 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_NUMSEEDTRACKS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_NUMSEEDTRACKS_DESC" %] 18 | 19 | [% END %] 20 |
21 | 22 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_PLAYEDTRACKSTOKEEP" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_PLAYEDTRACKSTOKEEP_DESC" %] 23 | 24 | [% END %] 25 |
26 | 27 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_BATCHSIZENEWTRACKS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_BATCHSIZENEWTRACKS_DESC" %] 28 | 29 | [% END %] 30 |
31 | 32 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_MINTRACKDUR" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_MINTRACKDUR_DESC" %] 33 | 34 | [% END %] 35 |
36 | 37 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_EXCLUDEDGENRES" desc="PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_EXCLUDEDGENRES_DESC" %] 38 |
[% "PLUGIN_RATINGSLIGHT_SETTINGS_DSTM_CHOOSEEXLUDEGENRES" | string %]: 39 | [% USE table genrelistsorted, cols=3, pad=0 %] 40 | [%- FOREACH genrerow = table.rows %] 41 | 42 | [%- FOREACH genre = genrerow %] 43 | [%- genreid = "genre_" _ genrelist.item("$genre").id %] 44 | 48 | [%- END %] 49 | 50 | [%- END %] 51 |
45 | 46 | 47 |
52 |
53 | [% END %] 54 | 55 | [% PROCESS settings/footer.html %] 56 | -------------------------------------------------------------------------------- /RatingsLight/Settings/Backup.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::Backup; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Plugins::RatingsLight::Settings::BaseSettings); 28 | use Plugins::RatingsLight::Common ':all'; 29 | 30 | use Slim::Utils::Log; 31 | use Slim::Utils::Prefs; 32 | use Slim::Utils::Misc; 33 | use Slim::Utils::Strings; 34 | 35 | my $prefs = preferences('plugin.ratingslight'); 36 | my $log = logger('plugin.ratingslight'); 37 | 38 | my $plugin; 39 | 40 | sub new { 41 | my $class = shift; 42 | $plugin = shift; 43 | $class->SUPER::new($plugin); 44 | } 45 | 46 | sub name { 47 | return Slim::Web::HTTP::CSRF->protectName('PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_RESTORE'); 48 | } 49 | 50 | sub page { 51 | return Slim::Web::HTTP::CSRF->protectURI('plugins/RatingsLight/settings/backup.html'); 52 | } 53 | 54 | sub currentPage { 55 | return name(); 56 | } 57 | 58 | sub pages { 59 | my %page = ( 60 | 'name' => name(), 61 | 'page' => page(), 62 | ); 63 | my @pages = (\%page); 64 | return \@pages; 65 | } 66 | 67 | sub prefs { 68 | return ($prefs, qw(autodeletebackups scheduledbackups backuptime prescanbackup backupsdaystokeep backupfilesmin restorefile selectiverestore clearallbeforerestore)); 69 | } 70 | 71 | sub handler { 72 | my ($class, $client, $paramRef) = @_; 73 | my $result = undef; 74 | my $callHandler = 1; 75 | if ($paramRef->{'saveSettings'}) { 76 | $result = $class->SUPER::handler($client, $paramRef); 77 | $callHandler = 0; 78 | } 79 | if ($paramRef->{'backup'}) { 80 | if ($callHandler) { 81 | $paramRef->{'saveSettings'} = 1; 82 | $result = $class->SUPER::handler($client, $paramRef); 83 | } 84 | createBackup(); 85 | } elsif ($paramRef->{'restore'}) { 86 | if ($callHandler) { 87 | $paramRef->{'saveSettings'} = 1; 88 | $result = $class->SUPER::handler($client, $paramRef); 89 | } 90 | my $selectedfile = $paramRef->{'pref_restorefile'}; 91 | main::DEBUGLOG && $log->is_debug && $log->debug("restorefile = ".$selectedfile); 92 | if ((!defined ($paramRef->{'pref_restorefile'})) || ($paramRef->{'pref_restorefile'} eq '')) { 93 | $paramRef->{'restoremissingfile'} = 1; 94 | $result = $class->SUPER::handler($client, $paramRef); 95 | } elsif ($selectedfile !~ /\.xml/i) { 96 | $paramRef->{'restoremissingfile'} = 2; 97 | $result = $class->SUPER::handler($client, $paramRef); 98 | } else { 99 | Plugins::RatingsLight::Plugin::restoreFromBackup(); 100 | } 101 | } elsif ($callHandler) { 102 | $result = $class->SUPER::handler($client, $paramRef); 103 | } 104 | 105 | my $RLfolderpath = $prefs->get('rlfolderpath'); 106 | $prefs->set('restorefile', $RLfolderpath); 107 | $result = $class->SUPER::handler($client, $paramRef); 108 | return $result; 109 | } 110 | 111 | 1; 112 | -------------------------------------------------------------------------------- /RatingsLight/Settings/Menus.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::Menus; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Plugins::RatingsLight::Settings::BaseSettings); 28 | 29 | use Slim::Utils::Log; 30 | use Slim::Utils::Prefs; 31 | use Slim::Utils::Misc; 32 | use Slim::Utils::Strings; 33 | use Slim::Utils::Strings qw(string cstring); 34 | 35 | my $prefs = preferences('plugin.ratingslight'); 36 | my $log = logger('plugin.ratingslight'); 37 | 38 | my $plugin; 39 | 40 | sub new { 41 | my $class = shift; 42 | $plugin = shift; 43 | $class->SUPER::new($plugin); 44 | } 45 | 46 | sub name { 47 | return Slim::Web::HTTP::CSRF->protectName('PLUGIN_RATINGSLIGHT_SETTINGS_MENUS'); 48 | } 49 | 50 | sub page { 51 | return Slim::Web::HTTP::CSRF->protectURI('plugins/RatingsLight/settings/menus.html'); 52 | } 53 | 54 | sub currentPage { 55 | return name(); 56 | } 57 | 58 | sub pages { 59 | my %page = ( 60 | 'name' => Slim::Utils::Strings::string('PLUGIN_RATINGSLIGHT_SETTINGS_MENUS'), 61 | 'page' => page(), 62 | ); 63 | my @pages = (\%page); 64 | return \@pages; 65 | } 66 | 67 | sub prefs { 68 | return ($prefs, qw(displayratingchar usehalfstarratings showratedtracksmenus browsemenus_artists browsemenus_genres browsemenus_tracks browsemenus_sourceVL_id enableipengtslegacyrating ratingcontextmenupos ratedtracksweblimit ratedtrackscontextmenulimit)); 69 | } 70 | 71 | sub handler { 72 | my ($class, $client, $paramRef) = @_; 73 | if ($paramRef->{'saveSettings'}) { } 74 | my $result = $class->SUPER::handler($client, $paramRef); 75 | return $result; 76 | } 77 | 78 | sub beforeRender { 79 | my ($class, $paramRef) = @_; 80 | 81 | my @items; 82 | my $libraries = Slim::Music::VirtualLibraries->getLibraries(); 83 | main::DEBUGLOG && $log->is_debug && $log->debug("Menu Settings - ALL libraries: ".Data::Dump::dump($libraries)); 84 | 85 | my $currentLibrary = $prefs->get('browsemenus_sourceVL_id'); 86 | main::DEBUGLOG && $log->is_debug && $log->debug("current browsemenus_sourceVL_id = ".Data::Dump::dump($currentLibrary)); 87 | 88 | while (my ($k, $v) = each %{$libraries}) { 89 | my $count = Slim::Music::VirtualLibraries->getTrackCount($k); 90 | my $name = $libraries->{$k}->{'name'}; 91 | my $displayName = Slim::Utils::Unicode::utf8decode($name, 'utf8').' ('.Slim::Utils::Misc::delimitThousands($count).($count == 1 ? ' '.string("PLUGIN_RATINGSLIGHT_LANGSTRING_TRACK") : ' '.string("PLUGIN_RATINGSLIGHT_LANGSTRING_TRACKS")).')'; 92 | 93 | my $VLID = $libraries->{$k}->{'id'}; 94 | main::DEBUGLOG && $log->is_debug && $log->debug("VL: ".$displayName." - VLID:".$VLID); 95 | unless (starts_with($VLID, "RATINGSLIGHT_") == 0) { 96 | push @items, { 97 | name => $displayName, 98 | sortName => Slim::Utils::Unicode::utf8decode($name, 'utf8'), 99 | library_id => $k, 100 | }; 101 | } 102 | } 103 | @items = sort { $a->{sortName} cmp $b->{sortName} } @items; 104 | unshift @items, { 105 | name => string("PLUGIN_RATINGSLIGHT_LANGSTRING_COMPLETELIB"), 106 | sortName => "Complete Library", 107 | library_id => undef, 108 | }; 109 | main::DEBUGLOG && $log->is_debug && $log->debug("libraries for settings page: ".Data::Dump::dump(\@items)); 110 | $paramRef->{virtuallibraries} = \@items; 111 | } 112 | 113 | sub starts_with { 114 | # complete_string, start_string, position 115 | return rindex($_[0], $_[1], 0); 116 | # 0 for yes, -1 for no 117 | } 118 | 119 | 1; 120 | -------------------------------------------------------------------------------- /RatingsLight/Settings/Import.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::Import; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Plugins::RatingsLight::Settings::BaseSettings); 28 | use Plugins::RatingsLight::Common ':all'; 29 | 30 | use Slim::Utils::Log; 31 | use Slim::Utils::Prefs; 32 | use Slim::Utils::Misc; 33 | use Slim::Utils::Strings; 34 | 35 | my $prefs = preferences('plugin.ratingslight'); 36 | my $log = logger('plugin.ratingslight'); 37 | 38 | my $plugin; 39 | 40 | sub new { 41 | my $class = shift; 42 | $plugin = shift; 43 | $class->SUPER::new($plugin); 44 | } 45 | 46 | sub name { 47 | return Slim::Web::HTTP::CSRF->protectName('PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT'); 48 | } 49 | 50 | sub page { 51 | return Slim::Web::HTTP::CSRF->protectURI('plugins/RatingsLight/settings/import.html'); 52 | } 53 | 54 | sub currentPage { 55 | return name(); 56 | } 57 | 58 | sub pages { 59 | my %page = ( 60 | 'name' => name(), 61 | 'page' => page(), 62 | ); 63 | my @pages = (\%page); 64 | return \@pages; 65 | } 66 | 67 | sub prefs { 68 | return ($prefs, qw(rating_keyword_prefix rating_keyword_suffix autoscan ratethisplaylistid ratethisplaylistrating playlistimport_maxtracks tagimport_dontunrate filetagtype)); 69 | } 70 | 71 | sub handler { 72 | my ($class, $client, $paramRef) = @_; 73 | my $result = undef; 74 | my $callHandler = 1; 75 | if ($paramRef->{'saveSettings'}) { 76 | $result = $class->SUPER::handler($client, $paramRef); 77 | $callHandler = 0; 78 | } 79 | if ($paramRef->{'manimport'}) { 80 | if ($callHandler) { 81 | $paramRef->{'saveSettings'} = 1; 82 | $result = $class->SUPER::handler($client, $paramRef); 83 | } 84 | my $filetagtype = $prefs->get('filetagtype'); 85 | if ($filetagtype == 1) { 86 | main::DEBUGLOG && $log->is_debug && $log->debug("rating keyword prefix = ".$paramRef->{'pref_rating_keyword_prefix'}); 87 | main::DEBUGLOG && $log->is_debug && $log->debug("rating keyword suffix = ".$paramRef->{'pref_rating_keyword_suffix'}); 88 | if (((!defined ($paramRef->{'pref_rating_keyword_prefix'})) || ($paramRef->{'pref_rating_keyword_prefix'} eq '')) && ((!defined ($paramRef->{'pref_rating_keyword_suffix'})) || ($paramRef->{'pref_rating_keyword_suffix'} eq ''))) { 89 | $paramRef->{'missingkeywords'} = 1; 90 | $result = $class->SUPER::handler($client, $paramRef); 91 | } else { 92 | importRatingsFromCommentTags(); 93 | Plugins::RatingsLight::Plugin::setRefreshTimer(1); 94 | } 95 | } elsif ($filetagtype == 0) { 96 | importRatingsFromBPMTags(); 97 | Plugins::RatingsLight::Plugin::setRefreshTimer(1); 98 | } 99 | } elsif ($paramRef->{'rateplaylistnow'}) { 100 | if ($callHandler) { 101 | $paramRef->{'saveSettings'} = 1; 102 | $result = $class->SUPER::handler($client, $paramRef); 103 | } 104 | Plugins::RatingsLight::Plugin::importRatingsFromPlaylist(); 105 | } elsif ($callHandler) { 106 | $result = $class->SUPER::handler($client, $paramRef); 107 | } 108 | 109 | return $result; 110 | } 111 | 112 | sub beforeRender { 113 | my ($class, $paramRef) = @_; 114 | my @allplaylists = (); 115 | my @localPlaylists = (); 116 | my $queryresult = Slim::Control::Request::executeRequest(undef, ['playlists', '0', '500', 'tags:x']); 117 | my $playlistarray = $queryresult->getResult("playlists_loop"); 118 | 119 | foreach my $thisPlaylist (@{$playlistarray}) { 120 | push @localPlaylists, $thisPlaylist if $thisPlaylist->{'remote'} == 0; 121 | } 122 | my $playlistcount = scalar (@localPlaylists); 123 | 124 | if ($playlistcount > 0) { 125 | my @sortedarray = sort {$a->{id} <=> $b->{id}} @localPlaylists; 126 | main::DEBUGLOG && $log->is_debug && $log->debug("sorted playlists = ".Data::Dump::dump(\@sortedarray)); 127 | $paramRef->{playlistcount} = $playlistcount; 128 | $paramRef->{allplaylists} = \@sortedarray; 129 | } 130 | } 131 | 132 | 1; 133 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/export.html: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 12 | 13 | [% page = "PLUGIN_RATINGSLIGHT" %] 14 | [% PROCESS settings/header.html %] 15 | 16 | [% PROCESS plugins/RatingsLight/settings/subpage_chooser.html %] 17 | 18 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PLAYLISTS_TO_FILES" desc="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PLAYLISTS_TO_FILES_DESC" %] 19 | 24 |

25 | 26 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_INPROGRESS" | string %] 27 | [% END %] 28 |
29 | 30 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PLAYLISTS_SINGLE_FILE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PLAYLISTS_SINGLE_FILE_DESC" %] 31 | 35 | [% END %] 36 |
37 | 38 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PLAYLISTS_ONLY_DIFF" desc="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PLAYLISTS_ONLY_DIFF_DESC" %] 39 | 43 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_SELFILETAG" | string %]: [% IF curselfiletag == 0 %][% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_FILETAGTYPE_BPM" | string %][% ELSE %][% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_FILETAGTYPE_COMMENT" | string %][% END %] 44 | [% END %] 45 |

46 | 47 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PATHSUBSTITUTION" desc="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PATHSUBSTITUTION_DESC" %] 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | [% FOREACH exportbasefilepath = exportbasefilepathmatrix; idx = loop.count %] 57 | 58 | 63 | 68 | 69 | [% END %] 70 |
[% "PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PATHSUBSTITUTION_LMSPATH" | string %][% "PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_PATHSUBSTITUTION_NEWPATH" | string %]
59 | 62 | 64 | 67 |
71 | [% END %] 72 |

73 | 74 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_EXTENSIONSUBSTITUTION" desc="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_EXTENSIONSUBSTITUTION_DESC" %] 75 | 76 | [% END %] 77 | 78 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_EXTENSIONEXCEPTIONS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT_EXTENSIONEXCEPTIONS_DESC" %] 79 | 80 | [% END %] 81 | 82 | [% PROCESS settings/footer.html %] 83 | -------------------------------------------------------------------------------- /RatingsLight/Settings/DSTM.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::DSTM; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Plugins::RatingsLight::Settings::BaseSettings); 28 | 29 | use Slim::Utils::Log; 30 | use Slim::Utils::Prefs; 31 | use Slim::Utils::Misc; 32 | use Slim::Utils::Strings; 33 | 34 | 35 | my $prefs = preferences('plugin.ratingslight'); 36 | my $log = logger('plugin.ratingslight'); 37 | 38 | my $plugin; 39 | 40 | sub new { 41 | my $class = shift; 42 | $plugin = shift; 43 | $class->SUPER::new($plugin); 44 | } 45 | 46 | sub name { 47 | return Slim::Web::HTTP::CSRF->protectName('PLUGIN_RATINGSLIGHT_SETTINGS_DSTM'); 48 | } 49 | 50 | sub page { 51 | return Slim::Web::HTTP::CSRF->protectURI('plugins/RatingsLight/settings/dstm.html'); 52 | } 53 | 54 | sub currentPage { 55 | return name(); 56 | } 57 | 58 | sub pages { 59 | my %page = ( 60 | 'name' => name(), 61 | 'page' => page(), 62 | ); 63 | my @pages = (\%page); 64 | return \@pages; 65 | } 66 | 67 | sub prefs { 68 | return ($prefs, qw(dstm_minTrackDuration dstm_percentagerated dstm_percentagetoprated dstm_num_seedtracks dstm_playedtrackstokeep dstm_batchsizenewtracks)); 69 | } 70 | 71 | sub handler { 72 | my ($class, $client, $paramRef) = @_; 73 | my $result = undef; 74 | my $callHandler = 1; 75 | if ($paramRef->{'saveSettings'}) { 76 | 77 | my $excludegenres_namelist; 78 | my $genres = getGenres(); 79 | 80 | # %{$paramRef} will contain a key called genre_ for each ticked checkbox on the page 81 | for my $genre (keys %{$genres}) { 82 | if ($paramRef->{'genre_'.$genres->{$genre}->{'id'}}) { 83 | push (@{$excludegenres_namelist}, $genre); 84 | } 85 | } 86 | main::DEBUGLOG && $log->is_debug && $log->debug('*** SAVED *** excludegenres_namelist = '.Data::Dump::dump($excludegenres_namelist)); 87 | $prefs->set('excludegenres_namelist', $excludegenres_namelist); 88 | 89 | $result = $class->SUPER::handler($client, $paramRef); 90 | $callHandler = 0; 91 | } elsif ($callHandler) { 92 | $result = $class->SUPER::handler($client, $paramRef); 93 | } 94 | 95 | return $result; 96 | } 97 | 98 | sub beforeRender { 99 | my ($class, $paramRef) = @_; 100 | 101 | my $genrelist = getGenres(); 102 | main::DEBUGLOG && $log->is_debug && $log->debug('genrelist (all genres) = '.Data::Dump::dump($genrelist)); 103 | $paramRef->{'genrelist'} = $genrelist; 104 | 105 | my $genrelistsorted = [getSortedGenres()]; 106 | main::DEBUGLOG && $log->is_debug && $log->debug('genrelistsorted (just names) = '.Data::Dump::dump($genrelistsorted)); 107 | $paramRef->{'genrelistsorted'} = $genrelistsorted; 108 | } 109 | 110 | sub getGenres { 111 | my $genres = {}; 112 | my $genreSQL = "select genres.id,genres.name,genres.namesearch from genres order by namesort asc"; 113 | 114 | my $excludenamelist = $prefs->get('excludegenres_namelist'); 115 | my %exclude; 116 | if (defined $excludenamelist) { 117 | %exclude = map { $_ => 1 } @{$excludenamelist}; # Extract each genre name into a hash 118 | } 119 | 120 | my $i = 0; 121 | my $sth = Slim::Schema->dbh->prepare($genreSQL); 122 | main::DEBUGLOG && $log->is_debug && $log->debug("Executing: $genreSQL"); 123 | eval { 124 | $sth->execute() or do { 125 | $log->error("Error executing: $genreSQL"); 126 | $genreSQL = undef; 127 | }; 128 | 129 | my ($id, $name, $namesearch); 130 | $sth->bind_col(1, \$id); 131 | $sth->bind_col(2, \$name); 132 | $sth->bind_col(3, \$namesearch); 133 | while($sth->fetch()) { 134 | my %item = ( 135 | 'id' => Slim::Utils::Unicode::utf8decode($id, 'utf8'), 136 | 'name' => Slim::Utils::Unicode::utf8decode($name, 'utf8'), 137 | 'namesearch' => Slim::Utils::Unicode::utf8decode($namesearch, 'utf8'), 138 | 'chosen' => $exclude{$namesearch} ? 'yes' : '', 139 | 'sort' => $i++, 140 | ); 141 | $genres->{$namesearch} = \%item; 142 | } 143 | $sth->finish(); 144 | }; 145 | if ($@) { 146 | $log->error("Database error: $DBI::errstr"); 147 | } 148 | 149 | main::DEBUGLOG && $log->is_debug && $log->debug('genre list before render = '.Data::Dump::dump($genres)); 150 | return $genres; 151 | } 152 | 153 | sub getSortedGenres { 154 | my $genres = getGenres(); 155 | return sort { 156 | $genres->{$a}->{sort} <=> $genres->{$b}->{sort}; 157 | } keys %{$genres}; 158 | } 159 | 160 | 1; 161 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/basic.html: -------------------------------------------------------------------------------- 1 | 6 | 7 | 10 | 11 | [% page = "PLUGIN_RATINGSLIGHT" %] 12 | [% PROCESS settings/header.html %] 13 | 14 | [% PROCESS plugins/RatingsLight/settings/subpage_chooser.html %] 15 | 16 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_REMOTEBUTTONS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_REMOTEBUTTONS_DESC" %] 17 | 21 | [% END %] 22 |
23 | 24 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_TOPRATED_MINRATING" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_TOPRATED_MINRATING_DESC" %] 25 | 30 | [% END %] 31 |
32 | 33 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_USERECENTLYRATEDPLAYLIST" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_USERECENTLYRATEDPLAYLIST_DESC" %] 34 | 38 | [% END %] 39 |
40 | 41 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_USERECENTLYRATEDPLAYLIST_MAXCOUNT" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_USERECENTLYRATEDPLAYLIST_MAXCOUNT_DESC" %] 42 | 43 | [% END %] 44 |
45 | 46 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_USELOGFILE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_USELOGFILE_DESC" %] 47 | 51 | [% END %] 52 |
53 | 54 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_RATINGSLIGHT_PARENTFOLDERPATH" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_RATINGSLIGHT_PARENTFOLDERPATH_DESC" %] 55 | 56 | [% END %] 57 |
58 | 59 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_CLEARALLRATINGS_NOW" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_CLEARALLRATINGS_NOW_DESC" %] 60 | 61 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_CLEARALLRATINGS_INPROGRESS" | string %] 62 | [% END %] 63 |
64 | 65 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_ADJUSTRATINGS_NOW" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_ADJUSTRATINGS_NOW_DESC" %] 66 | 67 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_ADJUSTRATINGS_INPROGRESS" | string %] 68 | [% END %] 69 |
70 | 71 | 72 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_POSTSCANSCHEDULEDELAY" desc="PLUGIN_RATINGSLIGHT_SETTINGS_VARIOUS_POSTSCANSCHEDULEDELAY_DESC" %] 73 | seconds 74 | [% END %] 75 | 76 | 77 | [% PROCESS settings/footer.html %] 78 | -------------------------------------------------------------------------------- /RatingsLight/Settings/Export.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Settings::Export; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use base qw(Plugins::RatingsLight::Settings::BaseSettings); 28 | 29 | use Slim::Utils::Log; 30 | use Slim::Utils::Prefs; 31 | use Slim::Utils::Misc; 32 | use Slim::Utils::Strings; 33 | use Slim::Utils::Strings qw(string cstring); 34 | 35 | my $prefs = preferences('plugin.ratingslight'); 36 | my $log = logger('plugin.ratingslight'); 37 | 38 | my $plugin; 39 | 40 | sub new { 41 | my $class = shift; 42 | $plugin = shift; 43 | $class->SUPER::new($plugin); 44 | } 45 | 46 | sub name { 47 | return Slim::Web::HTTP::CSRF->protectName('PLUGIN_RATINGSLIGHT_SETTINGS_EXPORT'); 48 | } 49 | 50 | sub page { 51 | return Slim::Web::HTTP::CSRF->protectURI('plugins/RatingsLight/settings/export.html'); 52 | } 53 | 54 | sub currentPage { 55 | return name(); 56 | } 57 | 58 | sub pages { 59 | my %page = ( 60 | 'name' => name(), 61 | 'page' => page(), 62 | ); 63 | my @pages = (\%page); 64 | return \@pages; 65 | } 66 | 67 | sub prefs { 68 | return ($prefs, qw(playlistexportsinglefile onlyratingsnotmatchtags exportextension exportextensionexceptions exportVL_id)); 69 | } 70 | 71 | sub handler { 72 | my ($class, $client, $paramRef) = @_; 73 | my $result = undef; 74 | my $callHandler = 1; 75 | if ($paramRef->{'saveSettings'}) { 76 | my @exportbasefilepathmatrix; 77 | my %lmsbasepathDone; 78 | 79 | for (my $n = 0; $n <= 10; $n++) { 80 | my $lmsbasepath = trim($paramRef->{"pref_lmsbasepath_$n"} // ''); 81 | my $substitutebasepath = trim($paramRef->{"pref_substitutebasepath_$n"} // ''); 82 | 83 | if ((length($lmsbasepath) > 0) && !$lmsbasepathDone{$lmsbasepath} && (length($substitutebasepath) > 0)) { 84 | push(@exportbasefilepathmatrix, {lmsbasepath => $lmsbasepath, substitutebasepath => $substitutebasepath}); 85 | $lmsbasepathDone{$lmsbasepath} = 1; 86 | } 87 | } 88 | $prefs->set('exportbasefilepathmatrix', \@exportbasefilepathmatrix); 89 | $paramRef->{exportbasefilepathmatrix} = \@exportbasefilepathmatrix; 90 | 91 | $result = $class->SUPER::handler($client, $paramRef); 92 | $callHandler = 0; 93 | } 94 | if ($paramRef->{'export'}) { 95 | if ($callHandler) { 96 | $paramRef->{'saveSettings'} = 1; 97 | $result = $class->SUPER::handler($client, $paramRef); 98 | } 99 | Plugins::RatingsLight::Plugin::exportRatingsToPlaylistFiles(); 100 | } elsif ($callHandler) { 101 | $result = $class->SUPER::handler($client, $paramRef); 102 | } 103 | 104 | # push to settings page 105 | $paramRef->{exportbasefilepathmatrix} = []; 106 | my $exportbasefilepathmatrix = $prefs->get('exportbasefilepathmatrix'); 107 | 108 | if (scalar @{$exportbasefilepathmatrix} == 0) { 109 | Plugins::RatingsLight::Plugin::initExportBaseFilePathMatrix(); 110 | $exportbasefilepathmatrix = $prefs->get('exportbasefilepathmatrix'); 111 | } 112 | 113 | foreach my $exportbasefilepath (@{$exportbasefilepathmatrix}) { 114 | if ($exportbasefilepath->{'lmsbasepath'}) { 115 | push( @{$paramRef->{exportbasefilepathmatrix}}, $exportbasefilepath); 116 | } 117 | } 118 | 119 | # add empty field (max = 11) 120 | if ((scalar @{$exportbasefilepathmatrix} + 1) < 10) { 121 | push(@{$paramRef->{exportbasefilepathmatrix}}, {lmsbasepath => '', substitutebasepath => ''}); 122 | } 123 | 124 | $result = $class->SUPER::handler($client, $paramRef); 125 | return $result; 126 | } 127 | 128 | sub beforeRender { 129 | my ($class, $paramRef) = @_; 130 | 131 | my @items; 132 | my $libraries = Slim::Music::VirtualLibraries->getLibraries(); 133 | 134 | my %hiddenVLs = map {$_ => 1} ("Ratings Light - Rated Tracks", "Ratings Light - Top Rated Tracks"); 135 | main::DEBUGLOG && $log->is_debug && $log->debug("hidden libraries: ".Data::Dump::dump(\%hiddenVLs)); 136 | 137 | while (my ($k, $v) = each %{$libraries}) { 138 | my $count = Slim::Music::VirtualLibraries->getTrackCount($k); 139 | my $name = Slim::Music::VirtualLibraries->getNameForId($k); 140 | my $displayName = Slim::Utils::Unicode::utf8decode($name, 'utf8').' ('.Slim::Utils::Misc::delimitThousands($count).($count == 1 ? ' '.string("PLUGIN_RATINGSLIGHT_LANGSTRING_TRACK") : ' '.string("PLUGIN_RATINGSLIGHT_LANGSTRING_TRACKS")).')'; 141 | main::DEBUGLOG && $log->is_debug && $log->debug("VL: ".$displayName); 142 | 143 | unless ($hiddenVLs{$name}) { 144 | push @items, { 145 | name => $displayName, 146 | sortName => Slim::Utils::Unicode::utf8decode($name, 'utf8'), 147 | library_id => $k, 148 | }; 149 | } 150 | } 151 | push @items, { 152 | name => string("PLUGIN_RATINGSLIGHT_LANGSTRING_COMPLETELIB"), 153 | sortName => " Complete Library", 154 | library_id => undef, 155 | }; 156 | @items = sort { $a->{sortName} cmp $b->{sortName} } @items; 157 | $paramRef->{virtuallibraries} = \@items; 158 | $paramRef->{curselfiletag} = $prefs->get('filetagtype'); 159 | } 160 | 161 | sub trim { 162 | my ($str) = @_; 163 | $str =~ s{^\s+}{}; 164 | $str =~ s{\s+$}{}; 165 | return $str; 166 | } 167 | 168 | 1; 169 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/menus.html: -------------------------------------------------------------------------------- 1 | [% page = "PLUGIN_RATINGSLIGHT" %] 2 | [% PROCESS settings/header.html %] 3 | 4 | [% PROCESS plugins/RatingsLight/settings/subpage_chooser.html %] 5 | 6 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_SHOW_RATED_TRACKS_MENUS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_SHOW_RATED_TRACKS_MENUS_DESC" %] 7 | 19 |

20 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_ARTISTS_MENU" | string %]   21 | 25 |

26 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_GENRES_MENU" | string %]   27 | 31 |

32 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_TRACKS_MENU" | string %]   33 | 37 | [% END %] 38 | [% IF prefs.showratedtracksmenus && prefs.showratedtracksmenus > 0 %] 39 |
40 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_SOURCE_VL" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_SOURCE_VL_DESC" %] 41 | 46 | [% END %] 47 | [% END %] 48 |
49 | 50 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATINGDISPLAYCHARACTER" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATINGDISPLAYCHARACTER_DESC" %] 51 | 59 | [% END %] 60 |
61 | 62 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATING_USEHALFSTARS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATING_USEHALFSTARS_DESC" %] 63 | 67 | [% END %] 68 |
69 | 70 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATING_CONTEXTMENUPOS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATING_CONTEXTMENUPOS_DESC" %] 71 | 75 | [% END %] 76 |
77 | 78 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_ENABLEIPENG_TSLEGACYRATING" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_ENABLEIPENG_TSLEGACYRATING_DESC" %] 79 | 83 | [% END %] 84 |

85 | 86 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATEDTRACKSBYARTIST_WEB_LIMIT" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATEDTRACKSBYARTIST_WEB_LIMIT_DESC" %] 87 | 88 | [% END %] 89 |
90 | 91 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATEDTRACKSBYARTIST_CONTEXTMENU_LIMIT" desc="PLUGIN_RATINGSLIGHT_SETTINGS_MENUS_RATEDTRACKSBYARTIST_CONTEXTMENU_LIMIT_DESC" %] 92 | 93 | [% END %] 94 | 95 | [% PROCESS settings/footer.html %] 96 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/backup.html: -------------------------------------------------------------------------------- 1 | 6 | 7 | 13 | 14 | [% page = "PLUGIN_RATINGSLIGHT" %] 15 | [% PROCESS settings/header.html %] 16 | 17 | [% PROCESS plugins/RatingsLight/settings/subpage_chooser.html %] 18 | 19 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP" desc="" %] 20 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_MANUAL_BACKUP" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_MANUAL_BACKUP_DESC" %] 21 | 22 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_MANUAL_BACKUP_INPROGRESS" | string %] 23 | [% END %] 24 |
25 | 26 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_SCHEDULED_BACKUPS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_SCHEDULED_BACKUPS_DESC" %] 27 | 31 | [% END %] 32 | 33 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_SCHEDULED_BACKUPS_BACKUPTIME" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_SCHEDULED_BACKUPS_BACKUPTIME_DESC" %] 34 | 35 | [% END %] 36 |
37 | 38 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_PRESCANBACKUP" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_PRESCANBACKUP_DESC" %] 39 | 43 | [% END %] 44 |
45 | 46 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_AUTODELETEBACKUPS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_AUTODELETEBACKUPS_DESC" %] 47 | 51 | [% IF prefs.scheduledbackups && !prefs.autodeletebackups %] [% "PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_AUTODELETEBACKUPS_WARNING" | string %][% END %] 52 | [% END %] 53 | 54 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_BACKUPDAYSTOKEEP" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_BACKUPDAYSTOKEEP_DESC" %] 55 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_BACKUPDAYSTOKEEP_BACKUPDAYS" | string %] 56 | [% END %] 57 | 58 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_BACKUPMINFILESTOKEEP" desc="PLUGIN_RATINGSLIGHT_SETTINGS_BACKUP_BACKUPMINFILESTOKEEP_DESC" %] 59 | 60 | [% END %] 61 | [% END %] 62 |

63 | 64 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE" desc="" %] 65 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_SELECTFILE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_SELECTFILE_DESC" %] 66 |

67 | 68 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_INPROGESS" | string %] 69 | [% IF restoremissingfile == 1 %][% "PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_MISSINGFILE" | string %][% ELSIF restoremissingfile == 2 %][% "PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_NOXMLFILE" | string %][% ELSE %][% END %] 70 | [% END %] 71 |
72 | 73 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_SELECTIVERESTORE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_SELECTIVERESTORE_DESC" %] 74 | 83 | [% END %] 84 |
85 | 86 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_CLEARALLBEFORE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_RESTORE_CLEARALLBEFORE_DESC" %] 87 | 91 | [% END %] 92 | [% END %] 93 | 94 | [% PROCESS settings/footer.html %] 95 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/01-bug.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug 2 | description: File a bug report 3 | title: "[BUG] your title here" 4 | labels: ["bug: bug suspected"] 5 | assignees: 6 | - AF-1 7 | body: 8 | - type: checkboxes 9 | attributes: 10 | label: Is there an existing issue for this? 11 | description: Please search to see if an issue (open or closed) already exists for the bug you encountered. 12 | options: 13 | - label: I have searched the existing issues 14 | required: true 15 | - type: markdown 16 | attributes: 17 | value: "

" 18 | - type: checkboxes 19 | attributes: 20 | label: Check common causes of LMS (plugin) problems 21 | description: Please take a quick look at [**this checklist**](https://github.com/AF-1/sobras/wiki/Checklist-to-eliminate-common-causes-of-LMS-(plugin)-problems) to eliminate common causes of LMS (plugin) problems. 22 | options: 23 | - label: The list has no fix for my issue 24 | required: true 25 | - type: markdown 26 | attributes: 27 | value: "

" 28 | - type: textarea 29 | attributes: 30 | label: What happened? 31 | description: A concise description of what you're experiencing. When does it happen? 32 | validations: 33 | required: true 34 | - type: markdown 35 | attributes: 36 | value: "

" 37 | - type: textarea 38 | attributes: 39 | label: Expected Behavior 40 | description: A concise description of what you expected to happen 41 | validations: 42 | required: true 43 | - type: markdown 44 | attributes: 45 | value: "

" 46 | - type: textarea 47 | attributes: 48 | label: Steps To Reproduce 49 | description: Steps to reproduce the behavior 50 | placeholder: | 51 | 1. Go to '...' 52 | 2. Click on '...' 53 | 3. Scroll down to '...' 54 | 4. See error... 55 | validations: 56 | required: true 57 | - type: markdown 58 | attributes: 59 | value: "

" 60 | - type: input 61 | attributes: 62 | label: LMS version 63 | description: What version of LMS are you running? 64 | placeholder: "Example: 9.0.1" 65 | validations: 66 | required: true 67 | - type: markdown 68 | attributes: 69 | value: "
" 70 | - type: input 71 | attributes: 72 | label: Plugin version 73 | description: What version of the plugin are you running? 74 | placeholder: "Example: 1.0.3" 75 | validations: 76 | required: true 77 | - type: markdown 78 | attributes: 79 | value: "
" 80 | - type: input 81 | attributes: 82 | label: "Your OS (incl. version)" 83 | description: What OS (incl. version) are you running? 84 | placeholder: "Example: macOS 15.1.1" 85 | validations: 86 | required: true 87 | - type: markdown 88 | attributes: 89 | value: "
" 90 | - type: dropdown 91 | attributes: 92 | label: "What web skins / controllers are you seeing the problem with?" 93 | description: multiple selection possible 94 | multiple: true 95 | options: 96 | - Material 97 | - Logic Teal 98 | - Default skin 99 | - Classic skin 100 | - jivelite (piCorePlayer, SqueezePlay, Touch, Radio) 101 | - not applicable 102 | default: 0 103 | validations: 104 | required: true 105 | - type: checkboxes 106 | attributes: 107 | label: Please check whether the problem can be reproduced with other web skins / controllers. 108 | options: 109 | - label: I have checked this 110 | required: true 111 | - type: markdown 112 | attributes: 113 | value: "
" 114 | - type: dropdown 115 | attributes: 116 | label: What browsers are you seeing the problem on? 117 | description: Multiple selection possible. If your browser is not listed, add the name to bug description. 118 | multiple: true 119 | options: 120 | - Firefox 121 | - Chrome 122 | - Safari 123 | - Microsoft Edge 124 | - other 125 | - not applicable 126 | validations: 127 | required: true 128 | - type: markdown 129 | attributes: 130 | value: "

" 131 | - type: textarea 132 | attributes: 133 | label: Environment 134 | description: | 135 | Go to *LMS settings > Information* and copy/paste the information for *Lyrion Music Server Status* and *Perl and Module Versions* here. 136 | And a **list of installed plugins** (incl. version numbers). 137 | placeholder: | 138 | Lyrion Music Server Status: … 139 | 140 | Perl and Module Versions: … 141 | 142 | List of installed plugins: … 143 | render: markdown 144 | validations: 145 | required: false 146 | - type: markdown 147 | attributes: 148 | value: "

" 149 | - type: checkboxes 150 | attributes: 151 | label: Is there relevant log output for this? 152 | description: | 153 | * Add relevant (error) messages from the **LMS server log** (file path at the bottom of *LMS settings* > *Information*). Use the **time stamps** in the log to find messages created around the time your problem occurred. 154 | * If there are no server log error messages, set the **debug level for this plugin** to **Info** in *LMS settings* > *Advanced* > *Logging*, **reproduce the problem** and **check the server log** again. If there's still nothing, **repeat** this step with the debug level set to **Debug**. 155 | options: 156 | - label: I have searched the server log 157 | required: true 158 | - type: textarea 159 | attributes: 160 | label: Relevant log output 161 | description: "Please copy and paste any relevant log output here. This will be automatically formatted into code, so no need for backticks.
📎 Alternatively, **attach** the complete server log **file** (see *Anything else* below)." 162 | render: shell 163 | - type: markdown 164 | attributes: 165 | value: "

" 166 | - type: textarea 167 | attributes: 168 | label: Anything else? 📎 Attachments etc. 169 | description: | 170 | Screenshots? Log files? Links? References? Anything that will give us more context about the issue you are encountering! 171 | 172 | Tip: You can attach images (screenshots) or log files by clicking this area to highlight it and then dragging files in. 173 | validations: 174 | required: false 175 | - type: markdown 176 | attributes: 177 | value: "

" 178 | - type: markdown 179 | attributes: 180 | value: | 181 | ## ⭐ Help others discover this project 182 | If you find this project useful, giving it a [**star**](https://github.com/AF-1/lms-ratingslight#-help-others-discover-this-project) is a great way to show your support and help others discover it. Thank you. 183 | - type: markdown 184 | attributes: 185 | value: "

" 186 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/settings/import.html: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 13 | 14 | [% page = "PLUGIN_RATINGSLIGHT" %] 15 | [% PROCESS settings/header.html %] 16 | 17 | [% PROCESS plugins/RatingsLight/settings/subpage_chooser.html %] 18 | 19 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_DESC" %] 20 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_HEADER" | string %] 21 |

22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | [% IF playlistcount %] 32 | 39 | 47 | [% ELSE %] 48 | 49 | [% END %] 50 | 51 |
[% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_PLNAME" | string %][% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_PLRATING" | string %]
33 | 38 | 40 | 46 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_PLRATING_NOPLFOUND" | string %]
52 | [% IF playlistcount %] 53 |
54 | 55 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_INPROGRESS" | string %] 56 | [% END %] 57 | 58 | [% END %] 59 |

60 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_PLMAXTRACKS" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_PLAYLISTS_PLMAXTRACKS_DESC" %] 61 | 62 | [% END %] 63 |

64 | 65 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS" desc="" %] [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_HEADER" | string %] 66 |

67 | 68 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_MANUAL_IMPORT" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_MANUAL_IMPORT_DESC" %] 69 | 70 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_MANUAL_IMPORT_INPROGRESS" | string %] 71 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_COMMENTTAGS_MANUAL_IMPORT_MISSINGKEYWORDS" | string %] 72 | [% END %] 73 |
74 | 75 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_AUTOSCAN" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_AUTOSCAN_DESC" %] 76 | 80 | [% END %] 81 |
82 | 83 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_DONTUNRATE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_DONTUNRATE_DESC" %] 84 | 88 | [% END %] 89 |
90 | 91 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_FILETAGTYPE" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_FILETAGS_FILETAGTYPE_DESC" %] 92 | 100 | [% END %] 101 |
102 | 103 |
104 | [% WRAPPER setting title="" desc="" %] 105 | [% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_COMMENTTAGS_EXAMPLE" | string %] 106 | [% END %] 107 | 108 | [% WRAPPER setting title="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_COMMENTTAGS_RATING_KEYWORD" desc="PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_COMMENTTAGS_RATING_KEYWORD_DESC" %] 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 |
[% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_COMMENTTAGS_RATING_KEYWORD_PREFIX" | string %][% "PLUGIN_RATINGSLIGHT_SETTINGS_IMPORT_COMMENTTAGS_RATING_KEYWORD_SUFFIX" | string %]
122 | [% END %] 123 |
124 |
125 | [% END %] 126 | 127 | [% PROCESS settings/footer.html %] 128 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/showratedtrackslist.html: -------------------------------------------------------------------------------- 1 | [% IF objecttype == 'album' || objecttype == 'playlist' %] 2 | [% IF titlemore %] 3 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_MORERATEDTRACKSINALBUM_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 4 | [% ELSE %] 5 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_RATEDTRACKSINALBUM_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 6 | [% END %] 7 | [% ELSIF objecttype == 'composer' || objecttype == 'artistcomposer' %] 8 | [% IF titlemore %] 9 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_MORERATEDTRACKSBYCOMPOSER_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 10 | [% ELSE %] 11 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_RATEDTRACKSBYCOMPOSER_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 12 | [% END %] 13 | [% ELSIF objecttype == 'genre' %] 14 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_RNDSELRATEDTRACKSINGENRE_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 15 | [% ELSIF objecttype == 'year' %] 16 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_RNDSELRATEDTRACKSFROMYEAR_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 17 | [% ELSIF objecttype == 'decade' %] 18 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_RNDSELRATEDTRACKSFROMDECADE_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 19 | [% ELSE %] 20 | [% IF titlemore %] 21 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_MORERATEDTRACKSBYARTIST_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 22 | [% ELSE %] 23 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_MENUS_RATEDTRACKSBYARTIST_LISTHEADER' | string; pagetitle = pagetitle _ " " _ listheadername %] 24 | [% END %] 25 | [% END %] 26 | [% pwd_list = [ pagetitle ] %] 27 | [% PROCESS pageheader.html %] 28 | 48 | [% WRAPPER contentcontainer %] 49 | [% odd = 1 %] 50 | [% IF trackcount > 1 %] 51 | [% BLOCK controls_allsongs %] 52 | [% WRAPPER addlink noTarget=1 -%]href="[% webroot %]plugins/RatingsLight/showratedtrackslist.html?trackid=[% trackid %]&objectid=[% objectid %]&objecttype=[% objecttype %][%IF titlemore %]&titlemore=1[% END %][%IF objectname %]&objectname=[% objectname %][% END %]&action=add&actiontrackids=[% alltrackids %]&player=[% playerURI %]"[% END %] 53 | [% IF systemSkin != 'Classic' %] 54 | [% WRAPPER insertlink noTarget=1 -%]href="[% webroot %]plugins/RatingsLight/showratedtrackslist.html?trackid=[% trackid %]&objectid=[% objectid %]&objecttype=[% objecttype %][%IF titlemore %]&titlemore=1[% END %][%IF objectname %]&objectname=[% objectname %][% END %]&action=insert&actiontrackids=[% alltrackids %]&player=[% playerURI %]"[% END %] 55 | [% END %] 56 | [% WRAPPER playlink noTarget=1 -%]href="[% webroot %]plugins/RatingsLight/showratedtrackslist.html?trackid=[% trackid %]&objectid=[% objectid %]&objecttype=[% objecttype %][%IF titlemore %]&titlemore=1[% END %][%IF objectname %]&objectname=[% objectname %][% END %]&action=load&actiontrackids=[% alltrackids %]&player=[% playerURI %]"[% END %] 57 | [% END %] 58 | [%- WRAPPER contentitem controls='controls_allsongs' %] 59 | 60 | 61 | 62 | [% "PLUGIN_RATINGSLIGHT_MENUS_RATEDTRACKS_MENU_ALLSONGS" | string %] ([% trackcount %]) 63 | 64 | [% END %] 65 | [% odd = (not odd) %] 66 | [% END %] 67 | 68 | [% FOREACH ratedtrack IN ratedtracks %] 69 | [% BLOCK controls %] 70 | [% WRAPPER addlink noTarget=1 -%]href="[% webroot %]plugins/RatingsLight/showratedtrackslist.html?trackid=[% trackid %]&objectid=[% objectid %]&objecttype=[% objecttype %][%IF titlemore %]&titlemore=1[% END %][%IF objectname %]&objectname=[% objectname %][% END %]&action=add&actiontrackids=[% ratedtrack.trackid %]&player=[% playerURI %]"[% END %] 71 | [% IF systemSkin != 'Classic' %] 72 | [% WRAPPER insertlink noTarget=1 -%]href="[% webroot %]plugins/RatingsLight/showratedtrackslist.html?trackid=[% trackid %]&objectid=[% objectid %]&objecttype=[% objecttype %][%IF titlemore %]&titlemore=1[% END %][%IF objectname %]&objectname=[% objectname %][% END %]&action=insert&actiontrackids=[% ratedtrack.trackid %]&player=[% playerURI %]"[% END %] 73 | [% END %] 74 | [% WRAPPER playlink noTarget=1 -%]href="[% webroot %]plugins/RatingsLight/showratedtrackslist.html?trackid=[% trackid %]&objectid=[% objectid %]&objecttype=[% objecttype %][%IF titlemore %]&titlemore=1[% END %][%IF objectname %]&objectname=[% objectname %][% END %]&action=load&actiontrackids=[% ratedtrack.trackid %]&player=[% playerURI %]"[% END %] 75 | [% END %] 76 | [%- WRAPPER contentitem controls='controls' %] 77 | 78 | 79 | 80 | 81 | 82 | [% ratedtrack.tracktitle %] 83 | [% IF objecttype == 'album' %] 84 |
85 | [% ratedtrack.artistname %] 86 | [% END %] 87 | [% IF objecttype == 'artist' %] 88 |
89 | [% ratedtrack.albumname %] 90 | [% END %] 91 | [% IF objecttype == 'genre' || objecttype == 'year' || objecttype == 'decade' || objecttype == 'playlist' || objecttype == 'composer' || objecttype == 'artistcomposer' %] 92 |
93 | [% ratedtrack.artistname %] • 94 | [% ratedtrack.albumname %] 95 | [% END %] 96 | 97 | 98 | [% END %] 99 | [% odd = (not odd) %] 100 | [% END %] 101 | [% END %] 102 | 103 | [% PROCESS pagefooter.html %] 104 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/trackratinginfo.html: -------------------------------------------------------------------------------- 1 | 102 |
103 | 104 | [% "PLUGIN_RATINGSLIGHT_RATING" | string %] 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 |   130 | 131 | 132 | 133 | 134 | 135 |
136 | 199 | -------------------------------------------------------------------------------- /RatingsLight/Common.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::Common; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use Slim::Utils::Log; 28 | use Slim::Schema; 29 | use Slim::Utils::DateTime; 30 | use Slim::Utils::Prefs; 31 | use Slim::Utils::Strings qw(string); 32 | use Slim::Utils::Text; 33 | use File::Basename; 34 | use File::Copy qw(move); 35 | use File::Spec::Functions qw(:ALL); 36 | use File::stat; 37 | use FindBin qw($Bin); 38 | use POSIX qw(strftime); 39 | use Time::HiRes qw(time); 40 | use Path::Class; 41 | 42 | use base 'Exporter'; 43 | our %EXPORT_TAGS = ( 44 | all => [qw(commit rollback createBackup cleanupBackups importRatingsFromCommentTags importRatingsFromBPMTags isTimeOrEmpty getMusicDirs parse_duration pathForItem)], 45 | ); 46 | our @EXPORT_OK = ( @{ $EXPORT_TAGS{all} } ); 47 | 48 | my $log = logger('plugin.ratingslight'); 49 | my $prefs = preferences('plugin.ratingslight'); 50 | my $serverPrefs = preferences('server'); 51 | 52 | sub createBackup { 53 | my $status_creatingbackup = $prefs->get('status_creatingbackup'); 54 | if ($status_creatingbackup == 1) { 55 | $log->warn('A backup is already in progress, please wait for the previous backup to finish'); 56 | return; 57 | } 58 | $prefs->set('status_creatingbackup', 1); 59 | 60 | my $backupDir = $prefs->get('rlfolderpath'); 61 | my ($sql, $sth) = undef; 62 | my $dbh = Slim::Schema->dbh; 63 | my ($trackURL, $trackURLmd5, $trackRating, $trackRemote, $trackExtid, $trackMBID); 64 | my $started = time(); 65 | my $backuptimestamp = strftime "%Y-%m-%d %H:%M:%S", localtime time; 66 | my $filename_timestamp = strftime "%Y%m%d-%H%M", localtime time; 67 | 68 | $sql = "select tracks.url, tracks.urlmd5, tracks_persistent.rating, tracks.remote, tracks.extid, tracks_persistent.musicbrainz_id from tracks_persistent join tracks on tracks.urlmd5 = tracks_persistent.urlmd5 where tracks_persistent.rating > 0"; 69 | $sth = $dbh->prepare($sql); 70 | $sth->execute(); 71 | 72 | $sth->bind_col(1,\$trackURL); 73 | $sth->bind_col(2,\$trackURLmd5); 74 | $sth->bind_col(3,\$trackRating); 75 | $sth->bind_col(4,\$trackRemote); 76 | $sth->bind_col(5,\$trackExtid); 77 | $sth->bind_col(6,\$trackMBID); 78 | 79 | my @ratedTracks = (); 80 | while ($sth->fetch()) { 81 | push (@ratedTracks, {'url' => $trackURL, 'urlmd5' => $trackURLmd5, 'rating' => $trackRating, 'remote' => $trackRemote, 'extid' => $trackExtid, 'musicbrainzid' => $trackMBID}); 82 | } 83 | $sth->finish(); 84 | 85 | if (@ratedTracks) { 86 | my $filename = catfile($backupDir, 'RL_Backup_'.$filename_timestamp.'.xml'); 87 | my $output = FileHandle->new($filename, '>:utf8') or do { 88 | $log->error('Could not open '.$filename.' for writing. Does the RatingsLight folder exist? Does LMS have read/write permissions (755) for the (parent) folder?'); 89 | $prefs->set('status_creatingbackup', 0); 90 | return; 91 | }; 92 | my $trackcount = scalar(@ratedTracks); 93 | my $ignoredtracks = 0; 94 | main::DEBUGLOG && $log->is_debug && $log->debug('Found '.$trackcount.($trackcount == 1 ? ' rated track' : ' rated tracks').' in the LMS persistent database'); 95 | 96 | print $output "\n"; 97 | print $output "\n"; 98 | print $output "\n"; 99 | print $output "\n"; 100 | for my $ratedTrack (@ratedTracks) { 101 | my $BACKUPtrackURL = $ratedTrack->{'url'}; 102 | if ((($ratedTrack->{'remote'} == 1) && (!defined($ratedTrack->{'extid'}))) || !defined($ratedTrack->{'remote'})) { 103 | $log->warn('Warning: ignoring this track. Track is remote but not part of LMS library: '.$BACKUPtrackURL) if $ratedTrack->{'remote'}; 104 | $trackcount--; 105 | $ignoredtracks++; 106 | next; 107 | } 108 | my $urlmd5 = $ratedTrack->{'urlmd5'}; 109 | my $rating100ScaleValue = $ratedTrack->{'rating'}; 110 | my $remote = $ratedTrack->{'remote'}; 111 | my $BACKUPrelFilePath = ($remote == 0 ? getRelFilePath($BACKUPtrackURL) : ''); 112 | $BACKUPtrackURL = escape($BACKUPtrackURL); 113 | $BACKUPrelFilePath = $BACKUPrelFilePath ? escape($BACKUPrelFilePath) : ''; 114 | my $BACKUPtrackMBID = $ratedTrack->{'musicbrainzid'} || ''; 115 | print $output "\t\n\t\t".$BACKUPtrackURL."\n\t\t".$urlmd5."\n\t\t".$BACKUPrelFilePath."\n\t\t".$rating100ScaleValue."\n\t\t".$remote."\n\t\t".$BACKUPtrackMBID."\n\t\n"; 116 | } 117 | print $output "\n"; 118 | 119 | if ($ignoredtracks > 0) { 120 | print $output "\n"; 121 | } 122 | print $output "\n"; 123 | close $output; 124 | main::DEBUGLOG && $log->is_debug && $log->debug('Backup completed after '.(time() - $started).' seconds.'); 125 | 126 | cleanupBackups(); 127 | } else { 128 | main::INFOLOG && $log->is_info && $log->info('Found no rated tracks in the LMS database.'); 129 | } 130 | $prefs->set('status_creatingbackup', 0); 131 | } 132 | 133 | sub cleanupBackups { 134 | my $backupFilesMin = $prefs->get('backupfilesmin'); 135 | if ($prefs->get('autodeletebackups')) { 136 | my $backupDir = $prefs->get('rlfolderpath'); 137 | return unless (-d $backupDir); 138 | my $backupsdaystokeep = $prefs->get('backupsdaystokeep'); 139 | my $maxkeeptime = $backupsdaystokeep * 24 * 60 * 60; # in seconds 140 | my @files; 141 | opendir(my $DH, $backupDir) or die "Error opening $backupDir: $!"; 142 | @files = grep(/^RL_Backup_.*$/, readdir($DH)); 143 | closedir($DH); 144 | main::DEBUGLOG && $log->is_debug && $log->debug('number of backup files found: '.scalar(@files)); 145 | my $mtime; 146 | my $etime = int(time()); 147 | my $n = 0; 148 | if (scalar(@files) > $backupFilesMin) { 149 | foreach my $file (@files) { 150 | my $filepath = catfile($backupDir, $file); 151 | $mtime = stat($filepath)->mtime; 152 | if (($etime - $mtime) > $maxkeeptime) { 153 | unlink($filepath) or die "Can't delete $file: $!"; 154 | $n++; 155 | last if ((scalar(@files) - $n) <= $backupFilesMin); 156 | } 157 | } 158 | } else { 159 | main::DEBUGLOG && $log->is_debug && $log->debug('Not deleting any backups. Number of backup files to keep ('.$backupFilesMin.') '.((scalar(@files) - $n) == $backupFilesMin ? '=' : '>').' backup files found ('.scalar(@files).').'); 160 | } 161 | main::DEBUGLOG && $log->is_debug && $log->debug('Deleted '.$n.($n == 1 ? ' backup. ' : ' backups. ').(scalar(@files) - $n).((scalar(@files) - $n) == 1 ? " backup" : " backups")." remaining."); 162 | } 163 | } 164 | 165 | sub importRatingsFromCommentTags { 166 | main::DEBUGLOG && $log->is_debug && $log->debug('starting ratings import from comment tags'); 167 | my $class = shift; 168 | if ($prefs->get('status_importingfromcommenttags') == 1) { 169 | $log->warn('Import is already in progress, please wait for the previous import to finish'); 170 | return; 171 | } 172 | $prefs->set('status_importingfromcommenttags', 1); 173 | my $started = time(); 174 | 175 | my $rating_keyword_prefix = $prefs->get('rating_keyword_prefix'); 176 | my $rating_keyword_suffix = $prefs->get('rating_keyword_suffix'); 177 | my $tagimport_dontunrate = $prefs->get('tagimport_dontunrate'); 178 | 179 | my $dbh = Slim::Schema->dbh; 180 | if ((!defined $rating_keyword_prefix || $rating_keyword_prefix eq '') && (!defined $rating_keyword_suffix || $rating_keyword_suffix eq '')) { 181 | $log->warn('Error: no rating keywords found.'); 182 | $prefs->set('status_importingfromcommenttags', 0); 183 | return 184 | } else { 185 | my $sqlunrate = "UPDATE tracks_persistent 186 | SET rating = NULL 187 | WHERE (tracks_persistent.rating > 0 188 | AND tracks_persistent.urlmd5 IN ( 189 | SELECT tracks.urlmd5 190 | FROM tracks 191 | LEFT JOIN comments ON comments.track = tracks.id 192 | WHERE (comments.value NOT LIKE ? OR comments.value IS NULL)) 193 | );"; 194 | 195 | my $sqlrate = "UPDATE tracks_persistent 196 | SET rating = ? 197 | WHERE tracks_persistent.urlmd5 IN ( 198 | SELECT tracks.urlmd5 199 | FROM tracks 200 | JOIN comments ON comments.track = tracks.id 201 | WHERE comments.value LIKE ? 202 | );"; 203 | 204 | # unrate previously rated tracks in LMS if comment tag does no longer contain keyword(s) 205 | if (!$tagimport_dontunrate) { 206 | my $ratingkeyword_unrate = "%%".$rating_keyword_prefix."_".$rating_keyword_suffix."%%"; 207 | 208 | my $sth = $dbh->prepare($sqlunrate); 209 | eval { 210 | $sth->bind_param(1, $ratingkeyword_unrate); 211 | $sth->execute(); 212 | commit($dbh); 213 | }; 214 | if ($@) { 215 | $log->error("Database error: $DBI::errstr"); 216 | eval { 217 | rollback($dbh); 218 | }; 219 | } 220 | $sth->finish(); 221 | } 222 | 223 | # rate tracks according to comment tag keyword 224 | my $rating = 1; 225 | 226 | until ($rating > 5) { 227 | my $rating100scalevalue = ($rating * 20); 228 | my $ratingkeyword = "%%".$rating_keyword_prefix.$rating.$rating_keyword_suffix."%%"; 229 | my $sth = $dbh->prepare($sqlrate); 230 | eval { 231 | $sth->bind_param(1, $rating100scalevalue); 232 | $sth->bind_param(2, $ratingkeyword); 233 | $sth->execute(); 234 | commit($dbh); 235 | }; 236 | if ($@) { 237 | $log->error("Database error: $DBI::errstr"); 238 | eval { 239 | rollback($dbh); 240 | }; 241 | } 242 | $rating++; 243 | $sth->finish(); 244 | } 245 | } 246 | 247 | main::DEBUGLOG && $log->is_debug && $log->debug('Import completed after '.(time() - $started).' seconds.'); 248 | $prefs->set('status_importingfromcommenttags', 0); 249 | } 250 | 251 | sub importRatingsFromBPMTags { 252 | main::DEBUGLOG && $log->is_debug && $log->debug('starting ratings import from BPM tags'); 253 | my $class = shift; 254 | if ($prefs->get('status_importingfromBPMtags') == 1) { 255 | $log->warn('Import is already in progress, please wait for the previous import to finish'); 256 | return; 257 | } 258 | $prefs->set('status_importingfromBPMtags', 1); 259 | my $started = time(); 260 | my $tagimport_dontunrate = $prefs->get('tagimport_dontunrate'); 261 | 262 | my $dbh = Slim::Schema->dbh; 263 | my $sqlunrate = "update tracks_persistent 264 | set rating = null 265 | where (tracks_persistent.rating > 0 266 | and tracks_persistent.urlmd5 in ( 267 | select tracks.urlmd5 268 | from tracks 269 | where tracks.audio == 1 270 | and (tracks.bpm == 0 or tracks.bpm is null)) 271 | );"; 272 | 273 | my $sqlrate = "update tracks_persistent 274 | set rating = ? 275 | where tracks_persistent.urlmd5 in ( 276 | select tracks.urlmd5 277 | from tracks 278 | where tracks.audio == 1 279 | and tracks.bpm == ? 280 | );"; 281 | 282 | # unrate previously rated tracks in LMS if BPM tag value is zero or null 283 | if (!$tagimport_dontunrate) { 284 | my $sth = $dbh->prepare($sqlunrate); 285 | eval { 286 | $sth->execute(); 287 | commit($dbh); 288 | }; 289 | if ($@) { 290 | $log->error("Database error: $DBI::errstr"); 291 | eval { 292 | rollback($dbh); 293 | }; 294 | } 295 | $sth->finish(); 296 | } 297 | 298 | # rate tracks according to BPM value 299 | my $rating = 1; 300 | 301 | until ($rating > 10) { 302 | my $rating100scalevalue = ($rating * 10); 303 | my $sth = $dbh->prepare($sqlrate); 304 | eval { 305 | $sth->bind_param(1, $rating100scalevalue); 306 | $sth->bind_param(2, $rating100scalevalue); 307 | $sth->execute(); 308 | commit($dbh); 309 | }; 310 | if ($@) { 311 | $log->error("Database error: $DBI::errstr"); 312 | eval { 313 | rollback($dbh); 314 | }; 315 | } 316 | $rating++; 317 | $sth->finish(); 318 | } 319 | 320 | main::DEBUGLOG && $log->is_debug && $log->debug('Import completed after '.(time() - $started).' seconds.'); 321 | $prefs->set('status_importingfromBPMtags', 0); 322 | } 323 | 324 | sub getRelFilePath { 325 | main::DEBUGLOG && $log->is_debug && $log->debug('Getting relative file url/path.'); 326 | my $fullTrackURL = shift; 327 | my $relFilePath; 328 | my $lmsmusicdirs = getMusicDirs(); 329 | main::DEBUGLOG && $log->is_debug && $log->debug('Valid LMS music dirs = '.Data::Dump::dump($lmsmusicdirs)); 330 | 331 | foreach (@{$lmsmusicdirs}) { 332 | my $dirSep = File::Spec->canonpath("/"); 333 | my $mediaDirPath = $_.$dirSep; 334 | my $fullTrackPath = Slim::Utils::Misc::pathFromFileURL($fullTrackURL); 335 | my $match = checkInFolder($fullTrackPath, $mediaDirPath); 336 | 337 | main::DEBUGLOG && $log->is_debug && $log->debug("Full file path \"$fullTrackPath\" is".($match == 1 ? "" : " NOT")." part of media dir \"".$mediaDirPath."\""); 338 | if ($match == 1) { 339 | $relFilePath = file($fullTrackPath)->relative($_); 340 | $relFilePath = Slim::Utils::Misc::fileURLFromPath($relFilePath); 341 | $relFilePath =~ s/^(file:)?\/+//isg; 342 | main::DEBUGLOG && $log->is_debug && $log->debug('Saving RELATIVE file path: '.$relFilePath); 343 | last; 344 | } 345 | } 346 | if (!$relFilePath) { 347 | main::DEBUGLOG && $log->is_debug && $log->debug("Couldn't get relative file path for \"$fullTrackURL\"."); 348 | } 349 | return $relFilePath; 350 | } 351 | 352 | sub checkInFolder { 353 | my $path = shift || return; 354 | my $checkdir = shift; 355 | 356 | $path = Slim::Utils::Misc::fixPath($path) || return 0; 357 | $path = Slim::Utils::Misc::pathFromFileURL($path) || return 0; 358 | main::DEBUGLOG && $log->is_debug && $log->debug('path = '.$path.' -- checkdir = '.$checkdir); 359 | 360 | if ($checkdir && $path =~ /^\Q$checkdir\E/) { 361 | return 1; 362 | } else { 363 | return 0; 364 | } 365 | } 366 | 367 | sub getMusicDirs { 368 | my $mediadirs = $serverPrefs->get('mediadirs'); 369 | my $ignoreInAudioScan = $serverPrefs->get('ignoreInAudioScan'); 370 | my $lmsmusicdirs = []; 371 | my %musicdircount; 372 | my $thisdir; 373 | foreach $thisdir (@{$mediadirs}, @{$ignoreInAudioScan}) {$musicdircount{$thisdir}++} 374 | foreach $thisdir (keys %musicdircount) { 375 | if ($musicdircount{$thisdir} == 1) { 376 | push (@{$lmsmusicdirs}, $thisdir); 377 | } 378 | } 379 | return $lmsmusicdirs; 380 | } 381 | 382 | sub parse_duration { 383 | use integer; 384 | sprintf("%02dh:%02dm", $_[0]/3600, $_[0]/60%60); 385 | } 386 | 387 | sub isTimeOrEmpty { 388 | my $name = shift; 389 | my $arg = shift; 390 | if (!$arg || $arg eq '') { 391 | return 1; 392 | } elsif ($arg =~ m/^([0\s]?[0-9]|1[0-9]|2[0-4]):([0-5][0-9])\s*(P|PM|A|AM)?$/isg) { 393 | return 1; 394 | } 395 | return 0; 396 | } 397 | 398 | sub pathForItem { 399 | my $item = shift; 400 | if (Slim::Music::Info::isFileURL($item) && !Slim::Music::Info::isFragment($item)) { 401 | my $path = Slim::Utils::Misc::fixPath($item) || return 0; 402 | return Slim::Utils::Misc::pathFromFileURL($path); 403 | } 404 | return $item; 405 | } 406 | 407 | sub commit { 408 | my $dbh = shift; 409 | if (!$dbh->{'AutoCommit'}) { 410 | $dbh->commit(); 411 | } 412 | } 413 | 414 | sub rollback { 415 | my $dbh = shift; 416 | if (!$dbh->{'AutoCommit'}) { 417 | $dbh->rollback(); 418 | } 419 | } 420 | 421 | *escape = \&URI::Escape::uri_escape_utf8; 422 | 423 | 1; 424 | -------------------------------------------------------------------------------- /RatingsLight/DontStopTheMusic.pm: -------------------------------------------------------------------------------- 1 | # 2 | # Ratings Light 3 | # 4 | # (c) 2020 AF 5 | # 6 | # GPLv3 license 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | # 20 | 21 | package Plugins::RatingsLight::DontStopTheMusic; 22 | 23 | use strict; 24 | use warnings; 25 | use utf8; 26 | 27 | use Slim::Utils::Log; 28 | use Slim::Utils::Prefs; 29 | use Slim::Schema; 30 | 31 | use Plugins::RatingsLight::Common ':all'; 32 | use Plugins::RatingsLight::Plugin; 33 | use Slim::Plugin::DontStopTheMusic::Plugin; 34 | 35 | my $log = logger('plugin.ratingslight'); 36 | my $prefs = preferences('plugin.ratingslight'); 37 | 38 | 39 | sub init { 40 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_RATED', sub { 41 | dontStopTheMusic('rated', @_); 42 | }); 43 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_TOPRATED', sub { 44 | dontStopTheMusic('rated_toprated', @_); 45 | }); 46 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_RATED_GENRE', sub { 47 | dontStopTheMusic('rated_genre', @_); 48 | }); 49 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_RATED_GENRE_TOPRATED', sub { 50 | dontStopTheMusic('rated_genre_toprated', @_); 51 | }); 52 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_UNRATED_RATED', sub { 53 | dontStopTheMusic('unrated_rated', @_); 54 | }); 55 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_UNRATED_RATED_GENRE', sub { 56 | dontStopTheMusic('unrated_rated_genre', @_); 57 | }); 58 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_UNRATED_RATED_UNPLAYED', sub { 59 | dontStopTheMusic('unrated_rated_unplayed', @_); 60 | }); 61 | Slim::Plugin::DontStopTheMusic::Plugin->registerHandler('PLUGIN_RATINGSLIGHT_DSTM_UNRATED_RATED_UNPLAYED_GENRE', sub { 62 | dontStopTheMusic('unrated_rated_unplayed_genre', @_); 63 | }); 64 | } 65 | 66 | sub dontStopTheMusic { 67 | my ($mixtype, $client, $cb) = @_; 68 | return unless $client; 69 | main::DEBUGLOG && $log->is_debug && $log->debug('DSTM mixtype = '.$mixtype); 70 | 71 | my $topratedminrating = $prefs->get('topratedminrating'); 72 | my $tracks = []; 73 | my $dstm_batchsizenewtracks = $prefs->get('dstm_batchsizenewtracks'); 74 | my $excludedgenrelist = getExcludedGenreList(); 75 | main::DEBUGLOG && $log->is_debug && $log->debug('excludedgenrelist = '.$excludedgenrelist); 76 | my $dstm_minTrackDuration = $prefs->get('dstm_minTrackDuration'); 77 | my $dstm_percentagerated = $prefs->get('dstm_percentagerated'); 78 | my $dstm_percentagetoprated = $prefs->get('dstm_percentagetoprated'); 79 | my $currentLibrary = Slim::Music::VirtualLibraries->getLibraryIdForClient($client); 80 | main::DEBUGLOG && $log->is_debug && $log->debug('current client VlibID = '.$currentLibrary); 81 | 82 | my $sqlstatement; 83 | 84 | ### shared sql 85 | # track min duration, library view 86 | my $shared_curlib_sql = " join library_track on library_track.track = tracks.id and library_track.library = \"$currentLibrary\" where audio=1 and tracks.secs >= $dstm_minTrackDuration"; 87 | # track min duration 88 | my $shared_completelib_sql = " where audio=1 and tracks.secs >= $dstm_minTrackDuration"; 89 | # excluded genres 90 | my $excludegenre_sql = " and not exists (select * from tracks t2,genre_track,genres where t2.id=tracks.id and tracks.id=genre_track.track and genre_track.genre=genres.id and genres.namesearch in ($excludedgenrelist))"; 91 | 92 | ### Mix sql 93 | # Mix: Rated 94 | if ($mixtype eq 'rated') { 95 | $sqlstatement = "select tracks.url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating > 0"; 96 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 97 | $sqlstatement .= $shared_curlib_sql; 98 | } else { 99 | $sqlstatement .= $shared_completelib_sql; 100 | } 101 | if ($excludedgenrelist ne '') { 102 | $sqlstatement .= $excludegenre_sql; 103 | } 104 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_batchsizenewtracks;"; 105 | } 106 | 107 | # Mix: "Rated (with % of top rated)" 108 | if ($mixtype eq 'rated_toprated') { 109 | $sqlstatement = "drop table if exists randomweightedratingshigh; 110 | drop table if exists randomweightedratingslow; 111 | drop table if exists randomweightedratingscombined; 112 | "; 113 | $sqlstatement .="create temporary table randomweightedratingslow as select tracks.url as url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating < $topratedminrating"; 114 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 115 | $sqlstatement .= $shared_curlib_sql; 116 | } else { 117 | $sqlstatement .= $shared_completelib_sql; 118 | } 119 | if ($excludedgenrelist ne '') { 120 | $sqlstatement .= $excludegenre_sql; 121 | } 122 | $sqlstatement .= " group by tracks.id order by random() limit (100-$dstm_percentagetoprated); 123 | "; 124 | 125 | $sqlstatement .= "create temporary table randomweightedratingshigh as select tracks.url as url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating >= $topratedminrating"; 126 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 127 | $sqlstatement .= $shared_curlib_sql; 128 | } else { 129 | $sqlstatement .= $shared_completelib_sql; 130 | } 131 | if ($excludedgenrelist ne '') { 132 | $sqlstatement .= $excludegenre_sql; 133 | } 134 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_percentagetoprated; 135 | "; 136 | $sqlstatement .= "create temporary table randomweightedratingscombined as select * from randomweightedratingslow union select * from randomweightedratingshigh; 137 | select * from randomweightedratingscombined order by random() limit $dstm_batchsizenewtracks; 138 | drop table randomweightedratingshigh; 139 | drop table randomweightedratingslow; 140 | drop table randomweightedratingscombined;"; 141 | } 142 | 143 | # Mix: "Rated (seed genres)" 144 | if ($mixtype eq 'rated_genre') { 145 | my $dstm_includegenres = getSeedGenres($client); 146 | $sqlstatement = "select tracks.url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating > 0"; 147 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 148 | $sqlstatement .= $shared_curlib_sql; 149 | } else { 150 | $sqlstatement .= $shared_completelib_sql; 151 | } 152 | if ($excludedgenrelist ne '') { 153 | $sqlstatement .= $excludegenre_sql; 154 | } 155 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_batchsizenewtracks;"; 156 | } 157 | 158 | # Mix: "Rated (seed genres with % of top rated)" 159 | if ($mixtype eq 'rated_genre_toprated') { 160 | my $dstm_includegenres = getSeedGenres($client); 161 | $sqlstatement = "drop table if exists randomweightedratingshigh; 162 | drop table if exists randomweightedratingslow; 163 | drop table if exists randomweightedratingscombined; 164 | create temporary table randomweightedratingslow as select tracks.url as url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating < $topratedminrating"; 165 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 166 | $sqlstatement .= $shared_curlib_sql; 167 | } else { 168 | $sqlstatement .= $shared_completelib_sql; 169 | } 170 | if ($excludedgenrelist ne '') { 171 | $sqlstatement .= $excludegenre_sql; 172 | } 173 | $sqlstatement .= " group by tracks.id order by random() limit (100-$dstm_percentagetoprated); 174 | "; 175 | $sqlstatement .="create temporary table randomweightedratingshigh as select tracks.url as url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating >= $topratedminrating"; 176 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 177 | $sqlstatement .= $shared_curlib_sql; 178 | } else { 179 | $sqlstatement .= $shared_completelib_sql; 180 | } 181 | if ($excludedgenrelist ne '') { 182 | $sqlstatement .= $excludegenre_sql; 183 | } 184 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_percentagetoprated; 185 | "; 186 | $sqlstatement .= "create temporary table randomweightedratingscombined as select * from randomweightedratingslow union select * from randomweightedratingshigh; 187 | select * from randomweightedratingscombined order by random() limit $dstm_batchsizenewtracks; 188 | drop table randomweightedratingshigh; 189 | drop table randomweightedratingslow; 190 | drop table randomweightedratingscombined;"; 191 | } 192 | 193 | # Mix: "Unrated (with % of rated songs)" 194 | if ($mixtype eq 'unrated_rated') { 195 | $sqlstatement = "drop table if exists randomweightedratingsrated; 196 | drop table if exists randomweightedratingsunrated; 197 | drop table if exists randomweightedratingscombined; 198 | create temporary table randomweightedratingsunrated as select tracks.url as url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and (tracks_persistent.rating = 0 or tracks_persistent.rating is null)"; 199 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 200 | $sqlstatement .= $shared_curlib_sql; 201 | } else { 202 | $sqlstatement .= $shared_completelib_sql; 203 | } 204 | if ($excludedgenrelist ne '') { 205 | $sqlstatement .= $excludegenre_sql; 206 | } 207 | $sqlstatement .= " group by tracks.id order by random() limit (100-$dstm_percentagerated); 208 | "; 209 | 210 | $sqlstatement .= "create temporary table randomweightedratingsrated as select tracks.url as url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating > 0"; 211 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 212 | $sqlstatement .= $shared_curlib_sql; 213 | } else { 214 | $sqlstatement .= $shared_completelib_sql; 215 | } 216 | if ($excludedgenrelist ne '') { 217 | $sqlstatement .= $excludegenre_sql; 218 | } 219 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_percentagerated; 220 | "; 221 | $sqlstatement .= "create temporary table randomweightedratingscombined as select * from randomweightedratingsunrated union select * from randomweightedratingsrated; 222 | select * from randomweightedratingscombined order by random() limit $dstm_batchsizenewtracks; 223 | drop table randomweightedratingsrated; 224 | drop table randomweightedratingsunrated; 225 | drop table randomweightedratingscombined;"; 226 | } 227 | 228 | # Mix: "Unrated (seed genres with % of rated songs)" 229 | if ($mixtype eq 'unrated_rated_genre') { 230 | my $dstm_includegenres = getSeedGenres($client); 231 | $sqlstatement = "drop table if exists randomweightedratingsrated; 232 | drop table if exists randomweightedratingsunrated; 233 | drop table if exists randomweightedratingscombined; 234 | create temporary table randomweightedratingsunrated as select tracks.url as url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and (tracks_persistent.rating = 0 or tracks_persistent.rating is null)"; 235 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 236 | $sqlstatement .= $shared_curlib_sql; 237 | } else { 238 | $sqlstatement .= $shared_completelib_sql; 239 | } 240 | if ($excludedgenrelist ne '') { 241 | $sqlstatement .= $excludegenre_sql; 242 | } 243 | $sqlstatement .= " group by tracks.id order by random() limit (100-$dstm_percentagerated); 244 | "; 245 | 246 | $sqlstatement .= "create temporary table randomweightedratingsrated as select tracks.url as url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating > 0"; 247 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 248 | $sqlstatement .= $shared_curlib_sql; 249 | } else { 250 | $sqlstatement .= $shared_completelib_sql; 251 | } 252 | if ($excludedgenrelist ne '') { 253 | $sqlstatement .= $excludegenre_sql; 254 | } 255 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_percentagerated; 256 | "; 257 | $sqlstatement .= "create temporary table randomweightedratingscombined as select * from randomweightedratingsunrated union select * from randomweightedratingsrated; 258 | select * from randomweightedratingscombined order by random() limit $dstm_batchsizenewtracks; 259 | drop table randomweightedratingsrated; 260 | drop table randomweightedratingsunrated; 261 | drop table randomweightedratingscombined;"; 262 | } 263 | 264 | # Mix: "Unrated (unplayed, with % of rated songs)" 265 | if ($mixtype eq 'unrated_rated_unplayed') { 266 | $sqlstatement = "drop table if exists randomweightedratingsrated; 267 | drop table if exists randomweightedratingsunrated; 268 | drop table if exists randomweightedratingscombined; 269 | create temporary table randomweightedratingsunrated as select tracks.url as url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and (tracks_persistent.rating = 0 or tracks_persistent.rating is null) and (tracks_persistent.playCount = 0 or tracks_persistent.playCount is null)"; 270 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 271 | $sqlstatement .= $shared_curlib_sql; 272 | } else { 273 | $sqlstatement .= $shared_completelib_sql; 274 | } 275 | if ($excludedgenrelist ne '') { 276 | $sqlstatement .= $excludegenre_sql; 277 | } 278 | $sqlstatement .= " group by tracks.id order by random() limit (100-$dstm_percentagerated); 279 | "; 280 | 281 | $sqlstatement .= "create temporary table randomweightedratingsrated as select tracks.url as url from tracks join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating > 0 and (tracks_persistent.playCount = 0 or tracks_persistent.playCount is null)"; 282 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 283 | $sqlstatement .= $shared_curlib_sql; 284 | } else { 285 | $sqlstatement .= $shared_completelib_sql; 286 | } 287 | if ($excludedgenrelist ne '') { 288 | $sqlstatement .= $excludegenre_sql; 289 | } 290 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_percentagerated; 291 | "; 292 | $sqlstatement .= "create temporary table randomweightedratingscombined as select * from randomweightedratingsunrated union select * from randomweightedratingsrated; 293 | select * from randomweightedratingscombined order by random() limit $dstm_batchsizenewtracks; 294 | drop table randomweightedratingsrated; 295 | drop table randomweightedratingsunrated; 296 | drop table randomweightedratingscombined;"; 297 | } 298 | 299 | # Mix: "Unrated (unplayed, seed genres with % of rated songs)" 300 | if ($mixtype eq 'unrated_rated_unplayed_genre') { 301 | my $dstm_includegenres = getSeedGenres($client); 302 | $sqlstatement = "drop table if exists randomweightedratingsrated; 303 | drop table if exists randomweightedratingsunrated; 304 | drop table if exists randomweightedratingscombined; 305 | create temporary table randomweightedratingsunrated as select tracks.url as url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and (tracks_persistent.rating = 0 or tracks_persistent.rating is null) and (tracks_persistent.playCount = 0 or tracks_persistent.playCount is null)"; 306 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 307 | $sqlstatement .= $shared_curlib_sql; 308 | } else { 309 | $sqlstatement .= $shared_completelib_sql; 310 | } 311 | if ($excludedgenrelist ne '') { 312 | $sqlstatement .= $excludegenre_sql; 313 | } 314 | $sqlstatement .= " group by tracks.id order by random() limit (100-$dstm_percentagerated); 315 | "; 316 | 317 | $sqlstatement .= "create temporary table randomweightedratingsrated as select tracks.url as url from tracks join genre_track on genre_track.track=tracks.id and genre_track.genre in ($dstm_includegenres) join tracks_persistent on tracks_persistent.urlmd5 = tracks.urlmd5 and tracks_persistent.rating > 0 and (tracks_persistent.playCount = 0 or tracks_persistent.playCount is null)"; 318 | if ((defined $currentLibrary) && ($currentLibrary ne '')) { 319 | $sqlstatement .= $shared_curlib_sql; 320 | } else { 321 | $sqlstatement .= $shared_completelib_sql; 322 | } 323 | if ($excludedgenrelist ne '') { 324 | $sqlstatement .= $excludegenre_sql; 325 | } 326 | $sqlstatement .= " group by tracks.id order by random() limit $dstm_percentagerated; 327 | "; 328 | $sqlstatement .= "create temporary table randomweightedratingscombined as select * from randomweightedratingsunrated union select * from randomweightedratingsrated; 329 | select * from randomweightedratingscombined order by random() limit $dstm_batchsizenewtracks; 330 | drop table randomweightedratingsrated; 331 | drop table randomweightedratingsunrated; 332 | drop table randomweightedratingscombined;"; 333 | } 334 | 335 | my $dbh = Slim::Schema->dbh; 336 | for my $sql (split(/[\n\r]/,$sqlstatement)) { 337 | eval { 338 | my $sth = $dbh->prepare($sql); 339 | $sth->execute() or do { 340 | $sql = undef; 341 | }; 342 | if ($sql =~ /^\(*select+/oi) { 343 | my $trackURL; 344 | $sth->bind_col(1,\$trackURL); 345 | 346 | while ($sth->fetch()) { 347 | my $track = Slim::Schema->resultset('Track')->objectForUrl($trackURL); 348 | push @{$tracks}, $track; 349 | } 350 | } 351 | $sth->finish(); 352 | }; 353 | } 354 | my $tracksfound = scalar @{$tracks} || 0; 355 | main::DEBUGLOG && $log->is_debug && $log->debug('RL DSTM - tracks found/used: '.$tracksfound); 356 | # Prune previously played playlist tracks 357 | my $songIndex = Slim::Player::Source::streamingSongIndex($client); 358 | my $dstm_playedtrackstokeep = $prefs->get('dstm_playedtrackstokeep'); 359 | if ($songIndex) { 360 | for (my $i = 0; $i < $songIndex - $dstm_playedtrackstokeep; $i++) { 361 | my $request = $client->execute(['playlist', 'delete', 0]); 362 | $request->source('PLUGIN_RATINGSLIGHT'); 363 | } 364 | } 365 | 366 | $cb->($client, $tracks); 367 | } 368 | 369 | sub getSeedGenres { 370 | my $client = shift; 371 | my $dstm_num_seedtracks = $prefs->get('dstm_num_seedtracks'); 372 | my $seedTracks = Slim::Plugin::DontStopTheMusic::Plugin->getMixableProperties($client, $dstm_num_seedtracks); 373 | 374 | if ($seedTracks && ref $seedTracks && scalar @{$seedTracks}) { 375 | my @seedIDs = (); 376 | my @seedsToUse = (); 377 | foreach my $seedTrack (@{$seedTracks}) { 378 | my ($trackObj) = Slim::Schema->find('Track', $seedTrack->{id}); 379 | if ($trackObj) { 380 | push @seedsToUse, $trackObj; 381 | push @seedIDs, $seedTrack->{id}; 382 | } 383 | } 384 | 385 | if (scalar @seedsToUse > 0) { 386 | my $genrelist; 387 | foreach my $thisID (@seedIDs) { 388 | my $track = Slim::Schema->resultset('Track')->find($thisID); 389 | my $thisgenreid = $track->genre->id; 390 | main::DEBUGLOG && $log->is_debug && $log->debug('seed genrename = '.$track->genre->name.' -- genre ID: '.$thisgenreid); 391 | push @{$genrelist},$thisgenreid; 392 | } 393 | my @filteredgenrelist = sort (uniq(@{$genrelist})); 394 | my $includedgenrelist = join (',', @filteredgenrelist); 395 | return $includedgenrelist; 396 | } 397 | } 398 | } 399 | 400 | sub getExcludedGenreList { 401 | my $excludegenres_namelist = $prefs->get('excludegenres_namelist'); 402 | my $excludedgenreString = ''; 403 | if ((defined $excludegenres_namelist) && (scalar @{$excludegenres_namelist} > 0)) { 404 | $excludedgenreString = join ',', map qq/'$_'/, @{$excludegenres_namelist}; 405 | } 406 | return $excludedgenreString; 407 | } 408 | 409 | sub uniq { 410 | my %seen; 411 | grep !$seen{$_}++, @_; 412 | } 413 | 414 | 1; 415 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Ratings Light 2 | ==== 3 | ![Min. LMS Version](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Fraw.githubusercontent.com%2FAF-1%2Fsobras%2Fmain%2Frepos%2Flms%2Fpublic.xml&query=%2F%2F*%5Blocal-name()%3D'plugin'%20and%20%40name%3D'RatingsLight'%5D%2F%40minTarget&prefix=v&label=Min.%20LMS%20Version%20Required&color=darkgreen)
4 | 5 | **Ratings Light** takes care of rating tracks in your LMS library. See [**features**](#features) section for details. 6 |

7 | 8 | ⬅️ Back to the list of all plugins 9 |

10 | 11 | **Use the**    **icon** (top right) to **jump directly to a specific section.** 12 | 13 |

14 | 15 | 16 | ## Features 17 | 18 | * **set** track ratings 19 | * in your browser using web skins like *(Dark) Default* or *Material* 20 | * on your Logitech devices or piCorePlayer (context menu) 21 | * using the IR remote of your (Logitech) device 22 | * in supported apps and plugins 23 | * supports **incremental** rating changes 24 | 25 | * **import** track ratings 26 | * batch rate all tracks in a playlist 27 | * from file tags 28 | * using keywords in *comments* tags (auto-import after scan is possible) 29 | * using the *BPM* tag 30 | * auto-import after a (re)scan is possible 31 | 32 | * **export** rated tracks to playlist files (as a backup or to import ratings in other apps) 33 | * create **virtual libraries for (top) rated tacks** with *browse menus*[^1] 34 | * *create* (scheduled) **backups** of your ratings and *restore* your ratings from backups 35 | * keep track of your **recently rated songs** with a dedicated *playlist* or a plain text *log file* 36 | * **show rated songs** for any *artist, album, genre, year* or *playlist* from the **context menu** 37 | * includes mixes for the **Don't Stop The Music** plugin 38 | * *display track ratings* in *LMS menus* (web UI and text) or on older devices using the *Now Playing screensaver* or the *Music Information Screen* plugin 39 | * most features should work with **online library tracks** (see [FAQ](#faq)) 40 | 41 | Some features are not enabled by default.
You can enable them here: `LMS > Settings > Advanced > Ratings Light` 42 |



43 | 44 | 45 | ## Screenshots[^2] 46 | 47 | #### LMS web ui view: 48 | ![LMS web UI](screenshots/lms_webui.jpg) 49 |


50 | #### piCorePlayer - *Show more rated tracks by artist* view 51 | ![piCorePlayer - Show more rated tracks](screenshots/picoreplayer_show_more_rated_tracks.jpg) 52 |


53 | #### Boom - ratings display, rating menu, *show more rated tracks by artist* view 54 | ![Boom - ratings menus](screenshots/boom.jpg) 55 |


56 | #### *Rated Tracks* browse menus 57 | ![Rated Tracks - Home Menu](screenshots/ratedtracksmenu.jpg) 58 |


59 | #### *Rated Tracks* context menu 60 | ![Rated Tracks - Context Menu](screenshots/contextmenu_years.jpg)

61 | (available for artist, album, genre, year and playlist) 62 |



63 | #### Ratings Light *Settings* pages 64 | ![Rated Tracks - Home Menu](screenshots/rl_settings_preview.gif) 65 |


66 | 67 | 68 | 69 | ## Installation 70 | 71 | *Ratings Light* is available from the LMS plugin library: `LMS > Settings > Manage Plugins`.
72 | 73 | If you want to test a new patch that hasn't made it into a release version yet, you'll have to [install the plugin manually](https://github.com/AF-1/sobras/wiki/Manual-installation-of-LMS-plugins). 74 |



75 | 76 | 77 | ## Report a new issue 78 | 79 | To report a new issue please file a GitHub [**issue report**](https://github.com/AF-1/lms-ratingslight/issues/new/choose). 80 |


81 | 82 | 83 | ## ⭐ Help others discover this project 84 | 85 | If you find this project useful, giving it a star (top right of this page) is a great way to show your support and help others discover it. Thank you. 86 |



87 | 88 | 89 | ## 💡 Display and set ratings on the Now Playing screen 90 | 91 | You can install an [**applet**](https://github.com/AF-1#applets) on your *piCorePlayer*, *SB Touch*, *SB Radio* or *SqueezePlay* to **display track ratings** on the **Now Playing** screen.
On devices with a ***touch*** screen (piCorePlyer, SB Touch) you can also *set* ratings directly on the NowPlaying screen. 92 | 93 | #### pCP, Touch, SqueezePlay 94 | ![display ratings on the now playing screen of jivelite players](screenshots/ratings_npscreen_jivelite.jpg) 95 |

96 | 97 | #### SB Radio 98 | ![display ratings on the now playing screen of SB Radio](screenshots/ratings_npscreen_radio.jpg) 99 |



100 | 101 | 102 | ## 💡 Display track titles in menus or lists with appended rating stars 103 | 104 | If you look at the [screenshots](#screenshots2), you will notice that in some menus the *titles* of rated tracks are followed by rating stars. This can be very helpful in client playlists or album view menus to figure out right away which tracks are rated and their invididual ratings (instead of having to enter the song details menu of every track).

105 | Here's how to achieve this:
106 | First go to `LMS settings > Interface` and create a so-called *title format* with this name:
`TITLE RL_RATING_STARS_APPENDED`. Then select it and click `Apply`.
107 | 108 | By default, a rating star is displayed as a common asterisk \*. But the **unicode 2605 blackstar** character ★ is prettier. Go to `LMS Settings > Advanced > Ratings Light > Menus` where you can *choose the displayed rating character for menus and titel formats* and set it to the black star.

109 | There is one problem: On some players like *SB Touch, SB Radio, piCorePlayer, Squeezeplay and other players running jivelite* the unicode blackstar character is **not part of the *default* font**. You'll have to install the font manually via SSH, the Font Replacer applet.

💡 If you have installed and selected the [**Dark Flat Skin**](https://github.com/AF-1/jivelite-darkflatskin) as the skin on your device, you don't have to do anything. The DFS applet already includes and uses the necessary font files to display the black star in supported menus and lists.
110 | 111 |
112 | 113 | > [!NOTE] 114 | > A few menus and lists (e.g. jivelite's current track list) do not use title formats. You will only see the track title without appended rating stars.
115 | > And the **Material** web skin uses its own way to display track ratings in menus and playlists. 116 | 117 |




118 | 119 | 120 | ## FAQ 121 |
»What rating scale does this plugin use?«
    »Can I use / disable half-star ratings?«

Rating values are stored in the tracks_persistent database table provided by LMS. Internal rating values in LMS can range from 0 (no stars) to 100 (5 stars) where 20 equals 1 star (40 = 2 stars, 50 = 2.5 stars etc.). So how rating values are stored in LMS is a default that cannot be changed.

Ratings Light will always display the exact half-star value on a 5-star rating scale (e.g. LMS track rating value of 50 is displayed as 2.5 stars). You can enable or disable setting half-star ratings on this page: LMS settings > Advanced > Ratings Lights > Menus.
If, for some reason, you have tracks with odd track rating values (e.g. 67), Ratings Light will round them to the nearest half-star rating - for display only, the actual rating values remain unchanged.


122 | 123 |
»Is album rating supported?«

“Album ratings“ as such do not exist in LMS, only track ratings. You can set a rating for all or only the unrated tracks in an album using the album context menu. Setting ratings for single album tracks in this menu is possible with the Default, Dark Default and Classic web skin.

RL does not display “album ratings“, i.e. the average track rating of all album tracks. Most albums would probably have a very low average track rating (displayed as zero stars) and you'd have to display the “album rating“ in the album context menu.
If you want albums sorted by (average) rating, take a look at the Context Stats plugin.


124 | 125 |
»I have ratings display issues (ratings not displayed, wrong rating values…)«

Ratings Light is only responsible for displaying ratings in 2 places (see screenshot):
in the track context / song info menu and via the title format if you use e.g. "RL_RATING_STARS_APPENDED".
So while Ratings Light is always used to set ratings, plugins, skins or apps usually ask LMS directly for the rating value. RL is not involved. That's why RL plays, for example, no role in displaying rating values in Material Skin's playlist queue or track / album lists.

126 | You can always see the actual rating value for a track in the LMS database by going to the context / song info menu of the track and looking for the Rating tag. It shows the rating value in the LMS scale from 0 to 100 where 20 = 1 star. You'll have to reload this menu after changing the rating value to see the new rating value.

127 | Possible causes of problems:
128 | 129 | - You have duplicate tracks/albums (e.g different audio formats) and your files have the same MusicBrainz ID tags. LMS often tries to match tracks on MusicBrainz IDs first.
130 | 131 | - Your audio files have RATING tags that LMS may use to display ratings.
132 | 133 | - You used TrackStat before switching to Ratings Light. But then you (briefly) reinstalled TrackStat (don't!). TS might have reset the ratings that you've set with RL in the meantime. 134 | 135 | In short, Ratings Light has usually nothing to do with displaying ratings, except for the track context / song info menu and the title format. 136 |


137 | 138 |
»Does Ratings Light work with online tracks?«

It should work with online tracks that have been added to your LMS library as part of an album. LMS does not import single online tracks or tracks of online playlists as library tracks and therefore they cannot be processed by Ratings Light. That's a restriction imposed by LMS.


139 | 140 |
»I have renamed / moved some audio files. How can I preserve my ratings for these tracks?«

141 | You can use backups. Go to the plugin's settings page (backup section) immediately before you rescan your library and confirm that Backup before each library rescan is enabled. Just to be safe on the safe side, create a manual backup as well.
Then rescan your library. With the rescan completed, go to the plugin's settings page and restore the rating values from the pre-scan backup. RL will try to restore the ratings for moved/renamed tracks using (relative) path guessing and MusicBrainz IDs. Of course, there's no guarantee that it will restore 100% but that's as good as it gets. 142 |


143 | 144 |
»Where does Ratings Light store track ratings?«

Ratings Light does not use its own database. It tells LMS to store the track ratings in the LMS persistent database which is not cleared on rescans. However, if you value your ratings very much, I'd recommend to enable scheduled backups in RL. Or at least create occasional manual backups.


145 | 146 |
»Which buttons on the IR remote control should I use for rating?«
    »Which devices are supported?«

147 | To enable IR remote rating:
148 | 149 | - SB Classic, Boom, Transporter, other VFD devices:
150 | 151 | - rating is handled on the server side.
152 | 153 | - enable the Quick rating with IR remote buttons setting on the plugin's settings page and restart the server.
154 | 155 | - SB Touch:
156 | 157 | - IR remote rating is handled by an applet on the device. The plugin setting Quick rating with IR remote buttons has no effect.
158 | 159 | - Install an applet that enables and handles remote rating like the Dark Flat Skin applet. 160 | 161 | Rate the track currently playing on your device by holding down a button on the IR remote.
Press and hold the key until you see the new track rating on your display or a message confirming the new track rating.

Key map:
162 | 163 | - keys 1 to 5 = 1 to 5 stars
164 | - 0 = unrate
165 | - 6 = subtract 1 star from current rating
166 | - 7 = add 1 star to current rating
167 | - 8 = subtract 0.5 stars from current rating
168 | - 9 = add 0.5 stars to current rating 169 | 170 | The keys are the same for all supported devices except for the
171 | Boom (mini remote):
172 | 173 | - arrow up = add 1 star to current rating
174 | - arrow down = subtract 1 star from current rating 175 |


176 | 177 |
»Does Ratings Light auto-rate tracks when I play or skip them?«

No. Please use the Alternative Play Count plugin for that. It can auto-rate tracks and offers you an alternative, the dynamic played/skipped value that reflects your recent listening habits/decisions but does not mess with your tracking ratings.


178 | 179 |
»How do I migrate ratings from TrackStat to Ratings Light?«

You don't have to. Since ratings are stored in an LMS database (see FAQ above), you just uninstall TrackStat and install Ratings Light. TrackStat had its own database table (with identical columns though) but ratings should be in sync. You can even import ratings for local tracks from old TrackStat backup files.


180 | 181 |
»How does importing ratings from file tags work?«

Ratings Light does not scan files, it has no scanner module. LMS scans your music files and stores the data found in the file tags in the LMS database. RL does not create or use its own database table.
182 | Importing rating values from file tags with RL therefore means that RL reads the file tag values stored in the LMS database, converts them to rating values and saves them to the LMS persistent database. It does not scan your files.

183 | If you have tracks with dedicated rating tags which are not supported and imported by LMS, you can use the Custom Tag Importer plugin to scan these tags and set LMS track ratings accordingly.

184 | Unfortunately, there is no universal rating tag that is supported by music file formats across different music players - and scanned/imported by LMS.
So if you can't use Custom Tag Importer to import your ratings into LMS, you'll have to use/repurpose a file tag that you don't use otherwise and, more importantly, one that is scanned and imported by LMS.

185 | In Ratings Light you can choose between the BPM tag and the comments tag to import ratings values from.

186 | RL expects integer rating values on a 10-step rating scale from 0 to 100 in the BPM tag (corresponding to the internal LMS rating scale).
→ 0 or no value = unrated
→ 10 = 0.5 stars
→ 20 = 1 star
...
→ 100 = 5 stars

187 | If you want to use the comments tag, choose at least one short keyword to prefix the rating value. You can also choose a keyword suffix. RL expects integer rating values (no half-star ratings) on a scale from 1 to 5 for importing from comments tags.
188 | Example:
Rating keyword prefix = "favstars", rating keyword suffix = "xx".
If a comments tag contains "favstars4xx", RL will save the track rating value for 4 stars. 189 |


190 | 191 |
»When I create a backup, RL does not write a backup file.«
    »When I export rated tracks to playlist files, RL does not write any playlist files.«

192 | The RatingsLight folder is where RL stores its backup files and playlist files. On every LMS (re)start, RL checks if there's a folder called RatingsLight in the parent folder. The default parent folder is the LMS preferences folder but you can change that in RL's preferences. If it doesn't find the folder RatingsLight inside the specified parent folder, it will try to create it.

193 | The most likely cause is that RL can't create the folder because LMS doesn't have read/write permissions for the parent folder (or the RatingsLight folder). You'll probably find matching error messages in the server log.

194 | So please make sure that LMS has read/write permissions (755) for the parent folder - and the RatingsLight folder (if it exists but cannot be accessed). 195 |


196 | 197 |
»Can Ratings Light sync track ratings to music streaming providers or other online services?«

Short answer: no. Many music streaming providers and online services now use a binary scheme (e.g. called like or heart) to "rate" tracks, albums or artists. But even if some still supported a 5-star rating scale, I simply would not have the time to keep RL compatible with possible (API) changes of all those different services in the long run.
If you wanted to reduce star track ratings to binary likes or hearts and sync them to a specific online service, this should be done by the LMS plugin for this specific online services.


198 | 199 |
»Can I use CLI commands to set ratings?«

200 | Explained in the wiki. 201 |


202 | 203 |
»How is the Recently Rated playlist different from the Recently Rated log file?«

204 | In general, whenever you change a track's rating with Ratings Light (web interface, jivelite, CLI...) the track is added to the playlist and/or the log file if you've enabled this in the settings. Both are meant to help you keep track of your rating actions, i.e. the tracks whose rating you've changed.
205 | 206 | 207 | The recently rated playlist keeps a record of all tracks with changed ratings but 208 | - it will not add tracks twice. Example: Set a track's rating to 4 stars, then set it to 2 stars. The track will only show up only once in the playlist with the latest rating (2 stars), no matter how often you have changed its rating. 209 | - Unrating a track (rating = 0) will not delete this track from the playlist because unrating is a rating change too.
210 | 211 | If you want to keep detailed track of your rating actions and don't need a playable list, I suggest you use the log file.


212 | 213 |
»Can I use Ratings Light together with TrackStat?«

You really shouldn't. If you rate tracks with Ratings Light, these rating changes will be lost the next time you restart your server because TrackStat will reset the LMS database ratings to the TrackStat database values.


214 | 215 |
»Does Ratings Light work with iPeng?«

Displaying and changing track ratings in iPeng is already possible via the context menu.
iPeng additionally offers the possibility to display and change track ratings directly in the top left menu bar. iPeng has no official support for Ratings Light yet.
However, you'll find a workaround in the Menus section of the RL settings that should allow you to display and change track ratings directly in iPeng's top left menu bar (requires an LMS restart).


216 | 217 |
»Can this plugin be displayed in my language?«

If you want localized strings in your language, please read this.

218 |


219 | 220 | [^1]: Browse menus are provided by LMS. Under certain circumstances you may see (empty) albums or artists in some menus that shouldn't be there. There's nothing I can do about it because LMS creates and provides these menus.
Just go down one level: click to *show all tracks* or *show all albums*.
In case this LMS issue ever gets resolved, I'll update this page. 221 | [^2]: The screenshots might not correspond to the UI of the latest release in every detail. 222 | 223 | -------------------------------------------------------------------------------- /RatingsLight/HTML/EN/plugins/RatingsLight/html/ratealbumtracksoptions.html: -------------------------------------------------------------------------------- 1 | [% thisname = 'PLUGIN_RATINGSLIGHT_RATEALBUM' | string %] 2 | [% pagetitle = 'PLUGIN_RATINGSLIGHT_WEB_ALBUMRATE_INFOPREFIX' | string; pagetitle = pagetitle _ " (" _ albumname _ ") ";IF systemSkin == 'Classic';pagetitle = pagetitle _ "/ ";ELSE;pagetitle = pagetitle _ "> ";END;pagetitle = pagetitle _ thisname %] 3 | [% pwd_list = [ pagetitle ] %] 4 | [% PROCESS pageheader.html %] 5 | 107 |
108 | [% IF systemSkin == "DarkDefault" || systemSkin == "DarkLogic" || systemSkin == "Default" || systemSkin == "Logic" || systemSkin == "Classic" %] 109 | [% WRAPPER contentcontainer %] 110 | [% odd = 1 %] 111 | [% IF trackcount > 1 %] 112 | [% BLOCK controls_allsongs %] 113 |
114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 |   138 | 139 | 140 | 141 | 142 | 143 |
144 | [% END %] 145 | [%- WRAPPER contentitem controls='controls_allsongs' %] 146 | 147 | [% IF systemSkin != "Classic" %] 148 | 149 | [% END %] 150 | 151 | [% "PLUGIN_RATINGSLIGHT_RATEALBUM_OPTIONS_ALL" | string %] 152 | 153 | [% END %] 154 | [% odd = (not odd) %] 155 | [% IF unratedtrackcount > 1 && unratedtrackcount != trackcount %] 156 | [% BLOCK controls_allunratedsongs %] 157 |
158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 |   182 | 183 | 184 | 185 | 186 |
187 | [% END %] 188 | [%- WRAPPER contentitem controls='controls_allunratedsongs' %] 189 | 190 | [% IF systemSkin != "Classic" %] 191 | 192 | [% END %] 193 | 194 | [% "PLUGIN_RATINGSLIGHT_RATEALBUM_OPTIONS_UNRATED_ALL" | string %] 195 | 196 | [% END %] 197 | [% odd = (not odd) %] 198 | [% END %] 199 | [% END %] 200 | 201 | [% FOREACH albumtrack IN albumtracks %] 202 | [% BLOCK controls %] 203 |
204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 |   228 | 229 | 230 | 231 | 232 | 233 |
234 | 235 | [% END %] 236 | [%- WRAPPER contentitem controls='controls' %] 237 | 238 | [% IF systemSkin == "Classic" %] 239 | 240 | [% albumtrack.tracktitle %]  by  241 | [% albumtrack.artistname %] 242 | 243 | [% ELSE %] 244 | 245 | 246 | 247 | 248 | [% albumtrack.tracktitle %] 249 |
250 | [% albumtrack.artistname %] 251 | 252 | [% END %] 253 | 254 | [% END %] 255 | [% odd = (not odd) %] 256 | [% END %] 257 | [% END %] 258 | 259 | 468 | [% ELSE %] 469 |
470 | [% "PLUGIN_RATINGSLIGHT_RATEALBUM_HEADER" | string %] [% albumname %] 471 |
472 |
473 |
474 | 475 | 476 | 479 | 480 |   481 | 482 | 489 | 490 |   491 | 492 | 493 | 496 | 497 |
477 |   [% "PLUGIN_RATINGSLIGHT_RATEALBUM_ONLYUNRATED" | string %] 478 |
483 | 488 |
494 | 495 |
498 |
499 |
500 |
501 | [% IF failed %]

502 |
503 | [% "PLUGIN_RATINGSLIGHT_RATEALBUM_FAILED" | string %] 504 |
505 | [% END %] 506 | [% IF albumrated %] 507 | 510 | [% END %] 511 | [% END %] 512 | [% PROCESS pagefooter.html %] 513 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | ◔_◔ 677 | --------------------------------------------------------------------------------