From c2bd58662e588a111d319bd9112b87610a6a4197 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=B4me=20Chilliet?= <come.chilliet@fusiondirectory.org>
Date: Thu, 19 Mar 2020 11:28:21 +0100
Subject: [PATCH] :sparkles: feat(supann) First WIP of supannCMS support

There is a bug with the tagged attribute, it fails to remove tagged values.
Also the Source field cannot be set yet.

issue #6015
---
 supann/contrib/etc/cmsformat                  |  3 +
 supann/contrib/etc/cmstype                    | 11 +++
 .../class_SupannCMSAffectationAttribute.inc   | 90 ++++++++++++++++++
 .../personal/supann/class_TaggedAttribute.inc | 80 ++++++++++++++++
 supann/personal/supann/class_supannCMS.inc    | 94 +++++++++++++++++++
 5 files changed, 278 insertions(+)
 create mode 100644 supann/contrib/etc/cmsformat
 create mode 100644 supann/contrib/etc/cmstype
 create mode 100644 supann/personal/supann/class_SupannCMSAffectationAttribute.inc
 create mode 100644 supann/personal/supann/class_TaggedAttribute.inc
 create mode 100644 supann/personal/supann/class_supannCMS.inc

diff --git a/supann/contrib/etc/cmsformat b/supann/contrib/etc/cmsformat
new file mode 100644
index 0000000000..f0f303cf66
--- /dev/null
+++ b/supann/contrib/etc/cmsformat
@@ -0,0 +1,3 @@
+# Formats
+# TECHONOLOGY:ENCODING;label
+MIFARE:XLSB;Mifare XLSB
diff --git a/supann/contrib/etc/cmstype b/supann/contrib/etc/cmstype
new file mode 100644
index 0000000000..58cbc40943
--- /dev/null
+++ b/supann/contrib/etc/cmstype
@@ -0,0 +1,11 @@
+# Nomenclature SupAnn
+etudiant;étudiant
+personnel;professionnelle
+visiteur;visiteur, anonyme
+invite;invité, nominative
+lecteur;lecteur de bibliothèque
+prestataire;prestataire de services
+vehicule;véhicule
+externe;externe
+# Ajouter ici les types locaux étiqueté si besoin
+# {ORIGINE}type_local;Type de carte défini localement par l'établissement ORIGINE
diff --git a/supann/personal/supann/class_SupannCMSAffectationAttribute.inc b/supann/personal/supann/class_SupannCMSAffectationAttribute.inc
new file mode 100644
index 0000000000..95a96343c6
--- /dev/null
+++ b/supann/personal/supann/class_SupannCMSAffectationAttribute.inc
@@ -0,0 +1,90 @@
+<?php
+/*
+  This code is part of FusionDirectory (http://www.fusiondirectory.org)
+
+  Copyright (C) 2010-2012 Antoine Gallavardin
+  Copyright (C) 2013-2020 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
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+*/
+
+class SupannCMSAffectationAttribute extends SupannCompositeAttribute
+{
+  function __construct ($label, $description, $ldapName, $acl = '')
+  {
+    list($types, $typeLabels)     = supann::get_choices_for('cmstype');
+    list($formats, $formatLabels) = supann::get_choices_for('cmsformat');
+    $attributes = [
+      new SelectAttribute(
+        _('Type'), _('supannCMSType - Card type'),
+        'supannCMSType_type', TRUE,
+        $types, '', $typeLabels
+      ),
+      new SelectAttribute(
+        _('Format'), _('Card format'),
+        'none_format', TRUE,
+        $formats, '', $formatLabels
+      ),
+      new StringAttribute(
+        _('Id'), _('Card id'),
+        'none_id', TRUE
+      ),
+      new BooleanAttribute(
+        _('Valid'), _('Card validity'),
+        'none_valid', TRUE,
+        TRUE
+      ),
+      new SelectAttribute(
+        _('Source'), _('Card managing system and establishment'),
+        'supannCMSSource_source', FALSE
+      ),
+      new GeneralizedTimeDateAttribute(
+        _('End date'), _('End of validity date, if any'),
+        'supannCMSDateFin_datefin', FALSE,
+        ''
+      ),
+    ];
+    parent::__construct($description, $ldapName, $attributes, $acl, $label);
+  }
+
+  function supannGetValues (&$values)
+  {
+    if ($this->attributes[3]->getValue() !== TRUE) {
+      /* Card is not valid */
+      return;
+    }
+    foreach ($this->attributes as &$attribute) {
+      $shortname = preg_replace('/^([^_]+)_.*$/', '\\1', $attribute->getLdapName());
+      if ($shortname == 'none') {
+        continue;
+      }
+      $value = $attribute->getValue();
+      if (!isset($values[$shortname])) {
+        $values[$shortname] = [];
+      }
+      if ($value == '') {
+        continue;
+      }
+      $values[$shortname][$value] = $value;
+    }
+    unset($attribute);
+    $format = $this->attributes[1]->getValue();
+    $id     = $this->attributes[2]->getValue();
+    $supannCMSIdEtiquette = '{'.$format.'}'.$id;
+    $supannCMSId          = 'x-'.strtolower(str_replace(':', '-', $format)).';'.$id;
+    $values['supannCMSIdEtiquette'][$supannCMSIdEtiquette] = $supannCMSIdEtiquette;
+    $values['supannCMSId'][$supannCMSId] = $supannCMSId;
+  }
+}
diff --git a/supann/personal/supann/class_TaggedAttribute.inc b/supann/personal/supann/class_TaggedAttribute.inc
new file mode 100644
index 0000000000..45e31b12ec
--- /dev/null
+++ b/supann/personal/supann/class_TaggedAttribute.inc
@@ -0,0 +1,80 @@
+<?php
+/*
+  This code is part of FusionDirectory (http://www.fusiondirectory.org)
+
+  Copyright (C) 2019-2020 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
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+*/
+
+class TaggedAttribute extends SetAttribute
+{
+  function __construct (Attribute $attribute, array $values = [], bool $valueUnicity = TRUE)
+  {
+    parent::__construct($attribute, $values, $valueUnicity);
+  }
+
+  protected function loadAttrValue (array $attrs)
+  {
+    $this->value  = [];
+    $pattern      = '/^'.preg_quote($this->getLdapName(), '/').';(.+)$/';
+    for ($i = 0; $i < $attrs['count']; $i++) {
+      if ($attrs[$i] == $this->getLdapName()) {
+        for ($j = 0; $j < $attrs[$attrs[$i]]['count']; $j++) {
+          $this->value[] = ';'.$attrs[$attrs[$i]][$j];
+        }
+      } elseif (preg_match($pattern, $attrs[$i], $m)) {
+        for ($j = 0; $j < $attrs[$attrs[$i]]['count']; $j++) {
+          $this->value[] = $m[1].';'.$attrs[$attrs[$i]][$j];
+        }
+      }
+    }
+    $this->sortValues();
+  }
+
+  function computeLdapValue ()
+  {
+    throw new FusionDirectoryException('nope');
+  }
+
+  /*! \brief Fill LDAP value in the attrs array
+   */
+  function fillLdapValue (array &$attrs)
+  {
+    if ($this->isInLdap()) {
+      $initialValues  = $this->getInitialValue();
+      foreach ($initialValues as $value) {
+        list($tag, $tagvalue) = explode(';', $value, 2);
+        if (empty($tag)) {
+          $attrs[$this->getLdapName()] = [];
+        } else {
+          $attrs[$this->getLdapName().';'.$tag] = [];
+        }
+      }
+      if (empty($this->value)) {
+        $attrs[$this->getLdapName()] = [];
+      } else {
+        foreach ($this->value as $value) {
+          list($tag, $tagvalue) = explode(';', $value, 2);
+          if (empty($tag)) {
+            $attrs[$this->getLdapName()][] = $tagvalue;
+          } else {
+            $attrs[$this->getLdapName().';'.$tag][] = $tagvalue;
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/supann/personal/supann/class_supannCMS.inc b/supann/personal/supann/class_supannCMS.inc
new file mode 100644
index 0000000000..ce2cfc158b
--- /dev/null
+++ b/supann/personal/supann/class_supannCMS.inc
@@ -0,0 +1,94 @@
+<?php
+/*
+  This code is part of FusionDirectory (http://www.fusiondirectory.org)
+
+  Copyright (C) 2018-2020 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
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+*/
+
+class supannCMS extends simplePlugin
+{
+  protected $displayHeader = TRUE;
+
+  static function plInfo (): array
+  {
+    return [
+      'plShortName'   => _('Multiservice card'),
+      'plDescription' => _('SupAnn CMS management'),
+      'plIcon'        => 'geticon.php?context=applications&icon=supann&size=48',
+      'plSmallIcon'   => 'geticon.php?context=applications&icon=supann&size=16',
+      'plSelfModify'  => TRUE,
+      'plPriority'    => 16,
+      'plObjectClass' => ['supannCMS'],
+      'plObjectType'  => ['user'],
+
+      'plProvidedAcls'  => parent::generatePlProvidedAcls(static::getAttributesInfo())
+    ];
+  }
+
+  static function getAttributesInfo (): array
+  {
+    return [
+      'status' => [
+        'name'  => _('Cards'),
+        'class' => ['fullwidth'],
+        'attrs' => [
+          new HiddenArrayAttribute('supannCMSType', FALSE, []),
+          new TaggedAttribute(new StringAttribute('', '', 'supannCMSId', FALSE)),
+          new HiddenArrayAttribute('supannCMSIdEtiquette', FALSE, []),
+          new HiddenArrayAttribute('supannCMSSource', FALSE, []),
+          new HiddenArrayAttribute('supannCMSDateFin', FALSE, []),
+          new SupannOrderedArrayAttribute(
+            new SupannCMSAffectationAttribute(
+              _('Cards'), _('SupAnn CMS Affectation'),
+              'supannCMSAffectation'
+            ),
+            // no order
+            FALSE,
+            [],
+            // edit button
+            TRUE
+          ),
+        ]
+      ],
+    ];
+  }
+
+  function __construct ($dn = NULL, $object = NULL, $parent = NULL, $mainTab = FALSE)
+  {
+    global $config;
+
+    parent::__construct($dn, $object, $parent, $mainTab);
+
+    $this->attributesAccess['supannCMSId']->setVisible(FALSE);
+    $this->attributesAccess['supannCMSAffectation']->setLinearRendering(FALSE);
+    $this->attributesAccess['supannCMSAffectation']->setHeaders([
+      _('Type'),
+      _('Format'),
+      _('Id'),
+      _('Valid'),
+      _('Source'),
+      _('End date'),
+      ''
+    ]);
+  }
+
+  protected function prepare_save (): array
+  {
+    $this->attributesAccess['supannCMSAffectation']->supannPrepareSave();
+    return parent::prepare_save();
+  }
+}
-- 
GitLab