composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-22 08:42:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

PR review + code cleanup + added usecases and test cover

Browse Source
This commit is contained in:
odain
2025-09-01 21:19:24 +02:00
parent 08c77f8106
commit a587bd68eb
11 changed files with 692 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
tests/php-unit-tests/unitary-tests/setup/modulediscovery/resources/module.combodo-email-synchro.php Normal file
View File

@@ -0,0 +1,123 @@
<?php
SetupWebPage::AddModule(
__FILE__, // Path to the current file, all other file names are relative to the directory containing this file
'combodo-email-synchro/3.8.2',
array(
// Identification
'label' => 'Tickets synchronization via e-mail',
'category' => 'business',
// Setup
'dependencies' => array(
'itop-profiles-itil/3.0.0',
),
'mandatory' => false,
'visible' => true,
'installer' => 'EmailSynchroInstaller',
// Components
'datamodel' => array(
'classes/autoload.php',
'model.combodo-email-synchro.php',
),
'dictionary' => array(),
'data.struct' => array(
),
'data.sample' => array(
),
// Documentation
'doc.manual_setup' => '', // No manual installation required
'doc.more_information' => '', // None
// Default settings
'settings' => array(
'notify_errors_to' => '', // mandatory to track errors not handled by the email processing module
'notify_errors_from' => '', // mandatory as well (can be set at the same value as notify_errors_to)
'debug' => false, // Set to true to turn on debugging
'periodicity' => 30, // interval at which to check for incoming emails (in s)
'retention_period' => 1, // number of hour we keep the replica
'body_parts_order' => 'text/html,text/plain', // Order in which to read the parts of the incoming emails
'pop3_auth_option' => 'USER',
'imap_options' => array('imap'),
'imap_open_options' => array(),
'maximum_email_size' => '10M', // Maximum allowed size for incoming emails
'big_files_dir' => '',
'exclude_attachment_types' => array('application/exe'), // Example: 'application/exe', 'application/x-winexe', 'application/msdos-windows'
// Lines to be removed just above the 'new part' in a reply-to message... add your own patterns below
'introductory-patterns' => array(
'/^le .+ a écrit :$/i', // Thunderbird French
'/^on .+ wrote:$/i', // Thunderbird English
'|^[0-9]{4}/[0-9]{1,2}/[0-9]{1,2} .+:$|', // Gmail style
),
// Some patterns which delimit the previous message in case of a Reply
// The "new" part of the message is the text before the pattern
// Add your own multi-line patterns (use \\R for a line break)
// These patterns depend on the mail client/server used... feel free to add your own discoveries to the list
'multiline-delimiter-patterns' => array(
'/\\RFrom: .+\\RSent: .+\\R/m', // Outlook English
'/\\R_+\\R/m', // A whole line made only of underscore characters
'/\\RDe : .+\\R\\R?Envoyé : /m', // Outlook French, HTML and rich text
'/\\RDe : .+\\RDate d\'envoi : .+\\R/m', // Outlook French, plain text
'/\\R-----Message d\'origine-----\\R/m',
),
'use_message_id_as_uid' => false, // Do NOT change this unless you known what you are doing!!
'images_minimum_size' => '100x20', // Images smaller that these dimensions will be ignored (signatures...)
'images_maximum_size' => '', // Images bigger that these dimensions will be resized before uploading into iTop
'recommended_max_allowed_packet' => 10*1024*1024, // MySQL parameter for attachments
),
)
);
if (!class_exists('EmailSynchroInstaller'))
{
// Module installation handler
//
class EmailSynchroInstaller extends ModuleInstallerAPI
{
/**
* Handler called after the creation/update of the database schema
*
* @param $oConfiguration Config The new configuration of the application
* @param $sPreviousVersion string Previous version number of the module (empty string in case of first install)
* @param $sCurrentVersion string Current version number of the module
*
* @throws \ArchivedObjectException
* @throws \CoreException
* @throws \CoreUnexpectedValue
* @throws \DictExceptionMissingString
* @throws \MySQLException
* @throws \MySQLHasGoneAwayException
*/
public static function AfterDatabaseCreation(Config $oConfiguration, $sPreviousVersion, $sCurrentVersion)
{
// For each email sources, update email replicas by setting mailbox_path to source.mailbox where mailbox_path is null
SetupLog::Info("Updating email replicas to set their mailbox path.");
// Preparing mailboxes search
$oSearch = new DBObjectSearch('MailInboxBase');
// Retrieving definition of attribute to update
$sTableName = MetaModel::DBGetTable('EmailReplica');
$UidlAttDef = MetaModel::GetAttributeDef('EmailReplica', 'uidl');
$sUidlColName = $UidlAttDef->Get('sql');
$oMailboxAttDef = MetaModel::GetAttributeDef('EmailReplica', 'mailbox_path');
$sMailboxColName = $oMailboxAttDef->Get('sql');
$sFrienlynameAttCode = MetaModel::GetFriendlyNameAttributeCode('EmailReplica');
// Looping on inboxes to update
$oSet = new DBObjectSet($oSearch);
while ($oInbox = $oSet->Fetch())
{
$sUpdateQuery = "UPDATE $sTableName SET $sMailboxColName = " . CMDBSource::Quote($oInbox->Get('mailbox')) . " WHERE $sUidlColName LIKE " . CMDBSource::Quote($oInbox->Get('login') . '_%') . " AND $sMailboxColName IS NULL";
SetupLog::Info("Executing query: " . $sUpdateQuery);
$iRet = CMDBSource::Query($sUpdateQuery); // Throws an exception in case of error
SetupLog::Info("Updated $iRet rows.");
}
}
}
}

57
tests/php-unit-tests/unitary-tests/setup/modulediscovery/resources/module.combodo-make-it-vip.php Normal file
View File

@@ -0,0 +1,57 @@
<?php
/**
*
* @copyright Copyright (C) 2010-2019 Combodo SARL
* @license https://www.combodo.com/documentation/combodo-software-license.html
*
*/
//
// iTop module definition file
//
SetupWebPage::AddModule(
__FILE__, // Path to the current file, all other file names are relative to the directory containing this file
'combodo-make-it-vip/1.2.0',
array(
// Identification
//
'label' => 'Flag important contacts in your database and highlight tickets',
'category' => 'business',
// Setup
//
'dependencies' => array(
'itop-config-mgmt/2.0.0'||'itop-structure/3.0.0',
'itop-request-mgmt/2.0.0||itop-request-mgmt-itil/2.0.0||itop-incident-mgmt-itil/2.0.0',
),
'mandatory' => false,
'visible' => true,
// Components
//
'datamodel' => array(
'model.combodo-make-it-vip.php',
'main.combodo-make-it-vip.php',
),
'webservice' => array(
),
'data.struct' => array(
// add your 'structure' definition XML files here,
),
'data.sample' => array(
// add your sample data XML files here,
),
// Documentation
//
'doc.manual_setup' => '', // hyperlink to manual setup documentation, if any
'doc.more_information' => '', // hyperlink to more information, if any
// Default settings
//
'settings' => array(
// Module specific settings go here, if any
),
)
);

51
tests/php-unit-tests/unitary-tests/setup/modulediscovery/resources/module.itop-admin-delegation-profiles-bridge-for-combodo-email-synchro.php Normal file
View File

@@ -0,0 +1,51 @@
<?php
//
// iTop module definition file
//
SetupWebPage::AddModule(
__FILE__, // Path to the current file, all other file names are relative to the directory containing this file
'itop-admin-delegation-profiles-bridge-for-combodo-email-synchro/1.0.0',
array(
// Identification
//
'label' => 'Profiles per admin fonction: Mail inboxes and messages',
'category' => 'Datamodel',
// Setup
//
'dependencies' => array(
'itop-admin-delegation-profiles/1.0.0',
'itop-admin-delegation-profiles/1.0.0 || combodo-email-synchro/3.7.2 || itop-oauth-client/2.7.7', // Optional dependency to silence the setup to not display a warning if the other module is not present
),
'mandatory' => false,
'visible' => false,
'auto_select' => 'SetupInfo::ModuleIsSelected("itop-admin-delegation-profiles") && SetupInfo::ModuleIsSelected("combodo-email-synchro") && SetupInfo::ModuleIsSelected("itop-oauth-client")',
// Components
//
'datamodel' => array(
'model.itop-admin-delegation-profiles-bridge-for-combodo-email-synchro.php'
),
'webservice' => array(
),
'data.struct' => array(
// add your 'structure' definition XML files here,
),
'data.sample' => array(
// add your sample data XML files here,
),
// Documentation
//
'doc.manual_setup' => '', // hyperlink to manual setup documentation, if any
'doc.more_information' => '', // hyperlink to more information, if any
// Default settings
//
'settings' => array(
// Module specific settings go here, if any
),
)
);

52
tests/php-unit-tests/unitary-tests/setup/modulediscovery/resources/module.itop-admin-delegation-profiles.php Normal file
View File

@@ -0,0 +1,52 @@
<?php
//
// iTop module definition file
//
SetupWebPage::AddModule(
__FILE__, // Path to the current file, all other file names are relative to the directory containing this file
'itop-admin-delegation-profiles/1.2.1',
array(
// Identification
//
'label' => 'Profiles per admin fonction',
'category' => 'Datamodel',
// Setup
//
'dependencies' => array(
'itop-config-mgmt/2.7.0' || 'itop-structure/3.0.0',
// itop-profiles-itil is here to ensure that the /itop_design/groups/group[@id="History"] alteration comes after those from that module.
// This allows to define the missing "History" group in iTop 2.7 / 3.0, while merging smoothly with iTop 3.1+
'itop-profiles-itil/2.7.0',
),
'mandatory' => false,
'visible' => true,
// Components
//
'datamodel' => array(
'model.itop-admin-delegation-profiles.php'
),
'webservice' => array(
),
'data.struct' => array(
// add your 'structure' definition XML files here,
),
'data.sample' => array(
// add your sample data XML files here,
),
// Documentation
//
'doc.manual_setup' => '', // hyperlink to manual setup documentation, if any
'doc.more_information' => '', // hyperlink to more information, if any
// Default settings
//
'settings' => array(
// Module specific settings go here, if any
),
)
);

114
tests/php-unit-tests/unitary-tests/setup/modulediscovery/resources/module.itop-global-requests-mgmt.php Normal file
View File

@@ -0,0 +1,114 @@
<?php
/**
* Module itop-global-requests
*
* @copyright Copyright (C) 2012-2019 Combodo SARL
* @license https://www.combodo.com/documentation/combodo-software-license.html
*/
/** @noinspection PhpUnhandledExceptionInspection */
SetupWebPage::AddModule(
__FILE__, // Path to the current file, all other file names are relative to the directory containing this file
'itop-global-requests-mgmt/1.6.3',
array(
// Identification
//
'label' => 'iTop Global Requests Management',
'category' => 'business',
// Setup
//
'dependencies' => array(
'itop-portal-base/3.2.0',
'approval-base/2.5.1',
'combodo-approval-extended/1.2.3',
'itop-config-mgmt/3.2.0',
'itop-tickets/3.2.0',
'combodo-dispatch-userrequest/1.1.4',
'itop-request-mgmt-itil/3.2.0||itop-request-mgmt/3.2.0',
'itop-service-mgmt/3.2.0||itop-service-mgmt-provider/3.2.0',
'itop-request-template/2.0.1',
'itop-request-template-portal/1.0.0',
),
'mandatory' => false,
'visible' => true,
'installer' => GlobalRequestInstaller::class,
// Components
//
'datamodel' => array(
'vendor/autoload.php',
// Explicitly load hooks classes
'src/Hook/GRPopupMenuExtension.php',
// Explicitly load DM classes
'model.itop-global-requests-mgmt.php',
//Needed for symfony dependency injection
'src/Portal/Router/GlobalRequestBrickRouter.php',
),
'webservice' => array(),
'data.struct' => array(// add your 'structure' definition XML files here,
),
'data.sample' => array(// add your sample data XML files here,
),
// Documentation
//
'doc.manual_setup' => '', // hyperlink to manual setup documentation, if any
'doc.more_information' => '', // hyperlink to more information, if any
// Default settings
//
'settings' => array(
'target_state' => 'new',
'bypass_profiles' => 'Administrator, Service Manager',
'reuse_previous_answers' => true,
),
)
);
class GlobalRequestInstaller extends ModuleInstallerAPI
{
/**
* Handler called before creating or upgrading the database schema
*
* @param $oConfiguration Config The new configuration of the application
* @param $sPreviousVersion string Previous version number of the module (empty string in case of first install)
* @param $sCurrentVersion string Current version number of the module
*
* @throws \CoreException
* @throws \MySQLException
* @throws \MySQLHasGoneAwayException
*/
public static function AfterDatabaseCreation(Config $oConfiguration, $sPreviousVersion, $sCurrentVersion)
{
if (strlen($sPreviousVersion) > 0 && version_compare($sPreviousVersion, '1.6.0', '<')) {
$slnkGRTypeToServiceSubcategory = MetaModel::DBGetTable('lnkGRTypeToServiceSubcategory','parent_servicesubcategory_id');
$oAttDefToUpdate = MetaModel::GetAttributeDef('lnkGRTypeToServiceSubcategory', 'parent_servicesubcategory_id');
$aColumnsToUpdate = array_keys($oAttDefToUpdate->GetSQLColumns());
$sColumnToUpdate = $aColumnsToUpdate[0]; // We know that a string has only one column*/
$oAttDefLink = MetaModel::GetAttributeDef('lnkGRTypeToServiceSubcategory', 'servicesubcategory_id');
$aColumnsLink = array_keys($oAttDefLink->GetSQLColumns());
$sColumnLink = $aColumnsLink[0]; // We know that a string has only one column*/
$sTableToRead = MetaModel::DBGetTable('ServiceSubcategory', 'parent_servicesubcategory_id');
$oAttDefToRead = MetaModel::GetAttributeDef('ServiceSubcategory', 'parent_servicesubcategory_id');
$aColumnsToReads = array_keys($oAttDefToRead->GetSQLColumns());
$sColumnToRead = $aColumnsToReads[0]; // We know that a string has only one column
$sTableToReadPrimaryKey = MetaModel::DBGetKey('ServiceSubcategory');
$sQueryUpdate = "
UPDATE `$slnkGRTypeToServiceSubcategory`
JOIN `$sTableToRead`
ON `$slnkGRTypeToServiceSubcategory`.`$sColumnLink` = `$sTableToRead`.`$sTableToReadPrimaryKey`
SET `$slnkGRTypeToServiceSubcategory`.`$sColumnToUpdate` = `$sTableToRead`.`$sColumnToRead`
WHERE `$slnkGRTypeToServiceSubcategory`.`$sColumnToUpdate` = 0 OR `$slnkGRTypeToServiceSubcategory`.`$sColumnToUpdate` IS NULL
";
SetupLog::Info(" GlobalRequestInstaller Query: " . $sQueryUpdate);
CMDBSource::Query($sQueryUpdate);
}
}
}