require_once(APPROOT.'core/metamodel.class.php');
- */
- static public function GetConfig()
- {
- if (self::$oConfig == null)
- {
- self::$oConfig = MetaModel::GetConfig();
-
- if (self::$oConfig == null)
- {
- $sConfigFile = self::GetConfigFilePath();
- if (!file_exists($sConfigFile))
- {
- $sConfigFile = self::GetConfigFilePath('production');
- if (!file_exists($sConfigFile))
- {
- $sConfigFile = null;
- }
- }
-
- self::$oConfig = new Config($sConfigFile);
- }
- }
- return self::$oConfig;
- }
-
- public static function InitTimeZone() {
- $oConfig = self::GetConfig();
- $sItopTimeZone = $oConfig->Get('timezone');
-
- if (!empty($sItopTimeZone))
- {
- date_default_timezone_set($sItopTimeZone);
- }
- else
- {
- // Leave as is... up to the admin to set a value somewhere...
- // see http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
- }
- }
-
- /**
- * Returns the absolute URL to the application root path
- *
- * @return string The absolute URL to the application root, without the first slash
- *
- * @throws \Exception
- */
- static public function GetAbsoluteUrlAppRoot()
- {
- static $sUrl = null;
- if ($sUrl === null)
- {
- $sUrl = self::GetConfig()->Get('app_root_url');
- if ($sUrl == '')
- {
- $sUrl = self::GetDefaultUrlAppRoot();
- }
- elseif (strpos($sUrl, SERVER_NAME_PLACEHOLDER) > -1)
- {
- if (isset($_SERVER['SERVER_NAME']))
- {
- $sServerName = $_SERVER['SERVER_NAME'];
- }
- else
- {
- // CLI mode ?
- $sServerName = php_uname('n');
- }
- $sUrl = str_replace(SERVER_NAME_PLACEHOLDER, $sServerName, $sUrl);
- }
- }
- return $sUrl;
- }
-
- /**
- * Builds an root url from the server's variables.
- * For most usages, when an root url is needed, use utils::GetAbsoluteUrlAppRoot() instead as uses this only as a fallback when the app_root_url conf parameter is not defined.
- *
- * @return string
- *
- * @throws \Exception
- */
- static public function GetDefaultUrlAppRoot()
- {
- // Build an absolute URL to this page on this server/port
- $sServerName = isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : '';
- $sProtocol = self::IsConnectionSecure() ? 'https' : 'http';
- $iPort = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : 80;
- if ($sProtocol == 'http')
- {
- $sPort = ($iPort == 80) ? '' : ':'.$iPort;
- }
- else
- {
- $sPort = ($iPort == 443) ? '' : ':'.$iPort;
- }
- // $_SERVER['REQUEST_URI'] is empty when running on IIS
- // Let's use Ivan Tcholakov's fix (found on www.dokeos.com)
- if (!empty($_SERVER['REQUEST_URI']))
- {
- $sPath = $_SERVER['REQUEST_URI'];
- }
- else
- {
- $sPath = $_SERVER['SCRIPT_NAME'];
- if (!empty($_SERVER['QUERY_STRING']))
- {
- $sPath .= '?'.$_SERVER['QUERY_STRING'];
- }
- $_SERVER['REQUEST_URI'] = $sPath;
- }
- $sPath = $_SERVER['REQUEST_URI'];
-
- // remove all the parameters from the query string
- $iQuestionMarkPos = strpos($sPath, '?');
- if ($iQuestionMarkPos !== false)
- {
- $sPath = substr($sPath, 0, $iQuestionMarkPos);
- }
- $sAbsoluteUrl = "$sProtocol://{$sServerName}{$sPort}{$sPath}";
-
- $sCurrentScript = realpath($_SERVER['SCRIPT_FILENAME']);
- $sCurrentScript = str_replace('\\', '/', $sCurrentScript); // canonical path
- $sAppRoot = str_replace('\\', '/', APPROOT); // canonical path
- $sCurrentRelativePath = str_replace($sAppRoot, '', $sCurrentScript);
-
- $sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath);
- if ($sAppRootPos !== false)
- {
- $sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path
- }
- else
- {
- // Second attempt without index.php at the end...
- $sCurrentRelativePath = str_replace('index.php', '', $sCurrentRelativePath);
- $sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath);
- if ($sAppRootPos !== false)
- {
- $sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path
- }
- else
- {
- // No luck...
- throw new Exception("Failed to determine application root path $sAbsoluteUrl ($sCurrentRelativePath) APPROOT:'$sAppRoot'");
- }
- }
- return $sAppRootUrl;
- }
-
- /**
- * Helper to handle the variety of HTTP servers
- * See #286 (fixed in [896]), and #634 (this fix)
- *
- * Though the official specs says 'a non empty string', some servers like IIS do set it to 'off' !
- * nginx set it to an empty string
- * Others might leave it unset (no array entry)
- */
- static public function IsConnectionSecure()
- {
- $bSecured = false;
-
- if (!empty($_SERVER['HTTPS']) && (strtolower($_SERVER['HTTPS']) != 'off'))
- {
- $bSecured = true;
- }
- return $bSecured;
- }
-
- /**
- * Tells whether or not log off operation is supported.
- * Actually in only one case:
- * 1) iTop is using an internal authentication
- * 2) the user did not log-in using the "basic" mode (i.e basic authentication) or by passing credentials in the URL
- * @return boolean True if logoff is supported, false otherwise
- */
- static function CanLogOff()
- {
- $bResult = false;
- if(isset($_SESSION['login_mode']))
- {
- $sLoginMode = $_SESSION['login_mode'];
- switch($sLoginMode)
- {
- case 'external':
- $bResult = false;
- break;
-
- case 'form':
- case 'basic':
- case 'url':
- case 'cas':
- default:
- $bResult = true;
-
- }
- }
- return $bResult;
- }
-
- /**
- * Initializes the CAS client
- */
- static function InitCASClient()
- {
- $sCASIncludePath = self::GetConfig()->Get('cas_include_path');
- include_once($sCASIncludePath.'/CAS.php');
-
- $bCASDebug = self::GetConfig()->Get('cas_debug');
- if ($bCASDebug)
- {
- phpCAS::setDebug(APPROOT.'log/error.log');
- }
-
- if (!self::$m_bCASClient)
- {
- // Initialize phpCAS
- $sCASVersion = self::GetConfig()->Get('cas_version');
- $sCASHost = self::GetConfig()->Get('cas_host');
- $iCASPort = self::GetConfig()->Get('cas_port');
- $sCASContext = self::GetConfig()->Get('cas_context');
- phpCAS::client($sCASVersion, $sCASHost, $iCASPort, $sCASContext, false /* session already started */);
- self::$m_bCASClient = true;
- $sCASCACertPath = self::GetConfig()->Get('cas_server_ca_cert_path');
- if (empty($sCASCACertPath))
- {
- // If no certificate authority is provided, do not attempt to validate
- // the server's certificate
- // THIS SETTING IS NOT RECOMMENDED FOR PRODUCTION.
- // VALIDATING THE CAS SERVER IS CRUCIAL TO THE SECURITY OF THE CAS PROTOCOL!
- phpCAS::setNoCasServerValidation();
- }
- else
- {
- phpCAS::setCasServerCACert($sCASCACertPath);
- }
- }
- }
-
- static function DebugBacktrace($iLimit = 5)
- {
- $aFullTrace = debug_backtrace();
- $aLightTrace = array();
- for($i=1; ($i<=$iLimit && $i < count($aFullTrace)); $i++) // Skip the last function call... which is the call to this function !
- {
- $aLightTrace[$i] = $aFullTrace[$i]['function'].'(), called from line '.$aFullTrace[$i]['line'].' in '.$aFullTrace[$i]['file'];
- }
- echo "".print_r($aLightTrace, true)."\n"; - } - - /** - * Execute the given iTop PHP script, passing it the current credentials - * Only CLI mode is supported, because of the need to hand the credentials over to the next process - * Throws an exception if the execution fails or could not be attempted (config issue) - * @param string $sScript Name and relative path to the file (relative to the iTop root dir) - * @param hash $aArguments Associative array of 'arg' => 'value' - * @return array(iCode, array(output lines)) - */ - /** - */ - static function ExecITopScript($sScriptName, $aArguments) - { - $aDisabled = explode(', ', ini_get('disable_functions')); - if (in_array('exec', $aDisabled)) - { - throw new Exception("The PHP exec() function has been disabled on this server"); - } - - $sPHPExec = trim(self::GetConfig()->Get('php_path')); - if (strlen($sPHPExec) == 0) - { - throw new Exception("The path to php must not be empty. Please set a value for 'php_path' in your configuration file."); - } - - $sAuthUser = self::ReadParam('auth_user', '', 'raw_data'); - $sAuthPwd = self::ReadParam('auth_pwd', '', 'raw_data'); - $sParamFile = self::GetParamSourceFile('auth_user'); - if (is_null($sParamFile)) - { - $aArguments['auth_user'] = $sAuthUser; - $aArguments['auth_pwd'] = $sAuthPwd; - } - else - { - $aArguments['param_file'] = $sParamFile; - } - - $aArgs = array(); - foreach($aArguments as $sName => $value) - { - // Note: See comment from the 23-Apr-2004 03:30 in the PHP documentation - // It suggests to rely on pctnl_* function instead of using escapeshellargs - $aArgs[] = "--$sName=".escapeshellarg($value); - } - $sArgs = implode(' ', $aArgs); - - $sScript = realpath(APPROOT.$sScriptName); - if (!file_exists($sScript)) - { - throw new Exception("Could not find the script file '$sScriptName' from the directory '".APPROOT."'"); - } - - $sCommand = '"'.$sPHPExec.'" '.escapeshellarg($sScript).' -- '.$sArgs; - - if (version_compare(phpversion(), '5.3.0', '<')) - { - if (substr(PHP_OS,0,3) == 'WIN') - { - // Under Windows, and for PHP 5.2.x, the whole command has to be quoted - // Cf PHP doc: http://php.net/manual/fr/function.exec.php, comment from the 27-Dec-2010 - $sCommand = '"'.$sCommand.'"'; - } - } - - $sLastLine = exec($sCommand, $aOutput, $iRes); - if ($iRes == 1) - { - throw new Exception(Dict::S('Core:ExecProcess:Code1')." - ".$sCommand); - } - elseif ($iRes == 255) - { - $sErrors = implode("\n", $aOutput); - throw new Exception(Dict::S('Core:ExecProcess:Code255')." - ".$sCommand.":\n".$sErrors); - } - - //$aOutput[] = $sCommand; - return array($iRes, $aOutput); - } - - /** - * Get the current environment - */ - public static function GetCurrentEnvironment() - { - if (isset($_SESSION['itop_env'])) - { - return $_SESSION['itop_env']; - } - else - { - return ITOP_DEFAULT_ENV; - } - } - - /** - * Returns a path to a folder into which any module can store cache data - * The corresponding folder is created or cleaned upon code compilation - * @return string - */ - public static function GetCachePath() - { - return APPROOT.'data/cache-'.MetaModel::GetEnvironment().'/'; - } - /** - * Merge standard menu items with plugin provided menus items - */ - public static function GetPopupMenuItems($oPage, $iMenuId, $param, &$aActions, $sTableId = null, $sDataTableId = null) - { - // 1st - add standard built-in menu items - // - switch($iMenuId) - { - case iPopupMenuExtension::MENU_OBJLIST_TOOLKIT: - // $param is a DBObjectSet - $oAppContext = new ApplicationContext(); - $sContext = $oAppContext->GetForLink(); - $sDataTableId = is_null($sDataTableId) ? '' : $sDataTableId; - $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($param->GetFilter()->GetClass()); - $sOQL = addslashes($param->GetFilter()->ToOQL(true)); - $sFilter = urlencode($param->GetFilter()->serialize()); - $sUrl = utils::GetAbsoluteUrlAppRoot()."pages/$sUIPage?operation=search&filter=".$sFilter."&{$sContext}"; - $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js'); - $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js'); - $oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css'); - - $aResult = array( - new SeparatorPopupMenuItem(), - // Static menus: Email this page, CSV Export & Add to Dashboard - new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook - ); - - if (UserRights::IsActionAllowed($param->GetFilter()->GetClass(), UR_ACTION_BULK_READ, $param) != UR_ALLOWED_NO) - { - // Bulk export actions - $aResult[] = new JSPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), "ExportListDlg('$sOQL', '$sDataTableId', 'csv', ".json_encode(Dict::S('UI:Menu:CSVExport')).")"); - $aResult[] = new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '$sDataTableId', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"); - if (extension_loaded('gd')) - { - // PDF export requires GD - $aResult[] = new JSPopupMenuItem('UI:Menu:ExportPDF', Dict::S('UI:Menu:ExportPDF'), "ExportListDlg('$sOQL', '$sDataTableId', 'pdf', ".json_encode(Dict::S('UI:Menu:ExportPDF')).")"); - } - } - $aResult[] = new JSPopupMenuItem('UI:Menu:AddToDashboard', Dict::S('UI:Menu:AddToDashboard'), "DashletCreationDlg('$sOQL', '$sContext')"); - $aResult[] = new JSPopupMenuItem('UI:Menu:ShortcutList', Dict::S('UI:Menu:ShortcutList'), "ShortcutListDlg('$sOQL', '$sDataTableId', '$sContext')"); - - break; - - case iPopupMenuExtension::MENU_OBJDETAILS_ACTIONS: - // $param is a DBObject - $oObj = $param; - $sOQL = "SELECT ".get_class($oObj)." WHERE id=".$oObj->GetKey(); - $oFilter = DBObjectSearch::FromOQL($sOQL); - $sFilter = $oFilter->serialize(); - $sUrl = ApplicationContext::MakeObjectUrl(get_class($oObj), $oObj->GetKey()); - $sUIPage = cmdbAbstractObject::ComputeStandardUIPage(get_class($oObj)); - $oAppContext = new ApplicationContext(); - $sContext = $oAppContext->GetForLink(); - $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js'); - $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js'); - $oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css'); - $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js'); - $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js'); - $oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css'); - - $aResult = array( - new SeparatorPopupMenuItem(), - // Static menus: Email this page & CSV Export - new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?subject=".urlencode($oObj->GetRawName())."&body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook - new JSPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), "ExportListDlg('$sOQL', '', 'csv', ".json_encode(Dict::S('UI:Menu:CSVExport')).")"), - new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"), - new SeparatorPopupMenuItem(), - new URLPopupMenuItem('UI:Menu:PrintableVersion', Dict::S('UI:Menu:PrintableVersion'), $sUrl.'&printable=1', '_blank'), - ); - break; - - case iPopupMenuExtension::MENU_DASHBOARD_ACTIONS: - // $param is a Dashboard - $oAppContext = new ApplicationContext(); - $aParams = $oAppContext->GetAsHash(); - $sMenuId = ApplicationMenu::GetActiveNodeId(); - $sDlgTitle = addslashes(Dict::S('UI:ImportDashboardTitle')); - $sDlgText = addslashes(Dict::S('UI:ImportDashboardText')); - $sCloseBtn = addslashes(Dict::S('UI:Button:Cancel')); - $aResult = array( - new SeparatorPopupMenuItem(), - new URLPopupMenuItem('UI:ExportDashboard', Dict::S('UI:ExportDashBoard'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=export_dashboard&id='.$sMenuId), - new JSPopupMenuItem('UI:ImportDashboard', Dict::S('UI:ImportDashBoard'), "UploadDashboard({dashboard_id: '$sMenuId', title: '$sDlgTitle', text: '$sDlgText', close_btn: '$sCloseBtn' })"), - ); - break; - - default: - // Unknown type of menu, do nothing - $aResult = array(); - } - foreach($aResult as $oMenuItem) - { - $aActions[$oMenuItem->GetUID()] = $oMenuItem->GetMenuItem(); - } - - // Invoke the plugins - // - foreach (MetaModel::EnumPlugins('iPopupMenuExtension') as $oExtensionInstance) - { - if (is_object($param) && !($param instanceof DBObject)) - { - $tmpParam = clone $param; // In case the parameter is an DBObjectSet, clone it to prevent alterations - } - else - { - $tmpParam = $param; - } - foreach($oExtensionInstance->EnumItems($iMenuId, $tmpParam) as $oMenuItem) - { - if (is_object($oMenuItem)) - { - $aActions[$oMenuItem->GetUID()] = $oMenuItem->GetMenuItem(); - - foreach($oMenuItem->GetLinkedScripts() as $sLinkedScript) - { - $oPage->add_linked_script($sLinkedScript); - } - } - } - } - } - /** - * Get target configuration file name (including full path) - */ - public static function GetConfigFilePath($sEnvironment = null) - { - if (is_null($sEnvironment)) - { - $sEnvironment = self::GetCurrentEnvironment(); - } - return APPCONF.$sEnvironment.'/'.ITOP_CONFIG_FILE; - } - - /** - * @return string the absolute URL to the modules root path - */ - static public function GetAbsoluteUrlModulesRoot() - { - $sUrl = self::GetAbsoluteUrlAppRoot().'env-'.self::GetCurrentEnvironment().'/'; - return $sUrl; - } - - /** - * To be compatible with this mechanism, the called page must include approot with an absolute path OR not include - * it at all (losing the direct access to the page) : - * - * ```php - * if (!defined('__DIR__')) define('__DIR__', dirname(__FILE__)); - * require_once(__DIR__.'/../../approot.inc.php'); - * ``` - * - * @param string $sModule - * @param string $sPage - * @param string[] $aArguments - * @param string $sEnvironment - * - * @return string the URL to a page that will execute the requested module page, with query string values url encoded - * - * @see GetExecPageArguments can be used to submit using the GET method (see bug in N.1108) - * @see GetAbsoluteUrlExecPage - */ - static public function GetAbsoluteUrlModulePage($sModule, $sPage, $aArguments = array(), $sEnvironment = null) - { - $aArgs = self::GetExecPageArguments($sModule, $sPage, $aArguments, $sEnvironment); - $sArgs = http_build_query($aArgs); - - return self::GetAbsoluteUrlExecPage()."?".$sArgs; - } - - /** - * @param string $sModule - * @param string $sPage - * @param string[] $aArguments - * @param string $sEnvironment - * - * @return string[] key/value pair for the exec page query string. Warning : values are not url encoded ! - * @throws \Exception if one of the argument has a reserved name - */ - static public function GetExecPageArguments($sModule, $sPage, $aArguments = array(), $sEnvironment = null) - { - $sEnvironment = is_null($sEnvironment) ? self::GetCurrentEnvironment() : $sEnvironment; - $aArgs = array(); - $aArgs['exec_module'] = $sModule; - $aArgs['exec_page'] = $sPage; - $aArgs['exec_env'] = $sEnvironment; - foreach($aArguments as $sName => $sValue) - { - if (($sName == 'exec_module') || ($sName == 'exec_page') || ($sName == 'exec_env')) - { - throw new Exception("Module page: $sName is a reserved page argument name"); - } - $aArgs[$sName] = $sValue; - } - - return $aArgs; - } - - /** - * @return string - */ - static public function GetAbsoluteUrlExecPage() - { - return self::GetAbsoluteUrlAppRoot().'pages/exec.php'; - } - - /** - * Returns a name unique amongst the given list - * @param string $sProposed The default value - * @param array $aExisting An array of existing values (strings) - */ - static public function MakeUniqueName($sProposed, $aExisting) - { - if (in_array($sProposed, $aExisting)) - { - $i = 1; - while (in_array($sProposed.$i, $aExisting) && ($i < 50)) - { - $i++; - } - return $sProposed.$i; - } - else - { - return $sProposed; - } - } - - /** - * Some characters cause troubles with jQuery when used inside DOM IDs, so let's replace them by the safe _ (underscore) - * @param string $sId The ID to sanitize - * @return string The sanitized ID - */ - static public function GetSafeId($sId) - { - return str_replace(array(':', '[', ']', '+', '-'), '_', $sId); - } - - /** - * Helper to execute an HTTP POST request - * Source: http://netevil.org/blog/2006/nov/http-post-from-php-without-curl - * originaly named after do_post_request - * Does not require cUrl but requires openssl for performing https POSTs. - * - * @param string $sUrl The URL to POST the data to - * @param hash $aData The data to POST as an array('param_name' => value) - * @param string $sOptionnalHeaders Additional HTTP headers as a string with newlines between headers - * @param hash $aResponseHeaders An array to be filled with reponse headers: WARNING: the actual content of the array depends on the library used: cURL or fopen, test with both !! See: http://fr.php.net/manual/en/function.curl-getinfo.php - * @param hash $aCurlOptions An (optional) array of options to pass to curl_init. The format is 'option_code' => 'value'. These values have precedence over the default ones. Example: CURLOPT_SSLVERSION => CURL_SSLVERSION_SSLv3 - * @return string The result of the POST request - * @throws Exception - */ - static public function DoPostRequest($sUrl, $aData, $sOptionnalHeaders = null, &$aResponseHeaders = null, $aCurlOptions = array()) - { - // $sOptionnalHeaders is a string containing additional HTTP headers that you would like to send in your request. - - if (function_exists('curl_init')) - { - // If cURL is available, let's use it, since it provides a greater control over the various HTTP/SSL options - // For instance fopen does not allow to work around the bug: http://stackoverflow.com/questions/18191672/php-curl-ssl-routinesssl23-get-server-helloreason1112 - // by setting the SSLVERSION to 3 as done below. - $aHeaders = explode("\n", $sOptionnalHeaders); - $aHTTPHeaders = array(); - foreach($aHeaders as $sHeaderString) - { - if(preg_match('/^([^:]): (.+)$/', $sHeaderString, $aMatches)) - { - $aHTTPHeaders[$aMatches[1]] = $aMatches[2]; - } - } - // Default options, can be overloaded/extended with the 4th parameter of this method, see above $aCurlOptions - $aOptions = array( - CURLOPT_RETURNTRANSFER => true, // return the content of the request - CURLOPT_HEADER => false, // don't return the headers in the output - CURLOPT_FOLLOWLOCATION => true, // follow redirects - CURLOPT_ENCODING => "", // handle all encodings - CURLOPT_USERAGENT => "spider", // who am i - CURLOPT_AUTOREFERER => true, // set referer on redirect - CURLOPT_CONNECTTIMEOUT => 120, // timeout on connect - CURLOPT_TIMEOUT => 120, // timeout on response - CURLOPT_MAXREDIRS => 10, // stop after 10 redirects - CURLOPT_SSL_VERIFYPEER => false, // Disabled SSL Cert checks - // SSLV3 (CURL_SSLVERSION_SSLv3 = 3) is now considered as obsolete/dangerous: http://disablessl3.com/#why - // but it used to be a MUST to prevent a strange SSL error: http://stackoverflow.com/questions/18191672/php-curl-ssl-routinesssl23-get-server-helloreason1112 - // CURLOPT_SSLVERSION => 3, - CURLOPT_POST => count($aData), - CURLOPT_POSTFIELDS => http_build_query($aData), - CURLOPT_HTTPHEADER => $aHTTPHeaders, - ); - - $aAllOptions = $aCurlOptions + $aOptions; - $ch = curl_init($sUrl); - curl_setopt_array($ch, $aAllOptions); - $response = curl_exec($ch); - $iErr = curl_errno($ch); - $sErrMsg = curl_error( $ch ); - $aHeaders = curl_getinfo( $ch ); - if ($iErr !== 0) - { - throw new Exception("Problem opening URL: $sUrl, $sErrMsg"); - } - if (is_array($aResponseHeaders)) - { - $aHeaders = curl_getinfo($ch); - foreach($aHeaders as $sCode => $sValue) - { - $sName = str_replace(' ' , '-', ucwords(str_replace('_', ' ', $sCode))); // Transform "content_type" into "Content-Type" - $aResponseHeaders[$sName] = $sValue; - } - } - curl_close( $ch ); - } - else - { - // cURL is not available let's try with streams and fopen... - - $sData = http_build_query($aData); - $aParams = array('http' => array( - 'method' => 'POST', - 'content' => $sData, - 'header'=> "Content-type: application/x-www-form-urlencoded\r\nContent-Length: ".strlen($sData)."\r\n", - )); - if ($sOptionnalHeaders !== null) - { - $aParams['http']['header'] .= $sOptionnalHeaders; - } - $ctx = stream_context_create($aParams); - - $fp = @fopen($sUrl, 'rb', false, $ctx); - if (!$fp) - { - global $php_errormsg; - if (isset($php_errormsg)) - { - throw new Exception("Wrong URL: $sUrl, $php_errormsg"); - } - elseif ((strtolower(substr($sUrl, 0, 5)) == 'https') && !extension_loaded('openssl')) - { - throw new Exception("Cannot connect to $sUrl: missing module 'openssl'"); - } - else - { - throw new Exception("Wrong URL: $sUrl"); - } - } - $response = @stream_get_contents($fp); - if ($response === false) - { - throw new Exception("Problem reading data from $sUrl, $php_errormsg"); - } - if (is_array($aResponseHeaders)) - { - $aMeta = stream_get_meta_data($fp); - $aHeaders = $aMeta['wrapper_data']; - foreach($aHeaders as $sHeaderString) - { - if(preg_match('/^([^:]+): (.+)$/', $sHeaderString, $aMatches)) - { - $aResponseHeaders[$aMatches[1]] = trim($aMatches[2]); - } - } - } - } - return $response; - } - - /** - * Get a standard list of character sets - * - * @param array $aAdditionalEncodings Additional values - * @return array of iconv code => english label, sorted by label - */ - public static function GetPossibleEncodings($aAdditionalEncodings = array()) - { - // Encodings supported: - // ICONV_CODE => Display Name - // Each iconv installation supports different encodings - // Some reasonably common and useful encodings are listed here - $aPossibleEncodings = array( - 'UTF-8' => 'Unicode (UTF-8)', - 'ISO-8859-1' => 'Western (ISO-8859-1)', - 'WINDOWS-1251' => 'Cyrilic (Windows 1251)', - 'WINDOWS-1252' => 'Western (Windows 1252)', - 'ISO-8859-15' => 'Western (ISO-8859-15)', - ); - $aPossibleEncodings = array_merge($aPossibleEncodings, $aAdditionalEncodings); - asort($aPossibleEncodings); - return $aPossibleEncodings; - } - - /** - * Convert a string containing some (valid) HTML markup to plain text - * @param string $sHtml - * @return string - */ - public static function HtmlToText($sHtml) - { - try - { - //return ''.$sHtml; - return \Html2Text\Html2Text::convert(''.$sHtml); - } - catch(Exception $e) - { - return $e->getMessage(); - } - } - - /** - * Convert (?) plain text to some HTML markup by replacing newlines by
require_once(APPROOT.'core/metamodel.class.php');
+ */
+ static public function GetConfig()
+ {
+ if (self::$oConfig == null)
+ {
+ self::$oConfig = MetaModel::GetConfig();
+
+ if (self::$oConfig == null)
+ {
+ $sConfigFile = self::GetConfigFilePath();
+ if (!file_exists($sConfigFile))
+ {
+ $sConfigFile = self::GetConfigFilePath('production');
+ if (!file_exists($sConfigFile))
+ {
+ $sConfigFile = null;
+ }
+ }
+
+ self::$oConfig = new Config($sConfigFile);
+ }
+ }
+ return self::$oConfig;
+ }
+
+ public static function InitTimeZone() {
+ $oConfig = self::GetConfig();
+ $sItopTimeZone = $oConfig->Get('timezone');
+
+ if (!empty($sItopTimeZone))
+ {
+ date_default_timezone_set($sItopTimeZone);
+ }
+ else
+ {
+ // Leave as is... up to the admin to set a value somewhere...
+ // see http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
+ }
+ }
+
+ /**
+ * Returns the absolute URL to the application root path
+ *
+ * @return string The absolute URL to the application root, without the first slash
+ *
+ * @throws \Exception
+ */
+ static public function GetAbsoluteUrlAppRoot()
+ {
+ static $sUrl = null;
+ if ($sUrl === null)
+ {
+ $sUrl = self::GetConfig()->Get('app_root_url');
+ if ($sUrl == '')
+ {
+ $sUrl = self::GetDefaultUrlAppRoot();
+ }
+ elseif (strpos($sUrl, SERVER_NAME_PLACEHOLDER) > -1)
+ {
+ if (isset($_SERVER['SERVER_NAME']))
+ {
+ $sServerName = $_SERVER['SERVER_NAME'];
+ }
+ else
+ {
+ // CLI mode ?
+ $sServerName = php_uname('n');
+ }
+ $sUrl = str_replace(SERVER_NAME_PLACEHOLDER, $sServerName, $sUrl);
+ }
+ }
+ return $sUrl;
+ }
+
+ /**
+ * Builds an root url from the server's variables.
+ * For most usages, when an root url is needed, use utils::GetAbsoluteUrlAppRoot() instead as uses this only as a fallback when the app_root_url conf parameter is not defined.
+ *
+ * @return string
+ *
+ * @throws \Exception
+ */
+ static public function GetDefaultUrlAppRoot()
+ {
+ // Build an absolute URL to this page on this server/port
+ $sServerName = isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : '';
+ $sProtocol = self::IsConnectionSecure() ? 'https' : 'http';
+ $iPort = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : 80;
+ if ($sProtocol == 'http')
+ {
+ $sPort = ($iPort == 80) ? '' : ':'.$iPort;
+ }
+ else
+ {
+ $sPort = ($iPort == 443) ? '' : ':'.$iPort;
+ }
+ // $_SERVER['REQUEST_URI'] is empty when running on IIS
+ // Let's use Ivan Tcholakov's fix (found on www.dokeos.com)
+ if (!empty($_SERVER['REQUEST_URI']))
+ {
+ $sPath = $_SERVER['REQUEST_URI'];
+ }
+ else
+ {
+ $sPath = $_SERVER['SCRIPT_NAME'];
+ if (!empty($_SERVER['QUERY_STRING']))
+ {
+ $sPath .= '?'.$_SERVER['QUERY_STRING'];
+ }
+ $_SERVER['REQUEST_URI'] = $sPath;
+ }
+ $sPath = $_SERVER['REQUEST_URI'];
+
+ // remove all the parameters from the query string
+ $iQuestionMarkPos = strpos($sPath, '?');
+ if ($iQuestionMarkPos !== false)
+ {
+ $sPath = substr($sPath, 0, $iQuestionMarkPos);
+ }
+ $sAbsoluteUrl = "$sProtocol://{$sServerName}{$sPort}{$sPath}";
+
+ $sCurrentScript = realpath($_SERVER['SCRIPT_FILENAME']);
+ $sCurrentScript = str_replace('\\', '/', $sCurrentScript); // canonical path
+ $sAppRoot = str_replace('\\', '/', APPROOT); // canonical path
+ $sCurrentRelativePath = str_replace($sAppRoot, '', $sCurrentScript);
+
+ $sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath);
+ if ($sAppRootPos !== false)
+ {
+ $sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path
+ }
+ else
+ {
+ // Second attempt without index.php at the end...
+ $sCurrentRelativePath = str_replace('index.php', '', $sCurrentRelativePath);
+ $sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath);
+ if ($sAppRootPos !== false)
+ {
+ $sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path
+ }
+ else
+ {
+ // No luck...
+ throw new Exception("Failed to determine application root path $sAbsoluteUrl ($sCurrentRelativePath) APPROOT:'$sAppRoot'");
+ }
+ }
+ return $sAppRootUrl;
+ }
+
+ /**
+ * Helper to handle the variety of HTTP servers
+ * See #286 (fixed in [896]), and #634 (this fix)
+ *
+ * Though the official specs says 'a non empty string', some servers like IIS do set it to 'off' !
+ * nginx set it to an empty string
+ * Others might leave it unset (no array entry)
+ */
+ static public function IsConnectionSecure()
+ {
+ $bSecured = false;
+
+ if (!empty($_SERVER['HTTPS']) && (strtolower($_SERVER['HTTPS']) != 'off'))
+ {
+ $bSecured = true;
+ }
+ return $bSecured;
+ }
+
+ /**
+ * Tells whether or not log off operation is supported.
+ * Actually in only one case:
+ * 1) iTop is using an internal authentication
+ * 2) the user did not log-in using the "basic" mode (i.e basic authentication) or by passing credentials in the URL
+ * @return boolean True if logoff is supported, false otherwise
+ */
+ static function CanLogOff()
+ {
+ $bResult = false;
+ if(isset($_SESSION['login_mode']))
+ {
+ $sLoginMode = $_SESSION['login_mode'];
+ switch($sLoginMode)
+ {
+ case 'external':
+ $bResult = false;
+ break;
+
+ case 'form':
+ case 'basic':
+ case 'url':
+ case 'cas':
+ default:
+ $bResult = true;
+
+ }
+ }
+ return $bResult;
+ }
+
+ /**
+ * Initializes the CAS client
+ */
+ static function InitCASClient()
+ {
+ $sCASIncludePath = self::GetConfig()->Get('cas_include_path');
+ include_once($sCASIncludePath.'/CAS.php');
+
+ $bCASDebug = self::GetConfig()->Get('cas_debug');
+ if ($bCASDebug)
+ {
+ phpCAS::setDebug(APPROOT.'log/error.log');
+ }
+
+ if (!self::$m_bCASClient)
+ {
+ // Initialize phpCAS
+ $sCASVersion = self::GetConfig()->Get('cas_version');
+ $sCASHost = self::GetConfig()->Get('cas_host');
+ $iCASPort = self::GetConfig()->Get('cas_port');
+ $sCASContext = self::GetConfig()->Get('cas_context');
+ phpCAS::client($sCASVersion, $sCASHost, $iCASPort, $sCASContext, false /* session already started */);
+ self::$m_bCASClient = true;
+ $sCASCACertPath = self::GetConfig()->Get('cas_server_ca_cert_path');
+ if (empty($sCASCACertPath))
+ {
+ // If no certificate authority is provided, do not attempt to validate
+ // the server's certificate
+ // THIS SETTING IS NOT RECOMMENDED FOR PRODUCTION.
+ // VALIDATING THE CAS SERVER IS CRUCIAL TO THE SECURITY OF THE CAS PROTOCOL!
+ phpCAS::setNoCasServerValidation();
+ }
+ else
+ {
+ phpCAS::setCasServerCACert($sCASCACertPath);
+ }
+ }
+ }
+
+ static function DebugBacktrace($iLimit = 5)
+ {
+ $aFullTrace = debug_backtrace();
+ $aLightTrace = array();
+ for($i=1; ($i<=$iLimit && $i < count($aFullTrace)); $i++) // Skip the last function call... which is the call to this function !
+ {
+ $aLightTrace[$i] = $aFullTrace[$i]['function'].'(), called from line '.$aFullTrace[$i]['line'].' in '.$aFullTrace[$i]['file'];
+ }
+ echo "".print_r($aLightTrace, true)."\n"; + } + + /** + * Execute the given iTop PHP script, passing it the current credentials + * Only CLI mode is supported, because of the need to hand the credentials over to the next process + * Throws an exception if the execution fails or could not be attempted (config issue) + * @param string $sScript Name and relative path to the file (relative to the iTop root dir) + * @param hash $aArguments Associative array of 'arg' => 'value' + * @return array(iCode, array(output lines)) + */ + /** + */ + static function ExecITopScript($sScriptName, $aArguments) + { + $aDisabled = explode(', ', ini_get('disable_functions')); + if (in_array('exec', $aDisabled)) + { + throw new Exception("The PHP exec() function has been disabled on this server"); + } + + $sPHPExec = trim(self::GetConfig()->Get('php_path')); + if (strlen($sPHPExec) == 0) + { + throw new Exception("The path to php must not be empty. Please set a value for 'php_path' in your configuration file."); + } + + $sAuthUser = self::ReadParam('auth_user', '', 'raw_data'); + $sAuthPwd = self::ReadParam('auth_pwd', '', 'raw_data'); + $sParamFile = self::GetParamSourceFile('auth_user'); + if (is_null($sParamFile)) + { + $aArguments['auth_user'] = $sAuthUser; + $aArguments['auth_pwd'] = $sAuthPwd; + } + else + { + $aArguments['param_file'] = $sParamFile; + } + + $aArgs = array(); + foreach($aArguments as $sName => $value) + { + // Note: See comment from the 23-Apr-2004 03:30 in the PHP documentation + // It suggests to rely on pctnl_* function instead of using escapeshellargs + $aArgs[] = "--$sName=".escapeshellarg($value); + } + $sArgs = implode(' ', $aArgs); + + $sScript = realpath(APPROOT.$sScriptName); + if (!file_exists($sScript)) + { + throw new Exception("Could not find the script file '$sScriptName' from the directory '".APPROOT."'"); + } + + $sCommand = '"'.$sPHPExec.'" '.escapeshellarg($sScript).' -- '.$sArgs; + + if (version_compare(phpversion(), '5.3.0', '<')) + { + if (substr(PHP_OS,0,3) == 'WIN') + { + // Under Windows, and for PHP 5.2.x, the whole command has to be quoted + // Cf PHP doc: http://php.net/manual/fr/function.exec.php, comment from the 27-Dec-2010 + $sCommand = '"'.$sCommand.'"'; + } + } + + $sLastLine = exec($sCommand, $aOutput, $iRes); + if ($iRes == 1) + { + throw new Exception(Dict::S('Core:ExecProcess:Code1')." - ".$sCommand); + } + elseif ($iRes == 255) + { + $sErrors = implode("\n", $aOutput); + throw new Exception(Dict::S('Core:ExecProcess:Code255')." - ".$sCommand.":\n".$sErrors); + } + + //$aOutput[] = $sCommand; + return array($iRes, $aOutput); + } + + /** + * Get the current environment + */ + public static function GetCurrentEnvironment() + { + if (isset($_SESSION['itop_env'])) + { + return $_SESSION['itop_env']; + } + else + { + return ITOP_DEFAULT_ENV; + } + } + + /** + * Returns a path to a folder into which any module can store cache data + * The corresponding folder is created or cleaned upon code compilation + * @return string + */ + public static function GetCachePath() + { + return APPROOT.'data/cache-'.MetaModel::GetEnvironment().'/'; + } + /** + * Merge standard menu items with plugin provided menus items + */ + public static function GetPopupMenuItems($oPage, $iMenuId, $param, &$aActions, $sTableId = null, $sDataTableId = null) + { + // 1st - add standard built-in menu items + // + switch($iMenuId) + { + case iPopupMenuExtension::MENU_OBJLIST_TOOLKIT: + // $param is a DBObjectSet + $oAppContext = new ApplicationContext(); + $sContext = $oAppContext->GetForLink(); + $sDataTableId = is_null($sDataTableId) ? '' : $sDataTableId; + $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($param->GetFilter()->GetClass()); + $sOQL = addslashes($param->GetFilter()->ToOQL(true)); + $sFilter = urlencode($param->GetFilter()->serialize()); + $sUrl = utils::GetAbsoluteUrlAppRoot()."pages/$sUIPage?operation=search&filter=".$sFilter."&{$sContext}"; + $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js'); + $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js'); + $oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css'); + + $aResult = array( + new SeparatorPopupMenuItem(), + // Static menus: Email this page, CSV Export & Add to Dashboard + new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook + ); + + if (UserRights::IsActionAllowed($param->GetFilter()->GetClass(), UR_ACTION_BULK_READ, $param) != UR_ALLOWED_NO) + { + // Bulk export actions + $aResult[] = new JSPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), "ExportListDlg('$sOQL', '$sDataTableId', 'csv', ".json_encode(Dict::S('UI:Menu:CSVExport')).")"); + $aResult[] = new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '$sDataTableId', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"); + if (extension_loaded('gd')) + { + // PDF export requires GD + $aResult[] = new JSPopupMenuItem('UI:Menu:ExportPDF', Dict::S('UI:Menu:ExportPDF'), "ExportListDlg('$sOQL', '$sDataTableId', 'pdf', ".json_encode(Dict::S('UI:Menu:ExportPDF')).")"); + } + } + $aResult[] = new JSPopupMenuItem('UI:Menu:AddToDashboard', Dict::S('UI:Menu:AddToDashboard'), "DashletCreationDlg('$sOQL', '$sContext')"); + $aResult[] = new JSPopupMenuItem('UI:Menu:ShortcutList', Dict::S('UI:Menu:ShortcutList'), "ShortcutListDlg('$sOQL', '$sDataTableId', '$sContext')"); + + break; + + case iPopupMenuExtension::MENU_OBJDETAILS_ACTIONS: + // $param is a DBObject + $oObj = $param; + $sOQL = "SELECT ".get_class($oObj)." WHERE id=".$oObj->GetKey(); + $oFilter = DBObjectSearch::FromOQL($sOQL); + $sFilter = $oFilter->serialize(); + $sUrl = ApplicationContext::MakeObjectUrl(get_class($oObj), $oObj->GetKey()); + $sUIPage = cmdbAbstractObject::ComputeStandardUIPage(get_class($oObj)); + $oAppContext = new ApplicationContext(); + $sContext = $oAppContext->GetForLink(); + $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js'); + $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js'); + $oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css'); + $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js'); + $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js'); + $oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css'); + + $aResult = array( + new SeparatorPopupMenuItem(), + // Static menus: Email this page & CSV Export + new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?subject=".urlencode($oObj->GetRawName())."&body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook + new JSPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), "ExportListDlg('$sOQL', '', 'csv', ".json_encode(Dict::S('UI:Menu:CSVExport')).")"), + new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"), + new SeparatorPopupMenuItem(), + new URLPopupMenuItem('UI:Menu:PrintableVersion', Dict::S('UI:Menu:PrintableVersion'), $sUrl.'&printable=1', '_blank'), + ); + break; + + case iPopupMenuExtension::MENU_DASHBOARD_ACTIONS: + // $param is a Dashboard + $oAppContext = new ApplicationContext(); + $aParams = $oAppContext->GetAsHash(); + $sMenuId = ApplicationMenu::GetActiveNodeId(); + $sDlgTitle = addslashes(Dict::S('UI:ImportDashboardTitle')); + $sDlgText = addslashes(Dict::S('UI:ImportDashboardText')); + $sCloseBtn = addslashes(Dict::S('UI:Button:Cancel')); + $aResult = array( + new SeparatorPopupMenuItem(), + new URLPopupMenuItem('UI:ExportDashboard', Dict::S('UI:ExportDashBoard'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=export_dashboard&id='.$sMenuId), + new JSPopupMenuItem('UI:ImportDashboard', Dict::S('UI:ImportDashBoard'), "UploadDashboard({dashboard_id: '$sMenuId', title: '$sDlgTitle', text: '$sDlgText', close_btn: '$sCloseBtn' })"), + ); + break; + + default: + // Unknown type of menu, do nothing + $aResult = array(); + } + foreach($aResult as $oMenuItem) + { + $aActions[$oMenuItem->GetUID()] = $oMenuItem->GetMenuItem(); + } + + // Invoke the plugins + // + foreach (MetaModel::EnumPlugins('iPopupMenuExtension') as $oExtensionInstance) + { + if (is_object($param) && !($param instanceof DBObject)) + { + $tmpParam = clone $param; // In case the parameter is an DBObjectSet, clone it to prevent alterations + } + else + { + $tmpParam = $param; + } + foreach($oExtensionInstance->EnumItems($iMenuId, $tmpParam) as $oMenuItem) + { + if (is_object($oMenuItem)) + { + $aActions[$oMenuItem->GetUID()] = $oMenuItem->GetMenuItem(); + + foreach($oMenuItem->GetLinkedScripts() as $sLinkedScript) + { + $oPage->add_linked_script($sLinkedScript); + } + } + } + } + } + /** + * Get target configuration file name (including full path) + */ + public static function GetConfigFilePath($sEnvironment = null) + { + if (is_null($sEnvironment)) + { + $sEnvironment = self::GetCurrentEnvironment(); + } + return APPCONF.$sEnvironment.'/'.ITOP_CONFIG_FILE; + } + + /** + * @return string the absolute URL to the modules root path + */ + static public function GetAbsoluteUrlModulesRoot() + { + $sUrl = self::GetAbsoluteUrlAppRoot().'env-'.self::GetCurrentEnvironment().'/'; + return $sUrl; + } + + /** + * To be compatible with this mechanism, the called page must include approot with an absolute path OR not include + * it at all (losing the direct access to the page) : + * + * ```php + * if (!defined('__DIR__')) define('__DIR__', dirname(__FILE__)); + * require_once(__DIR__.'/../../approot.inc.php'); + * ``` + * + * @param string $sModule + * @param string $sPage + * @param string[] $aArguments + * @param string $sEnvironment + * + * @return string the URL to a page that will execute the requested module page, with query string values url encoded + * + * @see GetExecPageArguments can be used to submit using the GET method (see bug in N.1108) + * @see GetAbsoluteUrlExecPage + */ + static public function GetAbsoluteUrlModulePage($sModule, $sPage, $aArguments = array(), $sEnvironment = null) + { + $aArgs = self::GetExecPageArguments($sModule, $sPage, $aArguments, $sEnvironment); + $sArgs = http_build_query($aArgs); + + return self::GetAbsoluteUrlExecPage()."?".$sArgs; + } + + /** + * @param string $sModule + * @param string $sPage + * @param string[] $aArguments + * @param string $sEnvironment + * + * @return string[] key/value pair for the exec page query string. Warning : values are not url encoded ! + * @throws \Exception if one of the argument has a reserved name + */ + static public function GetExecPageArguments($sModule, $sPage, $aArguments = array(), $sEnvironment = null) + { + $sEnvironment = is_null($sEnvironment) ? self::GetCurrentEnvironment() : $sEnvironment; + $aArgs = array(); + $aArgs['exec_module'] = $sModule; + $aArgs['exec_page'] = $sPage; + $aArgs['exec_env'] = $sEnvironment; + foreach($aArguments as $sName => $sValue) + { + if (($sName == 'exec_module') || ($sName == 'exec_page') || ($sName == 'exec_env')) + { + throw new Exception("Module page: $sName is a reserved page argument name"); + } + $aArgs[$sName] = $sValue; + } + + return $aArgs; + } + + /** + * @return string + */ + static public function GetAbsoluteUrlExecPage() + { + return self::GetAbsoluteUrlAppRoot().'pages/exec.php'; + } + + /** + * Returns a name unique amongst the given list + * @param string $sProposed The default value + * @param array $aExisting An array of existing values (strings) + */ + static public function MakeUniqueName($sProposed, $aExisting) + { + if (in_array($sProposed, $aExisting)) + { + $i = 1; + while (in_array($sProposed.$i, $aExisting) && ($i < 50)) + { + $i++; + } + return $sProposed.$i; + } + else + { + return $sProposed; + } + } + + /** + * Some characters cause troubles with jQuery when used inside DOM IDs, so let's replace them by the safe _ (underscore) + * @param string $sId The ID to sanitize + * @return string The sanitized ID + */ + static public function GetSafeId($sId) + { + return str_replace(array(':', '[', ']', '+', '-'), '_', $sId); + } + + /** + * Helper to execute an HTTP POST request + * Source: http://netevil.org/blog/2006/nov/http-post-from-php-without-curl + * originaly named after do_post_request + * Does not require cUrl but requires openssl for performing https POSTs. + * + * @param string $sUrl The URL to POST the data to + * @param hash $aData The data to POST as an array('param_name' => value) + * @param string $sOptionnalHeaders Additional HTTP headers as a string with newlines between headers + * @param hash $aResponseHeaders An array to be filled with reponse headers: WARNING: the actual content of the array depends on the library used: cURL or fopen, test with both !! See: http://fr.php.net/manual/en/function.curl-getinfo.php + * @param hash $aCurlOptions An (optional) array of options to pass to curl_init. The format is 'option_code' => 'value'. These values have precedence over the default ones. Example: CURLOPT_SSLVERSION => CURL_SSLVERSION_SSLv3 + * @return string The result of the POST request + * @throws Exception + */ + static public function DoPostRequest($sUrl, $aData, $sOptionnalHeaders = null, &$aResponseHeaders = null, $aCurlOptions = array()) + { + // $sOptionnalHeaders is a string containing additional HTTP headers that you would like to send in your request. + + if (function_exists('curl_init')) + { + // If cURL is available, let's use it, since it provides a greater control over the various HTTP/SSL options + // For instance fopen does not allow to work around the bug: http://stackoverflow.com/questions/18191672/php-curl-ssl-routinesssl23-get-server-helloreason1112 + // by setting the SSLVERSION to 3 as done below. + $aHeaders = explode("\n", $sOptionnalHeaders); + $aHTTPHeaders = array(); + foreach($aHeaders as $sHeaderString) + { + if(preg_match('/^([^:]): (.+)$/', $sHeaderString, $aMatches)) + { + $aHTTPHeaders[$aMatches[1]] = $aMatches[2]; + } + } + // Default options, can be overloaded/extended with the 4th parameter of this method, see above $aCurlOptions + $aOptions = array( + CURLOPT_RETURNTRANSFER => true, // return the content of the request + CURLOPT_HEADER => false, // don't return the headers in the output + CURLOPT_FOLLOWLOCATION => true, // follow redirects + CURLOPT_ENCODING => "", // handle all encodings + CURLOPT_USERAGENT => "spider", // who am i + CURLOPT_AUTOREFERER => true, // set referer on redirect + CURLOPT_CONNECTTIMEOUT => 120, // timeout on connect + CURLOPT_TIMEOUT => 120, // timeout on response + CURLOPT_MAXREDIRS => 10, // stop after 10 redirects + CURLOPT_SSL_VERIFYPEER => false, // Disabled SSL Cert checks + // SSLV3 (CURL_SSLVERSION_SSLv3 = 3) is now considered as obsolete/dangerous: http://disablessl3.com/#why + // but it used to be a MUST to prevent a strange SSL error: http://stackoverflow.com/questions/18191672/php-curl-ssl-routinesssl23-get-server-helloreason1112 + // CURLOPT_SSLVERSION => 3, + CURLOPT_POST => count($aData), + CURLOPT_POSTFIELDS => http_build_query($aData), + CURLOPT_HTTPHEADER => $aHTTPHeaders, + ); + + $aAllOptions = $aCurlOptions + $aOptions; + $ch = curl_init($sUrl); + curl_setopt_array($ch, $aAllOptions); + $response = curl_exec($ch); + $iErr = curl_errno($ch); + $sErrMsg = curl_error( $ch ); + $aHeaders = curl_getinfo( $ch ); + if ($iErr !== 0) + { + throw new Exception("Problem opening URL: $sUrl, $sErrMsg"); + } + if (is_array($aResponseHeaders)) + { + $aHeaders = curl_getinfo($ch); + foreach($aHeaders as $sCode => $sValue) + { + $sName = str_replace(' ' , '-', ucwords(str_replace('_', ' ', $sCode))); // Transform "content_type" into "Content-Type" + $aResponseHeaders[$sName] = $sValue; + } + } + curl_close( $ch ); + } + else + { + // cURL is not available let's try with streams and fopen... + + $sData = http_build_query($aData); + $aParams = array('http' => array( + 'method' => 'POST', + 'content' => $sData, + 'header'=> "Content-type: application/x-www-form-urlencoded\r\nContent-Length: ".strlen($sData)."\r\n", + )); + if ($sOptionnalHeaders !== null) + { + $aParams['http']['header'] .= $sOptionnalHeaders; + } + $ctx = stream_context_create($aParams); + + $fp = @fopen($sUrl, 'rb', false, $ctx); + if (!$fp) + { + global $php_errormsg; + if (isset($php_errormsg)) + { + throw new Exception("Wrong URL: $sUrl, $php_errormsg"); + } + elseif ((strtolower(substr($sUrl, 0, 5)) == 'https') && !extension_loaded('openssl')) + { + throw new Exception("Cannot connect to $sUrl: missing module 'openssl'"); + } + else + { + throw new Exception("Wrong URL: $sUrl"); + } + } + $response = @stream_get_contents($fp); + if ($response === false) + { + throw new Exception("Problem reading data from $sUrl, $php_errormsg"); + } + if (is_array($aResponseHeaders)) + { + $aMeta = stream_get_meta_data($fp); + $aHeaders = $aMeta['wrapper_data']; + foreach($aHeaders as $sHeaderString) + { + if(preg_match('/^([^:]+): (.+)$/', $sHeaderString, $aMatches)) + { + $aResponseHeaders[$aMatches[1]] = trim($aMatches[2]); + } + } + } + } + return $response; + } + + /** + * Get a standard list of character sets + * + * @param array $aAdditionalEncodings Additional values + * @return array of iconv code => english label, sorted by label + */ + public static function GetPossibleEncodings($aAdditionalEncodings = array()) + { + // Encodings supported: + // ICONV_CODE => Display Name + // Each iconv installation supports different encodings + // Some reasonably common and useful encodings are listed here + $aPossibleEncodings = array( + 'UTF-8' => 'Unicode (UTF-8)', + 'ISO-8859-1' => 'Western (ISO-8859-1)', + 'WINDOWS-1251' => 'Cyrilic (Windows 1251)', + 'WINDOWS-1252' => 'Western (Windows 1252)', + 'ISO-8859-15' => 'Western (ISO-8859-15)', + ); + $aPossibleEncodings = array_merge($aPossibleEncodings, $aAdditionalEncodings); + asort($aPossibleEncodings); + return $aPossibleEncodings; + } + + /** + * Convert a string containing some (valid) HTML markup to plain text + * @param string $sHtml + * @return string + */ + public static function HtmlToText($sHtml) + { + try + { + //return ''.$sHtml; + return \Html2Text\Html2Text::convert(''.$sHtml); + } + catch(Exception $e) + { + return $e->getMessage(); + } + } + + /** + * Convert (?) plain text to some HTML markup by replacing newlines by
An error happened while processing the installation:
\n"; - echo ''.$e."
\n"; - SetupPage::log_error("An error happened while processing the installation: ".$e); -} - -if (function_exists('memory_get_peak_usage')) -{ - if ($sOperation == 'file') - { - SetupPage::log_info("loading file '$sFileName', peak memory usage. ".memory_get_peak_usage()); - } - else - { - SetupPage::log_info("operation '$sOperation', peak memory usage. ".memory_get_peak_usage()); - } -} + + + +/** + * Does load data from XML files (currently used in the setup only) + * + * @copyright Copyright (C) 2010-2018 Combodo SARL + * @license http://opensource.org/licenses/AGPL-3.0 + */ + +/** + * This page is called to perform "asynchronously" the setup actions + * parameters + * 'operation': one of 'compile_data_model', 'update_db_schema', 'after_db_creation', 'file' + * + * if 'operation' == 'update_db_schema': + * 'mode': install | upgrade + * + * if 'operation' == 'after_db_creation': + * 'mode': install | upgrade + * + * if 'operation' == 'file': + * 'file': string Name of the file to load + * 'session_status': string 'start', 'continue' or 'end' + * 'percent': integer 0..100 the percentage of completion once the file has been loaded + */ +define('SAFE_MINIMUM_MEMORY', 64*1024*1024); +require_once('../approot.inc.php'); +require_once(APPROOT.'/application/utils.inc.php'); +require_once(APPROOT.'/setup/setuppage.class.inc.php'); +require_once(APPROOT.'/setup/moduleinstaller.class.inc.php'); + +ini_set('max_execution_time', max(3600, ini_get('max_execution_time'))); // Under Windows SQL/backup operations are part of the timeout and require extra time +date_default_timezone_set('Europe/Paris'); // Just to avoid a warning if the timezone is not set in php.ini + +$sMemoryLimit = trim(ini_get('memory_limit')); +if (empty($sMemoryLimit)) +{ + // On some PHP installations, memory_limit does not exist as a PHP setting! + // (encountered on a 5.2.0 under Windows) + // In that case, ini_set will not work, let's keep track of this and proceed with the data load + SetupPage::log_info("No memory limit has been defined in this instance of PHP"); +} +else +{ + // Check that the limit will allow us to load the data + // + $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit); + if (!utils::IsMemoryLimitOk($iMemoryLimit, SAFE_MINIMUM_MEMORY)) + { + if (ini_set('memory_limit', SAFE_MINIMUM_MEMORY) === FALSE) + { + SetupPage::log_error("memory_limit is too small: $iMemoryLimit and can not be increased by the script itself."); + } + else + { + SetupPage::log_info("memory_limit increased from $iMemoryLimit to ".SAFE_MINIMUM_MEMORY."."); + } + } +} + + +define('PHP_FATAL_ERROR_TAG', 'phpfatalerror'); + + +/** + * Handler for register_shutdown_function, to catch PHP errors + */ +function ShutdownCallback() +{ + $error = error_get_last(); + $bIsErrorToReport = (($error !== null) && ($error['type'] & (E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR))); + if (!$bIsErrorToReport) + { + return; + } + + $errno = $error["type"]; + $errfile = $error["file"]; + $errline = $error["line"]; + $errstr = $error["message"]; + $sLogMessage = "PHP error occured : msg=$errstr, no=$errno, file=$errfile, line=$errline"; + SetupPage::log_error("Setup error: $sLogMessage"); + echo '<'.PHP_FATAL_ERROR_TAG.'>'.$sLogMessage.''; +} + + +function FatalErrorCatcher($sOutput) +{ + if (preg_match('|<'.PHP_FATAL_ERROR_TAG.'>.*|s', $sOutput, $aMatches)) + { + header("HTTP/1.0 500 Internal server error."); + $errors = ''; + foreach ($aMatches as $sMatch) + { + $errors .= strip_tags($sMatch)."\n"; + } + $sOutput = "$errors\n"; + // Logging to a file does not work if the whole memory is exhausted... + //SetupPage::log_error("Fatal error - in $__FILE__ , $errors"); + } + return $sOutput; +} + +//Define some bogus, invalid HTML tags that no sane +//person would ever put in an actual document and tell +//PHP to delimit fatal error warnings with them. +ini_set('error_prepend_string', '<'.PHP_FATAL_ERROR_TAG.'>'); +ini_set('error_append_string', ''); + +// callback on errors to log +register_shutdown_function('ShutdownCallback'); +// Starts the capture of the ouput, and sets a filter to capture the fatal errors. +ob_start('FatalErrorCatcher'); // Start capturing the output, and pass it through the fatal error catcher + +require_once(APPROOT.'/core/config.class.inc.php'); +require_once(APPROOT.'/core/log.class.inc.php'); +require_once(APPROOT.'/core/kpi.class.inc.php'); +require_once(APPROOT.'/core/cmdbsource.class.inc.php'); +require_once('./xmldataloader.class.inc.php'); +require_once(APPROOT.'/application/ajaxwebpage.class.inc.php'); + + +// Never cache this page +header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 +header("Expires: Fri, 17 Jul 1970 05:00:00 GMT"); // Date in the past + +/** + * Main program + */ +$sOperation = Utils::ReadParam('operation', ''); +try +{ + switch($sOperation) + { + case 'async_action': + ini_set('max_execution_time', max(240, ini_get('max_execution_time'))); + // While running the setup it is desirable to see any error that may happen + ini_set('display_errors', true); + ini_set('display_startup_errors', true); + + require_once(APPROOT.'/setup/wizardcontroller.class.inc.php'); + require_once(APPROOT.'/setup/wizardsteps.class.inc.php'); + + $sClass = utils::ReadParam('step_class', ''); + $sState = utils::ReadParam('step_state', ''); + $sActionCode = utils::ReadParam('code', ''); + $aParams = utils::ReadParam('params', array(), false, 'raw_data'); + $oPage = new ajax_page(''); + $oDummyController = new WizardController(''); + if (is_subclass_of($sClass, 'WizardStep')) + { + /** @var WizardStep $oStep */ + $oStep = new $sClass($oDummyController, $sState); + $sConfigFile = utils::GetConfigFilePath(); + if (file_exists($sConfigFile) && !is_writable($sConfigFile) && $oStep->RequiresWritableConfig()) + { + $oPage->error("Error: the configuration file '".$sConfigFile."' already exists and cannot be overwritten."); + $oPage->p("The wizard cannot modify the configuration file for you. If you want to upgrade ".ITOP_APPLICATION.", make sure that the file '".realpath($sConfigFile)."' can be modified by the web server."); + $oPage->output(); + } + else + { + $oStep->AsyncAction($oPage, $sActionCode, $aParams); + } + } + $oPage->output(); + break; + + default: + throw(new Exception("Error unsupported operation '$sOperation'")); + } +} +catch(Exception $e) +{ + header("HTTP/1.0 500 Internal server error."); + echo "An error happened while processing the installation:
\n"; + echo ''.$e."
\n"; + SetupPage::log_error("An error happened while processing the installation: ".$e); +} + +if (function_exists('memory_get_peak_usage')) +{ + if ($sOperation == 'file') + { + SetupPage::log_info("loading file '$sFileName', peak memory usage. ".memory_get_peak_usage()); + } + else + { + SetupPage::log_info("operation '$sOperation', peak memory usage. ".memory_get_peak_usage()); + } +} \ No newline at end of file diff --git a/setup/setuputils.class.inc.php b/setup/setuputils.class.inc.php index 4753d5082..24e02582f 100644 --- a/setup/setuputils.class.inc.php +++ b/setup/setuputils.class.inc.php @@ -274,7 +274,7 @@ class SetupUtils // Check that the limit will allow us to load the data // $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit); - if ($iMemoryLimit < self::MIN_MEMORY_LIMIT) + if (!utils::IsMemoryLimitOk($iMemoryLimit, self::MIN_MEMORY_LIMIT)) { $aResult[] = new CheckResult(CheckResult::ERROR, "memory_limit ($iMemoryLimit) is too small, the minimum value to run the application is ".self::MIN_MEMORY_LIMIT."."); } diff --git a/test/application/UtilsTest.php b/test/application/UtilsTest.php new file mode 100644 index 000000000..af35b8386 --- /dev/null +++ b/test/application/UtilsTest.php @@ -0,0 +1,53 @@ + + * + */ + +class UtilsTest extends \Combodo\iTop\Test\UnitTest\ItopTestCase +{ + public function setUp() + { + parent::setUp(); + require_once(APPROOT . 'application/utils.inc.php'); + } + + /** + * @dataProvider memoryLimitDataProvider + */ + public function testIsMemoryLimit($expected, $memoryLimit, $requiredMemory) + { + $this->assertSame($expected, utils::IsMemoryLimitOk($memoryLimit, $requiredMemory)); + } + + /** + * DataProvider for testIsMemoryLimitOk + * + * @return array + */ + public function memoryLimitDataProvider() + { + return [ + [true, '-1', 1024], + [true, -1, 1024], + [true, 1024, 1024], + [true, 2048, 1024], + [false, 1024, 2048], + ]; + } +} \ No newline at end of file diff --git a/test/application/search/CriterionConversionTest.php b/test/application/search/CriterionConversionTest.php index ccda37dfe..0805c1b9a 100644 --- a/test/application/search/CriterionConversionTest.php +++ b/test/application/search/CriterionConversionTest.php @@ -412,6 +412,11 @@ class CriterionConversionTest extends ItopDataTestCase 'ExpectedOQL' => "SELECT `Contact` FROM Contact AS `Contact` JOIN Organization AS `Organization` ON `Contact`.org_id = `Organization`.id JOIN Organization AS `Organization1` ON `Organization`.parent_id BELOW `Organization1`.id WHERE (`Organization1`.`id` = '1')", 'ExpectedCriterion' => array(array('widget' => 'hierarchical_key', 'operator' => 'IN')), ), + 'key IN 2' => array( + 'OQL' => "SELECT Contact WHERE org_id IN ('1', '999999')", + 'ExpectedOQL' => "SELECT `Contact` FROM Contact AS `Contact` JOIN Organization AS `Organization` ON `Contact`.org_id = `Organization`.id JOIN Organization AS `Organization1` ON `Organization`.parent_id BELOW `Organization1`.id WHERE (`Organization1`.`id` = '1')", + 'ExpectedCriterion' => array(array('widget' => 'hierarchical_key', 'operator' => 'IN')), + ), 'key empty' => array( 'OQL' => "SELECT Person WHERE location_id = '0'", 'ExpectedOQL' => "SELECT `Person` FROM Person AS `Person` WHERE (`Person`.`location_id` = '0')", @@ -438,8 +443,8 @@ class CriterionConversionTest extends ItopDataTestCase 'ExpectedCriterion' => array(array('widget' => 'hierarchical_key')), ), 'Hierarchical below 2' => array( - 'OQL' => "SELECT `Organization` FROM Organization AS `Organization` JOIN Organization AS `Organization1` ON `Organization`.parent_id = `Organization1`.id JOIN Organization AS `Organization11` ON `Organization1`.parent_id BELOW `Organization11`.id WHERE (((`Organization11`.`id` IN ('2', '4')) OR (`Organization`.`parent_id` = '0')) AND 1)", - 'ExpectedOQL' => "SELECT `Organization` FROM Organization AS `Organization` JOIN Organization AS `Organization1` ON `Organization`.parent_id = `Organization1`.id JOIN Organization AS `Organization11` ON `Organization1`.parent_id BELOW `Organization11`.id WHERE (((`Organization11`.`id` IN ('2', '4')) OR (`Organization`.`parent_id` = '0')) AND 1)", + 'OQL' => "SELECT `Organization` FROM Organization AS `Organization` JOIN Organization AS `Organization1` ON `Organization`.parent_id = `Organization1`.id JOIN Organization AS `Organization11` ON `Organization1`.parent_id BELOW `Organization11`.id WHERE (((`Organization11`.`id` IN ('1', '2')) OR (`Organization`.`parent_id` = '0')) AND 1)", + 'ExpectedOQL' => "SELECT `Organization` FROM Organization AS `Organization` JOIN Organization AS `Organization1` ON `Organization`.parent_id = `Organization1`.id JOIN Organization AS `Organization11` ON `Organization1`.parent_id BELOW `Organization11`.id WHERE (((`Organization11`.`id` IN ('1', '2')) OR (`Organization`.`parent_id` = '0')) AND 1)", 'ExpectedCriterion' => array(array('widget' => 'hierarchical_key')), ), 'IP range' => array( diff --git a/test/core/TagSetFieldDataTest.php b/test/core/TagSetFieldDataTest.php index d7fb057da..e463e9a4d 100644 --- a/test/core/TagSetFieldDataTest.php +++ b/test/core/TagSetFieldDataTest.php @@ -19,6 +19,28 @@ class TagSetFieldDataTest extends ItopDataTestCase // Need commit to create the FULLTEXT INDEX of MySQL const USE_TRANSACTION = false; + public function testGetAllowedValues() + { + $aAllowedValues = TagSetFieldData::GetAllowedValues(TAG_CLASS, TAG_ATTCODE); + $iInitialCount = count($aAllowedValues); + $this->CreateTagData(TAG_CLASS, TAG_ATTCODE, 'tag1', 'First'); + $aAllowedValues = TagSetFieldData::GetAllowedValues(TAG_CLASS, TAG_ATTCODE); + $iCurrCount = count($aAllowedValues); + static::assertEquals(1, $iCurrCount - $iInitialCount); + $this->CreateTagData(TAG_CLASS, TAG_ATTCODE, 'tag2', 'Second'); + $aAllowedValues = TagSetFieldData::GetAllowedValues(TAG_CLASS, TAG_ATTCODE); + $iCurrCount = count($aAllowedValues); + static::assertEquals(2, $iCurrCount - $iInitialCount); + $this->CreateTagData(TAG_CLASS, TAG_ATTCODE, 'tag3', 'Third'); + $aAllowedValues = TagSetFieldData::GetAllowedValues(TAG_CLASS, TAG_ATTCODE); + $iCurrCount = count($aAllowedValues); + static::assertEquals(3, $iCurrCount - $iInitialCount); + $this->CreateTagData(TAG_CLASS, TAG_ATTCODE, 'tag4', 'Fourth'); + $aAllowedValues = TagSetFieldData::GetAllowedValues(TAG_CLASS, TAG_ATTCODE); + $iCurrCount = count($aAllowedValues); + static::assertEquals(4, $iCurrCount - $iInitialCount); + } + public function testDoCheckToWrite() { $aAllowedValues = TagSetFieldData::GetAllowedValues(TAG_CLASS, TAG_ATTCODE); @@ -67,8 +89,6 @@ class TagSetFieldDataTest extends ItopDataTestCase } /** - * @expectedException \CoreException - * * @throws \CoreException * @throws \CoreUnexpectedValue */ @@ -76,19 +96,34 @@ class TagSetFieldDataTest extends ItopDataTestCase { $oTagData = $this->CreateTagData(TAG_CLASS, TAG_ATTCODE, 'tag1', 'First'); $oTagData->DBDelete(); + $oTagData = $this->CreateTagData(TAG_CLASS, TAG_ATTCODE, 'tag1', 'First'); $oTicket = $this->CreateTicket(1); $oTicket->Set(TAG_ATTCODE, 'tag1'); $oTicket->DBWrite(); - $oTagData->DBDelete($oDeletionPlan); + try + { + $oTagData->DBDelete(); + } + catch (\CoreException $e) + { + static::assertTrue(true); + return; + } + static::assertFalse(true); } public function testComputeValues() { + $sTagClass = \MetaModel::GetTagDataClass(TAG_CLASS, TAG_ATTCODE); + $oTagData = $this->createObject($sTagClass, array( + 'tag_code' => 'tag1', + 'tag_label' => 'First', + )); + $this->debug("Created {$oTagData->Get('tag_class')}::{$oTagData->Get('tag_attcode')}"); + + static::assertEquals(TAG_CLASS, $oTagData->Get('tag_class')); + static::assertEquals(TAG_ATTCODE, $oTagData->Get('tag_attcode')); } - public function testGetAllowedValues() - { - - } } diff --git a/webservices/backoffice.dataloader.php b/webservices/backoffice.dataloader.php index 601b90b95..691c347a9 100644 --- a/webservices/backoffice.dataloader.php +++ b/webservices/backoffice.dataloader.php @@ -1,170 +1,170 @@ - - - -/** - * Does load data from XML files (currently used in the setup and the backoffice data loader utility) - * - * @copyright Copyright (C) 2010-2012 Combodo SARL - * @license http://opensource.org/licenses/AGPL-3.0 - */ - -/** - * This page is called to load an XML file into the database - * parameters - * 'file' string Name of the file to load - */ -define('SAFE_MINIMUM_MEMORY', 256*1024*1024); - -require_once('../approot.inc.php'); -require_once(APPROOT.'/application/application.inc.php'); - -require_once(APPROOT.'/application/startup.inc.php'); - -require_once(APPROOT.'/application/loginwebpage.class.inc.php'); -LoginWebPage::DoLogin(true); // Check user rights and prompt if needed (must be admin) - -// required because the class xmldataloader is reporting errors in the setup.log file -require_once(APPROOT.'/setup/setuppage.class.inc.php'); -require_once(APPROOT.'/setup/xmldataloader.class.inc.php'); - - -function SetMemoryLimit($oP) -{ - $sMemoryLimit = trim(ini_get('memory_limit')); - if (empty($sMemoryLimit)) - { - // On some PHP installations, memory_limit does not exist as a PHP setting! - // (encountered on a 5.2.0 under Windows) - // In that case, ini_set will not work, let's keep track of this and proceed with the data load - $oP->p("No memory limit has been defined in this instance of PHP"); - } - else - { - // Check that the limit will allow us to load the data - // - $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit); - if ($iMemoryLimit < SAFE_MINIMUM_MEMORY) - { - if (ini_set('memory_limit', SAFE_MINIMUM_MEMORY) === FALSE) - { - $oP->p("memory_limit is too small: $iMemoryLimit and can not be increased by the script itself."); - } - else - { - $oP->p("memory_limit increased from $iMemoryLimit to ".SAFE_MINIMUM_MEMORY."."); - } - } - } -} - - -//////////////////////////////////////////////////////////////////////////////// -// -// Main -// -//////////////////////////////////////////////////////////////////////////////// - -// Never cache this page -header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 -header("Expires: Fri, 17 Jul 1970 05:00:00 GMT"); // Date in the past - -/** - * Main program - */ -$sFileName = Utils::ReadParam('file', '', false, 'raw_data'); - -$oP = new WebPage("iTop - Backoffice data loader"); - - -try -{ - // Note: the data model must be loaded first - $oDataLoader = new XMLDataLoader(); - - if (empty($sFileName)) - { - throw(new Exception("Missing argument 'file'")); - } - if (!file_exists($sFileName)) - { - throw(new Exception("File $sFileName does not exist")); - } - - SetMemoryLimit($oP); - - - // The XMLDataLoader constructor has initialized the DB, let's start a transaction - CMDBSource::Query('START TRANSACTION'); - - $oChange = MetaModel::NewObject("CMDBChange"); - $oChange->Set("date", time()); - $oChange->Set("userinfo", "Initialization"); - $iChangeId = $oChange->DBInsert(); - $oP->p("Starting data load."); - $oDataLoader->StartSession($oChange); - - $oDataLoader->LoadFile($sFileName); - - $oP->p("Ending data load session"); - if ($oDataLoader->EndSession(true /* strict */)) - { - $iCountCreated = $oDataLoader->GetCountCreated(); - CMDBSource::Query('COMMIT'); - - $oP->p("Data successfully written into the DB: $iCountCreated objects created"); - } - else - { - CMDBSource::Query('ROLLBACK'); - $oP->p("Some issues have been encountered, changes will not be recorded, please review the source data"); - $aErrors = $oDataLoader->GetErrors(); - if (count($aErrors) > 0) - { - $oP->p('Errors ('.count($aErrors).')'); - foreach ($aErrors as $sMsg) - { - $oP->p(' * '.$sMsg); - } - } - $aWarnings = $oDataLoader->GetWarnings(); - if (count($aWarnings) > 0) - { - $oP->p('Warnings ('.count($aWarnings).')'); - foreach ($aWarnings as $sMsg) - { - $oP->p(' * '.$sMsg); - } - } - } - -} -catch(Exception $e) -{ - $oP->p("An error happened while loading the data: ".$e->getMessage()); - $oP->p("Aborting (no data written)..."); - CMDBSource::Query('ROLLBACK'); -} - -if (function_exists('memory_get_peak_usage')) -{ - $oP->p("Information: memory peak usage: ".memory_get_peak_usage()); -} - -$oP->Output(); -?> + + + +/** + * Does load data from XML files (currently used in the setup and the backoffice data loader utility) + * + * @copyright Copyright (C) 2010-2012 Combodo SARL + * @license http://opensource.org/licenses/AGPL-3.0 + */ + +/** + * This page is called to load an XML file into the database + * parameters + * 'file' string Name of the file to load + */ +define('SAFE_MINIMUM_MEMORY', 256*1024*1024); + +require_once('../approot.inc.php'); +require_once(APPROOT.'/application/application.inc.php'); + +require_once(APPROOT.'/application/startup.inc.php'); + +require_once(APPROOT.'/application/loginwebpage.class.inc.php'); +LoginWebPage::DoLogin(true); // Check user rights and prompt if needed (must be admin) + +// required because the class xmldataloader is reporting errors in the setup.log file +require_once(APPROOT.'/setup/setuppage.class.inc.php'); +require_once(APPROOT.'/setup/xmldataloader.class.inc.php'); + + +function SetMemoryLimit($oP) +{ + $sMemoryLimit = trim(ini_get('memory_limit')); + if (empty($sMemoryLimit)) + { + // On some PHP installations, memory_limit does not exist as a PHP setting! + // (encountered on a 5.2.0 under Windows) + // In that case, ini_set will not work, let's keep track of this and proceed with the data load + $oP->p("No memory limit has been defined in this instance of PHP"); + } + else + { + // Check that the limit will allow us to load the data + // + $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit); + if (!utils::IsMemoryLimitOk($iMemoryLimit, SAFE_MINIMUM_MEMORY)) + { + if (ini_set('memory_limit', SAFE_MINIMUM_MEMORY) === FALSE) + { + $oP->p("memory_limit is too small: $iMemoryLimit and can not be increased by the script itself."); + } + else + { + $oP->p("memory_limit increased from $iMemoryLimit to ".SAFE_MINIMUM_MEMORY."."); + } + } + } +} + + +//////////////////////////////////////////////////////////////////////////////// +// +// Main +// +//////////////////////////////////////////////////////////////////////////////// + +// Never cache this page +header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 +header("Expires: Fri, 17 Jul 1970 05:00:00 GMT"); // Date in the past + +/** + * Main program + */ +$sFileName = Utils::ReadParam('file', '', false, 'raw_data'); + +$oP = new WebPage("iTop - Backoffice data loader"); + + +try +{ + // Note: the data model must be loaded first + $oDataLoader = new XMLDataLoader(); + + if (empty($sFileName)) + { + throw(new Exception("Missing argument 'file'")); + } + if (!file_exists($sFileName)) + { + throw(new Exception("File $sFileName does not exist")); + } + + SetMemoryLimit($oP); + + + // The XMLDataLoader constructor has initialized the DB, let's start a transaction + CMDBSource::Query('START TRANSACTION'); + + $oChange = MetaModel::NewObject("CMDBChange"); + $oChange->Set("date", time()); + $oChange->Set("userinfo", "Initialization"); + $iChangeId = $oChange->DBInsert(); + $oP->p("Starting data load."); + $oDataLoader->StartSession($oChange); + + $oDataLoader->LoadFile($sFileName); + + $oP->p("Ending data load session"); + if ($oDataLoader->EndSession(true /* strict */)) + { + $iCountCreated = $oDataLoader->GetCountCreated(); + CMDBSource::Query('COMMIT'); + + $oP->p("Data successfully written into the DB: $iCountCreated objects created"); + } + else + { + CMDBSource::Query('ROLLBACK'); + $oP->p("Some issues have been encountered, changes will not be recorded, please review the source data"); + $aErrors = $oDataLoader->GetErrors(); + if (count($aErrors) > 0) + { + $oP->p('Errors ('.count($aErrors).')'); + foreach ($aErrors as $sMsg) + { + $oP->p(' * '.$sMsg); + } + } + $aWarnings = $oDataLoader->GetWarnings(); + if (count($aWarnings) > 0) + { + $oP->p('Warnings ('.count($aWarnings).')'); + foreach ($aWarnings as $sMsg) + { + $oP->p(' * '.$sMsg); + } + } + } + +} +catch(Exception $e) +{ + $oP->p("An error happened while loading the data: ".$e->getMessage()); + $oP->p("Aborting (no data written)..."); + CMDBSource::Query('ROLLBACK'); +} + +if (function_exists('memory_get_peak_usage')) +{ + $oP->p("Information: memory peak usage: ".memory_get_peak_usage()); +} + +$oP->Output(); +?>