<?php
/**
 * ---------------------------------------------------------------------
 * GLPI - Gestionnaire Libre de Parc Informatique
 * Copyright (C) 2015-2021 Teclib' and contributors.
 *
 * http://glpi-project.org
 *
 * based on GLPI - Gestionnaire Libre de Parc Informatique
 * Copyright (C) 2003-2014 by the INDEPNET Development Team.
 *
 * ---------------------------------------------------------------------
 *
 * LICENSE
 *
 * This file is part of GLPI.
 *
 * GLPI 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.
 *
 * GLPI 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 GLPI. If not, see <http://www.gnu.org/licenses/>.
 * ---------------------------------------------------------------------
 */

/**
 * @since 0.84
 */

if (!defined('GLPI_ROOT')) {
   die("Sorry. You can't access this file directly");
}

/**
 * Relation between item and devices
 * We completely relies on CommonDBConnexity to manage the can* and the history and the deletion ...
**/
class Item_Devices extends CommonDBRelation {

   static public $itemtype_1            = 'itemtype';
   static public $items_id_1            = 'items_id';
   static public $mustBeAttached_1      = false;
   static public $take_entity_1         = false;
   // static public $checkItem_1_Rights    = self::DONT_CHECK_ITEM_RIGHTS;

   static protected $notable            = true;

   static public $logs_for_item_2       = false;
   static public $take_entity_2         = true;

   static public $log_history_1_add     = Log::HISTORY_ADD_DEVICE;
   static public $log_history_1_update  = Log::HISTORY_UPDATE_DEVICE;
   static public $log_history_1_delete  = Log::HISTORY_DELETE_DEVICE;
   static public $log_history_1_lock    = Log::HISTORY_LOCK_DEVICE;
   static public $log_history_1_unlock  = Log::HISTORY_UNLOCK_DEVICE;

   // This var is defined by CommonDBRelation ...
   public $no_form_page                 = false;

   public $dohistory = true;

   static protected $forward_entity_to  = ['Infocom'];

   static $undisclosedFields      = [];

   static public $mustBeAttached_2 = false; // Mandatory to display creation form

   protected function computeFriendlyName() {
      $itemtype = static::$itemtype_2;
      if (!empty($this->fields[static::$itemtype_1])) {
         $item = new $this->fields[static::$itemtype_1];
         $item->getFromDB($this->fields[static::$items_id_1]);
         $name = sprintf(__('%1$s of item "%2$s"'), $itemtype::getTypeName(1), $item->getName());
      } else {
         $name = $itemtype::getTypeName(1);
      }
      return $name;
   }

   static function getTypeName($nb = 0) {
      $device_type = static::getDeviceType();
      return $device_type::getTypeName($nb);
   }


   /**
    * Get type name for device (used in Log)
    *
    * @param integer $nb Count
    *
    * @return string
    */
   static function getDeviceTypeName($nb = 0) {
      $device_type = static::getDeviceType();
      //TRANS: %s is the type of the component
      return sprintf(__('Item - %s link'), $device_type::getTypeName($nb));
   }


   function getForbiddenStandardMassiveAction() {

      $forbidden = parent::getForbiddenStandardMassiveAction();

      if ((count(static::getSpecificities()) == 0)
          && !Infocom::canApplyOn($this)) {
         $forbidden[] = 'update';
      }

      return $forbidden;
   }

   function rawSearchOptions() {
      $tab = [];

      $tab[] = [
         'id'                 => 'common',
         'name'               => __('Characteristics')
      ];

      $tab[] = [
         'id'                 => '1',
         'table'              => $this->getTable(),
         'field'              => 'id',
         'name'               => __('ID'),
         'datatype'           => 'itemlink',
         'massiveaction'      => false,
      ];

      $deviceType = $this->getDeviceType();
      $tab[] = [
         'id'                 => '4',
         'table'              => getTableForItemType($deviceType),
         'field'              => 'designation',
         'name'               => $deviceType::getTypeName(1),
         'datatype'           => 'itemlink',
         'forcegroupby'       => true,
         'massiveaction'      => false,
         'joinparams'         => [
            'beforejoin'         => [
               'table'              => $this->getTable(),
               'joinparams'         => [
                  'jointype'           => 'child'
               ]
            ]
         ]
      ];

      $tab[] = [
         'id'                 => '5',
         'table'              => $this->getTable(),
         'field'              => 'items_id',
         'name'               => _n('Associated element', 'Associated elements', Session::getPluralNumber()),
         'datatype'           => 'specific',
         'comments'           => true,
         'nosort'             => true,
         'additionalfields'   => ['itemtype']
      ];

      $tab[] = [
         'id'                 => '6',
         'table'              => $this->getTable(),
         'field'              => 'itemtype',
         'name'               => _n('Associated item type', 'Associated item types', Session::getPluralNumber()),
         'datatype'           => 'itemtypename',
         'itemtype_list'      => 'itemdevices_types',
         'nosort'             => true
      ];

      foreach (static::getSpecificities() as $field => $attributs) {
         if (isForeignKeyField($field)) {
            $table = getTableNameForForeignKeyField($field);
            $linked_itemtype = getItemTypeForTable($table);
            $field = $linked_itemtype::getNameField();
         } else {
            $table = $this->getTable();
         }
         if (array_key_exists('field', $attributs)) {
            $field = $attributs['field'];
         }

         $newtab = [
            'id'                 => $attributs['id'],
            'table'              => $table,
            'field'              => $field,
            'name'               => $attributs['long name'],
            'massiveaction'      => true
         ];

         if (isset($attributs['datatype'])) {
            $newtab['datatype'] = $attributs['datatype'];
         }
         if (isset($attributs['nosearch'])) {
            $newtab['nosearch'] = $attributs['nosearch'];
         }
         if (isset($attributs['nodisplay'])) {
            $newtab['nodisplay'] = $attributs['nodisplay'];
         }
         if (isset($attributs['autocomplete'])) {
            $newtab['autocomplete'] = $attributs['autocomplete'];
         }
         $tab[] = $newtab;
      }

      $tab[] = [
         'id'                 => '80',
         'table'              => 'glpi_entities',
         'field'              => 'completename',
         'name'               => Entity::getTypeName(1),
         'datatype'           => 'dropdown'
      ];

      return $tab;
   }

   public static function rawSearchOptionsToAdd($itemtype) {
      global $CFG_GLPI;

      $options = [];
      $device_types = $CFG_GLPI['device_types'];

      $main_joinparams = [
         'jointype'           => 'itemtype_item',
         'specific_itemtype'  => $itemtype
      ];

      foreach ($device_types as $device_type) {
         if (isset($CFG_GLPI['item' . strtolower($device_type) . '_types'])) {
            $itemtypes = $CFG_GLPI['item' . strtolower($device_type) . '_types'];
            if ($itemtypes == '*' || in_array($itemtype, $itemtypes)) {
               if (method_exists($device_type, 'rawSearchOptionsToAdd')) {
                  $options = array_merge(
                     $options,
                     $device_type::rawSearchOptionsToAdd(
                        $itemtype,
                        $main_joinparams
                     )
                  );
               }
            }
         }
      }

      if (count($options)) {
         //add title if there are options
         $options = array_merge(
            [[
               'id'                => 'devices',
               'name'              => _n('Component', 'Components', Session::getPluralNumber())
            ]],
            $options
         );
      }

      return $options;
   }

   static function getSpecificValueToDisplay($field, $values, array $options = []) {

      if (!is_array($values)) {
         $values = [$field => $values];
      }
      switch ($field) {
         case 'items_id':
            if (isset($values['itemtype'])) {
               if (isset($options['comments']) && $options['comments']) {
                  $valueData = Dropdown::getDropdownName(
                     getTableForItemType($values['itemtype']),
                     $values[$field],
                     1
                  );
                  return sprintf(
                     __('%1$s %2$s'),
                     $valueData['name'],
                     Html::showToolTip($valueData['comment'], ['display' => false])
                  );

               }
               return Dropdown::getDropdownName(
                  getTableForItemType($values['itemtype']),
                  $values[$field]
               );
            }
            break;
      }
      return parent::getSpecificValueToDisplay($field, $values, $options);
   }

   static function getSpecificValueToSelect($field, $name = '', $values = '', array $options = []) {

      if (!is_array($values)) {
         $values = [$field => $values];
      }
      $options['display'] = false;
      switch ($field) {
         case 'items_id' :
            if (isset($values['itemtype']) && !empty($values['itemtype'])) {
               $options['name']  = $name;
               $options['value'] = $values[$field];
               return Dropdown::show($values['itemtype'], $options);
            }
            break;
      }
      return parent::getSpecificValueToSelect($field, $name, $values, $options);
   }


   /**
    * Get the specificities of the given device. For instance, the
    * serial number, the size of the memory, the frequency of the CPUs ...
    *
    * @param $specif   string   specificity to display
    *
    * Should be overloaded by Item_Device*
    *
    * @return array of the specificities: index is the field name and the values are the attributs
    *                                     of the specificity (long name, short name, size)
   **/
   static function getSpecificities($specif = '') {

      switch ($specif) {
         case 'serial' :
            return ['long name'  => __('Serial number'),
                         'short name' => __('Serial number'),
                         'size'       => 20,
                         'id'         => 10,
                         'autocomplete' => true,];

         case 'busID' :
            return ['long name'  => __('Position of the device on its bus'),
                         'short name' => __('bus ID'),
                         'size'       => 10,
                         'id'         => 11,
                         'autocomplete' => true,];

         case 'otherserial':
            return ['long name'  => __('Inventory number'),
                         'short name' => __('Inventory number'),
                         'size'       => 20,
                         'id'         => 12,
                         'autocomplete' => true,];

         case 'locations_id':
            return ['long name'  => Location::getTypeName(1),
                         'short name' => Location::getTypeName(1),
                         'size'       => 20,
                         'id'         => 13,
                         'datatype'   => 'dropdown'];

         case 'states_id':
            return ['long name'  => __('Status'),
                         'short name' => __('Status'),
                         'size'       => 20,
                         'id'         => 14,
                         'datatype'   => 'dropdown'];
      }
      return [];
   }


   /**
    * Get the items on which this Item_Device can be attached. For instance, a computer can have
    * any kind of device. Conversely, a soundcard does not concern a NetworkEquipment
    * A configuration entry is automatically checked in $CFG_GLPI (must be the name of
    * the class, lowercase, without "_" with extra "_types" at the end; for example
    * "itemdevicesoundcard_types").
    *
    * Alternatively, it could be overloaded from subclasses
    *
    * @since 0.85
    *
    * @return array of the itemtype that can have this Item_Device
   **/
   static function itemAffinity() {
      global $CFG_GLPI;

      $conf_param = str_replace('_', '', strtolower(static::class)) . '_types';
      if (isset($CFG_GLPI[$conf_param])) {
         return $CFG_GLPI[$conf_param];
      }

      return $CFG_GLPI["itemdevices_itemaffinity"];
   }


   /**
    * Get all the kind of devices available inside the system.
    * This method is equivalent to getItemAffinities('')
    *
    * @return array of the types of Item_Device* available
   **/
   static function getDeviceTypes() {
      global $CFG_GLPI;

      // If the size of $CFG_GLPI['item_device_types'] and $CFG_GLPI['device_types'] then,
      // there is new device_types and we must update item_device_types !
      if (!isset($CFG_GLPI['item_device_types'])
          || (count($CFG_GLPI['item_device_types']) != count($CFG_GLPI['device_types']))) {

         $CFG_GLPI['item_device_types'] = [];

         foreach (CommonDevice::getDeviceTypes() as $deviceType) {
            $CFG_GLPI['item_device_types'][] = $deviceType::getItem_DeviceType();
         }
      }

      return $CFG_GLPI['item_device_types'];
   }


   /**
    * Get the Item_Device* a given item type can have
    *
    * @param string $itemtype the type of the item that we want to know its devices
    *
    * @since 0.85
    *
    * @return array of Item_Device*
   **/
   static function getItemAffinities($itemtype) {
      global $GLPI_CACHE;

      if (!$GLPI_CACHE->has('item_device_affinities')) {
         $GLPI_CACHE->set('item_device_affinities', ['' => static::getDeviceTypes()]);
      }
      $items_affinities = $GLPI_CACHE->get('item_device_affinities');

      if (!isset($items_affinities[$itemtype])) {
         $afffinities = [];
         foreach ($items_affinities[''] as $item_id => $item_device) {
            if (in_array($itemtype, $item_device::itemAffinity()) || in_array('*', $item_device::itemAffinity())) {
               $afffinities[$item_id] = $item_device;
            }
         }
         $items_affinities[$itemtype] = $afffinities;
         $GLPI_CACHE->set('item_device_affinities', $items_affinities);
      }

      return $items_affinities[$itemtype];
   }


   /**
    * Get all kind of items that can be used by Item_Device*
    *
    * @since 0.85
    *
    * @return array of the available items
   **/
   static function getConcernedItems() {
      global $CFG_GLPI;

      $itemtypes = $CFG_GLPI['itemdevices_types'];

      $conf_param = str_replace('_', '', strtolower(static::class)) . '_types';
      if (isset($CFG_GLPI[$conf_param]) && !in_array('*', $CFG_GLPI[$conf_param])) {
         $itemtypes = array_intersect($itemtypes, $CFG_GLPI[$conf_param]);
      }

      return $itemtypes;
   }


   /**
    * Get associated device to the current item_device
    *
    * @since 0.85
    *
    * @return string containing the device
   **/
   static function getDeviceType() {

      $devicetype = get_called_class();
      if ($plug = isPluginItemType($devicetype)) {
         return 'Plugin'.$plug['plugin'].str_replace ('Item_', '', $plug['class']);
      }
      return str_replace ('Item_', '', $devicetype);
   }

    /**
    * get items associated to the given one (defined by $itemtype and $items_id)
    *
    * @param string  $itemtype          the type of the item we want the resulting items to be associated to
    * @param string  $items_id          the name of the item we want the resulting items to be associated to
    *
    * @return array the items associated to the given one (empty if none was found)
   **/
   static function getItemsAssociatedTo($itemtype, $items_id) {
      global $DB;

      $res = [];
      foreach (self::getItemAffinities($itemtype) as $link_type) {
         $table = $link_type::getTable();
         $iterator = $DB->request([
            'SELECT' => 'id',
            'FROM'   => $table,
            'WHERE'  => [
               'itemtype'  => $itemtype,
               'items_id'  => $items_id
            ]
         ]);

         while ($row = $iterator->next()) {
            $input = Toolbox::addslashes_deep($row);
            $item = new $link_type();
            $item->getFromDB($input['id']);
            $res[] = $item;
         }
      }
      return $res;
   }

   /**
    *
    * @deprecated 9.5
    *
   **/
   static function cloneItem($itemtype, $oldid, $newid) {
      global $DB;

      Toolbox::deprecated('Use clone');
      foreach (self::getItemAffinities($itemtype) as $link_type) {
         $table = $link_type::getTable();
         $olds = $DB->request([
            'FROM'   => $table,
            'WHERE'  => [
               'itemtype'  => $itemtype,
               'items_id'  => $oldid
            ]
         ]);

         while ($data = $olds->next()) {
            $link = new $link_type();
            unset($data['id']);
            $data['items_id']     = $newid;
            $data['_itemtype']    = $itemtype;
            $data['_no_history']  = true;
            $data                 = Toolbox::addslashes_deep($data);

            $link->add($data);
         }
      }
   }


   function getTabNameForItem(CommonGLPI $item, $withtemplate = 0) {

      if ($item->canView()) {
         $nb = 0;
         if (in_array($item->getType(), self::getConcernedItems())) {
            if ($_SESSION['glpishow_count_on_tabs']) {
               foreach (self::getItemAffinities($item->getType()) as $link_type) {
                  $nb   += countElementsInTable($link_type::getTable(),
                                                ['items_id'   => $item->getID(),
                                                 'itemtype'   => $item->getType(),
                                                 'is_deleted' => 0 ]);
               }
            }
            return self::createTabEntry(_n('Component', 'Components', Session::getPluralNumber()),
                                        $nb);
         }
         if ($item instanceof CommonDevice) {
            if ($_SESSION['glpishow_count_on_tabs']) {
               $deviceClass     = $item->getType();
               $linkClass       = $deviceClass::getItem_DeviceType();
               $table           = $linkClass::getTable();
               $foreignkeyField = $deviceClass::getForeignKeyField();
               $nb = countElementsInTable($table,
                                          [$foreignkeyField => $item->getID(),
                                           'is_deleted' => 0 ]);
            }
            return self::createTabEntry(_n('Item', 'Items', Session::getPluralNumber()), $nb);
         }
      }
      return '';
   }


   static function displayTabContentForItem(CommonGLPI $item, $tabnum = 1, $withtemplate = 0) {

      self::showForItem($item, $withtemplate);
      return true;
   }


   static function showForItem(CommonGLPI $item, $withtemplate = 0) {
      global $CFG_GLPI;

      $is_device = ($item instanceof CommonDevice);

      $ID = $item->getField('id');

      if (!$item->can($ID, READ)) {
         return false;
      }

      $canedit = (($withtemplate != 2)
                  && $item->canEdit($ID)
                  && Session::haveRightsOr('device', [UPDATE, PURGE]));
      echo "<div class='spaced'>";
      $rand = mt_rand();
      if ($canedit) {
         echo "\n<form id='form_device_add$rand' name='form_device_add$rand'
                  action='".Toolbox::getItemTypeFormURL(__CLASS__)."' method='post'>\n";
         echo "\t<input type='hidden' name='items_id' value='$ID'>\n";
         echo "\t<input type='hidden' name='itemtype' value='".$item->getType()."'>\n";
      }

      $table = new HTMLTableMain();

      $table->setTitle(_n('Component', 'Components', Session::getPluralNumber()));
      if ($canedit) {
         $delete_all_column = $table->addHeader('delete all',
                                                Html::getCheckAllAsCheckbox("form_device_action$rand",
                                                '__RAND__'));
         $delete_all_column->setHTMLClass('center');
      } else {
         $delete_all_column = null;
      }

      $column_label    = ($is_device ? _n('Item', 'Items', Session::getPluralNumber()) : __('Type of component'));
      $common_column   = $table->addHeader('common', $column_label);
      $specific_column = $table->addHeader('specificities', __('Specificities'));
      $specific_column->setHTMLClass('center');

      $dynamic_column = '';
      if ($item->isDynamic()) {
         $dynamic_column = $table->addHeader('is_dynamic', __('Automatic inventory'));
         $dynamic_column->setHTMLClass('center');
      }

      if ($canedit) {
         $massiveactionparams = ['container'     => "form_device_action$rand",
                                      'fixed'         => false,
                                      'display_arrow' => false];
         $content = [['function'   => 'Html::showMassiveActions',
                                'parameters' => [$massiveactionparams]]];
         $delete_column = $table->addHeader('delete one', $content);
         $delete_column->setHTMLClass('center');
      } else {
         $delete_column = null;
      }

      $table_options = ['canedit' => $canedit,
                             'rand'    => $rand];

      if ($is_device) {
         Session::initNavigateListItems(static::getType(),
                                        sprintf(__('%1$s = %2$s'),
                                                $item->getTypeName(1), $item->getName()));
         foreach (array_merge([''], self::getConcernedItems()) as $itemtype) {
            $table_options['itemtype'] = $itemtype;
            $link                      = getItemForItemtype(static::getType());

            $link->getTableGroup($item, $table, $table_options, $delete_all_column,
                                 $common_column, $specific_column, $delete_column,
                                 $dynamic_column);
         }
      } else {
         $devtypes = [];
         foreach (self::getItemAffinities($item->getType()) as $link_type) {
            $devtypes [] = $link_type::getDeviceType();
            $link        = getItemForItemtype($link_type);

            Session::initNavigateListItems($link_type,
                                           sprintf(__('%1$s = %2$s'),
                                                   $item->getTypeName(1), $item->getName()));
            $link->getTableGroup($item, $table, $table_options, $delete_all_column,
                                 $common_column, $specific_column, $delete_column,
                                 $dynamic_column);
         }
      }

      if ($canedit) {
         echo "<table class='tab_cadre_fixe'><tr class='tab_bg_1'><td>";
         echo __('Add a new component')."</td><td class=left width='70%'>";
         if ($is_device) {
            Dropdown::showNumber('number_devices_to_add', ['value' => 0,
                                                                'min'   => 0,
                                                                'max'   => 10]);
         } else {
            Dropdown::showSelectItemFromItemtypes(['itemtype_name'       => 'devicetype',
                                                        'items_id_name'       => 'devices_id',
                                                        'itemtypes'           => $devtypes,
                                                        'entity_restrict'     => $item->getEntityID(),
                                                        'showItemSpecificity' => $CFG_GLPI['root_doc']
                                                                 .'/ajax/selectUnaffectedOrNewItem_Device.php']);
         }
         echo "</td><td>";
         echo "<input type='submit' class='submit' name='add' value='"._sx('button', 'Add')."'>";
         echo "</td></tr></table>";
         Html::closeForm();
      }

      if ($canedit) {
         echo "\n<form id='form_device_action$rand' name='form_device_action$rand'
                  action='".Toolbox::getItemTypeFormURL(__CLASS__)."' method='post'>\n";
         echo "\t<input type='hidden' name='items_id' value='$ID'>\n";
         echo "\t<input type='hidden' name='itemtype' value='".$item->getType()."'>\n";
      }

      $table->display(['display_super_for_each_group' => false,
                            'display_title_for_each_group' => false]);

      if ($canedit) {
          echo "<input type='submit' class='submit' name='updateall' value='" .
               _sx('button', 'Save')."'>";

         Html::closeForm();
      }

      echo "</div>";
      // Force disable selected items
      $_SESSION['glpimassiveactionselected'] = [];
   }


   static function getDeviceForeignKey() {
      return getForeignKeyFieldForTable(getTableForItemType(static::getDeviceType()));
   }

   public function getTableGroupCriteria($item, $peer_type = null) {
      $is_device = ($item instanceof CommonDevice);
      $ctable = $this->getTable();
      $criteria = [
         'SELECT' => "$ctable.*",
         'FROM'   => $ctable
      ];
      if ($is_device) {
         $fk = 'items_id';

         // Entity restrict
         $criteria['WHERE'] = [
            $this->getDeviceForeignKey()  => $item->getID(),
            "$ctable.itemtype"            => $peer_type,
            "$ctable.is_deleted"          => 0
         ];
         $criteria['ORDERBY'] = [
            "$ctable.itemtype",
            "$ctable.$fk"
         ];
         if (!empty($peer_type)) {
            $criteria['LEFT JOIN'] = [
               getTableForItemType($peer_type) => [
                  'ON' => [
                     $ctable                          => 'items_id',
                     getTableForItemType($peer_type)  => 'id', [
                        'AND' => [
                           "$ctable.itemtype"   => $peer_type
                        ]
                     ]
                  ]
               ]
            ];
            $criteria['WHERE'] = $criteria['WHERE'] + getEntitiesRestrictCriteria(getTableForItemType($peer_type));
         }
      } else {
         $fk = $this->getDeviceForeignKey();

         $criteria['WHERE'] = [
            'itemtype'     => $item->getType(),
            'items_id'     => $item->getID(),
            'is_deleted'   => 0
         ];
         $criteria['ORDERBY'] = $fk;
      }

      return $criteria;
   }

   /**
    * Get the group of elements regarding given item.
    * Two kind of item :
    *              - Device* feed by a link to the attached item (Computer, Printer ...)
    *              - Computer, Printer ...: feed by the "global" properties of the CommonDevice
    * Then feed with the specificities of the Item_Device elements
    * In cas of $item is an instance, then $options contains the type of the item (Computer,
    * Printer ...).
    *
    * @param $item
    * @param $table
    * @param $options            array
    * @param $delete_all_column
    * @param $common_column
    * @param $specific_column
    * @param $delete_column
    * @param $dynamic_column
   **/
   function getTableGroup(CommonDBTM $item, HTMLTableMain $table, array $options,
                          HTMLTableSuperHeader $delete_all_column = null,
                          HTMLTableSuperHeader $common_column,
                          HTMLTableSuperHeader $specific_column,
                          HTMLTableSuperHeader $delete_column = null, $dynamic_column) {
      global $DB;

      $is_device = ($item instanceof CommonDevice);

      if ($is_device) {
         $peer_type = $options['itemtype'];

         if (empty($peer_type)) {
            $column_label = __('Dissociated devices');
            $group_name   = 'None';
         } else {
            $column_label = $peer_type::getTypeName(Session::getPluralNumber());
            $group_name   = $peer_type;
         }

         $table_group = $table->createGroup($group_name, '');

         $peer_column = $table_group->addHeader('item', $column_label, $common_column, null);

         if (!empty($peer_type)) {
            //TRANS : %1$s is the type of the device
            //        %2$s is the type of the item
            //        %3$s is the name of the item (used for headings of a list),
            $itemtype_nav_title = sprintf(__('%1$s of %2$s: %3$s'), $peer_type::getTypeName(Session::getPluralNumber()),
                                          $item->getTypeName(1), $item->getName());
            $peer_column->setItemType($peer_type, $itemtype_nav_title);
         }

      } else {
         $peer_type   = $this->getDeviceType();

         $table_group = $table->createGroup($peer_type, '');

         //TRANS : %1$s is the type of the device
         //        %2$s is the type of the item
         //        %3$s is the name of the item (used for headings of a list),
         $options['itemtype_title'] = sprintf(__('%1$s of %2$s: %3$s'), $peer_type::getTypeName(Session::getPluralNumber()),
                                              $item->getTypeName(1), $item->getName());

         $peer_type::getHTMLTableHeader($item->getType(), $table_group, $common_column, null,
                                          $options);
      }

      $specificity_columns = [];
      $link_column         = $table_group->addHeader('spec_link', '', $specific_column);
      $spec_column         = $link_column;

      foreach ($this->getSpecificities() as $field => $attributs) {
         $spec_column                 = $table_group->addHeader('spec_'.$field,
                                                                $attributs['long name'],
                                                                $specific_column, $spec_column);
         $specificity_columns[$field] = $spec_column;
      }

      $infocom_column  = $table_group->addHeader('infocom', Infocom::getTypeName(Session::getPluralNumber()),
                                                 $specific_column, $spec_column);

      $document_column = $table_group->addHeader('document', Document::getTypeName(Session::getPluralNumber()),
                                                 $specific_column, $spec_column);

      if ($item->isDynamic()) {
         $dynamics_column = $table_group->addHeader('one', '&nbsp;', $dynamic_column,
                                                    $spec_column);
         $previous_column = $dynamics_column;
      } else {
         $previous_column = $spec_column;
      }

      if ($options['canedit']) {
         $group_checkbox_tag =  (empty($peer_type) ? '__' : $peer_type);
         $content            = Html::getCheckbox(['criterion'
                                                         => ['tag_for_massive'
                                                                   => $group_checkbox_tag]]);
         $delete_one         = $table_group->addHeader('one', $content, $delete_column,
                                                       $previous_column);
      }

      $criteria = $this->getTableGroupCriteria($item, $peer_type);
      $fk = $item instanceof CommonDevice ? 'items_id' : $this->getDeviceForeignKey();

      if (!empty($peer_type)) {
         $peer = new $peer_type();
         $peer->getEmpty();
      } else {
         $peer = null;
      }

      $iterator = $DB->request($criteria);
      while ($link = $iterator->next()) {

         Session::addToNavigateListItems(static::getType(), $link["id"]);
         $this->getFromDB($link['id']);
         $current_row  = $table_group->createRow();
         if ((is_null($peer)) || ($link[$fk] != $peer->getID())) {

            if ($peer instanceof CommonDBTM) {
               $peer->getFromDB($link[$fk]);
            }

            $peer_group   = $peer_type.'_'.$link[$fk].'_'.mt_rand();
            $current_row->setHTMLID($peer_group);

            if ($options['canedit']) {
               $cell_value = Html::getCheckAllAsCheckbox($peer_group);
               $current_row->addCell($delete_all_column, $cell_value);
            }

            if ($is_device) {
               $cell = $current_row->addCell($peer_column, ($peer ? $peer->getLink() : __('None')),
                                             null, $peer);
               if (is_null($peer)) {
                  $cell->setHTMLClass('center');
               }
            } else {
               $peer->getHTMLTableCellForItem($current_row, $item, null, $options);
            }

         }

         if (Session::haveRight('device', UPDATE)) {
            $mode = __s('Update');
         } else {
            $mode = _sn('View', 'Views', 1);
         }
         $spec_cell = $current_row->addCell($link_column,
                                            "<a href='" . $this->getLinkURL() . "'>$mode</a>");

         foreach ($this->getSpecificities() as $field => $attributs) {
            $content = '';

            if (!empty($link[$field])) {
               // Check the user can view the field
               if (!isset($attributs['right'])) {
                  $canRead = true;
               } else {
                  $canRead = (Session::haveRightsOr($attributs['right'], [READ, UPDATE]));
               }

               // Don't show if the field shall not display in the list
               if (isset($attributs['nodisplay']) && $attributs['nodisplay']) {
                  $canRead = false;
               }

               if (!isset($attributs['datatype'])) {
                  $attributs['datatype'] = 'text';
               }
               if ($canRead) {
                  switch ($attributs['datatype']) {
                     case 'dropdown':
                        $dropdownType = getItemtypeForForeignKeyField($field);
                        $content = Dropdown::getDropdownName($dropdownType::getTable(), $link[$field]);
                        break;

                     default:
                        $content = $link[$field];
                  }
               }
            }

            $spec_cell = $current_row->addCell($specificity_columns[$field], $content, $spec_cell);
         }

         if (countElementsInTable('glpi_infocoms', ['itemtype' => $this->getType(),
                                                    'items_id' => $link['id']])) {
            $content = [['function'   => 'Infocom::showDisplayLink',
                                   'parameters' => [$this->getType(), $link['id']]]];
         } else {
            $content = '';
         }
         $current_row->addCell($infocom_column, $content, $spec_cell);

         $content = [];
         // The order is to be sure that specific documents appear first
         $doc_iterator = $DB->request([
            'SELECT' => 'documents_id',
            'FROM'   => 'glpi_documents_items',
            'WHERE'  => [
               'OR' => [
                  [
                     'itemtype'  => $this->getType(),
                     'items_id'  => $link['id']
                  ],
                  [
                     'itemtype'  => $this->getDeviceType(),
                     'items_id'  => $link[$this->getDeviceForeignKey()]
                  ]
               ]
            ],
            'ORDER'  => 'itemtype'
         ]);
         $document = new Document();
         while ($document_link = $doc_iterator->next()) {
            if ($document->can($document_link['documents_id'], READ)) {
               $content[] = $document->getLink();
            }
         }
         $content = implode('<br>', $content);
         $current_row->addCell($document_column, $content, $spec_cell);

         if ($item->isDynamic()) {
            $previous_cell = $current_row->addCell($dynamics_column,
                                                   Dropdown::getYesNo($link['is_dynamic']),
                                                   $spec_cell);
         } else {
            $previous_cell = $spec_cell;
         }

         if ($options['canedit']) {
            $cell_value = Html::getMassiveActionCheckBox($this->getType(), $link['id'],
                                                         ['massive_tags' => $group_checkbox_tag]);
            $current_row->addCell($delete_one, $cell_value, $previous_cell);
         }
      }
   }


   /**
    * @param $numberToAdd
    * @param $itemtype
    * @param $items_id
    * @param $devices_id
    * @param $input          array to complete (permit to define values)
   **/
   function addDevices($numberToAdd, $itemtype, $items_id, $devices_id, $input = []) {
      if ($numberToAdd == 0) {
         return;
      }

      $input['itemtype']                    = $itemtype;
      $input['items_id']                    = $items_id;
      $input[static::getDeviceForeignKey()] = $devices_id;

      $device_type = static::getDeviceType();
      $device      = new $device_type();
      $device->getFromDB($devices_id);

      foreach (static::getSpecificities() as $field => $attributs) {
         if (isset($device->fields[$field.'_default'])) {
            $input[$field] = $device->fields[$field.'_default'];
         }
      }

      if ($this->can(-1, CREATE, $input)) {
         for ($i = 0; $i < $numberToAdd; $i ++) {
            $this->add($input);
         }
      }
   }


   /**
    * Add one or several device(s) from front/item_devices.form.php.
    *
    * @param $input array of input: should be $_POST
    *
    * @since 0.85
   **/
   static function addDevicesFromPOST($input) {
      if (isset($input['devicetype']) && !$input['devicetype']) {
         Session::addMessageAfterRedirect(
            __('Please select a device type'),
            false,
            ERROR
         );
         return;
      } else if (isset($_POST['devices_id']) && !$_POST['devices_id']) {
         Session::addMessageAfterRedirect(
            __('Please select a device'),
            false,
            ERROR
         );
         return;
      }

      if (isset($input['devicetype'])) {
         $devicetype = $input['devicetype'];
         $linktype   = $devicetype::getItem_DeviceType();
         if ($link = getItemForItemtype($linktype)) {
            if (!isset($input[$linktype::getForeignKeyField()])
               && (!isset($input['new_devices']) || !$input['new_devices'])) {
               Session::addMessageAfterRedirect(
                  __('You must choose any unaffected device or ask to add new.'),
                  false,
                  ERROR
               );
               return;
            }

            if ((isset($input[$linktype::getForeignKeyField()]))
                && (count($input[$linktype::getForeignKeyField()]))) {
               $update_input = ['itemtype' => $input['itemtype'],
                                     'items_id' => $input['items_id']];
               foreach ($input[$linktype::getForeignKeyField()] as $id) {
                  $update_input['id'] = $id;
                  $link->update($update_input);
               }
            }
            if (isset($input['new_devices'])) {
               $link->addDevices($input['new_devices'], $input['itemtype'], $input['items_id'],
                                 $input['devices_id']);
            }
         }
      } else {
         if (!$item = getItemForItemtype($input['itemtype'])) {
            Html::displayNotFoundError();
         }
         if ($item instanceof CommonDevice) {
            if ($link = getItemForItemtype($item->getItem_DeviceType())) {
               $link->addDevices($input['number_devices_to_add'], '', 0, $input['items_id']);
            }
         }
      }
   }


   /**
    * @param $input array of input: should be $_POST
   **/
   static function updateAll($input) {

      if (!isset($input['itemtype'])
          || !isset($input['items_id'])) {
         Html::displayNotFoundError();
      }

      $itemtype = $input['itemtype'];
      $items_id = $input['items_id'];
      if (!$item = getItemForItemtype($itemtype)) {
         Html::displayNotFoundError();
      }
      $item->check($input['items_id'], UPDATE, $_POST);

      $is_device = ($item instanceof CommonDevice);
      if ($is_device) {
         $link_type = $itemtype::getItem_DeviceType();
      }

      $links   = [];
      // Update quantity or values
      $device_type = '';
      foreach ($input as $key => $val) {
         $data = explode("_", $key);
         if (!empty($data[0])) {
            $command = $data[0];
         } else {
            continue;
         }
         if (($command != 'quantity') && ($command != 'value')) {
            // items_id, itemtype, devicetype ...
            continue;
         }
         if (!$is_device) {
            if (empty($data[1])) {
               continue;
            }
            $device_type = $data[1];
            if (in_array($device_type::getItem_DeviceType(), self::getItemAffinities($itemtype))) {
               $link_type = $device_type::getItem_DeviceType();
            }
         }
         if (!empty($data[2])) {
            $links_id = $data[2];
         } else {
            continue;
         }
         if (!isset($links[$link_type])) {
            $links[$link_type] = ['add'    => [],
                                       'update' => []];
         }

         switch ($command) {
            case 'quantity' :
               $links[$link_type]['add'][$links_id] = $val;
               break;

            case 'value' :
               if (!isset($links[$link_type]['update'][$links_id])) {
                  $links[$link_type]['update'][$links_id] = [];
               }
               if (isset($data[3])) {
                  $links[$link_type]['update'][$links_id][$data[3]] = $val;
               }
               break;
         }
      }

      foreach ($links as $type => $commands) {
         if ($link = getItemForItemtype($type)) {
            foreach ($commands['add'] as $link_to_add => $number) {
               $link->addDevices($number, $itemtype, $items_id, $link_to_add);
            }
            foreach ($commands['update'] as $link_to_update => $input) {
               $input['id'] = $link_to_update;
               $link->update($input);
            }
            unset($link);
         }
      }

   }


   /**
    * @since 0.85
    *
    * @param $item_devices_id
    * @param $items_id
    * @param $itemtype
    *
    * @return boolean
   **/
   static function affectItem_Device($item_devices_id, $items_id, $itemtype) {

      $link = new static();
      return $link->update(['id'       => $item_devices_id,
                                 'items_id' => $items_id,
                                 'itemtype' => $itemtype]);
   }


   /**
    * @param $itemtype
    * @param $items_id
    * @param $unaffect
   **/
   static function cleanItemDeviceDBOnItemDelete($itemtype, $items_id, $unaffect) {
      global $DB;

      foreach (self::getItemAffinities($itemtype) as $link_type) {
         $link = getItemForItemtype($link_type);
         if ($link) {
            if ($unaffect) {
               $DB->update(
                  $link->getTable(), [
                     'items_id'  => 0,
                     'itemtype'  => ''
                  ], [
                     'items_id'  => $items_id,
                     'itemtype'  => $itemtype
                  ]
               );
            } else {
               $link->cleanDBOnItemDelete($itemtype, $items_id);
            }
         }
      }
   }


   function getRights($interface = 'central') {

      $values = parent::getRights();
      return $values;
   }


   /**
    * @since 0.85
    *
    * @see CommonDBConnexity::getConnexityMassiveActionsSpecificities()
   **/
   static function getConnexityMassiveActionsSpecificities() {

      $specificities              = parent::getConnexityMassiveActionsSpecificities();

      $specificities['reaffect']  = 1;
      $specificities['itemtypes'] = self::getConcernedItems();

      return $specificities;
   }


   function defineTabs($options = []) {

      $ong = [];
      $this->addDefaultFormTab($ong);
      $this->addStandardTab('Infocom', $ong, $options);
      $this->addStandardTab('Document_Item', $ong, $options);
      $this->addStandardTab('Log', $ong, $options);
      $this->addStandardTab('Contract_Item', $ong, $options);

      return $ong;
   }


   /**
    * @since 0.85
   **/
   function showForm($ID, $options = []) {
      if (!$this->isNewID($ID)) {
         $this->check($ID, READ);
      } else {
         // Create item
         $this->check(-1, CREATE);
      }
      $this->showFormHeader($options);

      $item   = $this->getOnePeer(0);
      $device = $this->getOnePeer(1);

      echo "<tr class='tab_bg_1'><td>"._n('Item', 'Items', 1)."</td>";
      echo "<td>";
      if ($item === false) {
         echo __('No associated item');
      } else {
         echo $item->getLink();
      }
      echo "</td>";

      echo "<td>"._n('Component', 'Components', 1)."</td>";
      echo "<td>";
      if (false === $device) {
         Dropdown::show(
            static::$itemtype_2, [
               'name'   => static::$items_id_2
            ]
         );
      } else {
         echo $device->getLink();
      }
      echo "</td>";
      echo "</tr>";
      $even = 0;
      $nb = count(static::getSpecificities());
      echo Html::scriptBlock('function showField(item) {
            $("#" + item).prop("type", "text");
         }
         function hideField(item) {
            $("#" + item).prop("type", "password");
         }
         function copyToClipboard(item) {
            showField(item);
            $("#" + item).select();
            try {
               document.execCommand("copy");
            } catch (e) {
               alert("' . addslashes(__('Copy to clipboard failed')) . '");
            }
            hideField(item);
         }');
      foreach (static::getSpecificities() as $field => $attributs) {
         if (($even % 2) == 0) {
            echo "<tr class='tab_bg_1'>";
         }
         $out = '';

         // Can the user view the value of the field ?
         if (!isset($attributs['right'])) {
            $canRead = true;
         } else {
            $canRead = (Session::haveRightsOr($attributs['right'], [READ, UPDATE]));
         }

         if (!isset($attributs['datatype'])) {
            $attributs['datatype'] = 'text';
         }

         $rand = mt_rand();
         echo "<td>";
         if ($canRead) {
            switch ($attributs['datatype']) {
               case 'dropdown':
                  $fieldType = 'dropdown';
                  break;

               default:
                  $fieldType = 'textfield';
            }
            echo "<label for='${fieldType}_$field$rand'>".$attributs['long name']."</label>";
         } else {
            echo $attributs['long name'];
         }
         echo "</td><td>";

         // Do the field needs a user action to display ?
         if (isset($attributs['protected']) && $attributs['protected']) {
            $protected = true;
            $out.= '<span class="disclosablefield">';
         } else {
            $protected = false;
         }

         if (isset($attributs['tooltip']) && strlen($attributs['tooltip']) > 0) {
            $tooltip = $attributs['tooltip'];
         } else {
            $tooltip = null;
         }

         if ($canRead) {
            $value = $this->fields[$field];
            switch ($attributs['datatype']) {
               case 'dropdown':
                  $dropdownType = getItemtypeForForeignKeyField($field);
                  $dropdown_options = [
                     'value'    => $value,
                     'rand'     => $rand,
                     'entity'   => $this->fields["entities_id"],
                     'display'  => false
                  ];
                  if (array_key_exists('dropdown_options', $attributs) && is_array($attributs['dropdown_options'])) {
                     $dropdown_options = array_merge($dropdown_options, $attributs['dropdown_options']);
                  }
                  $out.= $dropdownType::dropdown($dropdown_options);
                  break;
               default:
                  if (!$protected) {
                     $out.= Html::autocompletionTextField($this, $field, ['value'    => $value,
                                                                          'rand'     => $rand,
                                                                          'size'     => $attributs['size'],
                                                                          'display'  => false]);
                  } else {
                     $out.= '<input class="protected" type="password" autocomplete="new-password" name="' . $field . '" ';
                     $out.= 'id="' . $field . $rand . '" value="' . $value . '">';
                  }
            }
            if ($tooltip !== null) {
               $comment_id      = Html::cleanId("comment_".$field.$rand);
               $link_id         = Html::cleanId("comment_link_".$field.$rand);
               $options_tooltip = ['contentid' => $comment_id,
                  'linkid'    => $link_id,
                  'display'   => false];
               $out.= '&nbsp;'.Html::showToolTip($tooltip, $options_tooltip);
            }
            if ($protected) {
               $out.= '<span><i class="far fa-eye pointer disclose" ';
               $out.= 'onmousedown="showField(\'' . $field . $rand . '\')" ';
               $out.= 'onmouseup="hideField(\'' . $field . $rand . '\')" ';
               $out.= 'onmouseout="hideField(\'' . $field . $rand . '\')"></i>';
               $out.= '<i class="fa fa-paste pointer disclose" ';
               $out.= 'onclick="copyToClipboard(\'' . $field . $rand . '\')"></i>';
               $out.= '</span>';
            }
            echo $out;
         } else {
            echo NOT_AVAILABLE;
         }
         echo "</td>";
         $even ++;
         if (($even == $nb) && (($nb % 2) != 0) && $nb > 1) {
            echo "<td></td><td></td></tr>";
         }
      }
      $options['canedit'] =  Session::haveRight('device', UPDATE);
      $this->showFormButtons($options);

      return true;
   }

   function prepareInputForAdd($input) {
      global $CFG_GLPI;

      if (!isset($input[static::$items_id_2]) || !$input[static::$items_id_2]) {
         Session::addMessageAfterRedirect(
            sprintf(
               __('%1$s: %2$s'),
               static::getTypeName(),
               __('A device ID is mandatory')
            ),
            false,
            ERROR
         );
         return false;
      }

      $computer = static::getItemFromArray(static::$itemtype_1, static::$items_id_1, $input);

      if ($computer instanceOf CommonDBTM) {
         if (isset($CFG_GLPI['is_location_autoupdate']) && $CFG_GLPI["is_location_autoupdate"]
            && (!isset($input['locations_id']) ||
            $computer->fields['locations_id'] != $input['locations_id'])
         ) {
            $input['locations_id'] = $computer->fields['locations_id'];
         }

         if ((isset($CFG_GLPI['state_autoupdate_mode']) && $CFG_GLPI["state_autoupdate_mode"] < 0)
            && (!isset($input['states_id']) ||
            $computer->fields['states_id'] != $input['states_id'])
         ) {

            $input['states_id'] = $computer->fields['states_id'];
         }

         if ((isset($CFG_GLPI['state_autoupdate_mode']) && $CFG_GLPI["state_autoupdate_mode"] > 0)
            && (!isset($input['states_id']) ||
            $input['states_id'] != $CFG_GLPI["state_autoupdate_mode"])
         ) {

            $input['states_id'] = $CFG_GLPI["state_autoupdate_mode"];
         }
      }

      return parent::prepareInputForAdd($input);
   }

   function prepareInputForUpdate($input) {
      foreach (static::getSpecificities() as $field => $attributs) {
         if (!isset($attributs['right'])) {
            $canUpdate = true;
         } else {
            $canUpdate = (Session::haveRightsOr($attributs['right'], [UPDATE]));
         }
         if (isset($input[$field]) && !$canUpdate) {
            unset($input[$field]);
            Session::addMessageAfterRedirect(__('Update of ' . $attributs['short name'] . ' denied'));
         }
      }

      return $input;
   }

   static public function unsetUndisclosedFields(&$fields) {
      foreach (static::getSpecificities() as $key => $attributs) {
         if (isset($attributs['right'])) {
            if (!Session::haveRightsOr($attributs['right'], [READ])) {
               unset($fields[$key]);
            }
         }
      }
   }

   static function getSearchURL($full = true) {
      global $CFG_GLPI;

      $dir = ($full ? $CFG_GLPI['root_doc'] : '');
      $itemtype = get_called_class();
      $link = "$dir/front/item_device.php?itemtype=$itemtype";

      return $link;
   }


   static function getIcon() {
      $device_class = static::$itemtype_2 ?? "CommonDevice";
      return $device_class::getIcon();
   }
}
