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