X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fxml-functions.php;h=a623e70181d6dac2f41c4fa413b7821fc6adb3a0;hb=91c2f600b1d39c1317bccafba62e7a78ad4d8c14;hp=04550bc6da6afa1f1901b1efb6bbd93ff1cdc5b4;hpb=9197694ce183b69384a385a6c4a5e16988c7fb09;p=mailer.git diff --git a/inc/xml-functions.php b/inc/xml-functions.php index 04550bc6da..a623e70181 100644 --- a/inc/xml-functions.php +++ b/inc/xml-functions.php @@ -16,8 +16,8 @@ * $Author:: $ * * -------------------------------------------------------------------- * * Copyright (c) 2003 - 2009 by Roland Haeder * - * Copyright (c) 2009 - 2011 by Mailer Developer Team * - * For more information visit: http://www.mxchange.org * + * Copyright (c) 2009 - 2012 by Mailer Developer Team * + * For more information visit: http://mxchange.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * @@ -63,9 +63,20 @@ function showEntriesByXmlCallback ($template) { // Read it $templateContent = readFromFile($FQFN); + // Init main arrays + $GLOBALS['__XML_CALLBACKS'] = array( + 'callbacks' => array(), + 'functions' => array() + ); + $GLOBALS['__XML_ARGUMENTS'] = array(); + $GLOBALS['__COLUMN_INDEX'] = array(); + // Handle it over to the parser parseXmlData($templateContent); + // Add special elements, e.g. column index + addXmlSpecialElements($template); + // Call the call-back function doCallXmlCallbackFunction(); } else { @@ -74,16 +85,31 @@ function showEntriesByXmlCallback ($template) { } } +// Adds special elements by calling back another template-depending function +function addXmlSpecialElements ($template) { + // Generate the FQCN (Full-Qualified CallbackName) + $FQCN = 'addXmlSpecial' . capitalizeUnderscoreString($template); + + // Is it there? + if (function_exists($FQCN)) { + // Call it + call_user_func($FQCN); + } else { + // This callback function is only optional + logDebugMessage(__FUNCTION__, __LINE__, 'Call-back function ' . $FQCN . ' for template ' . $template . ' does not exist.'); + } +} + // Parses the XML content function parseXmlData ($content) { // Do we have recode? - if (function_exists('recode')) { - // Convert 'HTML' to UTF-8 - $content = recode('html..utf8', $content); - } else { + if (!function_exists('recode')) { // No fallback ATM - debug_report_bug('PHP extension recode is missing. Please install it.'); - } + reportBug('PHP extension recode is missing. Please install it.'); + } // END - if + + // Convert HTML entities to UTF-8 + $content = recode('html..utf8', $content); // Create a new XML parser $xmlParser = xml_parser_create(); @@ -102,7 +128,7 @@ function parseXmlData ($content) { if (!xml_parse($xmlParser, $content)) { // Error found in XML! //* DEBUG: */ die('
'.htmlentities($content).'
'); - debug_report_bug(__FUNCTION__, __LINE__, 'Error found in XML. errorMessage=' . xml_error_string(xml_get_error_code($xmlParser)) . ', line=' . xml_get_current_line_number($xmlParser)); + reportBug(__FUNCTION__, __LINE__, 'Error found in XML. errorMessage=' . xml_error_string(xml_get_error_code($xmlParser)) . ', line=' . xml_get_current_line_number($xmlParser)); } // END - if // Free the parser @@ -117,27 +143,36 @@ function doCallXmlCallbackFunction () { if ((isset($GLOBALS['__XML_CALLBACKS']['functions'][$callback])) && (isset($GLOBALS['__XML_ARGUMENTS'][$callback]))) { // Run all function callbacks foreach ($GLOBALS['__XML_CALLBACKS']['functions'][$callback] as $function) { + // Trim all function names + $function = trim($function); + + // If the function is empty, simply skip to the (maybe) next one + if (empty($function)) { + // Skip this + continue; + } // END - if + // Now construct the call-back function's name with 'Execute' at the end $callbackName = $callback . 'Execute'; // Is it there? if (!function_exists($callbackName)) { - debug_report_bug(__FUNCTION__, __LINE__, 'callback=' . $callback . ',function=' . $function . 'arguments()=' . count($GLOBALS['__XML_ARGUMENTS'][$callback]) . ' - execute call-back not found.'); + reportBug(__FUNCTION__, __LINE__, 'callback=' . $callback . ',function=' . $function . 'arguments()=' . count($GLOBALS['__XML_ARGUMENTS'][$callback]) . ' - execute call-back does not exist.'); } // END - if // Call it - call_user_func_array($callbackName, array($function, $GLOBALS['__XML_ARGUMENTS'][$callback])); + call_user_func_array($callbackName, array($function, $GLOBALS['__XML_ARGUMENTS'][$callback], $GLOBALS['__COLUMN_INDEX'][$callback])); } // END - foreach } else { // Not found - debug_report_bug(__FUNCTION__, __LINE__, 'Entry in callbacks does exist, but not in functions, callback= ' . $callback); + reportBug(__FUNCTION__, __LINE__, 'Entry in callbacks does exist, but not in functions, callback= ' . $callback); } } // END - foreach } -// ---------------------------------------------------------------------------- +//----------------------------------------------------------------------------- // Call-back functions for XML parser -// ---------------------------------------------------------------------------- +//----------------------------------------------------------------------------- // Starts an element function startXmlElement ($resource, $element, $attributes) { @@ -147,7 +182,7 @@ function startXmlElement ($resource, $element, $attributes) { // Is the call-back function there? if (!function_exists($elementCallback)) { // Not there - debug_report_bug(__FUNCTION__, __LINE__, 'Missing call-back function ' . $elementCallback . ', please add it.'); + reportBug(__FUNCTION__, __LINE__, 'Missing call-back function ' . $elementCallback . ', please add it.'); } // END - if // Call the call-back function @@ -169,7 +204,9 @@ function xmlCharacterHandler ($resource, $characters) { // Nothing to handle return; } // END - if - die('characters[]='.strlen($characters)); + + // @TODO Handle characters + die(__FUNCTION__ . ':characters[]='.strlen($characters)); } // Checks if given type is valid, makes all lower-case @@ -178,22 +215,108 @@ function isInvalidXmlType ($type) { $type = strtolower(trim($type)); // Is it found? - return (in_array($type, array('string', 'array', 'bool'))); + return (in_array($type, array('string', 'array', 'bool', 'int', 'callback'))); +} + +// Checks if given condition is valid +function isXmlConditionValid ($condition) { + // Trim and make lower-case + $condition = trim(strtolower($condition)); + + // Is it valid? + return (in_array($condition, array('equals'))); } // Checks if given value is valid/verifyable function isXmlValueValid ($type, $value) { // Depends on type, so build a call-back - $callbackFunction = 'isXmlType' . trim(capitalizeUnderscoreString($type)); + $callbackName = 'isXmlType' . trim(capitalizeUnderscoreString($type)); // Is the call-back function there? - if (!function_exists($callbackFunction)) { + if (!function_exists($callbackName)) { // Not there - debug_report_bug(__FUNCTION__, __LINE__, 'Missing call-back function ' . $callbackFunction . ', please add it.'); + reportBug(__FUNCTION__, __LINE__, 'Missing call-back function ' . $callbackName . ', please add it.'); } // END - if // Call and return it - return call_user_func_array($callbackFunction, array($value)); + return call_user_func_array($callbackName, array($value)); +} + +// Converts given condition into a symbol +function convertXmlContion ($condition) { + // Default is an invalid one + $return = '???'; + + // Detect the condition again + switch ($condition) { + case 'EQUALS': // Equals + $return = '='; + break; + + default: // Unknown condition + reportBug(__FUNCTION__, __LINE__, 'Condition ' . $condition . ' is unknown/unsupported.'); + break; + } // END - switch + + // Return it + return $return; +} + +// "Getter" for sql part back from given array +function getSqlPartFromXmlArray ($columns) { + // Init SQL + $SQL = ''; + + // Walk through all entries + foreach ($columns as $columnArray) { + // Init SQL part + $sqlPart = ''; + + // Do we have a table/alias + if (!empty($columnArray['table'])) { + // Pre-add it + $sqlPart .= $columnArray['table'] . '.'; + } // END - if + + // Add column + $sqlPart .= '`' . $columnArray['column'] . '`'; + + // Is a function and alias set? + if ((!empty($columnArray['function'])) && (!empty($columnArray['alias']))) { + // Add both + $sqlPart = $columnArray['function'] . '(' . $sqlPart . ') AS `' . $columnArray['alias'] . '`'; + } // END - if + + // Add finished SQL part to the query + $SQL .= $sqlPart . ','; + } // END - foreach + + // Return it without last commata + return substr($SQL, 0, -1); +} + +// Searches in given XML array for value and returns the parent index +function searchXmlArray ($value, $columns, $childKey) { + // Default is not found + $return = false; + + // Walk through whole array + foreach ($columns as $key => $columnArray) { + // Make sure the element is there + assert(isset($columnArray[$childKey])); + + // Now is it what we are looking for? + if ($columnArray[$childKey] == $value) { + // Remember this match + $return = $key; + + // And abort any further searches + break; + } // END - if + } // END - foreach + + // Return key/false + return $return; } // [EOF]