feat(sinaps) Only send Sinaps acquisiton if data changed or forced

issue #5913

sinaps/personal/sinaps/class_sinapsUser.inc

 <?php
 /*
   This code is part of FusionDirectory (http://www.fusiondirectory.org/)
-  Copyright (C) 2017-2018  FusionDirectory
+
+  Copyright (C) 2017-2019  FusionDirectory
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -26,14 +27,13 @@ class sinapsUser extends simplePlugin
       'plShortName'     => _('Sinaps'),
       'plTitle'         => _('Sinaps'),
       'plDescription'   => _('Used to send acquisition request for users'),
-      'plFilter'        => '(objectClass=*)',
       'plSelfModify'    => FALSE,
       'plObjectClass'   => array(),
       'plObjectType'    => array('user'),
       //~ 'plIcon'          => '',
       //~ 'plSmallIcon'     => '',
 
-      'plProvidedAcls'  => array()
+      'plProvidedAcls'  => parent::generatePlProvidedAcls(static::getAttributesInfo())
     );
   }
 
@@ -49,12 +49,23 @@ class sinapsUser extends simplePlugin
             'sinaps_explanation', FALSE,
             _('This tab takes care of sending Acquisition event to Sinaps whenever a user is modified.')
           ),
+          new BooleanAttribute(
+            _('Force Sinaps Acquisition'), _('Send Acquisition data even if data was not modified in FusionDirectory'),
+            'force_acquisition', FALSE
+          ),
         )
       )
     );
   }
 
-  function codeEntiteToldapUuidCallback($codeEntite)
+  function __construct ($dn = NULL, $object = NULL, $parent = NULL, $mainTab = FALSE, $attributesInfo = NULL)
+  {
+    parent::__construct($dn, $object, $parent, $mainTab, $attributesInfo);
+
+    $this->attributesAccess['force_acquisition']->setInLdap(FALSE);
+  }
+
+  function codeEntiteToldapUuidCallback ($codeEntite)
   {
     global $config;
 
@@ -98,6 +109,7 @@ class sinapsUser extends simplePlugin
     if ($config->get_cfg_value('SinapsEnabled', 'FALSE') == 'FALSE') {
       return array();
     }
+
     if ($config->get_cfg_value('SinapsAcquisitionURL', '') == '') {
       return array('Sinaps acquisition URL is not filled in FusionDirectory configuration');
     }
@@ -126,6 +138,25 @@ class sinapsUser extends simplePlugin
       $attributes[$ldapField] = 1;
     }
 
+    if (!$this->force_acquisition) {
+      /* Skip sync if no field changed */
+      $sync = FALSE;
+      foreach (array_keys($attributes) as $ldapField) {
+        foreach ($this->parent->by_object as $class => $tab) {
+          if (isset($tab->attributesAccess[$ldapField])) {
+            if ($tab->attributesAccess[$ldapField]->hasChanged()) {
+              $sync = TRUE;
+              break 2;
+            }
+            break;
+          }
+        }
+      }
+      if (!$sync) {
+        return array();
+      }
+    }
+
     $attributes['dn'] = 'raw';
 
     $users  = objects::ls('user', $attributes, $this->dn, '', FALSE, 'base');

[Ghost User]

Remove this unused "$class" local variable.

[Ghost User]

SonarQube analysis reported 3 issues

• 3 major

Watch the comments in this conversation to review them.

2 extra issues

Note: The following issues were found on lines that were not modified in the commit. Because these issues can't be reported as line comments, they are summarized here:

1. This function "getUserValues" has 198 lines, which is greater than the 150 lines authorized. Split it into smaller functions.
2. Review the data-flow - use of uninitialized value.