Dev 2.0

.docker/Dockerfile

@@ -12,14 +12,12 @@ RUN apt-get update && apt-get install -y \
     vim
 COPY ./mpm_prefork.conf /etc/apache2/mods-available/
 COPY ./000-default.conf /etc/apache2/sites-available/
-
 # install sqlsrv drivers
 RUN curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add - 
 RUN curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
 RUN apt-get update
 RUN ACCEPT_EULA=Y apt-get -y --no-install-recommends install msodbcsql17 odbcinst=2.3.7 odbcinst1debian2=2.3.7 unixodbc-dev=2.3.7 unixodbc=2.3.7
 RUN pecl install sqlsrv-5.10.1 pdo_sqlsrv-5.10.1
-
 # install required PHP extensions
 RUN set -ex; \
         \
@@ -38,7 +36,8 @@ RUN set -ex; \
         ; \
         \
         docker-php-ext-configure gd --with-freetype --with-jpeg --with-webp; \
-        docker-php-ext-install gd mysqli opcache zip tidy; \
+        docker-php-ext-configure intl; \
+        docker-php-ext-install gd mysqli opcache zip tidy intl; \
 		docker-php-ext-enable sqlsrv pdo_sqlsrv; \
         \
 # reset apt-mark's "manual" list so that "purge --auto-remove" will remove all build dependencies

.gitignore

@@ -1,4 +1,5 @@
 vendor/
+tests/
 log/*
 !log/.gitkeep
 cache/*
@@ -18,4 +19,5 @@ public/*
 !public/index.php
 !public/console.php
 !public/assets
+!public/console2.php
 public/assets/env/config.json

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "doc"]
+	path = doc
+	url = https://github.com/equalframework/equal-doc.git
+[submodule "packages/core/apps/workbench/source"]
+	path = packages/core/apps/workbench/source
+	url = https://github.com/equalframework/apps-core-workbench.git

README.md

@@ -52,6 +52,9 @@ git clone https://github.com/equalframework/equal.git
 For more info, see : [http://doc.equal.run/getting-started/installation](http://doc.equal.run/getting-started/installation/)
 
 
+## CLI autocomplete
+To ease commands typing in CLI, you can enable autocompletion by running `source autocomplete`.
+
 
 ## Code Coverage setup
 

equal_autocomplete → autocomplete

@@ -1,5 +1,5 @@
 # this script is meant to be placed at /etc/bash_completion.d/
-# and activated with source /etc/bash_completion.d/equal_autocomplete
+# and activated with `source /etc/bash_completion.d/autocomplete`
 
 _equal_completion()
 {

config/schema.json

@@ -15,7 +15,7 @@
     },
     "DEFAULT_LANG": {
         "type": "string",
-        "description": "The language in which the content must be displayed by default (ISO 639-1).",
+        "description": "The language in which the multilang content must be provided/stored by default (ISO 639-1).",
         "instant": true,
         "default": "en"
     },
@@ -78,6 +78,12 @@
         "instant": true,
         "default": 10
     },
+    "HTTP_PROCESS_USERNAME": {
+        "type": "string",
+        "description": "Username used by the HTTP service (for rights checks).",
+        "instant": true,
+        "default": "www-data"
+    },
     "EMAIL_SMTP_HOST": {
         "type": "string",
         "description": "Hostname of the SMTP server to use for sending emails.",
@@ -137,7 +143,7 @@
     },
     "DB_DBMS": {
         "type": "string",
-        "description": "Database Management System running on the DB host. Possible values are: 'MYSQL', 'SQLSRV', 'MARIADB', 'POSTGRESQL'",
+        "description": "Database Management System running on the DB host. Possible values are: 'MYSQL', 'SQLSRV', 'MARIADB', 'SQLITE', 'POSTGRESQL'",
         "instant": true,
         "default": "MYSQL",
         "examples": [
@@ -270,6 +276,8 @@
     },
     "ROOT_APP_URL": {
         "type": "string",
+        "deprecated": "Please use APP_URL instead.",
+        "description": "The URL of the root folder (mapped with `./public`), with the scheme but without trailing slash (no path).",
         "default": "http://equal.local"
     },
     "USER_ACCOUNT_DISPLAYNAME": {
@@ -286,5 +294,30 @@
         "type": "boolean",
         "description": "Flag telling if a new user account needs to be validated before being active.",
         "default": true
+    },
+    "ORG_NAME" : {
+        "type": "string",
+        "description": "Name of the organisation to which belongs the instance.",
+        "default": "eQual"
+    },
+    "ORG_URL": {
+        "type": "string",
+        "description": "URL of the official website of the organisation.",
+        "default": "https://equal.run"
+    },
+    "APP_NAME": {
+        "type": "string",
+        "description": "Specific brand name of the application, if any.",
+        "default": "eQual"
+    },
+    "APP_URL": {
+        "type": "string",
+        "description": "The URL of the root folder (mapped with `./public`), with the scheme but without trailing slash (no path).",
+        "default": "http://equal.local"
+    },
+    "APP_LOGO_URL": {
+        "type": "string",
+        "description": "The URL of the image to be displayed in UI as App logo in the top left corner.",
+        "default": "/assets/img/logo.svg"
     }
 }

config/usages.json

@@ -32,7 +32,8 @@
                 "xml"       : {},
                 "html"      : {},
                 "markdown"  : {},
-                "wiki"      : {}
+                "wiki"      : {},
+                "json"      : {}
             },
             "length_free" : true,
             "boundary" : true

ecs.php

@@ -9,18 +9,21 @@
 return static function (ECSConfig $ecsConfig): void {
     $ecsConfig->paths([__DIR__ . '/src', __DIR__ . '/tests']);
 
-    $ecsConfig->ruleWithConfiguration(ArraySyntaxFixer::class, [
-        'syntax' => 'short',
-    ]);
-
     $ecsConfig->sets([
         // run and fix, one by one
         SetList::SPACES,
         SetList::ARRAY,
-	    SetList::DOCBLOCK,
-	    SetList::SYMPLIFY,
-	    // SetList::COMMON, // adds declare(strict_types=1)
-	    SetList::CLEAN_CODE,
+        SetList::DOCBLOCK,
+        // #memo - messes with COMMENTS blocks
+        // SetList::SYMPLIFY,
+        // #memo - adds declare(strict_types=1)
+        // SetList::COMMON,
+        SetList::CLEAN_CODE,
         SetList::PSR_12,
     ]);
+
+    $ecsConfig->ruleWithConfiguration(ArraySyntaxFixer::class, [
+        'syntax' => 'short',
+    ]);
+
 };

eq.lib.php

@@ -33,7 +33,7 @@
     /**
      * Current version of eQual
      */
-    define('QN_VERSION', '1.0.0');
+    define('EQ_VERSION', '2.0.0');
 
     /**
      * Root directory of current install
@@ -109,13 +109,15 @@
     define('QN_R_WRITE',     4);
     define('QN_R_DELETE',    8);
     define('QN_R_MANAGE',   16);
+    define('QN_R_ALL',      31);
 
     /* equivalence map for naming migration */
-    define('R_CREATE',       QN_R_CREATE);
-    define('R_READ',         QN_R_READ);
-    define('R_WRITE',        QN_R_WRITE);
-    define('R_DELETE',       QN_R_DELETE);
-    define('R_MANAGE',       QN_R_MANAGE);
+    define('EQ_R_CREATE',       QN_R_CREATE);
+    define('EQ_R_READ',         QN_R_READ);
+    define('EQ_R_WRITE',        QN_R_WRITE);
+    define('EQ_R_DELETE',       QN_R_DELETE);
+    define('EQ_R_MANAGE',       QN_R_MANAGE);
+    define('EQ_R_ALL',          QN_R_ALL);
 
     /**
      * Built-in Users and Groups
@@ -821,6 +823,7 @@ public static function announce(array $announcement) {
             }
 
 
+
             // 1) check if all required parameters have been received
 
             // build mandatory fields array
@@ -831,23 +834,53 @@ public static function announce(array $announcement) {
             }
             // if at least one mandatory param is missing
             $missing_params = array_values(array_diff($mandatory_params, array_keys($body)));
-            if( count($missing_params)
-                || isset($body['announce'])
-                || $method == 'OPTIONS' ) {
+            if( count($missing_params) || isset($body['announce']) || $method == 'OPTIONS' ) {
                 // #memo - we don't remove anything from the schema, so it can be returned as is for the UI
                 // (for public and protected controllers this might be considered as security issue as it may reveals a part of the configuration)
-                // no feedback about services
-                if(isset($announcement['providers'])) {
-                    // unset($announcement['providers']);
-                }
-                // no feedback about constants
-                if(isset($announcement['constants'])) {
-                    // unset($announcement['constants']);
+                // if 'help' is amongst the params and request was made through CLI
+                if(php_sapi_name() == 'cli' && isset($body['help'])) {
+                    $operation = $context->get('operation');
+                    $help = 'Help about ';
+                    $help .= strtoupper($operation['type']).' '.$operation['operation']." :\n\n";
+                    $help .= "Description:\n";
+                    $help .= $announcement["description"]."\n\n";
+                    $help .= "Parameters:\n";
+                    foreach($announcement['params'] as $name => $info) {
+                        $help .= str_pad("--".$name, 20, ' ', STR_PAD_RIGHT);
+                        $required = (isset($info['required']))?'(required)':'';
+                        $help .= str_pad($required, 12, ' ');
+                        $type = $info['type'].( (isset($info['usage']))?'>'.$info['usage']:'');
+                        $help .= str_pad($type, 28, ' ');
+                        $help .= $info['description']."\n";
+                    }
+                    $help.= "\nMore Info :\n";
+                    foreach($body as $key => $value) {
+                        if(isset($announcement['params'][$key])) {
+                            $help.= "--".$key." :\n";
+                            if(isset($announcement['params'][$key]['help'])) {
+                                $help .= '   help: ';
+                                $help .= preg_replace("/ {2,}/", str_pad('', 9, ' '), $announcement['params'][$key]['help'])."\n";
+                            }
+                            if(isset($announcement['params'][$key]['default'])) {
+                                $help .= '   default value: ';
+                                $help .= json_encode($announcement['params'][$key]['default'], true)."\n";
+                            }
+                            if(isset($announcement['params'][$key]['selection'])) {
+                                $help .= '   selection: ';
+                                $help .= json_encode($announcement['params'][$key]['selection'], true)."\n";
+                            }
+                        }
+                    }
+                    $response->status(200)
+                        ->header('Content-Type', 'text/plain')
+                        ->body($help)
+                        ->send();
+                    throw new \Exception('', 0);
                 }
                 // add announcement to response body
                 $response->body(['announcement' => $announcement]);
+                // if user asked for the announcement or browser requested fingerprint, set status and header accordingly
                 if(isset($body['announce']) || $method == 'OPTIONS') {
-                    // user asked for the announcement or browser requested fingerprint
                     $response->status(200)
                         // allow browser to cache the response for 1 year
                         ->header('Cache-Control', 'max-age=31536000')
@@ -972,7 +1005,7 @@ public static function announce(array $announcement) {
                 $response->body(['announcement' => $announcement]);
                 foreach($invalid_params as $invalid_param => $error_id) {
                     // raise an exception with error details
-                    throw new \Exception(serialize([$invalid_param => [$error_id => 'Invalid parameter']]), QN_ERROR_INVALID_PARAM);
+                    throw new \Exception(serialize([$invalid_param => [$error_id => "Invalid value {$result[$invalid_param]} for parameter {$invalid_param}."]]), QN_ERROR_INVALID_PARAM);
                 }
             }
 
@@ -1215,7 +1248,7 @@ public static function run($type, $operation, $body=[], $root=false) {
                     // restore original HTTP Response headers
                     // #memo - this is mandatory for integration with other frameworks (i.e. WP) while calling `run()` when (some) headers have already been set
                     $headers_orig = $context_orig->getHttpResponse()->getHeaders(true);
-                    if(count($headers_orig)) {
+                    if(is_array($headers_orig) && count($headers_orig)) {
                         header_remove();
                         foreach($headers_orig as $header => $value) {
                             header($header.': '.$value);