.
* ---------------------------------------------------------------------
*/
if (!defined('GLPI_ROOT')) {
die("Sorry. You can't access this file directly");
}
/**
* Saved searches class
*
* @since 9.2
**/
class SavedSearch extends CommonDBTM implements ExtraVisibilityCriteria {
static $rightname = 'bookmark_public';
const SEARCH = 1; //SEARCH SYSTEM bookmark
const URI = 2;
const ALERT = 3; //SEARCH SYSTEM search alert
const COUNT_NO = 0;
const COUNT_YES = 1;
const COUNT_AUTO = 2;
static function getForbiddenActionsForMenu() {
return ['add'];
}
public static function getTypeName($nb = 0) {
return _n('Saved search', 'Saved searches', $nb);
}
function getForbiddenStandardMassiveAction() {
$forbidden = parent::getForbiddenStandardMassiveAction();
$forbidden[] = 'update';
return $forbidden;
}
function getSpecificMassiveActions($checkitem = null) {
$actions[get_called_class().MassiveAction::CLASS_ACTION_SEPARATOR.'unset_default']
= __('Unset as default');
$actions[get_called_class().MassiveAction::CLASS_ACTION_SEPARATOR.'change_count_method']
= __('Change count method');
if (Session::haveRight('transfer', READ)) {
$actions[get_called_class().MassiveAction::CLASS_ACTION_SEPARATOR.'change_entity']
= __('Change visibility');
}
return $actions;
}
static function showMassiveActionsSubForm(MassiveAction $ma) {
switch ($ma->getAction()) {
case 'change_count_method':
$values = [self::COUNT_AUTO => __('Auto'),
self::COUNT_YES => __('Yes'),
self::COUNT_NO => __('No')];
Dropdown::showFromArray('do_count', $values, ['width' => '20%']);
break;
case 'change_entity':
Entity::dropdown(['entity' => $_SESSION['glpiactiveentities'],
'value' => $_SESSION['glpiactive_entity'],
'name' => 'entities_id']);
echo '";
if (!isset($options['ajax'])) {
if ($ID > 0) {
//TRANS: %1$s is the Itemtype name and $2$d the ID of the item
printf(__('%1$s - ID %2$d'), $this->getTypeName(1), $ID);
} else {
echo __('New item');
}
} else {
echo __('New saved search');
}
echo " ".__('Name')." ";
echo "";
Html::autocompletionTextField($this, "name", ['user' => $this->fields["users_id"]]);
echo " ";
if (Session::haveRight("config", UPDATE)) {
echo "".__('Do count')." ".
"";
$values = [self::COUNT_AUTO => __('Auto'),
self::COUNT_YES => __('Yes'),
self::COUNT_NO => __('No')];
Dropdown::showFromArray('do_count', $values, ['value' => $this->getField('do_count')]);
} else {
echo " ";
}
echo " ".__('Visibility') . " ";
Dropdown::showFromArray(
'is_private', [
1 => __('Private'),
0 => __('Public')
], [
'value' => $this->fields['is_private'],
'rand' => $rand
]
);
echo " ".Entity::getTypeName(1)." ";
echo "";
Entity::dropdown(['value' => $this->fields["entities_id"]]);
echo " ". __('Child entities')." ";
Dropdown::showYesNo('is_recursive', $this->fields["is_recursive"]);
} else {
echo " ";
if ($this->fields["is_private"]) {
echo __('Private');
} else {
echo __('Public');
}
}
if ($ID <= 0) { // add
echo Html::hidden('users_id', ['value' => $this->fields['users_id']]);
echo Html::hidden('is_private', ['value' => $this->fields['is_private']]);
} else {
echo Html::hidden('id', ['value' => $ID]);
}
echo " ";
$colspan = 2;
echo "
";
echo "";
echo $this->displaySavedSearchType($searches['private']);
echo " ";
if ($this->canView()) {
echo "" .
sprintf(
_n('Public %1$s', 'Public %1$s', count($searches['public'])),
$this->getTypeName(count($searches['public']))
) .
" ";
echo $this->displaySavedSearchType($searches['public']);
echo " ";
}
echo "
";
echo "";
if (is_null($this->fields['IS_DEFAULT'])) {
echo "getSearchURL() . "?action=edit& mark_default=1&id=".
$this->fields["id"]."\" title=\"".__s('Not default search')."\">".
"" . __('Not default search') . " ";
} else {
echo "getSearchURL() . "?action=edit&mark_default=0&id=".
$this->fields["id"]."\" title=\"".__s('Default search')."\">".
"" . __('Default search') . " ";
}
echo " ";
echo "";
$text = sprintf(__('%1$s on %2$s'), $this->fields['name'], $current_type_name);
$title = ($is_private ? __s('Click to load or drag and drop to reorder')
: __s('Click to load'));
echo "getSearchURL()."?action=load&id=".
$this->fields["id"]."\" title='".$title."'>".
$text;
if ($_SESSION['glpishow_count_on_tabs']) {
echo "$count ";
}
echo " ";
echo " ";
echo " ";
}
if ($is_private) {
//private saved searches can be ordered
$js = "$(function() {
$('.slidepanel .contents table').sortable({
items: 'tr.private',
placeholder: 'ui-state-highlight',
create: function(event, ui) {
$('tr.private td:first-child').each(function() {
$(this).prepend('";
echo sprintf(__('You have not recorded any %1$s yet'), mb_strtolower($this->getTypeName(1)));
echo " ";
echo "".__s('Save current search')." ";
echo " ";
Ajax::createModalWindow('savesearch',
$CFG_GLPI['root_doc'] .
"/ajax/savedsearch.php?action=create&itemtype=$itemtype&type=$type&url=".
rawurlencode($_SERVER["REQUEST_URI"]),
['title' => __('Save current search')]);
}
/**
* Get personal order field name
*
* @return string
**/
protected function getPersonalOrderField() {
return 'privatebookmarkorder';
}
/**
* Get all itemtypes used
*
* @return array of itemtypes
**/
static function getUsedItemtypes() {
global $DB;
$types= [];
$iterator = $DB->request([
'SELECT' => 'itemtype',
'DISTINCT' => true,
'FROM' => static::getTable()
]);
while ($data = $iterator->next()) {
$types[] = $data['itemtype'];
}
return $types;
}
/**
* Update bookmark execution time after it has been loaded
*
* @param integer $id Saved search ID
* @param integer $time Execution time, in milliseconds
*
* @return void
**/
static public function updateExecutionTime($id, $time) {
global $DB;
if ($_SESSION['glpishow_count_on_tabs']) {
$DB->update(
static::getTable(), [
'last_execution_time' => $time,
'last_execution_date' => date('Y-m-d H:i:s'),
'counter' => new \QueryExpression($DB->quoteName('counter') . ' + 1')
], [
'id' => $id
]
);
}
}
static function getSpecificValueToDisplay($field, $values, array $options = []) {
if (!is_array($values)) {
$values = [$field => $values];
}
switch ($field) {
case 'do_count':
switch ($values[$field]) {
case SavedSearch::COUNT_NO:
return __('No');
case SavedSearch::COUNT_YES:
return __('Yes');
case SavedSearch::COUNT_AUTO:
return ('Auto');
}
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 'do_count' :
$options['name'] = $name;
$options['value'] = $values[$field];
return self::dropdownDoCount($options);
}
return parent::getSpecificValueToSelect($field, $name, $values, $options);
}
/**
* Dropdown of do_count possible values
*
* @param array $options array of options:
* - name : select name (default is do_count)
* - value : default value (default self::COUNT_AUTO)
* - display : boolean if false get string
*
* @return void|string
**/
static function dropdownDoCount(array $options = []) {
$p['name'] = 'do_count';
$p['value'] = self::COUNT_AUTO;
$p['display'] = true;
if (is_array($options) && count($options)) {
foreach ($options as $key => $val) {
$p[$key] = $val;
}
}
$tab = [self::COUNT_AUTO => __('Auto'),
self::COUNT_YES => __('Yes'),
self::COUNT_NO => __('No')];
return Dropdown::showFromArray($p['name'], $tab, $p);
}
/**
* Set do_count from massive actions
*
* @param array $ids Items IDs
* @param integer $do_count One of self::COUNT_*
*
* @return boolean
*/
public function setDoCount(array $ids, $do_count) {
global $DB;
$result = $DB->update(
$this->getTable(), [
'do_count' => $do_count
], [
'id' => $ids
]
);
return $result;
}
/**
* Set entity and recursivity from massive actions
*
* @param array $ids Items IDs
* @param integer $eid Entityy ID
* @param boolean $recur Recursivity
*
* @return boolean
*/
public function setEntityRecur(array $ids, $eid, $recur) {
global $DB;
$result = $DB->update(
$this->getTable(), [
'entities_id' => $eid,
'is_recursive' => $recur
], [
'id' => $ids
]
);
return $result;
}
/**
* Specific method to add where to a request
*
* @param string $link link string
* @param boolean $nott is it a negative search ?
* @param string $itemtype item type
* @param integer $ID ID of the item to search
* @param string $searchtype searchtype used (equals or contains)
* @param mixed $val item num in the request
* @param integer $meta is a meta search (meta=2 in search.class.php) (default 0)
*
* @return string where clause
*/
public static function addWhere($link, $nott, $itemtype, $ID, $searchtype, $val, $meta = 0) {
if ($ID == 11) { //search for defaults/not defaults
if ($val == 0) {
return "$link glpi_savedsearches_users.users_id IS NULL";
}
return "$link glpi_savedsearches_users.users_id IS NOT NULL";
}
}
static function cronInfo($name) {
switch ($name) {
case 'countAll' :
return ['description' => __('Update all bookmarks execution time')];
}
return [];
}
/**
* Update all bookmarks execution time
*
* @param CronTask $task CronTask instance
*
* @return void
**/
static public function croncountAll($task) {
global $DB, $CFG_GLPI;
$cron_status = 0;
if ($CFG_GLPI['show_count_on_tabs'] != -1) {
$lastdate = new \DateTime($task->getField('lastrun'));
$lastdate->sub(new \DateInterval('P7D'));
$iterator = $DB->request(['FROM' => self::getTable(),
'FIELDS' => ['id', 'query', 'itemtype', 'type'],
'WHERE' => ['last_execution_date'
=> ['<' , $lastdate->format('Y-m-d H:i:s')]]]);
if ($iterator->numrows()) {
//prepare variables we'll use
$self = new self();
$now = date('Y-m-d H:i:s');
$query = $DB->buildUpdate(
self::getTable(), [
'last_execution_time' => new QueryParam(),
'last_execution_date' => new QueryParam()
], [
'id' => new QueryParam()
]
);
$stmt = $DB->prepare($query);
if (!isset($_SESSION['glpiname'])) {
//required from search class
$_SESSION['glpiname'] = 'crontab';
}
if (!isset($_SESSION['glpigroups'])) {
$_SESSION['glpigroups'] = [];
}
$in_transaction = $DB->inTransaction();
if (!$in_transaction) {
$DB->beginTransaction();
}
while ($row = $iterator->next()) {
try {
$self->fields = $row;
if ($data = $self->execute(true)) {
$execution_time = $data['data']['execution_time'];
$stmt->bind_param('sss', $execution_time, $now, $row['id']);
$stmt->execute();
}
} catch (\Exception $e) {
Toolbox::logError($e);
}
}
$stmt->close();
if (!$in_transaction) {
$DB->commit();
}
$cron_status = 1;
}
} else {
Toolbox::logWarning('Count on tabs has been disabled; crontask is inefficient.');
}
return $cron_status;
}
/**
* Execute current saved search and return results
*
* @param boolean $force Force query execution even if it should not be executed
* (default false)
*
* @throws RuntimeException
*
* @return array
**/
public function execute($force = false) {
global $CFG_GLPI;
if (($force === true)
|| (($this->fields['do_count'] == self::COUNT_YES)
|| ($this->fields['do_count'] == self::COUNT_AUTO)
&& ($this->getField('last_execution_time') != null)
&& ($this->fields['last_execution_time'] <= $CFG_GLPI['max_time_for_count']))) {
$search = new Search();
//Do the same as self::getParameters() but getFromDB is useless
$query_tab = [];
parse_str($this->getField('query'), $query_tab);
$params = null;
if (class_exists($this->getField('itemtype'))
|| ($this->getField('itemtype') == 'AllAssets')) {
$params = $this->prepareQueryToUse($this->getField('type'), $query_tab);
}
if (!$params) {
throw new \RuntimeException('Saved search #' . $this->getID() . ' seems to be broken!');
} else {
$data = $search->prepareDatasForSearch($this->getField('itemtype'),
$params);
$data['search']['sort'] = null;
$search->constructSQL($data);
$search->constructData($data, true);
return $data;
}
}
}
/**
* Create specific notification for a public saved search
*
* @return void
*/
public function createNotif() {
$notif = new Notification();
$notif->getFromDBByCrit(['event' => 'alert_' . $this->getID()]);
if ($notif->isNewItem()) {
$notif->check(-1, CREATE);
$notif->add(['name' => SavedSearch::getTypeName(1) . ' ' . $this->getName(),
'entities_id' => $_SESSION["glpidefault_entity"],
'itemtype' => SavedSearch_Alert::getType(),
'event' => 'alert_' . $this->getID(),
'is_active' => 0,
'datate_creation' => date('Y-m-d H:i:s')
]);
Session::addMessageAfterRedirect(__('Notification has been created!'), INFO);
}
}
/**
* Return visibility SQL restriction to add
*
* @return string restrict to add
**/
static function addVisibilityRestrict() {
//not deprecated because used in Search
if (Session::haveRight('config', UPDATE)) {
return '';
}
//get and clean criteria
$criteria = self::getVisibilityCriteria();
unset($criteria['LEFT JOIN']);
$criteria['FROM'] = self::getTable();
$it = new \DBmysqlIterator(null);
$it->buildQuery($criteria);
$sql = $it->getSql();
$sql = preg_replace('/.*WHERE /', '', $sql);
return $sql;
}
/**
* Return visibility joins to add to DBIterator parameters
*
* @since 9.4
*
* @param boolean $forceall force all joins (false by default)
*
* @return array
*/
static public function getVisibilityCriteria(bool $forceall = false): array {
$criteria = ['WHERE' => []];
if (Session::haveRight('config', UPDATE)) {
return $criteria;
}
$restrict = [
self::getTable() . '.is_private' => 1,
self::getTable() . '.users_id' => Session::getLoginUserID()
];
if (Session::haveRight(self::$rightname, READ)) {
$restrict = [
'OR' => [
$restrict,
self::getTable() . '.is_private' => 0
]
];
}
$criteria['WHERE'] = $restrict;
return $criteria;
}
static function getIcon() {
return "far fa-bookmark";
}
}
![\'"](\'{$CFG_GLPI["root_doc"]}/pics/spinner.gif\')
');
});
},
stop: function (event, ui) {
var _ids = $('tr.private').map(function(idx, ele) {
return $(ele).data('id');
}).get();
$.ajax({
url: '{$CFG_GLPI["root_doc"]}/ajax/savedsearch.php?action=reorder',
data: {
ids: _ids
},
beforeSend: function() {
var _img = '