Added an check-requirements console command

.github/workflows/tests.yml

@@ -127,4 +127,7 @@ jobs:
       
       - name: Test app:show-logs
         run: php bin/console app:show-logs -n
+
+      - name: Test check-requirements command
+        run: php bin/console partdb:check-requirements -n
       

README.md

@@ -105,6 +105,7 @@ Useful commands are:
  If you dont use Euro as base currency, you have to setup an fixer.io API key in `.env.local`.
 * `php bin/console partdb:attachments:clean-unused`: Removes all unused files (files without an associated attachment) in attachments folder. 
 Normally Part-DB should be able to delete the attachment file, if you delete the attachment, but if you have some obsolete files left over from legacy Part-DB you can remove them safely with this command.
+* `php bin/console partdb:check-requirements`: Checks if the required dependencies are installed and gives you recommendations for optimization
 * `php bin/console cache:clear`: Remove and rebuild all caches. If you encounter some weird issues in Part-DB, it maybe helps to run this command.
 * `php bin/console doctrine:migrations:up-to-date`: Check if your database is up to date.
 

docs/installation/installation_guide-debian.md

@@ -96,6 +96,13 @@ sudo yarn install
 sudo yarn build
 ```
 
+### Check if everything is installed
+To check if everything is installed, run the following command:
+```bash
+sudo -u www-data php bin/console partdb:check-requirements
+```
+The most things should be green, and no red ones. Yellow messages means optional dependencies which are not important but can improve performance and functionality.
+
 ## Create a database for Part-DB
 Part-DB by default uses a file based sqlite database to store the data. Use the following command to create the database. The database will normally created at `/var/www/partdb/var/app.db`.
 ```bash

src/Command/CheckRequirementsCommand.php

@@ -0,0 +1,158 @@
+<?php
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
+
+class CheckRequirementsCommand extends Command
+{
+    protected static $defaultName = 'partdb:check-requirements';
+
+    protected $params;
+
+    public function __construct(ContainerBagInterface $params)
+    {
+        $this->params = $params;
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setDescription('Checks if the requirements Part-DB needs or recommends are fulfilled.')
+            ->addOption('only_issues', 'i', InputOption::VALUE_NONE, 'Only show issues, not success messages.')
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $only_issues = (bool) $input->getOption('only_issues');
+
+        $io->title('Checking PHP configuration...');
+        $this->checkPHP($io, $only_issues);
+
+        $io->title('Checking PHP extensions...');
+        $this->checkPHPExtensions($io, $only_issues);
+
+        $io->title('Checking Part-DB configuration');
+        $this->checkPartDBConfig($io, $only_issues);
+
+        return self::SUCCESS;
+
+    }
+
+    protected function checkPHP(SymfonyStyle $io, $only_issues = false): void
+    {
+        //Check PHP versions
+        $io->isVerbose() && $io->comment('Checking PHP version...');
+        if (PHP_VERSION_ID < 80100) {
+            $io->warning('You are using PHP '. PHP_VERSION .'. This will work, but a newer version is recommended.');
+        } else {
+            !$only_issues && $io->success('PHP version is sufficient.');
+        }
+
+        //Check if opcache is enabled
+        $io->isVerbose() && $io->comment('Checking Opcache...');
+        $opcache_enabled = ini_get('opcache.enable') === '1';
+        if (!$opcache_enabled) {
+            $io->warning('Opcache is not enabled. This will work, but performance will be better with opcache enabled. Set opcache.enable=1 in your php.ini to enable it');
+        } else {
+            !$only_issues && $io->success('Opcache is enabled.');
+        }
+
+        //Check if opcache is configured correctly
+        $io->isVerbose() && $io->comment('Checking Opcache configuration...');
+        if ($opcache_enabled && (ini_get('opcache.memory_consumption') < 256 || ini_get('opcache.max_accelerated_files') < 20000)) {
+            $io->warning('Opcache configuration can be improved. See https://symfony.com/doc/current/performance.html for more info.');
+        } else {
+            !$only_issues && $io->success('Opcache configuration is already performance optimized.');
+        }
+    }
+
+    protected function checkPartDBConfig(SymfonyStyle $io, $only_issues = false): void
+    {
+        //Check if APP_ENV is set to prod
+        $io->isVerbose() && $io->comment('Checking debug mode...');
+        if($this->params->get('kernel.debug')) {
+            $io->warning('You have activated debug mode, this is will leak informations in a production environment.');
+        } else {
+            !$only_issues && $io->success('Debug mode disabled.');
+        }
+
+    }
+
+    protected function checkPHPExtensions(SymfonyStyle $io, $only_issues = false): void
+    {
+        //Get all installed PHP extensions
+        $extensions = get_loaded_extensions();
+        $io->isVerbose() && $io->comment('Your PHP installation has '. count($extensions) .' extensions installed: '. implode(', ', $extensions));
+
+        $db_drivers_count = 0;
+        if(!in_array('pdo_mysql', $extensions)) {
+            $io->error('pdo_mysql is not installed. You will not be able to use MySQL databases.');
+        } else {
+            !$only_issues && $io->success('PHP extension pdo_mysql is installed.');
+            $db_drivers_count++;
+        }
+
+        if(!in_array('pdo_sqlite', $extensions)) {
+            $io->error('pdo_sqlite is not installed. You will not be able to use SQLite. databases');
+        } else {
+            !$only_issues && $io->success('PHP extension pdo_sqlite is installed.');
+            $db_drivers_count++;
+        }
+
+        $io->isVerbose() && $io->comment('You have '. $db_drivers_count .' database drivers installed.');
+        if ($db_drivers_count === 0) {
+            $io->error('You have no database drivers installed. You have to install at least one database driver!');
+        }
+
+        if(!in_array('curl', $extensions)) {
+            $io->warning('curl extension is not installed. Install curl extension for better performance');
+        } else {
+            !$only_issues && $io->success('PHP extension curl is installed.');
+        }
+
+        $gd_installed = in_array('gd', $extensions);
+        if(!$gd_installed) {
+            $io->error('GD is not installed. GD is required for image processing.');
+        } else {
+            !$only_issues && $io->success('PHP extension GD is installed.');
+        }
+
+        //Check if GD has jpeg support
+        $io->isVerbose() && $io->comment('Checking if GD has jpeg support...');
+        if ($gd_installed) {
+            $gd_info = gd_info();
+            if($gd_info['JPEG Support'] === false) {
+                $io->warning('Your GD does not have jpeg support. You will not be able to generate thumbnails of jpeg images.');
+            } else {
+                !$only_issues && $io->success('GD has jpeg support.');
+            }
+
+            if($gd_info['PNG Support'] === false) {
+                $io->warning('Your GD does not have png support. You will not be able to generate thumbnails of png images.');
+            } else {
+                !$only_issues && $io->success('GD has png support.');
+            }
+
+            if($gd_info['WebP Support'] === false) {
+                $io->warning('Your GD does not have WebP support. You will not be able to generate thumbnails of WebP images.');
+            } else {
+                !$only_issues && $io->success('GD has WebP support.');
+            }
+        }
+
+
+
+
+    }
+
+}