2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 08/25/2003 *
4 * =================== Last change: 11/29/2005 *
6 * -------------------------------------------------------------------- *
7 * File : functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Many non-MySQL functions (also file access) *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * For more information visit: http://www.mxchange.org *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the Free Software *
35 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
44 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
45 function outputHtml ($htmlCode, $newLine = true) {
47 if (!isset($GLOBALS['output'])) $GLOBALS['output'] = '';
50 $username = getMessage('USERNAME_UNKNOWN');
51 if (isset($GLOBALS['username'])) $username = getUsername();
53 // Do we have HTML-Code here?
54 if (!empty($htmlCode)) {
55 // Yes, so we handle it as you have configured
56 switch (getConfig('OUTPUT_MODE')) {
58 // That's why you don't need any \n at the end of your HTML code... :-)
59 if (getPhpCaching() == 'on') {
60 // Output into PHP's internal buffer
61 outputRawCode($htmlCode);
63 // That's why you don't need any \n at the end of your HTML code... :-)
64 if ($newLine === true) print("\n");
66 // Render mode for old or lame servers...
67 $GLOBALS['output'] .= $htmlCode;
69 // That's why you don't need any \n at the end of your HTML code... :-)
70 if ($newLine === true) $GLOBALS['output'] .= "\n";
75 // If we are switching from render to direct output rendered code
76 if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
78 // The same as above... ^
79 outputRawCode($htmlCode);
80 if ($newLine === true) print("\n");
84 // Huh, something goes wrong or maybe you have edited config.php ???
85 app_die(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--LANG_NO_RENDER_DIRECT--}');
88 } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
89 // Output cached HTML code
90 $GLOBALS['output'] = ob_get_contents();
92 // Clear output buffer for later output if output is found
93 if (!empty($GLOBALS['output'])) {
97 // Extension 'rewrite' installed?
98 if ((isExtensionActive('rewrite')) && (getOutputMode() != 1)) {
99 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
102 // Send all HTTP headers
105 // Compile and run finished rendered HTML code
106 compileFinalOutput();
108 // Output code here, DO NOT REMOVE! ;-)
109 outputRawCode($GLOBALS['output']);
110 } elseif ((getConfig('OUTPUT_MODE') == 'render') && (!empty($GLOBALS['output']))) {
111 // Rewrite links when rewrite extension is active
112 if ((isExtensionActive('rewrite')) && (getOutputMode() != 1)) {
113 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
116 // Send all HTTP headers
119 // Compile and run finished rendered HTML code
120 compileFinalOutput();
122 // Output code here, DO NOT REMOVE! ;-)
123 outputRawCode($GLOBALS['output']);
125 // And flush all headers
130 // Sends out all headers required for HTTP/1.1 reply
131 function sendHttpHeaders () {
133 $now = gmdate('D, d M Y H:i:s') . ' GMT';
136 sendHeader('HTTP/1.1 200');
138 // General headers for no caching
139 sendHeader('Expires: ' . $now); // RFC2616 - Section 14.21
140 sendHeader('Last-Modified: ' . $now);
141 sendHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
142 sendHeader('Pragma: no-cache'); // HTTP/1.0
143 sendHeader('Connection: Close');
144 sendHeader('Content-Type: ' . getContentType() . '; charset=UTF-8');
145 sendHeader('Content-Language: ' . getLanguage());
148 // Compiles the final output
149 function compileFinalOutput () {
154 while (((strpos($GLOBALS['output'], '{--') > 0) || (strpos($GLOBALS['output'], '{!') > 0) || (strpos($GLOBALS['output'], '{?') > 0)) && ($cnt < 3)) {
155 // Init common variables
160 $eval = "\$newContent = \"".compileCode(escapeQuotes($GLOBALS['output']))."\";";
163 // Was that eval okay?
164 if (empty($newContent)) {
165 // Something went wrong!
166 debug_report_bug('Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
168 $GLOBALS['output'] = $newContent;
175 if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
176 // Compress it for HTTP gzip
177 $GLOBALS['output'] = gzencode($GLOBALS['output'], 9, true);
180 sendHeader('Content-Encoding: gzip');
181 } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
182 // Compress it for HTTP deflate
183 $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
186 sendHeader('Content-Encoding: deflate');
190 sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
196 // Output the raw HTML code
197 function outputRawCode ($htmlCode) {
198 // Output stripped HTML code to avoid broken JavaScript code, etc.
199 print(str_replace('{BACK}', "\\", $htmlCode));
201 // Flush the output if only getPhpCaching() is not 'on'
202 if (getPhpCaching() != 'on') {
208 // Init fatal message array
209 function initFatalMessages () {
210 $GLOBALS['fatal_messages'] = array();
213 // Getter for whole fatal error messages
214 function getFatalArray () {
215 return $GLOBALS['fatal_messages'];
218 // Add a fatal error message to the queue array
219 function addFatalMessage ($F, $L, $message, $extra = '') {
220 if (is_array($extra)) {
221 // Multiple extras for a message with masks
222 $message = call_user_func_array('sprintf', $extra);
223 } elseif (!empty($extra)) {
224 // $message is text with a mask plus extras to insert into the text
225 $message = sprintf($message, $extra);
228 // Add message to $GLOBALS['fatal_messages']
229 $GLOBALS['fatal_messages'][] = $message;
231 // Log fatal messages away
232 logDebugMessage($F, $L, 'Fatal error message: ' . $message);
235 // Getter for total fatal message count
236 function getTotalFatalErrors () {
240 // Do we have at least the first entry?
241 if (!empty($GLOBALS['fatal_messages'][0])) {
243 $count = count($GLOBALS['fatal_messages']);
250 // Load a template file and return it's content (only it's name; do not use ' or ")
251 function loadTemplate ($template, $return = false, $content = array()) {
252 // @TODO Remove this sanity-check if all is fine
253 if (!is_bool($return)) debug_report_bug('return is not bool (' . gettype($return) . ')');
255 // @TODO Try to rewrite all $DATA to $content
259 if (isTemplateCached($template)) {
260 // Evaluate the cache
261 eval(readTemplateCache($template));
262 } elseif (!isset($GLOBALS['template_eval'][$template])) {
263 // Add more variables which you want to use in your template files
264 $username = getUsername();
266 // Make all template names lowercase
267 $template = strtolower($template);
271 if (empty($GLOBALS['refid'])) $GLOBALS['refid'] = '0';
274 $basePath = sprintf("%stemplates/%s/html/", getConfig('PATH'), getLanguage());
275 $extraPath = detectExtraTemplatePath($template);;
277 ////////////////////////
278 // Generate file name //
279 ////////////////////////
280 $FQFN = $basePath . $extraPath . $template . '.tpl';
282 // Does the special template exists?
283 if (!isFileReadable($FQFN)) {
284 // Reset to default template
285 $FQFN = $basePath . $template . '.tpl';
288 // Now does the final template exists?
289 if (isFileReadable($FQFN)) {
290 // Count the template load
291 incrementConfigEntry('num_templates');
293 // The local file does exists so we load it. :)
294 $GLOBALS['tpl_content'] = readFromFile($FQFN);
296 // Do we have to compile the code?
298 if ((strpos($GLOBALS['tpl_content'], '$') !== false) || (strpos($GLOBALS['tpl_content'], '{--') !== false) || (strpos($GLOBALS['tpl_content'], '{!') !== false) || (strpos($GLOBALS['tpl_content'], '{?') !== false) || (strpos($GLOBALS['tpl_content'], '{%') !== false)) {
299 // Normal HTML output?
300 if (getOutputMode() == '0') {
301 // Add surrounding HTML comments to help finding bugs faster
302 $ret = '<!-- Template ' . $template . " - Start -->\n" . $GLOBALS['tpl_content'] . '<!-- Template ' . $template . " - End -->\n";
304 // Prepare eval() command
305 $eval = '$ret = "' . compileCode(escapeQuotes($ret)) . '";';
306 } elseif (substr($template, 0, 3) == 'js_') {
307 // JavaScripts don't like entities and timings
308 $eval = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'])) . '");';
310 // Prepare eval() command, other output doesn't like entities, maybe
311 $eval = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'])) . '");';
314 // Add surrounding HTML comments to help finding bugs faster
315 $ret = '<!-- Template ' . $template . " - Start -->\n" . $GLOBALS['tpl_content'] . '<!-- Template ' . $template . " - End -->\n";
316 $eval = '$ret = "' . compileRawCode(escapeQuotes($ret)) . '";';
319 // Cache the eval() command here
320 $GLOBALS['template_eval'][$template] = $eval;
323 eval($GLOBALS['template_eval'][$template]);
324 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
325 // Only admins shall see this warning or when installation mode is active
326 $ret = '<br /><span class="guest_failed">{--TEMPLATE_404--}</span><br />
327 (' . $template . ')<br />
329 {--TEMPLATE_CONTENT--}
330 <pre>' . print_r($content, true) . '</pre>
332 <pre>' . print_r($DATA, true) . '</pre>
336 $GLOBALS['template_eval'][$template] = '404';
340 eval($GLOBALS['template_eval'][$template]);
343 // Do we have some content to output or return?
345 // Not empty so let's put it out! ;)
346 if ($return === true) {
347 // Return the HTML code
353 } elseif (isDebugModeEnabled()) {
354 // Warning, empty output!
355 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
359 // Detects the extra template path from given template name
360 function detectExtraTemplatePath ($template) {
365 if (!isset($GLOBALS['extra_path'][$template])) {
366 // Check for admin/guest/member/etc. templates
367 if (substr($template, 0, 6) == 'admin_') {
368 // Admin template found
369 $extraPath = 'admin/';
370 } elseif (substr($template, 0, 6) == 'guest_') {
371 // Guest template found
372 $extraPath = 'guest/';
373 } elseif (substr($template, 0, 7) == 'member_') {
374 // Member template found
375 $extraPath = 'member/';
376 } elseif (substr($template, 0, 7) == 'select_') {
377 // Selection template found
378 $extraPath = 'select/';
379 } elseif (substr($template, 0, 8) == 'install_') {
380 // Installation template found
381 $extraPath = 'install/';
382 } elseif (substr($template, 0, 4) == 'ext_') {
383 // Extension template found
385 } elseif (substr($template, 0, 3) == 'la_') {
386 // 'Logical-area' template found
388 } elseif (substr($template, 0, 3) == 'js_') {
389 // JavaScript template found
391 } elseif (substr($template, 0, 5) == 'menu_') {
392 // Menu template found
393 $extraPath = 'menu/';
395 // Test for extension
396 $test = substr($template, 0, strpos($template, '_'));
398 // Probe for valid extension name
399 if (isExtensionNameValid($test)) {
400 // Set extra path to extension's name
401 $extraPath = $test . '/';
406 $GLOBALS['extra_path'][$template] = $extraPath;
410 return $GLOBALS['extra_path'][$template];
413 // Loads an email template and compiles it
414 function loadEmailTemplate ($template, $content = array(), $userid = '0') {
417 // Make sure all template names are lowercase!
418 $template = strtolower($template);
420 // Default 'nickname' if extension is not installed
423 // Neutral email address is default
424 $email = getConfig('WEBMASTER');
426 // Is content an array?
427 if (is_array($content)) {
428 // Add expiration to array
429 if ((isConfigEntrySet('auto_purge')) && (getConfig('auto_purge') == '0')) {
430 // Will never expire!
431 $content['expiration'] = getMessage('MAIL_WILL_NEVER_EXPIRE');
432 } elseif (isConfigEntrySet('auto_purge')) {
433 // Create nice date string
434 $content['expiration'] = createFancyTime(getConfig('auto_purge'));
437 $content['expiration'] = getMessage('MAIL_NO_CONFIG_AUTO_PURGE');
442 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):UID={$userid},template={$template},content[]=".gettype($content).'<br />');
443 if (($userid > 0) && (is_array($content))) {
444 // If nickname extension is installed, fetch nickname as well
445 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
446 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):NICKNAME!<br />");
448 fetchUserData($userid, 'nickname');
450 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):NO-NICK!<br />");
452 fetchUserData($userid);
455 // Merge data if valid
456 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):content()=".count($content)." - PRE<br />");
457 if (isUserDataValid()) {
458 $content = merge_array($content, getUserDataArray());
460 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):content()=".count($content)." - AFTER<br />");
463 // Translate M to male or F to female if present
464 if (isset($content['gender'])) $content['gender'] = translateGender($content['gender']);
466 // Overwrite email from data if present
467 if (isset($content['email'])) $email = $content['email'];
469 // Store email for some functions in global data array
470 // @TODO Do only use $content, not $DATA or raw variables
471 $DATA['email'] = $email;
474 $basePath = sprintf("%stemplates/%s/emails/", getConfig('PATH'), getLanguage());
477 $extraPath = detectExtraTemplatePath($template);
479 // Generate full FQFN
480 $FQFN = $basePath . $extraPath . $template . '.tpl';
482 // Does the special template exists?
483 if (!isFileReadable($FQFN)) {
484 // Reset to default template
485 $FQFN = $basePath . $template . '.tpl';
488 // Now does the final template exists?
490 if (isFileReadable($FQFN)) {
491 // The local file does exists so we load it. :)
492 $GLOBALS['tpl_content'] = readFromFile($FQFN);
495 $GLOBALS['tpl_content'] = "\$newContent = decodeEntities(\"".compileRawCode(escapeQuotes($GLOBALS['tpl_content']))."\");";
496 eval($GLOBALS['tpl_content']);
497 } elseif (!empty($template)) {
498 // Template file not found!
499 $newContent = '{--TEMPLATE_404--}: ' . $template . '<br />
500 {--TEMPLATE_CONTENT--}
501 <pre>' . print_r($content, true) . '</pre>
503 <pre>' . print_r($DATA, true) . '</pre>
506 // Debug mode not active? Then remove the HTML tags
507 if (!isDebugModeEnabled()) $newContent = secureString($newContent);
509 // No template name supplied!
510 $newContent = getMessage('NO_TEMPLATE_SUPPLIED');
513 // Is there some content?
514 if (empty($newContent)) {
516 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'];
518 // Add last error if the required function exists
519 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
522 // Remove content and data
530 // Send mail out to an email address
531 function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '') {
532 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$toEmail},SUBJECT={$subject}<br />");
534 // Compile subject line (for POINTS constant etc.)
535 eval("\$subject = decodeEntities(\"".compileRawCode(escapeQuotes($subject))."\");");
538 if ((!eregi('@', $toEmail)) && ($toEmail > 0)) {
539 // Value detected, is the message extension installed?
540 // @TODO Extension 'msg' does not exist
541 if (isExtensionActive('msg')) {
542 ADD_MESSAGE_TO_BOX($toEmail, $subject, $message, $isHtml);
545 // Does the user exist?
546 if (fetchUserData($toEmail)) {
548 $toEmail = getUserData('email');
551 $toEmail = getConfig('WEBMASTER');
554 } elseif ($toEmail == '0') {
556 $toEmail = getConfig('WEBMASTER');
558 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$toEmail}<br />");
560 // Check for PHPMailer or debug-mode
561 if (!checkPhpMailerUsage()) {
562 // Not in PHPMailer-Mode
563 if (empty($mailHeader)) {
564 // Load email header template
565 $mailHeader = loadEmailTemplate('header');
568 $mailHeader .= loadEmailTemplate('header');
570 } elseif (isDebugModeEnabled()) {
571 if (empty($mailHeader)) {
572 // Load email header template
573 $mailHeader = loadEmailTemplate('header');
576 $mailHeader .= loadEmailTemplate('header');
581 eval("\$toEmail = \"".compileRawCode(escapeQuotes($toEmail))."\";");
584 eval("\$message = \"".str_replace('$', '$', compileRawCode(escapeQuotes($message)))."\";");
586 // Fix HTML parameter (default is no!)
587 if (empty($isHtml)) $isHtml = 'N';
588 if (isDebugModeEnabled()) {
589 // In debug mode we want to display the mail instead of sending it away so we can debug this part
591 Headers : ' . htmlentities(utf8_decode(trim($mailHeader))) . '
592 To : ' . htmlentities(utf8_decode($toEmail)) . '
593 Subject : ' . htmlentities(utf8_decode($subject)) . '
594 Message : ' . htmlentities(utf8_decode($message)) . '
596 } elseif (($isHtml == 'Y') && (isExtensionActive('html_mail'))) {
597 // Send mail as HTML away
598 sendHtmlEmail($toEmail, $subject, $message, $mailHeader);
599 } elseif (!empty($toEmail)) {
601 sendRawEmail($toEmail, $subject, $message, $mailHeader);
602 } elseif ($isHtml != 'Y') {
604 sendRawEmail(getConfig('WEBMASTER'), '[PROBLEM:]' . $subject, $message, $mailHeader);
608 // Check to use wether legacy mail() command or PHPMailer class
609 // @TODO Rewrite this to an extension 'smtp'
611 function checkPhpMailerUsage() {
612 return ((getConfig('SMTP_HOSTNAME') != '') && (getConfig('SMTP_USER') != ''));
615 // Send out a raw email with PHPMailer class or legacy mail() command
616 function sendRawEmail ($toEmail, $subject, $message, $from) {
617 // Just compile all again, to put out all configs, etc.
618 eval('$toEmail = decodeEntities("' . compileRawCode(escapeQuotes($toEmail)) . '");');
619 eval('$subject = decodeEntities("' . compileRawCode(escapeQuotes($subject)) . '");');
620 eval('$message = decodeEntities("' . compileRawCode(escapeQuotes($message)) . '");');
621 eval('$from = decodeEntities("' . compileRawCode(escapeQuotes($from)) . '");');
623 // Shall we use PHPMailer class or legacy mode?
624 if (checkPhpMailerUsage()) {
625 // Use PHPMailer class with SMTP enabled
626 loadIncludeOnce('inc/phpmailer/class.phpmailer.php');
627 loadIncludeOnce('inc/phpmailer/class.smtp.php');
630 $mail = new PHPMailer();
632 // Set charset to UTF-8
633 $mail->CharSet('UTF-8');
635 // Path for PHPMailer
636 $mail->PluginDir = sprintf("%sinc/phpmailer/", getConfig('PATH'));
639 $mail->SMTPAuth = true;
640 $mail->Host = getConfig('SMTP_HOSTNAME');
642 $mail->Username = getConfig('SMTP_USER');
643 $mail->Password = getConfig('SMTP_PASSWORD');
645 $mail->From = getConfig('WEBMASTER');
649 $mail->FromName = getConfig('MAIN_TITLE');
650 $mail->Subject = $subject;
651 if ((isExtensionActive('html_mail')) && (secureString($message) != $message)) {
652 $mail->Body = $message;
653 $mail->AltBody = 'Your mail program required HTML support to read this mail!';
654 $mail->WordWrap = 70;
657 $mail->Body = decodeEntities($message);
659 $mail->AddAddress($toEmail, '');
660 $mail->AddReplyTo(getConfig('WEBMASTER'), getConfig('MAIN_TITLE'));
661 $mail->AddCustomHeader('Errors-To:' . getConfig('WEBMASTER'));
662 $mail->AddCustomHeader('X-Loop:' . getConfig('WEBMASTER'));
665 // Use legacy mail() command
666 mail($toEmail, $subject, decodeEntities($message), $from);
670 // Generate a password in a specified length or use default password length
671 function generatePassword ($length = '0') {
672 // Auto-fix invalid length of zero
673 if ($length == '0') $length = getConfig('pass_len');
675 // Initialize array with all allowed chars
676 $ABC = explode(',', 'a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,0,1,2,3,4,5,6,7,8,9,-,+,_,/,.');
678 // Start creating password
680 for ($i = '0'; $i < $length; $i++) {
681 $PASS .= $ABC[mt_rand(0, count($ABC) -1)];
684 // When the size is below 40 we can also add additional security by scrambling
685 // it. Otherwise we may corrupt hashes
686 if (strlen($PASS) <= 40) {
687 // Also scramble the password
688 $PASS = scrambleString($PASS);
691 // Return the password
695 // Generates a human-readable timestamp from the Uni* stamp
696 function generateDateTime ($time, $mode = '0') {
697 // Filter out numbers
698 $time = bigintval($time);
700 // If the stamp is zero it mostly didn't "happen"
703 return getMessage('NEVER_HAPPENED');
706 switch (getLanguage()) {
707 case 'de': // German date / time format
709 case '0': $ret = date("d.m.Y \u\m H:i \U\h\\r", $time); break;
710 case '1': $ret = strtolower(date('d.m.Y - H:i', $time)); break;
711 case '2': $ret = date('d.m.Y|H:i', $time); break;
712 case '3': $ret = date('d.m.Y', $time); break;
714 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
719 default: // Default is the US date / time format!
721 case '0': $ret = date('r', $time); break;
722 case '1': $ret = date('Y-m-d - g:i A', $time); break;
723 case '2': $ret = date('y-m-d|H:i', $time); break;
724 case '3': $ret = date('y-m-d', $time); break;
726 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
735 // Translates Y/N to yes/no
736 function translateYesNo ($yn) {
738 $translated = '??? (' . $yn . ')';
740 case 'Y': $translated = getMessage('YES'); break;
741 case 'N': $translated = getMessage('NO'); break;
744 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected Y/N!", $yn));
752 // Translates the "pool type" into human-readable
753 function translatePoolType ($type) {
754 // Default?type is unknown
755 $translated = getMaskedMessage('POOL_TYPE_UNKNOWN', $type);
758 $constName = sprintf("POOL_TYPE_%s", $type);
761 if (isMessageIdValid($constName)) {
763 $translated = getMessage($constName);
766 // Return "translation"
770 // Translates the american decimal dot into a german comma
771 function translateComma ($dotted, $cut = true, $max = '0') {
772 // Default is 3 you can change this in admin area "Misc -> Misc Options"
773 if (!isConfigEntrySet('max_comma')) setConfigEntry('max_comma', 3);
775 // Use from config is default
776 $maxComma = getConfig('max_comma');
778 // Use from parameter?
779 if ($max > 0) $maxComma = $max;
782 if (($cut === true) && ($max == '0')) {
783 // Test for commata if in cut-mode
784 $com = explode('.', $dotted);
785 if (count($com) < 2) {
786 // Don't display commatas even if there are none... ;-)
792 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "dotted={$dotted},maxComma={$maxComma}");
795 switch (getLanguage()) {
796 case 'de': // German language
797 $dotted = number_format($dotted, $maxComma, ',', '.');
800 default: // All others
801 $dotted = number_format($dotted, $maxComma, '.', ',');
805 // Return translated value
809 // Translate Uni*-like gender to human-readable
810 function translateGender ($gender) {
812 $ret = '!' . $gender . '!';
814 // Male/female or company?
816 case 'M': $ret = getMessage('GENDER_M'); break;
817 case 'F': $ret = getMessage('GENDER_F'); break;
818 case 'C': $ret = getMessage('GENDER_C'); break;
820 // Log unknown gender
821 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
825 // Return translated gender
829 // "Translates" the user status
830 function translateUserStatus ($status) {
831 // Generate message depending on status
836 $ret = getMessage(sprintf("ACCOUNT_%s", $status));
841 $ret = getMessage('ACCOUNT_DELETED');
845 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
846 $ret = getMaskedMessage('UNKNOWN_STATUS', $status);
854 // Generates an URL for the dereferer
855 function generateDerefererUrl ($URL) {
856 // Don't de-refer our own links!
857 if (substr($URL, 0, strlen(getConfig('URL'))) != getConfig('URL')) {
858 // De-refer this link
859 $URL = '{%url=modules.php?module=loader&url=' . encodeString(compileUriCode($URL)) . '%}';
866 // Generates an URL for the frametester
867 function generateFrametesterUrl ($URL) {
868 // Prepare frametester URL
869 $frametesterUrl = sprintf("{%%url=modules.php?module=frametester&url=%s%%}",
870 encodeString(compileUriCode($URL))
873 // Return the new URL
874 return $frametesterUrl;
877 // Count entries from e.g. a selection box
878 function countSelection ($array) {
880 if (!is_array($array)) {
882 debug_report_bug(__FUNCTION__.': No array provided.');
889 foreach ($array as $key => $selected) {
891 if (!empty($selected)) $ret++;
894 // Return counted selections
898 // Generate XHTML code for the CAPTCHA
899 function generateCaptchaCode ($code, $type, $DATA, $userid) {
900 return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&' . $type . '=' . $DATA . '&mode=img&code=' . $code . '%}" />';
903 // Generates a timestamp (some wrapper for mktime())
904 function makeTime ($hours, $minutes, $seconds, $stamp) {
905 // Extract day, month and year from given timestamp
906 $days = date('d', $stamp);
907 $months = date('m', $stamp);
908 $years = date('Y', $stamp);
910 // Create timestamp for wished time which depends on extracted date
921 // Redirects to an URL and if neccessarry extends it with own base URL
922 function redirectToUrl ($URL) {
924 eval('$URL = "' . compileRawCode(encodeUrl($URL)) . '";');
926 // Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
927 $rel = ' rel="external"';
929 // Do we have internal or external URL?
930 if (substr($URL, 0, strlen(getConfig('URL'))) == getConfig('URL')) {
931 // Own (=internal) URL
935 // Three different ways to debug...
936 //* DEBUG: */ debug_report_bug(sprintf("%s[%s:] URL=%s", __FUNCTION__, __LINE__, $URL));
937 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $URL);
938 //* DEBUG: */ die($URL);
940 // Simple probe for bots/spiders from search engines
942 // Secure the URL against bad things such als HTML insertions and so on...
943 $URL = secureString($URL);
945 // Output new location link as anchor
946 outputHtml('<a href="' . $URL . '"' . $rel . '>' . $URL . '</a>');
947 } elseif (!headers_sent()) {
948 // Clear own output buffer
949 $GLOBALS['output'] = '';
951 // Load URL when headers are not sent
952 sendHeader('Location: '.str_replace('&', '&', $URL));
954 // Output error message
955 loadInclude('inc/header.php');
956 loadTemplate('redirect_url', false, str_replace('&', '&', $URL));
957 loadInclude('inc/footer.php');
960 // Shut the mailer down here
964 // Wrapper for redirectToUrl but URL comes from a configuration entry
965 function redirectToConfiguredUrl ($configEntry) {
967 $URL = getConfig($configEntry);
972 debug_report_bug(sprintf("Configuration entry %s is not set!", $configEntry));
979 // Compiles the given HTML/mail code
980 function compileCode ($code, $simple = false, $constants = true, $full = true) {
981 // Is the code a string?
982 if (!is_string($code)) {
983 // Silently return it
988 $startCompile = microtime(true);
991 $code = compileRawCode($code, $simple, $constants, $full);
994 $compiled = microtime(true);
997 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
999 // Return compiled code
1003 // Compiles the code (use compileCode() only for HTML because of the comments)
1004 // @TODO $simple is deprecated
1005 function compileRawCode ($code, $simple = false, $constants = true, $full = true) {
1006 // Is the code a string?
1007 if (!is_string($code)) {
1008 // Silently return it
1012 // Init replacement-array with smaller set of security characters
1013 $secChars = $GLOBALS['url_chars'];
1015 // Select full set of chars to replace when we e.g. want to compile URLs
1016 if ($full === true) $secChars = $GLOBALS['security_chars'];
1018 // Compile more through a filter
1019 $code = runFilterChain('compile_code', $code);
1021 // Compile constants
1022 if ($constants === true) {
1023 // BEFORE 0.2.1 : Language and data constants
1024 // WITH 0.2.1+ : Only language constants
1025 $code = str_replace('{--', "\" . getMessage('", str_replace('--}', "') . \"", $code));
1027 // BEFORE 0.2.1 : Not used
1028 // WITH 0.2.1+ : Data constants
1029 $code = str_replace('{!', "\" . constant('", str_replace('!}', "') . \"", $code));
1032 // Compile QUOT and other non-HTML codes
1033 foreach ($secChars['to'] as $k => $to) {
1034 // Do the reversed thing as in inc/libs/security_functions.php
1035 $code = str_replace($to, $secChars['from'][$k], $code);
1038 // Find $content[bla][blub] entries
1039 // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
1040 preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
1042 // Are some matches found?
1043 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
1044 // Replace all matches
1045 $matchesFound = array();
1046 foreach ($matches[0] as $key => $match) {
1047 // Fuzzy look has failed by default
1048 $fuzzyFound = false;
1050 // Fuzzy look on match if already found
1051 foreach ($matchesFound as $found => $set) {
1053 $test = substr($found, 0, strlen($match));
1055 // Does this entry exist?
1056 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):found={$found},match={$match},set={$set}<br />");
1057 if ($test == $match) {
1059 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):fuzzyFound!<br />");
1066 if ($fuzzyFound === true) continue;
1068 // Take all string elements
1069 if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key."_" . $matches[4][$key]]))) {
1070 // Replace it in the code
1071 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):key={$key},match={$match}<br />");
1072 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
1073 $code = str_replace($match, '".' . $newMatch . '."', $code);
1074 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
1075 $matchesFound[$match] = 1;
1076 } elseif (!isset($matchesFound[$match])) {
1077 // Not yet replaced!
1078 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):match={$match}<br />");
1079 $code = str_replace($match, '".' . $match . '."', $code);
1080 $matchesFound[$match] = 1;
1089 /************************************************************************
1091 * Gaenderter Sortier-Algorythmus, $array wird nach dem Array (!) *
1092 * $a_sort sortiert: *
1094 * $array - Das 3-dimensionale Array, das paralell sortiert werden soll *
1095 * $a_sort - Array, das die Sortiereihenfolge der ersten Elementeben *
1096 * $primary_key - Prim.rschl.ssel aus $a_sort, nach dem sortiert wird *
1097 * $order - Sortiereihenfolge: -1 = a-Z, 0 = keine, 1 = Z-a *
1098 * $nums - true = Als Zahlen sortieren, false = Als Zeichen sortieren *
1100 * $a_sort muss Elemente enthalten, deren Wert Schluessel von $array *
1101 * sind... Klingt kompliziert, suchen Sie mal mein Beispiel, dann sehen *
1102 * Sie, dass es doch nicht so schwer ist! :-) *
1104 ************************************************************************/
1105 function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums = false) {
1107 while ($primary_key < count($a_sort)) {
1108 foreach ($dummy[$a_sort[$primary_key]] as $key => $value) {
1109 foreach ($dummy[$a_sort[$primary_key]] as $key2 => $value2) {
1111 if ($nums === false) {
1112 // Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
1113 if (($key != $key2) && (strcmp(strtolower($dummy[$a_sort[$primary_key]][$key]), strtolower($dummy[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
1114 } elseif ($key != $key2) {
1115 // Sort numbers (E.g.: 9 < 10)
1116 if (($dummy[$a_sort[$primary_key]][$key] < $dummy[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
1117 if (($dummy[$a_sort[$primary_key]][$key] > $dummy[$a_sort[$primary_key]][$key2]) && ($order == 1)) $match = true;
1121 // We have found two different values, so let's sort whole array
1122 foreach ($dummy as $sort_key => $sort_val) {
1123 $t = $dummy[$sort_key][$key];
1124 $dummy[$sort_key][$key] = $dummy[$sort_key][$key2];
1125 $dummy[$sort_key][$key2] = $t;
1136 // Write back sorted array
1141 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'register_select') {
1144 if ($type == 'yn') {
1145 // This is a yes/no selection only!
1146 if ($id > 0) $prefix .= "[" . $id."]";
1147 $OUT .= " <select name=\"" . $prefix."\" class=\"" . $class . "\" size=\"1\">\n";
1149 // Begin with regular selection box here
1150 if (!empty($prefix)) $prefix .= "_";
1152 if ($id > 0) $type2 .= "[" . $id."]";
1153 $OUT .= " <select name=\"".strtolower($prefix . $type2)."\" class=\"" . $class . "\" size=\"1\">\n";
1158 for ($idx = 1; $idx < 32; $idx++) {
1159 $OUT .= "<option value=\"" . $idx."\"";
1160 if ($default == $idx) $OUT .= ' selected="selected"';
1161 $OUT .= ">" . $idx."</option>\n";
1165 case 'month': // Month
1166 foreach ($GLOBALS['month_descr'] as $month => $descr) {
1167 $OUT .= "<option value=\"" . $month."\"";
1168 if ($default == $month) $OUT .= ' selected="selected"';
1169 $OUT .= ">" . $descr."</option>\n";
1173 case 'year': // Year
1175 $year = date('Y', time());
1177 // Use configured min age or fixed?
1178 if ((isExtensionActive('other')) && (getExtensionVersion('other') >= '0.2.1')) {
1180 $startYear = $year - getConfig('min_age');
1183 $startYear = $year - 16;
1186 // Calculate earliest year (100 years old people can still enter Internet???)
1187 $minYear = $year - 100;
1189 // Check if the default value is larger than minimum and bigger than actual year
1190 if (($default > $minYear) && ($default >= $year)) {
1191 for ($idx = $year; $idx < ($year + 11); $idx++) {
1192 $OUT .= "<option value=\"" . $idx."\"";
1193 if ($default == $idx) $OUT .= ' selected="selected"';
1194 $OUT .= ">" . $idx."</option>\n";
1196 } elseif ($default == -1) {
1197 // Current year minus 1
1198 for ($idx = $startYear; $idx <= ($year + 1); $idx++)
1200 $OUT .= "<option value=\"" . $idx."\">" . $idx."</option>\n";
1203 // Get current year and subtract the configured minimum age
1204 $OUT .= "<option value=\"".($minYear - 1)."\"><" . $minYear."</option>\n";
1205 // Calculate earliest year depending on extension version
1206 if ((isExtensionActive('other')) && (getExtensionVersion('other') >= '0.2.1')) {
1207 // Use configured minimum age
1208 $year = date('Y', time()) - getConfig('min_age');
1210 // Use fixed 16 years age
1211 $year = date('Y', time()) - 16;
1214 // Construct year selection list
1215 for ($idx = $minYear; $idx <= $year; $idx++) {
1216 $OUT .= "<option value=\"" . $idx."\"";
1217 if ($default == $idx) $OUT .= ' selected="selected"';
1218 $OUT .= ">" . $idx."</option>\n";
1225 for ($idx = '0'; $idx < 60; $idx+=5) {
1226 if (strlen($idx) == 1) $idx = '0' . $idx;
1227 $OUT .= "<option value=\"" . $idx."\"";
1228 if ($default == $idx) $OUT .= ' selected="selected"';
1229 $OUT .= ">" . $idx."</option>\n";
1234 for ($idx = '0'; $idx < 24; $idx++) {
1235 if (strlen($idx) == 1) $idx = '0' . $idx;
1236 $OUT .= "<option value=\"" . $idx."\"";
1237 if ($default == $idx) $OUT .= ' selected="selected"';
1238 $OUT .= ">" . $idx."</option>\n";
1243 $OUT .= "<option value=\"Y\"";
1244 if ($default == 'Y') $OUT .= ' selected="selected"';
1245 $OUT .= ">{--YES--}</option>\n<option value=\"N\"";
1246 if ($default != 'Y') $OUT .= ' selected="selected"';
1247 $OUT .= ">{--NO--}</option>\n";
1250 $OUT .= " </select>\n";
1255 // Deprecated : $length
1258 function generateRandomCode ($length, $code, $userid, $DATA = '') {
1259 // Build server string
1260 $server = $_SERVER['PHP_SELF'] . getConfig('ENCRYPT_SEPERATOR') . detectUserAgent() . getConfig('ENCRYPT_SEPERATOR') . getenv('SERVER_SOFTWARE') . getConfig('ENCRYPT_SEPERATOR') . detectRemoteAddr().":'.':".filemtime(getConfig('PATH').'inc/databases.php');
1263 $keys = getConfig('SITE_KEY') . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY');
1264 if (isConfigEntrySet('secret_key')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('secret_key');
1265 if (isConfigEntrySet('file_hash')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('file_hash');
1266 $keys .= getConfig('ENCRYPT_SEPERATOR') . date('d-m-Y (l-F-T)', getConfig('patch_ctime'));
1267 if (isConfigEntrySet('master_salt')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('master_salt');
1269 // Build string from misc data
1270 $data = $code . getConfig('ENCRYPT_SEPERATOR') . $userid . getConfig('ENCRYPT_SEPERATOR') . $DATA;
1272 // Add more additional data
1273 if (isSessionVariableSet('u_hash')) $data .= getConfig('ENCRYPT_SEPERATOR') . getSession('u_hash');
1275 // Add referal id, language, theme and userid
1276 $data .= getConfig('ENCRYPT_SEPERATOR') . determineReferalId();
1277 $data .= getConfig('ENCRYPT_SEPERATOR') . getLanguage();
1278 $data .= getConfig('ENCRYPT_SEPERATOR') . getCurrentTheme();
1279 $data .= getConfig('ENCRYPT_SEPERATOR') . getMemberId();
1281 // Calculate number for generating the code
1282 $a = $code + getConfig('_ADD') - 1;
1284 if (isConfigEntrySet('master_salt')) {
1285 // Generate hash with master salt from modula of number with the prime number and other data
1286 $saltedHash = generateHash(($a % getConfig('_PRIME')) . getConfig('ENCRYPT_SEPERATOR') . $server . getConfig('ENCRYPT_SEPERATOR') . $keys . getConfig('ENCRYPT_SEPERATOR') . $data . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY') . getConfig('ENCRYPT_SEPERATOR') . $a, getConfig('master_salt'));
1288 // Create number from hash
1289 $rcode = hexdec(substr($saltedHash, strlen(getConfig('master_salt')), 9)) / abs(getConfig('rand_no') - $a + sqrt(getConfig('_ADD'))) / pi();
1291 // Generate hash with "hash of site key" from modula of number with the prime number and other data
1292 $saltedHash = generateHash(($a % getConfig('_PRIME')) . getConfig('ENCRYPT_SEPERATOR') . $server . getConfig('ENCRYPT_SEPERATOR') . $keys . getConfig('ENCRYPT_SEPERATOR') . $data . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY') . getConfig('ENCRYPT_SEPERATOR') . $a, substr(sha1(getConfig('SITE_KEY')), 0, getConfig('salt_length')));
1294 // Create number from hash
1295 $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(getConfig('rand_no') - $a + sqrt(getConfig('_ADD'))) / pi();
1298 // At least 10 numbers shall be secure enought!
1299 $len = getConfig('code_length');
1300 if ($len == '0') $len = $length;
1301 if ($len == '0') $len = 10;
1303 // Cut off requested counts of number
1304 $return = substr(str_replace('.', '', $rcode), 0, $len);
1306 // Done building code
1310 // Does only allow numbers
1311 function bigintval ($num, $castValue = true) {
1312 // Filter all numbers out
1313 $ret = preg_replace('/[^0123456789]/', '', $num);
1316 if ($castValue === true) $ret = (double)$ret;
1318 // Has the whole value changed?
1319 if ('' . $ret . '' != '' . $num . '') {
1321 debug_report_bug('Problem with number found. ret=' . $ret . ', num='. $num);
1328 // Insert the code in $img_code into jpeg or PNG image
1329 function generateImageOrCode ($img_code, $headerSent = true) {
1330 // Is the code size oversized or shouldn't we display it?
1331 if ((strlen($img_code) > 6) || (empty($img_code)) || (getConfig('code_length') == '0')) {
1332 // Stop execution of function here because of over-sized code length
1333 debug_report_bug('img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getConfig('code_length'));
1334 } elseif ($headerSent === false) {
1335 // Return an HTML code here
1336 return "<img src=\"{%url=img.php?code=" . $img_code."%}\" alt=\"Image\" />\n";
1340 $img = sprintf("%s/theme/%s/images/code_bg.%s",
1343 getConfig('img_type')
1347 if (isFileReadable($img)) {
1348 // Switch image type
1349 switch (getConfig('img_type'))
1352 // Okay, load image and hide all errors
1353 $image = imagecreatefromjpeg($img);
1357 // Okay, load image and hide all errors
1358 $image = imagecreatefrompng($img);
1362 // Exit function here
1363 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
1367 // Generate text color (red/green/blue; 0 = dark, 255 = bright)
1368 $text_color = imagecolorallocate($image, 0, 0, 0);
1370 // Insert code into image
1371 imagestring($image, 5, 14, 2, $img_code, $text_color);
1373 // Return to browser
1374 sendHeader('Content-Type: image/' . getConfig('img_type'));
1376 // Output image with matching image factory
1377 switch (getConfig('img_type')) {
1378 case 'jpg': imagejpeg($image); break;
1379 case 'png': imagepng($image); break;
1382 // Remove image from memory
1383 imagedestroy($image);
1385 // Create selection box or array of splitted timestamp
1386 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
1387 // Do not continue if ONE_DAY is absend
1388 if (!isConfigEntrySet('ONE_DAY')) {
1389 // And return the timestamp itself or empty array
1390 if ($return_array === true) {
1397 // Calculate 2-seconds timestamp
1398 $stamp = round($timestamp);
1399 //* DEBUG: */ print("*" . $stamp.'/' . $timestamp."*<br />");
1401 // Do we have a leap year?
1403 $TEST = date('Y', time()) / 4;
1404 $M1 = date('m', time());
1405 $M2 = date('m', (time() + $timestamp));
1407 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1408 if ((floor($TEST) == $TEST) && ($M1 == "02") && ($M2 > "02")) $SWITCH = getConfig('ONE_DAY');
1410 // First of all years...
1411 $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
1412 //* DEBUG: */ print("Y={$Y}<br />");
1414 $M = abs(floor($timestamp / 2628000 - $Y * 12));
1415 //* DEBUG: */ print("M={$M}<br />");
1417 $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('ONE_DAY')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) / 7)));
1418 //* DEBUG: */ print("W={$W}<br />");
1420 $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY'))) - $W * 7));
1421 //* DEBUG: */ print("D={$D}<br />");
1423 $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24) - $W * 7 * 24 - $D * 24));
1424 //* DEBUG: */ print("h={$h}<br />");
1426 $m = abs(floor($timestamp / 60 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 60 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 60) - $W * 7 * 24 * 60 - $D * 24 * 60 - $h * 60));
1427 //* DEBUG: */ print("m={$m}<br />");
1428 // And at last seconds...
1429 $s = abs(floor($timestamp - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 3600 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 3600) - $W * 7 * 24 * 3600 - $D * 24 * 3600 - $h * 3600 - $m * 60));
1430 //* DEBUG: */ print("s={$s}<br />");
1432 // Is seconds zero and time is < 60 seconds?
1433 if (($s == '0') && ($timestamp < 60)) {
1435 $s = round($timestamp);
1439 // Now we convert them in seconds...
1441 if ($return_array) {
1442 // Just put all data in an array for later use
1454 $OUT = "<div align=\"" . $align."\">\n";
1455 $OUT .= "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" class=\"timebox_table dashed\">\n";
1458 if (ereg('Y', $display) || (empty($display))) {
1459 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_YEARS--}</strong></td>\n";
1462 if (ereg('M', $display) || (empty($display))) {
1463 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_MONTHS--}</strong></td>\n";
1466 if (ereg('W', $display) || (empty($display))) {
1467 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_WEEKS--}</strong></td>\n";
1470 if (ereg('D', $display) || (empty($display))) {
1471 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_DAYS--}</strong></td>\n";
1474 if (ereg('h', $display) || (empty($display))) {
1475 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_HOURS--}</strong></td>\n";
1478 if (ereg('m', $display) || (empty($display))) {
1479 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_MINUTES--}</strong></td>\n";
1482 if (ereg('s', $display) || (empty($display))) {
1483 $OUT .= " <td align=\"center\" class=\"timebox_column bottom\"><div class=\"tiny\">{--_SECONDS--}</strong></td>\n";
1489 if (ereg('Y', $display) || (empty($display))) {
1490 // Generate year selection
1491 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_ye\" size=\"1\">\n";
1492 for ($idx = '0'; $idx <= 10; $idx++) {
1493 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1494 if ($idx == $Y) $OUT .= ' selected="selected"';
1495 $OUT .= ">" . $idx."</option>\n";
1497 $OUT .= " </select></td>\n";
1499 $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
1502 if (ereg('M', $display) || (empty($display))) {
1503 // Generate month selection
1504 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_mo\" size=\"1\">\n";
1505 for ($idx = '0'; $idx <= 11; $idx++)
1507 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1508 if ($idx == $M) $OUT .= ' selected="selected"';
1509 $OUT .= ">" . $idx."</option>\n";
1511 $OUT .= " </select></td>\n";
1513 $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
1516 if (ereg('W', $display) || (empty($display))) {
1517 // Generate week selection
1518 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_we\" size=\"1\">\n";
1519 for ($idx = '0'; $idx <= 4; $idx++) {
1520 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1521 if ($idx == $W) $OUT .= ' selected="selected"';
1522 $OUT .= ">" . $idx."</option>\n";
1524 $OUT .= " </select></td>\n";
1526 $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
1529 if (ereg('D', $display) || (empty($display))) {
1530 // Generate day selection
1531 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_da\" size=\"1\">\n";
1532 for ($idx = '0'; $idx <= 31; $idx++) {
1533 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1534 if ($idx == $D) $OUT .= ' selected="selected"';
1535 $OUT .= ">" . $idx."</option>\n";
1537 $OUT .= " </select></td>\n";
1539 $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
1542 if (ereg('h', $display) || (empty($display))) {
1543 // Generate hour selection
1544 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_ho\" size=\"1\">\n";
1545 for ($idx = '0'; $idx <= 23; $idx++) {
1546 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1547 if ($idx == $h) $OUT .= ' selected="selected"';
1548 $OUT .= ">" . $idx."</option>\n";
1550 $OUT .= " </select></td>\n";
1552 $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
1555 if (ereg('m', $display) || (empty($display))) {
1556 // Generate minute selection
1557 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_mi\" size=\"1\">\n";
1558 for ($idx = '0'; $idx <= 59; $idx++) {
1559 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1560 if ($idx == $m) $OUT .= ' selected="selected"';
1561 $OUT .= ">" . $idx."</option>\n";
1563 $OUT .= " </select></td>\n";
1565 $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1568 if (ereg('s', $display) || (empty($display))) {
1569 // Generate second selection
1570 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix . "_se\" size=\"1\">\n";
1571 for ($idx = '0'; $idx <= 59; $idx++) {
1572 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1573 if ($idx == $s) $OUT .= ' selected="selected"';
1574 $OUT .= ">" . $idx."</option>\n";
1576 $OUT .= " </select></td>\n";
1578 $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1581 $OUT .= "</table>\n";
1583 // Return generated HTML code
1589 function createTimestampFromSelections ($prefix, $postData) {
1590 // Initial return value
1593 // Do we have a leap year?
1595 $TEST = date('Y', time()) / 4;
1596 $M1 = date('m', time());
1597 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1598 if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02')) $SWITCH = getConfig('ONE_DAY');
1599 // First add years...
1600 $ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
1602 $ret += $postData[$prefix . '_mo'] * 2628000;
1604 $ret += $postData[$prefix . '_we'] * 604800;
1606 $ret += $postData[$prefix . '_da'] * 86400;
1608 $ret += $postData[$prefix . '_ho'] * 3600;
1610 $ret += $postData[$prefix . '_mi'] * 60;
1611 // And at last seconds...
1612 $ret += $postData[$prefix . '_se'];
1613 // Return calculated value
1617 // Creates a 'fancy' human-readable timestamp from a Uni* stamp
1618 function createFancyTime ($stamp) {
1619 // Get data array with years/months/weeks/days/...
1620 $data = createTimeSelections($stamp, '', '', '', true);
1622 foreach($data as $k => $v) {
1624 // Value is greater than 0 "eval" data to return string
1625 eval("\$ret .= \", \".\$v.\" {--_".strtoupper($k)."--}\";");
1630 // Do we have something there?
1631 if (strlen($ret) > 0) {
1632 // Remove leading commata and space
1633 $ret = substr($ret, 2);
1636 $ret = "0 {--_SECONDS--}";
1639 // Return fancy time string
1643 // Generates a navigation row for listing emails
1644 function addEmailNavigation ($PAGES, $offset, $show_form, $colspan, $return=false) {
1645 $SEP = ''; $TOP = '';
1646 if ($show_form === false) {
1648 $SEP = "<tr><td colspan=\"" . $colspan."\" class=\"seperator\"> </td></tr>";
1652 for ($page = 1; $page <= $PAGES; $page++) {
1653 // Is the page currently selected or shall we generate a link to it?
1654 if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('page')) && ($page == 1))) {
1655 // Is currently selected, so only highlight it
1656 $NAV .= '<strong>-';
1658 // Open anchor tag and add base URL
1659 $NAV .= '<a href="{%url=modules.php?module=admin&what=' . getWhat() . '&page=' . $page . '&offset=' . $offset;
1661 // Add userid when we shall show all mails from a single member
1662 if ((isGetRequestElementSet('userid')) && (bigintval(getRequestElement('userid')) > 0)) $NAV .= '&userid=' . bigintval(getRequestElement('userid'));
1664 // Close open anchor tag
1668 if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('page')) && ($page == 1))) {
1669 // Is currently selected, so only highlight it
1670 $NAV .= '-</strong>';
1676 // Add seperator if we have not yet reached total pages
1677 if ($page < $PAGES) $NAV .= ' | ';
1680 // Define constants only once
1681 $content['nav'] = $NAV;
1682 $content['span'] = $colspan;
1683 $content['top'] = $TOP;
1684 $content['sep'] = $SEP;
1686 // Load navigation template
1687 $OUT = loadTemplate('admin_email_nav_row', true, $content);
1689 if ($return === true) {
1690 // Return generated HTML-Code
1698 // Extract host from script name
1699 function extractHostnameFromUrl (&$script) {
1700 // Use default SERVER_URL by default... ;) So?
1701 $url = getConfig('SERVER_URL');
1703 // Is this URL valid?
1704 if (substr($script, 0, 7) == 'http://') {
1705 // Use the hostname from script URL as new hostname
1706 $url = substr($script, 7);
1707 $extract = explode('/', $url);
1709 // Done extracting the URL :)
1712 // Extract host name
1713 $host = str_replace('http://', '', $url);
1714 if (ereg('/', $host)) $host = substr($host, 0, strpos($host, '/'));
1716 // Generate relative URL
1717 //* DEBUG: */ print("SCRIPT=" . $script.'<br />');
1718 if (substr(strtolower($script), 0, 7) == 'http://') {
1719 // But only if http:// is in front!
1720 $script = substr($script, (strlen($url) + 7));
1721 } elseif (substr(strtolower($script), 0, 8) == 'https://') {
1723 $script = substr($script, (strlen($url) + 8));
1726 //* DEBUG: */ print("SCRIPT=" . $script.'<br />');
1727 if (substr($script, 0, 1) == '/') $script = substr($script, 1);
1733 // Send a GET request
1734 function sendGetRequest ($script, $data = array()) {
1735 // Extract host name from script
1736 $host = extractHostnameFromUrl($script);
1739 $body = http_build_query($data, '', '&');
1741 // Do we have a question-mark in the script?
1742 if (strpos($script, '?') === false) {
1743 // No, so first char must be question mark
1744 $body = '?' . $body;
1747 $body = '&' . $body;
1753 // Remove trailed & to make it more conform
1754 if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
1756 // Generate GET request header
1757 $request = 'GET /' . trim($script) . ' HTTP/1.1' . getConfig('HTTP_EOL');
1758 $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
1759 $request .= 'Referer: ' . getConfig('URL') . '/admin.php' . getConfig('HTTP_EOL');
1760 if (isConfigEntrySet('FULL_VERSION')) {
1761 $request .= 'User-Agent: ' . getConfig('TITLE') . '/' . getConfig('FULL_VERSION') . getConfig('HTTP_EOL');
1763 $request .= 'User-Agent: ' . getConfig('TITLE') . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
1765 $request .= 'Accept: text/plain;q=0.8' . getConfig('HTTP_EOL');
1766 $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
1767 $request .= 'Cache-Control: no-cache' . getConfig('HTTP_EOL');
1768 $request .= 'Content-Type: text/plain' . getConfig('HTTP_EOL');
1769 $request .= 'Content-Length: 0' . getConfig('HTTP_EOL');
1770 $request .= 'Connection: close' . getConfig('HTTP_EOL');
1771 $request .= getConfig('HTTP_EOL');
1773 // Send the raw request
1774 $response = sendRawRequest($host, $request);
1776 // Return the result to the caller function
1780 // Send a POST request
1781 function sendPostRequest ($script, $postData) {
1782 // Is postData an array?
1783 if (!is_array($postData)) {
1785 logDebugMessage(__FUNCTION__, __LINE__, sprintf("postData is not an array. Type: %s", gettype($postData)));
1786 return array('', '', '');
1789 // Extract host name from script
1790 $host = extractHostnameFromUrl($script);
1792 // Construct request
1793 $body = http_build_query($postData, '', '&');
1795 // Generate POST request header
1796 $request = 'POST /' . trim($script) . ' HTTP/1.1' . getConfig('HTTP_EOL');
1797 $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
1798 $request .= 'Referer: ' . getConfig('URL') . '/admin.php' . getConfig('HTTP_EOL');
1799 $request .= 'User-Agent: ' . getConfig('TITLE') . '/' . getConfig('FULL_VERSION') . getConfig('HTTP_EOL');
1800 $request .= 'Cache-Control: no-cache' . getConfig('HTTP_EOL');
1801 $request .= 'Content-Type: application/x-www-form-urlencoded' . getConfig('HTTP_EOL');
1802 $request .= 'Connection: close' . getConfig('HTTP_EOL');
1803 $request .= getConfig('HTTP_EOL');
1808 // Send the raw request
1809 $response = sendRawRequest($host, $request);
1811 // Return the result to the caller function
1815 // Sends a raw request to another host
1816 function sendRawRequest ($host, $request) {
1817 // Init errno and errdesc with 'all fine' values
1818 $errno = '0'; $errdesc = '';
1821 $response = array('', '', '');
1823 // Default is not to use proxy
1826 // Are proxy settins set?
1827 if ((isConfigEntrySet('proxy_host')) && (getConfig('proxy_host') != '') && (isConfigEntrySet('proxy_port')) && (getConfig('proxy_port') > 0)) {
1833 //* DEBUG: */ die("SCRIPT=" . $script.'<br />');
1834 if ($useProxy === true) {
1835 // Connect to host through proxy connection
1836 $fp = fsockopen(compileRawCode(getConfig('proxy_host')), bigintval(getConfig('proxy_port')), $errno, $errdesc, 30);
1838 // Connect to host directly
1839 $fp = fsockopen($host, 80, $errno, $errdesc, 30);
1843 if (!is_resource($fp)) {
1845 logDebugMessage(__FUNCTION__, __LINE__, $errdesc . ' (' . $errno . ')');
1847 } elseif ((!stream_set_blocking($fp, 0)) || (!stream_set_timeout($fp, 1))) {
1848 // Cannot set non-blocking mode or timeout
1849 logDebugMessage(__FUNCTION__, __LINE__, socket_strerror(socket_last_error()));
1854 if ($useProxy === true) {
1855 // Generate CONNECT request header
1856 $proxyTunnel = 'CONNECT ' . $host . ':80 HTTP/1.1' . getConfig('HTTP_EOL');
1857 $proxyTunnel .= 'Host: ' . $host . getConfig('HTTP_EOL');
1859 // Use login data to proxy? (username at least!)
1860 if (getConfig('proxy_username') != '') {
1862 $encodedAuth = base64_encode(compileRawCode(getConfig('proxy_username')) . getConfig('ENCRYPT_SEPERATOR') . compileRawCode(getConfig('proxy_password')));
1863 $proxyTunnel .= 'Proxy-Authorization: Basic ' . $encodedAuth . getConfig('HTTP_EOL');
1866 // Add last new-line
1867 $proxyTunnel .= getConfig('HTTP_EOL');
1868 //* DEBUG: */ print('<strong>proxyTunnel=</strong><pre>' . $proxyTunnel.'</pre>');
1871 fwrite($fp, $proxyTunnel);
1875 // No response received
1879 // Read the first line
1880 $resp = trim(fgets($fp, 10240));
1881 $respArray = explode(' ', $resp);
1882 if ((strtolower($respArray[0]) !== 'http/1.0') || ($respArray[1] != '200')) {
1883 // Invalid response!
1889 fwrite($fp, $request);
1892 $start = microtime(true);
1895 while (!feof($fp)) {
1896 // Get info from stream
1897 $info = stream_get_meta_data($fp);
1899 // Is it timed out? 15 seconds is a really patient...
1900 if (($info['timed_out'] == true) || (microtime(true) - $start) > 15) {
1902 logDebugMessage(__FUNCTION__, __LINE__, 'Timed out to get data from host ' . $host);
1908 // Get line from stream
1909 $line = fgets($fp, 128);
1911 // Ignore empty lines because of non-blocking mode
1913 // uslepp a little to avoid 100% CPU load
1920 // Add it to response
1921 $response[] = trim($line);
1927 // Time request if debug-mode is enabled
1928 if (isDebugModeEnabled()) {
1929 // Add debug message...
1930 logDebugMessage(__FUNCTION__, __LINE__, 'Request took ' . (microtime(true) - $start) . ' seconds.');
1933 // Skip first empty lines
1935 foreach ($resp as $idx => $line) {
1937 $line = trim($line);
1939 // Is this line empty?
1942 array_shift($response);
1944 // Abort on first non-empty line
1949 //* DEBUG: */ print('<strong>Response:</strong><pre>'.print_r($response, true).'</pre>');
1951 // Proxy agent found or something went wrong?
1952 if (!isset($response[0])) {
1953 // No response, maybe timeout
1954 $response = array('', '', '');
1955 } elseif ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && ($useProxy === true)) {
1956 // Proxy header detected, so remove two lines
1957 array_shift($response);
1958 array_shift($response);
1961 // Was the request successfull?
1962 if ((!eregi('200 OK', $response[0])) || (empty($response[0]))) {
1963 // Not found / access forbidden
1964 $response = array('', '', '');
1971 // Taken from www.php.net eregi() user comments
1972 function isEmailValid ($email) {
1973 // Check first part of email address
1974 $first = '[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*';
1977 $domain = '[a-z0-9-]+(\.[a-z0-9-]{2,5})+';
1980 $regex = '@^' . $first . '\@' . $domain . '$@iU';
1982 // Return check result
1983 return preg_match($regex, $email);
1986 // Function taken from user comments on www.php.net / function eregi()
1987 function isUrlValid ($URL, $compile=true) {
1988 // Trim URL a little
1989 $URL = trim(urldecode($URL));
1990 //* DEBUG: */ outputHtml($URL.'<br />');
1992 // Compile some chars out...
1993 if ($compile === true) $URL = compileUriCode($URL, false, false, false);
1994 //* DEBUG: */ outputHtml($URL.'<br />');
1996 // Check for the extension filter
1997 if (isExtensionActive('filter')) {
1998 // Use the extension's filter set
1999 return FILTER_VALIDATE_URL($URL, false);
2002 // If not installed, perform a simple test. Just make it sure there is always a http:// or
2003 // https:// in front of the URLs
2004 return isUrlValidSimple($URL);
2007 // Generate a list of administrative links to a given userid
2008 function generateMemberAdminActionLinks ($userid, $status = '') {
2009 // Make sure userid is a number
2010 if ($userid != bigintval($userid)) debug_report_bug('userid is not a number!');
2012 // Define all main targets
2013 $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
2015 // Begin of navigation links
2018 foreach ($targetArray as $tar) {
2019 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&what=' . $tar . '&userid=' . $userid . '%}" title="{--ADMIN_LINK_';
2020 //* DEBUG: */ outputHtml('*' . $tar.'/' . $status.'*<br />');
2021 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
2022 // Locked accounts shall be unlocked
2023 $OUT .= 'UNLOCK_USER';
2025 // All other status is fine
2026 $OUT .= strtoupper($tar);
2028 $OUT .= '_TITLE--}">{--ADMIN_';
2029 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
2030 // Locked accounts shall be unlocked
2031 $OUT .= 'UNLOCK_USER';
2033 // All other status is fine
2034 $OUT .= strtoupper($tar);
2036 $OUT .= '--}</a></span> | ';
2039 // Finish navigation link
2040 $OUT = substr($OUT, 0, -7) . ']';
2046 // Generate an email link
2047 function generateEmailLink ($email, $table = 'admins') {
2048 // Default email link (INSECURE! Spammer can read this by harvester programs)
2049 $EMAIL = 'mailto:' . $email;
2051 // Check for several extensions
2052 if ((isExtensionActive('admins')) && ($table == 'admins')) {
2053 // Create email link for contacting admin in guest area
2054 $EMAIL = generateAdminEmailLink($email);
2055 } elseif ((isExtensionActive('user')) && (getExtensionVersion('user') >= '0.3.3') && ($table == 'user_data')) {
2056 // Create email link for contacting a member within admin area (or later in other areas, too?)
2057 $EMAIL = generateUserEmailLink($email, 'admin');
2058 } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
2059 // Create email link to contact sponsor within admin area (or like the link above?)
2060 $EMAIL = generateSponsorEmailLink($email, 'sponsor_data');
2063 // Shall I close the link when there is no admin?
2064 if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
2066 // Return email link
2070 // Generate a hash for extra-security for all passwords
2071 function generateHash ($plainText, $salt = '') {
2072 // Is the required extension 'sql_patches' there and a salt is not given?
2073 if (((isExtensionInstalledAndOlder('sql_patches', '0.3.6')) || (!isExtensionActive('sql_patches')) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) && (empty($salt))) {
2074 // Extension sql_patches is missing/outdated so we hash the plain text with MD5
2075 return md5($plainText);
2078 // Do we miss an arry element here?
2079 if (!isConfigEntrySet('file_hash')) {
2081 debug_report_bug('Missing file_hash in ' . __FUNCTION__ . '.');
2084 // When the salt is empty build a new one, else use the first x configured characters as the salt
2086 // Build server string (inc/databases.php is no longer updated with every commit)
2087 $server = $_SERVER['PHP_SELF'] . getConfig('ENCRYPT_SEPERATOR') . detectUserAgent() . getConfig('ENCRYPT_SEPERATOR') . getenv('SERVER_SOFTWARE') . getConfig('ENCRYPT_SEPERATOR') . detectRemoteAddr();
2090 $keys = getConfig('SITE_KEY') . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY') . getConfig('ENCRYPT_SEPERATOR') . getConfig('secret_key') . getConfig('ENCRYPT_SEPERATOR') . getConfig('file_hash') . getConfig('ENCRYPT_SEPERATOR') . date('d-m-Y (l-F-T)', getConfig('patch_ctime')) . getConfig('ENCRYPT_SEPERATOR') . getConfig('master_salt');
2093 $data = $plainText . getConfig('ENCRYPT_SEPERATOR') . uniqid(mt_rand(), true) . getConfig('ENCRYPT_SEPERATOR') . time();
2095 // Calculate number for generating the code
2096 $a = time() + getConfig('_ADD') - 1;
2098 // Generate SHA1 sum from modula of number and the prime number
2099 $sha1 = sha1(($a % getConfig('_PRIME')) . $server . getConfig('ENCRYPT_SEPERATOR') . $keys . getConfig('ENCRYPT_SEPERATOR') . $data . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY') . getConfig('ENCRYPT_SEPERATOR') . $a);
2100 //* DEBUG: */ outputHtml('SHA1=' . $sha1.' ('.strlen($sha1).')<br />');
2101 $sha1 = scrambleString($sha1);
2102 //* DEBUG: */ outputHtml('Scrambled=' . $sha1.' ('.strlen($sha1).')<br />');
2103 //* DEBUG: */ $sha1b = descrambleString($sha1);
2104 //* DEBUG: */ outputHtml('Descrambled=' . $sha1b.' ('.strlen($sha1b).')<br />');
2106 // Generate the password salt string
2107 $salt = substr($sha1, 0, getConfig('salt_length'));
2108 //* DEBUG: */ outputHtml($salt.' ('.strlen($salt).')<br />');
2111 //* DEBUG: */ print 'salt=' . $salt . '<br />';
2112 $salt = substr($salt, 0, getConfig('salt_length'));
2113 //* DEBUG: */ print 'salt=' . $salt . '(' . strlen($salt) . '/' . getConfig('salt_length') . ')<br />';
2115 // Sanity check on salt
2116 if (strlen($salt) != getConfig('salt_length')) {
2118 debug_report_bug(__FUNCTION__.': salt length mismatch! ('.strlen($salt).'/'.getConfig('salt_length').')');
2123 return $salt.sha1($salt . $plainText);
2126 // Scramble a string
2127 function scrambleString($str) {
2131 // Final check, in case of failture it will return unscrambled string
2132 if (strlen($str) > 40) {
2133 // The string is to long
2135 } elseif (strlen($str) == 40) {
2137 $scrambleNums = explode(':', getConfig('pass_scramble'));
2139 // Generate new numbers
2140 $scrambleNums = explode(':', genScrambleString(strlen($str)));
2143 // Compare both lengths and abort if different
2144 if (strlen($str) != count($scrambleNums)) return $str;
2146 // Scramble string here
2147 //* DEBUG: */ outputHtml('***Original=' . $str.'***<br />');
2148 for ($idx = '0'; $idx < strlen($str); $idx++) {
2149 // Get char on scrambled position
2150 $char = substr($str, $scrambleNums[$idx], 1);
2152 // Add it to final output string
2153 $scrambled .= $char;
2156 // Return scrambled string
2157 //* DEBUG: */ outputHtml('***Scrambled=' . $scrambled.'***<br />');
2161 // De-scramble a string scrambled by scrambleString()
2162 function descrambleString($str) {
2163 // Scramble only 40 chars long strings
2164 if (strlen($str) != 40) return $str;
2166 // Load numbers from config
2167 $scrambleNums = explode(':', getConfig('pass_scramble'));
2170 if (count($scrambleNums) != 40) return $str;
2172 // Begin descrambling
2173 $orig = str_repeat(' ', 40);
2174 //* DEBUG: */ outputHtml('+++Scrambled=' . $str.'+++<br />');
2175 for ($idx = '0'; $idx < 40; $idx++) {
2176 $char = substr($str, $idx, 1);
2177 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
2180 // Return scrambled string
2181 //* DEBUG: */ outputHtml('+++Original=' . $orig.'+++<br />');
2185 // Generated a "string" for scrambling
2186 function genScrambleString ($len) {
2187 // Prepare array for the numbers
2188 $scrambleNumbers = array();
2190 // First we need to setup randomized numbers from 0 to 31
2191 for ($idx = '0'; $idx < $len; $idx++) {
2193 $rand = mt_rand(0, ($len -1));
2195 // Check for it by creating more numbers
2196 while (array_key_exists($rand, $scrambleNumbers)) {
2197 $rand = mt_rand(0, ($len -1));
2201 $scrambleNumbers[$rand] = $rand;
2204 // So let's create the string for storing it in database
2205 $scrambleString = implode(':', $scrambleNumbers);
2206 return $scrambleString;
2209 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
2210 function generatePassString ($passHash) {
2211 // Return vanilla password hash
2214 // Is a secret key and master salt already initialized?
2215 if ((isExtensionInstalled('sql_patches')) && (isExtensionInstalledAndNewer('other', '0.2.5')) && (isConfigEntrySet('_PRIME')) && (isConfigEntrySet('secret_key')) && (isConfigEntrySet('master_salt'))) {
2216 // Only calculate when the secret key is generated
2217 $newHash = ''; $start = 9;
2218 for ($idx = '0'; $idx < 10; $idx++) {
2219 $part1 = hexdec(substr($passHash, $start, 4));
2220 $part2 = hexdec(substr(getConfig('secret_key'), $start, 4));
2221 $mod = dechex($idx);
2222 if ($part1 > $part2) {
2223 $mod = dechex(sqrt(($part1 - $part2) * getConfig('_PRIME') / pi()));
2224 } elseif ($part2 > $part1) {
2225 $mod = dechex(sqrt(($part2 - $part1) * getConfig('_PRIME') / pi()));
2227 $mod = substr($mod, 0, 4);
2228 //* DEBUG: */ outputHtml('part1='.$part1.'/part2='.$part2.'/mod=' . $mod . '('.strlen($mod).')<br />');
2229 $mod = str_repeat(0, (4 - strlen($mod))) . $mod;
2230 //* DEBUG: */ outputHtml('*' . $start . '=' . $mod . '*<br />');
2235 //* DEBUG: */ print($passHash.'<br />' . $newHash." (".strlen($newHash).')<br />');
2236 $ret = generateHash($newHash, getConfig('master_salt'));
2237 //* DEBUG: */ print('ret='.$ret.'<br />');
2240 //* DEBUG: */ outputHtml("--" . $passHash."--<br />");
2241 $ret = md5($passHash);
2242 //* DEBUG: */ outputHtml("++" . $ret."++<br />");
2249 // Fix "deleted" cookies
2250 function fixDeletedCookies ($cookies) {
2251 // Is this an array with entries?
2252 if ((is_array($cookies)) && (count($cookies) > 0)) {
2253 // Then check all cookies if they are marked as deleted!
2254 foreach ($cookies as $cookieName) {
2255 // Is the cookie set to "deleted"?
2256 if (getSession($cookieName) == 'deleted') {
2257 setSession($cookieName, '');
2263 // Output error messages in a fasioned way and die...
2264 function app_die ($F, $L, $message) {
2265 // Check if Script is already dieing and not let it kill itself another 1000 times
2266 if (!isset($GLOBALS['app_died'])) {
2267 // Make sure, that the script realy realy diese here and now
2268 $GLOBALS['app_died'] = true;
2271 loadIncludeOnce('inc/header.php');
2273 // Rewrite message for output
2274 $message = sprintf(getMessage('MXCHANGE_HAS_DIED'), basename($F), $L, $message);
2276 // Better log this message away
2277 if ($F != 'debug_report_bug') logDebugMessage($F, $L, $message);
2279 // Load the message template
2280 loadTemplate('app_die_message', false, $message);
2283 loadIncludeOnce('inc/footer.php');
2285 // Script tried to kill itself twice
2286 debug_report_bug('Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
2290 // Display parsing time and number of SQL queries in footer
2291 function displayParsingTime() {
2292 // Is the timer started?
2293 if (!isset($GLOBALS['startTime'])) {
2299 $endTime = microtime(true);
2301 // "Explode" both times
2302 $start = explode(' ', $GLOBALS['startTime']);
2303 $end = explode(' ', $endTime);
2304 $runTime = $end[0] - $start[0];
2305 if ($runTime < 0) $runTime = '0';
2309 'runtime' => translateComma($runTime),
2310 'timeSQLs' => translateComma(getConfig('sql_time') * 1000),
2313 // Load the template
2314 loadTemplate('show_timings', false, $content);
2317 // Check wether a boolean constant is set
2318 // Taken from user comments in PHP documentation for function constant()
2319 function isBooleanConstantAndTrue ($constName) { // : Boolean
2320 // Failed by default
2324 if (isset($GLOBALS['cache_array']['const'][$constName])) {
2326 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): " . $constName."-CACHE!<br />");
2327 $res = ($GLOBALS['cache_array']['const'][$constName] === true);
2330 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): " . $constName."-RESOLVE!<br />");
2331 if (defined($constName)) {
2333 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): " . $constName."-FOUND!<br />");
2334 $res = (constant($constName) === true);
2338 $GLOBALS['cache_array']['const'][$constName] = $res;
2340 //* DEBUG: */ var_dump($res);
2346 // Checks if a given apache module is loaded
2347 function isApacheModuleLoaded ($apacheModule) {
2348 // Check it and return result
2349 return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
2352 // Get current theme name
2353 function getCurrentTheme () {
2354 // The default theme is 'default'... ;-)
2357 // Do we have ext-theme installed and active?
2358 if (isExtensionActive('theme')) {
2359 // Call inner method
2360 $ret = getActualTheme();
2363 // Return theme value
2367 // Generates an error code from given account status
2368 function generateErrorCodeFromUserStatus ($status='') {
2369 // If no status is provided, use the default, cached
2370 if ((empty($status)) && (isMember())) {
2372 $status = getUserData('status');
2375 // Default error code if unknown account status
2376 $errorCode = getCode('UNKNOWN_STATUS');
2378 // Generate constant name
2379 $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
2381 // Is the constant there?
2382 if (isCodeSet($codeName)) {
2384 $errorCode = getCode($codeName);
2387 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
2390 // Return error code
2394 // Function to search for the last modifified file
2395 function searchDirsRecursive ($dir, &$last_changed) {
2397 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):dir=" . $dir.'<br />');
2398 // Does it match what we are looking for? (We skip a lot files already!)
2399 // RegexPattern to exclude ., .., .revision, .svn, debug.log or .cache in the filenames
2400 $excludePattern = '@(\.revision|debug\.log|\.cache|config\.php)$@';
2401 $ds = getArrayFromDirectory($dir, '', true, false, array(), '.php', $excludePattern);
2402 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):ds[]=".count($ds).'<br />');
2404 // Walk through all entries
2405 foreach ($ds as $d) {
2406 // Generate proper FQFN
2407 $FQFN = str_replace('//', '/', getConfig('PATH') . $dir. '/'. $d);
2409 // Is it a file and readable?
2410 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):FQFN={$FQFN}<br />");
2411 if (isDirectory($FQFN)) {
2412 // $FQFN is a directory so also crawl into this directory
2414 if (!empty($dir)) $newDir = $dir . '/'. $d;
2415 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):DESCENT: " . $newDir.'<br />');
2416 searchDirsRecursive($newDir, $last_changed);
2417 } elseif (isFileReadable($FQFN)) {
2418 // $FQFN is a filename and no directory
2419 $time = filemtime($FQFN);
2420 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):File: " . $d." found. (".($last_changed['time'] - $time).")<br />");
2421 if ($last_changed['time'] < $time) {
2422 // This file is newer as the file before
2423 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>) - NEWER!<br />");
2424 $last_changed['path_name'] = $FQFN;
2425 $last_changed['time'] = $time;
2431 // "Getter" for revision/version data
2432 function getActualVersion ($type = 'Revision') {
2433 // By default nothing is new... ;-)
2436 // Is the cache entry there?
2437 if (isset($GLOBALS['cache_array']['revision'][$type])) {
2438 // Found so increase cache hit
2439 incrementStatsEntry('cache_hits');
2442 return $GLOBALS['cache_array']['revision'][$type][0];
2444 // FQFN of revision file
2445 $FQFN = sprintf("%s/.revision", getConfig('CACHE_PATH'));
2447 // Check if 'check_revision_data' is setted (switch for manually rewrite the .revision-File)
2448 if ((isGetRequestElementSet('check_revision_data')) && (getRequestElement('check_revision_data') == 'yes')) {
2449 // Forced rebuild of .revision file
2452 // Check for revision file
2453 if (!isFileReadable($FQFN)) {
2454 // Not found, so we need to create it
2457 // Revision file found
2458 $ins_vers = explode("\n", readFromFile($FQFN));
2460 // Get array for mapping information
2461 $mapper = array_flip(getSearchFor());
2462 //* DEBUG: */ print('<pre>mapper='.print_r($mapper, true).'</pre>ins_vers=<pre>'.print_r($ins_vers, true).'</pre>');
2464 // Is the content valid?
2465 if ((!is_array($ins_vers)) || (count($ins_vers) <= 0) || (!isset($ins_vers[$mapper[$type]])) || (trim($ins_vers[$mapper[$type]]) == '') || ($ins_vers[0]) == 'new') {
2466 // File needs update!
2469 // Generate fake cache entry
2470 foreach ($mapper as $map => $idx) {
2471 $GLOBALS['cache_array']['revision'][$map][0] = $ins_vers[$idx];
2474 // Return found value
2475 return trim($ins_vers[$mapper[$type]]);
2480 // Has it been updated?
2481 if ($new === true) {
2483 writeToFile($FQFN, implode("\n", getArrayFromActualVersion()));
2485 // ... and call recursive
2486 return getActualVersion($type);
2491 // Repares an array we are looking for
2492 // The returned Array is needed twice (in getArrayFromActualVersion() and in getActualVersion() in the old .revision-fallback) so I puted it in an extra function to not polute the global namespace
2493 function getSearchFor () {
2494 // Add Revision, Date, Tag and Author
2495 $searchFor = array('Revision', 'Date', 'Tag', 'Author', 'File');
2497 // Return the created array
2501 // @TODO Please describe this function
2502 function getArrayFromActualVersion () {
2506 // Directory to start with search
2507 $last_changed = array(
2512 // Init return array
2513 $akt_vers = array();
2515 // Init value for counting the founded keywords
2518 // Searches all Files and there date of the last modifikation and puts the newest File in $last_changed.
2519 searchDirsRecursive($next_dir, $last_changed); // @TODO small change to API to $last_changed = searchDirsRecursive($next_dir, $time);
2522 $last_file = readFromFile($last_changed['path_name']);
2524 // Get all the keywords to search for
2525 $searchFor = getSearchFor();
2527 // This foreach loops the $searchFor-Tags (array('Revision', 'Date', 'Tag', 'Author') --> could easaly extended in the future)
2528 foreach ($searchFor as $search) {
2529 // Searches for "$search-tag:VALUE$" or "$search-tag::VALUE$"(the stylish keywordversion ;-)) in the lates modified file
2530 $res += preg_match('@\$' . $search.'(:|::) (.*) \$@U', $last_file, $t);
2531 // This trimms the search-result and puts it in the $GLOBALS['cache_array']['revision']-return array
2532 if (isset($t[2])) $GLOBALS['cache_array']['revision'][$search] = trim($t[2]);
2535 // Save the last-changed filename for debugging
2536 $GLOBALS['cache_array']['revision']['File'] = $last_changed['path_name'];
2538 // at least 3 keyword-Tags are needed for propper values
2539 if ($res && $res >= 3
2540 && isset($GLOBALS['cache_array']['revision']['Revision']) && $GLOBALS['cache_array']['revision']['Revision'] != ''
2541 && isset($GLOBALS['cache_array']['revision']['Date']) && $GLOBALS['cache_array']['revision']['Date'] != ''
2542 && isset($GLOBALS['cache_array']['revision']['Tag']) && $GLOBALS['cache_array']['revision']['Tag'] != '') {
2543 // Prepare content witch need special treadment
2545 // Prepare timestamp for date
2546 preg_match('@(....)-(..)-(..) (..):(..):(..)@', $GLOBALS['cache_array']['revision']['Date'], $match_d);
2547 $GLOBALS['cache_array']['revision']['Date'] = mktime($match_d[4], $match_d[5], $match_d[6], $match_d[2], $match_d[3], $match_d[1]);
2549 // Add author to the Tag if the author is set and is not quix0r (lead coder)
2550 if ((isset($GLOBALS['cache_array']['revision']['Author'])) && ($GLOBALS['cache_array']['revision']['Author'] != 'quix0r')) {
2551 $GLOBALS['cache_array']['revision']['Tag'] .= '-'.strtoupper($GLOBALS['cache_array']['revision']['Author']);
2555 // No valid Data from the last modificated file so read the Revision from the Server. Fallback-solution!! Should not be removed I think.
2556 $version = sendGetRequest('check-updates3.php');
2559 // Only sets not setted or not proper values to the Online-Server-Fallback-Solution
2560 if (!isset($GLOBALS['cache_array']['revision']['Revision']) || $GLOBALS['cache_array']['revision']['Revision'] == '') $GLOBALS['cache_array']['revision']['Revision'] = trim($version[10]);
2561 if (!isset($GLOBALS['cache_array']['revision']['Date']) || $GLOBALS['cache_array']['revision']['Date'] == '') $GLOBALS['cache_array']['revision']['Date'] = trim($version[9]);
2562 if (!isset($GLOBALS['cache_array']['revision']['Tag']) || $GLOBALS['cache_array']['revision']['Tag'] == '') $GLOBALS['cache_array']['revision']['Tag'] = trim($version[8]);
2563 if (!isset($GLOBALS['cache_array']['revision']['Author']) || $GLOBALS['cache_array']['revision']['Author'] == '') $GLOBALS['cache_array']['revision']['Author'] = 'quix0r';
2564 if (!isset($GLOBALS['cache_array']['revision']['File']) || $GLOBALS['cache_array']['revision']['File'] == '') $GLOBALS['cache_array']['revision']['File'] = trim($version[11]);
2567 // Return prepared array
2568 return $GLOBALS['cache_array']['revision'];
2571 // Back-ported from the new ship-simu engine. :-)
2572 function debug_get_printable_backtrace () {
2574 $backtrace = "<ol>\n";
2576 // Get and prepare backtrace for output
2577 $backtraceArray = debug_backtrace();
2578 foreach ($backtraceArray as $key => $trace) {
2579 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
2580 if (!isset($trace['line'])) $trace['line'] = __LINE__;
2581 if (!isset($trace['args'])) $trace['args'] = array();
2582 $backtrace .= "<li class=\"debug_list\"><span class=\"backtrace_file\">".basename($trace['file'])."</span>:" . $trace['line'].", <span class=\"backtrace_function\">" . $trace['function'].'('.count($trace['args']).")</span></li>\n";
2586 $backtrace .= "</ol>\n";
2588 // Return the backtrace
2592 // A mail-able backtrace
2593 function debug_get_mailable_backtrace () {
2597 // Get and prepare backtrace for output
2598 $backtraceArray = debug_backtrace();
2599 foreach ($backtraceArray as $key => $trace) {
2600 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
2601 if (!isset($trace['line'])) $trace['line'] = __LINE__;
2602 if (!isset($trace['args'])) $trace['args'] = array();
2603 $backtrace .= ($key+1) . '.:' . basename($trace['file']) . ':' . $trace['line'] . ', ' . $trace['function'] . '(' . count($trace['args']) . ")\n";
2606 // Return the backtrace
2610 // Output a debug backtrace to the user
2611 function debug_report_bug ($message = '', $sendEmail = true) {
2612 // Is this already called?
2613 if (isset($GLOBALS[__FUNCTION__])) {
2615 print 'Message:'.$message.'<br />Backtrace:<pre>';
2616 debug_print_backtrace();
2620 // Set this function as called
2621 $GLOBALS[__FUNCTION__] = true;
2626 // Is the optional message set?
2627 if (!empty($message)) {
2629 $debug = sprintf("Note: %s<br />\n",
2633 // @TODO Add a little more infos here
2634 logDebugMessage(__FUNCTION__, __LINE__, strip_tags($message));
2638 $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(getConfig('PATH'), '', getConfig('CACHE_PATH')) . "debug.log</strong> in your report (you can now attach files):<pre>";
2639 $debug .= debug_get_printable_backtrace();
2640 $debug .= "</pre>\nRequest-URI: " . getRequestUri()."<br />\n";
2641 $debug .= "Thank you for finding bugs.";
2643 // Send an email? (e.g. not wanted for evaluation errors)
2644 if (($sendEmail === true) && (!isInstallationPhase())) {
2647 'message' => trim($message),
2648 'backtrace' => trim(debug_get_mailable_backtrace())
2651 // Send email to webmaster
2652 sendAdminNotification(getMessage('DEBUG_REPORT_BUG_SUBJECT'), 'admin_report_bug', $content);
2656 app_die(__FUNCTION__, __LINE__, $debug);
2659 // Generates a ***weak*** seed
2660 function generateSeed () {
2661 return microtime(true) * 100000;
2664 // Converts a message code to a human-readable message
2665 function getMessageFromErrorCode ($code) {
2669 case getCode('LOGOUT_DONE') : $message = getMessage('LOGOUT_DONE'); break;
2670 case getCode('LOGOUT_FAILED') : $message = '<span class="guest_failed">{--LOGOUT_FAILED--}</span>'; break;
2671 case getCode('DATA_INVALID') : $message = getMessage('MAIL_DATA_INVALID'); break;
2672 case getCode('POSSIBLE_INVALID') : $message = getMessage('MAIL_POSSIBLE_INVALID'); break;
2673 case getCode('USER_404') : $message = getMessage('USER_404'); break;
2674 case getCode('STATS_404') : $message = getMessage('MAIL_STATS_404'); break;
2675 case getCode('ALREADY_CONFIRMED') : $message = getMessage('MAIL_ALREADY_CONFIRMED'); break;
2676 case getCode('WRONG_PASS') : $message = getMessage('LOGIN_WRONG_PASS'); break;
2677 case getCode('WRONG_ID') : $message = getMessage('LOGIN_WRONG_ID'); break;
2678 case getCode('ACCOUNT_LOCKED') : $message = getMessage('LOGIN_STATUS_LOCKED'); break;
2679 case getCode('ACCOUNT_UNCONFIRMED'): $message = getMessage('LOGIN_STATUS_UNCONFIRMED'); break;
2680 case getCode('COOKIES_DISABLED') : $message = getMessage('LOGIN_COOKIES_DISABLED'); break;
2681 case getCode('BEG_SAME_AS_OWN') : $message = getMessage('BEG_SAME_UID_AS_OWN'); break;
2682 case getCode('LOGIN_FAILED') : $message = getMessage('LOGIN_FAILED_GENERAL'); break;
2683 case getCode('MODULE_MEM_ONLY') : $message = getMaskedMessage('MODULE_MEM_ONLY', getRequestElement('mod')); break;
2684 case getCode('OVERLENGTH') : $message = getMessage('MEMBER_TEXT_OVERLENGTH'); break;
2685 case getCode('URL_FOUND') : $message = getMessage('MEMBER_TEXT_CONTAINS_URL'); break;
2686 case getCode('SUBJ_URL') : $message = getMessage('MEMBER_SUBJ_CONTAINS_URL'); break;
2687 case getCode('BLIST_URL') : $message = "{--MEMBER_URL_BLACK_LISTED--}<br />\n{--MEMBER_BLIST_TIME--}: ".generateDateTime(getRequestElement('blist'), 0); break;
2688 case getCode('NO_RECS_LEFT') : $message = getMessage('MEMBER_SELECTED_MORE_RECS'); break;
2689 case getCode('INVALID_TAGS') : $message = getMessage('MEMBER_HTML_INVALID_TAGS'); break;
2690 case getCode('MORE_POINTS') : $message = getMessage('MEMBER_MORE_POINTS_NEEDED'); break;
2691 case getCode('MORE_RECEIVERS1') : $message = getMessage('MEMBER_ENTER_MORE_RECEIVERS'); break;
2692 case getCode('MORE_RECEIVERS2') : $message = getMessage('MEMBER_NO_MORE_RECEIVERS_FOUND'); break;
2693 case getCode('MORE_RECEIVERS3') : $message = getMessage('MEMBER_ENTER_MORE_MIN_RECEIVERS'); break;
2694 case getCode('INVALID_URL') : $message = getMessage('MEMBER_ENTER_INVALID_URL'); break;
2695 case getCode('UNKNOWN_ERROR') : $message = getMessage('LOGIN_UNKNOWN_ERROR'); break;
2696 case getCode('UNKNOWN_STATUS') : $message = getMessage('LOGIN_UNKNOWN_STATUS'); break;
2698 case getCode('ERROR_MAILID'):
2699 if (isExtensionActive('mailid', true)) {
2700 $message = getMessage('ERROR_CONFIRMING_MAIL');
2702 $message = getMaskedMessage('EXTENSION_PROBLEM_NOT_INSTALLED', 'mailid');
2706 case getCode('EXTENSION_PROBLEM'):
2707 if (isGetRequestElementSet('ext')) {
2708 $message = generateExtensionInactiveNotInstalledMessage(getRequestElement('ext'));
2710 $message = getMessage('EXTENSION_PROBLEM_UNSET_EXT');
2714 case getCode('URL_TLOCK'):
2715 // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
2716 $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
2717 array(bigintval(getRequestElement('id'))), __FILE__, __LINE__);
2719 // Load timestamp from last order
2720 list($timestamp) = SQL_FETCHROW($result);
2723 SQL_FREERESULT($result);
2725 // Translate it for templates
2726 $timestamp = generateDateTime($timestamp, 1);
2728 // Calculate hours...
2729 $STD = round(getConfig('url_tlock') / 60 / 60);
2732 $MIN = round((getConfig('url_tlock') - $STD * 60 * 60) / 60);
2735 $SEC = getConfig('url_tlock') - $STD * 60 * 60 - $MIN * 60;
2737 // Finally contruct the message
2738 // @TODO Rewrite this old lost code to a template
2739 $message = "{--MEMBER_URL_TIME_LOCK--}<br />{--CONFIG_URL_TLOCK--} ".$STD."
2740 {--_HOURS--}, ".$MIN." {--_MINUTES--} {--_AND--} ".$SEC." {--_SECONDS--}<br />
2741 {--MEMBER_LAST_TLOCK--}: ".$timestamp;
2745 // Missing/invalid code
2746 $message = getMaskedMessage('UNKNOWN_MAILID_CODE', $code);
2749 logDebugMessage(__FUNCTION__, __LINE__, $message);
2753 // Return the message
2757 // Compile characters which are allowed in URLs
2758 function compileUriCode ($code, $simple = true) {
2759 // Compile constants
2760 if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
2762 // Compile QUOT and other non-HTML codes
2763 $code = str_replace('{DOT}', '.',
2764 str_replace('{SLASH}', '/',
2765 str_replace('{QUOT}', "'",
2766 str_replace('{DOLLAR}', '$',
2767 str_replace('{OPEN_ANCHOR}', '(',
2768 str_replace('{CLOSE_ANCHOR}', ')',
2769 str_replace('{OPEN_SQR}', '[',
2770 str_replace('{CLOSE_SQR}', ']',
2771 str_replace('{PER}', '%',
2775 // Return compiled code
2779 // Function taken from user comments on www.php.net / function eregi()
2780 function isUrlValidSimple ($url) {
2782 $url = secureString(str_replace("\\", '', compileRawCode(urldecode($url))));
2784 // Allows http and https
2785 $http = "(http|https)+(:\/\/)";
2787 $domain1 = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
2788 // Test double-domains (e.g. .de.vu)
2789 $domain2 = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
2791 $ip = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
2793 $dir = "((/)+([-_\.[:alnum:]])+)*";
2795 $page = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
2796 // ... and the string after and including question character
2797 $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
2798 // Pattern for URLs like http://url/dir/doc.html?var=value
2799 $pattern['d1dpg1'] = $http . $domain1 . $dir . $page . $getstring1;
2800 $pattern['d2dpg1'] = $http . $domain2 . $dir . $page . $getstring1;
2801 $pattern['ipdpg1'] = $http . $ip . $dir . $page . $getstring1;
2802 // Pattern for URLs like http://url/dir/?var=value
2803 $pattern['d1dg1'] = $http . $domain1 . $dir.'/' . $getstring1;
2804 $pattern['d2dg1'] = $http . $domain2 . $dir.'/' . $getstring1;
2805 $pattern['ipdg1'] = $http . $ip . $dir.'/' . $getstring1;
2806 // Pattern for URLs like http://url/dir/page.ext
2807 $pattern['d1dp'] = $http . $domain1 . $dir . $page;
2808 $pattern['d1dp'] = $http . $domain2 . $dir . $page;
2809 $pattern['ipdp'] = $http . $ip . $dir . $page;
2810 // Pattern for URLs like http://url/dir
2811 $pattern['d1d'] = $http . $domain1 . $dir;
2812 $pattern['d2d'] = $http . $domain2 . $dir;
2813 $pattern['ipd'] = $http . $ip . $dir;
2814 // Pattern for URLs like http://url/?var=value
2815 $pattern['d1g1'] = $http . $domain1 . '/' . $getstring1;
2816 $pattern['d2g1'] = $http . $domain2 . '/' . $getstring1;
2817 $pattern['ipg1'] = $http . $ip . '/' . $getstring1;
2818 // Pattern for URLs like http://url?var=value
2819 $pattern['d1g12'] = $http . $domain1 . $getstring1;
2820 $pattern['d2g12'] = $http . $domain2 . $getstring1;
2821 $pattern['ipg12'] = $http . $ip . $getstring1;
2822 // Test all patterns
2824 foreach ($pattern as $key => $pat) {
2826 if (isDebugRegExpressionEnabled()) {
2827 // @TODO Are these convertions still required?
2828 $pat = str_replace('.', "\.", $pat);
2829 $pat = str_replace('@', "\@", $pat);
2830 //* DEBUG: */ outputHtml($key."= " . $pat . '<br />');
2833 // Check if expression matches
2834 $reg = ($reg || preg_match(('^' . $pat.'^'), $url));
2837 if ($reg === true) break;
2840 // Return true/false
2844 // Wtites data to a config.php-style file
2845 // @TODO Rewrite this function to use readFromFile() and writeToFile()
2846 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
2847 // Initialize some variables
2853 // Is the file there and read-/write-able?
2854 if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
2855 $search = 'CFG: ' . $comment;
2856 $tmp = $FQFN . '.tmp';
2858 // Open the source file
2859 $fp = fopen($FQFN, 'r') or outputHtml('<strong>READ:</strong> ' . $FQFN . '<br />');
2861 // Is the resource valid?
2862 if (is_resource($fp)) {
2863 // Open temporary file
2864 $fp_tmp = fopen($tmp, 'w') or outputHtml('<strong>WRITE:</strong> ' . $tmp . '<br />');
2866 // Is the resource again valid?
2867 if (is_resource($fp_tmp)) {
2868 // Mark temporary file as readable
2869 $GLOBALS['file_readable'][$tmp] = true;
2872 while (!feof($fp)) {
2873 // Read from source file
2874 $line = fgets ($fp, 1024);
2876 if (strpos($line, $search) > -1) { $next = '0'; $found = true; }
2879 if ($next === $seek) {
2881 $line = $prefix . $DATA . $suffix . "\n";
2887 // Write to temp file
2888 fwrite($fp_tmp, $line);
2894 // Finished writing tmp file
2898 // Close source file
2901 if (($done === true) && ($found === true)) {
2902 // Copy back tmp file and delete tmp :-)
2903 copyFileVerified($tmp, $FQFN, 0644);
2904 return removeFile($tmp);
2905 } elseif ($found === false) {
2906 outputHtml('<strong>CHANGE:</strong> 404!');
2908 outputHtml('<strong>TMP:</strong> UNDONE!');
2912 // File not found, not readable or writeable
2913 outputHtml('<strong>404:</strong> ' . $FQFN . '<br />');
2916 // An error was detected!
2919 // Send notification to admin
2920 function sendAdminNotification ($subject, $templateName, $content=array(), $userid = '0') {
2921 if ((isExtensionInstalledAndNewer('admins', '0.4.1')) && (function_exists('sendAdminsEmails'))) {
2923 sendAdminsEmails($subject, $templateName, $content, $userid);
2925 // Send out out-dated way
2926 $message = loadEmailTemplate($templateName, $content, $userid);
2927 sendAdminEmails($subject, $message);
2931 // Debug message logger
2932 function logDebugMessage ($funcFile, $line, $message, $force=true) {
2933 // Is debug mode enabled?
2934 if ((isDebugModeEnabled()) || ($force === true)) {
2936 $message = str_replace("\r", '', str_replace("\n", '', $message));
2938 // Log this message away, we better don't call app_die() here to prevent an endless loop
2939 $fp = fopen(getConfig('CACHE_PATH') . 'debug.log', 'a') or die(__FUNCTION__.'['.__LINE__.']: Cannot write logfile debug.log!');
2940 fwrite($fp, date('d.m.Y|H:i:s', time()) . '|' . getModule(false) . '|' . basename($funcFile) . '|' . $line . '|' . $message . "\n");
2945 // Handle extra values
2946 function handleExtraValues ($filterFunction, $value, $extraValue) {
2947 // Default is the value itself
2950 // Do we have a special filter function?
2951 if (!empty($filterFunction)) {
2952 // Does the filter function exist?
2953 if (function_exists($filterFunction)) {
2954 // Do we have extra parameters here?
2955 if (!empty($extraValue)) {
2956 // Put both parameters in one new array by default
2957 $args = array($value, $extraValue);
2959 // If we have an array simply use it and pre-extend it with our value
2960 if (is_array($extraValue)) {
2961 // Make the new args array
2962 $args = merge_array(array($value), $extraValue);
2965 // Call the multi-parameter call-back
2966 $ret = call_user_func_array($filterFunction, $args);
2968 // One parameter call
2969 $ret = call_user_func($filterFunction, $value);
2978 // Converts timestamp selections into a timestamp
2979 function convertSelectionsToTimestamp (&$postData, &$DATA, &$id, &$skip) {
2980 // Init test variable
2984 // Get last three chars
2985 $test = substr($id, -3);
2987 // Improved way of checking! :-)
2988 if (in_array($test, array('_ye', '_mo', '_we', '_da', '_ho', '_mi', '_se'))) {
2989 // Found a multi-selection for timings?
2990 $test = substr($id, 0, -3);
2991 if ((isset($postData[$test.'_ye'])) && (isset($postData[$test.'_mo'])) && (isset($postData[$test.'_we'])) && (isset($postData[$test.'_da'])) && (isset($postData[$test.'_ho'])) && (isset($postData[$test.'_mi'])) && (isset($postData[$test.'_se'])) && ($test != $test2)) {
2992 // Generate timestamp
2993 $postData[$test] = createTimestampFromSelections($test, $postData);
2994 $DATA[] = sprintf("`%s`='%s'", $test, $postData[$test]);
2995 $GLOBALS['skip_config'][$test] = true;
2997 // Remove data from array
2998 foreach (array('ye', 'mo', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
2999 unset($postData[$test . '_' . $rem]);
3010 // Reverts the german decimal comma into Computer decimal dot
3011 function convertCommaToDot ($str) {
3012 // Default float is not a float... ;-)
3015 // Which language is selected?
3016 switch (getLanguage()) {
3017 case 'de': // German language
3018 // Remove german thousand dots first
3019 $str = str_replace('.', '', $str);
3021 // Replace german commata with decimal dot and cast it
3022 $float = (float)str_replace(',', '.', $str);
3025 default: // US and so on
3026 // Remove thousand dots first and cast
3027 $float = (float)str_replace(',', '', $str);
3035 // Handle menu-depending failed logins and return the rendered content
3036 function handleLoginFailtures ($accessLevel) {
3037 // Default output is empty ;-)
3040 // Is the session data set?
3041 if ((isSessionVariableSet('mxchange_' . $accessLevel.'_failures')) && (isSessionVariableSet('mxchange_' . $accessLevel.'_last_fail'))) {
3042 // Ignore zero values
3043 if (getSession('mxchange_' . $accessLevel.'_failures') > 0) {
3044 // Non-guest has login failures found, get both data and prepare it for template
3045 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):accessLevel={$accessLevel}<br />");
3047 'login_failures' => getSession('mxchange_' . $accessLevel.'_failures'),
3048 'last_failure' => generateDateTime(getSession('mxchange_' . $accessLevel.'_last_fail'), 2)
3052 $OUT = loadTemplate('login_failures', true, $content);
3055 // Reset session data
3056 setSession('mxchange_' . $accessLevel.'_failures', '');
3057 setSession('mxchange_' . $accessLevel.'_last_fail', '');
3060 // Return rendered content
3065 function rebuildCacheFile ($cache, $inc = '', $force = false) {
3067 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("cache=%s, inc=%s, force=%s", $cache, $inc, intval($force)));
3069 // Shall I remove the cache file?
3070 if (isCacheInstanceValid()) {
3072 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
3074 $GLOBALS['cache_instance']->removeCacheFile($force);
3077 // Include file given?
3080 $inc = sprintf("inc/loader/load_cache-%s.php", $inc);
3082 // Is the include there?
3083 if (isIncludeReadable($inc)) {
3084 // And rebuild it from scratch
3085 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): inc={$inc} - LOADED!<br />");
3088 // Include not found!
3089 logDebugMessage(__FUNCTION__, __LINE__, "Include {$inc} not found. cache={$cache}");
3095 // Determines the real remote address
3096 function determineRealRemoteAddress () {
3097 // Is a proxy in use?
3098 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) {
3100 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
3101 } elseif (isset($_SERVER['HTTP_CLIENT_IP'])) {
3102 // Yet, another proxy
3103 $address = $_SERVER['HTTP_CLIENT_IP'];
3105 // The regular address when no proxy was used
3106 $address = $_SERVER['REMOTE_ADDR'];
3109 // This strips out the real address from proxy output
3110 if (strstr($address, ',')) {
3111 $addressArray = explode(',', $address);
3112 $address = $addressArray[0];
3115 // Return the result
3119 // Adds a bonus mail to the queue
3120 // This is a high-level function!
3121 function addNewBonusMail ($data, $mode = '', $output=true) {
3122 // Use mode from data if not set and availble ;-)
3123 if ((empty($mode)) && (isset($data['mode']))) $mode = $data['mode'];
3125 // Generate receiver list
3126 $receiver = generateReceiverList($data['cat'], $data['receiver'], $mode);
3129 if (!empty($receiver)) {
3130 // Add bonus mail to queue
3131 addBonusMailToQueue(
3143 // Mail inserted into bonus pool
3144 if ($output) loadTemplate('admin_settings_saved', false, getMessage('ADMIN_BONUS_SEND'));
3145 } elseif ($output) {
3146 // More entered than can be reached!
3147 loadTemplate('admin_settings_saved', false, getMessage('ADMIN_MORE_SELECTED'));
3150 logDebugMessage(__FUNCTION__, __LINE__, "cat={$data['cat']},receiver={$data['receiver']},data=".base64_encode(serialize($data))." More selected, than available!");
3154 // Determines referal id and sets it
3155 function determineReferalId () {
3156 // Skip this in non-html-mode and outside ref.php
3157 if ((getOutputMode() != 0) && (basename($_SERVER['PHP_SELF']) != 'ref.php')) return false;
3159 // Check if refid is set
3160 if ((isset($GLOBALS['refid'])) && ($GLOBALS['refid'] > 0)) {
3162 } elseif ((isGetRequestElementSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
3163 // The variable user comes from the click-counter script click.php and we only accept this here
3164 $GLOBALS['refid'] = bigintval(getRequestElement('user'));
3165 } elseif (isPostRequestElementSet('refid')) {
3166 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3167 $GLOBALS['refid'] = secureString(postRequestElement('refid'));
3168 } elseif (isGetRequestElementSet('refid')) {
3169 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3170 $GLOBALS['refid'] = secureString(getRequestElement('refid'));
3171 } elseif (isGetRequestElementSet('ref')) {
3172 // Set refid=ref (the referal link uses such variable)
3173 $GLOBALS['refid'] = secureString(getRequestElement('ref'));
3174 } elseif ((isSessionVariableSet('refid')) && (getSession('refid') != 0)) {
3175 // Set session refid als global
3176 $GLOBALS['refid'] = bigintval(getSession('refid'));
3177 } elseif ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y')) {
3178 // Select a random user which has confirmed enougth mails
3179 $GLOBALS['refid'] = determineRandomReferalId();
3180 } elseif ((isExtensionInstalled('sql_patches')) && (getConfig('def_refid') > 0)) {
3181 // Set default refid as refid in URL
3182 $GLOBALS['refid'] = getConfig('def_refid');
3184 // No default id when sql_patches is not installed or none set
3185 $GLOBALS['refid'] = '0';
3188 // Set cookie when default refid > 0
3189 if (!isSessionVariableSet('refid') || (!empty($GLOBALS['refid'])) || ((getSession('refid') == '0') && (isConfigEntrySet('def_refid')) && (getConfig('def_refid') > 0))) {
3190 // Default is not found
3193 // Do we have nickname or userid set?
3194 if ((isExtensionActive('nickname')) && (isNicknameUsed($GLOBALS['refid']))) {
3195 // Nickname in URL, so load the id
3196 $found = fetchUserData($GLOBALS['refid'], 'nickname');
3197 } elseif ($GLOBALS['refid'] > 0) {
3198 // Direct userid entered
3199 $found = fetchUserData($GLOBALS['refid']);
3202 // Is the record valid?
3203 if ((($found === false) || (!isUserDataValid())) && (isConfigEntrySet('def_refid'))) {
3204 // No, then reset referal id
3205 $GLOBALS['refid'] = getConfig('def_refid');
3209 setSession('refid', $GLOBALS['refid']);
3212 // Return determined refid
3213 return $GLOBALS['refid'];
3216 // Enables the reset mode and runs it
3217 function doReset () {
3218 // Enable the reset mode
3219 $GLOBALS['reset_enabled'] = true;
3222 runFilterChain('reset');
3225 // Our shutdown-function
3226 function shutdown () {
3227 // Call the filter chain 'shutdown'
3228 runFilterChain('shutdown', null);
3230 // Check if not in installation phase and the link is up
3231 if ((!isInstallationPhase()) && (SQL_IS_LINK_UP())) {
3233 SQL_CLOSE(__FILE__, __LINE__);
3234 } elseif (!isInstallationPhase()) {
3236 addFatalMessage(__FILE__, __LINE__, getMessage('NO_DB_LINK_SHUTDOWN'));
3239 // Stop executing here
3244 function initMemberId () {
3245 $GLOBALS['member_id'] = '0';
3248 // Setter for member id
3249 function setMemberId ($memberid) {
3250 // We should not set member id to zero
3251 if ($memberid == '0') debug_report_bug('Userid should not be set zero.');
3254 $GLOBALS['member_id'] = bigintval($memberid);
3257 // Getter for member id or returns zero
3258 function getMemberId () {
3259 // Default member id
3262 // Is the member id set?
3263 if (isMemberIdSet()) {
3265 $memberid = $GLOBALS['member_id'];
3272 // Checks ether the member id is set
3273 function isMemberIdSet () {
3274 return (isset($GLOBALS['member_id']));
3277 // Handle message codes from URL
3278 function handleCodeMessage () {
3279 if (isGetRequestElementSet('code')) {
3280 // Default extension is 'unknown'
3283 // Is extension given?
3284 if (isGetRequestElementSet('ext')) $ext = getRequestElement('ext');
3286 // Convert the 'code' parameter from URL to a human-readable message
3287 $message = getMessageFromErrorCode(getRequestElement('code'));
3289 // Load message template
3290 loadTemplate('message', false, $message);
3294 // Setter for extra title
3295 function setExtraTitle ($extraTitle) {
3296 $GLOBALS['extra_title'] = $extraTitle;
3299 // Getter for extra title
3300 function getExtraTitle () {
3301 // Is the extra title set?
3302 if (!isExtraTitleSet()) {
3303 // No, then abort here
3304 debug_report_bug('extra_title is not set!');
3308 return $GLOBALS['extra_title'];
3311 // Checks if the extra title is set
3312 function isExtraTitleSet () {
3313 return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
3316 // Generates a 'extension foo inactive' message
3317 function generateExtensionInactiveMessage ($ext_name) {
3318 // Is the extension empty?
3319 if (empty($ext_name)) {
3320 // This should not happen
3321 debug_report_bug(__FUNCTION__ . ': Parameter ext is empty. This should not happen.');
3325 $message = getMaskedMessage('EXTENSION_PROBLEM_EXT_INACTIVE', $ext_name);
3327 // Is an admin logged in?
3329 // Then output admin message
3330 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXT_INACTIVE', $ext_name);
3333 // Return prepared message
3337 // Generates a 'extension foo not installed' message
3338 function generateExtensionNotInstalledMessage ($ext_name) {
3339 // Is the extension empty?
3340 if (empty($ext_name)) {
3341 // This should not happen
3342 debug_report_bug(__FUNCTION__ . ': Parameter ext is empty. This should not happen.');
3346 $message = getMaskedMessage('EXTENSION_PROBLEM_EXT_NOT_INSTALLED', $ext_name);
3348 // Is an admin logged in?
3350 // Then output admin message
3351 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXT_NOT_INSTALLED', $ext_name);
3354 // Return prepared message
3358 // Generates a message depending on if the extension is not installed or not
3360 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
3364 // Is the extension not installed or just deactivated?
3365 switch (isExtensionInstalled($ext_name)) {
3366 case true; // Deactivated!
3367 $message = generateExtensionInactiveMessage($ext_name);
3370 case false; // Not installed!
3371 $message = generateExtensionNotInstalledMessage($ext_name);
3374 default: // Should not happen!
3375 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
3376 $message = sprintf("Invalid state of extension %s detected.", $ext_name);
3380 // Return the message
3384 // Reads a directory recursively by default and searches for files not matching
3385 // an exclusion pattern. You can now keep the exclusion pattern empty for reading
3386 // a whole directory.
3387 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $addBaseDir = true, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = true, $suffix = '') {
3388 // Add default entries we should exclude
3389 $excludeArray[] = '.';
3390 $excludeArray[] = '..';
3391 $excludeArray[] = '.svn';
3392 $excludeArray[] = '.htaccess';
3394 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
3399 $dirPointer = opendir(getConfig('PATH') . $baseDir) or app_die(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
3402 while ($baseFile = readdir($dirPointer)) {
3403 // Exclude '.', '..' and entries in $excludeArray automatically
3404 if (in_array($baseFile, $excludeArray, true)) {
3406 //* DEBUG: */ outputHtml('excluded=' . $baseFile . '<br />');
3410 // Construct include filename and FQFN
3411 $fileName = $baseDir . $baseFile;
3412 $FQFN = getConfig('PATH') . $fileName;
3414 // Remove double slashes
3415 $FQFN = str_replace('//', '/', $FQFN);
3417 // Check if the base filenname matches an exclusion pattern and if the pattern is not empty
3418 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
3419 // These Lines are only for debugging!!
3420 //* DEBUG: */ outputHtml('baseDir:' . $baseDir . '<br />');
3421 //* DEBUG: */ outputHtml('baseFile:' . $baseFile . '<br />');
3422 //* DEBUG: */ outputHtml('FQFN:' . $FQFN . '<br />');
3428 // Skip also files with non-matching prefix genericly
3429 if (($recursive === true) && (isDirectory($FQFN))) {
3430 // Is a redirectory so read it as well
3431 $files = merge_array($files, getArrayFromDirectory($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
3433 // And skip further processing
3435 } elseif (substr($baseFile, 0, strlen($prefix)) != $prefix) {
3437 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid prefix in file " . $baseFile . ", prefix=" . $prefix);
3439 } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
3440 // Skip wrong suffix as well
3441 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid suffix in file " . $baseFile . ", suffix=" . $suffix);
3443 } elseif (!isFileReadable($FQFN)) {
3444 // Not readable so skip it
3445 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "File " . $FQFN . " is not readable!");
3449 // Is the file a PHP script or other?
3450 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
3451 if ((substr($baseFile, -4, 4) == '.php') || (($fileIncludeDirs === true) && (isDirectory($FQFN)))) {
3452 // Is this a valid include file?
3453 if ($extension == '.php') {
3454 // Remove both for extension name
3455 $extName = substr($baseFile, strlen($prefix), -4);
3457 // Is the extension valid and active?
3458 if (isExtensionNameValid($extName)) {
3459 // Then add this file
3460 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension entry ' . $baseFile . ' added.');
3461 $files[] = $fileName;
3463 // Add non-extension files as well
3464 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Regular entry ' . $baseFile . ' added.');
3465 if ($addBaseDir === true) {
3466 $files[] = $fileName;
3468 $files[] = $baseFile;
3472 // We found .php file but should not search for them, why?
3473 debug_report_bug('We should find files with extension=' . $extension . ', but we found a PHP script.');
3475 } elseif (substr($baseFile, -4, 4) == $extension) {
3476 // Other, generic file found
3477 $files[] = $fileName;
3482 closedir($dirPointer);
3487 // Return array with include files
3488 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
3492 // Maps a module name into a database table name
3493 function mapModuleToTable ($moduleName) {
3494 // Map only these, still lame code...
3495 switch ($moduleName) {
3496 // 'index' is the guest's menu
3497 case 'index': $moduleName = 'guest'; break;
3498 // ... and 'login' the member's menu
3499 case 'login': $moduleName = 'member'; break;
3500 // Anything else will not be mapped, silently.
3507 // Add SQL debug data to array for later output
3508 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
3509 // Already executed?
3510 if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
3511 // Then abort here, we don't need to profile a query twice
3515 // Remeber this as profiled (or not, but we don't care here)
3516 $GLOBALS['debug_sqls'][$F][$L][$sqlString] = true;
3518 // Do we have cache?
3519 if (!isset($GLOBALS['debug_sql_available'])) {
3520 // Check it and cache it in $GLOBALS
3521 $GLOBALS['debug_sql_available'] = ((isConfigurationLoaded()) && (isExtensionInstalledAndNewer('other', '0.2.2')) && (getConfig('display_debug_sqls') == 'Y'));
3524 // Don't execute anything here if we don't need or ext-other is missing
3525 if ($GLOBALS['debug_sql_available'] === false) {
3531 'num_rows' => SQL_NUMROWS($result),
3532 'affected' => SQL_AFFECTEDROWS(),
3533 'sql_str' => $sqlString,
3534 'timing' => $timing,
3535 'file' => basename($F),
3540 $GLOBALS['debug_sqls'][] = $record;
3543 // Initializes the cache instance
3544 function initCacheInstance () {
3545 // Load include for CacheSystem class
3546 loadIncludeOnce('inc/classes/cachesystem.class.php');
3548 // Initialize cache system only when it's needed
3549 $GLOBALS['cache_instance'] = new CacheSystem();
3550 if ($GLOBALS['cache_instance']->getStatus() != 'done') {
3551 // Failed to initialize cache sustem
3552 addFatalMessage(__FILE__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_CANNOT_INITIALIZE'));
3556 // Getter for message from array or raw message
3557 function getMessageFromIndexedArray ($message, $pos, $array) {
3558 // Check if the requested message was found in array
3559 if (isset($array[$pos])) {
3560 // ... if yes then use it!
3561 $ret = $array[$pos];
3563 // ... else use default message
3571 // Print code with line numbers
3572 function linenumberCode ($code) {
3573 if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
3574 $count_lines = count($codeE);
3576 $r = 'Line | Code:<br />';
3577 foreach($codeE as $line => $c) {
3578 $r .= '<div class="line"><span class="linenum">';
3579 if ($count_lines == 1) {
3582 $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
3587 $r .= '<span class="linetext">' . htmlentities($c) . '</span></div>';
3590 return '<div class="code">' . $r . '</div>';
3593 // Convert ';' to ', ' for e.g. receiver list
3594 function convertReceivers ($old) {
3595 return str_replace(';', ', ', $old);
3598 // Determines the right page title
3599 function determinePageTitle () {
3600 // Config and database connection valid?
3601 if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
3605 // Title decoration enabled?
3606 if ((getConfig('enable_title_deco') == 'Y') && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
3608 // Do we have some extra title?
3609 if (isExtraTitleSet()) {
3611 $TITLE .= getExtraTitle() . ' by ';
3615 $TITLE .= getConfig('MAIN_TITLE');
3617 // Add title of module? (middle decoration will also be added!)
3618 if ((getConfig('enable_mod_title') == 'Y') || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
3619 $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getModuleTitle(getModule());
3622 // Add title from what file
3624 if (getModule() == 'login') $mode = 'member';
3625 elseif (getModule() == 'index') $mode = 'guest';
3626 if ((!empty($mode)) && (getConfig('enable_what_title') == 'Y')) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
3628 // Add title decorations? (right)
3629 if ((getConfig('enable_title_deco') == 'Y') && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
3631 // Remember title in constant for the template
3632 $pageTitle = $TITLE;
3633 } elseif ((isInstalled()) && (isAdminRegistered())) {
3634 // Installed, admin registered but no ext-sql_patches
3635 $pageTitle = '[-- ' . getConfig('MAIN_TITLE') . ' - ' . getModuleTitle(getModule()) . ' --]';
3636 } elseif ((isInstalled()) && (!isAdminRegistered())) {
3637 // Installed but no admin registered
3638 $pageTitle = getMessage('SETUP_OF_MXCHANGE');
3639 } elseif ((!isInstalled()) || (!isAdminRegistered())) {
3640 // Installation mode
3641 $pageTitle = getMessage('INSTALLATION_OF_MXCHANGE');
3643 // Configuration not found!
3644 $pageTitle = getMessage('NO_CONFIG_FOUND_TITLE');
3646 // Do not add the fatal message in installation mode
3647 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FILE__, __LINE__, getMessage('NO_CONFIG_FOUND'));
3651 return decodeEntities($pageTitle);
3654 // Checks wethere there is a cache file there. This function is cached.
3655 function isTemplateCached ($template) {
3656 // Do we have cached this result?
3657 if (!isset($GLOBALS['template_cache'][$template])) {
3659 $FQFN = sprintf("%s_compiled/templates/%s.tpl.cache", getConfig('CACHE_PATH'), $template);
3662 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
3666 return $GLOBALS['template_cache'][$template];
3669 // Flushes non-flushed template cache to disk
3670 function flushTemplateCache ($template, $eval) {
3671 // Is this cache flushed?
3672 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
3674 $FQFN = sprintf("%s_compiled/templates/%s.tpl.cache", getConfig('CACHE_PATH'), $template);
3676 // Replace username with a call
3677 $eval = str_replace('$username', '".getUsername()."', $eval);
3680 writeToFile($FQFN, $eval, true);
3684 // Reads a template cache
3685 function readTemplateCache ($template) {
3687 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template))) {
3689 $FQFN = sprintf("%s_compiled/templates/%s.tpl.cache", getConfig('CACHE_PATH'), $template);
3692 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
3696 return $GLOBALS['template_eval'][$template];
3699 // Escapes quotes (default is only double-quotes)
3700 function escapeQuotes ($str, $single = false) {
3701 // Should we escape all?
3702 if ($single === true) {
3703 // Escape all (including null)
3704 $str = addslashes($str);
3706 // Escape only double-quotes but prevent double-quoting
3707 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
3710 // Return the escaped string
3714 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
3715 function escapeJavaScriptQuotes ($str) {
3716 // Replace all double-quotes and secure back-ticks
3717 $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
3723 // Send out mails depending on the 'mod/modes' combination
3724 // @TODO Lame description for this function
3725 function sendModeMails ($mod, $modes) {
3727 if (fetchUserData(getMemberId())) {
3728 // Extract salt from cookie
3729 $salt = substr(getSession('u_hash'), 0, -40);
3731 // Now let's compare passwords
3732 $hash = generatePassString(getUserData('password'));
3734 // Does the hash match or should we change it?
3735 if (($hash == getSession('u_hash')) || (postRequestElement('pass1') == postRequestElement('pass2'))) {
3737 $content = getUserDataArray();
3740 $content['gender'] = translateGender($content['gender']);
3742 // Clear/init the content variable
3743 $content['message'] = '';
3746 // @TODO Move this in a filter
3749 foreach ($modes as $mode) {
3751 case 'normal': break; // Do not add any special lines
3752 case 'email': // Email was changed!
3753 $content['message'] = getMessage('MEMBER_CHANGED_EMAIL').": ".postRequestElement('old_email')."\n";
3756 case 'pass': // Password was changed
3757 $content['message'] = getMessage('MEMBER_CHANGED_PASS')."\n";
3761 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
3762 $content['message'] = getMessage('MEMBER_UNKNOWN_MODE') . ': ' . $mode . "\n\n";
3767 if (isExtensionActive('country')) {
3768 // Replace code with description
3769 $content['country'] = generateCountryInfo(postRequestElement('country_code'));
3772 // Merge content with data from POST
3773 $content = merge_array($content, postRequestArray());
3776 $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
3778 if (getConfig('admin_notify') == 'Y') {
3779 // The admin needs to be notified about a profile change
3780 $message_admin = 'admin_mydata_notify';
3781 $sub_adm = getMessage('ADMIN_CHANGED_DATA');
3784 $message_admin = '';
3788 // Set subject lines
3789 $sub_mem = getMessage('MEMBER_CHANGED_DATA');
3791 // Output success message
3792 $content = "<span class=\"member_done\">{--MYDATA_MAIL_SENT--}</span>";
3795 default: // Unsupported module!
3796 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
3797 $content = "<span class=\"member_failed\">{--UNKNOWN_MODULE--}</span>";
3801 // Passwords mismatch
3802 $content = "<span class=\"member_failed\">{--MEMBER_PASSWORD_ERROR--}</span>";
3805 // Could not load profile
3806 $content = "<span class=\"member_failed\">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>";
3809 // Send email to user if required
3810 if ((!empty($sub_mem)) && (!empty($message))) {
3812 sendEmail($content['email'], $sub_mem, $message);
3815 // Send only if no other error has occured
3816 if (empty($content)) {
3817 if ((!empty($sub_adm)) && (!empty($message_admin))) {
3819 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
3820 } elseif (getConfig('admin_notify') == 'Y') {
3821 // Cannot send mails to admin!
3822 $content = getMessage('CANNOT_SEND_ADMIN_MAILS');
3825 $content = "<span class=\"member_done\">{--MYDATA_MAIL_SENT--}</span>";
3830 loadTemplate('admin_settings_saved', false, $content);
3833 // Generates a 'selection box' from given array
3834 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent) {
3836 $OUT = '<select name="' . $name . '" size="1" class="admin_select">
3837 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
3839 // Walk through all options
3840 foreach ($options as $option) {
3841 // Add the <option> entry
3842 $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
3845 // Finish selection box
3846 $OUT .= '</select>';
3850 'selection_box' => $OUT,
3851 'module' => getModule(),
3855 // Load template and return it
3856 return loadTemplate('select_' . $name . '_box', true, $content);
3859 // Get a module from filename and access level
3860 function getModuleFromFileName ($file, $accessLevel) {
3861 // Default is 'invalid';
3862 $modCheck = 'invalid';
3864 // @TODO This is still very static, rewrite it somehow
3865 switch ($accessLevel) {
3867 $modCheck = 'admin';
3873 $modCheck = getModule();
3876 default: // Unsupported file name / access level
3877 debug_report_bug('Unsupported file name=' . basename($file) . '/access level=' . $accessLevel);
3885 // Encodes an URL for adding session id, etc.
3886 function encodeUrl ($url, $outputMode = '0') {
3887 // Do we have already have a PHPSESSID inside? Then it is already converted...
3888 if (strpos($url, session_name()) !== false) return $url;
3890 // Do we have a valid session?
3891 if (((!isset($GLOBALS['valid_session'])) || ($GLOBALS['valid_session'] === false) || (!isset($_COOKIE[session_name()]))) && (isSpider() === false)) {
3893 // Determine right seperator
3894 $seperator = '&';
3895 if (strpos($url, '?') === false) {
3898 } elseif ((getOutputMode() != '0') || ($outputMode != '0')) {
3904 if (session_id() != '') {
3905 $url .= $seperator . session_name() . '=' . session_id();
3910 if ((substr($url, 0, strlen(getConfig('URL'))) != getConfig('URL')) && (substr($url, 0, 7) != '{?URL?}') && (substr($url, 0, 7) != 'http://') && (substr($url, 0, 8) != 'https://')) {
3912 $url = '{?URL?}/' . $url;
3919 // Simple check for spider
3920 function isSpider () {
3922 $userAgent = strtolower(detectUserAgent(true));
3924 // It should not be empty, if so it is better a spider/bot
3925 if (empty($userAgent)) return true;
3928 return ((strpos($userAgent, 'spider') !== false) || (strpos($userAgent, 'slurp') !== false) || (strpos($userAgent, 'bot') !== false));
3931 //////////////////////////////////////////////////
3932 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
3933 //////////////////////////////////////////////////
3935 if (!function_exists('html_entity_decode')) {
3936 // Taken from documentation on www.php.net
3937 function html_entity_decode ($string) {
3938 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
3939 $trans_tbl = array_flip($trans_tbl);
3940 return strtr($string, $trans_tbl);
3944 if (!function_exists('http_build_query')) {
3945 // Taken from documentation on www.php.net, credits to Marco K. (Germany)
3946 function http_build_query($data, $prefix = '', $sep = '', $key = '') {
3948 foreach ((array)$data as $k => $v) {
3949 if (is_int($k) && $prefix != null) {
3950 $k = urlencode($prefix . $k);
3953 if ((!empty($key)) || ($key === 0)) $k = $key.'['.urlencode($k).']';
3955 if (is_array($v) || is_object($v)) {
3956 array_push($ret, http_build_query($v, '', $sep, $k));
3958 array_push($ret, $k.'='.urlencode($v));
3962 if (empty($sep)) $sep = ini_get('arg_separator.output');
3964 return implode($sep, $ret);