-
Notifications
You must be signed in to change notification settings - Fork 197
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The command may be used to import one or several playlists from file(s) for one or multiple users. If the user already has a playlist with the same name as the file, then either option `overwrite` or `append` has to be used. refs #832
- Loading branch information
Showing
4 changed files
with
155 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| /** | ||
| * ownCloud - Music app | ||
| * | ||
| * This file is licensed under the Affero General Public License version 3 or | ||
| * later. See the COPYING file. | ||
| * | ||
| * @author Pauli Järvinen <pauli.jarvinen@gmail.com> | ||
| * @copyright Pauli Järvinen 2021 | ||
| */ | ||
|
|
||
| namespace OCA\Music\Command; | ||
|
|
||
| use OCA\Music\AppFramework\BusinessLayer\BusinessLayerException; | ||
| use OCA\Music\BusinessLayer\PlaylistBusinessLayer; | ||
| use OCA\Music\Db\Playlist; | ||
| use OCA\Music\Utility\PlaylistFileService; | ||
|
|
||
| use OCP\Files\Folder; | ||
| use OCP\Files\IRootFolder; | ||
|
|
||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| class PlaylistImport extends BaseCommand { | ||
| /** @var IRootFolder */ | ||
| private $rootFolder; | ||
| /** @var PlaylistBusinessLayer */ | ||
| private $businessLayer; | ||
| /** @var PlaylistFileService */ | ||
| private $playlistFileService; | ||
|
|
||
| public function __construct( | ||
| \OCP\IUserManager $userManager, | ||
| \OCP\IGroupManager $groupManager, | ||
| IRootFolder $rootFolder, | ||
| PlaylistBusinessLayer $playlistBusinessLayer, | ||
| PlaylistFileService $playlistFileService) { | ||
| $this->rootFolder = $rootFolder; | ||
| $this->businessLayer = $playlistBusinessLayer; | ||
| $this->playlistFileService = $playlistFileService; | ||
| parent::__construct($userManager, $groupManager); | ||
| } | ||
|
|
||
| protected function doConfigure() : void { | ||
| $this | ||
| ->setName('music:playlist-import') | ||
| ->setDescription('import user playlist(s) from file(s)') | ||
| ->addOption( | ||
| 'file', | ||
| null, | ||
| InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, | ||
| 'path of the playlist file, relative to the user home folder' | ||
| ) | ||
| ->addOption( | ||
| 'overwrite', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'overwrite the target playlist if it already exists' | ||
| ) | ||
| ->addOption( | ||
| 'append', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'append imported tracks to an existing playlist if found' | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function doExecute(InputInterface $input, OutputInterface $output, array $users) : void { | ||
| $files = $input->getOption('file'); | ||
| $overwrite = (bool)$input->getOption('overwrite'); | ||
| $append = (bool)$input->getOption('append'); | ||
|
|
||
| if (empty($files)) { | ||
| throw new \InvalidArgumentException('At least one <error>file</error> argument must be given'); | ||
| } | ||
|
|
||
| if ($overwrite && $append) { | ||
| throw new \InvalidArgumentException('The options <error>overwrite</error> and <error>append</error> are mutually exclusive'); | ||
| } | ||
|
|
||
| if ($input->getOption('all')) { | ||
| $this->userManager->callForAllUsers(function($user) use ($output, $files, $overwrite, $append) { | ||
| $this->executeForUser($user->getUID(), $files, $overwrite, $append, $output); | ||
| }); | ||
| } else { | ||
| foreach ($users as $userId) { | ||
| $this->executeForUser($userId, $files, $overwrite, $append, $output); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private function executeForUser(string $userId, array $files, bool $overwrite, bool $append, OutputInterface $output) : void { | ||
| $output->writeln("Importing playlist(s) for <info>$userId</info>..."); | ||
|
|
||
| $userFolder = $this->rootFolder->getUserFolder($userId); | ||
|
|
||
| foreach ($files as $filePath) { | ||
| $name = \pathinfo($filePath, PATHINFO_FILENAME); | ||
| $existingLists = $this->businessLayer->findAllByName($name, $userId); | ||
| if (\count($existingLists) === 0) { | ||
| $playlist = $this->businessLayer->create($name, $userId); | ||
| } elseif (!$overwrite && !$append) { | ||
| $output->writeln(" The playlist <error>$name</error> already exists, give argument <info>overwrite</info> or <info>append</info>"); | ||
| $playlist = null; | ||
| } else { | ||
| $playlist = $existingLists[0]; | ||
| } | ||
|
|
||
| if ($playlist !== null) { | ||
| $this->importPlaylist($filePath, $playlist, $userId, $userFolder, $overwrite, $output); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private function importPlaylist(string $filePath, Playlist $playlist, string $userId, Folder $userFolder, bool $overwrite, OutputInterface $output) : void { | ||
| try { | ||
| $id = $playlist->getId(); | ||
| $result = $this->playlistFileService->importFromFile($playlist->getId(), $userId, $userFolder, $filePath, $overwrite ? 'overwrite' : 'append'); | ||
| $output->writeln(" <info>{$result['imported_count']}</info> tracks were imported to playlist <info>$id</info> from <info>$filePath</info>"); | ||
| } catch (BusinessLayerException $ex) { | ||
| $output->writeln(" User <info>$userId</info> has no playlist with id <error>$id</error>"); | ||
| } catch (\OCP\Files\NotFoundException $ex) { | ||
| $output->writeln(" Invalid file path <error>$filePath</error>"); | ||
| } catch (\UnexpectedValueException $ex) { | ||
| $output->writeln(" The file <error>$filePath</error> is not a supported playlist file"); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters