Updated namespace for Shortcode CLI commands

2026-03-09 16:53:11 +08:00 · 2016-08-08 09:36:52 +02:00
parent 0a4f8c3b0a
commit a65003803b
10 changed files with 20 additions and 21 deletions
--- a/module/CLI/src/Command/Shortcode/GenerateShortcodeCommand.php
+++ b/module/CLI/src/Command/Shortcode/GenerateShortcodeCommand.php
@@ -0,0 +1,108 @@
+<?php
+namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+
+use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
+use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
+use Shlinkio\Shlink\Core\Service\UrlShortener;
+use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\Question;
+use Zend\Diactoros\Uri;
+use Zend\I18n\Translator\TranslatorInterface;
+
+class GenerateShortcodeCommand extends Command
+{
+    /**
+     * @var UrlShortenerInterface
+     */
+    private $urlShortener;
+    /**
+     * @var array
+     */
+    private $domainConfig;
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * GenerateShortcodeCommand constructor.
+     * @param UrlShortenerInterface $urlShortener
+     * @param TranslatorInterface $translator
+     * @param array $domainConfig
+     *
+     * @Inject({UrlShortener::class, "translator", "config.url_shortener.domain"})
+     */
+    public function __construct(
+        UrlShortenerInterface $urlShortener,
+        TranslatorInterface $translator,
+        array $domainConfig
+    ) {
+        $this->urlShortener = $urlShortener;
+        $this->translator = $translator;
+        $this->domainConfig = $domainConfig;
+        parent::__construct(null);
+    }
+
+    public function configure()
+    {
+        $this->setName('shortcode:generate')
+             ->setDescription(
+                 $this->translator->translate('Generates a short code for provided URL and returns the short URL')
+             )
+             ->addArgument('longUrl', InputArgument::REQUIRED, $this->translator->translate('The long URL to parse'));
+    }
+
+    public function interact(InputInterface $input, OutputInterface $output)
+    {
+        $longUrl = $input->getArgument('longUrl');
+        if (! empty($longUrl)) {
+            return;
+        }
+
+        /** @var QuestionHelper $helper */
+        $helper = $this->getHelper('question');
+        $question = new Question(sprintf(
+            '<question>%s</question> ',
+            $this->translator->translate('A long URL was not provided. Which URL do you want to shorten?:')
+        ));
+
+        $longUrl = $helper->ask($input, $output, $question);
+        if (! empty($longUrl)) {
+            $input->setArgument('longUrl', $longUrl);
+        }
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $longUrl = $input->getArgument('longUrl');
+
+        try {
+            if (! isset($longUrl)) {
+                $output->writeln(sprintf('<error>%s</error>', $this->translator->translate('A URL was not provided!')));
+                return;
+            }
+
+            $shortCode = $this->urlShortener->urlToShortCode(new Uri($longUrl));
+            $shortUrl = (new Uri())->withPath($shortCode)
+                ->withScheme($this->domainConfig['schema'])
+                ->withHost($this->domainConfig['hostname']);
+
+            $output->writeln([
+                sprintf('%s <info>%s</info>', $this->translator->translate('Processed URL:'), $longUrl),
+                sprintf('%s <info>%s</info>', $this->translator->translate('Generated URL:'), $shortUrl),
+            ]);
+        } catch (InvalidUrlException $e) {
+            $output->writeln(sprintf(
+                '<error>' . $this->translator->translate(
+                    'Provided URL "%s" is invalid. Try with a different one.'
+                ) . '</error>',
+                $longUrl
+            ));
+        }
+    }
+}
--- a/module/CLI/src/Command/Shortcode/GetVisitsCommand.php
+++ b/module/CLI/src/Command/Shortcode/GetVisitsCommand.php
@@ -0,0 +1,122 @@
+<?php
+namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+
+use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
+use Shlinkio\Shlink\Common\Util\DateRange;
+use Shlinkio\Shlink\Core\Service\VisitsTracker;
+use Shlinkio\Shlink\Core\Service\VisitsTrackerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\Question;
+use Zend\I18n\Translator\TranslatorInterface;
+
+class GetVisitsCommand extends Command
+{
+    /**
+     * @var VisitsTrackerInterface
+     */
+    private $visitsTracker;
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * GetVisitsCommand constructor.
+     * @param VisitsTrackerInterface $visitsTracker
+     * @param TranslatorInterface $translator
+     *
+     * @Inject({VisitsTracker::class, "translator"})
+     */
+    public function __construct(VisitsTrackerInterface $visitsTracker, TranslatorInterface $translator)
+    {
+        $this->visitsTracker = $visitsTracker;
+        $this->translator = $translator;
+        parent::__construct(null);
+    }
+
+    public function configure()
+    {
+        $this->setName('shortcode:visits')
+            ->setDescription(
+                $this->translator->translate('Returns the detailed visits information for provided short code')
+            )
+            ->addArgument(
+                'shortCode',
+                InputArgument::REQUIRED,
+                $this->translator->translate('The short code which visits we want to get')
+            )
+            ->addOption(
+                'startDate',
+                's',
+                InputOption::VALUE_OPTIONAL,
+                $this->translator->translate('Allows to filter visits, returning only those older than start date')
+            )
+            ->addOption(
+                'endDate',
+                'e',
+                InputOption::VALUE_OPTIONAL,
+                $this->translator->translate('Allows to filter visits, returning only those newer than end date')
+            );
+    }
+
+    public function interact(InputInterface $input, OutputInterface $output)
+    {
+        $shortCode = $input->getArgument('shortCode');
+        if (! empty($shortCode)) {
+            return;
+        }
+
+        /** @var QuestionHelper $helper */
+        $helper = $this->getHelper('question');
+        $question = new Question(sprintf(
+            '<question>%s</question> ',
+            $this->translator->translate('A short code was not provided. Which short code do you want to use?:')
+        ));
+
+        $shortCode = $helper->ask($input, $output, $question);
+        if (! empty($shortCode)) {
+            $input->setArgument('shortCode', $shortCode);
+        }
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $shortCode = $input->getArgument('shortCode');
+        $startDate = $this->getDateOption($input, 'startDate');
+        $endDate = $this->getDateOption($input, 'endDate');
+
+        $visits = $this->visitsTracker->info($shortCode, new DateRange($startDate, $endDate));
+        $table = new Table($output);
+        $table->setHeaders([
+            $this->translator->translate('Referer'),
+            $this->translator->translate('Date'),
+            $this->translator->translate('Remote Address'),
+            $this->translator->translate('User agent'),
+        ]);
+
+        foreach ($visits as $row) {
+            $rowData = $row->jsonSerialize();
+            // Unset location info
+            unset($rowData['visitLocation']);
+
+            $table->addRow(array_values($rowData));
+        }
+        $table->render();
+    }
+
+    protected function getDateOption(InputInterface $input, $key)
+    {
+        $value = $input->getOption($key);
+        if (isset($value)) {
+            $value = new \DateTime($value);
+        }
+
+        return $value;
+    }
+}
--- a/module/CLI/src/Command/Shortcode/ListShortcodesCommand.php
+++ b/module/CLI/src/Command/Shortcode/ListShortcodesCommand.php
@@ -0,0 +1,98 @@
+<?php
+namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+
+use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
+use Shlinkio\Shlink\Common\Paginator\Adapter\PaginableRepositoryAdapter;
+use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
+use Shlinkio\Shlink\Core\Service\ShortUrlService;
+use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+use Zend\I18n\Translator\TranslatorInterface;
+
+class ListShortcodesCommand extends Command
+{
+    use PaginatorUtilsTrait;
+
+    /**
+     * @var ShortUrlServiceInterface
+     */
+    private $shortUrlService;
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * ListShortcodesCommand constructor.
+     * @param ShortUrlServiceInterface $shortUrlService
+     * @param TranslatorInterface $translator
+     *
+     * @Inject({ShortUrlService::class, "translator"})
+     */
+    public function __construct(ShortUrlServiceInterface $shortUrlService, TranslatorInterface $translator)
+    {
+        $this->shortUrlService = $shortUrlService;
+        $this->translator = $translator;
+        parent::__construct(null);
+    }
+
+    public function configure()
+    {
+        $this->setName('shortcode:list')
+             ->setDescription($this->translator->translate('List all short URLs'))
+             ->addOption(
+                 'page',
+                 'p',
+                 InputOption::VALUE_OPTIONAL,
+                 sprintf(
+                     $this->translator->translate('The first page to list (%s items per page)'),
+                     PaginableRepositoryAdapter::ITEMS_PER_PAGE
+                 ),
+                 1
+             );
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $page = intval($input->getOption('page'));
+        /** @var QuestionHelper $helper */
+        $helper = $this->getHelper('question');
+
+        do {
+            $result = $this->shortUrlService->listShortUrls($page);
+            $page++;
+            $table = new Table($output);
+            $table->setHeaders([
+                $this->translator->translate('Short code'),
+                $this->translator->translate('Original URL'),
+                $this->translator->translate('Date created'),
+                $this->translator->translate('Visits count'),
+            ]);
+
+            foreach ($result as $row) {
+                $table->addRow(array_values($row->jsonSerialize()));
+            }
+            $table->render();
+
+            if ($this->isLastPage($result)) {
+                $continue = false;
+                $output->writeln(
+                    sprintf('<info>%s</info>', $this->translator->translate('You have reached last page'))
+                );
+            } else {
+                $continue = $helper->ask($input, $output, new ConfirmationQuestion(
+                    sprintf('<question>' . $this->translator->translate(
+                        'Continue with page'
+                    ) . ' <bg=cyan;options=bold>%s</>? (y/N)</question> ', $page),
+                    false
+                ));
+            }
+        } while ($continue);
+    }
+}
--- a/module/CLI/src/Command/Shortcode/ResolveUrlCommand.php
+++ b/module/CLI/src/Command/Shortcode/ResolveUrlCommand.php
@@ -0,0 +1,93 @@
+<?php
+namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+
+use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
+use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
+use Shlinkio\Shlink\Core\Service\UrlShortener;
+use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\Question;
+use Zend\I18n\Translator\TranslatorInterface;
+
+class ResolveUrlCommand extends Command
+{
+    /**
+     * @var UrlShortenerInterface
+     */
+    private $urlShortener;
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * ResolveUrlCommand constructor.
+     * @param UrlShortenerInterface $urlShortener
+     * @param TranslatorInterface $translator
+     *
+     * @Inject({UrlShortener::class, "translator"})
+     */
+    public function __construct(UrlShortenerInterface $urlShortener, TranslatorInterface $translator)
+    {
+        $this->urlShortener = $urlShortener;
+        $this->translator = $translator;
+        parent::__construct(null);
+    }
+
+    public function configure()
+    {
+        $this->setName('shortcode:parse')
+             ->setDescription($this->translator->translate('Returns the long URL behind a short code'))
+             ->addArgument(
+                 'shortCode',
+                 InputArgument::REQUIRED,
+                 $this->translator->translate('The short code to parse')
+             );
+    }
+
+    public function interact(InputInterface $input, OutputInterface $output)
+    {
+        $shortCode = $input->getArgument('shortCode');
+        if (! empty($shortCode)) {
+            return;
+        }
+
+        /** @var QuestionHelper $helper */
+        $helper = $this->getHelper('question');
+        $question = new Question(sprintf(
+            '<question>%s</question> ',
+            $this->translator->translate('A short code was not provided. Which short code do you want to parse?:')
+        ));
+
+        $shortCode = $helper->ask($input, $output, $question);
+        if (! empty($shortCode)) {
+            $input->setArgument('shortCode', $shortCode);
+        }
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $shortCode = $input->getArgument('shortCode');
+
+        try {
+            $longUrl = $this->urlShortener->shortCodeToUrl($shortCode);
+            if (! isset($longUrl)) {
+                $output->writeln(sprintf(
+                    '<error>' . $this->translator->translate('No URL found for short code "%s"') . '</error>',
+                    $shortCode
+                ));
+                return;
+            }
+
+            $output->writeln(sprintf('%s <info>%s</info>', $this->translator->translate('Long URL:'), $longUrl));
+        } catch (InvalidShortCodeException $e) {
+            $output->writeln(sprintf('<error>' . $this->translator->translate(
+                'Provided short code "%s" has an invalid format.'
+            ) . '</error>', $shortCode));
+        }
+    }
+}