]> git.mxchange.org Git - mailer.git/blobdiff - inc/xml-functions.php
Continued a bit:
[mailer.git] / inc / xml-functions.php
index 2a11ccc4b72ebcfc413fd323abf9af4262614a4c..ee135cfcc51c9baec19856651dfa9641dbe71e5e 100644 (file)
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Funktionen zum Umgang mit XML-Templates          *
  * -------------------------------------------------------------------- *
- * $Revision::                                                        $ *
- * $Date::                                                            $ *
- * $Tag:: 0.2.1-FINAL                                                 $ *
- * $Author::                                                          $ *
- * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2016 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -61,7 +56,7 @@ function doGenericXmlTemplateCallback ($template, $content = array(), $compileCo
        initXml();
 
        // Generate FQFN for with special path
-       $FQFN = sprintf("%stemplates/xml/%s%s.xml",
+       $FQFN = sprintf('%stemplates/xml/%s%s.xml',
                getPath(),
                detectExtraTemplatePath('xml', $template),
                $template
@@ -70,7 +65,7 @@ function doGenericXmlTemplateCallback ($template, $content = array(), $compileCo
        // Is the file readable?
        if (!isFileReadable($FQFN)) {
                // No, use without extra path
-               $FQFN = sprintf("%stemplates/xml/%s.xml",
+               $FQFN = sprintf('%stemplates/xml/%s.xml',
                        getPath(),
                        $template
                );
@@ -79,15 +74,15 @@ function doGenericXmlTemplateCallback ($template, $content = array(), $compileCo
        // Is it again readable?
        if (isFileReadable($FQFN)) {
                // Is there cache?
-               if ((!isDebuggingTemplateCache()) && (isTemplateCached('xml', $template))) {
+               if ((!isDebugTemplateCacheEnabled()) && (isTemplateCached('xml', $template))) {
                        // Evaluate the cache
-                       eval(readTemplateCache('xml', $template));
+                       $templateContent = readTemplateCache('xml', $template, $content);
                } 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) . '");';
+                       $GLOBALS['template_eval']['xml'][$template] = '$templateContent = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($templateContent), TRUE, $compileCode) . '");';
 
                        // Eval the code, this does insert any array elements from $content
                        eval($GLOBALS['template_eval']['xml'][$template]);
@@ -109,7 +104,7 @@ function doGenericXmlTemplateCallback ($template, $content = array(), $compileCo
                addXmlSpecialElements($template);
 
                // Call the call-back function
-               doCallXmlCallbackFunction($content);
+               doCallXmlCallbackFunction();
        } else {
                // Template not found
                displayMessage('{%message,XML_TEMPLATE_404=' . $template . '%}');
@@ -133,14 +128,8 @@ function addXmlSpecialElements ($template) {
 
 // Parses the XML content
 function parseXmlData ($content) {
-       // Is there recode?
-       if (!function_exists('recode')) {
-               // No fallback ATM
-               reportBug('PHP extension recode is missing. Please install it.');
-       } // END - if
-
        // Convert HTML entities to UTF-8
-       $content = recode('html..utf8', $content);
+       $decoded = decodeEntities($content);
 
        // Create a new XML parser
        $xmlParser = xml_parser_create();
@@ -156,7 +145,7 @@ function parseXmlData ($content) {
        xml_set_character_data_handler($xmlParser, 'xmlCharacterHandler');
 
        // Now parse the XML tree
-       if (!xml_parse($xmlParser, $content)) {
+       if (!xml_parse($xmlParser, $decoded)) {
                // Error found in XML!
                //* DEBUG: */ die('<pre>'.htmlentities($content).'</pre>');
                reportBug(__FUNCTION__, __LINE__, 'Error found in XML. errorMessage=' . xml_error_string(xml_get_error_code($xmlParser)) . ', line=' . xml_get_current_line_number($xmlParser));
@@ -232,13 +221,13 @@ function xmlCharacterHandler ($resource, $characters) {
        $characters = trim($characters);
 
        // Are there some to handle?
-       if (strlen($characters) == 0) {
+       if (empty($characters)) {
                // Nothing to handle
                return;
        } // END - if
 
        // @TODO Handle characters
-       die(__FUNCTION__ . ':characters[]='.strlen($characters));
+       die(__FUNCTION__ . ':characters[' . gettype($characters) . ']=' . strlen($characters));
 }
 
 // Checks if given type is valid, makes all lower-case
@@ -256,7 +245,7 @@ function isXmlConditionValid ($condition) {
        $condition = trim(strtolower($condition));
 
        // Is it valid?
-       return (in_array($condition, array('equals')));
+       return (in_array($condition, array('equals', 'and')));
 }
 
 // Checks if given value is valid/verifyable
@@ -285,20 +274,38 @@ function convertXmlContion ($condition) {
        return $GLOBALS['__XML_CONDITIONS'][$condition];
 }
 
+// "Getter" for FROM statement from given columns
+function getSqlXmlFromTable ($tableName) {
+       // Init SQL
+       $sql = ' FROM `{?_MYSQL_PREFIX?}_' . $tableName[0]['value'] . '`';
+
+       // Is alias set?
+       if (!empty($tableName[0]['alias'])) {
+               // Also add it
+               $sql .= ' AS `' . $tableName[0]['alias'] . '`';
+       } // END - if
+
+       // Return SQL
+       return $sql;
+}
+
 // "Getter" for sql part back from given array
 function getSqlPartFromXmlArray ($columns) {
        // Init SQL
-       $SQL = '';
+       $sql = '';
 
        // Walk through all entries
        foreach ($columns as $columnArray) {
+               // Must be an array
+               assert(is_array($columnArray));
+
                // Init SQL part
                $sqlPart = '';
 
                // Is there a table/alias
                if (!empty($columnArray['table'])) {
                        // Pre-add it
-                       $sqlPart .= $columnArray['table'] . '.';
+                       $sqlPart .= '`' . $columnArray['table'] . '`.';
                } // END - if
 
                // Add column
@@ -311,11 +318,129 @@ function getSqlPartFromXmlArray ($columns) {
                } // END - if
 
                // Add finished SQL part to the query
-               $SQL .= $sqlPart . ',';
+               $sql .= $sqlPart . ',';
        } // END - foreach
 
        // Return it without last commata
-       return substr($SQL, 0, -1);
+       return substr($sql, 0, -1);
+}
+
+// "Getter" for JOIN statement
+function getSqlXmlJoinedTable ($tableJoinType, $tableJoinName, $joinOnLeftTable, $joinOnCondition, $joinOnRightTable) {
+       // Are all set?
+       assert((isFilledArray($tableJoinType)) && (isFilledArray($tableJoinName)) && (isFilledArray($joinOnLeftTable)) && (isFilledArray($joinOnCondition)) && (isFilledArray($joinOnRightTable)));
+
+       // Init SQL
+       $sql = '';
+
+       // "Walk" through all JOINs
+       foreach ($tableJoinType as $key => $joinType) {
+               // 1) Add JOIN type and table name with alias
+               $sql .= ' ' . $joinType . ' `{?_MYSQL_PREFIX?}_' . $tableJoinName[$key]['name'] . '`';
+
+               // Alias set?
+               if (!empty($tableJoinName[$key]['alias'])) {
+                       // Add it
+                       $sql .= ' AS `' . $tableJoinName[$key]['alias'] . '`';
+               } // END - if
+
+               // 2) Add left part + condition + right part with aliases
+               // 2/1) ON + left part
+               $sql .= ' ON `' . $joinOnLeftTable[$key]['name'] . '`.`' . $joinOnLeftTable[$key]['column'] . '`';
+               // 2/2) Condition
+               $sql .= $joinOnCondition[$key];
+               // 2/3) right part
+               $sql .= '`' . $joinOnRightTable[$key]['name'] . '`.`' . $joinOnRightTable[$key]['column'] . '`';
+       } // END - foreach
+
+       // Return SQL
+       return $sql;
+}
+
+// "Getter" for WHERE statement from given columns and conditions arrays
+function getSqlXmlWhereConditions ($whereColumns, $conditions) {
+       // Init SQL
+       $sql = '';
+
+       // Are there some conditions?
+       if (isFilledArray($whereColumns)) {
+               // Then add these as well
+               if (count($whereColumns) == 1) {
+                       // One entry found
+                       $sql .= ' WHERE ';
+
+                       // Table/alias included?
+                       if (!empty($whereColumns[0]['table'])) {
+                               // Add it as well
+                               $sql .= $whereColumns[0]['table'] . '.';
+                       } // END - if
+
+                       // Add the rest
+                       $sql .= '`' . $whereColumns[0]['column'] . '`' . $whereColumns[0]['condition'] . chr(39) . $whereColumns[0]['look_for'] . chr(39);
+               } elseif ((count($whereColumns > 1)) && (isFilledArray($conditions))) {
+                       // More than one "WHERE" + condition found
+                       foreach ($whereColumns as $idx => $columnArray) {
+                               // Default is WHERE
+                               $condition = ' WHERE ';
+
+                               // Is the condition element there?
+                               if (isset($conditions[$columnArray['column']])) {
+                                       // Assume the condition
+                                       $condition = ' ' . $conditions[$columnArray['column']] . ' ';
+                               } // END - if
+
+                               // Add to SQL query
+                               $sql .= $condition;
+
+                               // Table/alias included?
+                               if (!empty($whereColumns[$idx]['table'])) {
+                                       // Add it as well
+                                       $sql .= $whereColumns[$idx]['table'] . '.';
+                               } // END - if
+
+                               // Add the rest
+                               $sql .= '`' . $whereColumns[$idx]['column'] . '`' . $whereColumns[$idx]['condition'] . chr(39) . convertDollarDataToGetElement($whereColumns[$idx]['look_for']) . chr(39);
+                       } // END - foreach
+               } else {
+                       // Did not set $conditions
+                       reportBug(__FUNCTION__, __LINE__, 'Supplied more than &quot;whereColumns&quot; entries but no conditions! Please fix your XML template.');
+               }
+       } // END - if
+
+       // Return SQL
+       return $sql;
+}
+
+// "Getter" for ORDER BY statement from given columns
+function getSqlXmlOrderBy ($orderByColumns) {
+       // Init SQL
+       $sql = '';
+
+       // Are there entries from orderByColumns to add?
+       if (isFilledArray($orderByColumns)) {
+               // Add them as well
+               $sql .= ' ORDER BY ';
+               foreach ($orderByColumns as $orderByColumn => $array) {
+                       // Get keys (table/alias) and values (sorting itself)
+                       $table   = trim(implode('', array_keys($array)));
+                       $sorting = trim(implode('', array_values($array)));
+
+                       // table/alias can be omitted
+                       if (!empty($table)) {
+                               // table/alias is given
+                               $sql .= '`' . $table . '`.';
+                       } // END - if
+
+                       // Add order-by column
+                       $sql .= '`' . $orderByColumn . '` ' . $sorting . ',';
+               } // END - foreach
+
+               // Remove last column
+               $sql = substr($sql, 0, -1);
+       } // END - if
+
+       // Return SQL
+       return $sql;
 }
 
 // Searches in given XML array for value and returns the parent index
@@ -329,6 +454,7 @@ function searchXmlArray ($value, $columns, $childKey) {
                assert(isset($columnArray[$childKey]));
 
                // Now is it what we are looking for?
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'value=' . $value . ',key=' . $key . ',childKey=' . $childKey . ',columnArray=' . $columnArray[$childKey]);
                if ($columnArray[$childKey] === $value) {
                        // Remember this match
                        $return = $key;