iframe-proxy | Sunbelt Computer Software

796 lines (642 loc) · 23.6 KB
 * -------------------------------------------------------------------------
 * Example plugin for GLPI
 * -------------------------------------------------------------------------
 * This file is part of Example.
 * Example 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.
 * Example 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 Example. If not, see <http://www.gnu.org/licenses/>.
 * -------------------------------------------------------------------------
 * @copyright Copyright (C) 2006-2022 by Example plugin team.
 * @license   GPLv2 https://www.gnu.org/licenses/gpl-2.0.html
 * @link      https://github.com/pluginsGLPI/example
 * -------------------------------------------------------------------------
// ----------------------------------------------------------------------
// Original Author of file:
// Purpose of file:
// ----------------------------------------------------------------------
use GlpiPlugin\Example\Example;
function plugin_change_profile_example()
    // Some logic that runs when the profile is changed
// Define dropdown relations
function plugin_example_getDatabaseRelations()
    return ['glpi_plugin_example_dropdowns' => ['glpi_plugin_example' => 'plugin_example_dropdowns_id']];
// Define Dropdown tables to be manage in GLPI :
function plugin_example_getDropdown()
    // Table => Name
    return [Dropdown::class => __s('Plugin Example Dropdown', 'example')];
////// SEARCH FUNCTIONS ///////(){
// Define Additionnal search options for types (other than the plugin ones)
function plugin_example_getAddSearchOptions($itemtype)
    $sopt = [];
    if ($itemtype == 'Computer') {
        // Just for example, not working...
        $sopt[1001]['table']     = 'glpi_plugin_example_dropdowns';
        $sopt[1001]['field']     = 'name';
        $sopt[1001]['linkfield'] = 'plugin_example_dropdowns_id';
        $sopt[1001]['name']      = __s('Example plugin', 'example');
    return $sopt;
function plugin_example_getAddSearchOptionsNew($itemtype)
    $options = [];
    if ($itemtype == 'Computer') {
        //Just for example, not working
        $options[] = [
            'id'        => '1002',
            'table'     => 'glpi_plugin_example_dropdowns',
            'field'     => 'name',
            'linkfield' => 'plugin_example_dropdowns_id',
            'name'      => __s('Example plugin new', 'example'),
    return $options;
// See also GlpiPlugin\Example\Example::getSpecificValueToDisplay()
function plugin_example_giveItem($type, $ID, $data, $num)
    $searchopt = &Search::getOptions($type);
    $table     = $searchopt[$ID]['table'];
    $field     = $searchopt[$ID]['field'];
    switch ($table . '.' . $field) {
        case 'glpi_plugin_example_examples.name':
            $out = "<a href='" . Toolbox::getItemTypeFormURL(Example::class) . '?id=' . $data['id'] . "'>";
            $out .= $data[$num][0]['name'];
            if ($_SESSION['glpiis_ids_visible'] || empty($data[$num][0]['name'])) {
                $out .= ' (' . $data['id'] . ')';
            $out .= '</a>';
            return $out;
    return '';
function plugin_example_displayConfigItem($type, $ID, $data, $num)
    $searchopt = &Search::getOptions($type);
    $table     = $searchopt[$ID]['table'];
    $field     = $searchopt[$ID]['field'];
    // Example of specific style options
    // No need of the function if you do not have specific cases
    switch ($table . '.' . $field) {
        case 'glpi_plugin_example_examples.name':
            return ' style="background-color:#DDDDDD;" ';
    return '';
function plugin_example_addDefaultJoin($type, $ref_table, &$already_link_tables)
    // Example of default JOIN clause
    // No need of the function if you do not have specific cases
    switch ($type) {
        //       case Example::class :
        case 'MyType':
            return Search::addLeftJoin(
                $type,
                $ref_table,
                $already_link_tables,
                'newtable',
                'linkfield',
    return '';
function plugin_example_addDefaultSelect($type)
    // Example of default SELECT item to be added
    // No need of the function if you do not have specific cases
    switch ($type) {
        //       case Example::class :
        case 'MyType':
            return "`mytable`.`myfield` = 'myvalue' AS MYNAME, ";
    return '';
function plugin_example_addDefaultWhere($type)
    // Example of default WHERE item to be added
    // No need of the function if you do not have specific cases
    switch ($type) {
        //       case Example::class :
        case 'MyType':
            return " `mytable`.`myfield` = 'myvalue' ";
    return '';
function plugin_example_addLeftJoin($type, $ref_table, $new_table, $linkfield)
    // Example of standard LEFT JOIN  clause but use it ONLY for specific LEFT JOIN
    // No need of the function if you do not have specific cases
    switch ($new_table) {
        case 'glpi_plugin_example_dropdowns':
            return " LEFT JOIN `$new_table` ON (`$ref_table`.`$linkfield` = `$new_table`.`id`) ";
    return '';
function plugin_example_forceGroupBy($type)
    switch ($type) {
        case Example::class:
            // Force add GROUP BY IN REQUEST
            return true;
    return false;
function plugin_example_addWhere($link, $nott, $type, $ID, $val, $searchtype)
    $searchopt = &Search::getOptions($type);
    $table     = $searchopt[$ID]['table'];
    $field     = $searchopt[$ID]['field'];
    Search::makeTextSearch($val, $nott);
    // Example of standard Where clause but use it ONLY for specific Where
    // No need of the function if you do not have specific cases
    switch ($table . '.' . $field) {
        /*case "glpi_plugin_example.name" :
          $ADD = "";
          if ($nott && $val!="NULL") {
             $ADD = " OR `$table`.`$field` IS NULL";
          return $link." (`$table`.`$field` $SEARCH ".$ADD." ) ";*/
        case 'glpi_plugin_example_examples.serial':
            return $link . " `$table`.`$field` = '$val' ";
    return '';
// This is not a real example because the use of Having condition in this case is not suitable
function plugin_example_addHaving($link, $nott, $type, $ID, $val, $num)
    $searchopt = &Search::getOptions($type);
    $table     = $searchopt[$ID]['table'];
    $field     = $searchopt[$ID]['field'];
    $SEARCH = Search::makeTextSearch($val, $nott);
    // Example of standard Having clause but use it ONLY for specific Having
    // No need of the function if you do not have specific cases
    switch ($table . '.' . $field) {
        case 'glpi_plugin_example.serial':
            $ADD = '';
            if (($nott && $val != 'NULL')
                || $val == '^$') {
                $ADD = " OR ITEM_$num IS NULL";
            return " $link ( ITEM_" . $num . $SEARCH . " $ADD ) ";
    return '';
function plugin_example_addSelect($type, $ID, $num)
    $searchopt = &Search::getOptions($type);
    // Example of standard Select clause but use it ONLY for specific Select
    // No need of the function if you do not have specific cases
    // switch ($table.".".$field) {
    //    case "glpi_plugin_example.name" :
    //       return $table.".".$field." AS ITEM_$num, ";
    return '';
function plugin_example_addOrderBy($type, $ID, $order, $key = 0)
    $searchopt = &Search::getOptions($type);
    // Example of standard OrderBy clause but use it ONLY for specific order by
    // No need of the function if you do not have specific cases
    // switch ($table.".".$field) {
    //    case "glpi_plugin_example.name" :
    //       return " ORDER BY $table.$field $order ";
    return '';
//////////////////////////////
////// SPECIFIC MODIF MASSIVE FUNCTIONS ///////
// Define actions :
function plugin_example_MassiveActions($type)
    switch ($type) {
        // New action for core and other plugin types : name = plugin_PLUGINNAME_actionname
        case 'Computer':
            return [Example::class . MassiveAction::CLASS_ACTION_SEPARATOR . 'DoIt' => __s('plugin_example_DoIt', 'example')];
            // Actions for types provided by the plugin are included inside the classes
    return [];
// How to display specific update fields ?
// options must contain at least itemtype and options array
function plugin_example_MassiveActionsFieldsDisplay($options = [])
    //$type,$table,$field,$linkfield
    $table     = $options['options']['table'];
    $field     = $options['options']['field'];
    if ($table == getTableForItemType($options['itemtype'])) {
        // Table fields
        switch ($table . '.' . $field) {
            case 'glpi_plugin_example_examples.serial':
                echo __s('Not really specific - Just for example', 'example');
                // Dropdown::showYesNo($linkfield);
                // Need to return true if specific display
                return true;
    } else {
        // Linked Fields
        switch ($table . '.' . $field) {
            case 'glpi_plugin_example_dropdowns.name':
                echo __s('Not really specific - Just for example', 'example');
                // Need to return true if specific display
                return true;
    // Need to return false on non display item
    return false;
// How to display specific search fields or dropdown ?
// options must contain at least itemtype and options array
// MUST Use a specific AddWhere & $tab[X]['searchtype'] = 'equals'; declaration
function plugin_example_searchOptionsValues($options = [])
    $table = $options['searchoption']['table'];
    $field = $options['searchoption']['field'];
    // Table fields
    switch ($table . '.' . $field) {
        case 'glpi_plugin_example_examples.serial':
            echo __s('Not really specific - Use your own dropdown - Just for example', 'example');
            Dropdown::show(
                getItemTypeForTable($options['searchoption']['table']),
                ['value'       => $options['value'],
                    'name'     => $options['name'],
                    'comments' => 0],
            // Need to return true if specific display
            return true;
    return false;
//////////////////////////////
// Hook done on before update item case
function plugin_pre_item_update_example($item)
    /* Manipulate data if needed
    if (!isset($item->input['comment'])) {
       $item->input['comment'] = addslashes($item->fields['comment']);
    $item->input['comment'] .= addslashes("\nUpdate: ".date('r'));
    Session::addMessageAfterRedirect(__s('Pre Update Computer Hook', 'example'), true);
// Hook done on update item case
function plugin_item_update_example($item)
    Session::addMessageAfterRedirect(sprintf(__s('Update Computer Hook (%s)', 'example'), implode(',', $item->updates)), true);
    return true;
// Hook done on get empty item case
function plugin_item_empty_example($item)
    if (empty($_SESSION['Already displayed "Empty Computer Hook"'])) {
        Session::addMessageAfterRedirect(__s('Empty Computer Hook', 'example'), true);
        $_SESSION['Already displayed "Empty Computer Hook"'] = true;
    return true;
// Hook done on before delete item case
function plugin_pre_item_delete_example($object)
    // Manipulate data if needed
    Session::addMessageAfterRedirect(__s('Pre Delete Computer Hook', 'example'), true);
// Hook done on delete item case
function plugin_item_delete_example($object)
    Session::addMessageAfterRedirect(__s('Delete Computer Hook', 'example'), true);
    return true;
// Hook done on before purge item case
function plugin_pre_item_purge_example($object)
    // Manipulate data if needed
    Session::addMessageAfterRedirect(__s('Pre Purge Computer Hook', 'example'), true);
// Hook done on purge item case
function plugin_item_purge_example($object)
    Session::addMessageAfterRedirect(__s('Purge Computer Hook', 'example'), true);
    return true;
// Hook done on before restore item case
function plugin_pre_item_restore_example($item)
    // Manipulate data if needed
    Session::addMessageAfterRedirect(__s('Pre Restore Computer Hook', 'example'));
// Hook done on before restore item case
function plugin_pre_item_restore_example2($item)
    // Manipulate data if needed
    Session::addMessageAfterRedirect(__s('Pre Restore Phone Hook', 'example'));
// Hook done on restore item case
function plugin_item_restore_example($item)
    Session::addMessageAfterRedirect(__s('Restore Computer Hook', 'example'));
    return true;
// Hook done on restore item case
function plugin_item_transfer_example($parm)
    //TRANS: %1$s is the source type, %2$d is the source ID, %3$d is the destination ID
    Session::addMessageAfterRedirect(sprintf(
        __s('Transfer Computer Hook %1$s %2$d -> %3$d', 'example'),
        $parm['type'],
        $parm['id'],
        $parm['newID'],
    return false;
// Do special actions for dynamic report
function plugin_example_dynamicReport($parm)
    if ($parm['item_type'] == Example::class) {
        // Do all what you want for export depending on $parm
        echo 'Personalized export for type ' . $parm['display_type'];
        echo 'with additional datas : <br>';
        echo 'Single data : add1 <br>';
        print $parm['add1'] . '<br>';
        echo 'Array data : add2 <br>';
        Html::printCleanArray($parm['add2']);
        // Return true if personalized display is done
        return true;
    // Return false if no specific display is done, then use standard display
    return false;
// Add parameters to Html::printPager in search system
function plugin_example_addParamFordynamicReport($itemtype)
    if ($itemtype == Example::class) {
        // Return array data containing all params to add : may be single data or array data
        // Search config are available from session variable
        return ['add1' => $_SESSION['glpisearch'][$itemtype]['order'],
            'add2'     => ['tutu' => 'Second Add',
                'Other Data']];
    // Return false or a non array data if not needed
    return false;
 * Plugin install process
 * @return boolean
function plugin_example_install()
    global $DB;
    $migration = new Migration(PLUGIN_EXAMPLE_VERSION);
    Config::setConfigurationValues('plugin:Example', ['configuration' => false]);
    // Adds the right(s) to all pre-existing profiles with no access by default
    ProfileRight::addProfileRights([Example::$rightname]);
    // Grants full access to profiles that can update the Config (super-admins)
    $migration->addRight(Example::$rightname, ALLSTANDARDRIGHT, [Config::$rightname => UPDATE]);
    $default_charset   = DBConnection::getDefaultCharset();
    $default_collation = DBConnection::getDefaultCollation();
    $default_key_sign  = DBConnection::getDefaultPrimaryKeySignOption();
    if (!$DB->tableExists('glpi_plugin_example_examples')) {
        $query = "CREATE TABLE `glpi_plugin_example_examples` (
                  `id` int {$default_key_sign} NOT NULL auto_increment,
                  `name` varchar(255) default NULL,
                  `serial` varchar(255) NOT NULL,
                  `plugin_example_dropdowns_id` int {$default_key_sign} NOT NULL default '0',
                  `is_deleted` tinyint NOT NULL default '0',
                  `is_template` tinyint NOT NULL default '0',
                  `template_name` varchar(255) default NULL,
                PRIMARY KEY (`id`)
               ) ENGINE=InnoDB DEFAULT CHARSET={$default_charset} COLLATE={$default_collation} ROW_FORMAT=DYNAMIC;";
        $DB->doQuery($query);
        $query = "INSERT INTO `glpi_plugin_example_examples`
                       (`id`, `name`, `serial`, `plugin_example_dropdowns_id`, `is_deleted`,
                        `is_template`, `template_name`)
                VALUES (1, 'example 1', 'serial 1', 1, 0, 0, NULL),
                       (2, 'example 2', 'serial 2', 2, 0, 0, NULL),
                       (3, 'example 3', 'serial 3', 1, 0, 0, NULL)";
        $DB->doQuery($query);
    if (!$DB->tableExists('glpi_plugin_example_dropdowns')) {
        $query = "CREATE TABLE `glpi_plugin_example_dropdowns` (
                  `id` int {$default_key_sign} NOT NULL auto_increment,
                  `name` varchar(255) default NULL,
                  `comment` text,
                PRIMARY KEY  (`id`),
                KEY `name` (`name`)
               ) ENGINE=InnoDB DEFAULT CHARSET={$default_charset} COLLATE={$default_collation} ROW_FORMAT=DYNAMIC;";
        $DB->doQuery($query);
        $query = "INSERT INTO `glpi_plugin_example_dropdowns`
                       (`id`, `name`, `comment`)
                VALUES (1, 'dp 1', 'comment 1'),
                       (2, 'dp2', 'comment 2')";
        $DB->doQuery($query);
    if (!$DB->tableExists('glpi_plugin_example_devicecameras')) {
        $query = "CREATE TABLE `glpi_plugin_example_devicecameras` (
                  `id` int {$default_key_sign} NOT NULL AUTO_INCREMENT,
                  `designation` varchar(255) DEFAULT NULL,
                  `comment` text,
                  `manufacturers_id` int {$default_key_sign} NOT NULL DEFAULT '0',
                  PRIMARY KEY (`id`),
                  KEY `designation` (`designation`),
                  KEY `manufacturers_id` (`manufacturers_id`)
               ) ENGINE=InnoDB DEFAULT CHARSET={$default_charset} COLLATE={$default_collation} ROW_FORMAT=DYNAMIC;";
        $DB->doQuery($query);
    if (!$DB->tableExists('glpi_plugin_example_items_devicecameras')) {
        $query = "CREATE TABLE `glpi_plugin_example_items_devicecameras` (
                  `id` int {$default_key_sign} NOT NULL AUTO_INCREMENT,
                  `items_id` int {$default_key_sign} NOT NULL DEFAULT '0',
                  `itemtype` varchar(255) DEFAULT NULL,
                  `plugin_example_devicecameras_id` int {$default_key_sign} NOT NULL DEFAULT '0',
                  `is_deleted` tinyint NOT NULL DEFAULT '0',
                  `is_dynamic` tinyint NOT NULL DEFAULT '0',
                  PRIMARY KEY (`id`),
                  KEY `computers_id` (`items_id`),
                  KEY `plugin_example_devicecameras_id` (`plugin_example_devicecameras_id`),
                  KEY `is_deleted` (`is_deleted`),
                  KEY `is_dynamic` (`is_dynamic`)
               ) ENGINE=InnoDB DEFAULT CHARSET={$default_charset} COLLATE={$default_collation} ROW_FORMAT=DYNAMIC;";
        $DB->doQuery($query);
    // To be called for each task the plugin manage
    // task in class
    CronTask::Register(Example::class, 'Sample', DAY_TIMESTAMP, ['param' => 50]);
    return true;
 * Plugin uninstall process
 * @return boolean
function plugin_example_uninstall()
    global $DB;
    $config = new Config();
    $my_config = array_keys(Config::getConfigurationValues('plugin:Example'));
    $config->deleteConfigurationValues('plugin:Example', $my_config);
    ProfileRight::deleteProfileRights([Example::$rightname]);
    $notif   = new Notification();
    $notif->deleteByCriteria([
        'itemtype' => 'Ticket',
        'event'    => 'plugin_example',
        'FIELDS'   => 'id',
    // Old version tables
    if ($DB->tableExists('glpi_dropdown_plugin_example')) {
        $query = 'DROP TABLE `glpi_dropdown_plugin_example`';
        $DB->doQuery($query);
    if ($DB->tableExists('glpi_plugin_example')) {
        $query = 'DROP TABLE `glpi_plugin_example`';
        $DB->doQuery($query);
    // Current version tables
    if ($DB->tableExists('glpi_plugin_example_example')) {
        $query = 'DROP TABLE `glpi_plugin_example_example`';
        $DB->doQuery($query);
    if ($DB->tableExists('glpi_plugin_example_dropdowns')) {
        $query = 'DROP TABLE `glpi_plugin_example_dropdowns`;';
        $DB->doQuery($query);
    if ($DB->tableExists('glpi_plugin_example_devicecameras')) {
        $query = 'DROP TABLE `glpi_plugin_example_devicecameras`;';
        $DB->doQuery($query);
    if ($DB->tableExists('glpi_plugin_example_items_devicecameras')) {
        $query = 'DROP TABLE `glpi_plugin_example_items_devicecameras`;';
        $DB->doQuery($query);
    if ($DB->tableExists('glpi_plugin_example_examples')) {
        $query = 'DROP TABLE `glpi_plugin_example_examples`;';
        $DB->doQuery($query);
    return true;
function plugin_example_AssignToTicket($types)
    $types[Example::class] = 'Example';
    return $types;
function plugin_example_get_events(NotificationTargetTicket $target)
    $target->events['plugin_example'] = __s('Example event', 'example');
function plugin_example_get_datas(NotificationTargetTicket $target)
    $target->data['##ticket.example##'] = __s('Example datas', 'example');
function plugin_example_postinit()
    global $CFG_GLPI;
    // All plugins are initialized, so all types are registered
    //foreach (Infocom::getItemtypesThatCanHave() as $type) {
    // do something
 * Hook to add more data from ldap
 * fields from plugin_retrieve_more_field_from_ldap_example
 * @param $datas   array
 * @return array
function plugin_retrieve_more_data_from_ldap_example(array $datas)
    return $datas;
 * Hook to add more fields from LDAP
 * @param $fields   array
 * @return array
function plugin_retrieve_more_field_from_ldap_example($fields)
    return $fields;
// Check to add to status page
function plugin_example_Status($param)
    // Do checks (no check for example)
    $ok = true;
    echo 'example plugin: example';
    if ($ok) {
        echo '_OK';
    } else {
        echo '_PROBLEM';
        // Only set ok to false if trouble (global status)
        $param['ok'] = false;
    echo "\n";
    return $param;
function plugin_example_display_central()
    echo "<tr><th colspan='2'>";
    echo "<div style='text-align:center; font-size:2em'>";
    echo __s('Plugin example displays on central page', 'example');
    echo '</div>';
    echo '</th></tr>';
function plugin_example_display_login()
    echo "<div style='text-align:center; font-size:2em'>";
    echo __s('Plugin example displays on login page', 'example');
    echo '</div>';
function plugin_example_infocom_hook($params)
    echo "<tr><th colspan='4'>";
    echo __s('Plugin example displays on central page', 'example');
    echo '</th></tr>';
function plugin_example_filter_actors(array $params = []): array
    $itemtype = $params['params']['itemtype'];
    // remove users_id = 1 for assignee list
    if ($itemtype == 'Ticket' && $params['params']['actortype'] == 'assign') {
        foreach ($params['actors'] as $index => &$actor) {
            if ($actor['type'] == 'user' && $actor['items_id'] == 1) {
                unset($params['actors'][$index]);
    return $params;
function plugin_example_set_impact_icon(array $params)
    /** @var array $CFG_GLPI */
    global $CFG_GLPI;
    $itemtype = $params['itemtype'];
    $items_id = $params['items_id'];
    $item = getItemForItemtype($itemtype);
    if ($item instanceof Computer && $item->getFromDB($items_id)) {
        return $CFG_GLPI['root_doc'] . '/plugins/example/public/computer_icon.svg';
    return null;
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

hook.php

Latest commit

History

hook.php

File metadata and controls
