X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fxml-functions.php;h=d0963f4b22f203ee895d4e64a026edd4ebf95b90;hp=d59207e916ae0357fae647a85af646bc91a5673c;hb=6560179e7c8dc565485503f374d4e31f333ffd0e;hpb=20741b93fd58620af677a7f1039ffd16ea6ec689

diff --git a/inc/xml-functions.php b/inc/xml-functions.php
index d59207e916..d0963f4b22 100644
--- a/inc/xml-functions.php
+++ b/inc/xml-functions.php
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
+ * 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 *
@@ -41,11 +41,11 @@ if (!defined('__SECURITY')) {
 } // END - if
 
 // Calls back a function based on given XML template data
-function showEntriesByXmlCallback ($template) {
+function showEntriesByXmlCallback ($template, $content = array(), $compileCode = true) {
 	// Generate FQFN for with special path
 	$FQFN = sprintf("%stemplates/xml/%s%s.xml",
 		getPath(),
-		detectExtraTemplatePath($template),
+		detectExtraTemplatePath('xml', $template),
 		$template
 	);
 
@@ -60,8 +60,20 @@ function showEntriesByXmlCallback ($template) {
 
 	// Is it again readable?
 	if (isFileReadable($FQFN)) {
-		// Read it
-		$templateContent = readFromFile($FQFN);
+		// Is there cache?
+		if ((!isDebuggingTemplateCache()) && (isTemplateCached('xml', $template))) {
+			// Evaluate the cache
+			eval(readTemplateCache('xml', $template));
+		} else {
+			// Read it
+			$templateContent = readFromFile($FQFN);
+
+			// Prepare it for finaly eval() command
+			$GLOBALS['template_eval']['xml'][$template] = '$templateContent = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($templateContent), false, true, true, $compileCode) . '");';
+
+			// Eval the code, this does insert any array elements from $content
+			eval($GLOBALS['template_eval']['xml'][$template]);
+		}
 
 		// Init main arrays
 		$GLOBALS['__XML_CALLBACKS'] = array(
@@ -69,10 +81,14 @@ function showEntriesByXmlCallback ($template) {
 			'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 {
@@ -81,16 +97,31 @@ function showEntriesByXmlCallback ($template) {
 	}
 }
 
+// Adds special elements by calling back another template-depending function
+function addXmlSpecialElements ($template) {
+	// Generate the FQCN (Full-Qualified Callback Name)
+	$FQCN = 'addXmlSpecial' . capitalizeUnderscoreString($template);
+
+	// Is it there?
+	if (function_exists($FQCN)) {
+		// Call it
+		call_user_func($FQCN);
+	} elseif (isDebugModeEnabled()) {
+		// 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 {
+	// Is there recode?
+	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();
@@ -109,7 +140,7 @@ function parseXmlData ($content) {
 	if (!xml_parse($xmlParser, $content)) {
 		// Error found in XML!
 		//* DEBUG: */ die('<pre>'.htmlentities($content).'</pre>');
-		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
@@ -120,7 +151,7 @@ function parseXmlData ($content) {
 function doCallXmlCallbackFunction () {
 	// Loop through all added entries
 	foreach ($GLOBALS['__XML_CALLBACKS']['callbacks'] as $callback) {
-		// Do we have the entry?
+		// Is there the entry?
 		if ((isset($GLOBALS['__XML_CALLBACKS']['functions'][$callback])) && (isset($GLOBALS['__XML_ARGUMENTS'][$callback]))) {
 			// Run all function callbacks
 			foreach ($GLOBALS['__XML_CALLBACKS']['functions'][$callback] as $function) {
@@ -138,15 +169,16 @@ function doCallXmlCallbackFunction () {
 
 				// 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.');
+					// No, then please add it
+					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
 }
@@ -163,7 +195,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
@@ -180,7 +212,7 @@ function xmlCharacterHandler ($resource, $characters) {
 	// Trim spaces away
 	$characters = trim($characters);
 
-	// Do we have some to handle?
+	// Are there some to handle?
 	if (strlen($characters) == 0) {
 		// Nothing to handle
 		return;
@@ -211,16 +243,16 @@ function isXmlConditionValid ($condition) {
 // 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
@@ -235,7 +267,7 @@ function convertXmlContion ($condition) {
 			break;
 
 		default: // Unknown condition
-			debug_report_bug(__FUNCTION__, __LINE__, 'Condition ' . $condition . ' is unknown/unsupported.');
+			reportBug(__FUNCTION__, __LINE__, 'Condition ' . $condition . ' is unknown/unsupported.');
 			break;
 	} // END - switch
 
@@ -243,5 +275,62 @@ function convertXmlContion ($condition) {
 	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 = '';
+
+		// Is there 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]
 ?>