hook.php

<?php

/**
 * -------------------------------------------------------------------------
 * LICENSE
 *
 * This file is part of Transferticketentity plugin for GLPI.
 *
 * Transferticketentity is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Transferticketentity 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Reports. If not, see <http://www.gnu.org/licenses/>.
 *
 * @author    Yannick Comba, Xavier Caillaud, Infotel
 * @category  Ticket
 * @copyright 2015-2026 Transferticketentity team
 * @license   AGPL License 3.0 or (at your option) any later version
 * @link      https://github.com/pluginsGLPI/transferticketentity/
 * @package   Transferticketentity
 *            https://www.gnu.org/licenses/gpl-3.0.html
 * --------------------------------------------------------------------------
 */

use GlpiPlugin\Transferticketentity\Profile;

/**
 * Install hook
 *
 * @return boolean
 */
function plugin_transferticketentity_install()
{
    global $DB;

    Profile::createFirstAccess($_SESSION["glpiactiveprofile"]["id"]);

    $default_charset = DBConnection::getDefaultCharset();
    $default_collation = DBConnection::getDefaultCollation();
    $default_key_sign = DBConnection::getDefaultPrimaryKeySignOption();

    if (!$DB->TableExists("glpi_plugin_transferticketentity_entities_settings")) {
        $query = "CREATE TABLE `glpi_plugin_transferticketentity_entities_settings` (
            `id` int {$default_key_sign} NOT NULL auto_increment,
            `entities_id` int {$default_key_sign} NOT NULL,
            `allow_entity_only_transfer` BOOLEAN NOT NULL DEFAULT 0,
            `justification_transfer` BOOLEAN NOT NULL DEFAULT 0,
            `allow_transfer` BOOLEAN NOT NULL DEFAULT 0,
            `keep_category` BOOLEAN NOT NULL DEFAULT 0,
            `itilcategories_id` INT {$default_key_sign},
            `log_type` TINYINT NOT NULL DEFAULT 0,
            PRIMARY KEY  (`id`),
            UNIQUE KEY `entities_id` (`entities_id`)
            ) ENGINE=InnoDB DEFAULT CHARSET={$default_charset} COLLATE={$default_collation} ROW_FORMAT=DYNAMIC;";

        $DB->doQuery($query);
    }

    // GLPI does not use real DB-level foreign keys. A FK referencing glpi_entities.id
    // blocks core migrations that run `ALTER TABLE glpi_entities MODIFY id ...`
    // (MySQL error 1833). Drop any leftover FK constraint created by older versions.
    $fk_result = $DB->doQuery(
        "SELECT `CONSTRAINT_NAME` FROM `information_schema`.`KEY_COLUMN_USAGE`
         WHERE `TABLE_SCHEMA` = DATABASE()
           AND `TABLE_NAME` = 'glpi_plugin_transferticketentity_entities_settings'
           AND `REFERENCED_TABLE_NAME` IS NOT NULL",
    );
    // doQuery() throws on failure in GLPI 12, so the result is always a valid set here
    while ($fk_row = $DB->fetchAssoc($fk_result)) {
        $DB->doQuery(
            "ALTER TABLE `glpi_plugin_transferticketentity_entities_settings`
             DROP FOREIGN KEY `{$fk_row['CONSTRAINT_NAME']}`",
        );
    }

    if (!$DB->fieldExists('glpi_plugin_transferticketentity_entities_settings', 'log_type')) {
        $DB->doQuery("ALTER TABLE `glpi_plugin_transferticketentity_entities_settings`
            ADD COLUMN `log_type` TINYINT NOT NULL DEFAULT 0");
    }

    // One settings row per entity: a duplicate made the configuration tab
    // unreachable (getFromDBByCrit() throws) while transfers stayed allowed.
    // Keep the oldest row of each entity, then enforce it with a unique key.
    $settings_table = 'glpi_plugin_transferticketentity_entities_settings';
    $index_result   = $DB->doQuery(
        "SHOW INDEX FROM `{$settings_table}` WHERE `Key_name` = 'entities_id' AND `Non_unique` = 1",
    );
    if ($DB->numrows($index_result) > 0) {
        $seen_entities = [];
        foreach ($DB->request(['FROM' => $settings_table, 'ORDER' => 'id ASC']) as $row) {
            if (isset($seen_entities[$row['entities_id']])) {
                $DB->delete($settings_table, ['id' => $row['id']]);
            } else {
                $seen_entities[$row['entities_id']] = true;
            }
        }
        $DB->doQuery(
            "ALTER TABLE `{$settings_table}` DROP INDEX `entities_id`, ADD UNIQUE KEY `entities_id` (`entities_id`)",
        );
    }

    return true;
}

/**
 * Uninstall hook
 *
 * @return boolean
 */
function plugin_transferticketentity_uninstall()
{
    global $DB;

    // Plugin tables deletion
    $tables = ["glpi_plugin_transferticketentity_entities_settings"];

    foreach ($tables as $table) {
        $DB->dropTable($table);
    }

    //Delete rights associated with the plugin
    $profileRight = new ProfileRight();
    foreach (Profile::getAllRights() as $right) {
        $profileRight->deleteByCriteria(['name' => $right['field']]);
    }
    return true;
}