Symfony Migration

.circleci/config.yml

@@ -27,18 +27,33 @@ jobs:
       - setup_remote_docker
       - run:
           name: Docker Compose corresponding OS file
-          command: docker compose -f ~/project/tests/playwright/Docker/docker-compose.yml up -d
+          command: pushd ~/project/tests/playwright/Docker && docker compose up -d; popd
       - run:
           name: Generate Key for XDMoD
           command: docker exec xdmod openssl genrsa -out /etc/pki/tls/private/localhost.key -rand /proc/cpuinfo:/proc/filesystems:/proc/interrupts:/proc/ioports:/proc/uptime 2048
       - run:
           name: Generate Cert for XDMoD
           command: docker exec xdmod /usr/bin/openssl req -new -key /etc/pki/tls/private/localhost.key -x509 -sha256 -days 365 -set_serial $RANDOM -extensions v3_req -out /etc/pki/tls/certs/localhost.crt -subj "/C=XX/L=Default City/O=Default Company Ltd"
+      - run:
+          name: Update PHP to PHP8.2
+          command: |
+            docker exec xdmod dnf module reset -y php
+            docker exec xdmod dnf module enable -y php:8.2
+            docker exec xdmod dnf install -y php-devel openssl-devel
+            docker exec xdmod dnf update -y php php-common php-opcache php-cli php-gd php-curl php-pear php-zip php-gmp php-pdo php-xml php-mbstring php-mysqlnd php-pecl-apcu php-pecl-json php-pear
+            docker exec xdmod pecl uninstall mongodb-1.18.1
+            docker exec xdmod pecl install mongodb-1.18.1
+            docker exec xdmod pecl install zip
+            docker exec xdmod dnf remove -y php-devel openssl-devel
+            docker exec xdmod bash -c ">/var/log/php_errors.log"
       - run:
           name: Copy Files for Playwright and XDMoD containers
           command: |
             docker cp ~/project xdmod:/root/xdmod
-            docker cp ~/project playwright:/root/xdmod
+            docker exec playwright mkdir -p /root/xdmod/tests/ /root/xdmod/tests/artifacts/xdmod/
+            docker cp ~/project/tests/playwright playwright:/root/xdmod/tests/
+            docker cp ~/project/tests/ci playwright:/root/xdmod/tests/
+            docker cp ~/project/tests/artifacts/xdmod/ui playwright:/root/xdmod/tests/artifacts/xdmod/
       - run:
           name: Create test result directories
           command: |
@@ -56,6 +71,13 @@ jobs:
       - run:
           name: Install XDMoD Composer Dependencies
           command: docker exec -w /root/xdmod xdmod composer install
+      - run:
+          name: Fixup php.ini for debugging
+          command: |
+            docker exec xdmod bash -c "sed -i 's|error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT|error_reporting = E_ALL|g' /etc/php.ini"
+            docker exec xdmod bash -c "sed -i 's|display_errors = Off|display_errors = On|g' /etc/php.ini"
+            docker exec xdmod bash -c "sed -i 's|display_startup_errors = Off|display_startup_errors = On|g' /etc/php.ini"
+            docker exec xdmod bash -c "sed -i 's|;error_log = php_errors.log|error_log = php_errors.log|g' /etc/php.ini"
       - run:
           name: Build XDMoD RPM
           command: docker exec -w /root/xdmod xdmod /root/bin/buildrpm xdmod
@@ -78,7 +100,7 @@ jobs:
           command: docker exec -w /root/xdmod xdmod composer install
       - run:
           name: Setup the SimpleSAML server etc. so we can test SSO
-          command: docker exec xdmod /root/xdmod/tests/ci/samlSetup.sh
+          command: docker exec xdmod /root/xdmod/tests/ci/samlSetup.sh -t local -h xdmod
       - run:
           name: Make sure that the Test Dependencies are installed
           command: docker exec -w /root/xdmod xdmod composer install --no-progress
@@ -196,7 +218,7 @@ jobs:
       - run:
           name: Ensure that no PHP command-line errors were generated
           command: |
-            docker exec xdmod /bin/bash -c "if [ -s /var/log/php_errors.log ]; then cat /var/log/php_errors.log; false; fi"
+            docker exec xdmod /bin/bash -c "if [ -s /var/log/php_errors.log ]; then cat /var/log/php_errors.log | grep -v 'Warning'; false; fi"
       - store_artifacts:
           path: /tmp/screenshots
       - store_artifacts:

.env

@@ -0,0 +1,2 @@
+# There is no need to alter this file except to support custom code development for XDMoD, it is required by
+# Symfony but we load the default Symfony required values via DefaultXdmodEnvVarLoader.

.github/workflows/linter.yml

@@ -5,6 +5,7 @@ on:
   pull_request:
     branches:
       - main
+      - symfony_migration
 
 env:
   XDMOD_IS_CORE: 'true'
@@ -25,7 +26,7 @@ jobs:
       - name: Setup php
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.2'
           extensions: xml
           tools: composer:v2
 

bin/console

@@ -0,0 +1,39 @@
+#!/usr/bin/env php
+<?php
+
+use CCR\Kernel;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+
+/* Since we want to be able to use this file in at least the following cases:
+ *   - in the working repository for dev purposes
+ *   - while installed via rpm ( location: /usr/bin/console, in $PATH by default )
+ *   - while installed via source ( location: /usr/local/xdmod/bin, not in $PATH by default )
+ *
+ * We need to be able to find the `vendor/autoload_runtime.php` in a couple different places.
+ *   - `'__XDMOD_SHARE_PATH__/vendor/autoload_runtime.php'` is for when XDMoD is installed from source or by RPM
+ *   - `dirname(__DIR__).'/vendor/autoload_runtime.php'` is for when doing dev work in the XDMoD git repo.
+ */
+$files = [
+    '__XDMOD_SHARE_PATH__/vendor/autoload_runtime.php',
+    dirname(__DIR__).'/vendor/autoload_runtime.php'
+];
+
+$file = null;
+foreach($files as $potentialFile) {
+    if (is_file($potentialFile)) {
+        $file = $potentialFile;
+        break;
+    }
+}
+
+if ($file === null) {
+    throw new RuntimeException('Symfony Runtime is missing. Try running "composer require symfony/runtime".');
+}
+
+require_once $file;
+
+return function (array $context) {
+    $kernel = new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
+
+    return new Application($kernel);
+};

bin/xdmod-admin

@@ -289,7 +289,7 @@ function addSSOUsers(array $data)
     foreach ($data as $user) {
         $xdmodUserId = \XDUser::userExistsWithUsername($user['username']);
         if ($xdmodUserId !== INVALID) {
-            $logger->warning("Skipping user '${user['username']}' - account already exists");
+            $logger->warning("Skipping user '{$user['username']}' - account already exists");
             continue;
         }
 

classes/Authentication/SAML/XDSamlAuthentication.php

@@ -6,14 +6,19 @@
 use \Exception;
 use CCR\Log;
 use Models\Services\Organizations;
+use Psr\Log\LoggerInterface;
+use SimpleSAML\Auth\Simple;
+use SimpleSAML\Auth\Source;
+use SimpleSAML\Metadata\MetaDataStorageHandler;
+use SimpleSAML\Session;
 use XDUser;
 
 class XDSamlAuthentication
 {
     /**
      * The selected auth source
      *
-     * @var \SimpleSAML_Auth_Simple
+     * @var Simple
      */
     protected $_as = null;
 
@@ -65,7 +70,7 @@ public function __construct()
             )
         );
 
-        $this->_sources = \SimpleSAML_Auth_Source::getSources();
+        $this->_sources = Source::getSources();
         if ($this->isSamlConfigured()) {
             try {
                 $authSource = \xd_utilities\getConfiguration('authentication', 'source');
@@ -97,7 +102,7 @@ public function isSamlConfigured()
      */
     public function logout(){
         if ($this->isSamlConfigured()) {
-            \SimpleSAML_Session::getSessionFromRequest()->doLogout($this->authSourceName);
+            Session::getSessionFromRequest()->doLogout($this->authSourceName);
         }
     }
     /**
@@ -112,7 +117,7 @@ public function getXdmodAccount()
         /*
          * SimpleSAMLphp uses its own session, this sets it back.
          */
-        \SimpleSAML_Session::getSessionFromRequest()->cleanup();
+        Session::getSessionFromRequest()->cleanup();
         if ($this->_as->isAuthenticated()) {
             $userName = $samlAttrs['username'][0];
 
@@ -205,7 +210,7 @@ public function getOrganizationId($samlAttrs, $personId)
      *
      * @param string $returnTo the URI to redirect to after auth.
      *
-     * @return the login URL or false if no provider is configured
+     * @return string|bool login URL or false if no provider is configured
      */
     public function getLoginURL($returnTo)
     {
@@ -226,8 +231,8 @@ public function getLoginLink()
         if (!$this->isSamlConfigured()) {
             return false;
         }
-        $idp = \SimpleSAML_Metadata_MetaDataStorageHandler::getMetadataHandler()->getMetadata(
-            \SimpleSAML_Auth_Source::getById($this->authSourceName)->getMetadata()->toArray()['idp'],
+        $idp = MetaDataStorageHandler::getMetadataHandler()->getMetaData(
+            Source::getById($this->authSourceName)->getMetadata()->toArray()['idp'],
             'saml20-idp-remote'
         );
         if (!empty($idp['OrganizationDisplayName'])) {

classes/CCR/CCRDBFormatter.php

@@ -3,6 +3,7 @@
 namespace CCR;
 
 use Monolog\Formatter\NormalizerFormatter;
+use Monolog\LogRecord;
 
 class CCRDBFormatter extends NormalizerFormatter
 {
@@ -12,7 +13,7 @@ class CCRDBFormatter extends NormalizerFormatter
      * all of the properties from the context. If the message is an empty
      * string the message property is not added.
      */
-    public function format(array $record)
+    public function format(LogRecord $record)
     {
         $vars = parent::format($record);
 

classes/CCR/CCRDBHandler.php

@@ -5,6 +5,8 @@
 use CCR\DB\iDatabase;
 use Exception;
 use Monolog\Handler\AbstractProcessingHandler;
+use Monolog\Level;
+use Monolog\LogRecord;
 
 /**
  * This class is meant to provide a means of writing log entries to a database within the Monolog framework.
@@ -49,7 +51,7 @@ class CCRDBHandler extends AbstractProcessingHandler
      */
     public function __construct(iDatabase $db = null, $schema = null, $table = null, $level = Log::DEBUG, $bubble = true)
     {
-        parent::__construct($level, $bubble);
+        parent::__construct(Level::fromValue(Log::convertToMonologLevel($level)), $bubble);
 
         if (!isset($db)) {
             $db = DB::factory('logger');
@@ -71,16 +73,16 @@ public function __construct(iDatabase $db = null, $schema = null, $table = null,
     /**
      * @see AbstractProcessingHandler::write()
      */
-    protected function write(array $record)
+    protected function write(LogRecord $record): void
     {
         $sql = sprintf("INSERT INTO %s.%s (id, logtime, ident, priority, message) VALUES(:id, NOW(), :ident, :priority, :message)", $this->schema, $this->table);
-
-        $this->db->execute($sql, array(
+        $params = [
             ':id' => $this->getNextId(),
             ':ident' => $record['channel'],
             ':priority' => Log::convertToCCRLevel($record['level']),
             ':message' => $record['formatted']
-        ));
+        ];
+        $this->db->execute($sql, $params);
     }
 
     /**

classes/CCR/CCRLineFormatter.php

@@ -4,6 +4,7 @@
 
 use Monolog\Formatter\LineFormatter;
 use Monolog\Formatter\NormalizerFormatter;
+use Monolog\LogRecord;
 use Monolog\Utils;
 
 class CCRLineFormatter extends LineFormatter
@@ -45,7 +46,7 @@
      * string and context object. If either the context is empty or the message
      * is an empty string they are ommitted.
      */
-    public function format(array $record)
+    public function format(LogRecord $record): string
     {
         $vars = NormalizerFormatter::format($record);
 
@@ -98,6 +99,11 @@
         // remove leftover %extra.xxx% and %context.xxx% if any
         if (false !== strpos($output, '%')) {
             $output = preg_replace('/%(?:extra|context)\..+?%/', '', $output);
+            if (null === $output) {
+                $pcreErrorCode = preg_last_error();
+
+                throw new \RuntimeException('Failed to run preg_replace: ' . $pcreErrorCode . ' / ' . preg_last_error_msg());
+            }
         }
 
         return $output;

classes/CCR/Log.php

@@ -8,7 +8,9 @@
 use Monolog\Handler\NativeMailerHandler;
 use Monolog\Handler\NullHandler;
 use Monolog\Handler\StreamHandler;
+use Monolog\Level;
 use Psr\Log\LoggerInterface;
+
 use xd_utilities;
 
 /**
@@ -32,25 +34,25 @@ class Log
     const DEBUG   = 7;
 
     private static $logLevels = array(
-        self::EMERG => \Monolog\Logger::EMERGENCY,
-        self::ALERT => \Monolog\Logger::ALERT,
-        self::CRIT => \Monolog\Logger::CRITICAL,
-        self::ERR => \Monolog\Logger::ERROR,
-        self::WARNING => \Monolog\Logger::WARNING,
-        self::NOTICE => \Monolog\Logger::NOTICE,
-        self::INFO => \Monolog\Logger::INFO,
-        self::DEBUG => \Monolog\Logger::DEBUG
+        self::EMERG => \Monolog\Level::Emergency->value,
+        self::ALERT => \Monolog\Level::Alert->value,
+        self::CRIT => \Monolog\Level::Critical->value,
+        self::ERR => \Monolog\Level::Error->value,
+        self::WARNING => \Monolog\Level::Warning->value,
+        self::NOTICE => \Monolog\Level::Notice->value,
+        self::INFO => \Monolog\Level::Info->value,
+        self::DEBUG => \Monolog\Level::Debug->value
     );
 
     private static $flippedLogLevels = array(
-        \Monolog\Logger::EMERGENCY => self::EMERG,
-        \Monolog\Logger::ALERT => self::ALERT,
-        \Monolog\Logger::CRITICAL => self::CRIT,
-        \Monolog\Logger::ERROR => self::ERR,
-        \Monolog\Logger::WARNING => self::WARNING,
-        \Monolog\Logger::NOTICE => self::NOTICE,
-        \Monolog\Logger::INFO => self::INFO,
-        \Monolog\Logger::DEBUG => self::DEBUG
+        \Monolog\Level::Emergency->value => self::EMERG,
+        \Monolog\Level::Alert->value => self::ALERT,
+        \Monolog\Level::Critical->value => self::CRIT,
+        \Monolog\Level::Error->value => self::ERR,
+        \Monolog\Level::Warning->value => self::WARNING,
+        \Monolog\Level::Notice->value => self::NOTICE,
+        \Monolog\Level::Info->value => self::INFO,
+        \Monolog\Level::Debug->value => self::DEBUG
     );
 
     /**
@@ -165,7 +167,7 @@ protected static function getLogger($ident, array $conf)
             'mail'
         );
 
-        $logger = new Logger($ident);
+        $logger = new \Monolog\Logger($ident);
 
         // Short circuit the function if 'null' was asked for since this will be the only handler for the logger.
         if ($ident === 'null') {
@@ -262,7 +264,7 @@ protected static function getDbHandler($ident, array $conf)
     {
         $dbLogLevel = $conf['dbLogLevel'] ?? self::getDefaultLogLevel('db');
 
-        $handler = new CCRDBHandler(null, null, null, self::convertToMonologLevel($dbLogLevel));
+        $handler = new CCRDBHandler(null, null, null, $dbLogLevel);
         $handler->setFormatter(new CCRDBFormatter());
 
         return $handler;
@@ -341,7 +343,7 @@ public static function convertToCCRLevel($monologLevel)
         if (array_key_exists($monologLevel, self::$flippedLogLevels)) {
             return self::$flippedLogLevels[$monologLevel];
         }
-        throw new Exception('Unknown Log Level');
+        throw new Exception(sprintf('Unknown Monolog Log Level %s', $monologLevel));
     }
 
     /**
@@ -356,7 +358,7 @@ public static function convertToMonologLevel($ccrLevel)
         if (array_key_exists($ccrLevel, self::$logLevels)) {
             return self::$logLevels[$ccrLevel];
         }
-        throw new Exception('Unknown Log Level');
+        throw new Exception(sprintf('Unknown CCR Log Level %s', $ccrLevel));
     }
 
     /**