-
Notifications
You must be signed in to change notification settings - Fork 304
/
slimserver.pl
executable file
·1117 lines (885 loc) · 30.3 KB
/
slimserver.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl
# Logitech Media Server Copyright 2001-2024 Logitech.
# Lyrion Music Server Copyright 2024 Lyrion Community.
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License,
# version 2.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
require 5.010;
use strict;
use constant SCANNER => 0;
use constant RESIZER => 0;
use constant ISWINDOWS => ( $^O =~ /^m?s?win/i ) ? 1 : 0;
use constant ISMAC => ( $^O =~ /darwin/i ) ? 1 : 0;
use constant TRANSCODING => ( grep { /--notranscoding/ } @ARGV ) ? 0 : 1;
use constant PERFMON => ( grep { /--perfwarn/ } @ARGV ) ? 1 : 0;
use constant DEBUGLOG => ( grep { /--no(?:debug|info)log/ } @ARGV ) ? 0 : 1;
use constant INFOLOG => ( grep { /--noinfolog/ } @ARGV ) ? 0 : 1;
use constant STATISTICS => ( grep { /--nostatistics/ } @ARGV ) ? 0 : 1;
use constant SB1SLIMP3SYNC=> ( grep { /--nosb1slimp3sync/ } @ARGV ) ? 0 : 1;
use constant WEBUI => ( grep { /--noweb/ } @ARGV ) ? 0 : 1;
use constant NOMYSB => 1;
use constant LOCALFILE => ( grep { /--localfile/ } @ARGV ) ? 1 : 0;
use constant NOBROWSECACHE=> ( grep { /--nobrowsecache/ } @ARGV ) ? 1 : 0;
# leaving some legacy flags for the moment - unlikely but possibly some 3rd party plugin is referring to it
use constant SLIM_SERVICE => 0;
use constant NOUPNP => 0;
use constant ISACTIVEPERL => 0;
use Config;
my %check_inc;
$ENV{PERL5LIB} = join $Config{path_sep}, grep { !$check_inc{$_}++ } @INC;
package main;
use FindBin qw($Bin);
use lib $Bin;
our @argv;
our $REVISION = undef;
our $BUILDDATE = undef;
BEGIN {
# hack a Strawberry Perl specific path into the environment variable - XML::Parser::Expat needs it!
if (ISWINDOWS) {
my $path = File::Basename::dirname($^X);
$path =~ s/perl(?=.bin)/c/i;
$ENV{PATH} = "$path;" . $ENV{PATH} if -d $path;
}
our $VERSION = '9.1.0';
# With EV, only use select backend
# I have seen segfaults with poll, and epoll is not stable
$ENV{LIBEV_FLAGS} = 1;
# set the AnyEvent model to our subclassed version when PERFMON is enabled
$ENV{PERL_ANYEVENT_MODEL} = 'PerfMonEV' if main::PERFMON;
$ENV{PERL_ANYEVENT_MODEL} ||= 'EV';
# By default, tell Audio::Scan not to get artwork to save memory
# Where needed, this is locally changed to 0.
$ENV{AUDIO_SCAN_NO_ARTWORK} = 1;
# save argv
@argv = @ARGV;
use Slim::bootstrap;
use Slim::Utils::OSDetect;
Slim::bootstrap->loadModules();
};
use File::Slurp;
use Getopt::Long;
use File::Spec::Functions qw(:ALL);
use POSIX qw(setsid);
use Time::HiRes;
use EV;
use AnyEvent;
# Load AIO support if available
my $HAS_AIO;
sub HAS_AIO {
return $HAS_AIO if defined $HAS_AIO;
eval {
require AnyEvent::AIO;
IO::AIO::max_poll_time( 0.01 ); # Make AIO play nice if there are a lot of requests (10ms per poll)
$HAS_AIO = 1;
};
$HAS_AIO = 0 if !$HAS_AIO; # Make sure it is defined now.
return $HAS_AIO;
}
# Force XML::Simple to use XML::Parser for speed. This is done
# here so other packages don't have to worry about it. If we
# don't have XML::Parser installed, we fall back to PurePerl.
#
# Only use XML::Simple 2.15 an above, which has support for pass-by-ref
use XML::Simple qw(2.15);
eval {
local($^W) = 0; # Suppress warning from Expat.pm re File::Spec::load()
require XML::Parser;
};
if (!$@) {
$XML::Simple::PREFERRED_PARSER = 'XML::Parser';
}
use Slim::Utils::Log;
use Slim::Utils::Prefs;
use Slim::Utils::Misc;
use Slim::Buttons::Common;
use Slim::Buttons::Home;
use Slim::Buttons::Power;
use Slim::Buttons::ScreenSaver;
use Slim::Utils::PluginManager;
use Slim::Buttons::Synchronize;
use Slim::Buttons::Input::Text;
use Slim::Buttons::Input::Time;
use Slim::Buttons::Input::List;
use Slim::Buttons::Input::Choice;
use Slim::Buttons::Input::Bar;
use Slim::Buttons::Settings;
use Slim::Player::Client;
use Slim::Control::Request;
use Slim::Web::HTTP;
use Slim::Hardware::IR;
use Slim::Menu::TrackInfo;
use Slim::Menu::AlbumInfo;
use Slim::Menu::ArtistInfo;
use Slim::Menu::GenreInfo;
use Slim::Menu::YearInfo;
use Slim::Menu::SystemInfo;
use Slim::Menu::PlaylistInfo;
use Slim::Menu::FolderInfo;
use Slim::Menu::GlobalSearch;
use Slim::Menu::BrowseLibrary;
use Slim::Music::Info;
use Slim::Music::Import;
use Slim::Music::VirtualLibraries;
use Slim::Utils::OSDetect;
use Slim::Player::Playlist;
use Slim::Player::Sync;
use Slim::Player::Source;
use Slim::Utils::Cache;
use Slim::Utils::Scanner;
use Slim::Utils::Scanner::Local;
use Slim::Utils::Scheduler;
use Slim::Networking::Async::DNS;
use Slim::Networking::Select;
use Slim::Networking::UDP;
use Slim::Control::Stdio;
use Slim::Utils::Strings qw(string);
use Slim::Utils::Timers;
use Slim::Networking::Slimproto;
use Slim::Networking::SimpleAsyncHTTP;
use Slim::Utils::Firmware;
use Slim::Control::Jive;
use Slim::Formats::RemoteMetadata;
if ( SB1SLIMP3SYNC ) {
require Slim::Player::SB1SliMP3Sync;
}
if ( DEBUGLOG ) {
require Data::Dump;
require Slim::Utils::PerlRunTime;
}
my $sqlHelperClass = Slim::Utils::OSDetect->getOS()->sqlHelperClass();
eval "use $sqlHelperClass";
die $@ if $@;
our @AUTHORS = (
'Sean Adams',
'Vidur Apparao',
'Dean Blackketter',
'Kevin Deane-Freeman',
'Andy Grundman',
'Amos Hayes',
'Michael Herger',
'Christopher Key',
'Ben Klaas',
'Mark Langston',
'Eric Lyons',
'Scott McIntyre',
'Robert Moser',
'Felix Müller',
'Dave Nanian',
'Jacob Potter',
'Sam Saffron',
'Roy M. Silvernail',
'Adrian Smith',
'Richard Smith',
'Max Spicer',
'Dan Sully',
'Richard Titmuss',
'Alan Young'
);
my $prefs = preferences('server');
our $httpport = undef;
our (
$inInit,
$cachedir,
$tmpdir,
$user,
$group,
$cliaddr,
$cliport,
$daemon,
$diag,
$help,
$httpaddr,
$advertiseaddr,
$lastlooptime,
$logfile,
$logdir,
$logconf,
$debug,
$LogTimestamp,
$localClientNetAddr,
$localStreamAddr,
$newVersion,
$pidfile,
$prefsfile,
$priority,
$quiet,
$nosetup,
$noserver,
$norestart,
$stdio,
$stop,
$perfwarn,
$failsafe,
$checkstrings,
$charset,
$dbtype,
$d_startup, # Needed for Slim::bootstrap
);
sub init {
$inInit = 1;
# May get overridden by object-leak or nytprof usage below
$SIG{USR2} = \&Slim::Utils::Log::logBacktrace;
# Can only have one of NYTPROF and Object-Leak at a time
if ( $ENV{OBJECT_LEAK} ) {
require Devel::Leak::Object;
Devel::Leak::Object->import(qw(GLOBAL_bless));
$SIG{USR2} = sub {
Devel::Leak::Object::status();
warn "Dumping objects...\n";
};
}
# initialize the process and daemonize, etc...
srand();
($REVISION, $BUILDDATE) = Slim::Utils::Misc::parseRevision();
my $log = logger('server');
$log->error("Starting Lyrion Music Server (v$main::VERSION, $REVISION, $BUILDDATE) perl $] - " . $main::Config{archname});
if ($diag) {
eval "use diagnostics";
}
# force a charset from the command line
$Slim::Utils::Unicode::lc_ctype = $charset if $charset;
# If dbsource has been changed via settings, it overrides the default
if ( $prefs->get('dbtype') ) {
$dbtype ||= $prefs->get('dbtype') =~ /SQLite/ ? 'SQLite' : 'MySQL';
}
if ( $dbtype ) {
# For testing SQLite, can specify a different database type
$sqlHelperClass = "Slim::Utils::${dbtype}Helper";
eval "use $sqlHelperClass";
die $@ if $@;
}
Slim::Utils::OSDetect::init();
my $os = Slim::Utils::OSDetect->getOS();
# initialize server subsystems
initSettings();
# Redirect STDERR to the log file.
tie *STDERR, 'Slim::Utils::Log::Trapper';
main::INFOLOG && $log->info("OS Specific init...");
unless (main::ISWINDOWS) {
$SIG{'HUP'} = \&initSettings;
}
$SIG{'QUIT'} = \&Slim::bootstrap::sigquit;
$SIG{__WARN__} = sub { msg($_[0]) };
# Uncomment to enable crash debugging.
#$SIG{__DIE__} = \&Slim::Utils::Misc::bt;
# Start/stop profiler during runtime (requires Devel::NYTProf)
# and NYTPROF env var set to 'start=no'
if ( $ENV{NYTPROF} && $INC{'Devel/NYTProf.pm'} && $ENV{NYTPROF} =~ /start=no/ ) {
$SIG{USR1} = sub {
DB::enable_profile();
warn "Profiling enabled...\n";
};
$SIG{USR2} = sub {
DB::finish_profile();
warn "Profiling disabled...\n";
};
}
# background if requested
if (!main::ISWINDOWS && $daemon) {
main::INFOLOG && $log->info("Server daemonizing...");
daemonize();
} else {
if ($quiet) {
open STDOUT, '>>/dev/null';
}
save_pid_file();
}
# leave a mark for external tools
$failsafe ? $prefs->set('failsafe', 1) : $prefs->remove('failsafe');
# Change UID/GID after the pid & logfiles have been opened.
unless ($os->dontSetUserAndGroup() || (defined($user) && $> != 0)) {
main::INFOLOG && $log->info("Server settings effective user and group if requested...");
changeEffectiveUserAndGroup();
}
# Set priority, command line overrides pref
if (defined $priority) {
Slim::Utils::Misc::setPriority($priority);
} else {
Slim::Utils::Misc::setPriority( $prefs->get('serverPriority') );
}
# Generate a UUID for this SC instance on first-run
if ( !$prefs->get('server_uuid') ) {
require UUID::Tiny;
$prefs->set( server_uuid => UUID::Tiny::create_UUID_as_string( UUID::Tiny::UUID_V4() ) );
}
main::INFOLOG && $log->info("Server binary search path init...");
$os->initSearchPath();
# Find plugins and process any new ones now so we can load their strings
main::INFOLOG && $log->info("Server PluginManager init...");
Slim::Utils::PluginManager->init();
main::INFOLOG && $log->info("Server strings init...");
Slim::Utils::Strings::init();
# Load appropriate DB module
my $dbModule = $sqlHelperClass =~ /MySQL/ ? 'DBD::mysql' : 'DBD::SQLite';
Slim::bootstrap::tryModuleLoad($dbModule);
if ( $@ ) {
logError("Couldn't load $dbModule [$@]");
exit;
}
if ( $sqlHelperClass ) {
main::INFOLOG && $log->info("Server SQL init ($sqlHelperClass)...");
$sqlHelperClass->init();
}
main::INFOLOG && $log->info("Async DNS init...");
Slim::Networking::Async::DNS->init;
main::INFOLOG && $log->info("Async HTTP init...");
Slim::Networking::Async::HTTP->init;
Slim::Networking::SimpleAsyncHTTP->init;
main::INFOLOG && $log->info("Firmware init...");
Slim::Utils::Firmware->init;
main::INFOLOG && $log->info("Server Info init...");
Slim::Music::Info::init();
main::INFOLOG && $log->info("Server IR init...");
Slim::Hardware::IR::init();
main::INFOLOG && $log->info("Server Request init...");
Slim::Control::Request::init();
main::INFOLOG && $log->info("Server Queries init...");
Slim::Control::Queries->init();
main::INFOLOG && $log->info("Server Buttons init...");
Slim::Buttons::Common::init();
if ($stdio || ($ENV{LMS_STDIO} && $REVISION =~ /TRUNK|git-/)) {
main::INFOLOG && $log->info("Server Stdio init...");
Slim::Control::Stdio::init(\*STDIN, \*STDOUT);
}
main::INFOLOG && $log->info("UDP init...");
Slim::Networking::UDP::init();
main::INFOLOG && $log->info("Slimproto Init...");
Slim::Networking::Slimproto::init();
main::INFOLOG && $log->info("Cache init...");
Slim::Utils::Cache->init();
Slim::Schema->init();
Slim::Schema::RemoteTrack->init();
Slim::Music::VirtualLibraries->init();
# Register the default importers - necessary to ensure that Slim::Schema::init() is called
# but no need to initialize it, as it's being run in external scanner mode only
# XXX - we should be able to handle this differently
Slim::Music::Import->addImporter( 'Slim::Media::MediaFolderScan', {
type => 'file',
weight => 1,
use => 1,
} );
main::INFOLOG && $log->info("Server HTTP init...");
Slim::Web::HTTP::init();
if (main::TRANSCODING) {
main::INFOLOG && $log->info("Source conversion init..");
require Slim::Player::TranscodingHelper;
Slim::Player::TranscodingHelper::init();
}
if (WEBUI && !$nosetup) {
main::INFOLOG && $log->info("Server Web Settings init...");
require Slim::Web::Setup;
Slim::Web::Setup::initSetup();
}
main::INFOLOG && $log->info('Menu init...');
Slim::Menu::TrackInfo->init();
Slim::Menu::AlbumInfo->init();
Slim::Menu::ArtistInfo->init();
Slim::Menu::GenreInfo->init();
Slim::Menu::YearInfo->init();
Slim::Menu::SystemInfo->init();
Slim::Menu::PlaylistInfo->init();
Slim::Menu::FolderInfo->init();
Slim::Menu::GlobalSearch->init();
main::INFOLOG && $log->info('Server Alarms init...');
Slim::Utils::Alarm->init();
# load plugins before Jive init so MusicIP hooks to cached artist/genre queries from Jive->init() will take root
main::INFOLOG && $log->info("Server Load Plugins...");
Slim::Utils::PluginManager->load();
main::INFOLOG && $log->info("Server Jive init...");
Slim::Control::Jive->init();
# Reinitialize logging, as plugins may have been added.
if (Slim::Utils::Log->needsReInit) {
Slim::Utils::Log->reInit;
}
main::INFOLOG && $log->info("Server checkDataSource...");
checkDataSource();
if ( $os->canAutoRescan && $prefs->get('autorescan') ) {
require Slim::Utils::AutoRescan;
main::INFOLOG && $log->info('Auto-rescan init...');
Slim::Utils::AutoRescan->init();
}
main::INFOLOG && $log->info("Library Browser init...");
Slim::Menu::BrowseLibrary->init();
# regular server has a couple more initial operations.
main::INFOLOG && $log->info("Server persist playlists...");
if ($prefs->get('persistPlaylists')) {
Slim::Control::Request::subscribe(
\&Slim::Player::Playlist::modifyPlaylistCallback, [['playlist']]
);
}
# pull in the memory usage module if requested.
if (main::INFOLOG && logger('server.memory')->is_info) {
if ( Slim::bootstrap::tryModuleLoad('Slim::Utils::MemoryUsage') ) {
logError("Couldn't load Slim::Utils::MemoryUsage: [$@]");
} else {
Slim::Utils::MemoryUsage->init();
}
}
if ( main::PERFMON ) {
main::INFOLOG && $log->info("Server Perfwarn init...");
require Slim::Utils::PerfMon;
Slim::Utils::PerfMon->init($perfwarn);
}
if ( !$os->runningFromSource && $prefs->get('checkVersion') ) {
require Slim::Utils::Update;
Slim::Utils::Timers::setTimer(
undef,
time() + 30,
\&Slim::Utils::Update::checkVersion,
);
}
main::INFOLOG && $log->info("Server HTTP enable...");
Slim::Web::HTTP::init2();
# otherwise, get ready to loop
$lastlooptime = Time::HiRes::time();
$inInit = 0;
$log->error("Server done init: " . Slim::Utils::Network::serverURL);
}
sub main {
# command line options
initOptions();
# all other initialization
init();
if ( ISWINDOWS && $daemon ) {
Slim::Utils::OSDetect->getOS()->runService();
}
else {
while (!idle()) {}
}
stopServer();
}
sub idle {
# No idle processing during startup
return if $inInit;
my $now = EV::now;
# check for time travel (i.e. If time skips backwards for DST or clock drift adjustments)
if ( $now < $lastlooptime || ( $now - $lastlooptime > 300 ) ) {
# For all clients that support RTC, we need to adjust their clocks
for my $client ( Slim::Player::Client::clients() ) {
if ( $client->hasRTCAlarm ) {
$client->setRTCTime;
}
}
}
$lastlooptime = $now;
# This flag indicates we have pending IR or request events to handle
my $pendingEvents = 0;
# process IR queue
$pendingEvents = Slim::Hardware::IR::idle();
if ( !$pendingEvents ) {
# empty notifcation queue, only if no IR events are pending
$pendingEvents = Slim::Control::Request::checkNotifications();
if ( !$pendingEvents ) {
# run scheduled tasks, only if no other events are pending
$pendingEvents = Slim::Utils::Scheduler::run_tasks();
}
}
# Include pending AIO events or we will end up stalling AIO processing
if ( $HAS_AIO && !$pendingEvents ) {
$pendingEvents += IO::AIO::nreqs();
}
if ( $pendingEvents ) {
# Some notifications are still pending, run the loop in non-blocking mode
Slim::Networking::IO::Select::loop( EV::LOOP_NONBLOCK );
}
else {
# No events are pending, run the loop until we get a select event
Slim::Networking::IO::Select::loop( EV::LOOP_ONESHOT );
}
return $::stop;
}
sub idleStreams {
my $timeout = shift || 0;
# No idle processing during startup
return if $inInit;
# Loop once without blocking
Slim::Networking::IO::Select::loop( EV::LOOP_NONBLOCK );
}
sub showUsage {
print <<EOF;
Usage: $0 [--diag] [--daemon] [--stdio]
[--cachedir <dirpath>] [--tmpdir <dirpath>]
[--logdir <logpath>]
[--logfile <logfilepath|syslog>]
[--user <username>]
[--group <groupname>]
[--httpport <portnumber> [--httpaddr <listenip>]]
[--advertiseaddr <ipaddress>]
[--cliport <portnumber> [--cliaddr <listenip>]]
[--playeraddr <listenip>]
[--priority <priority>]
[--streamaddr <listenip>]
[--prefsdir <prefspath> [--pidfile <pidfilepath>]]
[--perfmon] [--perfwarn=<threshold> | --perfwarn <warn options>]
[--checkstrings] [--charset <charset>]
[--noweb] [--notranscoding] [--nosb1slimp3sync] [--nostatistics] [--norestart]
[--nobrowsecache]
[--logging <logging-spec>] [--noinfolog | --nodebuglog]
[--localfile]
--help => Show this usage information.
--cachedir => Directory for Lyrion Music Server to save cached music and web data
--tmpdir => Directory for Lyrion Music Server's temporary files (cleaned on start and stop)
--diag => Use diagnostics, shows more verbose errors.
Also slows down library processing considerably
--logdir => Specify folder location for log file
--logfile => Specify a file for error logging. Specify 'syslog' to log to syslog.
--daemon => Run the server in the background.
This may only work on Unix-like systems.
--stdio => Use standard in and out as a command line interface
to the server
--user => Specify the user that server should run as.
Only usable if server is started as root.
This may only work on Unix-like systems.
--group => Specify the group that server should run as.
Only usable if server is started as root.
This may only work on Unix-like systems.
--httpport => Activate the web interface on the specified port.
Set to 0 in order disable the web server.
--httpaddr => Activate the web interface on the specified IP address.
--advertiseaddr => IP address to report as its exposed address. Basically the user facing IP address.
--cliport => Activate the command line interface TCP/IP interface
on the specified port. Set to 0 in order disable the
command line interface server.
--cliaddr => Activate the command line interface TCP/IP
interface on the specified IP address.
--prefsdir => Specify the location of the preferences directory
--pidfile => Specify where a process ID file should be stored
--quiet => Minimize the amount of text output
--playeraddr => Specify the _server's_ IP address to use to connect
to Slim players
--priority => set process priority from -20 (high) to 20 (low)
--streamaddr => Specify the _server's_ IP address to use to connect
to streaming audio sources
--nodebuglog => Disable all debug-level logging (compiled out).
--noinfolog => Disable all debug-level & info-level logging (compiled out).
--norestart => Disable automatic restarts of server (if performed by external script)
--nosetup => Disable setup via http.
--noserver => Disable web access server settings, but leave player settings accessible.
Settings changes are not preserved.
--noweb => Disable web interface. JSON-RPC, Comet, and artwork web APIs are still enabled.
--nosb1slimp3sync=> Disable support for SliMP3s, SB1s and associated synchronization
--nostatistics => Disable the TracksPersistent table used to keep to statistics across rescans (compiled out).
--notranscoding => Disable transcoding support.
--nobrowsecache => Disable caching of rendered browse pages.
--perfmon => Enable internal server performance monitoring
--perfwarn => Generate log messages if internal tasks take longer than specified threshold
--failsafe => Don't load plugins
--checkstrings => Enable reloading of changed string files for plugin development
--charset => Force a character set to be used, eg. utf8 on Linux devices
which don't have full utf8 locale installed
--dbtype => Force database type (valid values are MySQL or SQLite)
--logging => Enable logging for the specified comma separated categories
--localfile => Enable LocalFile protocol handling for locally connected squeezelite service
Commands may be sent to the server through standard in and will be echoed via
standard out. See complete documentation for details on the command syntax.
EOF
}
sub initOptions {
my $logging;
$LogTimestamp = 1;
my $gotOptions = GetOptions(
'user=s' => \$user,
'group=s' => \$group,
'cliaddr=s' => \$cliaddr,
'cliport=s' => \$cliport,
'daemon' => \$daemon,
'diag' => \$diag,
'help' => \$help,
'httpaddr=s' => \$httpaddr,
'httpport=s' => \$httpport,
'advertiseaddr=s' => \$advertiseaddr,
'logfile=s' => \$logfile,
'logdir=s' => \$logdir,
'logconfig=s' => \$logconf,
'debug=s' => \$debug,
'logging=s' => \$logging,
'LogTimestamp!' => \$LogTimestamp,
'cachedir=s' => \$cachedir,
'tmpdir=s' => \$tmpdir,
'pidfile=s' => \$pidfile,
'playeraddr=s' => \$localClientNetAddr,
'priority=i' => \$priority,
'stdio' => \$stdio,
'streamaddr=s' => \$localStreamAddr,
'prefsfile=s' => \$prefsfile,
# prefsdir is parsed by Slim::Utils::Prefs prior to initOptions being run
'quiet' => \$quiet,
'norestart' => \$norestart,
'nosetup' => \$nosetup,
'noserver' => \$noserver,
'failsafe' => \$failsafe,
'perfwarn=s' => \$perfwarn, # content parsed by PerfMon if set
'checkstrings' => \$checkstrings,
'charset=s' => \$charset,
'dbtype=s' => \$dbtype,
'd_startup' => \$d_startup, # Needed for Slim::bootstrap
# these values are parsed separately, we don't need these values in a variable - just get them off the list
'nodebuglog' => sub {},
'noinfolog' => sub {},
'nostatistics' => sub {},
'nosb1slimp3sync'=> sub {},
'notranscoding' => sub {},
'noweb' => sub {},
);
# make --logging and --debug synonyms, but prefer --logging
$debug = $logging if ($logging);
initLogging();
if ($help || !$gotOptions) {
showUsage();
exit(1);
}
}
sub initLogging {
# open the log files
Slim::Utils::Log->init({
'logconf' => $logconf,
'logdir' => $logdir,
'logfile' => $logfile,
'logtype' => 'server',
'debug' => $debug,
});
}
sub initClass {
my $class = shift;
Slim::bootstrap::tryModuleLoad($class);
if ($@) {
logError("Couldn't load $class: $@");
} else {
$class->initPlugin;
}
}
sub initSettings {
Slim::Utils::Prefs::init();
# options override existing preferences
if (defined($cachedir)) {
$prefs->set('cachedir', $cachedir);
$prefs->set('librarycachedir', $cachedir);
}
if (defined($httpport)) {
$prefs->set('httpport', $httpport);
}
if (defined($cliport)) {
preferences('plugin.cli')->set('cliport', $cliport);
}
if (defined($prefs->get('cachedir')) && $prefs->get('cachedir') ne '') {
$cachedir = $prefs->get('cachedir');
$cachedir = Slim::Utils::Misc::fixPath($cachedir);
$cachedir = Slim::Utils::Misc::pathFromFileURL($cachedir);
$cachedir =~ s|[/\\]$||;
# Make sure cachedir exists
Slim::Utils::Prefs::makeCacheDir($cachedir);
$prefs->set('cachedir',$cachedir);
$prefs->set('librarycachedir',$cachedir) unless $prefs->get('librarycachedir');
}
Slim::Utils::Prefs::makeCacheDir();
# tmpdir is set only through command line
$tmpdir = Win32::GetANSIPathName($tmpdir) if main::ISWINDOWS;
Slim::Utils::Misc::makeTempDir();
}
sub daemonize {
my ($pid, $log);
if (!defined($pid = fork())) {
die "Can't fork: $!";
}
if ($pid) {
save_pid_file($pid);
# don't clean up the pidfile!
$pidfile = undef;
exit;
}
if (!setsid) {
die "Can't start a new session: $!";
}
open STDOUT, '>>/dev/null';
# Do not attempt to daemonize again.
@argv = grep { $_ ne '--daemon' } @argv;
# On Leopard, GD will crash because you can't run CoreServices code in a forked child,
# so we have to exec as well.
if ( $^O =~ /darwin/ ) {
exec $^X . ' "' . $0 . '" ' . join( ' ', @argv );
exit;
}
}
sub changeEffectiveUserAndGroup {
# If we're not root and need to change user and group then die with a
# suitable message, else there's nothing more to do, so return.
if ($> != 0) {
if (defined($user) || defined($group)) {
my $uname = getpwuid($>);
print STDERR "Current user is $uname\n";
print STDERR "Must run as root to change effective user or group.\n";
die "Aborting";
} else {
return;
}
}
my ($uid, $pgid, @sgids, $gid);
# Don't allow the server to be started as root.
# MySQL can't be run as root, and it's generally a bad idea anyways.
# Try starting as 'squeezeboxserver' instead.
if (!defined($user)) {
$user = 'squeezeboxserver';
print STDERR "Lyrion Music Server must not be run as root! Trying user $user instead.\n";
}
# Get the uid and primary group id for the $user.
($uid, $pgid) = (getpwnam($user))[2,3];
if (!defined ($uid)) {
die "User $user not found.\n";
}
# Get the supplementary groups to which $user belongs
setgrent();
while (my @grp = getgrent()) {
if ($grp[3] =~ m/\b$user\b/){ push @sgids, $grp[2] }
}
endgrent();
# If a group was specified, get the gid of it and add it to the
# list of supplementary groups.
if (defined($group)) {
$gid = getgrnam($group);
if (!defined $gid) {
die "Group $group not found.\n";
} else {
push @sgids, $gid;
}
}
# Check that we're definately not trying to start as root, e.g. if
# we were passed '--user root' or any other used with uid 0.
if ($uid == 0) {
print STDERR "Lyrion Music Server must not be run as root! Only do this if you know what you're doing!!\n";
}
# Change effective group. Need to do this while still root, so do group first
# $) is a space separated list that begins with the effective gid then lists
# any supplementary group IDs, so compare against that. On some systems
# no supplementary group IDs are present at system startup or at all.
# We need to pass $pgid twice because setgroups only gets called if there's
# more than one value. For example, if we did:
# $) = "1234"
# then the effective primary group would become 1234, but we'd retain any
# previously set supplementary groups. To become a member of just 1234, the
# correct way is to do:
# $) = "1234 1234"
undef $!;
$) = "$pgid $pgid " . join (" ", @sgids);
if ( $! ) {
die "Unable to set effective group(s) to $group ($gid) is: $): $!\n";
}
# Finally, change effective user id.
undef $!;
$> = $uid;
if ( $! ) {
die "Unable to set effective user to $user, ($uid)!\n";
}
logger('server')->info("Running as uid: $> / gid: $)");
}
sub checkDataSource {
my $mediadirs = Slim::Utils::Misc::getMediaDirs();
my $modified = 0;
foreach my $audiodir (@$mediadirs) {
if (defined $audiodir && $audiodir =~ m|[/\\]$|) {
$audiodir =~ s|[/\\]$||;
$modified++;
}
}
$prefs->set('mediadirs', $mediadirs) if $modified;
return if !Slim::Schema::hasLibrary();
$sqlHelperClass->checkDataSource();
# Count entries for all media types, run scan if all are empty
my $dbh = Slim::Schema->dbh;
my ($gc) = $dbh->selectrow_array( qq{
SELECT COUNT(1) FROM genres
} );
if (Slim::Schema->schemaUpdated || !$gc) {
logWarning("Schema updated or no media found in the database, initiating scan.");