list.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2002-2003  Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2018  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2018  Regis Houssin           <regis.houssin@inodbox.com>
 * Copyright (C) 2011       Herve Prot              <herve.prot@symeos.com>
 * Copyright (C) 2019-2021  Frédéric France         <frederic.france@netlogic.fr>
 *
 * 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 3 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, see <https://www.gnu.org/licenses/>.
 */
 
// Load Dolibarr environment
require '../../main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/user/class/usergroup.class.php';
 
// Load translation files required by page
$langs->loadLangs(array("users"));
 
$action     = GETPOST('action', 'aZ09') ? GETPOST('action', 'aZ09') : 'view'; // The action 'create'/'add', 'edit'/'update', 'view', ...
$massaction = GETPOST('massaction', 'alpha'); // The bulk action (combo box choice into lists)
$show_files = GETPOST('show_files', 'int'); // Show files area generated by bulk actions ?
$confirm    = GETPOST('confirm', 'alpha'); // Result of a confirmation
$cancel     = GETPOST('cancel', 'alpha'); // We click on a Cancel button
$toselect   = GETPOST('toselect', 'array'); // Array of ids of elements selected into a list
$contextpage = GETPOST('contextpage', 'aZ') ? GETPOST('contextpage', 'aZ') : str_replace('_', '', basename(dirname(__FILE__)).basename(__FILE__, '.php')); // To manage different context of search
$backtopage = GETPOST('backtopage', 'alpha'); // Go back to a dedicated page
$optioncss  = GETPOST('optioncss', 'aZ'); // Option for the css output (always '' except when 'print')
$mode       = GETPOST('mode', 'aZ'); // The output mode ('list', 'kanban', 'hierarchy', 'calendar', ...)
 
$search_all = trim((GETPOST('search_all', 'alphanohtml') != '') ? GETPOST('search_all', 'alphanohtml') : GETPOST('sall', 'alphanohtml'));
$search_group = GETPOST('search_group');
$search = array();
 
// Load variable for pagination
$limit = GETPOST('limit', 'int') ?GETPOST('limit', 'int') : $conf->liste_limit;
$sortfield = GETPOST('sortfield', 'aZ09comma');
$sortorder = GETPOST('sortorder', 'aZ09comma');
$page = GETPOSTISSET('pageplusone') ? (GETPOST('pageplusone') - 1) : GETPOST("page", 'int');
if (empty($page) || $page < 0 || GETPOST('button_search', 'alpha') || GETPOST('button_removefilter', 'alpha')) {
  // If $page is not defined, or '' or -1 or if we click on clear filters
  $page = 0;
}
$offset = $limit * $page;
$pageprev = $page - 1;
$pagenext = $page + 1;
 
// Initialize technical objects
$object = new UserGroup($db);
$extrafields = new ExtraFields($db);
//$diroutputmassaction = $conf->mymodule->dir_output.'/temp/massgeneration/'.$user->id;
$hookmanager->initHooks(array($contextpage));   // Note that conf->hooks_modules contains array of activated contexes
 
// Fetch optionals attributes and labels
$extrafields->fetch_name_optionals_label($object->table_element);
//$extrafields->fetch_name_optionals_label($object->table_element_line);
 
$search_array_options = $extrafields->getOptionalsFromPost($object->table_element, '', 'search_');
 
if (!$sortfield) {
  $sortfield = "g.nom";
}
if (!$sortorder) {
  $sortorder = "ASC";
}
 
// List of fields to search into when doing a "search in all"
$fieldstosearchall = array();
foreach ($object->fields as $key => $val) {
  if (!empty($val['searchall'])) {
    $fieldstosearchall['t.'.$key] = $val['label'];
  }
}
 
if (!empty($conf->global->MAIN_USE_ADVANCED_PERMS)) {
  if (!$user->hasRight("user", "group_advance", "read") && !$user->admin) {
    accessforbidden();
  }
}
 
// Users/Groups management only in master entity if transverse mode
if (isModEnabled('multicompany') && $conf->entity > 1 && $conf->global->MULTICOMPANY_TRANSVERSE_MODE) {
  accessforbidden();
}
 
if (!$user->hasRight("user", "user", "read") && !$user->admin) {
  accessforbidden();
}
 
// Defini si peux lire/modifier utilisateurs et permisssions
$caneditperms = ($user->admin || $user->hasRight("user", "user", "write"));
$permissiontodelete = ($user->admin || $user->hasRight("user", "user", "write"));
// Advanced permissions
if (!empty($conf->global->MAIN_USE_ADVANCED_PERMS)) {
  $caneditperms = ($user->admin || $user->hasRight("user", "group_advance", "write"));
}
 
 
/*
 * Actions
 */
 
if (GETPOST('cancel', 'alpha')) {
  $action = 'list';
  $massaction = '';
}
if (!GETPOST('confirmmassaction', 'alpha') && $massaction != 'presend' && $massaction != 'confirm_presend') {
  $massaction = '';
}
 
$parameters = array();
$reshook = $hookmanager->executeHooks('doActions', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
if ($reshook < 0) {
  setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
}
 
if (empty($reshook)) {
  // Selection of new fields
  include DOL_DOCUMENT_ROOT.'/core/actions_changeselectedfields.inc.php';
 
  // Purge search criteria
  if (GETPOST('button_removefilter_x', 'alpha') || GETPOST('button_removefilter.x', 'alpha') || GETPOST('button_removefilter', 'alpha')) { // All tests are required to be compatible with all browsers
    foreach ($object->fields as $key => $val) {
      $search[$key] = '';
      if (preg_match('/^(date|timestamp|datetime)/', $val['type'])) {
        $search[$key.'_dtstart'] = '';
        $search[$key.'_dtend'] = '';
      }
    }
    $toselect = array();
    $search_array_options = array();
  }
  if (GETPOST('button_removefilter_x', 'alpha') || GETPOST('button_removefilter.x', 'alpha') || GETPOST('button_removefilter', 'alpha')
    || GETPOST('button_search_x', 'alpha') || GETPOST('button_search.x', 'alpha') || GETPOST('button_search', 'alpha')) {
    $massaction = ''; // Protection to avoid mass action if we force a new search during a mass action confirmation
  }
 
  // Mass actions
  $objectclass = 'UserGroup';
  $objectlabel = 'UserGroup';
  $uploaddir = $conf->user->dir_output;
  include DOL_DOCUMENT_ROOT.'/core/actions_massactions.inc.php';
}
 
 
/*
 * View
 */
 
$form = new Form($db);
 
$now = dol_now();
 
$title = $langs->trans("UserGroups");
$help_url = '';
$morejs = array();
$morecss = array();
 
// Build and execute select
// --------------------------------------------------------------------
$sql = "SELECT g.rowid, g.nom as name, g.note, g.entity, g.datec, g.tms, COUNT(DISTINCT ugu.fk_user) as nb, COUNT(DISTINCT ugr.fk_id) as nbpermissions";
$sql .= " FROM ".MAIN_DB_PREFIX."usergroup as g";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."usergroup_user as ugu ON ugu.fk_usergroup = g.rowid";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."usergroup_rights as ugr ON ugr.fk_usergroup = g.rowid";
if (isModEnabled('multicompany') && $conf->entity == 1 && (getDolGlobalInt('MULTICOMPANY_TRANSVERSE_MODE') || ($user->admin && !$user->entity))) {
  $sql .= " WHERE g.entity IS NOT NULL";
} else {
  $sql .= " WHERE g.entity IN (0,".$conf->entity.")";
}
if (!empty($search_group)) {
  natural_search(array("g.nom", "g.note"), $search_group);
}
if ($search_all) {
  $sql .= natural_search(array("g.nom", "g.note"), $search_all);
}
$sql .= " GROUP BY g.rowid, g.nom, g.note, g.entity, g.datec, g.tms";
 
// Complete request and execute it with limit
$sql .= $db->order($sortfield, $sortorder);
if ($limit) {
  $sql .= $db->plimit($limit + 1, $offset);
}
 
$resql = $db->query($sql);
if (!$resql) {
  dol_print_error($db);
  exit;
}
 
$num = $db->num_rows($resql);
 
 
$nbtotalofrecords = $num;
 
$i = 0;
 
 
// Output page
// --------------------------------------------------------------------
 
llxHeader('', $title, $help_url, '', 0, 0, $morejs, $morecss, '', 'bodyforlist');
 
$arrayofselected = is_array($toselect) ? $toselect : array();
 
$param = "&search_group=".urlencode($search_group)."&search_all=".urlencode($search_all);
if (!empty($mode)) {
  $param .= '&mode='.urlencode($mode);
}
if (!empty($contextpage) && $contextpage != $_SERVER["PHP_SELF"]) {
  $param .= '&contextpage='.urlencode($contextpage);
}
if ($limit > 0 && $limit != $conf->liste_limit) {
  $param .= '&limit='.((int) $limit);
}
foreach ($search as $key => $val) {
  if (is_array($search[$key])) {
    foreach ($search[$key] as $skey) {
      if ($skey != '') {
        $param .= '&search_'.$key.'[]='.urlencode($skey);
      }
    }
  } elseif (preg_match('/(_dtstart|_dtend)$/', $key) && !empty($val)) {
    $param .= '&search_'.$key.'month='.((int) GETPOST('search_'.$key.'month', 'int'));
    $param .= '&search_'.$key.'day='.((int) GETPOST('search_'.$key.'day', 'int'));
    $param .= '&search_'.$key.'year='.((int) GETPOST('search_'.$key.'year', 'int'));
  } elseif ($search[$key] != '') {
    $param .= '&search_'.$key.'='.urlencode($search[$key]);
  }
}
if ($optioncss != '') {
  $param .= '&optioncss='.urlencode($optioncss);
}
// Add $param from extra fields
include DOL_DOCUMENT_ROOT.'/core/tpl/extrafields_list_search_param.tpl.php';
// Add $param from hooks
$parameters = array();
$reshook = $hookmanager->executeHooks('printFieldListSearchParam', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
$param .= $hookmanager->resPrint;
 
// List of mass actions available
$arrayofmassactions = array(
  //'validate'=>img_picto('', 'check', 'class="pictofixedwidth"').$langs->trans("Validate"),
  //'generate_doc'=>img_picto('', 'pdf', 'class="pictofixedwidth"').$langs->trans("ReGeneratePDF"),
  //'builddoc'=>img_picto('', 'pdf', 'class="pictofixedwidth"').$langs->trans("PDFMerge"),
  //'presend'=>img_picto('', 'email', 'class="pictofixedwidth"').$langs->trans("SendByMail"),
);
if (!empty($permissiontodelete)) {
  $arrayofmassactions['predelete'] = img_picto('', 'delete', 'class="pictofixedwidth"').$langs->trans("Delete");
}
if (GETPOST('nomassaction', 'int') || in_array($massaction, array('presend', 'predelete'))) {
  $arrayofmassactions = array();
}
$massactionbutton = $form->selectMassAction('', $arrayofmassactions);
 
print '<form method="POST" id="searchFormList" action="'.$_SERVER["PHP_SELF"].'">'."\n";
if ($optioncss != '') {
  print '<input type="hidden" name="optioncss" value="'.$optioncss.'">';
}
print '<input type="hidden" name="token" value="'.newToken().'">';
print '<input type="hidden" name="formfilteraction" id="formfilteraction" value="list">';
print '<input type="hidden" name="action" value="list">';
print '<input type="hidden" name="sortfield" value="'.$sortfield.'">';
print '<input type="hidden" name="sortorder" value="'.$sortorder.'">';
print '<input type="hidden" name="page" value="'.$page.'">';
print '<input type="hidden" name="contextpage" value="'.$contextpage.'">';
print '<input type="hidden" name="page_y" value="">';
print '<input type="hidden" name="mode" value="'.$mode.'">';
 
$newcardbutton = '';
$newcardbutton .= dolGetButtonTitle($langs->trans('ViewList'), '', 'fa fa-bars imgforviewmode', $_SERVER["PHP_SELF"].'?mode=common'.preg_replace('/(&|\?)*mode=[^&]+/', '', $param), '', ((empty($mode) || $mode == 'common') ? 2 : 1), array('morecss'=>'reposition'));
$newcardbutton .= dolGetButtonTitle($langs->trans('ViewKanban'), '', 'fa fa-th-list imgforviewmode', $_SERVER["PHP_SELF"].'?mode=kanban'.preg_replace('/(&|\?)*mode=[^&]+/', '', $param), '', ($mode == 'kanban' ? 2 : 1), array('morecss'=>'reposition'));
 
if ($caneditperms) {
  $newcardbutton .= dolGetButtonTitleSeparator();
  $newcardbutton .= dolGetButtonTitle($langs->trans('NewGroup'), '', 'fa fa-plus-circle', DOL_URL_ROOT.'/user/group/card.php?action=create&leftmenu=');
}
 
print_barre_liste($title, $page, $_SERVER["PHP_SELF"], $param, $sortfield, $sortorder, $massactionbutton, $num, $nbtotalofrecords, 'object_'.$object->picto, 0, $newcardbutton, '', $limit, 0, 0, 1);
 
// Add code for pre mass action (confirmation or email presend form)
$topicmail = "SendGroup";
$modelmail = "group";
$objecttmp = new UserGroup($db);
$trackid = 'grp'.$object->id;
include DOL_DOCUMENT_ROOT.'/core/tpl/massactions_pre.tpl.php';
 
if ($search_all) {
  $setupstring = '';
  foreach ($fieldstosearchall as $key => $val) {
    $fieldstosearchall[$key] = $langs->trans($val);
    $setupstring .= $key."=".$val.";";
  }
  print '<!-- Search done like if GROUP_QUICKSEARCH_ON_FIELDS = '.$setupstring.' -->'."\n";
  print '<div class="divsearchfieldfilter">'.$langs->trans("FilterOnInto", $search_all).join(', ', $fieldstosearchall).'</div>'."\n";
}
 
$moreforfilter = '';
 
$parameters = array();
$reshook = $hookmanager->executeHooks('printFieldPreListTitle', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
if (empty($reshook)) {
  $moreforfilter .= $hookmanager->resPrint;
} else {
  $moreforfilter = $hookmanager->resPrint;
}
 
if (!empty($moreforfilter)) {
  print '<div class="liste_titre liste_titre_bydiv centpercent">';
  print $moreforfilter;
  $parameters = array();
  $reshook = $hookmanager->executeHooks('printFieldPreListTitle', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
  print $hookmanager->resPrint;
  print '</div>';
}
 
$varpage=empty($contextpage)?$_SERVER["PHP_SELF"]:$contextpage;
$selectedfields = ($mode != 'kanban' ? $form->multiSelectArrayWithCheckbox('selectedfields', $arrayfields, $varpage, getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN', '')) : ''); // This also change content of $arrayfields
$selectedfields .= (count($arrayofmassactions) ? $form->showCheckAddButtons('checkforselect', 1) : '');
 
print '<div class="div-table-responsive">';
print '<table class="tagtable nobottomiftotal liste'.($moreforfilter ? " listwithfilterbefore" : "").'">'."\n";
 
// Fields title search
// --------------------------------------------------------------------
// ...
 
$totalarray = array();
$totalarray['nbfield'] = 0;
 
// Fields title label
// --------------------------------------------------------------------
print '<tr class="liste_titre">';
if (getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
  print getTitleFieldOfList($selectedfields, 0, $_SERVER["PHP_SELF"], '', '', '', '', $sortfield, $sortorder, 'center maxwidthsearch ')."\n";
  $totalarray['nbfield']++;
}
print_liste_field_titre("Group", $_SERVER["PHP_SELF"], "g.nom", $param, "", "", $sortfield, $sortorder);
$totalarray['nbfield']++;
//multicompany
if (isModEnabled('multicompany') && empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE) && $conf->entity == 1) {
  print_liste_field_titre("Entity", $_SERVER["PHP_SELF"], "g.entity", $param, "", '', $sortfield, $sortorder, 'center ');
  $totalarray['nbfield']++;
}
print_liste_field_titre("NbOfUsers", $_SERVER["PHP_SELF"], "nb", $param, "", '', $sortfield, $sortorder, 'center ');
$totalarray['nbfield']++;
print_liste_field_titre("NbOfPermissions", $_SERVER["PHP_SELF"], "nbpermissions", $param, "", '', $sortfield, $sortorder, 'center ');
$totalarray['nbfield']++;
print_liste_field_titre("DateCreationShort", $_SERVER["PHP_SELF"], "g.datec", $param, "", '', $sortfield, $sortorder, 'center ');
$totalarray['nbfield']++;
print_liste_field_titre("DateLastModification", $_SERVER["PHP_SELF"], "g.tms", $param, "", '', $sortfield, $sortorder, 'center ');
$totalarray['nbfield']++;
// Extra fields
include DOL_DOCUMENT_ROOT.'/core/tpl/extrafields_list_search_title.tpl.php';
// Hook fields
$parameters = array('arrayfields'=>$arrayfields, 'param'=>$param, 'sortfield'=>$sortfield, 'sortorder'=>$sortorder, 'totalarray'=>&$totalarray);
$reshook = $hookmanager->executeHooks('printFieldListTitle', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
print $hookmanager->resPrint;
/*if (!empty($arrayfields['anotherfield']['checked'])) {
 print '<th class="liste_titre right">'.$langs->trans("AnotherField").'</th>';
 $totalarray['nbfield']++;
 }*/
// Action column
if (!getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
  print getTitleFieldOfList($selectedfields, 0, $_SERVER["PHP_SELF"], '', '', '', '', $sortfield, $sortorder, 'center maxwidthsearch ')."\n";
  $totalarray['nbfield']++;
}
print '</tr>'."\n";
 
 
// Loop on record
// --------------------------------------------------------------------
$i = 0;
$savnbfield = $totalarray['nbfield'];
$totalarray = array();
$totalarray['nbfield'] = 0;
$imaxinloop = ($limit ? min($num, $limit) : $num);
while ($i < $imaxinloop) {
  $obj = $db->fetch_object($resql);
  if (empty($obj)) {
    break; // Should not happen
  }
 
  // Store properties in $object
  $object->setVarsFromFetchObj($obj);
 
  $object->name = $obj->name;
  $object->note = $obj->note;
  $object->nb_rights = $obj->nbpermissions;
  $object->nb_users = $obj->nb;
 
  if ($mode == 'kanban') {
    if ($i == 0) {
      print '<tr class="trkanban"><td colspan="'.$savnbfield.'">';
      print '<div class="box-flex-container kanban">';
    }
    // Output Kanban
    if ($massactionbutton || $massaction) { // If we are in select mode (massactionbutton defined) or if we have already selected and sent an action ($massaction) defined
      $selected = 0;
      if (in_array($object->id, $arrayofselected)) {
        $selected = 1;
      }
    }
    print $object->getKanbanView('', array('selected' => in_array($object->id, $arrayofselected)));
    if ($i == ($imaxinloop - 1)) {
      print '</div>';
      print '</td></tr>';
    }
  } else {
    // Show here line of result
    $j = 0;
    print '<tr data-rowid="'.$object->id.'" class="oddeven">';
    // Action column
    if (getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
      print '<td class="nowrap center">';
      if ($massactionbutton || $massaction) { // If we are in select mode (massactionbutton defined) or if we have already selected and sent an action ($massaction) defined
        $selected = 0;
        if (in_array($object->id, $arrayofselected)) {
          $selected = 1;
        }
        print '<input id="cb'.$object->id.'" class="flat checkforselect" type="checkbox" name="toselect[]" value="'.$object->id.'"'.($selected ? ' checked="checked"' : '').'>';
      }
      print '</td>';
      if (!$i) {
        $totalarray['nbfield']++;
      }
    }
 
    print '<td>';
    print $object->getNomUrl(1);
    if (isModEnabled('multicompany') && !$obj->entity) {
      print img_picto($langs->trans("GlobalGroup"), 'redstar');
    }
    print "</td>";
    if (!$i) {
      $totalarray['nbfield']++;
    }
    //multicompany
    if (isModEnabled('multicompany') && is_object($mc) && empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE) && $conf->entity == 1) {
      $mc->getInfo($obj->entity);
      print '<td class="center">'.dol_escape_htmltag($mc->label).'</td>';
      if (!$i) {
        $totalarray['nbfield']++;
      }
    }
    print '<td class="center">'.$obj->nb.'</td>';
    if (!$i) {
      $totalarray['nbfield']++;
    }
    print '<td class="center">';
    print '<a href="'.DOL_URL_ROOT.'/user/group/perms.php?id='.$obj->rowid.'">'.$obj->nbpermissions.'</a>';
    print '</td>';
    if (!$i) {
      $totalarray['nbfield']++;
    }
    print '<td class="center nowrap">'.dol_print_date($db->jdate($obj->datec), "dayhour").'</td>';
    if (!$i) {
      $totalarray['nbfield']++;
    }
    print '<td class="center nowrap">'.dol_print_date($db->jdate($obj->tms), "dayhour").'</td>';
    if (!$i) {
      $totalarray['nbfield']++;
    }
    // Extra fields
    include DOL_DOCUMENT_ROOT.'/core/tpl/extrafields_list_print_fields.tpl.php';
    // Fields from hook
    $parameters = array('arrayfields'=>$arrayfields, 'object'=>$object, 'obj'=>$obj, 'i'=>$i, 'totalarray'=>&$totalarray);
    $reshook = $hookmanager->executeHooks('printFieldListValue', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
    print $hookmanager->resPrint;
    // Action column
    if (!getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
      print '<td class="nowrap center">';
      if ($massactionbutton || $massaction) { // If we are in select mode (massactionbutton defined) or if we have already selected and sent an action ($massaction) defined
        $selected = 0;
        if (in_array($object->id, $arrayofselected)) {
          $selected = 1;
        }
        print '<input id="cb'.$object->id.'" class="flat checkforselect" type="checkbox" name="toselect[]" value="'.$object->id.'"'.($selected ? ' checked="checked"' : '').'>';
      }
      print '</td>';
      if (!$i) {
        $totalarray['nbfield']++;
      }
    }
 
    print '</tr>'."\n";
  }
  $i++;
}
 
// Show total line
include DOL_DOCUMENT_ROOT.'/core/tpl/list_print_total.tpl.php';
 
// If no record found
if ($num == 0) {
  /*$colspan = 1;
  foreach ($arrayfields as $key => $val) {
    if (!empty($val['checked'])) {
      $colspan++;
    }
  }*/
  $colspan = 1;
  foreach ($arrayfields as $key => $val) {
    if (!empty($val['checked'])) {
      $colspan++;
    }
  }
  print '<tr><td colspan="'.$colspan.'"><span class="opacitymedium">'.$langs->trans("NoRecordFound").'</span></td></tr>';
}
 
$db->free($resql);
 
print '</table>'."\n";
print '</div>'."\n";
 
print '</form>'."\n";
 
// End of page
llxFooter();
$db->close();