setup.php

<?php
/*
 * -------------------------------------------------------------------------
Timezones management plugin
Copyright (C) 2015-2016-2017 by Raynet SAS a company of A.Raymond Network.

http://www.araymond.com
-------------------------------------------------------------------------

LICENSE

This file is part of Timezones management plugin for GLPI.

This file 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.

GLPI 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 GLPI. If not, see <http://www.gnu.org/licenses/>.
--------------------------------------------------------------------------
 */

// ----------------------------------------------------------------------
// Original Author of file: Olivier Moron
// Purpose of file: to setup time zone management plugin to GLPI
// ----------------------------------------------------------------------
define ("PLUGIN_TIMEZONES_VERSION", "2.5.2");

/**
 * Summary of plugin_init_timezones
 */
function plugin_init_timezones() {
    global $PLUGIN_HOOKS,$CFG_GLPI;

   Plugin::registerClass('PluginTimezonesUser',
                         ['addtabon'                    => ['Preference', 'User']]);

   // Init session
   $PLUGIN_HOOKS['init_session']['timezones'] = 'plugin_init_session_timezones';

   $PLUGIN_HOOKS['post_init']['timezones'] = 'plugin_timezones_postinit';

   $PLUGIN_HOOKS['pre_item_update']['timezones']
      = [ 'User' => [ 'PluginTimezonesUser', 'preItemUpdate']];

   $PLUGIN_HOOKS['item_update']['timezones']
      = [   'TicketTask' => 'plugin_item_add_update_timezones_tasks',
            'ProblemTask' => 'plugin_item_add_update_timezones_tasks',
            'ProjectTask' => 'plugin_item_add_update_timezones_tasks',
            'ChangeTask' => 'plugin_item_add_update_timezones_tasks',
            'Config' => 'plugin_item_add_update_timezones_dbconnection'
        ];

   $PLUGIN_HOOKS['item_add']['timezones']
      = [   'TicketTask' => 'plugin_item_add_update_timezones_tasks',
            'ProblemTask' => 'plugin_item_add_update_timezones_tasks',
            'ProjectTask' => 'plugin_item_add_update_timezones_tasks',
            'ChangeTask' => 'plugin_item_add_update_timezones_tasks',
            'Config' => 'plugin_item_add_update_timezones_dbconnection'
        ];

   //$tz=(isset($_SESSION['glpitimezone'])?$_SESSION['glpitimezone']:date_default_timezone_get());
   //$PLUGIN_HOOKS['add_javascript']['timezones'] = "js/tz.php?tz=$tz";
   $PLUGIN_HOOKS['add_javascript']['timezones'] = "js/tz.js";

   $PLUGIN_HOOKS['csrf_compliant']['timezones'] = true;

   //$PLUGIN_HOOKS['use_massive_action']['timezones'] = 1;

}

/**
 * Summary of plugin_version_timezones
 * @return string[]
 */
function plugin_version_timezones() {

   return ['name'           => 'Timezones',
                'version'        => PLUGIN_TIMEZONES_VERSION,
                'author'         => 'Olivier Moron',
                'license'        => 'GPLv2+',
                'homepage'       => 'https://github.com/tomolimo/timezones',
                'minGlpiVersion' => '9.3'];
}


/**
 * Summary of plugin_timezones_check_prerequisites
 * @return bool
 */
function plugin_timezones_check_prerequisites() {
    global $DB, $LANG;

    // Strict version check (could be less strict, or could allow various version)
   if (version_compare(GLPI_VERSION, '9.3', 'lt')) {
        echo $LANG['timezones']['glpiversion'];
        return false;
   }

   // check if mySQL time_zones tables are empty
   $query = "SELECT * FROM mysql.time_zone_name";
   $res = $DB->query( $query );
   if ($DB->numrows( $res ) == 0) {
       echo $LANG['timezones']['timezonetables'];
       return false;
   }

   return true;
}


/**
 * Summary of needConvert
 * @return boolean|DBmysqlIterator
 */
function needConvert() {
   global $DB;
   $query = "SELECT  `INFORMATION_SCHEMA`.`COLUMNS`.`COLUMN_NAME` from `INFORMATION_SCHEMA`.`COLUMNS`
            WHERE `INFORMATION_SCHEMA`.`COLUMNS`.TABLE_SCHEMA = '".$DB->dbdefault."' AND `INFORMATION_SCHEMA`.`COLUMNS`.`COLUMN_TYPE` IN ('DATETIME') ;";
   $res = $DB->request( $query );
   if ($res->numrows() > 0) {      
      $query = "SELECT DISTINCT( `INFORMATION_SCHEMA`.`COLUMNS`.`TABLE_NAME` ), TABLE_TYPE from `INFORMATION_SCHEMA`.`COLUMNS`
            JOIN `INFORMATION_SCHEMA`.`TABLES` ON `INFORMATION_SCHEMA`.`TABLES`.`TABLE_NAME` = `INFORMATION_SCHEMA`.`COLUMNS`.`TABLE_NAME` AND `INFORMATION_SCHEMA`.`TABLES`.`TABLE_TYPE` = 'BASE TABLE'
            WHERE `INFORMATION_SCHEMA`.`COLUMNS`.TABLE_SCHEMA = '".$DB->dbdefault."' AND `INFORMATION_SCHEMA`.`COLUMNS`.`COLUMN_TYPE` IN ('DATETIME') ; ";
      $res = $DB->request( $query );
      if ($res->numrows() > 0) {
         return $res;
      }
   }
   return false;
}


/**
 * Summary of plugin_timezones_check_config
 * @param mixed $verbose
 * @return bool
 */
function plugin_timezones_check_config($verbose = false) {
   global $DB, $LANG;

   $plug = new Plugin;
   if ($plug->isActivated('timezones')) {
      // check if all datetime fields of the glpi db have been converted to timestamp otherwise, timezone management can't be done correctly
      if ($res = needConvert()) {
         // will convert during GLPI execution any DATETIME fields that may have been added
         include_once 'hook.php';
         convertDB($verbose, $res);
      }
   }

   return true;
}