Dev 2.0

README.md

@@ -137,7 +137,7 @@ or clone with Git :
 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/)
+For more info, see : [https://doc.equal.run/getting-started/install/installation/](https://doc.equal.run/getting-started/install/installation/)
 
 ## Contributing
 Contributions are what make the open-source community such an amazing place to learn, inspire, and create.

config/schema.json

@@ -316,6 +316,12 @@
         "description": "Flag for requesting to store meta data whenever an event occurs (creation, update, deletion or custom event).",
         "help": "Keep in mind that enabling logging increases I/O operations and impacts performances."
     },
+    "LOGS_EXPIRY_DELAY": {
+        "type": "integer",
+        "default": 12,
+        "description": "Duration, in months, for retaining logs in the database.",
+        "help": "This value is use in the logs_prune controller for auto-vacuuming logs."
+    },
     "UPLOAD_MAX_FILE_SIZE": {
         "type": "integer",
         "usage": "amount/data",

eq.lib.php

@@ -1035,7 +1035,24 @@ public static function announce(array $announcement) {
             foreach($announcement['params'] as $param => $config) {
                 // #memo - at some point condition had a clause "|| empty($body[$param])", remember not to alter received data!
                 if(in_array($param, $missing_params) && isset($config['default'])) {
-                    $body[$param] = $config['default'];
+                    $default_value = $config['default'];
+                    // #memo - array can be used as callable descriptor but are not considered here
+                    if( (is_string($default_value) || is_object($default_value)) && is_callable($default_value)) {
+                        // either a php function (or a function from the global scope) or a closure object
+                        if(is_object($default_value)) {
+                            // default is a closure
+                            $default_value = $default_value();
+                        }
+                    }
+                    elseif(is_string($default_value) && strpos($default_value, '::')) {
+                        list($class_name, $method_name) = explode('::', $default_value);
+                        if(method_exists($class_name, $method_name)) {
+                            /** @var \equal\orm\ObjectManager */
+                            $orm = $container->get('orm');
+                            $default_value = $orm->callonce($class_name, $method_name);
+                        }
+                    }
+                    $body[$param] = $default_value;
                 }
                 if(!array_key_exists($param, $body)) {
                     // ignore optional params without default value (this allows PATCH of objects on specific fields only)

lib/equal/data/adapt/adapters/sql/DataAdapterSqlBoolean.class.php

@@ -52,7 +52,7 @@ public function adaptOut($value, $usage, $locale='en') {
         if(is_null($value)) {
             return null;
         }
-        return ($value)?'1':'0';
+        return ($value) ? '1': '0';
     }
 
 }

lib/equal/error/Reporter.class.php

@@ -55,6 +55,7 @@ public static function handleThrowable($exception) {
         $msg = $exception->getMessage();
         // retrieve instance and log error
         $instance = self::getInstance();
+        // #todo #bug - $backtrace may contain non json_encodable objects (which leads to an error at file_put_contents)
         $backtrace = $exception->getTrace();
         if(count($backtrace)) {
             $trace = array_shift($backtrace);
@@ -159,12 +160,13 @@ private function log($code, $msg, $trace) {
             'mtime'         => substr($time_parts[0], 2, 6),
             'level'         => qn_debug_code_name($code),
             'mode'          => qn_debug_mode_name($mode),
-            'class'         => (isset($trace['class']))?$trace['class']:'',
-            'function'      => (isset($trace['function']))?(strlen($trace['function'])?$trace['function'].'()':'[main]'):'',
-            'file'          => (isset($trace['file']))?$trace['file']:'',
-            'line'          => (isset($trace['line']))?$trace['line']:'',
+            'class'         => (isset($trace['class'])) ? $trace['class'] : '',
+            'function'      => (isset($trace['function'])) ? (strlen($trace['function'])?$trace['function'].'()':'[main]') : '',
+            'file'          => (isset($trace['file'])) ? $trace['file'] : '',
+            'line'          => (isset($trace['line'])) ? $trace['line'] : '',
             'message'       => $msg,
-            'stack'         => (isset($trace['stack']))?$trace['stack']:[]
+            // #memo - in case of error, forcing trace stack to empty array
+            'stack'         => (isset($trace['stack'])) ? $trace['stack'] : []
         ];
 
         // append backtrace if required (fatal errors)

lib/equal/orm/Collection.class.php

@@ -835,14 +835,14 @@ public function read($fields, $lang=null) {
                 }
                 $children_fields = [];
                 foreach($subfields as $key => $val) {
-                    $children_fields[] = (!is_numeric($key))?$key:$val;
+                    $children_fields[] = (!is_numeric($key)) ? $key : $val;
                 }
                 // read all targeted children objects at once
-                $this->orm->read($target['foreign_object'], $children_ids, $children_fields, ($lang)?$lang:$this->lang);
+                $this->orm->read($target['foreign_object'], $children_ids, $children_fields, ($lang) ? $lang : $this->lang);
                 // assign retrieved values to the objects they relate to
                 foreach($this->objects as $id => $object) {
                     /** @var Collection */
-                    $children = $target['foreign_object']::ids($this->objects[$id][$field])->read($subfields, ($lang)?$lang:$this->lang);
+                    $children = $target['foreign_object']::ids($this->objects[$id][$field])->read($subfields, ($lang) ? $lang : $this->lang);
                     if($target['result_type'] == 'many2one') {
                         // #memo - result might be either null or a Model object (which might contain sub-collections)
                         $this->objects[$id][$field] = $children->first();
@@ -973,7 +973,11 @@ public function delete($permanent=false) {
     public function transition($transition) {
         // retrieve targeted identifiers
         $res = $this->orm->transition($this->class, $this->ids(), $transition);
-        if(count($res)) {
+        if($res < 0) {
+            trigger_error("ORM::unexpected error for transition '{$transition}' on '{$this->class}' objects:".$this->orm->getLastError(), EQ_REPORT_WARNING);
+            throw new \Exception('transition_failed', $res);
+        }
+        elseif(count($res)) {
             throw new \Exception(serialize($res), EQ_ERROR_NOT_ALLOWED);
         }
         return $this;

lib/equal/orm/DateReference.class.php

@@ -43,7 +43,7 @@ public function parse($descriptor) {
 
             if(preg_match('/date\.(this|prev|next)(\((\d*)\))?\.(day|week|month|quarter|semester|year)(\.(first|last|get\((.+)\)))?/', $descriptor, $matches)) {
                 // init at today
-                $date = new DateTime();
+                $date = new \DateTime();
 
                 $origin = $matches[1];
                 $offset = isset($matches[3]) && $matches[3] !== '' ? (int)$matches[3] : 1;

lib/equal/orm/Model.class.php

@@ -6,6 +6,7 @@
 */
 namespace equal\orm;
 
+use core\setting\Setting;
 use equal\services\Container;
 
 /**
@@ -141,6 +142,7 @@ private function setDefaults($values=[]) {
         $container = Container::getInstance();
         $orm = $container->get('orm');
         $defaults = $this->getDefaults();
+        $setting_defaults = $this->getSettingDefaults();
         // reset fields values
         $this->values = [];
         $fields = array_keys($this->schema);
@@ -166,6 +168,32 @@ private function setDefaults($values=[]) {
                     // default is a method of the class (or parents')
                     $this->values[$field] = $orm->callonce($this->getType(), $defaults[$field]);
                 }
+                elseif($defaults[$field] === 'defaultFromSetting') {
+                    $class_name = get_called_class();
+
+                    // create the setting code prefix
+                    // @example "core\alert\MessageModel" --> alert.message_model
+
+                    // split parts into an array
+                    $parts = explode('\\', $class_name);
+                    $package = array_shift($parts);
+
+                    // use dots instead of backslashes
+                    $class_name = implode('.', $parts);
+                    // convert PascalCase to snake_case
+                    $setting_code_prefix = strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $class_name));
+
+                    $default = Setting::get_value(
+                            $package,
+                            'default',
+                            "$setting_code_prefix.$field",
+                            $setting_defaults[$field] ?? null
+                        );
+
+                    if(!is_null($default)) {
+                        $this->values[$field] = $default;
+                    }
+                }
                 else {
                     // default is a scalar value
                     $this->values[$field] = $defaults[$field];
@@ -513,6 +541,16 @@ public function getDefaults() {
         return $defaults;
     }
 
+    public function getSettingDefaults() {
+        $setting_defaults = [];
+        foreach($this->schema as $field => $definition) {
+            if(isset($definition['setting_default'])) {
+                $setting_defaults[$field] = $definition['setting_default'];
+            }
+        }
+        return $setting_defaults;
+    }
+
     /**
      * Provide the list of unique rules (array of combinations of fields).
      * This method can be overridden to define a more precise set of unique constraints (i.e when keys are formed of several fields).

lib/equal/orm/ObjectManager.class.php

@@ -644,8 +644,9 @@ private function load($class, $ids, $fields, $lang) {
                         if(!ObjectManager::checkFieldAttributes(self::$mandatory_attributes, $schema, $field)) {
                             throw new Exception("missing at least one mandatory attribute for field '$field' of class '$class'", QN_ERROR_INVALID_PARAM);
                         }
-                        $order = (isset($schema[$field]['order']) && isset($schema[$schema[$field]['order']]))?$schema[$field]['order']:'id';
-                        $sort = (isset($schema[$field]['sort']))?$schema[$field]['sort']:'asc';
+                        // #todo - we should check that order field exists in targeted entity
+                        $order = (isset($schema[$field]['order'])) ? $schema[$field]['order'] : 'id';
+                        $sort = (isset($schema[$field]['sort'])) ? $schema[$field]['sort'] : 'asc';
                         $domain = [
                             [
                                 [$schema[$field]['foreign_field'], 'in', $ids],
@@ -661,9 +662,12 @@ private function load($class, $ids, $fields, $lang) {
                             $domain = $domain_tmp->toArray();
                         }
                         // #todo - add support for sorting on m2o fields (for now user needs to use usort)
+                        // #todo - this is invalid, check should point to the target schema (foreign_object)
+                        /*
                         if($schema[$order]['type'] == 'many2one' || (isset($schema[$order]['result_type']) && $schema[$order]['result_type'] == 'many2one') ) {
                             $order = 'id';
                         }
+                        */
                         // obtain the ids by searching inside the foreign object's table
                         $result = $om->db->getRecords(
                                 $om->getObjectTableName($schema[$field]['foreign_object']),
@@ -844,6 +848,7 @@ private function load($class, $ids, $fields, $lang) {
         }
         catch(Exception $e) {
             trigger_error("ORM::".$e->getMessage(), QN_REPORT_ERROR);
+            $this->last_error = $e->getMessage();
             throw new Exception('unable to load object fields', $e->getCode());
         }
     }
@@ -1104,6 +1109,7 @@ private function store($class, $ids, $fields, $lang) {
         }
         catch (Exception $e) {
             trigger_error("ORM::".$e->getMessage(), QN_REPORT_ERROR);
+            $this->last_error = $e->getMessage();
             throw new Exception('unable to store object fields', $e->getCode());
         }
     }
@@ -1129,7 +1135,7 @@ public function callonce($class, $method, $ids=[], $values=[], $lang=null, $sign
 
         $result = [];
 
-        $lang = ($lang)?$lang:constant('DEFAULT_LANG');
+        $lang = ($lang) ? $lang : constant('DEFAULT_LANG');
         $called_class = $class;
         $called_method = $method;
 
@@ -1212,14 +1218,16 @@ public function callonce($class, $method, $ids=[], $values=[], $lang=null, $sign
             if($res !== null) {
                 $result = $res;
             }
+            // unstack global object_methods state
+            $this->object_methods = $object_methods_state;
         }
         catch(\Exception $e) {
-            $result = $e->getCode();
+            // #memo - there is no depth limit so, exceptions must be relayed to caller
+            // unstack global object_methods state
+            $this->object_methods = $object_methods_state;
+            throw $e;
         }
 
-        // unstack global object_methods state
-        $this->object_methods = $object_methods_state;
-
         return $result;
     }
 
@@ -2504,7 +2512,7 @@ public function canTransition($class, $ids, $transition) {
      * @param   array       $ids              Array of ids of the objects to delete.
      * @param   string      $transition       Name of the requested workflow transition (signal).
      *
-     * @return  array           Returns an associative array containing invalid fields with their associated error_message_id.
+     * @return  mixed       Returns an associative array containing invalid fields with their associated error_message_id.
      *                          An empty array means all fields are valid. In case of error, the method returns a negative integer.
      */
     public function transition($class, $ids, $transition) {
@@ -2514,28 +2522,36 @@ public function transition($class, $ids, $transition) {
         if(count($res)) {
             return $res;
         }
+        $res = [];
         $table_name = $this->getObjectTableName($class);
         $model = $this->getStaticInstance($class);
         $workflow = $model->getWorkflow();
         $lang = constant('DEFAULT_LANG');
         // read status field for retrieved objects
         $objects = $this->read($class, $ids, ['status']);
-        foreach($objects as $id => $object) {
-            // reaching this part means all objects have a status and a workflow in which given transition is defined and valid for requested mutation
-            $t_descr = $workflow[$object['status']]['transitions'][$transition];
-            // if a 'onbefore' method is defined for applied transition, call it
-            if(isset($t_descr['onbefore'])) {
-                $this->callonce($class, $t_descr['onbefore'], $id);
-            }
-            // status field is always writeable (we don't call `update()` to bypass checks)
-            $this->cache[$table_name][$id][$lang]['status'] = $t_descr['status'];
-            $this->store($class, (array) $id, ['status'], $lang);
-            // if a 'onafter' method is defined for applied transition, call it
-            if(isset($t_descr['onafter'])) {
-                $this->callonce($class, $t_descr['onafter'], $id);
+        try {
+            foreach($objects as $id => $object) {
+                // reaching this part means all objects have a status and a workflow in which given transition is defined and valid for requested mutation
+                $t_descr = $workflow[$object['status']]['transitions'][$transition];
+                // if a 'onbefore' method is defined for applied transition, call it
+                if(isset($t_descr['onbefore'])) {
+                    $this->callonce($class, $t_descr['onbefore'], $id);
+                }
+                // status field is always writeable (we don't call `update()` to bypass checks)
+                $this->cache[$table_name][$id][$lang]['status'] = $t_descr['status'];
+                $this->store($class, (array) $id, ['status'], $lang);
+                // if a 'onafter' method is defined for applied transition, call it
+                if(isset($t_descr['onafter'])) {
+                    $this->callonce($class, $t_descr['onafter'], $id);
+                }
             }
         }
-        return [];
+        catch(\Exception $e) {
+            trigger_error("ORM::".$e->getMessage(), QN_REPORT_WARNING);
+            $this->last_error = $e->getMessage();
+            $res = $e->getCode();
+        }
+        return $res;
     }
 
     /**