feat: add UsersCommand for viewing Plex users

arabcoders · arabcoders · commit 57ee7e02c906 · 2026-02-20T01:48:45.000+03:00
diff --git a/src/Backends/Plex/Action/GetUsersList.php b/src/Backends/Plex/Action/GetUsersList.php
@@ -71,8 +71,14 @@ private function action(Context $context, array $opts = []): Response
         $callback = ag($opts, Options::RAW_RESPONSE_CALLBACK, null);
         $this->logRequests = $callback && ag($opts, Options::RAW_RESPONSE, false);
 
+        $opts[Options::LOG_TO_WRITER] = ag($opts, Options::LOG_TO_WRITER, static fn() => static function (string $log) {});
+
         if (true === (bool) ag($opts, Options::PLEX_EXTERNAL_USER, false)) {
             $cls = fn() => $this->getExternalUsers($context, $opts);
+            $opts[Options::LOG_TO_WRITER](r('Reading external user from cache? {state}', [
+                'state' => true === (bool) ag($opts, Options::NO_CACHE) ? 'no' : 'yes',
+            ]));
+
             return true === (bool) ag($opts, Options::NO_CACHE)
                 ? $cls()
                 : $this->tryCache(
@@ -89,6 +95,10 @@ private function action(Context $context, array $opts = []): Response
 
         $cls = fn() => $this->getHomeUsers($this->getExternalUsers($context, $opts), $context, $opts);
 
+        $opts[Options::LOG_TO_WRITER](r('Reading data from cache? {state}', [
+            'state' => true === (bool) ag($opts, Options::NO_CACHE) ? 'no' : 'yes',
+        ]));
+
         $data = true === (bool) ag($opts, Options::NO_CACHE)
             ? $cls()
             : $this->tryCache(
@@ -192,7 +202,7 @@ private function getExternalUsers(Context $context, array $opts = []): Response
                 'headers' => [
                     'Accept' => 'application/xml',
                 ],
-            ]), $context, $url);
+            ]), $context, $url, $opts);
 
             if (true !== (bool) ag($opts, Options::GET_TOKENS) || count($users) < 1) {
                 return new Response(status: true, response: $users);
@@ -249,7 +259,7 @@ private function getExternalUsers(Context $context, array $opts = []): Response
             );
         }
 
-        return $this->externalUsersTokens($users, $context, $url, $response);
+        return $this->externalUsersTokens($users, $context, $url, $response, $opts);
     }
 
     /**
@@ -258,18 +268,18 @@ private function getExternalUsers(Context $context, array $opts = []): Response
      * @param iResponse $response
      * @param Context $context
      * @param iUri $url
+     * @param array $opts The options.
      *
      * @return array Return processed response.
      * @throws iException if an error occurs during the request.
      */
-    private function processExternalUsers(iResponse $response, Context $context, iUri $url): array
+    private function processExternalUsers(iResponse $response, Context $context, iUri $url, array $opts = []): array
     {
         $content = simplexml_load_string($response->getContent(false));
         $data = [];
         foreach ($content->User ?? [] as $_user) {
             $user = [];
             // @INFO: This workaround is needed, for some reason array_map() doesn't work correctly on xml objects.
-            /** @noinspection PhpLoopCanBeConvertedToArrayMapInspection */
             foreach ($_user->attributes() as $k => $v) {
                 $user[$k] = (string) $v;
             }
@@ -296,7 +306,7 @@ private function processExternalUsers(iResponse $response, Context $context, iUr
         $list = [];
         foreach ($data as $user) {
             $uuidStatus = preg_match('/\/users\/(?<uuid>.+?)\/avatar/', ag($user, 'thumb', ''), $matches);
-            $list[] = [
+            $_user = [
                 'id' => (int) ag($user, 'id'),
                 'uuid' => 1 === $uuidStatus ? ag($matches, 'uuid') : ag($user, 'invited_user'),
                 'name' => ag($user, ['username', 'title', 'email', 'id'], '??'),
@@ -306,6 +316,17 @@ private function processExternalUsers(iResponse $response, Context $context, iUr
                 'protected' => 1 === (int) ag($user, 'protected'),
                 'updatedAt' => 'external_user',
             ];
+
+            $list[] = $_user;
+
+            $opts[Options::LOG_TO_WRITER](r("Processed external user '{name}' with id '{id}': {data}.", [
+                'name' => $_user['name'],
+                'id' => $_user['id'],
+                'data' => [
+                    'local' => array_to_json($_user),
+                    'remote' => array_to_json($user),
+                ],
+            ]));
         }
 
         return $list;
@@ -318,12 +339,13 @@ private function processExternalUsers(iResponse $response, Context $context, iUr
      * @param Context $context The context.
      * @param iUri $url The URL.
      * @param iResponse $response The response.
+     * @param array $opts The options.
      *
      * @return Response Return processed response.
      * @throws iException if an error occurs during the request.
      * @throws JsonException if an error occurs during the JSON parsing.
      */
-    private function externalUsersTokens(array $users, Context $context, iUri $url, iResponse $response): Response
+    private function externalUsersTokens(array $users, Context $context, iUri $url, iResponse $response, array $opts = []): Response
     {
         if (count($users) < 1) {
             return new Response(status: true, response: $users);
@@ -356,6 +378,11 @@ private function externalUsersTokens(array $users, Context $context, iUri $url,
 
             foreach ($users as &$user) {
                 if ((int) ag($user, 'id') !== (int) ag($data, 'userID')) {
+                    $opts[Options::LOG_TO_WRITER](r("Skipping token for user '{name}' with id '{id}' because it doesn't match with userID '{userID}' in the response.", [
+                        'name' => ag($user, 'name'),
+                        'id' => ag($user, 'id'),
+                        'userID' => ag($data, 'userID'),
+                    ]));
                     continue;
                 }
                 $user['token'] = ag($data, 'accessToken');
@@ -470,6 +497,12 @@ private function processHomeUsers(
                     continue;
                 }
 
+                $opts[Options::LOG_TO_WRITER](r("Skipping external user '{name}' with id '{id}' because match a home user with id '{userId}' and name '{userName}'.", [
+                    'name' => ag($extUser, 'name'),
+                    'id' => ag($extUser, 'id'),
+                    'userId' => $user['id'],
+                    'userName' => $user['name'],
+                ]));
                 unset($users[$key]);
             }
         }
diff --git a/src/Backends/Plex/Commands/UsersCommand.php b/src/Backends/Plex/Commands/UsersCommand.php
@@ -0,0 +1,158 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Backends\Plex\Commands;
+
+use App\Backends\Plex\PlexClient;
+use App\Command;
+use App\Libs\Attributes\DI\Inject;
+use App\Libs\Attributes\Route\Cli;
+use App\Libs\LogSuppressor;
+use App\Libs\Mappers\Import\DirectMapper;
+use App\Libs\Mappers\ImportInterface as iImport;
+use App\Libs\Options;
+use App\Libs\UserContext;
+use Psr\Log\LoggerInterface as iLogger;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class UsersCommand
+ *
+ * This command manages Plex users.
+ */
+#[Cli(command: self::ROUTE)]
+class UsersCommand extends Command
+{
+    public const string ROUTE = 'backend:plex:users';
+
+    /**
+     * Class Constructor.
+     *
+     * @param iImport $mapper The import interface object.
+     * @param iLogger $logger The logger interface object.
+     * @param LogSuppressor $suppressor The log suppressor object.
+     *
+     */
+    public function __construct(
+        #[Inject(DirectMapper::class)]
+        private readonly iImport $mapper,
+        private readonly iLogger $logger,
+    ) {
+        set_time_limit(0);
+        ini_set('memory_limit', '-1');
+
+        parent::__construct();
+    }
+
+    /**
+     * Configure the method.
+     */
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::ROUTE)
+            ->setDescription('View plex users.')
+            ->addOption('no-cache', 'N', InputOption::VALUE_NONE, 'Disable cache when loading data plex.')
+            ->addOption('raw', 'r', InputOption::VALUE_NONE, 'Show raw data from plex.')
+            ->addOption('log', 'l', InputOption::VALUE_NONE, 'Show logs from get users list process.')
+            ->addOption(
+                'select-backend',
+                's',
+                InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED,
+                'Select backend.',
+            );
+    }
+
+    /**
+     * Make sure the command is not running in parallel.
+     *
+     * @param InputInterface $input The input interface object.
+     * @param OutputInterface $output The output interface object.
+     *
+     * @return int The status code of the command execution.
+     */
+    protected function runCommand(InputInterface $input, OutputInterface $output): int
+    {
+        $userContext = get_user_context('main', mapper: $this->mapper, logger: $this->logger);
+
+        $backends = $input->getOption('select-backend');
+        if (empty($backends)) {
+            $output->writeln('<error>No backends selected. Use --select-backend option to select backend.</error>');
+            return self::FAILURE;
+        }
+
+        $conf = $name = null;
+        foreach ($backends as $backend) {
+            if (null === ($conf = $userContext->config->get($backend))) {
+                continue;
+            }
+            $name = $backend;
+            break;
+        }
+
+        if (null === $conf) {
+            $output->writeln('<error>No valid backends selected. Use --select-backend option to select backend.</error>');
+            return self::FAILURE;
+        }
+
+        if (strtolower(PlexClient::CLIENT_NAME) !== ag($conf, 'type')) {
+            $output->writeln('<error>Selected backend is not a plex backend. Use --select-backend option to select plex backend.</error>');
+            return self::FAILURE;
+        }
+
+        $requests = $logs = $opts = [];
+
+        if ($input->getOption('log')) {
+            $opts[Options::LOG_TO_WRITER] = static function (string $log) use (&$logs) {
+                $logs[] = r('[{time}] {log}', [
+                    'time' => make_date(),
+                    'log' => $log,
+                ]);
+            };
+        }
+
+        if ($input->getOption('raw')) {
+            $opts[Options::NO_CACHE] = true;
+            $opts[Options::RAW_RESPONSE] = true;
+            $opts[Options::RAW_RESPONSE_CALLBACK] = static function (array $r) use (&$requests) {
+                $requests = $r;
+            };
+        }
+
+        if ($input->getOption('no-cache')) {
+            $opts[Options::NO_CACHE] = true;
+        }
+
+        $backend = make_backend(backend: $conf, name: $name, options: [
+            UserContext::class => $userContext,
+        ]);
+
+        $users = $backend->getUsersList($opts);
+
+        foreach ($logs as $log) {
+            $output->writeln($log);
+        }
+
+        foreach ($requests as $request) {
+            $output->writeln(r('URL: {url}', ['url' => ag($request, 'url')]));
+
+            foreach (ag($request, 'headers', []) as $key => $value) {
+                $output->writeln(r('{key}: {value}', [
+                    'key' => $key,
+                    'value' => is_array($value) ? implode(', ', $value) : (string) $value,
+                ]));
+            }
+            $output->writeln('');
+            $output->writeln(json_encode(ag($request, 'body', []), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+
+            $output->writeln(str_repeat('-', 80));
+        }
+
+        $this->displayContent($users, $output, 'table');
+
+        return self::SUCCESS;
+    }
+}
