Release

.github/workflows/standards.yml

@@ -0,0 +1,33 @@
+name: Coding Standards
+
+on:
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP with tools
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          tools: composer, php-cs-fixer
+
+      - name: Validate composer.json
+        run: composer validate
+
+      - name: Remove eZ Platform Admin UI's dependency
+        run: composer remove ezsystems/ezplatform-admin-ui --no-interaction --no-update
+
+      - name: Validate coding standards in source
+        run: php-cs-fixer fix --dry-run --rules=@Symfony,-phpdoc_to_comment src/
+
+#      - name: Validate coding standards in test suite
+#        run: vendor/bin/php-cs-fixer fix --dry-run --rules=@Symfony tests/

README.md

@@ -3,4 +3,61 @@ Adrien Dupuis' eZ Platform Admin Extension Bundle
 
 Bundle to
 - extended eZ Platform Admin UI
-- add command line administration tools
+- add command line administration tools
+
+
+Install
+-------
+
+1. Add to [composer.json `repositories`](https://getcomposer.org/doc/04-schema.md#repositories): `{ "type": "vcs", "url": "https://github.com/adriendupuis/ezplatform-admin.git" }`
+1. Execute `composer require adriendupuis/ezplatform-admin;`
+1. Add to config/bundles.php: `AdrienDupuis\EzPlatformAdminBundle\AdrienDupuisEzPlatformAdminBundle::class => ['all' => true],`
+1. Execute `cp vendor/adriendupuis/ezplatform-admin/src/bundle/Resources/config/routes/adriendupuis_admin.yaml config/routes/adriendupuis_admin.yaml;`
+1. Pick ideas from [parameters.yaml](src/bundle/Resources/config/parameters.yaml) or fully import it; from, for example, config/services.yaml:
+```yaml
+imports:
+    - { resource: ../vendor/adriendupuis/ezplatform-admin/src/bundle/Resources/config/parameters.yaml }
+```
+
+
+Features
+--------
+
+* Content Usage
+  - Content Type Usage: Content count per content type.
+  - Field Usage (Example Finder): Find best and bad content examples for each field of a content type, and report field usage statistics.
+  - Language Usage: Content count per language.
+  - Landing Page Usage: Layout usage count and block usage count.
+* Admin
+  - Identification: Find content, location, content type or content type field definitions from an ID or an identifier (like `1`, `folder`, `user*` or `ez*text`)
+* Navigation
+  - Tab Opener: Open a tab according to URL hash. Examples: Right-click on a tab and open it in a new window, the tab is active; Reload a page, tab is still active.
+* Commands
+  - `ezuser:create` to create a user
+  - `ezuser:password` to change a user password
+  - `ezuser:enable` to enable a user
+  - `ezuser:anonymous:siteaccess` to add a siteaccess to the Anonymous's user/login policy limitation.
+  - `ezplatform:language:add` to add a language to the database
+  - `ezplatform:slug:test` to test transformation of text into slug
+
+
+Contribute
+----------
+
+### Translations
+
+English example:
+```shell
+bin/console translation:extract en \
+  --bundle AdrienDupuisEzPlatformAdminBundle \
+  --output-dir vendor/adriendupuis/ezplatform-admin/src/bundle/Resources/translations/ \
+  --domain ad_admin_content_usage --domain ad_admin_identification \
+;
+```
+
+### TODO
+
+* Features
+* Developments
+  * Quality
+    - Unit tests

composer.json

@@ -0,0 +1,13 @@
+{
+  "name": "adriendupuis/ezplatform-admin",
+  "description": "eZ Platform Administration Tools",
+  "homepage": "https://github.com/adriendupuis/ezplatform-admin",
+  "autoload": {
+    "psr-4": {
+      "AdrienDupuis\\EzPlatformAdminBundle\\": "src/bundle/"
+    }
+  },
+  "require": {
+    "ezsystems/ezplatform-admin-ui": "^2.0.0"
+  }
+}

src/bundle/AdrienDupuisEzPlatformAdminBundle.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace AdrienDupuis\EzPlatformAdminBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class AdrienDupuisEzPlatformAdminBundle extends Bundle
+{
+}

src/bundle/Command/AddLanguageToRepositoryCommand.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace AdrienDupuis\EzPlatformAdminBundle\Command;
+
+use eZ\Publish\API\Repository\LanguageService;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class AddLanguageToRepositoryCommand extends AdminCommandAbstract
+{
+    protected static $defaultName = 'ezplatform:language:add';
+
+    /** @var LanguageService */
+    private $languageService;
+
+    protected function configure(): void
+    {
+        parent::configure();
+        $this->setDescription('Create a new language')
+            ->addArgument('code', InputArgument::REQUIRED, 'Language code as <ISO 639‑2/B>-<ISO 3166-1 alpha-2>, in other words <three_lowercase_language>-<two_uppercase_country>; Examples: eng-GB, eng-US, fre-FR, fre-CA')
+            ->addArgument('name', InputArgument::REQUIRED | InputArgument::IS_ARRAY, 'Language name; Traditionally as full language name in itself followed by country in parentheses; Examples: English (United Kingdom), English (United States), Français (France), Français (Canada)');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->languageService = $this->repository->getContentLanguageService();
+
+        $initCode = $this->initAdminFunctionExecution($input, $output);
+
+        if (self::SUCCESS === $initCode) {
+            return $this->executeAdminFunction(function () {
+                $languageCreateStruct = $this->languageService->newLanguageCreateStruct();
+                $languageCreateStruct->languageCode = $this->input->getArgument('code');
+                $languageCreateStruct->name = implode(' ', $this->input->getArgument('name'));
+                $languageCreateStruct->enabled = true;
+                $this->languageService->createLanguage($languageCreateStruct);
+
+                return self::SUCCESS;
+            });
+        } else {
+            return $initCode;
+        }
+    }
+}

src/bundle/Command/AdminCommandAbstract.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace AdrienDupuis\EzPlatformAdminBundle\Command;
+
+use eZ\Publish\API\Repository\Exceptions\NotFoundException;
+use eZ\Publish\API\Repository\PermissionResolver;
+use eZ\Publish\API\Repository\Repository;
+use eZ\Publish\API\Repository\UserService;
+use eZ\Publish\API\Repository\Values\User\User;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+abstract class AdminCommandAbstract extends Command
+{
+    public const SUCCESS = 0;
+    public const FAILURE = 1;
+    public const ERROR_ADMIN_NOT_FOUND = 2;
+
+    /** @var Repository */
+    protected $repository;
+
+    /** @var UserService */
+    protected $userService;
+
+    /** @var PermissionResolver */
+    protected $permissionResolver;
+
+    /* @var User */
+    protected $admin;
+
+    /** @var InputInterface */
+    protected $input;
+
+    /** @var OutputInterface */
+    protected $output;
+
+    public function __construct(Repository $repository)
+    {
+        parent::__construct(self::$defaultName);
+        $this->repository = $repository;
+        $this->userService = $this->repository->getUserService();
+        $this->permissionResolver = $this->repository->getPermissionResolver();
+    }
+
+    protected function configure(): void
+    {
+        $this->addOption('admin', 'a', InputOption::VALUE_REQUIRED, 'Login of the admin user creating this new user; If not given, sudo is used');
+    }
+
+    protected function initAdminFunctionExecution(InputInterface $input, OutputInterface $output): int
+    {
+        $this->input = $input;
+        $this->output = $output;
+
+        if ($input->getOption('admin')) {
+            $this->admin = $this->loadUser($input->getOption('admin'));
+        }
+        if (null === $this->admin) {
+            if ($input->getOption('admin')) {
+                return self::ERROR_ADMIN_NOT_FOUND;
+            } else {
+                $output->writeln('<info>sudo will be used.</info>');
+            }
+        } else {
+            $this->permissionResolver->setCurrentUserReference($this->admin);
+        }
+
+        return self::SUCCESS;
+    }
+
+    protected function executeAdminFunction($function): int
+    {
+        if (null === $this->admin) {
+            return $this->repository->sudo($function);
+        } else {
+            return $function();
+        }
+    }
+
+    protected function loadUser($loginOrEmail): ?User
+    {
+        /* @var User|null $user */
+        $user = null;
+
+        try {
+            $user = $this->userService->loadUserByLogin($loginOrEmail);
+        } catch (NotFoundException $notFoundException) {
+            try {
+                $user = $this->userService->loadUserByEmail($loginOrEmail);
+            } catch (NotFoundException $notFoundException) {
+                $this->output->writeln("<error>User '$loginOrEmail' not found.</error>");
+            }
+        }
+
+        return $user;
+    }
+}

src/bundle/Command/OutputStyleTrait.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace AdrienDupuis\EzPlatformAdminBundle\Command;
+
+use Symfony\Component\Console\Formatter\OutputFormatterStyle;
+use Symfony\Component\Console\Output\OutputInterface;
+
+trait OutputStyleTrait
+{
+    /**
+     * Add styles corresponding to error levels.
+     */
+    public function setStyle(OutputInterface $output)
+    {
+        // https://symfony.com/doc/current/console/coloring.html
+        foreach ([
+                     'notice' => new OutputFormatterStyle('blue'),
+                     'warning' => new OutputFormatterStyle(null, 'yellow'),
+                     'debug' => new OutputFormatterStyle(null, 'magenta'),
+                 ] as $name => $style) {
+            $output->getFormatter()->setStyle($name, $style);
+        }
+    }
+}