File: /home4/cca63905/public_html/guiaweb/htdocs/core/class/infobox.class.php
<?php
/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2019 Nicolas ZABOURI <info@inovea-conseil.com>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
*
* 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/>.
*/
/**
* \file htdocs/core/class/infobox.class.php
* \brief File of class to manage widget boxes
*/
/**
* Class to manage boxes on pages. This is an utility class (all is static)
*/
class InfoBox
{
/**
* Name of positions (See below)
*
* @return string[] Array with list of zones
*/
public static function getListOfPagesForBoxes()
{
global $conf;
if (getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
return array(
0 => 'Home',
1 => 'UsersHome',
2 => 'MembersHome',
3 => 'ThirdpartiesHome',
11 => 'TicketsHome',
27 => 'AccountancyHome'
);
} else {
return array(
0 => 'Home',
1 => 'UsersHome',
2 => 'MembersHome',
3 => 'ThirdpartiesHome',
4 => 'productindex',
5 => 'productindex',
6 => 'mrpindex',
7 => 'commercialindex',
8 => 'projectsindex',
9 => 'invoiceindex',
10 => 'hrmindex',
11 => 'TicketsHome',
12 => 'stockindex',
13 => 'sendingindex',
14 => 'receptionindex',
15 => 'activityindex',
16 => 'proposalindex',
17 => 'ordersindex',
18 => 'orderssuppliersindex',
19 => 'contractindex',
20 => 'interventionindex',
21 => 'suppliersproposalsindex',
22 => 'donationindex',
23 => 'specialexpensesindex',
24 => 'expensereportindex',
25 => 'mailingindex',
26 => 'opensurveyindex',
27 => 'AccountancyHome'
);
}
}
/**
* Return array of boxes qualified for area and user
*
* @param DoliDB $dbs Database handler
* @param string $mode 'available' or 'activated'
* @param int $zone Name or area (-1 for all, 0 for Homepage, 1 for Accountancy, 2 for xxx, ...)
* @param ?User $user Object user to filter
* @param int[] $excludelist Array of box id (box.box_id = boxes_def.rowid) to exclude
* @param int $includehidden Include also hidden boxes
* @return ModeleBoxes[]|array{error:string} Array of boxes or error info
*/
public static function listBoxes($dbs, $mode, $zone, $user = null, $excludelist = array(), $includehidden = 1)
{
global $conf;
$boxes = array();
if ($mode == 'activated') { // activated
$sql = "SELECT b.rowid, b.position, b.box_order, b.fk_user,";
$sql .= " d.rowid as box_id, d.file, d.note, d.tms";
$sql .= " FROM ".$dbs->prefix()."boxes as b, ".$dbs->prefix()."boxes_def as d";
$sql .= " WHERE b.box_id = d.rowid";
$sql .= " AND b.entity IN (0,".$conf->entity.")";
if ($zone >= 0) {
$sql .= " AND b.position = ".((int) $zone);
}
if (is_object($user)) {
$sql .= " AND b.fk_user IN (0,".$user->id.")";
} else {
$sql .= " AND b.fk_user = 0";
}
$sql .= " ORDER BY b.box_order";
} else { // available
$sql = "SELECT d.rowid as box_id, d.file, d.note, d.tms";
$sql .= " FROM ".$dbs->prefix()."boxes_def as d";
$sql .= " WHERE d.entity IN (0, ".$conf->entity.")";
}
dol_syslog(self::class."::listBoxes get default box list for mode=".$mode." userid=".(is_object($user) ? $user->id : ''), LOG_DEBUG);
$resql = $dbs->query($sql);
if ($resql) {
$num = $dbs->num_rows($resql);
$j = 0;
while ($j < $num) {
$obj = $dbs->fetch_object($resql);
if (!in_array($obj->box_id, $excludelist)) {
$regs = array();
if (preg_match('/^([^@]+)@([^@]+)$/i', $obj->file, $regs)) {
$boxname = preg_replace('/\.php$/i', '', $regs[1]);
$module = $regs[2];
$relsourcefile = "/".$module."/core/boxes/".$boxname.".php";
} else {
$boxname = preg_replace('/\.php$/i', '', $obj->file);
$relsourcefile = "/core/boxes/".$boxname.".php";
}
//print $obj->box_id.'-'.$boxname.'-'.$relsourcefile.'<br>';
// TODO PERF Do not make "dol_include_once" here, nor "new" later. This means, we must store a 'depends' field to store modules list, then
// the "enabled" condition for modules forbidden for external users and the depends condition can be done.
// Goal is to avoid to make a "new" done for each boxes returned by select.
dol_include_once($relsourcefile);
if (class_exists($boxname)) {
$box = new $boxname($dbs, $obj->note); // Constructor may set properties like box->enabled. obj->note is note into box def, not user params.
'@phan-var-force ModeleBoxes $box';
//$box=new stdClass();
// box properties
$box->rowid = (empty($obj->rowid) ? '' : $obj->rowid);
$box->id = (empty($obj->box_id) ? '' : $obj->box_id);
$box->position = ((isset($obj->position) && $obj->position == '') ? '' : (isset($obj->position) ? $obj->position : '')); // '0' must stay '0'
$box->box_order = (empty($obj->box_order) ? '' : $obj->box_order);
$box->fk_user = (empty($obj->fk_user) ? 0 : $obj->fk_user);
$box->sourcefile = $relsourcefile;
$box->class = $boxname;
if ($mode == 'activated' && !is_object($user)) { // List of activated box was not yet personalized into database
if (is_numeric($box->box_order)) {
if (((int) $box->box_order % 2) == 1) {
$box->box_order = 'A'.$box->box_order;
} elseif (((int) $box->box_order % 2) == 0) {
$box->box_order = 'B'.$box->box_order;
}
}
}
// box_def properties
$box->box_id = (empty($obj->box_id) ? '' : $obj->box_id);
$box->note = (empty($obj->note) ? '' : $obj->note);
// Filter on box->enabled (used for example by box_comptes)
// Filter also on box->depends. Example: array("product|service") or array("contrat", "service")
$enabled = $box->enabled;
if (isset($box->depends) && count($box->depends) > 0) {
foreach ($box->depends as $moduleelem) {
$arrayelem = explode('|', $moduleelem);
$tmpenabled = 0; // $tmpenabled is used for the '|' test (OR)
foreach ($arrayelem as $module) {
$tmpmodule = preg_replace('/@[^@]+/', '', $module);
if (!empty($tmpmodule) && isModEnabled($tmpmodule)) {
$tmpenabled = 1;
}
//print $boxname.'-'.$module.'-module enabled='.(empty($conf->$tmpmodule->enabled)?0:1).'<br>';
}
if (empty($tmpenabled)) { // We found at least one module required that is disabled
$enabled = 0;
break;
}
}
}
//print '=>'.$boxname.'-enabled='.$enabled.'<br>';
//print 'xx module='.$module.' enabled='.$enabled;
if ($enabled && ($includehidden || empty($box->hidden))) {
$boxes[] = $box;
} else {
unset($box);
}
} else {
dol_syslog("Failed to load box '".$boxname."' into file '".$relsourcefile."'", LOG_WARNING);
}
}
$j++;
}
} else {
dol_syslog($dbs->lasterror(), LOG_ERR);
return array('error' => $dbs->lasterror());
}
return $boxes;
}
/**
* Save order of boxes for area and user
*
* @param DoliDB $dbs Database handler
* @param int|string $zone Key of area ('0' for Homepage, '1', 'pagename', ...)
* @param string $boxorder List of boxes with correct order 'A:123,456,...-B:789,321...'
* @param int $userid Id of user
* @return int Return integer <0 if KO, 0=Nothing done, > 0 if OK
*/
public static function saveboxorder($dbs, $zone, $boxorder, $userid = 0)
{
global $conf;
$error = 0;
require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
dol_syslog(self::class."::saveboxorder zone=".$zone." userid=".$userid);
if (!$userid || $userid == 0) {
return 0;
}
$user = new User($dbs);
$user->id = $userid;
$dbs->begin();
// Save parameters to say user has a dedicated setup
$tab = array();
$confuserzone = 'MAIN_BOXES_'.$zone;
$tab[$confuserzone] = '1';
if (dol_set_user_param($dbs, $conf, $user, $tab) < 0) {
$error = $dbs->lasterror();
$dbs->rollback();
return -3;
}
if (!is_numeric($zone)) {
$zone = '0'; // Force $zone to a numeric value string
}
// Delete all lines
$sql = "DELETE FROM ".$dbs->prefix()."boxes";
$sql .= " WHERE entity = ".$conf->entity;
$sql .= " AND fk_user = ".((int) $userid);
$sql .= " AND position = ".((int) $zone);
dol_syslog(self::class."::saveboxorder", LOG_DEBUG);
$result = $dbs->query($sql);
if ($result) {
$colonnes = explode('-', $boxorder);
foreach ($colonnes as $collist) {
$part = explode(':', $collist);
$colonne = $part[0];
$list = $part[1];
dol_syslog(self::class."::saveboxorder column=".$colonne.' list='.$list);
$i = 0;
$listarray = explode(',', $list);
foreach ($listarray as $id) {
if (is_numeric($id)) {
//dol_syslog("aaaaa".count($listarray));
$i++;
$ii = sprintf('%02d', $i);
$sql = "INSERT INTO ".$dbs->prefix()."boxes";
$sql .= "(box_id, position, box_order, fk_user, entity)";
$sql .= " values (";
$sql .= " ".((int) $id).",";
$sql .= " ".((int) $zone).",";
$sql .= " '".$dbs->escape($colonne.$ii)."',";
$sql .= " ".((int) $userid).",";
$sql .= " ".((int) $conf->entity);
$sql .= ")";
$result = $dbs->query($sql);
if ($result < 0) {
$error++;
break;
}
}
}
}
} else {
$error++;
}
if ($error) {
$dbs->rollback();
return -2;
} else {
$dbs->commit();
return 1;
}
}
}