inc/template-functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 04/04/2009 *
   4  * ===================                          Last change: 04/04/2009 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : template-functions.php                           *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Template functions                               *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Template-Funktionen                              *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * -------------------------------------------------------------------- *
  18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  20  * For more information visit: http://www.mxchange.org                  *
  21  *                                                                      *
  22  * This program is free software; you can redistribute it and/or modify *
  23  * it under the terms of the GNU General Public License as published by *
  24  * the Free Software Foundation; either version 2 of the License, or    *
  25  * (at your option) any later version.                                  *
  26  *                                                                      *
  27  * This program is distributed in the hope that it will be useful,      *
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  30  * GNU General Public License for more details.                         *
  31  *                                                                      *
  32  * You should have received a copy of the GNU General Public License    *
  33  * along with this program; if not, write to the Free Software          *
  34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  35  * MA  02110-1301  USA                                                  *
  36  ************************************************************************/
  37
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         die();
  41 } // END - if
  42
  43 // Wrapper until we merged to the EL branch
  44 function preCompileCode ($code, $template = '', $compiled = false, $full = true, $overwrite = false) {
  45         return compileCode($code, false, true, $full);
  46 }
  47
  48 // Setter for 'is_template_html'
  49 function enableTemplateHtml ($enable = true) {
  50         $GLOBALS['is_template_html'] = (bool) $enable;
  51 }
  52
  53 // Checks wether the template is HTML or not by previously set flag
  54 // Default: true
  55 function isTemplateHtml () {
  56         // Is the output_mode other than 0 (HTML), then no comments are enabled
  57         if (!isHtmlOutputMode()) {
  58                 // No HTML
  59                 return false;
  60         } else {
  61                 // Maybe HTML?
  62                 return $GLOBALS['is_template_html'];
  63         }
  64 }
  65
  66 // Wrapper for writing debug informations to the browser
  67 function debugOutput ($message) {
  68         outputHtml('<div class="debug_message">' . $message . '</div>');
  69 }
  70
  71 // "Fixes" an empty string into three dashes (use for templates)
  72 function fixEmptyContentToDashes ($str) {
  73         // Trim the string
  74         $str = trim($str);
  75
  76         // Is the string empty?
  77         if (empty($str)) {
  78                 $str = '---';
  79         } // END - if
  80
  81         // Return string
  82         return $str;
  83 }
  84
  85 // Init color switch
  86 function initTemplateColorSwitch ($template) {
  87         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'INIT:' . $template);
  88         $GLOBALS['color_switch'][$template] = 2;
  89 }
  90
  91 // "Getter" for color switch code
  92 function getColorSwitchCode ($template) {
  93         // Prepare the code
  94         $code = "{DQUOTE} . doTemplateColorSwitch('" . $template . "', false, false) . {DQUOTE}";
  95
  96         // And return it
  97         return $code;
  98 }
  99
 100 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
 101 function outputHtml ($htmlCode, $newLine = true) {
 102         // Init output
 103         if (!isset($GLOBALS['output'])) {
 104                 $GLOBALS['output'] = '';
 105         } // END - if
 106
 107         // Do we have HTML-Code here?
 108         if (!empty($htmlCode)) {
 109                 // Yes, so we handle it as you have configured
 110                 switch (getOutputMode()) {
 111                         case 'render':
 112                                 // That's why you don't need any \n at the end of your HTML code... :-)
 113                                 if (getPhpCaching() == 'on') {
 114                                         // Output into PHP's internal buffer
 115                                         outputRawCode($htmlCode);
 116
 117                                         // That's why you don't need any \n at the end of your HTML code... :-)
 118                                         if ($newLine === true) print("\n");
 119                                 } else {
 120                                         // Render mode for old or lame servers...
 121                                         $GLOBALS['output'] .= $htmlCode;
 122
 123                                         // That's why you don't need any \n at the end of your HTML code... :-)
 124                                         if ($newLine === true) $GLOBALS['output'] .= "\n";
 125                                 }
 126                                 break;
 127
 128                         case 'direct':
 129                                 // If we are switching from render to direct output rendered code
 130                                 if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
 131
 132                                 // The same as above... ^
 133                                 outputRawCode($htmlCode);
 134                                 if ($newLine === true) print("\n");
 135                                 break;
 136
 137                         default:
 138                                 // Huh, something goes wrong or maybe you have edited config.php ???
 139                                 debug_report_bug(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--NO_RENDER_DIRECT--}');
 140                                 break;
 141                 } // END - switch
 142         } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
 143                 // Output cached HTML code
 144                 $GLOBALS['output'] = ob_get_contents();
 145
 146                 // Clear output buffer for later output if output is found
 147                 if (!empty($GLOBALS['output'])) {
 148                         clearOutputBuffer();
 149                 } // END - if
 150
 151                 // Send all HTTP headers
 152                 sendHttpHeaders();
 153
 154                 // Compile and run finished rendered HTML code
 155                 compileFinalOutput();
 156
 157                 // Output code here, DO NOT REMOVE! ;-)
 158                 outputRawCode($GLOBALS['output']);
 159         } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['output']))) {
 160                 // Send all HTTP headers
 161                 sendHttpHeaders();
 162
 163                 // Compile and run finished rendered HTML code
 164                 compileFinalOutput();
 165
 166                 // Output code here, DO NOT REMOVE! ;-)
 167                 outputRawCode($GLOBALS['output']);
 168         } else {
 169                 // And flush all headers
 170                 flushHeaders();
 171         }
 172 }
 173
 174 // Compiles the final output
 175 function compileFinalOutput () {
 176         // Add page header and footer
 177         addPageHeaderFooter();
 178
 179         // Do the final compilation
 180         $GLOBALS['output'] = doFinalCompilation($GLOBALS['output']);
 181
 182         // Extension 'rewrite' installed?
 183         if ((isExtensionActive('rewrite')) && (!isCssOutputMode())) {
 184                 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
 185         } // END - if
 186
 187         // Compress it?
 188         /**
 189          * @TODO On some pages this is buggy
 190         if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
 191                 // Compress it for HTTP gzip
 192                 $GLOBALS['output'] = gzencode($GLOBALS['output'], 9);
 193
 194                 // Add header
 195                 sendHeader('Content-Encoding: gzip');
 196         } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
 197                 // Compress it for HTTP deflate
 198                 $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
 199
 200                 // Add header
 201                 sendHeader('Content-Encoding: deflate');
 202         }
 203         */
 204
 205         // Add final length
 206         sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
 207
 208         // Flush all headers
 209         flushHeaders();
 210 }
 211
 212 // Main compilation loop
 213 function doFinalCompilation ($code, $insertComments = true, $enableCodes = true) {
 214         // Insert comments? (Only valid with HTML templates, of course)
 215         enableTemplateHtml($insertComments);
 216
 217         // Init counter
 218         $count = 0;
 219
 220         // Compile all out
 221         while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($count < 5)) {
 222                 // Init common variables
 223                 $content = array();
 224                 $newContent = '';
 225
 226                 // Compile it
 227                 //* DEBUG: */ debugOutput('<pre>'.linenumberCode($code).'</pre>');
 228                 $eval = '$newContent = "' . str_replace('{DQUOTE}', '"', compileCode(escapeQuotes($code), false, true, $enableCodes)) . '";';
 229                 //* DEBUG: */ if (!$insertComments) print('EVAL=<pre>'.linenumberCode($eval).'</pre>');
 230                 eval($eval);
 231                 //* DEBUG: */ if (!$insertComments) print('NEW=<pre>'.linenumberCode($newContent).'</pre>');
 232                 //* DEBUG: */ die('<pre>'.encodeEntities($newContent).'</pre>');
 233
 234                 // Was that eval okay?
 235                 if (empty($newContent)) {
 236                         // Something went wrong!
 237                         debug_report_bug(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
 238                 } // END - if
 239
 240                 // Use it again
 241                 $code = $newContent;
 242
 243                 // Count round
 244                 $count++;
 245         } // END - while
 246
 247         // Return the compiled code
 248         return $code;
 249 }
 250
 251 // Output the raw HTML code
 252 function outputRawCode ($htmlCode) {
 253         // Output stripped HTML code to avoid broken JavaScript code, etc.
 254         print(str_replace('{BACK}', "\\", $htmlCode));
 255
 256         // Flush the output if only getPhpCaching() is not 'on'
 257         if (getPhpCaching() != 'on') {
 258                 // Flush it
 259                 flush();
 260         } // END - if
 261 }
 262
 263 // Load a template file and return it's content (only it's name; do not use ' or ")
 264 function loadTemplate ($template, $return = false, $content = array(), $compileCode = true) {
 265         // @TODO Remove this sanity-check if all is fine
 266         if (!is_bool($return)) debug_report_bug(__FUNCTION__, __LINE__, 'return is not bool (' . gettype($return) . ')');
 267
 268         // Set current template
 269         $GLOBALS['current_template'] = $template;
 270
 271         // Do we have cache?
 272         if ((!isDebuggingTemplateCache()) && (isTemplateCached($template))) {
 273                 // Evaluate the cache
 274                 eval(readTemplateCache($template));
 275         } elseif (!isset($GLOBALS['template_eval'][$template])) {
 276                 // Make all template names lowercase
 277                 $template = strtolower($template);
 278
 279                 // Init some data
 280                 $ret = '';
 281
 282                 // Base directory
 283                 $basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
 284                 $extraPath = detectExtraTemplatePath($template);
 285
 286                 // Generate FQFN
 287                 $FQFN = $basePath . $extraPath . $template . '.tpl';
 288
 289                 // Does the special template exists?
 290                 if (!isFileReadable($FQFN)) {
 291                         // Reset to default template
 292                         $FQFN = $basePath . $template . '.tpl';
 293                 } // END - if
 294
 295                 // Now does the final template exists?
 296                 if (isFileReadable($FQFN)) {
 297                         // Count the template load
 298                         incrementConfigEntry('num_templates');
 299
 300                         // The local file does exists so we load it. :)
 301                         $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
 302
 303                         // Do we have to compile the code?
 304                         $ret = '';
 305                         if ((strpos($GLOBALS['tpl_content'][$template], '$') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{--') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{?') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{%') !== false)) {
 306                                 // Normal HTML output?
 307                                 if (isHtmlOutputMode()) {
 308                                         // Add surrounding HTML comments to help finding bugs faster
 309                                         $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
 310
 311                                         // Prepare eval() command
 312                                         $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
 313                                 } elseif (substr($template, 0, 3) == 'js_') {
 314                                         // JavaScripts don't like entities and timings
 315                                         $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
 316                                 } else {
 317                                         // Prepare eval() command, other output doesn't like entities, maybe
 318                                         $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
 319                                 }
 320                         } else {
 321                                 // Add surrounding HTML comments to help finding bugs faster
 322                                 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
 323                                 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
 324                         } // END - if
 325                 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
 326                         // Only admins shall see this warning or when installation mode is active
 327                         $ret = '<div class="para">
 328         <span class="notice">{--TEMPLATE_404--}</span>
 329 </div>
 330 <div class="para">
 331         (' . $template . ')
 332 </div>
 333 <div class="para">
 334         {--TEMPLATE_CONTENT--}:
 335         <pre>' . print_r($content, true) . '</pre>
 336 </div>';
 337                 } else {
 338                         // No file!
 339                         $GLOBALS['template_eval'][$template] = '404';
 340                 }
 341         }
 342
 343         // Code set?
 344         if ((isset($GLOBALS['template_eval'][$template])) && ($GLOBALS['template_eval'][$template] != '404')) {
 345                 // Eval the code
 346                 eval($GLOBALS['template_eval'][$template]);
 347         } // END - if
 348
 349         // Do we have some content to output or return?
 350         if (!empty($ret)) {
 351                 // Not empty so let's put it out! ;)
 352                 if ($return === true) {
 353                         // Return the HTML code
 354                         return $ret;
 355                 } else {
 356                         // Output directly
 357                         outputHtml($ret);
 358                 }
 359         } elseif (isDebugModeEnabled()) {
 360                 // Warning, empty output!
 361                 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
 362         }
 363 }
 364
 365 // Detects the extra template path from given template name
 366 function detectExtraTemplatePath ($template) {
 367         // Default is empty
 368         $extraPath = '';
 369
 370         // Do we have cache?
 371         if (!isset($GLOBALS['extra_path'][$template])) {
 372                 // Check for admin/guest/member/etc. templates
 373                 if (substr($template, 0, 6) == 'admin_') {
 374                         // Admin template found
 375                         $extraPath = 'admin/';
 376                 } elseif (substr($template, 0, 6) == 'guest_') {
 377                         // Guest template found
 378                         $extraPath = 'guest/';
 379                 } elseif (substr($template, 0, 7) == 'member_') {
 380                         // Member template found
 381                         $extraPath = 'member/';
 382                 } elseif (substr($template, 0, 7) == 'select_') {
 383                         // Selection template found
 384                         $extraPath = 'select/';
 385                 } elseif (substr($template, 0, 8) == 'install_') {
 386                         // Installation template found
 387                         $extraPath = 'install/';
 388                 } elseif (substr($template, 0, 4) == 'ext_') {
 389                         // Extension template found
 390                         $extraPath = 'ext/';
 391                 } elseif (substr($template, 0, 3) == 'la_') {
 392                         // 'Logical-area' template found
 393                         $extraPath = 'la/';
 394                 } elseif (substr($template, 0, 3) == 'js_') {
 395                         // JavaScript template found
 396                         $extraPath = 'js/';
 397                 } elseif (substr($template, 0, 5) == 'menu_') {
 398                         // Menu template found
 399                         $extraPath = 'menu/';
 400                 } else {
 401                         // Test for extension
 402                         $test = substr($template, 0, strpos($template, '_'));
 403
 404                         // Probe for valid extension name
 405                         if (isExtensionNameValid($test)) {
 406                                 // Set extra path to extension's name
 407                                 $extraPath = $test . '/';
 408                         } // END - if
 409                 }
 410
 411                 // Store it in cache
 412                 $GLOBALS['extra_path'][$template] = $extraPath;
 413         } // END - if
 414
 415         // Return result
 416         return $GLOBALS['extra_path'][$template];
 417 }
 418
 419 // Loads an email template and compiles it
 420 function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadUserData = true) {
 421         global $DATA;
 422
 423         // Make sure all template names are lowercase!
 424         $template = strtolower($template);
 425
 426         // Is content an array?
 427         if (is_array($content)) {
 428                 // Add expiration to array
 429                 if ((isConfigEntrySet('auto_purge')) && (getAutoPurge() == '0')) {
 430                         // Will never expire!
 431                         $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
 432                 } elseif (isConfigEntrySet('auto_purge')) {
 433                         // Create nice date string
 434                         $content['expiration'] = '{%pipe,getAutoPurge,createFancyTime%}';
 435                 } else {
 436                         // Missing entry
 437                         $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
 438                 }
 439         } // END - if
 440
 441         // Load user's data
 442         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content));
 443         if ((isValidUserId($userid)) && (is_array($content))) {
 444                 // If nickname extension is installed, fetch nickname as well
 445                 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
 446                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME!<br />");
 447                         // Load by nickname
 448                         fetchUserData($userid, 'nickname');
 449                 } else {
 450                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK!<br />");
 451                         /// Load by userid
 452                         fetchUserData($userid);
 453                 }
 454
 455                 // Merge data if valid
 456                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
 457                 if ((isUserDataValid()) && ($loadUserData === true)) {
 458                         $content = merge_array($content, getUserDataArray());
 459                 } // END - if
 460                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
 461         } // END - if
 462
 463         // Base directory
 464         $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
 465
 466         // Detect extra path
 467         $extraPath = detectExtraTemplatePath($template);
 468
 469         // Generate full FQFN
 470         $FQFN = $basePath . $extraPath . $template . '.tpl';
 471
 472         // Does the special template exists?
 473         if (!isFileReadable($FQFN)) {
 474                 // Reset to default template
 475                 $FQFN = $basePath . $template . '.tpl';
 476         } // END - if
 477
 478         // Now does the final template exists?
 479         $newContent = '';
 480         if (isFileReadable($FQFN)) {
 481                 // The local file does exists so we load it. :)
 482                 $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
 483
 484                 // Run code
 485                 $GLOBALS['tpl_content'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
 486                 eval($GLOBALS['tpl_content'][$template]);
 487         } elseif (!empty($template)) {
 488                 // Template file not found
 489                 $newContent = '<div class="para">
 490         {--TEMPLATE_404--}: ' . $template . '
 491 </div>
 492 <div class="para">
 493         {--TEMPLATE_CONTENT--}:
 494         <pre>' . print_r($content, true) . '</pre>
 495         {--TEMPLATE_DATA--}:
 496         <pre>' . print_r($DATA, true) . '</pre>
 497 </div>';
 498
 499                 // Debug mode not active? Then remove the HTML tags
 500                 if (!isDebugModeEnabled()) {
 501                         // Remove HTML tags
 502                         $newContent = secureString($newContent);
 503                 } // END - if
 504         } else {
 505                 // No template name supplied!
 506                 $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
 507         }
 508
 509         // Is there some content?
 510         if (empty($newContent)) {
 511                 // Compiling failed
 512                 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'][$template];
 513
 514                 // Add last error if the required function exists
 515                 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
 516         } // END - if
 517
 518         // Remove content and data
 519         unset($content);
 520         unset($DATA);
 521
 522         // Return content
 523         return $newContent;
 524 }
 525
 526 // "Getter" for menu CSS classes, mainly used in templates
 527 function getMenuCssClasses ($data) {
 528         // $data needs to be converted into an array
 529         $content = explode('|', $data);
 530
 531         // Non-existent index 2 will happen in menu blocks
 532         if (!isset($content[2])) $content[2] = '';
 533
 534         // Re-construct the array: 0=visible,1=locked,2=prefix
 535         $content['visible'] = $content[0];
 536         $content['locked']  = $content[1];
 537
 538         // Call our "translator" function
 539         $content = translateMenuVisibleLocked($content, $content[2]);
 540
 541         // Return CSS classes
 542         return ($content['visible_css'] . ' ' . $content['locked_css']);
 543 }
 544
 545 // Generate XHTML code for the CAPTCHA
 546 function generateCaptchaCode ($code, $type, $type, $userid) {
 547         return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&amp;' . $type . '=' . $type . '&amp;mode=img&amp;code=' . $code . '%}" />';
 548 }
 549
 550 // Compiles the given HTML/mail code
 551 function compileCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
 552         // Is the code a string or should we not compile?
 553         if ((!is_string($code)) || ($compileCode === false)) {
 554                 // Silently return it
 555                 return $code;
 556         } // END - if
 557
 558         // Start couting
 559         $startCompile = microtime(true);
 560
 561         // Comile the code
 562         $code = compileRawCode($code, $simple, $constants, $full);
 563
 564         // Get timing
 565         $compiled = microtime(true);
 566
 567         // Add timing if enabled
 568         if (isTemplateHtml()) {
 569                 // Add timing, this should be disabled in
 570                 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
 571         } // END - if
 572
 573         // Return compiled code
 574         return $code;
 575 }
 576
 577 // Compiles the code (use compileCode() only for HTML because of the comments)
 578 // @TODO $simple/$constants are deprecated
 579 function compileRawCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
 580         // Is the code a string or shall we not compile?
 581         if ((!is_string($code)) || ($compileCode === false)) {
 582                 // Silently return it
 583                 return $code;
 584         } // END - if
 585
 586         // Init replacement-array with smaller set of security characters
 587         $secChars = $GLOBALS['url_chars'];
 588
 589         // Select full set of chars to replace when we e.g. want to compile URLs
 590         if ($full === true) {
 591                 $secChars = $GLOBALS['security_chars'];
 592         } // END - if
 593
 594         // Compile more through a filter
 595         $code = runFilterChain('compile_code', $code);
 596
 597         // Compile message strings
 598         $code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
 599
 600         // Compile QUOT and other non-HTML codes
 601         $code = str_replace($secChars['to'], $secChars['from'], $code);
 602
 603         // Find $content[bla][blub] entries
 604         // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
 605         preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
 606
 607         // Are some matches found?
 608         if ((count($matches) > 0) && (count($matches[0]) > 0)) {
 609                 // Replace all matches
 610                 $matchesFound = array();
 611                 foreach ($matches[0] as $key => $match) {
 612                         // Fuzzy look has failed by default
 613                         $fuzzyFound = false;
 614
 615                         // Fuzzy look on match if already found
 616                         foreach ($matchesFound as $found => $set) {
 617                                 // Get test part
 618                                 $test = substr($found, 0, strlen($match));
 619
 620                                 // Does this entry exist?
 621                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
 622                                 if ($test == $match) {
 623                                         // Match found
 624                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
 625                                         $fuzzyFound = true;
 626                                         break;
 627                                 } // END - if
 628                         } // END - foreach
 629
 630                         // Skip this entry?
 631                         if ($fuzzyFound === true) continue;
 632
 633                         // Take all string elements
 634                         if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
 635                                 // Replace it in the code
 636                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
 637                                 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
 638                                 $code = str_replace($match, '".' . $newMatch . '."', $code);
 639                                 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
 640                                 $matchesFound[$match] = 1;
 641                         } elseif (!isset($matchesFound[$match])) {
 642                                 // Not yet replaced!
 643                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
 644                                 $code = str_replace($match, '".' . $match . '."', $code);
 645                                 $matchesFound[$match] = 1;
 646                         }
 647                 } // END - foreach
 648         } // END - if
 649
 650         // Return it
 651         return $code;
 652 }
 653
 654 //
 655 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'form_select') {
 656         $OUT = '';
 657
 658         if ($type == 'yn') {
 659                 // This is a yes/no selection only!
 660                 if ($id > 0) $prefix .= '[' . $id . ']';
 661                 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
 662         } else {
 663                 // Begin with regular selection box here
 664                 if (!empty($prefix)) $prefix .= '_';
 665                 $type2 = $type;
 666                 if ($id > 0) $type2 .= '[' . $id . ']';
 667                 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
 668         }
 669
 670         switch ($type) {
 671                 case 'day': // Day
 672                         for ($idx = 1; $idx < 32; $idx++) {
 673                                 $OUT .= '<option value="' . $idx . '"';
 674                                 if ($default == $idx) $OUT .= ' selected="selected"';
 675                                 $OUT .= '>' . $idx . '</option>';
 676                         } // END - for
 677                         break;
 678
 679                 case 'month': // Month
 680                         foreach ($GLOBALS['month_descr'] as $idx => $descr) {
 681                                 $OUT .= '<option value="' . $idx . '"';
 682                                 if ($default == $idx) $OUT .= ' selected="selected"';
 683                                 $OUT .= '>' . $descr . '</option>';
 684                         } // END - for
 685                         break;
 686
 687                 case 'year': // Year
 688                         // Get current year
 689                         $year = getYear();
 690
 691                         // Use configured min age or fixed?
 692                         if (isExtensionInstalledAndNewer('order', '0.2.1')) {
 693                                 // Configured
 694                                 $startYear = $year - getConfig('min_age');
 695                         } else {
 696                                 // Fixed 16 years
 697                                 $startYear = $year - 16;
 698                         }
 699
 700                         // Calculate earliest year (100 years old people can still enter Internet???)
 701                         $minYear = $year - 100;
 702
 703                         // Check if the default value is larger than minimum and bigger than actual year
 704                         if (($default > $minYear) && ($default >= $year)) {
 705                                 for ($idx = $year; $idx < ($year + 11); $idx++) {
 706                                         $OUT .= '<option value="' . $idx . '"';
 707                                         if ($default == $idx) $OUT .= ' selected="selected"';
 708                                         $OUT .= '>' . $idx . '</option>';
 709                                 } // END - for
 710                         } elseif ($default == -1) {
 711                                 // Current year minus 1
 712                                 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
 713                                         $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
 714                                 } // END - for
 715                         } else {
 716                                 // Get current year and subtract the configured minimum age
 717                                 $OUT .= '<option value="' . ($minYear - 1) . '">&lt;' . $minYear . '</option>';
 718                                 // Calculate earliest year depending on extension version
 719                                 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
 720                                         // Use configured minimum age
 721                                         $year = getYear() - getConfig('min_age');
 722                                 } else {
 723                                         // Use fixed 16 years age
 724                                         $year = getYear() - 16;
 725                                 }
 726
 727                                 // Construct year selection list
 728                                 for ($idx = $minYear; $idx <= $year; $idx++) {
 729                                         $OUT .= '<option value="' . $idx . '"';
 730                                         if ($default == $idx) $OUT .= ' selected="selected"';
 731                                         $OUT .= '>' . $idx . '</option>';
 732                                 } // END - for
 733                         }
 734                         break;
 735
 736                 case 'sec':
 737                 case 'min':
 738                         for ($idx = 0; $idx < 60; $idx+=5) {
 739                                 if (strlen($idx) == 1) $idx = '0' . $idx;
 740                                 $OUT .= '<option value="' . $idx . '"';
 741                                 if ($default == $idx) $OUT .= ' selected="selected"';
 742                                 $OUT .= '>' . $idx . '</option>';
 743                         } // END - for
 744                         break;
 745
 746                 case 'hour':
 747                         for ($idx = 0; $idx < 24; $idx++) {
 748                                 if (strlen($idx) == 1) $idx = '0' . $idx;
 749                                 $OUT .= '<option value="' . $idx . '"';
 750                                 if ($default == $idx) $OUT .= ' selected="selected"';
 751                                 $OUT .= '>' . $idx . '</option>';
 752                         } // END - for
 753                         break;
 754
 755                 case 'yn':
 756                         $OUT .= '<option value="Y"';
 757                         if ($default == 'Y') $OUT .= ' selected="selected"';
 758                         $OUT .= '>{--YES--}</option><option value="N"';
 759                         if ($default != 'Y') $OUT .= ' selected="selected"';
 760                         $OUT .= '>{--NO--}</option>';
 761                         break;
 762         }
 763         $OUT .= '</select>';
 764         return $OUT;
 765 }
 766
 767 // Insert the code in $img_code into jpeg or PNG image
 768 function generateImageOrCode ($img_code, $headerSent = true) {
 769         // Is the code size oversized or shouldn't we display it?
 770         if ((strlen($img_code) > 6) || (empty($img_code)) || (getCodeLength() == '0')) {
 771                 // Stop execution of function here because of over-sized code length
 772                 debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getCodeLength());
 773         } elseif ($headerSent === false) {
 774                 // Return an HTML code here
 775                 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
 776         }
 777
 778         // Load image
 779         $img = sprintf("%s/theme/%s/images/code_bg.%s",
 780                 getPath(),
 781                 getCurrentTheme(),
 782                 getImgType()
 783         );
 784
 785         // Is it readable?
 786         if (isFileReadable($img)) {
 787                 // Switch image type
 788                 switch (getImgType()) {
 789                         case 'jpg': // Okay, load image and hide all errors
 790                                 $image = imagecreatefromjpeg($img);
 791                                 break;
 792
 793                         case 'png': // Okay, load image and hide all errors
 794                                 $image = imagecreatefrompng($img);
 795                                 break;
 796                 } // END - switch
 797         } else {
 798                 // Silently log the error
 799                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image-type %s in theme %s not found.", getImgType(), getCurrentTheme()));
 800                 return;
 801         }
 802
 803         // Generate text color (red/green/blue; 0 = dark, 255 = bright)
 804         $text_color = imagecolorallocate($image, 0, 0, 0);
 805
 806         // Insert code into image
 807         imagestring($image, 5, 14, 2, $img_code, $text_color);
 808
 809         // Return to browser
 810         setContentType('image/' . getImgType());
 811
 812         // Output image with matching image factory
 813         switch (getImgType()) {
 814                 case 'jpg': imagejpeg($image); break;
 815                 case 'png': imagepng($image);  break;
 816         } // END - switch
 817
 818         // Remove image from memory
 819         imagedestroy($image);
 820 }
 821 // Create selection box or array of splitted timestamp
 822 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
 823         // Do not continue if ONE_DAY is absend
 824         if (!isConfigEntrySet('ONE_DAY')) {
 825                 // And return the timestamp itself or empty array
 826                 if ($return_array === true) {
 827                         return array();
 828                 } else {
 829                         return $timestamp;
 830                 }
 831         } // END - if
 832
 833         // Calculate 2-seconds timestamp
 834         $stamp = round($timestamp);
 835         //* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
 836
 837         // Do we have a leap year?
 838         $SWITCH = '0';
 839         $TEST = getYear() / 4;
 840         $M1 = getMonth();
 841         $M2 = getMonth(time() + $timestamp);
 842
 843         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
 844         if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02'))  {
 845                 $SWITCH = getOneDay();
 846         } // END - switch
 847
 848         // First of all years...
 849         $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
 850         //* DEBUG: */ debugOutput('Y=' . $Y);
 851         // Next months...
 852         $M = abs(floor($timestamp / 2628000 - $Y * 12));
 853         //* DEBUG: */ debugOutput('M=' . $M);
 854         // Next weeks
 855         $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getOneDay()) / 7) - ($M / 12 * (365 + $SWITCH / getOneDay()) / 7)));
 856         //* DEBUG: */ debugOutput('W=' . $W);
 857         // Next days...
 858         $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getOneDay()) - ($M / 12 * (365 + $SWITCH / getOneDay())) - $W * 7));
 859         //* DEBUG: */ debugOutput('D=' . $D);
 860         // Next hours...
 861         $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getOneDay()) * 24 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24) - $W * 7 * 24 - $D * 24));
 862         //* DEBUG: */ debugOutput('h=' . $h);
 863         // Next minutes..
 864         $m = abs(floor($timestamp / 60 - $Y * (365 + $SWITCH / getOneDay()) * 24 * 60 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24 * 60) - $W * 7 * 24 * 60 - $D * 24 * 60 - $h * 60));
 865         //* DEBUG: */ debugOutput('m=' . $m);
 866         // And at last seconds...
 867         $s = abs(floor($timestamp - $Y * (365 + $SWITCH / getOneDay()) * 24 * 3600 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24 * 3600) - $W * 7 * 24 * 3600 - $D * 24 * 3600 - $h * 3600 - $m * 60));
 868         //* DEBUG: */ debugOutput('s=' . $s);
 869
 870         // Is seconds zero and time is < 60 seconds?
 871         if (($s == '0') && ($timestamp < 60)) {
 872                 // Fix seconds
 873                 $s = round($timestamp);
 874         } // END - if
 875
 876         //
 877         // Now we convert them in seconds...
 878         //
 879         if ($return_array) {
 880                 // Just put all data in an array for later use
 881                 $OUT = array(
 882                         'YEARS'   => $Y,
 883                         'MONTHS'  => $M,
 884                         'WEEKS'   => $W,
 885                         'DAYS'    => $D,
 886                         'HOURS'   => $h,
 887                         'MINUTES' => $m,
 888                         'SECONDS' => $s
 889                 );
 890         } else {
 891                 // Generate table
 892                 $OUT  = '<div align="' . $align . '">';
 893                 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
 894                 $OUT .= '<tr>';
 895
 896                 if (isInString('Y', $display) || (empty($display))) {
 897                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_YEARS--}</strong></td>';
 898                 } // END - if
 899
 900                 if (isInString('M', $display) || (empty($display))) {
 901                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MONTHS--}</strong></td>';
 902                 } // END - if
 903
 904                 if (isInString('W', $display) || (empty($display))) {
 905                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_WEEKS--}</strong></td>';
 906                 } // END - if
 907
 908                 if (isInString('D', $display) || (empty($display))) {
 909                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_DAYS--}</strong></td>';
 910                 } // END - if
 911
 912                 if (isInString('h', $display) || (empty($display))) {
 913                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_HOURS--}</strong></td>';
 914                 } // END - if
 915
 916                 if (isInString('m', $display) || (empty($display))) {
 917                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MINUTES--}</strong></td>';
 918                 } // END - if
 919
 920                 if (isInString('s', $display) || (empty($display))) {
 921                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_SECONDS--}</strong></td>';
 922                 } // END - if
 923
 924                 $OUT .= '</tr>';
 925                 $OUT .= '<tr>';
 926
 927                 if (isInString('Y', $display) || (empty($display))) {
 928                         // Generate year selection
 929                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
 930                         for ($idx = 0; $idx <= 10; $idx++) {
 931                                 $OUT .= '<option class="mini_select" value="' . $idx . '"';
 932                                 if ($idx == $Y) $OUT .= ' selected="selected"';
 933                                 $OUT .= '>' . $idx . '</option>';
 934                         } // END - for
 935                         $OUT .= '</select></td>';
 936                 } else {
 937                         $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
 938                 }
 939
 940                 if (isInString('M', $display) || (empty($display))) {
 941                         // Generate month selection
 942                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
 943                         for ($idx = 0; $idx <= 11; $idx++) {
 944                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
 945                                 if ($idx == $M) $OUT .= ' selected="selected"';
 946                                 $OUT .= '>' . $idx . '</option>';
 947                         } // END - for
 948                         $OUT .= '</select></td>';
 949                 } else {
 950                         $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
 951                 }
 952
 953                 if (isInString('W', $display) || (empty($display))) {
 954                         // Generate week selection
 955                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
 956                         for ($idx = 0; $idx <= 4; $idx++) {
 957                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
 958                                 if ($idx == $W) $OUT .= ' selected="selected"';
 959                                 $OUT .= '>' . $idx . '</option>';
 960                         } // END - for
 961                         $OUT .= '</select></td>';
 962                 } else {
 963                         $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
 964                 }
 965
 966                 if (isInString('D', $display) || (empty($display))) {
 967                         // Generate day selection
 968                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
 969                         for ($idx = 0; $idx <= 31; $idx++) {
 970                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
 971                                 if ($idx == $D) $OUT .= ' selected="selected"';
 972                                 $OUT .= '>' . $idx . '</option>';
 973                         } // END - for
 974                         $OUT .= '</select></td>';
 975                 } else {
 976                         $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
 977                 }
 978
 979                 if (isInString('h', $display) || (empty($display))) {
 980                         // Generate hour selection
 981                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
 982                         for ($idx = 0; $idx <= 23; $idx++) {
 983                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
 984                                 if ($idx == $h) $OUT .= ' selected="selected"';
 985                                 $OUT .= '>' . $idx . '</option>';
 986                         } // END - for
 987                         $OUT .= '</select></td>';
 988                 } else {
 989                         $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
 990                 }
 991
 992                 if (isInString('m', $display) || (empty($display))) {
 993                         // Generate minute selection
 994                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
 995                         for ($idx = 0; $idx <= 59; $idx++) {
 996                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
 997                                 if ($idx == $m) $OUT .= ' selected="selected"';
 998                                 $OUT .= '>' . $idx . '</option>';
 999                         } // END - for
1000                         $OUT .= '</select></td>';
1001                 } else {
1002                         $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1003                 }
1004
1005                 if (isInString('s', $display) || (empty($display))) {
1006                         // Generate second selection
1007                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1008                         for ($idx = 0; $idx <= 59; $idx++) {
1009                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1010                                 if ($idx == $s) $OUT .= ' selected="selected"';
1011                                 $OUT .= '>' . $idx . '</option>';
1012                         } // END - for
1013                         $OUT .= '</select></td>';
1014                 } else {
1015                         $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1016                 }
1017                 $OUT .= '</tr>';
1018                 $OUT .= '</table>';
1019                 $OUT .= '</div>';
1020         }
1021
1022         // Return generated HTML code
1023         return $OUT;
1024 }
1025
1026 // Generate a list of administrative links to a given userid
1027 function generateMemberAdminActionLinks ($userid) {
1028         // Make sure userid is a number
1029         if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
1030
1031         // Define all main targets
1032         $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
1033
1034         // Get user status
1035         $status = getFetchedUserData('userid', $userid, 'status');
1036
1037         // Begin of navigation links
1038         $OUT = '[';
1039
1040         foreach ($targetArray as $tar) {
1041                 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&amp;what=' . $tar . '&amp;userid=' . $userid . '%}" title="{--ADMIN_USER_ACTION_LINK_';
1042                 //* DEBUG: */ debugOutput('*' . $tar.'/' . $status.'*');
1043                 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1044                         // Locked accounts shall be unlocked
1045                         $OUT .= 'UNLOCK_USER';
1046                 } elseif ($tar == 'del_user') {
1047                         // @TODO Deprecate this thing
1048                         $OUT .= 'DELETE_USER';
1049                 } else {
1050                         // All other status is fine
1051                         $OUT .= strtoupper($tar);
1052                 }
1053                 $OUT .= '_TITLE--}">{--ADMIN_USER_ACTION_LINK_';
1054                 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1055                         // Locked accounts shall be unlocked
1056                         $OUT .= 'UNLOCK_USER';
1057                 } elseif ($tar == 'del_user') {
1058                         // @TODO Deprecate this thing
1059                         $OUT .= 'DELETE_USER';
1060                 } else {
1061                         // All other status is fine
1062                         $OUT .= strtoupper($tar);
1063                 }
1064                 $OUT .= '--}</a></span>|';
1065         } // END - foreach
1066
1067         // Finish navigation link
1068         $OUT = substr($OUT, 0, -1) . ']';
1069
1070         // Return string
1071         return $OUT;
1072 }
1073
1074 // Generate an email link
1075 function generateEmailLink ($email, $table = 'admins') {
1076         // Default email link (INSECURE! Spammer can read this by harvester programs)
1077         $EMAIL = 'mailto:' . $email;
1078
1079         // Check for several extensions
1080         if ((isExtensionActive('admins')) && ($table == 'admins')) {
1081                 // Create email link for contacting admin in guest area
1082                 $EMAIL = generateAdminEmailLink($email);
1083         } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
1084                 // Create email link for contacting a member within admin area (or later in other areas, too?)
1085                 $EMAIL = generateUserEmailLink($email);
1086         } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
1087                 // Create email link to contact sponsor within admin area (or like the link above?)
1088                 $EMAIL = generateSponsorEmailLink($email);
1089         }
1090
1091         // Shall I close the link when there is no admin?
1092         if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
1093
1094         // Return email link
1095         return $EMAIL;
1096 }
1097
1098 // Output error messages in a fasioned way and die...
1099 function app_die ($F, $L, $message) {
1100         // Check if Script is already dieing and not let it kill itself another 1000 times
1101         if (isset($GLOBALS['app_died'])) {
1102                 // Script tried to kill itself twice
1103                 die('[' . __FUNCTION__ . ':' . __LINE__ . ']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
1104         } // END - if
1105
1106         // Make sure, that the script realy realy diese here and now
1107         $GLOBALS['app_died'] = true;
1108
1109         // Set content type as text/html
1110         setContentType('text/html');
1111
1112         // Load header
1113         loadIncludeOnce('inc/header.php');
1114
1115         // Rewrite message for output
1116         $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
1117
1118         // Load the message template
1119         loadTemplate('app_die_message', false, $message);
1120
1121         // Load footer
1122         loadIncludeOnce('inc/footer.php');
1123 }
1124
1125 // Display parsing time and number of SQL queries in footer
1126 function displayParsingTime () {
1127         // Is the timer started?
1128         if (!isset($GLOBALS['startTime'])) {
1129                 // Abort here
1130                 return false;
1131         } // END - if
1132
1133         // Get end time
1134         $endTime = microtime(true);
1135
1136         // "Explode" both times
1137         $start = explode(' ', $GLOBALS['startTime']);
1138         $end = explode(' ', $endTime);
1139         $runTime = $end[0] - $start[0];
1140         if ($runTime < 0) {
1141                 $runTime = '0';
1142         } // END - if
1143
1144         // Prepare output
1145         // @TODO This can be easily moved out after the merge from EL branch to this is complete
1146         $content = array(
1147                 'run_time' => $runTime,
1148                 'sql_time' => (getConfig('sql_time') * 1000),
1149         );
1150
1151         // Load the template
1152         $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
1153 }
1154
1155 // Output a debug backtrace to the user
1156 function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
1157         // Is this already called?
1158         if (isset($GLOBALS[__FUNCTION__])) {
1159                 // Other backtrace
1160                 print 'Message:' . $message . '<br />Backtrace:<pre>';
1161                 debug_print_backtrace();
1162                 die('</pre>');
1163         } // END - if
1164
1165         // Set this function as called
1166         $GLOBALS[__FUNCTION__] = true;
1167
1168         // Init message
1169         $debug = '';
1170
1171         // Is the optional message set?
1172         if (!empty($message)) {
1173                 // Use and log it
1174                 $debug = sprintf("Note: %s<br />\n",
1175                         $message
1176                 );
1177
1178                 // @TODO Add a little more infos here
1179                 logDebugMessage($F, $L, strip_tags($message));
1180         } // END - if
1181
1182         // Add output
1183         $debug .= 'Please report this bug at <a title="Direct link to the bug-tracker" href="http://bugs.mxchange.org" rel="external" target="_blank">http://bugs.mxchange.org</a> and include the logfile from <strong>' . str_replace(getPath(), '', getCachePath()) . 'debug.log</strong> in your report (you can now attach files):<pre>';
1184         $debug .= debug_get_printable_backtrace();
1185         $debug .= '</pre>';
1186         $debug .= '<div class="para">Request-URI: ' . getRequestUri() . '</div>';
1187         $debug .= '<div class="para">Thank you for finding bugs.</div>';
1188
1189         // Send an email? (e.g. not wanted for evaluation errors)
1190         if (($sendEmail === true) && (!isInstallationPhase())) {
1191                 // Prepare content
1192                 $content = array(
1193                         'message'   => trim($message),
1194                         'backtrace' => trim(debug_get_mailable_backtrace())
1195                 );
1196
1197                 // Send email to webmaster
1198                 sendAdminNotification('{--DEBUG_REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
1199         } // END - if
1200
1201         // And abort here
1202         app_die($F, $L, $debug);
1203 }
1204
1205 // Compile characters which are allowed in URLs
1206 function compileUriCode ($code, $simple = true) {
1207         // Compile constants
1208         if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
1209
1210         // Compile QUOT and other non-HTML codes
1211         $code = str_replace('{DOT}', '.',
1212                 str_replace('{SLASH}', '/',
1213                 str_replace('{QUOT}', "'",
1214                 str_replace('{DOLLAR}', '$',
1215                 str_replace('{OPEN_ANCHOR}', '(',
1216                 str_replace('{CLOSE_ANCHOR}', ')',
1217                 str_replace('{OPEN_SQR}', '[',
1218                 str_replace('{CLOSE_SQR}', ']',
1219                 str_replace('{PER}', '%',
1220                 $code
1221         )))))))));
1222
1223         // Return compiled code
1224         return $code;
1225 }
1226
1227 // Handle message codes from URL
1228 function handleCodeMessage () {
1229         if (isGetRequestParameterSet('code')) {
1230                 // Default extension is 'unknown'
1231                 $ext = 'unknown';
1232
1233                 // Is extension given?
1234                 if (isGetRequestParameterSet('ext')) {
1235                         $ext = getRequestParameter('ext');
1236                 } // END - if
1237
1238                 // Convert the 'code' parameter from URL to a human-readable message
1239                 $message = getMessageFromErrorCode(getRequestParameter('code'));
1240
1241                 // Load message template
1242                 loadTemplate('message', false, $message);
1243         } // END - if
1244 }
1245
1246 // Generates a 'extension foo out-dated' message
1247 function generateExtensionOutdatedMessage ($ext_name, $ext_ver) {
1248         // Is the extension empty?
1249         if (empty($ext_name)) {
1250                 // This should not happen
1251                 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1252         } // END - if
1253
1254         // Default message
1255         $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_OUTDATED', $ext_name);
1256
1257         // Is an admin logged in?
1258         if (isAdmin()) {
1259                 // Then output admin message
1260                 $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE'), $ext_name, $ext_name, $ext_ver);
1261         } // END - if
1262
1263         // Return prepared message
1264         return $message;
1265 }
1266
1267 // Generates a 'extension foo inactive' message
1268 function generateExtensionInactiveMessage ($ext_name) {
1269         // Is the extension empty?
1270         if (empty($ext_name)) {
1271                 // This should not happen
1272                 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1273         } // END - if
1274
1275         // Default message
1276         $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1277
1278         // Is an admin logged in?
1279         if (isAdmin()) {
1280                 // Then output admin message
1281                 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1282         } // END - if
1283
1284         // Return prepared message
1285         return $message;
1286 }
1287
1288 // Generates a 'extension foo not installed' message
1289 function generateExtensionNotInstalledMessage ($ext_name) {
1290         // Is the extension empty?
1291         if (empty($ext_name)) {
1292                 // This should not happen
1293                 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1294         } // END - if
1295
1296         // Default message
1297         $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1298
1299         // Is an admin logged in?
1300         if (isAdmin()) {
1301                 // Then output admin message
1302                 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1303         } // END - if
1304
1305         // Return prepared message
1306         return $message;
1307 }
1308
1309 // Generates a message depending on if the extension is not installed or not
1310 // just activated
1311 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
1312         // Init message
1313         $message = '';
1314
1315         // Is the extension not installed or just deactivated?
1316         switch (isExtensionInstalled($ext_name)) {
1317                 case true; // Deactivated!
1318                         $message = generateExtensionInactiveMessage($ext_name);
1319                         break;
1320
1321                 case false; // Not installed!
1322                         $message = generateExtensionNotInstalledMessage($ext_name);
1323                         break;
1324
1325                 default: // Should not happen!
1326                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
1327                         $message = sprintf("Invalid state of extension %s detected.", $ext_name);
1328                         break;
1329         } // END - switch
1330
1331         // Return the message
1332         return $message;
1333 }
1334
1335 // Print code with line numbers
1336 function linenumberCode ($code)    {
1337         if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
1338         $count_lines = count($codeE);
1339
1340         $r = 'Line | Code:<br />';
1341         foreach ($codeE as $line => $c) {
1342                 $r .= '<div class="line"><span class="linenum">';
1343                 if ($count_lines == 1) {
1344                         $r .= 1;
1345                 } else {
1346                         $r .= ($line == ($count_lines - 1)) ? '' :  ($line+1);
1347                 }
1348                 $r .= '</span>|';
1349
1350                 // Add code
1351                 $r .= '<span class="linetext">' . encodeEntities($c) . '</span></div>';
1352         } // END - foreach
1353
1354         return '<div class="code">' . $r . '</div>';
1355 }
1356
1357 // Determines the right page title
1358 function determinePageTitle () {
1359         // Config and database connection valid?
1360         if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1361                 // Init title
1362                 $TITLE = '';
1363
1364                 // Title decoration enabled?
1365                 if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
1366
1367                 // Do we have some extra title?
1368                 if (isExtraTitleSet()) {
1369                         // Then prepent it
1370                         $TITLE .= getExtraTitle() . ' by ';
1371                 } // END - if
1372
1373                 // Add main title
1374                 $TITLE .= getMainTitle();
1375
1376                 // Add title of module? (middle decoration will also be added!)
1377                 if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
1378                         $TITLE .= ' ' . trim(getConfig('title_middle')) . ' {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
1379                 } // END - if
1380
1381                 // Add title from what file
1382                 $mode = '';
1383                 if (getModule() == 'login') $mode = 'member';
1384                 elseif (getModule() == 'index') $mode = 'guest';
1385                 if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
1386
1387                 // Add title decorations? (right)
1388                 if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
1389
1390                 // Remember title in constant for the template
1391                 $pageTitle = $TITLE;
1392         } elseif ((isInstalled()) && (isAdminRegistered())) {
1393                 // Installed, admin registered but no ext-sql_patches
1394                 $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
1395         } elseif ((isInstalled()) && (!isAdminRegistered())) {
1396                 // Installed but no admin registered
1397                 $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
1398         } elseif ((!isInstalled()) || (!isAdminRegistered())) {
1399                 // Installation mode
1400                 $pageTitle = '{--INSTALLER_OF_MAILER--}';
1401         } else {
1402                 // Configuration not found
1403                 $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
1404
1405                 // Do not add the fatal message in installation mode
1406                 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
1407         }
1408
1409         // Return title
1410         return decodeEntities($pageTitle);
1411 }
1412
1413 // Checks wethere there is a cache file there. This function is cached.
1414 function isTemplateCached ($template) {
1415         // Do we have cached this result?
1416         if (!isset($GLOBALS['template_cache'][$template])) {
1417                 // Generate FQFN
1418                 $FQFN = generateCacheFqfn($template);
1419
1420                 // Is it there?
1421                 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
1422         } // END - if
1423
1424         // Return it
1425         return $GLOBALS['template_cache'][$template];
1426 }
1427
1428 // Flushes non-flushed template cache to disk
1429 function flushTemplateCache ($template, $eval) {
1430         // Is this cache flushed?
1431         if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
1432                 // Generate FQFN
1433                 $FQFN = generateCacheFqfn($template);
1434
1435                 // And flush it
1436                 writeToFile($FQFN, $eval, true);
1437         } // END - if
1438 }
1439
1440 // Reads a template cache
1441 function readTemplateCache ($template) {
1442         // Check it again
1443         if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
1444                 // This should not happen
1445                 debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
1446         } // END - if
1447
1448         // Is it cached?
1449         if (!isset($GLOBALS['template_eval'][$template])) {
1450                 // Generate FQFN
1451                 $FQFN = generateCacheFqfn($template);
1452
1453                 // And read from it
1454                 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
1455         } // END - if
1456
1457         // And return it
1458         return $GLOBALS['template_eval'][$template];
1459 }
1460
1461 // Escapes quotes (default is only double-quotes)
1462 function escapeQuotes ($str, $single = false) {
1463         // Should we escape all?
1464         if ($single === true) {
1465                 // Escape all (including null)
1466                 $str = addslashes($str);
1467         } else {
1468                 // Remove escaping of single quotes
1469                 $str = str_replace("\\'", "'", $str);
1470
1471                 // Escape only double-quotes but prevent double-quoting
1472                 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
1473         }
1474
1475         // Return the escaped string
1476         return $str;
1477 }
1478
1479 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
1480 function escapeJavaScriptQuotes ($str) {
1481         // Replace all double-quotes and secure back-ticks
1482         $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
1483
1484         // Return it
1485         return $str;
1486 }
1487
1488 // Send out mails depending on the 'mod/modes' combination
1489 // @TODO Lame description for this function
1490 function sendModeMails ($mod, $modes) {
1491         // Init user data
1492         $content = array ();
1493
1494         // Load hash
1495         if (fetchUserData(getMemberId())) {
1496                 // Extract salt from cookie
1497                 $salt = substr(getSession('u_hash'), 0, -40);
1498
1499                 // Now let's compare passwords
1500                 $hash = encodeHashForCookie(getUserData('password'));
1501
1502                 // Does the hash match or should we change it?
1503                 if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
1504                         // Load the data
1505                         $content = getUserDataArray();
1506
1507                         // Clear/init the content variable
1508                         $content['message'] = '';
1509
1510                         // Which mail?
1511                         // @TODO Move this in a filter
1512                         switch ($mod) {
1513                                 case 'mydata':
1514                                         foreach ($modes as $mode) {
1515                                                 switch ($mode) {
1516                                                         case 'normal': break; // Do not add any special lines
1517                                                         case 'email': // Email was changed!
1518                                                                 $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
1519                                                                 break;
1520
1521                                                         case 'password': // Password was changed
1522                                                                 $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
1523                                                                 break;
1524
1525                                                         default:
1526                                                                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
1527                                                                 $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
1528                                                                 break;
1529                                                 } // END - switch
1530                                         } // END - foreach
1531
1532                                         if (isExtensionActive('country')) {
1533                                                 // Replace code with description
1534                                                 $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
1535                                         } // END - if
1536
1537                                         // Merge content with data from POST
1538                                         $content = merge_array($content, postRequestArray());
1539
1540                                         // Load template
1541                                         $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
1542
1543                                         if (isAdminNotificationEnabled()) {
1544                                                 // The admin needs to be notified about a profile change
1545                                                 $message_admin = 'admin_mydata_notify';
1546                                                 $sub_adm   = '{--ADMIN_CHANGED_DATA--}';
1547                                         } else {
1548                                                 // No mail to admin
1549                                                 $message_admin = '';
1550                                                 $sub_adm   = '';
1551                                         }
1552
1553                                         // Set subject lines
1554                                         $sub_mem = '{--MEMBER_CHANGED_DATA--}';
1555
1556                                         // Output success message
1557                                         $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1558                                         break;
1559
1560                                 default: // Unsupported module!
1561                                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
1562                                         $content['message'] = '<span class="notice">{--UNKNOWN_MODULE--}</span>';
1563                                         break;
1564                         } // END - switch
1565                 } else {
1566                         // Passwords mismatch
1567                         $content['message'] = '<span class="notice">{--MEMBER_PASSWORD_ERROR--}</span>';
1568                 }
1569         } else {
1570                 // Could not load profile
1571                 $content['message'] = '<span class="notice">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
1572         }
1573
1574         // Send email to user if required
1575         if ((!empty($sub_mem)) && (!empty($message)) && (!empty($content['email']))) {
1576                 // Send member mail
1577                 sendEmail($content['email'], $sub_mem, $message);
1578         } // END - if
1579
1580         // Send only if no other error has occured
1581         if ((!empty($sub_adm)) && (!empty($message_admin)) && (isAdminNotificationEnabled())) {
1582                 // Send admin mail
1583                 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
1584         } elseif (isAdminNotificationEnabled()) {
1585                 // Cannot send mails to admin!
1586                 $content['message'] = '{--CANNOT_SEND_ADMIN_MAILS--}';
1587         } else {
1588                 // No mail to admin
1589                 $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1590         }
1591
1592         // Load template
1593         displayMessage($content['message']);
1594 }
1595
1596 // Generates a 'selection box' from given array
1597 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
1598         // Start the output
1599         $OUT = '<select name="' . $name . '" size="1" class="form_select">
1600 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
1601
1602         // Walk through all options
1603         foreach ($options as $option) {
1604                 // Add the <option> entry from ...
1605                 if (empty($optionContent)) {
1606                         // ... template
1607                         $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
1608                 } else {
1609                         // ... direct HTML code
1610                         $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
1611                 }
1612         } // END - foreach
1613
1614         // Finish selection box
1615         $OUT .= '</select>';
1616
1617         // Prepare output
1618         $content = array(
1619                 'selection_box' => $OUT,
1620         );
1621
1622         // Load template and return it
1623         return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
1624 }
1625
1626 // Prepares the header for HTML output
1627 function loadHtmlHeader () {
1628         // Run two filters:
1629         // 1.) pre_page_header (mainly loads the page_header template and includes
1630         //     meta description)
1631         runFilterChain('pre_page_header');
1632
1633         // Here can be something be added, but normally one of the two filters
1634         // around this line should do the job for you.
1635
1636         // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
1637         //     to close the head-tag)
1638         // Include more header data here
1639         runFilterChain('post_page_header');
1640 }
1641
1642 // Adds page header and footer to output array element
1643 function addPageHeaderFooter () {
1644         // Init output
1645         $OUT = '';
1646
1647         // Add them all together. This is maybe to simple
1648         foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
1649                 // Add page part if set
1650                 if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
1651         } // END - foreach
1652
1653         // Transfer $OUT to 'output'
1654         $GLOBALS['output'] = $OUT;
1655 }
1656
1657 // Generates meta description for current module and 'what' value
1658 function generateMetaDescriptionCode () {
1659         // Only include from guest area and if sql_patches has correct version
1660         if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1661                 // Construct dynamic description
1662                 $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
1663
1664                 // Output it directly
1665                 $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
1666         } // END - if
1667
1668         // Remove depth
1669         unset($GLOBALS['ref_level']);
1670 }
1671
1672 // Generates an FQFN for template cache from the given template name
1673 function generateCacheFqfn ($template, $mode = 'html') {
1674         // Is this cached?
1675         if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
1676                 // Generate the FQFN
1677                 $GLOBALS['template_cache_fqfn'][$template] = sprintf(
1678                         "%s_compiled/%s/%s.tpl.cache",
1679                         getCachePath(),
1680                         $mode,
1681                         $template
1682                 );
1683         } // END - if
1684
1685         // Return it
1686         return $GLOBALS['template_cache_fqfn'][$template];
1687 }
1688
1689 // "Fixes" null or empty string to count of dashes
1690 function fixNullEmptyToDashes ($str, $num) {
1691         // Use str as default
1692         $return = $str;
1693
1694         // Is it empty?
1695         if ((is_null($str)) || (trim($str) == '')) {
1696                 // Set it
1697                 $return = str_repeat('-', $num);
1698         } // END - if
1699
1700         // Return final string
1701         return $return;
1702 }
1703
1704 // Translates the "pool type" into human-readable
1705 function translatePoolType ($type) {
1706         // Return "translation"
1707         return sprintf("{--POOL_TYPE_%s--}", strtoupper($type));
1708 }
1709
1710 // Displays given message in admin_settings_saved template
1711 function displayMessage ($message, $return = false) {
1712         // Load the template
1713         return loadTemplate('admin_settings_saved', $return, $message);
1714 }
1715
1716 //-----------------------------------------------------------------------------
1717 //                      Template helper functions for EL
1718 //-----------------------------------------------------------------------------
1719
1720 // Color-switch helper function
1721 function doTemplateColorSwitch ($template, $clear = false, $return = true) {
1722         // Is it there?
1723         if (!isset($GLOBALS['color_switch'][$template])) {
1724                 // Initialize it
1725                 initTemplateColorSwitch($template);
1726         } elseif ($clear === false) {
1727                 // Switch color if called from loadTemplate()
1728                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $template);
1729                 $GLOBALS['color_switch'][$template] = 3 - $GLOBALS['color_switch'][$template];
1730         }
1731
1732         // Return CSS class name
1733         if ($return === true) {
1734                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $template . '=' . $GLOBALS['color_switch'][$template]);
1735                 return 'switch_sw' . $GLOBALS['color_switch'][$template];
1736         } // END - if
1737 }
1738
1739 // Helper function for extension registration link
1740 function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
1741         // Default is all non-productive
1742         $OUT = '<em style="cursor:help" class="notice" title="{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK_TITLE=' . $ext_name . '%}">{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}</em>';
1743
1744         // Is the given extension non-productive?
1745         if (isExtensionProductive($ext_name)) {
1746                 // Productive code
1747                 $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&amp;what=extensions&amp;reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
1748         } // END - if
1749
1750         // Return code
1751         return $OUT;
1752 }
1753
1754 // Helper function to create bonus mail admin links
1755 function doTemplateAdminBonusMailLinks ($template, $bonusId) {
1756         // Call the inner function
1757         return generateAdminMailLinks('bid', $bonusId);
1758 }
1759
1760 // Helper function to create member mail admin links
1761 function doTemplateAdminMemberMailLinks ($template, $mailId) {
1762         // Call the inner function
1763         return generateAdminMailLinks('mid', $mailId);
1764 }
1765
1766 // [EOF]
1767 ?>