koel/app/Console/Commands/SyncCommand.php

135 lines
4 KiB
PHP
Raw Normal View History

2015-12-13 04:42:28 +00:00
<?php
namespace App\Console\Commands;
2016-02-04 15:37:12 +00:00
use App\Libraries\WatchRecord\InotifyWatchRecord;
2015-12-13 04:42:28 +00:00
use App\Models\Setting;
use App\Services\FileSynchronizer;
2018-08-19 15:26:34 +00:00
use App\Services\MediaSyncService;
2015-12-13 04:42:28 +00:00
use Illuminate\Console\Command;
2018-08-19 15:26:34 +00:00
use Symfony\Component\Console\Helper\ProgressBar;
2015-12-13 04:42:28 +00:00
2019-06-30 11:20:40 +00:00
class SyncCommand extends Command
2015-12-13 04:42:28 +00:00
{
2016-02-02 07:47:00 +00:00
protected $signature = 'koel:sync
2016-03-22 08:22:39 +00:00
{record? : A single watch record. Consult Wiki for more info.}
{--excludes= : The comma-separated tags to excludes from syncing}
2016-03-22 08:22:39 +00:00
{--force : Force re-syncing even unchanged files}';
2015-12-13 04:42:28 +00:00
2018-08-19 15:26:34 +00:00
protected $description = 'Sync songs found in configured directory against the database.';
2021-06-05 10:47:56 +00:00
private int $ignored = 0;
private int $invalid = 0;
private int $synced = 0;
private MediaSyncService $mediaSyncService;
2016-08-17 14:26:07 +00:00
2021-06-05 10:47:56 +00:00
private ?ProgressBar $progressBar = null;
2018-08-19 15:26:34 +00:00
2021-06-05 10:47:56 +00:00
public function __construct(MediaSyncService $mediaSyncService)
2018-08-19 15:26:34 +00:00
{
parent::__construct();
2020-12-22 20:11:22 +00:00
2018-08-19 15:26:34 +00:00
$this->mediaSyncService = $mediaSyncService;
}
2015-12-13 04:42:28 +00:00
2018-08-24 15:27:19 +00:00
public function handle(): void
2015-12-13 04:42:28 +00:00
{
$this->ensureMediaPath();
2020-12-22 20:11:22 +00:00
$record = $this->argument('record');
2015-12-13 04:42:28 +00:00
2020-12-22 20:11:22 +00:00
if (!$record) {
2016-02-02 07:47:00 +00:00
$this->syncAll();
return;
}
$this->syncSingleRecord($record);
2016-02-02 07:47:00 +00:00
}
/**
* Sync all files in the configured media path.
*/
2018-08-24 15:27:19 +00:00
protected function syncAll(): void
2016-02-02 07:47:00 +00:00
{
2020-12-22 20:11:22 +00:00
$this->info('Syncing media from ' . Setting::get('media_path') . PHP_EOL);
2015-12-13 04:42:28 +00:00
// The excluded tags.
2016-03-22 08:22:39 +00:00
// Notice that this is only meaningful for existing records.
// New records will have every applicable field synced in.
$excludes = $this->option('excludes') ? explode(',', $this->option('excludes')) : [];
2016-03-22 08:22:39 +00:00
$this->mediaSyncService->sync(null, $excludes, $this->option('force'), $this);
2015-12-13 04:42:28 +00:00
2016-08-17 14:26:07 +00:00
$this->output->writeln(
2020-12-22 20:11:22 +00:00
PHP_EOL . PHP_EOL
2021-06-05 10:47:56 +00:00
. "<info>Completed! $this->synced new or updated song(s)</info>, "
. "$this->ignored unchanged song(s), "
. "and <comment>$this->invalid invalid file(s)</comment>."
2016-08-17 14:26:07 +00:00
);
2015-12-13 04:42:28 +00:00
}
2016-02-02 07:47:00 +00:00
/**
2016-02-04 15:04:53 +00:00
* @param string $record The watch record.
* As of current we only support inotifywait.
* Some examples:
* - "DELETE /var/www/media/gone.mp3"
* - "CLOSE_WRITE,CLOSE /var/www/media/new.mp3"
* - "MOVED_TO /var/www/media/new_dir"
2016-02-02 07:47:00 +00:00
*
2020-09-06 21:20:42 +00:00
* @see http://man7.org/linux/man-pages/man1/inotifywait.1.html
2016-02-02 07:47:00 +00:00
*/
public function syncSingleRecord(string $record): void
2016-02-02 07:47:00 +00:00
{
2018-08-19 15:26:34 +00:00
$this->mediaSyncService->syncByWatchRecord(new InotifyWatchRecord($record));
2016-02-02 07:47:00 +00:00
}
2015-12-13 04:42:28 +00:00
/**
* Log a song's sync status to console.
*/
2018-08-29 07:58:46 +00:00
public function logSyncStatusToConsole(string $path, int $result, ?string $reason = null): void
2015-12-13 04:42:28 +00:00
{
$name = basename($path);
if ($result === FileSynchronizer::SYNC_RESULT_UNMODIFIED) {
2020-09-06 21:20:42 +00:00
++$this->ignored;
} elseif ($result === FileSynchronizer::SYNC_RESULT_BAD_FILE) {
2015-12-13 04:42:28 +00:00
if ($this->option('verbose')) {
2020-12-22 20:11:22 +00:00
$this->error(PHP_EOL . "'$name' is not a valid media file: " . $reason);
2015-12-13 04:42:28 +00:00
}
2020-09-06 21:20:42 +00:00
++$this->invalid;
2015-12-13 04:42:28 +00:00
} else {
2020-09-06 21:20:42 +00:00
++$this->synced;
2015-12-13 04:42:28 +00:00
}
}
2016-08-17 14:26:07 +00:00
2018-08-24 15:27:19 +00:00
public function createProgressBar(int $max): void
2016-08-17 14:26:07 +00:00
{
2018-08-19 15:26:34 +00:00
$this->progressBar = $this->getOutput()->createProgressBar($max);
2016-08-17 14:26:07 +00:00
}
public function advanceProgressBar(): void
2016-08-17 14:26:07 +00:00
{
2018-08-19 15:26:34 +00:00
$this->progressBar->advance();
2016-08-17 14:26:07 +00:00
}
private function ensureMediaPath(): void
{
2018-08-31 13:47:15 +00:00
if (Setting::get('media_path')) {
return;
}
$this->warn("Media path hasn't been configured. Let's set it up.");
while (true) {
2018-09-04 05:42:49 +00:00
$path = $this->ask('Absolute path to your media directory');
if (is_dir($path) && is_readable($path)) {
Setting::set('media_path', $path);
break;
}
$this->error('The path does not exist or is not readable. Try again.');
}
}
2015-12-13 04:42:28 +00:00
}