Add PHPStan level 0 checks

* Add PHPStan level 0 check * Fix: Method NotificationSettingConfig::update() should return bool but return statement is missing. * Fix: Method Html::showDatesTimelineGraph() should return array but return statement is missing. * Fix: Array has 2 duplicate keys with value 'multiple' ('multiple', 'multiple'). * Fix: Access to an undefined property HTMLTableMain::$title. * Fix: Access to an undefined property HTMLTableGroup::$ordered_headers. * Fix: Variable $subheader_name is undefined * Fix: Access to an undefined property HTMLTableCell::$numberOfLines. * Fix: Access to an undefined property HTMLTableCell::$start. * Fix: Call to function unset() contains undefined variable $name|$type|$cbbox|$cidinfo|$cw|$dw. * Fix: Method GLPIMailer::setLanguage() should return bool but return statement is missing. * Fix FieldUnicity display when there is no fields selected * Fix: Method Glpi\Features\PlanningEvent::getAlreadyPlannedInformation() should return string but return statement is missing. * Fix: Call to an undefined static method PlanningExternalEventTemplate::getVisibilityCriteria(). * Fix: Instantiated class CommonITILTask is abstract. * Fix: Undefined variable: $options * Fix: Method DropdownTranslation::regenerateAllCompletenameTranslationsFor() should return string but return statement is missing. * Fix: Method Dropdown::showFrequency() should return int|string but return statement is missing. * Fix: Method Domain_Item::showForItem() should return bool but return statement is missing. * Remove Domain::getAdditionalFields() (Domain does not inherits CommonDropdown anymore) * Fix: Method Document_Item::showAddFormForItem() should return bool but return statement is missing. * Fix: Method Device*::getHTMLTableHeader() should return HTMLTableHeader but return statement is missing. * Fix: Undefined variable: $RELATION * Fix: Method DatabaseInstance::getTabNameForItem() should return string but return statement is missing. * Fix: Method DCRoom::getTabNameForItem() should return string but return statement is missing. * Fix: Result of method DBmysqlIterator::handleFields() (void) is used. * Fix: Method DBmysql::rollBack() should return bool but return statement is missing. * Fix: Method CronTask::cronInfo() should return array but return statement is missing. * Fix rights checks on CronTask massive actions * Fix: Result of method CronTask::showHistoryDetail() (void) is used. * Fix: Method Contact::getAddress() should return string but return statement is missing. * Fix: Method Consumable::getStatus() should return string but return statement is missing. * Fix: Access to undefined constant Glpi\Console\Migration\UnsignedKeysCommand::ERROR_UNABLE_TO_UPDATE_CONFIG. * Fix: Class DB not found. * Fix: Undefined variable: $parent * Fix: Undefined variable: $title * Fix: Method CommonGLPI::canUpdate() should return bool but return statement is missing. * Fix: Call to an undefined static method static(CommonGLPI)::getIcon(). * Fix: Call to an undefined method $this(CommonGLPI)::isField(). * Fix: Call to an undefined method CommonGLPI::getNameID(). * Fix: Call to an undefined method CommonGLPI::getFromDB(). * Fix: Access to an undefined property CommonGLPI::$fields. * Fix: Call to an undefined method CommonGLPI::getLink(). * Fix: Method CommonGLPI::getErrorMessage() should return string but return statement is missing. * Fix: Access to an undefined property CommonGLPI::$fields. * Fix: Access to an undefined property CommonDBVisible::$entities|groups|profiles|users. * Fix Glpi\Features\PlanningEvent::post_getEmpty() * Fix: Parameter #1 $position (int) of method DBmysqlIterator::seek() is not contravariant with parameter #1 $offset (mixed) of method SeekableIterator::seek(). * Fix: Call to an undefined static method static(CommonDBTM)::getDcBreadcrumbSpecificValueToDisplay(). * Fix: Access to an undefined property CommonDBTM::$itemtype. * Fix: Result of method CommonDBTM::canGlobal() (void) is used. * Fix: Result of method CommonDBTM::updateInDB() (void) is used. * Fix: Call to an undefined method CommonDBTM::clone(). * Fix: Method CommonDBTM::restoreSavedValues() should return array but return statement is missing. * Fix: Method Certificate_Item::showForItem() should return bool but return statement is missing. * Fix: Result of static method Contract::showCentral() (void) is used. * Fix: Method Cartridge::uninstall() should return bool but return statement is missing. * Fix: Method AuthLDAP::ldapImportUserByServerId() should return array|bool but return statement is missing. * Fix: Unsafe usage of new static(). * Fix: Function brotli_compress|brotli_uncompress not found.
cedric-anne · Sep 13, 2022 · 938a234 · 938a234
1 parent 15a89c0
commit 938a234
Show file tree

Hide file tree

Showing 47 changed files with 480 additions and 210 deletions.
diff --git a/.github/actions/lint_php-lint.sh b/.github/actions/lint_php-lint.sh
@@ -17,3 +17,10 @@ touch ~/phpcs.cache
 vendor/bin/phpcs \
   --cache ~/phpcs.cache \
   .
+
+echo "Run code static analysis"
+vendor/bin/phpstan analyze \
+  --ansi \
+  --memory-limit=2G \
+  --no-interaction \
+  --no-progress
diff --git a/composer.json b/composer.json
@@ -77,6 +77,7 @@
         "maglnet/composer-require-checker": "^3.5",
         "mikey179/vfsstream": "^1.6",
         "php-parallel-lint/php-parallel-lint": "^1.3",
+        "phpstan/phpstan": "^1.8",
         "squizlabs/php_codesniffer": "^3.7"
     },
     "replace": {

diff --git a/composer.lock b/composer.lock
diff --git a/inc/based_config.php b/inc/based_config.php
@@ -34,7 +34,7 @@
  */
 
 if (!defined('GLPI_ROOT')) {
-    die("Sorry. You can't access this file directly");
+    define('GLPI_ROOT', dirname(__FILE__, 2));
 }
 
 // Notice problem  for date function :

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,14 @@
+parameters:
+    level: 0
+    bootstrapFiles:
+        - inc/based_config.php
+    paths:
+        - src
+    scanDirectories:
+        - inc
+    ignoreErrors:
+        - '/Call to static method \w+\(\) on an unknown class phpCAS/'
+        - '/Class Ldap\\Connection not found/'
+        - '/Instantiated class (DB|DBSlave) not found/'
+        - '/Instantiated class XHProfRuns_Default not found/'
+        - '/\w+ has been replaced by \w+/'
diff --git a/src/Agent/Communication/AbstractRequest.php b/src/Agent/Communication/AbstractRequest.php
@@ -215,7 +215,14 @@ public function handleRequest($data): bool
                     $data = gzdecode($data);
                     break;
                 case self::COMPRESS_BR:
-                    $data = brotli_uncompress($data);
+                    if (!function_exists('brotli_uncompress')) {
+                        trigger_error(
+                            'Brotli PHP extension is required to handle Brotli compression algorithm in inventory feature.',
+                            E_USER_WARNING
+                        );
+                    } else {
+                        $data = brotli_uncompress($data);
+                    }
                     break;
                 case self::COMPRESS_DEFLATE:
                     $data = gzinflate($data);
@@ -521,7 +528,14 @@ public function getResponse(): string
                         $data = gzencode($data);
                         break;
                     case self::COMPRESS_BR:
-                        $data = brotli_compress($data);
+                        if (!function_exists('brotli_compress')) {
+                            trigger_error(
+                                'Brotli PHP extension is required to handle Brotli compression algorithm in inventory feature.',
+                                E_USER_WARNING
+                            );
+                        } else {
+                            $data = brotli_compress($data);
+                        }
                         break;
                     case self::COMPRESS_DEFLATE:
                         $data = gzdeflate($data);

diff --git a/src/Application/ErrorHandler.php b/src/Application/ErrorHandler.php
@@ -158,7 +158,7 @@ public static function getInstance(): ErrorHandler
 
         if ($instance === null) {
             global $PHPLOGGER;
-            $instance = new static($PHPLOGGER);
+            $instance = new self($PHPLOGGER);
         }
 
         return $instance;

diff --git a/src/Application/View/TemplateRenderer.php b/src/Application/View/TemplateRenderer.php
@@ -131,7 +131,7 @@ public static function getInstance(): TemplateRenderer
         static $instance = null;
 
         if ($instance === null) {
-            $instance = new static();
+            $instance = new self();
         }
 
         return $instance;

diff --git a/src/AuthLDAP.php b/src/AuthLDAP.php
@@ -2851,9 +2851,8 @@ public static function ldapImportUserByServerId(
                 ErrorHandler::getInstance()->handleException($e);
                 return false;
             }
-        } else {
-            return false;
         }
+        return false;
     }
 
 

diff --git a/src/Cartridge.php b/src/Cartridge.php
@@ -364,8 +364,8 @@ public function uninstall($ID)
 
                  return true;
             }
-            return false;
         }
+        return false;
     }
 
 

diff --git a/src/Certificate_Item.php b/src/Certificate_Item.php
@@ -541,5 +541,7 @@ public static function showForItem(CommonDBTM $item, $withtemplate = 0)
             Html::closeForm();
         }
         echo "</div>";
+
+        return true;
     }
 }
diff --git a/src/CommonDBTM.php b/src/CommonDBTM.php
@@ -658,7 +658,7 @@ public function getLogTypeID()
      * @param string[] $updates   fields to update
      * @param string[] $oldvalues array of old values of the updated fields
      *
-     * @return void
+     * @return bool
      **/
     public function updateInDB($updates, $oldvalues = [])
     {
@@ -1185,7 +1185,7 @@ protected function restoreInput(array $default = [])
      *
      * @param array $saved Array of values saved in session
      *
-     * @return array Array of values
+     * @return void
      **/
     protected function restoreSavedValues(array $saved = [])
     {
@@ -1229,7 +1229,10 @@ public function add(array $input, $options = [], $history = true)
         }
 
         // This means we are not adding a cloned object
-        if (!Toolbox::hasTrait($this, \Glpi\Features\Clonable::class) || !isset($input['clone'])) {
+        if (
+            (!Toolbox::hasTrait($this, \Glpi\Features\Clonable::class) || !isset($input['clone']))
+            && method_exists($this, 'clone')
+        ) {
             // This means we are asked to clone the object (old way). This will clone the clone method
             // that will set the clone parameter to true
             if (isset($input['_oldID'])) {
@@ -3050,7 +3053,7 @@ public function checkGlobal($right)
      *
      * @param mixed $right Right to check : c / r / w / d / READ / UPDATE / CREATE / DELETE
      *
-     * @return void
+     * @return bool
      **/
     public function canGlobal($right)
     {
@@ -4337,7 +4340,7 @@ public function getUnicityErrorMessage($msgs, $unicity, $doubles)
         $message_text .= '<br>' . __('Other item exist');
 
         foreach ($doubles as $double) {
-            if (in_array('CommonDBChild', class_parents($this))) {
+            if ($this instanceof CommonDBChild) {
                 if ($this->getField($this->itemtype)) {
                     $item = new $double['itemtype']();
                 } else {
@@ -4613,8 +4616,9 @@ public static function getSpecificValueToDisplay($field, $values, array $options
 
         switch ($field) {
             case '_virtual_datacenter_position':
-                if (method_exists(static::class, 'getDcBreadcrumbSpecificValueToDisplay')) {
-                    return static::getDcBreadcrumbSpecificValueToDisplay($values['id']);
+                $static = new static();
+                if (method_exists($static, 'getDcBreadcrumbSpecificValueToDisplay')) {
+                    return $static::getDcBreadcrumbSpecificValueToDisplay($values['id']);
                 }
         }
 

diff --git a/src/CommonDBVisible.php b/src/CommonDBVisible.php
@@ -38,6 +38,76 @@
  */
 abstract class CommonDBVisible extends CommonDBTM
 {
+    /**
+     * Entities on which item is visible.
+     * Keys are ID, values are DB fields values.
+     * @var array
+     */
+    protected $entities = [];
+
+    /**
+     * Groups for whom item is visible.
+     * Keys are ID, values are DB fields values.
+     * @var array
+     */
+    protected $groups = [];
+
+    /**
+     * Profiles for whom item is visible.
+     * Keys are ID, values are DB fields values.
+     * @var array
+     */
+    protected $profiles = [];
+
+    /**
+     * Users for whom item is visible.
+     * Keys are ID, values are DB fields values.
+     * @var array
+     */
+    protected $users = [];
+
+    public function __get(string $property)
+    {
+        // TODO Deprecate access to variables in GLPI 10.1.
+        $value = null;
+        switch ($property) {
+            case 'entities':
+            case 'groups':
+            case 'profiles':
+            case 'users':
+                $value = $this->$property;
+                break;
+            default:
+                $trace = debug_backtrace();
+                trigger_error(
+                    sprintf('Undefined property: %s::%s in %s on line %d', __CLASS__, $property, $trace[0]['file'], $trace[0]['line']),
+                    E_USER_WARNING
+                );
+                break;
+        }
+        return $value;
+    }
+
+    public function __set(string $property, $value)
+    {
+        // TODO Deprecate access to variables in GLPI 10.1.
+        switch ($property) {
+            case 'entities':
+            case 'groups':
+            case 'profiles':
+            case 'users':
+                $this->$property = $value;
+                break;
+            default:
+                $trace = debug_backtrace();
+                trigger_error(
+                    sprintf('Undefined property: %s::%s in %s on line %d', __CLASS__, $property, $trace[0]['file'], $trace[0]['line']),
+                    E_USER_WARNING
+                );
+                break;
+        }
+    }
+
     /**
      * Is the login user have access to item based on visibility configuration
      *

diff --git a/src/CommonDevice.php b/src/CommonDevice.php
@@ -359,7 +359,7 @@ public static function getNameField()
      *                            (default NULL)
      * @param $options   array    parameter such as restriction
      *
-     * @return HTMLTableHeader
+     * @return HTMLTableHeader|void
      **/
     public static function getHTMLTableHeader(
         $itemtype,
-Original file line number
+Diff line change
@@ Expand Up / @@ -364,8 +364,8 @@ public function uninstall($ID) @@
                      return true;
                 }
-                return false;
             }
+            return false;
         }
@@ Expand Down @@