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 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
46 function outputHtml ($htmlCode, $newLine = true) {
48 if (!isset($GLOBALS['output'])) {
49 $GLOBALS['output'] = '';
53 $username = getMessage('USERNAME_UNKNOWN');
54 if (isset($GLOBALS['username'])) $username = getUsername();
56 // Do we have HTML-Code here?
57 if (!empty($htmlCode)) {
58 // Yes, so we handle it as you have configured
59 switch (getConfig('OUTPUT_MODE')) {
61 // That's why you don't need any \n at the end of your HTML code... :-)
62 if (getPhpCaching() == 'on') {
63 // Output into PHP's internal buffer
64 outputRawCode($htmlCode);
66 // That's why you don't need any \n at the end of your HTML code... :-)
67 if ($newLine === true) print("\n");
69 // Render mode for old or lame servers...
70 $GLOBALS['output'] .= $htmlCode;
72 // That's why you don't need any \n at the end of your HTML code... :-)
73 if ($newLine === true) $GLOBALS['output'] .= "\n";
78 // If we are switching from render to direct output rendered code
79 if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
81 // The same as above... ^
82 outputRawCode($htmlCode);
83 if ($newLine === true) print("\n");
87 // Huh, something goes wrong or maybe you have edited config.php ???
88 debug_report_bug(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--LANG_NO_RENDER_DIRECT--}');
91 } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
92 // Output cached HTML code
93 $GLOBALS['output'] = ob_get_contents();
95 // Clear output buffer for later output if output is found
96 if (!empty($GLOBALS['output'])) {
100 // Send all HTTP headers
103 // Compile and run finished rendered HTML code
104 compileFinalOutput();
106 // Output code here, DO NOT REMOVE! ;-)
107 outputRawCode($GLOBALS['output']);
108 } elseif ((getConfig('OUTPUT_MODE') == 'render') && (!empty($GLOBALS['output']))) {
109 // Send all HTTP headers
112 // Compile and run finished rendered HTML code
113 compileFinalOutput();
115 // Output code here, DO NOT REMOVE! ;-)
116 outputRawCode($GLOBALS['output']);
118 // And flush all headers
123 // Sends out all headers required for HTTP/1.1 reply
124 function sendHttpHeaders () {
126 $now = gmdate('D, d M Y H:i:s') . ' GMT';
129 sendHeader('HTTP/1.1 ' . getHttpStatus());
131 // General headers for no caching
132 sendHeader('Expires: ' . $now); // RFC2616 - Section 14.21
133 sendHeader('Last-Modified: ' . $now);
134 sendHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
135 sendHeader('Pragma: no-cache'); // HTTP/1.0
136 sendHeader('Connection: Close');
137 sendHeader('Content-Type: ' . getContentType() . '; charset=UTF-8');
138 sendHeader('Content-Language: ' . getLanguage());
141 // Compiles the final output
142 function compileFinalOutput () {
146 // Add page header and footer
147 addPageHeaderFooter();
150 while (((strpos($GLOBALS['output'], '{--') !== false) || (strpos($GLOBALS['output'], '{DQUOTE}') !== false) || (strpos($GLOBALS['output'], '{!') !== false) || (strpos($GLOBALS['output'], '{?') !== false) || (strpos($GLOBALS['output'], '{%') !== false)) && ($cnt < 3)) {
151 // Init common variables
156 //* DEBUG: */ print '<pre>'.htmlentities($GLOBALS['output']).'</pre>';
157 $eval = '$newContent = "' . str_replace('{DQUOTE}', '"', compileCode(escapeQuotes($GLOBALS['output']))) . '";';
158 //* DEBUG: */ die('<pre>'.htmlentities($eval).'</pre>');
160 //* DEBUG: */ die('<pre>'.htmlentities($newContent).'</pre>');
162 // Was that eval okay?
163 if (empty($newContent)) {
164 // Something went wrong!
165 debug_report_bug(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
169 $GLOBALS['output'] = $newContent;
175 // Extension 'rewrite' installed?
176 if ((isExtensionActive('rewrite')) && (getOutputMode() != 1)) {
177 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
181 if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
182 // Compress it for HTTP gzip
183 $GLOBALS['output'] = gzencode($GLOBALS['output'], 9, true);
186 sendHeader('Content-Encoding: gzip');
187 } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
188 // Compress it for HTTP deflate
189 $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
192 sendHeader('Content-Encoding: deflate');
196 sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
202 // Output the raw HTML code
203 function outputRawCode ($htmlCode) {
204 // Output stripped HTML code to avoid broken JavaScript code, etc.
205 print(str_replace('{BACK}', "\\", $htmlCode));
207 // Flush the output if only getPhpCaching() is not 'on'
208 if (getPhpCaching() != 'on') {
214 // Init fatal message array
215 function initFatalMessages () {
216 $GLOBALS['fatal_messages'] = array();
219 // Getter for whole fatal error messages
220 function getFatalArray () {
221 return $GLOBALS['fatal_messages'];
224 // Add a fatal error message to the queue array
225 function addFatalMessage ($F, $L, $message, $extra = '') {
226 if (is_array($extra)) {
227 // Multiple extras for a message with masks
228 $message = call_user_func_array('sprintf', $extra);
229 } elseif (!empty($extra)) {
230 // $message is text with a mask plus extras to insert into the text
231 $message = sprintf($message, $extra);
234 // Add message to $GLOBALS['fatal_messages']
235 $GLOBALS['fatal_messages'][] = $message;
237 // Log fatal messages away
238 logDebugMessage($F, $L, 'Fatal error message: ' . $message);
241 // Getter for total fatal message count
242 function getTotalFatalErrors () {
246 // Do we have at least the first entry?
247 if (!empty($GLOBALS['fatal_messages'][0])) {
249 $count = count($GLOBALS['fatal_messages']);
256 // Load a template file and return it's content (only it's name; do not use ' or ")
257 function loadTemplate ($template, $return = false, $content = array()) {
258 // @TODO Remove this sanity-check if all is fine
259 if (!is_bool($return)) debug_report_bug(__FUNCTION__, __LINE__, 'return is not bool (' . gettype($return) . ')');
261 // @TODO Try to rewrite all $DATA to $content
265 if (isTemplateCached($template)) {
266 // Evaluate the cache
267 eval(readTemplateCache($template));
268 } elseif (!isset($GLOBALS['template_eval'][$template])) {
269 // Add more variables which you want to use in your template files
270 $username = getUsername();
272 // Make all template names lowercase
273 $template = strtolower($template);
277 if (empty($GLOBALS['refid'])) $GLOBALS['refid'] = '0';
280 $basePath = sprintf("%stemplates/%s/html/", getConfig('PATH'), getLanguage());
281 $extraPath = detectExtraTemplatePath($template);;
283 ////////////////////////
284 // Generate file name //
285 ////////////////////////
286 $FQFN = $basePath . $extraPath . $template . '.tpl';
288 // Does the special template exists?
289 if (!isFileReadable($FQFN)) {
290 // Reset to default template
291 $FQFN = $basePath . $template . '.tpl';
294 // Now does the final template exists?
295 if (isFileReadable($FQFN)) {
296 // Count the template load
297 incrementConfigEntry('num_templates');
299 // The local file does exists so we load it. :)
300 $GLOBALS['tpl_content'] = readFromFile($FQFN);
302 // Do we have to compile the code?
304 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)) {
305 // Normal HTML output?
306 if (getOutputMode() == '0') {
307 // Add surrounding HTML comments to help finding bugs faster
308 $ret = '<!-- Template ' . $template . " - Start -->\n" . $GLOBALS['tpl_content'] . '<!-- Template ' . $template . " - End -->\n";
310 // Prepare eval() command
311 $eval = '$ret = "' . compileCode(escapeQuotes($ret)) . '";';
312 } elseif (substr($template, 0, 3) == 'js_') {
313 // JavaScripts don't like entities and timings
314 $eval = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'])) . '");';
316 // Prepare eval() command, other output doesn't like entities, maybe
317 $eval = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'])) . '");';
320 // Add surrounding HTML comments to help finding bugs faster
321 $ret = '<!-- Template ' . $template . " - Start -->\n" . $GLOBALS['tpl_content'] . '<!-- Template ' . $template . " - End -->\n";
322 $eval = '$ret = "' . compileRawCode(escapeQuotes($ret)) . '";';
325 // Cache the eval() command here
326 $GLOBALS['template_eval'][$template] = $eval;
327 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
328 // Only admins shall see this warning or when installation mode is active
329 $ret = '<br /><span class="guest_failed">{--TEMPLATE_404--}</span><br />
330 (' . $template . ')<br />
332 {--TEMPLATE_CONTENT--}
333 <pre>' . print_r($content, true) . '</pre>
335 <pre>' . print_r($DATA, true) . '</pre>
339 $GLOBALS['template_eval'][$template] = '404';
344 if ((isset($GLOBALS['template_eval'][$template])) && ($GLOBALS['template_eval'][$template] != '404')) {
346 eval($GLOBALS['template_eval'][$template]);
349 // Do we have some content to output or return?
351 // Not empty so let's put it out! ;)
352 if ($return === true) {
353 // Return the HTML code
359 } elseif (isDebugModeEnabled()) {
360 // Warning, empty output!
361 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
365 // Detects the extra template path from given template name
366 function detectExtraTemplatePath ($template) {
371 if (!isset($GLOBALS['extra_path'][$template])) {
372 // Check for admin/guest/member/etc. templates
373 if (substr($template, 0, 6) == 'admin_') {
374 // Admin template found
375 $extraPath = 'admin/';
376 } elseif (substr($template, 0, 6) == 'guest_') {
377 // Guest template found
378 $extraPath = 'guest/';
379 } elseif (substr($template, 0, 7) == 'member_') {
380 // Member template found
381 $extraPath = 'member/';
382 } elseif (substr($template, 0, 7) == 'select_') {
383 // Selection template found
384 $extraPath = 'select/';
385 } elseif (substr($template, 0, 8) == 'install_') {
386 // Installation template found
387 $extraPath = 'install/';
388 } elseif (substr($template, 0, 4) == 'ext_') {
389 // Extension template found
391 } elseif (substr($template, 0, 3) == 'la_') {
392 // 'Logical-area' template found
394 } elseif (substr($template, 0, 3) == 'js_') {
395 // JavaScript template found
397 } elseif (substr($template, 0, 5) == 'menu_') {
398 // Menu template found
399 $extraPath = 'menu/';
401 // Test for extension
402 $test = substr($template, 0, strpos($template, '_'));
404 // Probe for valid extension name
405 if (isExtensionNameValid($test)) {
406 // Set extra path to extension's name
407 $extraPath = $test . '/';
412 $GLOBALS['extra_path'][$template] = $extraPath;
416 return $GLOBALS['extra_path'][$template];
419 // Loads an email template and compiles it
420 function loadEmailTemplate ($template, $content = array(), $userid = '0') {
423 // Make sure all template names are lowercase!
424 $template = strtolower($template);
426 // Default 'nickname' if extension is not installed
429 // Neutral email address is default
430 $email = getConfig('WEBMASTER');
432 // Is content an array?
433 if (is_array($content)) {
434 // Add expiration to array
435 if ((isConfigEntrySet('auto_purge')) && (getConfig('auto_purge') == '0')) {
436 // Will never expire!
437 $content['expiration'] = getMessage('MAIL_WILL_NEVER_EXPIRE');
438 } elseif (isConfigEntrySet('auto_purge')) {
439 // Create nice date string
440 $content['expiration'] = createFancyTime(getConfig('auto_purge'));
443 $content['expiration'] = getMessage('MAIL_NO_CONFIG_AUTO_PURGE');
448 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content).'<br />');
449 if (($userid > 0) && (is_array($content))) {
450 // If nickname extension is installed, fetch nickname as well
451 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
452 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME!<br />");
454 fetchUserData($userid, 'nickname');
456 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK!<br />");
458 fetchUserData($userid);
461 // Merge data if valid
462 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
463 if (isUserDataValid()) {
464 $content = merge_array($content, getUserDataArray());
466 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
469 // Translate M to male or F to female if present
470 if (isset($content['gender'])) $content['gender'] = translateGender($content['gender']);
472 // Overwrite email from data if present
473 if (isset($content['email'])) $email = $content['email'];
475 // Store email for some functions in global $DATA array
476 // @TODO Do only use $content, not $DATA or raw variables
477 $DATA['email'] = $email;
480 $basePath = sprintf("%stemplates/%s/emails/", getConfig('PATH'), getLanguage());
483 $extraPath = detectExtraTemplatePath($template);
485 // Generate full FQFN
486 $FQFN = $basePath . $extraPath . $template . '.tpl';
488 // Does the special template exists?
489 if (!isFileReadable($FQFN)) {
490 // Reset to default template
491 $FQFN = $basePath . $template . '.tpl';
494 // Now does the final template exists?
496 if (isFileReadable($FQFN)) {
497 // The local file does exists so we load it. :)
498 $GLOBALS['tpl_content'] = readFromFile($FQFN);
501 $GLOBALS['tpl_content'] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'])) . '");';
502 eval($GLOBALS['tpl_content']);
503 } elseif (!empty($template)) {
504 // Template file not found!
505 $newContent = '{--TEMPLATE_404--}: ' . $template . '<br />
506 {--TEMPLATE_CONTENT--}
507 <pre>' . print_r($content, true) . '</pre>
509 <pre>' . print_r($DATA, true) . '</pre>
512 // Debug mode not active? Then remove the HTML tags
513 if (!isDebugModeEnabled()) $newContent = secureString($newContent);
515 // No template name supplied!
516 $newContent = getMessage('NO_TEMPLATE_SUPPLIED');
519 // Is there some content?
520 if (empty($newContent)) {
522 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'];
524 // Add last error if the required function exists
525 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
528 // Remove content and data
536 // Send mail out to an email address
537 function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '') {
538 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "TO={$toEmail},SUBJECT={$subject}<br />");
540 // Compile subject line (for POINTS constant etc.)
541 eval('$subject = decodeEntities("' . compileRawCode(escapeQuotes($subject)) . '");');
544 if ((!isInStringIgnoreCase('@', $toEmail)) && ($toEmail > 0)) {
545 // Value detected, is the message extension installed?
546 // @TODO Extension 'msg' does not exist
547 if (isExtensionActive('msg')) {
548 ADD_MESSAGE_TO_BOX($toEmail, $subject, $message, $isHtml);
551 // Does the user exist?
552 if (fetchUserData($toEmail)) {
554 $toEmail = getUserData('email');
557 $toEmail = getConfig('WEBMASTER');
560 } elseif ($toEmail == '0') {
562 $toEmail = getConfig('WEBMASTER');
564 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "TO={$toEmail}<br />");
566 // Check for PHPMailer or debug-mode
567 if (!checkPhpMailerUsage()) {
568 // Not in PHPMailer-Mode
569 if (empty($mailHeader)) {
570 // Load email header template
571 $mailHeader = loadEmailTemplate('header');
574 $mailHeader .= loadEmailTemplate('header');
576 } elseif (isDebugModeEnabled()) {
577 if (empty($mailHeader)) {
578 // Load email header template
579 $mailHeader = loadEmailTemplate('header');
582 $mailHeader .= loadEmailTemplate('header');
587 eval('$toEmail = "' . compileRawCode(escapeQuotes($toEmail)) . '";');
590 eval('$message = "' . str_replace('$', '$', compileRawCode(escapeQuotes($message))) . '";');
592 // Fix HTML parameter (default is no!)
593 if (empty($isHtml)) $isHtml = 'N';
594 if (isDebugModeEnabled()) {
595 // In debug mode we want to display the mail instead of sending it away so we can debug this part
597 Headers : ' . htmlentities(utf8_decode(trim($mailHeader))) . '
598 To : ' . htmlentities(utf8_decode($toEmail)) . '
599 Subject : ' . htmlentities(utf8_decode($subject)) . '
600 Message : ' . htmlentities(utf8_decode($message)) . '
602 } elseif (($isHtml == 'Y') && (isExtensionActive('html_mail'))) {
603 // Send mail as HTML away
604 return sendHtmlEmail($toEmail, $subject, $message, $mailHeader);
605 } elseif (!empty($toEmail)) {
607 return sendRawEmail($toEmail, $subject, $message, $mailHeader);
608 } elseif ($isHtml != 'Y') {
610 return sendRawEmail(getConfig('WEBMASTER'), '[PROBLEM:]' . $subject, $message, $mailHeader);
614 // Check to use wether legacy mail() command or PHPMailer class
615 // @TODO Rewrite this to an extension 'smtp'
617 function checkPhpMailerUsage() {
618 return ((getConfig('SMTP_HOSTNAME') != '') && (getConfig('SMTP_USER') != ''));
621 // Send out a raw email with PHPMailer class or legacy mail() command
622 function sendRawEmail ($toEmail, $subject, $message, $from) {
623 // Just compile all again, to put out all configs, etc.
624 eval('$toEmail = decodeEntities("' . compileRawCode(escapeQuotes($toEmail)) . '");');
625 eval('$subject = decodeEntities("' . compileRawCode(escapeQuotes($subject)) . '");');
626 eval('$message = decodeEntities("' . compileRawCode(escapeQuotes($message)) . '");');
627 eval('$from = decodeEntities("' . compileRawCode(escapeQuotes($from)) . '");');
629 // Shall we use PHPMailer class or legacy mode?
630 if (checkPhpMailerUsage()) {
631 // Use PHPMailer class with SMTP enabled
632 loadIncludeOnce('inc/phpmailer/class.phpmailer.php');
633 loadIncludeOnce('inc/phpmailer/class.smtp.php');
636 $mail = new PHPMailer();
638 // Set charset to UTF-8
639 $mail->CharSet = 'UTF-8';
641 // Path for PHPMailer
642 $mail->PluginDir = sprintf("%sinc/phpmailer/", getConfig('PATH'));
645 $mail->SMTPAuth = true;
646 $mail->Host = getConfig('SMTP_HOSTNAME');
648 $mail->Username = getConfig('SMTP_USER');
649 $mail->Password = getConfig('SMTP_PASSWORD');
651 $mail->From = getConfig('WEBMASTER');
655 $mail->FromName = getConfig('MAIN_TITLE');
656 $mail->Subject = $subject;
657 if ((isExtensionActive('html_mail')) && (secureString($message) != $message)) {
658 $mail->Body = $message;
659 $mail->AltBody = 'Your mail program required HTML support to read this mail!';
660 $mail->WordWrap = 70;
663 $mail->Body = decodeEntities($message);
665 $mail->AddAddress($toEmail, '');
666 $mail->AddReplyTo(getConfig('WEBMASTER'), getConfig('MAIN_TITLE'));
667 $mail->AddCustomHeader('Errors-To:' . getConfig('WEBMASTER'));
668 $mail->AddCustomHeader('X-Loop:' . getConfig('WEBMASTER'));
671 // Has an error occured?
672 if (!empty($mail->ErrorInfo)) {
674 logDebugMessage(__FUNCTION__, __LINE__, 'Error while sending mail: ' . $mail->ErrorInfo);
683 // Use legacy mail() command
684 return mail($toEmail, $subject, decodeEntities($message), $from);
688 // Generate a password in a specified length or use default password length
689 function generatePassword ($length = '0') {
690 // Auto-fix invalid length of zero
691 if ($length == '0') $length = getConfig('pass_len');
693 // Initialize array with all allowed chars
694 $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,-,+,_,/,.');
696 // Start creating password
698 for ($i = '0'; $i < $length; $i++) {
699 $PASS .= $ABC[mt_rand(0, count($ABC) -1)];
702 // When the size is below 40 we can also add additional security by scrambling
703 // it. Otherwise we may corrupt hashes
704 if (strlen($PASS) <= 40) {
705 // Also scramble the password
706 $PASS = scrambleString($PASS);
709 // Return the password
713 // Generates a human-readable timestamp from the Uni* stamp
714 function generateDateTime ($time, $mode = '0') {
715 // Filter out numbers
716 $time = bigintval($time);
718 // If the stamp is zero it mostly didn't "happen"
721 return getMessage('NEVER_HAPPENED');
724 switch (getLanguage()) {
725 case 'de': // German date / time format
727 case '0': $ret = date("d.m.Y \u\m H:i \U\h\\r", $time); break;
728 case '1': $ret = strtolower(date('d.m.Y - H:i', $time)); break;
729 case '2': $ret = date('d.m.Y|H:i', $time); break;
730 case '3': $ret = date('d.m.Y', $time); break;
732 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
737 default: // Default is the US date / time format!
739 case '0': $ret = date('r', $time); break;
740 case '1': $ret = date('Y-m-d - g:i A', $time); break;
741 case '2': $ret = date('y-m-d|H:i', $time); break;
742 case '3': $ret = date('y-m-d', $time); break;
744 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
753 // Translates Y/N to yes/no
754 function translateYesNo ($yn) {
756 $translated = '??? (' . $yn . ')';
758 case 'Y': $translated = getMessage('YES'); break;
759 case 'N': $translated = getMessage('NO'); break;
762 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected Y/N!", $yn));
770 // Translates the "pool type" into human-readable
771 function translatePoolType ($type) {
772 // Default?type is unknown
773 $translated = getMaskedMessage('POOL_TYPE_UNKNOWN', $type);
776 $constName = sprintf("POOL_TYPE_%s", $type);
779 if (isMessageIdValid($constName)) {
781 $translated = getMessage($constName);
784 // Return "translation"
788 // Translates the american decimal dot into a german comma
789 function translateComma ($dotted, $cut = true, $max = '0') {
790 // First, cast all to double, due to PHP changes
791 $dotted = (double) $dotted;
793 // Default is 3 you can change this in admin area "Misc -> Misc Options"
794 if (!isConfigEntrySet('max_comma')) setConfigEntry('max_comma', 3);
796 // Use from config is default
797 $maxComma = getConfig('max_comma');
799 // Use from parameter?
800 if ($max > 0) $maxComma = $max;
803 if (($cut === true) && ($max == '0')) {
804 // Test for commata if in cut-mode
805 $com = explode('.', $dotted);
806 if (count($com) < 2) {
807 // Don't display commatas even if there are none... ;-)
813 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "dotted={$dotted},maxComma={$maxComma}");
816 switch (getLanguage()) {
817 case 'de': // German language
818 $dotted = number_format($dotted, $maxComma, ',', '.');
821 default: // All others
822 $dotted = number_format($dotted, $maxComma, '.', ',');
826 // Return translated value
830 // Translate Uni*-like gender to human-readable
831 function translateGender ($gender) {
833 $ret = '!' . $gender . '!';
835 // Male/female or company?
837 case 'M': $ret = getMessage('GENDER_M'); break;
838 case 'F': $ret = getMessage('GENDER_F'); break;
839 case 'C': $ret = getMessage('GENDER_C'); break;
841 // Please report bugs on unknown genders
842 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
846 // Return translated gender
850 // "Translates" the user status
851 function translateUserStatus ($status) {
852 // Generate message depending on status
857 $ret = getMessage(sprintf("ACCOUNT_%s", $status));
862 $ret = getMessage('ACCOUNT_DELETED');
866 // Please report all unknown status
867 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
875 // "Translates" 'visible' and 'locked' to a CSS class
876 function translateMenuVisibleLocked ($content, $prefix = '') {
877 // Translate 'visible' and keep an eye on the prefix
878 switch ($content[$prefix . 'visible']) {
880 case 'Y': $content[$prefix . 'visible_css'] = $prefix . 'menu_visible' ; break;
881 case 'N': $content[$prefix . 'visible_css'] = $prefix . 'menu_invisible'; break;
883 // Please report this
884 debug_report_bug('Unsupported visible value detected. content=<pre>'.print_r($content, true).'</pre>');
888 // Translate 'locked' and keep an eye on the prefix
889 switch ($content[$prefix . 'locked']) {
891 case 'Y': $content[$prefix . 'locked_css'] = $prefix . 'menu_locked' ; break;
892 case 'N': $content[$prefix . 'locked_css'] = $prefix . 'menu_unlocked'; break;
894 // Please report this
895 debug_report_bug('Unsupported locked value detected. content=<pre>'.print_r($content, true).'</pre>');
899 // Return the resulting array
903 // Generates an URL for the dereferer
904 function generateDerefererUrl ($URL) {
905 // Don't de-refer our own links!
906 if (substr($URL, 0, strlen(getConfig('URL'))) != getConfig('URL')) {
907 // De-refer this link
908 $URL = '{%url=modules.php?module=loader&url=' . encodeString(compileUriCode($URL)) . '%}';
915 // Generates an URL for the frametester
916 function generateFrametesterUrl ($URL) {
917 // Prepare frametester URL
918 $frametesterUrl = sprintf("{%%url=modules.php?module=frametester&url=%s%%}",
919 encodeString(compileUriCode($URL))
922 // Return the new URL
923 return $frametesterUrl;
926 // Count entries from e.g. a selection box
927 function countSelection ($array) {
929 if (!is_array($array)) {
931 debug_report_bug(__FUNCTION__.': No array provided.');
938 foreach ($array as $key => $selected) {
940 if (!empty($selected)) $ret++;
943 // Return counted selections
947 // Generate XHTML code for the CAPTCHA
948 function generateCaptchaCode ($code, $type, $DATA, $userid) {
949 return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&' . $type . '=' . $DATA . '&mode=img&code=' . $code . '%}" />';
952 // Generates a timestamp (some wrapper for mktime())
953 function makeTime ($hours, $minutes, $seconds, $stamp) {
954 // Extract day, month and year from given timestamp
955 $days = date('d', $stamp);
956 $months = date('m', $stamp);
957 $years = date('Y', $stamp);
959 // Create timestamp for wished time which depends on extracted date
970 // Redirects to an URL and if neccessarry extends it with own base URL
971 function redirectToUrl ($URL, $allowSpider = true) {
973 eval('$URL = "' . compileRawCode(encodeUrl($URL)) . '";');
975 // Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
976 $rel = ' rel="external"';
978 // Do we have internal or external URL?
979 if (substr($URL, 0, strlen(getConfig('URL'))) == getConfig('URL')) {
980 // Own (=internal) URL
984 // Three different ways to debug...
985 //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s[%s:] URL=%s", __FUNCTION__, __LINE__, $URL));
986 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $URL);
987 //* DEBUG: */ die($URL);
989 // Simple probe for bots/spiders from search engines
990 if ((isSpider()) && ($allowSpider === true)) {
991 // Secure the URL against bad things such als HTML insertions and so on...
992 $URL = secureString($URL);
994 // Set content-type here to fix a missing array element
995 setContentType('text/html');
997 // Output new location link as anchor
998 outputHtml('<a href="' . $URL . '"' . $rel . '>' . $URL . '</a>');
999 } elseif (!headers_sent()) {
1000 // Clear own output buffer
1001 $GLOBALS['output'] = '';
1003 // Load URL when headers are not sent
1004 sendHeader('Location: '.str_replace('&', '&', $URL));
1006 // Output error message
1007 loadInclude('inc/header.php');
1008 loadTemplate('redirect_url', false, str_replace('&', '&', $URL));
1009 loadInclude('inc/footer.php');
1012 // Shut the mailer down here
1016 // Wrapper for redirectToUrl but URL comes from a configuration entry
1017 function redirectToConfiguredUrl ($configEntry) {
1019 $URL = getConfig($configEntry);
1022 if (is_null($URL)) {
1024 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Configuration entry %s is not set!", $configEntry));
1028 redirectToUrl($URL);
1031 // Compiles the given HTML/mail code
1032 function compileCode ($code, $simple = false, $constants = true, $full = true) {
1033 // Is the code a string?
1034 if (!is_string($code)) {
1035 // Silently return it
1040 $startCompile = microtime(true);
1043 $code = compileRawCode($code, $simple, $constants, $full);
1046 $compiled = microtime(true);
1049 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
1051 // Return compiled code
1055 // Compiles the code (use compileCode() only for HTML because of the comments)
1056 // @TODO $simple is deprecated
1057 function compileRawCode ($code, $simple = false, $constants = true, $full = true) {
1058 // Is the code a string?
1059 if (!is_string($code)) {
1060 // Silently return it
1064 // Init replacement-array with smaller set of security characters
1065 $secChars = $GLOBALS['url_chars'];
1067 // Select full set of chars to replace when we e.g. want to compile URLs
1068 if ($full === true) $secChars = $GLOBALS['security_chars'];
1070 // Compile more through a filter
1071 $code = runFilterChain('compile_code', $code);
1073 // Compile constants
1074 if ($constants === true) {
1075 // BEFORE 0.2.1 : Language and data constants
1076 // WITH 0.2.1+ : Only language constants
1077 $code = str_replace('{--', "\" . getMessage('", str_replace('--}', "') . \"", $code));
1079 // BEFORE 0.2.1 : Not used
1080 // WITH 0.2.1+ : Data constants
1081 $code = str_replace('{!', "\" . constant('", str_replace('!}', "') . \"", $code));
1084 // Compile QUOT and other non-HTML codes
1085 foreach ($secChars['to'] as $k => $to) {
1086 // Do the reversed thing as in inc/libs/security_functions.php
1087 $code = str_replace($to, $secChars['from'][$k], $code);
1090 // Find $content[bla][blub] entries
1091 // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
1092 preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
1094 // Are some matches found?
1095 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
1096 // Replace all matches
1097 $matchesFound = array();
1098 foreach ($matches[0] as $key => $match) {
1099 // Fuzzy look has failed by default
1100 $fuzzyFound = false;
1102 // Fuzzy look on match if already found
1103 foreach ($matchesFound as $found => $set) {
1105 $test = substr($found, 0, strlen($match));
1107 // Does this entry exist?
1108 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
1109 if ($test == $match) {
1111 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
1118 if ($fuzzyFound === true) continue;
1120 // Take all string elements
1121 if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key."_" . $matches[4][$key]]))) {
1122 // Replace it in the code
1123 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
1124 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
1125 $code = str_replace($match, '".' . $newMatch . '."', $code);
1126 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
1127 $matchesFound[$match] = 1;
1128 } elseif (!isset($matchesFound[$match])) {
1129 // Not yet replaced!
1130 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
1131 $code = str_replace($match, '".' . $match . '."', $code);
1132 $matchesFound[$match] = 1;
1141 /************************************************************************
1143 * Gaenderter Sortier-Algorythmus, $array wird nach dem Array (!) *
1144 * $a_sort sortiert: *
1146 * $array - Das 3-dimensionale Array, das paralell sortiert werden soll *
1147 * $a_sort - Array, das die Sortiereihenfolge der ersten Elementeben *
1148 * $primary_key - Prim.rschl.ssel aus $a_sort, nach dem sortiert wird *
1149 * $order - Sortiereihenfolge: -1 = a-Z, 0 = keine, 1 = Z-a *
1150 * $nums - true = Als Zahlen sortieren, false = Als Zeichen sortieren *
1152 * $a_sort muss Elemente enthalten, deren Wert Schluessel von $array *
1153 * sind... Klingt kompliziert, suchen Sie mal mein Beispiel, dann sehen *
1154 * Sie, dass es doch nicht so schwer ist! :-) *
1156 ************************************************************************/
1157 function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums = false) {
1159 while ($primary_key < count($a_sort)) {
1160 foreach ($dummy[$a_sort[$primary_key]] as $key => $value) {
1161 foreach ($dummy[$a_sort[$primary_key]] as $key2 => $value2) {
1163 if ($nums === false) {
1164 // Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
1165 if (($key != $key2) && (strcmp(strtolower($dummy[$a_sort[$primary_key]][$key]), strtolower($dummy[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
1166 } elseif ($key != $key2) {
1167 // Sort numbers (E.g.: 9 < 10)
1168 if (($dummy[$a_sort[$primary_key]][$key] < $dummy[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
1169 if (($dummy[$a_sort[$primary_key]][$key] > $dummy[$a_sort[$primary_key]][$key2]) && ($order == 1)) $match = true;
1173 // We have found two different values, so let's sort whole array
1174 foreach ($dummy as $sort_key => $sort_val) {
1175 $t = $dummy[$sort_key][$key];
1176 $dummy[$sort_key][$key] = $dummy[$sort_key][$key2];
1177 $dummy[$sort_key][$key2] = $t;
1188 // Write back sorted array
1193 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'register_select') {
1196 if ($type == 'yn') {
1197 // This is a yes/no selection only!
1198 if ($id > 0) $prefix .= '[' . $id . ']';
1199 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
1201 // Begin with regular selection box here
1202 if (!empty($prefix)) $prefix .= "_";
1204 if ($id > 0) $type2 .= '[' . $id . ']';
1205 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
1210 for ($idx = 1; $idx < 32; $idx++) {
1211 $OUT .= '<option value="' . $idx . '"';
1212 if ($default == $idx) $OUT .= ' selected="selected"';
1213 $OUT .= '>' . $idx . '</option>';
1217 case 'month': // Month
1218 foreach ($GLOBALS['month_descr'] as $idx => $descr) {
1219 $OUT .= '<option value="' . $idx . '"';
1220 if ($default == $idx) $OUT .= ' selected="selected"';
1221 $OUT .= '>' . $descr . '</option>';
1225 case 'year': // Year
1227 $year = date('Y', time());
1229 // Use configured min age or fixed?
1230 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
1232 $startYear = $year - getConfig('min_age');
1235 $startYear = $year - 16;
1238 // Calculate earliest year (100 years old people can still enter Internet???)
1239 $minYear = $year - 100;
1241 // Check if the default value is larger than minimum and bigger than actual year
1242 if (($default > $minYear) && ($default >= $year)) {
1243 for ($idx = $year; $idx < ($year + 11); $idx++) {
1244 $OUT .= '<option value="' . $idx . '"';
1245 if ($default == $idx) $OUT .= ' selected="selected"';
1246 $OUT .= '>' . $idx . '</option>';
1248 } elseif ($default == -1) {
1249 // Current year minus 1
1250 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
1251 $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
1254 // Get current year and subtract the configured minimum age
1255 $OUT .= '<option value="' . ($minYear - 1) . '"><' . $minYear . '</option>';
1256 // Calculate earliest year depending on extension version
1257 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
1258 // Use configured minimum age
1259 $year = date('Y', time()) - getConfig('min_age');
1261 // Use fixed 16 years age
1262 $year = date('Y', time()) - 16;
1265 // Construct year selection list
1266 for ($idx = $minYear; $idx <= $year; $idx++) {
1267 $OUT .= '<option value="' . $idx . '"';
1268 if ($default == $idx) $OUT .= ' selected="selected"';
1269 $OUT .= '>' . $idx . '</option>';
1276 for ($idx = 0; $idx < 60; $idx+=5) {
1277 if (strlen($idx) == 1) $idx = '0' . $idx;
1278 $OUT .= '<option value="' . $idx . '"';
1279 if ($default == $idx) $OUT .= ' selected="selected"';
1280 $OUT .= '>' . $idx . '</option>';
1285 for ($idx = 0; $idx < 24; $idx++) {
1286 if (strlen($idx) == 1) $idx = '0' . $idx;
1287 $OUT .= '<option value="' . $idx . '"';
1288 if ($default == $idx) $OUT .= ' selected="selected"';
1289 $OUT .= '>' . $idx . '</option>';
1294 $OUT .= '<option value="Y"';
1295 if ($default == 'Y') $OUT .= ' selected="selected"';
1296 $OUT .= '>{--YES--}</option><option value="N"';
1297 if ($default != 'Y') $OUT .= ' selected="selected"';
1298 $OUT .= '>{--NO--}</option>';
1301 $OUT .= '</select>';
1306 // Deprecated : $length
1309 function generateRandomCode ($length, $code, $userid, $DATA = '') {
1310 // Build server string
1311 $server = $_SERVER['PHP_SELF'] . getConfig('ENCRYPT_SEPERATOR') . detectUserAgent() . getConfig('ENCRYPT_SEPERATOR') . getenv('SERVER_SOFTWARE') . getConfig('ENCRYPT_SEPERATOR') . detectRemoteAddr();
1314 $keys = getConfig('SITE_KEY') . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY');
1315 if (isConfigEntrySet('secret_key')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('secret_key');
1316 if (isConfigEntrySet('file_hash')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('file_hash');
1317 $keys .= getConfig('ENCRYPT_SEPERATOR') . date('d-m-Y (l-F-T)', getConfig('patch_ctime'));
1318 if (isConfigEntrySet('master_salt')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('master_salt');
1320 // Build string from misc data
1321 $data = $code . getConfig('ENCRYPT_SEPERATOR') . $userid . getConfig('ENCRYPT_SEPERATOR') . $DATA;
1323 // Add more additional data
1324 if (isSessionVariableSet('u_hash')) $data .= getConfig('ENCRYPT_SEPERATOR') . getSession('u_hash');
1326 // Add referal id, language, theme and userid
1327 $data .= getConfig('ENCRYPT_SEPERATOR') . determineReferalId();
1328 $data .= getConfig('ENCRYPT_SEPERATOR') . getLanguage();
1329 $data .= getConfig('ENCRYPT_SEPERATOR') . getCurrentTheme();
1330 $data .= getConfig('ENCRYPT_SEPERATOR') . getMemberId();
1332 // Calculate number for generating the code
1333 $a = $code + getConfig('_ADD') - 1;
1335 if (isConfigEntrySet('master_salt')) {
1336 // Generate hash with master salt from modula of number with the prime number and other data
1337 $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'));
1339 // Create number from hash
1340 $rcode = hexdec(substr($saltedHash, strlen(getConfig('master_salt')), 9)) / abs(getConfig('rand_no') - $a + sqrt(getConfig('_ADD'))) / pi();
1342 // Generate hash with "hash of site key" from modula of number with the prime number and other data
1343 $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')));
1345 // Create number from hash
1346 $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(getConfig('rand_no') - $a + sqrt(getConfig('_ADD'))) / pi();
1349 // At least 10 numbers shall be secure enought!
1350 $len = getConfig('code_length');
1351 if ($len == '0') $len = $length;
1352 if ($len == '0') $len = 10;
1354 // Cut off requested counts of number
1355 $return = substr(str_replace('.', '', $rcode), 0, $len);
1357 // Done building code
1361 // Does only allow numbers
1362 function bigintval ($num, $castValue = true, $abortOnMismatch = true) {
1363 // Filter all numbers out
1364 $ret = preg_replace('/[^0123456789]/', '', $num);
1367 if ($castValue === true) $ret = (double)$ret;
1369 // Has the whole value changed?
1370 if (('' . $ret . '' != '' . $num . '') && ($abortOnMismatch === true)) {
1372 debug_report_bug(__FUNCTION__, __LINE__, 'Problem with number found. ret=' . $ret . ', num='. $num);
1379 // Insert the code in $img_code into jpeg or PNG image
1380 function generateImageOrCode ($img_code, $headerSent = true) {
1381 // Is the code size oversized or shouldn't we display it?
1382 if ((strlen($img_code) > 6) || (empty($img_code)) || (getConfig('code_length') == '0')) {
1383 // Stop execution of function here because of over-sized code length
1384 debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getConfig('code_length'));
1385 } elseif ($headerSent === false) {
1386 // Return an HTML code here
1387 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
1391 $img = sprintf("%s/theme/%s/images/code_bg.%s",
1394 getConfig('img_type')
1398 if (isFileReadable($img)) {
1399 // Switch image type
1400 switch (getConfig('img_type')) {
1402 // Okay, load image and hide all errors
1403 $image = imagecreatefromjpeg($img);
1407 // Okay, load image and hide all errors
1408 $image = imagecreatefrompng($img);
1412 // Exit function here
1413 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
1417 // Generate text color (red/green/blue; 0 = dark, 255 = bright)
1418 $text_color = imagecolorallocate($image, 0, 0, 0);
1420 // Insert code into image
1421 imagestring($image, 5, 14, 2, $img_code, $text_color);
1423 // Return to browser
1424 sendHeader('Content-Type: image/' . getConfig('img_type'));
1426 // Output image with matching image factory
1427 switch (getConfig('img_type')) {
1428 case 'jpg': imagejpeg($image); break;
1429 case 'png': imagepng($image); break;
1432 // Remove image from memory
1433 imagedestroy($image);
1435 // Create selection box or array of splitted timestamp
1436 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
1437 // Do not continue if ONE_DAY is absend
1438 if (!isConfigEntrySet('ONE_DAY')) {
1439 // And return the timestamp itself or empty array
1440 if ($return_array === true) {
1447 // Calculate 2-seconds timestamp
1448 $stamp = round($timestamp);
1449 //* DEBUG: */ print("*" . $stamp.'/' . $timestamp."*<br />");
1451 // Do we have a leap year?
1453 $TEST = date('Y', time()) / 4;
1454 $M1 = date('m', time());
1455 $M2 = date('m', (time() + $timestamp));
1457 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1458 if ((floor($TEST) == $TEST) && ($M1 == "02") && ($M2 > "02")) $SWITCH = getConfig('ONE_DAY');
1460 // First of all years...
1461 $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
1462 //* DEBUG: */ print("Y={$Y}<br />");
1464 $M = abs(floor($timestamp / 2628000 - $Y * 12));
1465 //* DEBUG: */ print("M={$M}<br />");
1467 $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('ONE_DAY')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) / 7)));
1468 //* DEBUG: */ print("W={$W}<br />");
1470 $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY'))) - $W * 7));
1471 //* DEBUG: */ print("D={$D}<br />");
1473 $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));
1474 //* DEBUG: */ print("h={$h}<br />");
1476 $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));
1477 //* DEBUG: */ print("m={$m}<br />");
1478 // And at last seconds...
1479 $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));
1480 //* DEBUG: */ print("s={$s}<br />");
1482 // Is seconds zero and time is < 60 seconds?
1483 if (($s == '0') && ($timestamp < 60)) {
1485 $s = round($timestamp);
1489 // Now we convert them in seconds...
1491 if ($return_array) {
1492 // Just put all data in an array for later use
1504 $OUT = '<div align="' . $align . '">';
1505 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
1508 if (isInString('Y', $display) || (empty($display))) {
1509 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_YEARS--}</strong></td>';
1512 if (isInString('M', $display) || (empty($display))) {
1513 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MONTHS--}</strong></td>';
1516 if (isInString('W', $display) || (empty($display))) {
1517 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_WEEKS--}</strong></td>';
1520 if (isInString('D', $display) || (empty($display))) {
1521 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_DAYS--}</strong></td>';
1524 if (isInString('h', $display) || (empty($display))) {
1525 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_HOURS--}</strong></td>';
1528 if (isInString('m', $display) || (empty($display))) {
1529 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MINUTES--}</strong></td>';
1532 if (isInString('s', $display) || (empty($display))) {
1533 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_SECONDS--}</strong></td>';
1539 if (isInString('Y', $display) || (empty($display))) {
1540 // Generate year selection
1541 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
1542 for ($idx = 0; $idx <= 10; $idx++) {
1543 $OUT .= '<option class="mini_select" value="' . $idx . '"';
1544 if ($idx == $Y) $OUT .= ' selected="selected"';
1545 $OUT .= '>' . $idx . '</option>';
1547 $OUT .= '</select></td>';
1549 $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
1552 if (isInString('M', $display) || (empty($display))) {
1553 // Generate month selection
1554 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
1555 for ($idx = 0; $idx <= 11; $idx++) {
1556 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1557 if ($idx == $M) $OUT .= ' selected="selected"';
1558 $OUT .= '>' . $idx . '</option>';
1560 $OUT .= '</select></td>';
1562 $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
1565 if (isInString('W', $display) || (empty($display))) {
1566 // Generate week selection
1567 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
1568 for ($idx = 0; $idx <= 4; $idx++) {
1569 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1570 if ($idx == $W) $OUT .= ' selected="selected"';
1571 $OUT .= '>' . $idx . '</option>';
1573 $OUT .= '</select></td>';
1575 $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
1578 if (isInString('D', $display) || (empty($display))) {
1579 // Generate day selection
1580 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
1581 for ($idx = 0; $idx <= 31; $idx++) {
1582 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1583 if ($idx == $D) $OUT .= ' selected="selected"';
1584 $OUT .= '>' . $idx . '</option>';
1586 $OUT .= '</select></td>';
1588 $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
1591 if (isInString('h', $display) || (empty($display))) {
1592 // Generate hour selection
1593 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
1594 for ($idx = 0; $idx <= 23; $idx++) {
1595 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1596 if ($idx == $h) $OUT .= ' selected="selected"';
1597 $OUT .= '>' . $idx . '</option>';
1599 $OUT .= '</select></td>';
1601 $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
1604 if (isInString('m', $display) || (empty($display))) {
1605 // Generate minute selection
1606 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
1607 for ($idx = 0; $idx <= 59; $idx++) {
1608 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1609 if ($idx == $m) $OUT .= ' selected="selected"';
1610 $OUT .= '>' . $idx . '</option>';
1612 $OUT .= '</select></td>';
1614 $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1617 if (isInString('s', $display) || (empty($display))) {
1618 // Generate second selection
1619 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1620 for ($idx = 0; $idx <= 59; $idx++) {
1621 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1622 if ($idx == $s) $OUT .= ' selected="selected"';
1623 $OUT .= '>' . $idx . '</option>';
1625 $OUT .= '</select></td>';
1627 $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1634 // Return generated HTML code
1639 function createTimestampFromSelections ($prefix, $postData) {
1640 // Initial return value
1643 // Do we have a leap year?
1645 $TEST = date('Y', time()) / 4;
1646 $M1 = date('m', time());
1648 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1649 if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02')) $SWITCH = getConfig('ONE_DAY');
1651 // First add years...
1652 $ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
1655 $ret += $postData[$prefix . '_mo'] * 2628000;
1658 $ret += $postData[$prefix . '_we'] * 604800;
1661 $ret += $postData[$prefix . '_da'] * 86400;
1664 $ret += $postData[$prefix . '_ho'] * 3600;
1667 $ret += $postData[$prefix . '_mi'] * 60;
1669 // And at last seconds...
1670 $ret += $postData[$prefix . '_se'];
1672 // Return calculated value
1676 // Creates a 'fancy' human-readable timestamp from a Uni* stamp
1677 function createFancyTime ($stamp) {
1678 // Get data array with years/months/weeks/days/...
1679 $data = createTimeSelections($stamp, '', '', '', true);
1681 foreach($data as $k => $v) {
1683 // Value is greater than 0 "eval" data to return string
1684 eval('$ret .= ", ".$v." {--_' . strtoupper($k) . '--}";');
1689 // Do we have something there?
1690 if (strlen($ret) > 0) {
1691 // Remove leading commata and space
1692 $ret = substr($ret, 2);
1695 $ret = '0 {--_SECONDS--}';
1698 // Return fancy time string
1702 // Generates a navigation row for listing emails
1703 function addEmailNavigation ($PAGES, $offset, $show_form, $colspan, $return=false) {
1705 if ($show_form === false) {
1710 for ($page = 1; $page <= $PAGES; $page++) {
1711 // Is the page currently selected or shall we generate a link to it?
1712 if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
1713 // Is currently selected, so only highlight it
1714 $NAV .= '<strong>-';
1716 // Open anchor tag and add base URL
1717 $NAV .= '<a href="{%url=modules.php?module=admin&what=' . getWhat() . '&page=' . $page . '&offset=' . $offset;
1719 // Add userid when we shall show all mails from a single member
1720 if ((isGetRequestParameterSet('userid')) && (bigintval(getRequestParameter('userid')) > 0)) $NAV .= '&userid=' . bigintval(getRequestParameter('userid'));
1722 // Close open anchor tag
1726 if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
1727 // Is currently selected, so only highlight it
1728 $NAV .= '-</strong>';
1734 // Add seperator if we have not yet reached total pages
1735 if ($page < $PAGES) {
1741 // Define constants only once
1742 $content['nav'] = $NAV;
1743 $content['span'] = $colspan;
1744 $content['top'] = $TOP;
1746 // Load navigation template
1747 $OUT = loadTemplate('admin_email_nav_row', true, $content);
1749 if ($return === true) {
1750 // Return generated HTML-Code
1758 // Extract host from script name
1759 function extractHostnameFromUrl (&$script) {
1760 // Use default SERVER_URL by default... ;) So?
1761 $url = getConfig('SERVER_URL');
1763 // Is this URL valid?
1764 if (substr($script, 0, 7) == 'http://') {
1765 // Use the hostname from script URL as new hostname
1766 $url = substr($script, 7);
1767 $extract = explode('/', $url);
1769 // Done extracting the URL :)
1772 // Extract host name
1773 $host = str_replace('http://', '', $url);
1774 if (isInString('/', $host)) $host = substr($host, 0, strpos($host, '/'));
1776 // Generate relative URL
1777 //* DEBUG: */ print('SCRIPT=' . $script.'<br />');
1778 if (substr(strtolower($script), 0, 7) == 'http://') {
1779 // But only if http:// is in front!
1780 $script = substr($script, (strlen($url) + 7));
1781 } elseif (substr(strtolower($script), 0, 8) == 'https://') {
1783 $script = substr($script, (strlen($url) + 8));
1786 //* DEBUG: */ print('SCRIPT=' . $script.'<br />');
1787 if (substr($script, 0, 1) == '/') $script = substr($script, 1);
1793 // Send a GET request
1794 function sendGetRequest ($script, $data = array()) {
1795 // Extract host name from script
1796 $host = extractHostnameFromUrl($script);
1799 $body = http_build_query($data, '', '&');
1801 // Do we have a question-mark in the script?
1802 if (strpos($script, '?') === false) {
1803 // No, so first char must be question mark
1804 $body = '?' . $body;
1807 $body = '&' . $body;
1813 // Remove trailed & to make it more conform
1814 if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
1816 // Generate GET request header
1817 $request = 'GET /' . trim($script) . ' HTTP/1.1' . getConfig('HTTP_EOL');
1818 $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
1819 $request .= 'Referer: ' . getConfig('URL') . '/admin.php' . getConfig('HTTP_EOL');
1820 if (isConfigEntrySet('FULL_VERSION')) {
1821 $request .= 'User-Agent: ' . getConfig('TITLE') . '/' . getConfig('FULL_VERSION') . getConfig('HTTP_EOL');
1823 $request .= 'User-Agent: ' . getConfig('TITLE') . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
1825 $request .= 'Accept: image/png,image/*;q=0.8,text/plain,text/html,*/*;q=0.5' . getConfig('HTTP_EOL');
1826 $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
1827 $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
1828 $request .= 'Connection: close' . getConfig('HTTP_EOL');
1829 $request .= getConfig('HTTP_EOL');
1831 // Send the raw request
1832 $response = sendRawRequest($host, $request);
1834 // Return the result to the caller function
1838 // Send a POST request
1839 function sendPostRequest ($script, $postData) {
1840 // Is postData an array?
1841 if (!is_array($postData)) {
1843 logDebugMessage(__FUNCTION__, __LINE__, sprintf("postData is not an array. Type: %s", gettype($postData)));
1844 return array('', '', '');
1847 // Extract host name from script
1848 $host = extractHostnameFromUrl($script);
1850 // Construct request body
1851 $body = http_build_query($postData, '', '&');
1853 // Generate POST request header
1854 $request = 'POST /' . trim($script) . ' HTTP/1.0' . getConfig('HTTP_EOL');
1855 $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
1856 $request .= 'Referer: ' . getConfig('URL') . '/admin.php' . getConfig('HTTP_EOL');
1857 $request .= 'User-Agent: ' . getConfig('TITLE') . '/' . getConfig('FULL_VERSION') . getConfig('HTTP_EOL');
1858 $request .= 'Accept: text/plain;q=0.8' . getConfig('HTTP_EOL');
1859 $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
1860 $request .= 'Cache-Control: no-cache' . getConfig('HTTP_EOL');
1861 $request .= 'Content-Type: application/x-www-form-urlencoded' . getConfig('HTTP_EOL');
1862 $request .= 'Content-Length: ' . strlen($body) . getConfig('HTTP_EOL');
1863 $request .= 'Connection: close' . getConfig('HTTP_EOL');
1864 $request .= getConfig('HTTP_EOL');
1869 // Send the raw request
1870 $response = sendRawRequest($host, $request);
1872 // Return the result to the caller function
1876 // Sends a raw request to another host
1877 function sendRawRequest ($host, $request) {
1878 // Init errno and errdesc with 'all fine' values
1879 $errno = '0'; $errdesc = '';
1882 $response = array('', '', '');
1884 // Default is not to use proxy
1887 // Are proxy settins set?
1888 if ((isConfigEntrySet('proxy_host')) && (getConfig('proxy_host') != '') && (isConfigEntrySet('proxy_port')) && (getConfig('proxy_port') > 0)) {
1894 loadIncludeOnce('inc/classes/resolver.class.php');
1896 // Get resolver instance
1897 $resolver = new HostnameResolver();
1900 //* DEBUG: */ die('SCRIPT=' . $script.'<br />');
1901 if ($useProxy === true) {
1902 // Resolve hostname into IP address
1903 $ip = $resolver->resolveHostname(compileRawCode(getConfig('proxy_host')));
1905 // Connect to host through proxy connection
1906 $fp = fsockopen($ip, bigintval(getConfig('proxy_port')), $errno, $errdesc, 30);
1908 // Resolve hostname into IP address
1909 $ip = $resolver->resolveHostname($host);
1911 // Connect to host directly
1912 $fp = fsockopen($ip, 80, $errno, $errdesc, 30);
1916 if (!is_resource($fp)) {
1918 logDebugMessage(__FUNCTION__, __LINE__, $errdesc . ' (' . $errno . ')');
1920 } elseif ((!stream_set_blocking($fp, 0)) || (!stream_set_timeout($fp, 1))) {
1921 // Cannot set non-blocking mode or timeout
1922 logDebugMessage(__FUNCTION__, __LINE__, socket_strerror(socket_last_error()));
1927 if ($useProxy === true) {
1928 // Setup proxy tunnel
1929 $response = setupProxyTunnel($host, $fp);
1931 // If the response is invalid, abort
1932 if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) {
1933 // Invalid response!
1934 logDebugMessage(__FUNCTION__, __LINE__, 'Proxy tunnel not working?');
1940 fwrite($fp, $request);
1943 $start = microtime(true);
1946 while (!feof($fp)) {
1947 // Get info from stream
1948 $info = stream_get_meta_data($fp);
1950 // Is it timed out? 15 seconds is a really patient...
1951 if (($info['timed_out'] == true) || (microtime(true) - $start) > 15) {
1953 logDebugMessage(__FUNCTION__, __LINE__, 'Timed out to get data from host ' . $host);
1959 // Get line from stream
1960 $line = fgets($fp, 128);
1962 // Ignore empty lines because of non-blocking mode
1964 // uslepp a little to avoid 100% CPU load
1971 // Add it to response
1972 $response[] = trim($line);
1978 // Time request if debug-mode is enabled
1979 if (isDebugModeEnabled()) {
1980 // Add debug message...
1981 logDebugMessage(__FUNCTION__, __LINE__, 'Request took ' . (microtime(true) - $start) . ' seconds and returned ' . count($response) . ' line(s).');
1984 // Skip first empty lines
1986 foreach ($resp as $idx => $line) {
1988 $line = trim($line);
1990 // Is this line empty?
1993 array_shift($response);
1995 // Abort on first non-empty line
2000 //* DEBUG: */ print('<strong>Request:</strong><pre>'.print_r($request, true).'</pre>');
2001 //* DEBUG: */ print('<strong>Response:</strong><pre>'.print_r($response, true).'</pre>');
2003 // Proxy agent found or something went wrong?
2004 if (!isset($response[0])) {
2005 // No response, maybe timeout
2006 $response = array('', '', '');
2007 logDebugMessage(__FUNCTION__, __LINE__, 'Invalid empty response array, maybe timed out?');
2008 } elseif ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && ($useProxy === true)) {
2009 // Proxy header detected, so remove two lines
2010 array_shift($response);
2011 array_shift($response);
2014 // Was the request successfull?
2015 if ((!isInStringIgnoreCase('200 OK', $response[0])) || (empty($response[0]))) {
2016 // Not found / access forbidden
2017 logDebugMessage(__FUNCTION__, __LINE__, 'Unexpected status code ' . $response[0] . ' detected. "200 OK" was expected.');
2018 $response = array('', '', '');
2025 // Sets up a proxy tunnel for given hostname and through resource
2026 function setupProxyTunnel ($host, $resource) {
2028 $response = array('', '', '');
2030 // Generate CONNECT request header
2031 $proxyTunnel = 'CONNECT ' . $host . ':80 HTTP/1.0' . getConfig('HTTP_EOL');
2032 $proxyTunnel .= 'Host: ' . $host . getConfig('HTTP_EOL');
2034 // Use login data to proxy? (username at least!)
2035 if (getConfig('proxy_username') != '') {
2037 $encodedAuth = base64_encode(compileRawCode(getConfig('proxy_username')) . ':' . compileRawCode(getConfig('proxy_password')));
2038 $proxyTunnel .= 'Proxy-Authorization: Basic ' . $encodedAuth . getConfig('HTTP_EOL');
2041 // Add last new-line
2042 $proxyTunnel .= getConfig('HTTP_EOL');
2043 //* DEBUG: */ print('<strong>proxyTunnel=</strong><pre>' . $proxyTunnel.'</pre>');
2046 fwrite($fp, $proxyTunnel);
2050 // No response received
2054 // Read the first line
2055 $resp = trim(fgets($fp, 10240));
2056 $respArray = explode(' ', $resp);
2057 if ((strtolower($respArray[0]) !== 'http/1.0') || ($respArray[1] != '200')) {
2058 // Invalid response!
2066 // Taken from www.php.net isInStringIgnoreCase() user comments
2067 function isEmailValid ($email) {
2068 // Check first part of email address
2069 $first = '[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*';
2072 $domain = '[a-z0-9-]+(\.[a-z0-9-]{2,5})+';
2075 $regex = '@^' . $first . '\@' . $domain . '$@iU';
2077 // Return check result
2078 return preg_match($regex, $email);
2081 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
2082 function isUrlValid ($URL, $compile=true) {
2083 // Trim URL a little
2084 $URL = trim(urldecode($URL));
2085 //* DEBUG: */ outputHtml($URL.'<br />');
2087 // Compile some chars out...
2088 if ($compile === true) $URL = compileUriCode($URL, false, false, false);
2089 //* DEBUG: */ outputHtml($URL.'<br />');
2091 // Check for the extension filter
2092 if (isExtensionActive('filter')) {
2093 // Use the extension's filter set
2094 return FILTER_VALIDATE_URL($URL, false);
2097 // If not installed, perform a simple test. Just make it sure there is always a http:// or
2098 // https:// in front of the URLs
2099 return isUrlValidSimple($URL);
2102 // Generate a list of administrative links to a given userid
2103 function generateMemberAdminActionLinks ($userid, $status = '') {
2104 // Make sure userid is a number
2105 if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
2107 // Define all main targets
2108 $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
2110 // Begin of navigation links
2113 foreach ($targetArray as $tar) {
2114 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&what=' . $tar . '&userid=' . $userid . '%}" title="{--ADMIN_LINK_';
2115 //* DEBUG: */ outputHtml('*' . $tar.'/' . $status.'*<br />');
2116 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
2117 // Locked accounts shall be unlocked
2118 $OUT .= 'UNLOCK_USER';
2120 // All other status is fine
2121 $OUT .= strtoupper($tar);
2123 $OUT .= '_TITLE--}">{--ADMIN_';
2124 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
2125 // Locked accounts shall be unlocked
2126 $OUT .= 'UNLOCK_USER';
2128 // All other status is fine
2129 $OUT .= strtoupper($tar);
2131 $OUT .= '--}</a></span>|';
2134 // Finish navigation link
2135 $OUT = substr($OUT, 0, -7) . ']';
2141 // Generate an email link
2142 function generateEmailLink ($email, $table = 'admins') {
2143 // Default email link (INSECURE! Spammer can read this by harvester programs)
2144 $EMAIL = 'mailto:' . $email;
2146 // Check for several extensions
2147 if ((isExtensionActive('admins')) && ($table == 'admins')) {
2148 // Create email link for contacting admin in guest area
2149 $EMAIL = generateAdminEmailLink($email);
2150 } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
2151 // Create email link for contacting a member within admin area (or later in other areas, too?)
2152 $EMAIL = generateUserEmailLink($email, 'admin');
2153 } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
2154 // Create email link to contact sponsor within admin area (or like the link above?)
2155 $EMAIL = generateSponsorEmailLink($email, 'sponsor_data');
2158 // Shall I close the link when there is no admin?
2159 if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
2161 // Return email link
2165 // Generate a hash for extra-security for all passwords
2166 function generateHash ($plainText, $salt = '', $hash = true) {
2168 //* DEBUG: */ outputHtml('plainText=' . $plainText . ',salt=' . $salt . ',hash='.intval($hash).'<br />');
2170 // Is the required extension 'sql_patches' there and a salt is not given?
2171 // 0123 4 43 3 4 432 2 3 32 2 3 3210
2172 if ((((isExtensionInstalledAndOlder('sql_patches', '0.3.6')) && (empty($salt))) || (!isExtensionActive('sql_patches')) || (!isExtensionInstalledAndNewer('other', '0.2.5')))) {
2173 // Extension sql_patches is missing/outdated so we hash the plain text with MD5
2174 if ($hash === true) {
2175 // Is plain password
2176 return md5($plainText);
2178 // Is already a hash
2183 // Do we miss an arry element here?
2184 if (!isConfigEntrySet('file_hash')) {
2186 debug_report_bug(__FUNCTION__, __LINE__, 'Missing file_hash in ' . __FUNCTION__ . '.');
2189 // When the salt is empty build a new one, else use the first x configured characters as the salt
2191 // Build server string for more entropy
2192 $server = $_SERVER['PHP_SELF'] . getConfig('ENCRYPT_SEPERATOR') . detectUserAgent() . getConfig('ENCRYPT_SEPERATOR') . getenv('SERVER_SOFTWARE') . getConfig('ENCRYPT_SEPERATOR') . detectRemoteAddr();
2195 $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');
2198 $data = $plainText . getConfig('ENCRYPT_SEPERATOR') . uniqid(mt_rand(), true) . getConfig('ENCRYPT_SEPERATOR') . time();
2200 // Calculate number for generating the code
2201 $a = time() + getConfig('_ADD') - 1;
2203 // Generate SHA1 sum from modula of number and the prime number
2204 $sha1 = sha1(($a % getConfig('_PRIME')) . $server . getConfig('ENCRYPT_SEPERATOR') . $keys . getConfig('ENCRYPT_SEPERATOR') . $data . getConfig('ENCRYPT_SEPERATOR') . getConfig('DATE_KEY') . getConfig('ENCRYPT_SEPERATOR') . $a);
2205 //* DEBUG: */ outputHtml('SHA1=' . $sha1.' ('.strlen($sha1).')<br />');
2206 $sha1 = scrambleString($sha1);
2207 //* DEBUG: */ outputHtml('Scrambled=' . $sha1.' ('.strlen($sha1).')<br />');
2208 //* DEBUG: */ $sha1b = descrambleString($sha1);
2209 //* DEBUG: */ outputHtml('Descrambled=' . $sha1b.' ('.strlen($sha1b).')<br />');
2211 // Generate the password salt string
2212 $salt = substr($sha1, 0, getConfig('salt_length'));
2213 //* DEBUG: */ outputHtml($salt.' ('.strlen($salt).')<br />');
2216 //* DEBUG: */ outputHtml('salt=' . $salt . '<br />');
2217 $salt = substr($salt, 0, getConfig('salt_length'));
2218 //* DEBUG: */ outputHtml('salt=' . $salt . '(' . strlen($salt) . '/' . getConfig('salt_length') . ')<br />');
2220 // Sanity check on salt
2221 if (strlen($salt) != getConfig('salt_length')) {
2223 debug_report_bug(__FUNCTION__.': salt length mismatch! ('.strlen($salt).'/'.getConfig('salt_length').')');
2227 // Generate final hash (for debug output)
2228 $finalHash = $salt . sha1($salt . $plainText);
2231 //* DEBUG: */ outputHtml('finalHash=' . $finalHash);
2237 // Scramble a string
2238 function scrambleString($str) {
2242 // Final check, in case of failture it will return unscrambled string
2243 if (strlen($str) > 40) {
2244 // The string is to long
2246 } elseif (strlen($str) == 40) {
2248 $scrambleNums = explode(':', getConfig('pass_scramble'));
2250 // Generate new numbers
2251 $scrambleNums = explode(':', genScrambleString(strlen($str)));
2254 // Compare both lengths and abort if different
2255 if (strlen($str) != count($scrambleNums)) return $str;
2257 // Scramble string here
2258 //* DEBUG: */ outputHtml('***Original=' . $str.'***<br />');
2259 for ($idx = 0; $idx < strlen($str); $idx++) {
2260 // Get char on scrambled position
2261 $char = substr($str, $scrambleNums[$idx], 1);
2263 // Add it to final output string
2264 $scrambled .= $char;
2267 // Return scrambled string
2268 //* DEBUG: */ outputHtml('***Scrambled=' . $scrambled.'***<br />');
2272 // De-scramble a string scrambled by scrambleString()
2273 function descrambleString($str) {
2274 // Scramble only 40 chars long strings
2275 if (strlen($str) != 40) return $str;
2277 // Load numbers from config
2278 $scrambleNums = explode(':', getConfig('pass_scramble'));
2281 if (count($scrambleNums) != 40) return $str;
2283 // Begin descrambling
2284 $orig = str_repeat(' ', 40);
2285 //* DEBUG: */ outputHtml('+++Scrambled=' . $str.'+++<br />');
2286 for ($idx = 0; $idx < 40; $idx++) {
2287 $char = substr($str, $idx, 1);
2288 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
2291 // Return scrambled string
2292 //* DEBUG: */ outputHtml('+++Original=' . $orig.'+++<br />');
2296 // Generated a "string" for scrambling
2297 function genScrambleString ($len) {
2298 // Prepare array for the numbers
2299 $scrambleNumbers = array();
2301 // First we need to setup randomized numbers from 0 to 31
2302 for ($idx = 0; $idx < $len; $idx++) {
2304 $rand = mt_rand(0, ($len -1));
2306 // Check for it by creating more numbers
2307 while (array_key_exists($rand, $scrambleNumbers)) {
2308 $rand = mt_rand(0, ($len -1));
2312 $scrambleNumbers[$rand] = $rand;
2315 // So let's create the string for storing it in database
2316 $scrambleString = implode(':', $scrambleNumbers);
2317 return $scrambleString;
2320 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
2321 function encodeHashForCookie ($passHash) {
2322 // Return vanilla password hash
2325 // Is a secret key and master salt already initialized?
2326 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, intval(isExtensionInstalled('sql_patches')) . '/' . intval(isConfigEntrySet('_PRIME')) . '/' . intval(isConfigEntrySet('secret_key')) . '/' . intval(isConfigEntrySet('master_salt')));
2327 if ((isExtensionInstalled('sql_patches')) && (isConfigEntrySet('_PRIME')) && (isConfigEntrySet('secret_key')) && (isConfigEntrySet('master_salt'))) {
2328 // Only calculate when the secret key is generated
2329 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '/' . strlen(getConfig('secret_key')));
2330 if ((strlen($passHash) != 49) || (strlen(getConfig('secret_key')) != 40)) {
2331 // Both keys must have same length so return unencrypted
2332 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '!=49/' . strlen(getConfig('secret_key')) . '!=40');
2336 $newHash = ''; $start = 9;
2337 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'passHash=' . $passHash . '(' . strlen($passHash) . ')');
2338 for ($idx = 0; $idx < 20; $idx++) {
2339 $part1 = hexdec(substr($passHash, ($idx * 2) + (strlen($passHash) - strlen(getConfig('secret_key'))), 2));
2340 $part2 = hexdec(substr(getConfig('secret_key'), $start, 2));
2341 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'part1=' . $part1 . '/part2=' . $part2);
2342 $mod = dechex($idx);
2343 if ($part1 > $part2) {
2344 $mod = dechex(sqrt(($part1 - $part2) * getConfig('_PRIME') / pi()));
2345 } elseif ($part2 > $part1) {
2346 $mod = dechex(sqrt(($part2 - $part1) * getConfig('_PRIME') / pi()));
2348 $mod = substr($mod, 0, 2);
2349 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'part1=' . $part1 . '/part2=' . $part2 . '/mod=' . $mod . '(' . strlen($mod) . ')');
2350 $mod = str_repeat(0, (2 - strlen($mod))) . $mod;
2351 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mod(' . ($idx * 2) . ')=' . $mod . '*');
2356 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $passHash . ',' . $newHash . ' (' . strlen($newHash) . ')');
2357 $ret = generateHash($newHash, getConfig('master_salt'));
2361 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret . '');
2365 // Fix "deleted" cookies
2366 function fixDeletedCookies ($cookies) {
2367 // Is this an array with entries?
2368 if ((is_array($cookies)) && (count($cookies) > 0)) {
2369 // Then check all cookies if they are marked as deleted!
2370 foreach ($cookies as $cookieName) {
2371 // Is the cookie set to "deleted"?
2372 if (getSession($cookieName) == 'deleted') {
2373 setSession($cookieName, '');
2379 // Output error messages in a fasioned way and die...
2380 function app_die ($F, $L, $message) {
2381 // Check if Script is already dieing and not let it kill itself another 1000 times
2382 if (!isset($GLOBALS['app_died'])) {
2383 // Make sure, that the script realy realy diese here and now
2384 $GLOBALS['app_died'] = true;
2386 // Set content type as text/html
2387 setContentType('text/html');
2390 loadIncludeOnce('inc/header.php');
2392 // Rewrite message for output
2393 $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
2395 // Load the message template
2396 loadTemplate('app_die_message', false, $message);
2399 loadIncludeOnce('inc/footer.php');
2401 // Script tried to kill itself twice
2402 die('['.__FUNCTION__.':'.__LINE__.']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
2406 // Display parsing time and number of SQL queries in footer
2407 function displayParsingTime () {
2408 // Is the timer started?
2409 if (!isset($GLOBALS['startTime'])) {
2415 $endTime = microtime(true);
2417 // "Explode" both times
2418 $start = explode(' ', $GLOBALS['startTime']);
2419 $end = explode(' ', $endTime);
2420 $runTime = $end[0] - $start[0];
2421 if ($runTime < 0) $runTime = '0';
2424 // @TODO This can be easily moved out after the merge from EL branch to this is complete
2426 'run_time' => translateComma($runTime),
2427 'sql_time' => translateComma(getConfig('sql_time') * 1000),
2430 // Load the template
2431 $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
2434 // Check wether a boolean constant is set
2435 // Taken from user comments in PHP documentation for function constant()
2436 function isBooleanConstantAndTrue ($constName) { // : Boolean
2437 // Failed by default
2441 if (isset($GLOBALS['cache_array']['const'][$constName])) {
2443 //* DEBUG: */ outputHtml(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>): ' . $constName."-CACHE!<br />");
2444 $res = ($GLOBALS['cache_array']['const'][$constName] === true);
2447 //* DEBUG: */ outputHtml(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>): ' . $constName."-RESOLVE!<br />");
2448 if (defined($constName)) {
2450 //* DEBUG: */ outputHtml(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>): ' . $constName."-FOUND!<br />");
2451 $res = (constant($constName) === true);
2455 $GLOBALS['cache_array']['const'][$constName] = $res;
2457 //* DEBUG: */ var_dump($res);
2463 // Checks if a given apache module is loaded
2464 function isApacheModuleLoaded ($apacheModule) {
2465 // Check it and return result
2466 return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
2469 // Get current theme name
2470 function getCurrentTheme () {
2471 // The default theme is 'default'... ;-)
2474 // Do we have ext-theme installed and active?
2475 if (isExtensionActive('theme')) {
2476 // Call inner method
2477 $ret = getActualTheme();
2480 // Return theme value
2484 // Generates an error code from given account status
2485 function generateErrorCodeFromUserStatus ($status='') {
2486 // If no status is provided, use the default, cached
2487 if ((empty($status)) && (isMember())) {
2489 $status = getUserData('status');
2492 // Default error code if unknown account status
2493 $errorCode = getCode('UNKNOWN_STATUS');
2495 // Generate constant name
2496 $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
2498 // Is the constant there?
2499 if (isCodeSet($codeName)) {
2501 $errorCode = getCode($codeName);
2504 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
2507 // Return error code
2511 // Back-ported from the new ship-simu engine. :-)
2512 function debug_get_printable_backtrace () {
2514 $backtrace = "<ol>\n";
2516 // Get and prepare backtrace for output
2517 $backtraceArray = debug_backtrace();
2518 foreach ($backtraceArray as $key => $trace) {
2519 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
2520 if (!isset($trace['line'])) $trace['line'] = __LINE__;
2521 if (!isset($trace['args'])) $trace['args'] = array();
2522 $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";
2526 $backtrace .= "</ol>\n";
2528 // Return the backtrace
2532 // A mail-able backtrace
2533 function debug_get_mailable_backtrace () {
2537 // Get and prepare backtrace for output
2538 $backtraceArray = debug_backtrace();
2539 foreach ($backtraceArray as $key => $trace) {
2540 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
2541 if (!isset($trace['line'])) $trace['line'] = __LINE__;
2542 if (!isset($trace['args'])) $trace['args'] = array();
2543 $backtrace .= ($key+1) . '.:' . basename($trace['file']) . ':' . $trace['line'] . ', ' . $trace['function'] . '(' . count($trace['args']) . ")\n";
2546 // Return the backtrace
2550 // Output a debug backtrace to the user
2551 function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
2552 // Is this already called?
2553 if (isset($GLOBALS[__FUNCTION__])) {
2555 print 'Message:'.$message.'<br />Backtrace:<pre>';
2556 debug_print_backtrace();
2560 // Set this function as called
2561 $GLOBALS[__FUNCTION__] = true;
2566 // Is the optional message set?
2567 if (!empty($message)) {
2569 $debug = sprintf("Note: %s<br />\n",
2573 // @TODO Add a little more infos here
2574 logDebugMessage($F, $L, strip_tags($message));
2578 $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>";
2579 $debug .= debug_get_printable_backtrace();
2580 $debug .= "</pre>\nRequest-URI: " . getRequestUri()."<br />\n";
2581 $debug .= "Thank you for finding bugs.";
2583 // Send an email? (e.g. not wanted for evaluation errors)
2584 if (($sendEmail === true) && (!isInstallationPhase())) {
2587 'message' => trim($message),
2588 'backtrace' => trim(debug_get_mailable_backtrace())
2591 // Send email to webmaster
2592 sendAdminNotification(getMessage('DEBUG_REPORT_BUG_SUBJECT'), 'admin_report_bug', $content);
2596 app_die($F, $L, $debug);
2599 // Generates a ***weak*** seed
2600 function generateSeed () {
2601 return microtime(true) * 100000;
2604 // Converts a message code to a human-readable message
2605 function getMessageFromErrorCode ($code) {
2609 case getCode('LOGOUT_DONE') : $message = getMessage('LOGOUT_DONE'); break;
2610 case getCode('LOGOUT_FAILED') : $message = '<span class="guest_failed">{--LOGOUT_FAILED--}</span>'; break;
2611 case getCode('DATA_INVALID') : $message = getMessage('MAIL_DATA_INVALID'); break;
2612 case getCode('POSSIBLE_INVALID') : $message = getMessage('MAIL_POSSIBLE_INVALID'); break;
2613 case getCode('USER_404') : $message = getMessage('USER_404'); break;
2614 case getCode('STATS_404') : $message = getMessage('MAIL_STATS_404'); break;
2615 case getCode('ALREADY_CONFIRMED') : $message = getMessage('MAIL_ALREADY_CONFIRMED'); break;
2616 case getCode('WRONG_PASS') : $message = getMessage('LOGIN_WRONG_PASS'); break;
2617 case getCode('WRONG_ID') : $message = getMessage('LOGIN_WRONG_ID'); break;
2618 case getCode('ACCOUNT_LOCKED') : $message = getMessage('LOGIN_STATUS_LOCKED'); break;
2619 case getCode('ACCOUNT_UNCONFIRMED'): $message = getMessage('LOGIN_STATUS_UNCONFIRMED'); break;
2620 case getCode('COOKIES_DISABLED') : $message = getMessage('LOGIN_COOKIES_DISABLED'); break;
2621 case getCode('BEG_SAME_AS_OWN') : $message = getMessage('BEG_SAME_UID_AS_OWN'); break;
2622 case getCode('LOGIN_FAILED') : $message = getMessage('LOGIN_FAILED_GENERAL'); break;
2623 case getCode('MODULE_MEM_ONLY') : $message = getMaskedMessage('MODULE_MEM_ONLY', getRequestParameter('mod')); break;
2624 case getCode('OVERLENGTH') : $message = getMessage('MEMBER_TEXT_OVERLENGTH'); break;
2625 case getCode('URL_FOUND') : $message = getMessage('MEMBER_TEXT_CONTAINS_URL'); break;
2626 case getCode('SUBJ_URL') : $message = getMessage('MEMBER_SUBJ_CONTAINS_URL'); break;
2627 case getCode('BLIST_URL') : $message = "{--MEMBER_URL_BLACK_LISTED--}<br />\n{--MEMBER_BLIST_TIME--}: ".generateDateTime(getRequestParameter('blist'), 0); break;
2628 case getCode('NO_RECS_LEFT') : $message = getMessage('MEMBER_SELECTED_MORE_RECS'); break;
2629 case getCode('INVALID_TAGS') : $message = getMessage('MEMBER_HTML_INVALID_TAGS'); break;
2630 case getCode('MORE_POINTS') : $message = getMessage('MEMBER_MORE_POINTS_NEEDED'); break;
2631 case getCode('MORE_RECEIVERS1') : $message = getMessage('MEMBER_ENTER_MORE_RECEIVERS'); break;
2632 case getCode('MORE_RECEIVERS2') : $message = getMessage('MEMBER_NO_MORE_RECEIVERS_FOUND'); break;
2633 case getCode('MORE_RECEIVERS3') : $message = getMessage('MEMBER_ENTER_MORE_MIN_RECEIVERS'); break;
2634 case getCode('INVALID_URL') : $message = getMessage('MEMBER_ENTER_INVALID_URL'); break;
2635 case getCode('NO_MAIL_TYPE') : $message = getMessage('MEMBER_NO_MAIL_TYPE_SELECTED'); break;
2636 case getCode('UNKNOWN_ERROR') : $message = getMessage('LOGIN_UNKNOWN_ERROR'); break;
2637 case getCode('UNKNOWN_STATUS') : $message = getMessage('LOGIN_UNKNOWN_STATUS'); break;
2639 case getCode('ERROR_MAILID'):
2640 if (isExtensionActive('mailid', true)) {
2641 $message = getMessage('ERROR_CONFIRMING_MAIL');
2643 $message = getMaskedMessage('EXTENSION_PROBLEM_NOT_INSTALLED', 'mailid');
2647 case getCode('EXTENSION_PROBLEM'):
2648 if (isGetRequestParameterSet('ext')) {
2649 $message = generateExtensionInactiveNotInstalledMessage(getRequestParameter('ext'));
2651 $message = getMessage('EXTENSION_PROBLEM_UNSET_EXT');
2655 case getCode('URL_TLOCK'):
2656 // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
2657 $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
2658 array(bigintval(getRequestParameter('id'))), __FUNCTION__, __LINE__);
2660 // Load timestamp from last order
2661 list($timestamp) = SQL_FETCHROW($result);
2664 SQL_FREERESULT($result);
2666 // Translate it for templates
2667 $timestamp = generateDateTime($timestamp, 1);
2669 // Calculate hours...
2670 $STD = round(getConfig('url_tlock') / 60 / 60);
2673 $MIN = round((getConfig('url_tlock') - $STD * 60 * 60) / 60);
2676 $SEC = getConfig('url_tlock') - $STD * 60 * 60 - $MIN * 60;
2678 // Finally contruct the message
2679 // @TODO Rewrite this old lost code to a template
2680 $message = "{--MEMBER_URL_TIME_LOCK--}<br />{--CONFIG_URL_TLOCK--} ".$STD."
2681 {--_HOURS--}, ".$MIN." {--_MINUTES--} {--_AND--} ".$SEC." {--_SECONDS--}<br />
2682 {--MEMBER_LAST_TLOCK--}: ".$timestamp;
2686 // Missing/invalid code
2687 $message = getMaskedMessage('UNKNOWN_MAILID_CODE', $code);
2690 logDebugMessage(__FUNCTION__, __LINE__, $message);
2694 // Return the message
2698 // Compile characters which are allowed in URLs
2699 function compileUriCode ($code, $simple = true) {
2700 // Compile constants
2701 if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
2703 // Compile QUOT and other non-HTML codes
2704 $code = str_replace('{DOT}', '.',
2705 str_replace('{SLASH}', '/',
2706 str_replace('{QUOT}', "'",
2707 str_replace('{DOLLAR}', '$',
2708 str_replace('{OPEN_ANCHOR}', '(',
2709 str_replace('{CLOSE_ANCHOR}', ')',
2710 str_replace('{OPEN_SQR}', '[',
2711 str_replace('{CLOSE_SQR}', ']',
2712 str_replace('{PER}', '%',
2716 // Return compiled code
2720 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
2721 function isUrlValidSimple ($url) {
2723 $url = secureString(str_replace("\\", '', compileRawCode(urldecode($url))));
2725 // Allows http and https
2726 $http = "(http|https)+(:\/\/)";
2728 $domain1 = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
2729 // Test double-domains (e.g. .de.vu)
2730 $domain2 = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
2732 $ip = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
2734 $dir = "((/)+([-_\.[:alnum:]])+)*";
2736 $page = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
2737 // ... and the string after and including question character
2738 $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
2739 // Pattern for URLs like http://url/dir/doc.html?var=value
2740 $pattern['d1dpg1'] = $http . $domain1 . $dir . $page . $getstring1;
2741 $pattern['d2dpg1'] = $http . $domain2 . $dir . $page . $getstring1;
2742 $pattern['ipdpg1'] = $http . $ip . $dir . $page . $getstring1;
2743 // Pattern for URLs like http://url/dir/?var=value
2744 $pattern['d1dg1'] = $http . $domain1 . $dir.'/' . $getstring1;
2745 $pattern['d2dg1'] = $http . $domain2 . $dir.'/' . $getstring1;
2746 $pattern['ipdg1'] = $http . $ip . $dir.'/' . $getstring1;
2747 // Pattern for URLs like http://url/dir/page.ext
2748 $pattern['d1dp'] = $http . $domain1 . $dir . $page;
2749 $pattern['d1dp'] = $http . $domain2 . $dir . $page;
2750 $pattern['ipdp'] = $http . $ip . $dir . $page;
2751 // Pattern for URLs like http://url/dir
2752 $pattern['d1d'] = $http . $domain1 . $dir;
2753 $pattern['d2d'] = $http . $domain2 . $dir;
2754 $pattern['ipd'] = $http . $ip . $dir;
2755 // Pattern for URLs like http://url/?var=value
2756 $pattern['d1g1'] = $http . $domain1 . '/' . $getstring1;
2757 $pattern['d2g1'] = $http . $domain2 . '/' . $getstring1;
2758 $pattern['ipg1'] = $http . $ip . '/' . $getstring1;
2759 // Pattern for URLs like http://url?var=value
2760 $pattern['d1g12'] = $http . $domain1 . $getstring1;
2761 $pattern['d2g12'] = $http . $domain2 . $getstring1;
2762 $pattern['ipg12'] = $http . $ip . $getstring1;
2764 // Test all patterns
2766 foreach ($pattern as $key => $pat) {
2768 if (isDebugRegularExpressionEnabled()) {
2769 // @TODO Are these convertions still required?
2770 $pat = str_replace('.', "\.", $pat);
2771 $pat = str_replace('@', "\@", $pat);
2772 //* DEBUG: */ outputHtml($key."= " . $pat . '<br />');
2775 // Check if expression matches
2776 $reg = ($reg || preg_match(('^' . $pat . '^'), $url));
2779 if ($reg === true) break;
2782 // Return true/false
2786 // Wtites data to a config.php-style file
2787 // @TODO Rewrite this function to use readFromFile() and writeToFile()
2788 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
2789 // Initialize some variables
2795 // Is the file there and read-/write-able?
2796 if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
2797 $search = 'CFG: ' . $comment;
2798 $tmp = $FQFN . '.tmp';
2800 // Open the source file
2801 $fp = fopen($FQFN, 'r') or outputHtml('<strong>READ:</strong> ' . $FQFN . '<br />');
2803 // Is the resource valid?
2804 if (is_resource($fp)) {
2805 // Open temporary file
2806 $fp_tmp = fopen($tmp, 'w') or outputHtml('<strong>WRITE:</strong> ' . $tmp . '<br />');
2808 // Is the resource again valid?
2809 if (is_resource($fp_tmp)) {
2810 // Mark temporary file as readable
2811 $GLOBALS['file_readable'][$tmp] = true;
2814 while (!feof($fp)) {
2815 // Read from source file
2816 $line = fgets ($fp, 1024);
2818 if (strpos($line, $search) > -1) { $next = '0'; $found = true; }
2821 if ($next === $seek) {
2823 $line = $prefix . $DATA . $suffix . "\n";
2829 // Write to temp file
2830 fwrite($fp_tmp, $line);
2836 // Finished writing tmp file
2840 // Close source file
2843 if (($done === true) && ($found === true)) {
2844 // Copy back tmp file and delete tmp :-)
2845 copyFileVerified($tmp, $FQFN, 0644);
2846 return removeFile($tmp);
2847 } elseif ($found === false) {
2848 outputHtml('<strong>CHANGE:</strong> 404!');
2850 outputHtml('<strong>TMP:</strong> UNDONE!');
2854 // File not found, not readable or writeable
2855 outputHtml('<strong>404:</strong> ' . $FQFN . '<br />');
2858 // An error was detected!
2861 // Send notification to admin
2862 function sendAdminNotification ($subject, $templateName, $content=array(), $userid = '0') {
2863 if ((isExtensionInstalledAndNewer('admins', '0.4.1')) && (function_exists('sendAdminsEmails'))) {
2865 sendAdminsEmails($subject, $templateName, $content, $userid);
2867 // Send out out-dated way
2868 $message = loadEmailTemplate($templateName, $content, $userid);
2869 sendAdminEmails($subject, $message);
2873 // Debug message logger
2874 function logDebugMessage ($funcFile, $line, $message, $force=true) {
2875 // Is debug mode enabled?
2876 if ((isDebugModeEnabled()) || ($force === true)) {
2878 $message = str_replace("\r", '', str_replace("\n", '', $message));
2880 // Log this message away
2881 $fp = fopen(getConfig('CACHE_PATH') . 'debug.log', 'a') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write logfile debug.log!');
2882 fwrite($fp, date('d.m.Y|H:i:s', time()) . '|' . getModule(false) . '|' . basename($funcFile) . '|' . $line . '|' . $message . "\n");
2887 // Handle extra values
2888 function handleExtraValues ($filterFunction, $value, $extraValue) {
2889 // Default is the value itself
2892 // Do we have a special filter function?
2893 if (!empty($filterFunction)) {
2894 // Does the filter function exist?
2895 if (function_exists($filterFunction)) {
2896 // Do we have extra parameters here?
2897 if (!empty($extraValue)) {
2898 // Put both parameters in one new array by default
2899 $args = array($value, $extraValue);
2901 // If we have an array simply use it and pre-extend it with our value
2902 if (is_array($extraValue)) {
2903 // Make the new args array
2904 $args = merge_array(array($value), $extraValue);
2907 // Call the multi-parameter call-back
2908 $ret = call_user_func_array($filterFunction, $args);
2910 // One parameter call
2911 $ret = call_user_func($filterFunction, $value);
2920 // Converts timestamp selections into a timestamp
2921 function convertSelectionsToTimestamp (&$postData, &$DATA, &$id, &$skip) {
2922 // Init test variable
2926 // Get last three chars
2927 $test = substr($id, -3);
2929 // Improved way of checking! :-)
2930 if (in_array($test, array('_ye', '_mo', '_we', '_da', '_ho', '_mi', '_se'))) {
2931 // Found a multi-selection for timings?
2932 $test = substr($id, 0, -3);
2933 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)) {
2934 // Generate timestamp
2935 $postData[$test] = createTimestampFromSelections($test, $postData);
2936 $DATA[] = sprintf("`%s`='%s'", $test, $postData[$test]);
2937 $GLOBALS['skip_config'][$test] = true;
2939 // Remove data from array
2940 foreach (array('ye', 'mo', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
2941 unset($postData[$test . '_' . $rem]);
2952 // Reverts the german decimal comma into Computer decimal dot
2953 function convertCommaToDot ($str) {
2954 // Default float is not a float... ;-)
2957 // Which language is selected?
2958 switch (getLanguage()) {
2959 case 'de': // German language
2960 // Remove german thousand dots first
2961 $str = str_replace('.', '', $str);
2963 // Replace german commata with decimal dot and cast it
2964 $float = (float)str_replace(',', '.', $str);
2967 default: // US and so on
2968 // Remove thousand dots first and cast
2969 $float = (float)str_replace(',', '', $str);
2977 // Handle menu-depending failed logins and return the rendered content
2978 function handleLoginFailures ($accessLevel) {
2979 // Default output is empty ;-)
2982 // Is the session data set?
2983 if ((isSessionVariableSet('mailer_' . $accessLevel . '_failures')) && (isSessionVariableSet('mailer_' . $accessLevel . '_last_failure'))) {
2984 // Ignore zero values
2985 if (getSession('mailer_' . $accessLevel . '_failures') > 0) {
2986 // Non-guest has login failures found, get both data and prepare it for template
2987 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "accessLevel={$accessLevel}<br />");
2989 'login_failures' => getSession('mailer_' . $accessLevel . '_failures'),
2990 'last_failure' => generateDateTime(getSession('mailer_' . $accessLevel . '_last_failure'), 2)
2994 $OUT = loadTemplate('login_failures', true, $content);
2997 // Reset session data
2998 setSession('mailer_' . $accessLevel . '_failures', '');
2999 setSession('mailer_' . $accessLevel . '_last_failure', '');
3002 // Return rendered content
3007 function rebuildCache ($cache, $inc = '', $force = false) {
3009 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("cache=%s, inc=%s, force=%s", $cache, $inc, intval($force)));
3011 // Shall I remove the cache file?
3012 if (isCacheInstanceValid()) {
3014 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
3016 $GLOBALS['cache_instance']->removeCacheFile($force);
3019 // Include file given?
3022 $inc = sprintf("inc/loader/load_cache-%s.php", $inc);
3024 // Is the include there?
3025 if (isIncludeReadable($inc)) {
3026 // And rebuild it from scratch
3027 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "inc={$inc} - LOADED!<br />");
3030 // Include not found!
3031 logDebugMessage(__FUNCTION__, __LINE__, "Include {$inc} not found. cache={$cache}");
3037 // Determines the real remote address
3038 function determineRealRemoteAddress () {
3039 // Is a proxy in use?
3040 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) {
3042 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
3043 } elseif (isset($_SERVER['HTTP_CLIENT_IP'])) {
3044 // Yet, another proxy
3045 $address = $_SERVER['HTTP_CLIENT_IP'];
3047 // The regular address when no proxy was used
3048 $address = $_SERVER['REMOTE_ADDR'];
3051 // This strips out the real address from proxy output
3052 if (strstr($address, ',')) {
3053 $addressArray = explode(',', $address);
3054 $address = $addressArray[0];
3057 // Return the result
3061 // Adds a bonus mail to the queue
3062 // This is a high-level function!
3063 function addNewBonusMail ($data, $mode = '', $output=true) {
3064 // Use mode from data if not set and availble ;-)
3065 if ((empty($mode)) && (isset($data['mode']))) $mode = $data['mode'];
3067 // Generate receiver list
3068 $receiver = generateReceiverList($data['cat'], $data['receiver'], $mode);
3071 if (!empty($receiver)) {
3072 // Add bonus mail to queue
3073 addBonusMailToQueue(
3085 // Mail inserted into bonus pool
3086 if ($output) loadTemplate('admin_settings_saved', false, getMessage('ADMIN_BONUS_SEND'));
3087 } elseif ($output) {
3088 // More entered than can be reached!
3089 loadTemplate('admin_settings_saved', false, getMessage('ADMIN_MORE_SELECTED'));
3092 logDebugMessage(__FUNCTION__, __LINE__, "cat={$data['cat']},receiver={$data['receiver']},data=".base64_encode(serialize($data))." More selected, than available!");
3096 // Determines referal id and sets it
3097 function determineReferalId () {
3098 // Skip this in non-html-mode and outside ref.php
3099 if ((getOutputMode() != 0) && (basename($_SERVER['PHP_SELF']) != 'ref.php')) return false;
3101 // Check if refid is set
3102 if ((isset($GLOBALS['refid'])) && ($GLOBALS['refid'] > 0)) {
3104 } elseif ((isGetRequestParameterSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
3105 // The variable user comes from the click-counter script click.php and we only accept this here
3106 $GLOBALS['refid'] = bigintval(getRequestParameter('user'));
3107 } elseif (isPostRequestParameterSet('refid')) {
3108 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3109 $GLOBALS['refid'] = secureString(postRequestParameter('refid'));
3110 } elseif (isGetRequestParameterSet('refid')) {
3111 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3112 $GLOBALS['refid'] = secureString(getRequestParameter('refid'));
3113 } elseif (isGetRequestParameterSet('ref')) {
3114 // Set refid=ref (the referal link uses such variable)
3115 $GLOBALS['refid'] = secureString(getRequestParameter('ref'));
3116 } elseif ((isSessionVariableSet('refid')) && (getSession('refid') != 0)) {
3117 // Set session refid als global
3118 $GLOBALS['refid'] = bigintval(getSession('refid'));
3119 } elseif ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y')) {
3120 // Select a random user which has confirmed enougth mails
3121 $GLOBALS['refid'] = determineRandomReferalId();
3122 } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (getConfig('def_refid') > 0)) {
3123 // Set default refid as refid in URL
3124 $GLOBALS['refid'] = getConfig('def_refid');
3126 // No default id when sql_patches is not installed or none set
3127 $GLOBALS['refid'] = '0';
3130 // Set cookie when default refid > 0
3131 if (!isSessionVariableSet('refid') || (!empty($GLOBALS['refid'])) || ((getSession('refid') == '0') && (isConfigEntrySet('def_refid')) && (getConfig('def_refid') > 0))) {
3132 // Default is not found
3135 // Do we have nickname or userid set?
3136 if ((isExtensionActive('nickname')) && (isNicknameUsed($GLOBALS['refid']))) {
3137 // Nickname in URL, so load the id
3138 $found = fetchUserData($GLOBALS['refid'], 'nickname');
3139 } elseif ($GLOBALS['refid'] > 0) {
3140 // Direct userid entered
3141 $found = fetchUserData($GLOBALS['refid']);
3144 // Is the record valid?
3145 if ((($found === false) || (!isUserDataValid())) && (isConfigEntrySet('def_refid'))) {
3146 // No, then reset referal id
3147 $GLOBALS['refid'] = getConfig('def_refid');
3151 setSession('refid', $GLOBALS['refid']);
3154 // Return determined refid
3155 return $GLOBALS['refid'];
3158 // Enables the reset mode and runs it
3159 function doReset () {
3160 // Enable the reset mode
3161 $GLOBALS['reset_enabled'] = true;
3164 runFilterChain('reset');
3167 // Our shutdown-function
3168 function shutdown () {
3169 // Call the filter chain 'shutdown'
3170 runFilterChain('shutdown', null);
3172 // Check if not in installation phase and the link is up
3173 if ((!isInstallationPhase()) && (SQL_IS_LINK_UP())) {
3175 SQL_CLOSE(__FUNCTION__, __LINE__);
3176 } elseif (!isInstallationPhase()) {
3178 addFatalMessage(__FUNCTION__, __LINE__, getMessage('NO_DB_LINK_SHUTDOWN'));
3181 // Stop executing here
3186 function initMemberId () {
3187 $GLOBALS['member_id'] = '0';
3190 // Setter for member id
3191 function setMemberId ($memberid) {
3192 // We should not set member id to zero
3193 if ($memberid == '0') debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
3196 $GLOBALS['member_id'] = bigintval($memberid);
3199 // Getter for member id or returns zero
3200 function getMemberId () {
3201 // Default member id
3204 // Is the member id set?
3205 if (isMemberIdSet()) {
3207 $memberid = $GLOBALS['member_id'];
3214 // Checks ether the member id is set
3215 function isMemberIdSet () {
3216 return (isset($GLOBALS['member_id']));
3219 // Handle message codes from URL
3220 function handleCodeMessage () {
3221 if (isGetRequestParameterSet('code')) {
3222 // Default extension is 'unknown'
3225 // Is extension given?
3226 if (isGetRequestParameterSet('ext')) $ext = getRequestParameter('ext');
3228 // Convert the 'code' parameter from URL to a human-readable message
3229 $message = getMessageFromErrorCode(getRequestParameter('code'));
3231 // Load message template
3232 loadTemplate('message', false, $message);
3236 // Setter for extra title
3237 function setExtraTitle ($extraTitle) {
3238 $GLOBALS['extra_title'] = $extraTitle;
3241 // Getter for extra title
3242 function getExtraTitle () {
3243 // Is the extra title set?
3244 if (!isExtraTitleSet()) {
3245 // No, then abort here
3246 debug_report_bug(__FUNCTION__, __LINE__, 'extra_title is not set!');
3250 return $GLOBALS['extra_title'];
3253 // Checks if the extra title is set
3254 function isExtraTitleSet () {
3255 return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
3258 // Generates a 'extension foo inactive' message
3259 function generateExtensionInactiveMessage ($ext_name) {
3260 // Is the extension empty?
3261 if (empty($ext_name)) {
3262 // This should not happen
3263 debug_report_bug(__FUNCTION__ . ': Parameter ext is empty. This should not happen.');
3267 $message = getMaskedMessage('EXTENSION_PROBLEM_EXT_INACTIVE', $ext_name);
3269 // Is an admin logged in?
3271 // Then output admin message
3272 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXT_INACTIVE', $ext_name);
3275 // Return prepared message
3279 // Generates a 'extension foo not installed' message
3280 function generateExtensionNotInstalledMessage ($ext_name) {
3281 // Is the extension empty?
3282 if (empty($ext_name)) {
3283 // This should not happen
3284 debug_report_bug(__FUNCTION__ . ': Parameter ext is empty. This should not happen.');
3288 $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
3290 // Is an admin logged in?
3292 // Then output admin message
3293 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
3296 // Return prepared message
3300 // Generates a message depending on if the extension is not installed or not
3302 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
3306 // Is the extension not installed or just deactivated?
3307 switch (isExtensionInstalled($ext_name)) {
3308 case true; // Deactivated!
3309 $message = generateExtensionInactiveMessage($ext_name);
3312 case false; // Not installed!
3313 $message = generateExtensionNotInstalledMessage($ext_name);
3316 default: // Should not happen!
3317 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
3318 $message = sprintf("Invalid state of extension %s detected.", $ext_name);
3322 // Return the message
3326 // Reads a directory recursively by default and searches for files not matching
3327 // an exclusion pattern. You can now keep the exclusion pattern empty for reading
3328 // a whole directory.
3329 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $addBaseDir = true, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = true, $suffix = '') {
3330 // Add default entries we should exclude
3331 $excludeArray[] = '.';
3332 $excludeArray[] = '..';
3333 $excludeArray[] = '.svn';
3334 $excludeArray[] = '.htaccess';
3336 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
3341 $dirPointer = opendir(getConfig('PATH') . $baseDir) or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
3344 while ($baseFile = readdir($dirPointer)) {
3345 // Exclude '.', '..' and entries in $excludeArray automatically
3346 if (in_array($baseFile, $excludeArray, true)) {
3348 //* DEBUG: */ outputHtml('excluded=' . $baseFile . '<br />');
3352 // Construct include filename and FQFN
3353 $fileName = $baseDir . $baseFile;
3354 $FQFN = getConfig('PATH') . $fileName;
3356 // Remove double slashes
3357 $FQFN = str_replace('//', '/', $FQFN);
3359 // Check if the base filenname matches an exclusion pattern and if the pattern is not empty
3360 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
3361 // These Lines are only for debugging!!
3362 //* DEBUG: */ outputHtml('baseDir:' . $baseDir . '<br />');
3363 //* DEBUG: */ outputHtml('baseFile:' . $baseFile . '<br />');
3364 //* DEBUG: */ outputHtml('FQFN:' . $FQFN . '<br />');
3370 // Skip also files with non-matching prefix genericly
3371 if (($recursive === true) && (isDirectory($FQFN))) {
3372 // Is a redirectory so read it as well
3373 $files = merge_array($files, getArrayFromDirectory($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
3375 // And skip further processing
3377 } elseif (substr($baseFile, 0, strlen($prefix)) != $prefix) {
3379 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid prefix in file " . $baseFile . ", prefix=" . $prefix);
3381 } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
3382 // Skip wrong suffix as well
3383 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid suffix in file " . $baseFile . ", suffix=" . $suffix);
3385 } elseif (!isFileReadable($FQFN)) {
3386 // Not readable so skip it
3387 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "File " . $FQFN . " is not readable!");
3391 // Is the file a PHP script or other?
3392 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
3393 if ((substr($baseFile, -4, 4) == '.php') || (($fileIncludeDirs === true) && (isDirectory($FQFN)))) {
3394 // Is this a valid include file?
3395 if ($extension == '.php') {
3396 // Remove both for extension name
3397 $extName = substr($baseFile, strlen($prefix), -4);
3399 // Is the extension valid and active?
3400 if (isExtensionNameValid($extName)) {
3401 // Then add this file
3402 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension entry ' . $baseFile . ' added.');
3403 $files[] = $fileName;
3405 // Add non-extension files as well
3406 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Regular entry ' . $baseFile . ' added.');
3407 if ($addBaseDir === true) {
3408 $files[] = $fileName;
3410 $files[] = $baseFile;
3414 // We found .php file but should not search for them, why?
3415 debug_report_bug(__FUNCTION__, __LINE__, 'We should find files with extension=' . $extension . ', but we found a PHP script.');
3417 } elseif (substr($baseFile, -4, 4) == $extension) {
3418 // Other, generic file found
3419 $files[] = $fileName;
3424 closedir($dirPointer);
3429 // Return array with include files
3430 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
3434 // Maps a module name into a database table name
3435 function mapModuleToTable ($moduleName) {
3436 // Map only these, still lame code...
3437 switch ($moduleName) {
3438 // 'index' is the guest's menu
3439 case 'index': $moduleName = 'guest'; break;
3440 // ... and 'login' the member's menu
3441 case 'login': $moduleName = 'member'; break;
3442 // Anything else will not be mapped, silently.
3449 // Add SQL debug data to array for later output
3450 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
3451 // Already executed?
3452 if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
3453 // Then abort here, we don't need to profile a query twice
3457 // Remeber this as profiled (or not, but we don't care here)
3458 $GLOBALS['debug_sqls'][$F][$L][$sqlString] = true;
3460 // Do we have cache?
3461 if (!isset($GLOBALS['debug_sql_available'])) {
3462 // Check it and cache it in $GLOBALS
3463 $GLOBALS['debug_sql_available'] = ((isConfigurationLoaded()) && (isExtensionInstalledAndNewer('other', '0.2.2')) && (getConfig('display_debug_sqls') == 'Y'));
3466 // Don't execute anything here if we don't need or ext-other is missing
3467 if ($GLOBALS['debug_sql_available'] === false) {
3473 'num_rows' => SQL_NUMROWS($result),
3474 'affected' => SQL_AFFECTEDROWS(),
3475 'sql_str' => $sqlString,
3476 'timing' => $timing,
3477 'file' => basename($F),
3482 $GLOBALS['debug_sqls'][] = $record;
3485 // Initializes the cache instance
3486 function initCacheInstance () {
3487 // Load include for CacheSystem class
3488 loadIncludeOnce('inc/classes/cachesystem.class.php');
3490 // Initialize cache system only when it's needed
3491 $GLOBALS['cache_instance'] = new CacheSystem();
3492 if ($GLOBALS['cache_instance']->getStatus() != 'done') {
3493 // Failed to initialize cache sustem
3494 addFatalMessage(__FUNCTION__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_CANNOT_INITIALIZE'));
3498 // Getter for message from array or raw message
3499 function getMessageFromIndexedArray ($message, $pos, $array) {
3500 // Check if the requested message was found in array
3501 if (isset($array[$pos])) {
3502 // ... if yes then use it!
3503 $ret = $array[$pos];
3505 // ... else use default message
3513 // Print code with line numbers
3514 function linenumberCode ($code) {
3515 if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
3516 $count_lines = count($codeE);
3518 $r = 'Line | Code:<br />';
3519 foreach($codeE as $line => $c) {
3520 $r .= '<div class="line"><span class="linenum">';
3521 if ($count_lines == 1) {
3524 $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
3529 $r .= '<span class="linetext">' . htmlentities($c) . '</span></div>';
3532 return '<div class="code">' . $r . '</div>';
3535 // Convert ';' to ', ' for e.g. receiver list
3536 function convertReceivers ($old) {
3537 return str_replace(';', ', ', $old);
3540 // Determines the right page title
3541 function determinePageTitle () {
3542 // Config and database connection valid?
3543 if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
3547 // Title decoration enabled?
3548 if ((getConfig('enable_title_deco') == 'Y') && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
3550 // Do we have some extra title?
3551 if (isExtraTitleSet()) {
3553 $TITLE .= getExtraTitle() . ' by ';
3557 $TITLE .= getConfig('MAIN_TITLE');
3559 // Add title of module? (middle decoration will also be added!)
3560 if ((getConfig('enable_mod_title') == 'Y') || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
3561 $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getModuleTitle(getModule());
3564 // Add title from what file
3566 if (getModule() == 'login') $mode = 'member';
3567 elseif (getModule() == 'index') $mode = 'guest';
3568 if ((!empty($mode)) && (getConfig('enable_what_title') == 'Y')) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
3570 // Add title decorations? (right)
3571 if ((getConfig('enable_title_deco') == 'Y') && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
3573 // Remember title in constant for the template
3574 $pageTitle = $TITLE;
3575 } elseif ((isInstalled()) && (isAdminRegistered())) {
3576 // Installed, admin registered but no ext-sql_patches
3577 $pageTitle = '[-- ' . getConfig('MAIN_TITLE') . ' - ' . getModuleTitle(getModule()) . ' --]';
3578 } elseif ((isInstalled()) && (!isAdminRegistered())) {
3579 // Installed but no admin registered
3580 $pageTitle = getMessage('SETUP_OF_MXCHANGE');
3581 } elseif ((!isInstalled()) || (!isAdminRegistered())) {
3582 // Installation mode
3583 $pageTitle = getMessage('INSTALLATION_OF_MXCHANGE');
3585 // Configuration not found!
3586 $pageTitle = getMessage('NO_CONFIG_FOUND_TITLE');
3588 // Do not add the fatal message in installation mode
3589 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, getMessage('NO_CONFIG_FOUND'));
3593 return decodeEntities($pageTitle);
3596 // Checks wethere there is a cache file there. This function is cached.
3597 function isTemplateCached ($template) {
3598 // Do we have cached this result?
3599 if (!isset($GLOBALS['template_cache'][$template])) {
3601 $FQFN = generateCacheFqfn($template);
3604 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
3608 return $GLOBALS['template_cache'][$template];
3611 // Flushes non-flushed template cache to disk
3612 function flushTemplateCache ($template, $eval) {
3613 // Is this cache flushed?
3614 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
3616 $FQFN = generateCacheFqfn($template);
3618 // Replace username with a call
3619 $eval = str_replace('$username', '".getUsername()."', $eval);
3622 writeToFile($FQFN, $eval, true);
3626 // Reads a template cache
3627 function readTemplateCache ($template) {
3629 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template))) {
3631 $FQFN = generateCacheFqfn($template);
3634 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
3638 return $GLOBALS['template_eval'][$template];
3641 // Escapes quotes (default is only double-quotes)
3642 function escapeQuotes ($str, $single = false) {
3643 // Should we escape all?
3644 if ($single === true) {
3645 // Escape all (including null)
3646 $str = addslashes($str);
3648 // Escape only double-quotes but prevent double-quoting
3649 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
3652 // Return the escaped string
3656 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
3657 function escapeJavaScriptQuotes ($str) {
3658 // Replace all double-quotes and secure back-ticks
3659 $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
3665 // Send out mails depending on the 'mod/modes' combination
3666 // @TODO Lame description for this function
3667 function sendModeMails ($mod, $modes) {
3669 if (fetchUserData(getMemberId())) {
3670 // Extract salt from cookie
3671 $salt = substr(getSession('u_hash'), 0, -40);
3673 // Now let's compare passwords
3674 $hash = encodeHashForCookie(getUserData('password'));
3676 // Does the hash match or should we change it?
3677 if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
3679 $content = getUserDataArray();
3682 $content['gender'] = translateGender($content['gender']);
3684 // Clear/init the content variable
3685 $content['message'] = '';
3688 // @TODO Move this in a filter
3691 foreach ($modes as $mode) {
3693 case 'normal': break; // Do not add any special lines
3694 case 'email': // Email was changed!
3695 $content['message'] = getMessage('MEMBER_CHANGED_EMAIL').": ".postRequestParameter('old_email')."\n";
3698 case 'pass': // Password was changed
3699 $content['message'] = getMessage('MEMBER_CHANGED_PASS')."\n";
3703 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
3704 $content['message'] = getMessage('MEMBER_UNKNOWN_MODE') . ': ' . $mode . "\n\n";
3709 if (isExtensionActive('country')) {
3710 // Replace code with description
3711 $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
3714 // Merge content with data from POST
3715 $content = merge_array($content, postRequestArray());
3718 $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
3720 if (getConfig('admin_notify') == 'Y') {
3721 // The admin needs to be notified about a profile change
3722 $message_admin = 'admin_mydata_notify';
3723 $sub_adm = getMessage('ADMIN_CHANGED_DATA');
3726 $message_admin = '';
3730 // Set subject lines
3731 $sub_mem = getMessage('MEMBER_CHANGED_DATA');
3733 // Output success message
3734 $content = '<span class="member_done">{--MYDATA_MAIL_SENT--}</span>';
3737 default: // Unsupported module!
3738 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
3739 $content = '<span class="member_failed">{--UNKNOWN_MODULE--}</span>';
3743 // Passwords mismatch
3744 $content = '<span class="member_failed">{--MEMBER_PASSWORD_ERROR--}</span>';
3747 // Could not load profile
3748 $content = '<span class="member_failed">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
3751 // Send email to user if required
3752 if ((!empty($sub_mem)) && (!empty($message))) {
3754 sendEmail($content['email'], $sub_mem, $message);
3757 // Send only if no other error has occured
3758 if (empty($content)) {
3759 if ((!empty($sub_adm)) && (!empty($message_admin))) {
3761 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
3762 } elseif (getConfig('admin_notify') == 'Y') {
3763 // Cannot send mails to admin!
3764 $content = getMessage('CANNOT_SEND_ADMIN_MAILS');
3767 $content = '<span class="member_done">{--MYDATA_MAIL_SENT--}</span>';
3772 loadTemplate('admin_settings_saved', false, $content);
3775 // Generates a 'selection box' from given array
3776 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
3778 $OUT = '<select name="' . $name . '" size="1" class="admin_select">
3779 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
3781 // Walk through all options
3782 foreach ($options as $option) {
3783 // Add the <option> entry
3784 if (empty($optionContent)) {
3785 // ... from template
3786 $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
3789 $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
3793 // Finish selection box
3794 $OUT .= '</select>';
3798 'selection_box' => $OUT,
3799 'module' => getModule(),
3803 // Load template and return it
3804 return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
3807 // Get a module from filename and access level
3808 function getModuleFromFileName ($file, $accessLevel) {
3809 // Default is 'invalid';
3810 $modCheck = 'invalid';
3812 // @TODO This is still very static, rewrite it somehow
3813 switch ($accessLevel) {
3815 $modCheck = 'admin';
3821 $modCheck = getModule();
3824 default: // Unsupported file name / access level
3825 debug_report_bug(__FUNCTION__, __LINE__, 'Unsupported file name=' . basename($file) . '/access level=' . $accessLevel);
3833 // Encodes an URL for adding session id, etc.
3834 function encodeUrl ($url, $outputMode = '0') {
3835 // Do we have already have a PHPSESSID inside or view.php is called? Then abort here
3836 if ((strpos($url, session_name()) !== false) || (getOutputMode() == -3)) return $url;
3838 // Do we have a valid session?
3839 if (((!isset($GLOBALS['valid_session'])) || ($GLOBALS['valid_session'] === false) || (!isset($_COOKIE[session_name()]))) && (isSpider() === false)) {
3841 // Determine right seperator
3842 $seperator = '&';
3843 if (strpos($url, '?') === false) {
3846 } elseif ((getOutputMode() != '0') || ($outputMode != '0')) {
3852 if (session_id() != '') {
3853 $url .= $seperator . session_name() . '=' . session_id();
3858 if ((substr($url, 0, strlen(getConfig('URL'))) != getConfig('URL')) && (substr($url, 0, 7) != '{?URL?}') && (substr($url, 0, 7) != 'http://') && (substr($url, 0, 8) != 'https://')) {
3860 $url = '{?URL?}/' . $url;
3867 // Simple check for spider
3868 function isSpider () {
3870 $userAgent = strtolower(detectUserAgent(true));
3872 // It should not be empty, if so it is better a spider/bot
3873 if (empty($userAgent)) return true;
3876 return ((strpos($userAgent, 'spider') !== false) || (strpos($userAgent, 'slurp') !== false) || (strpos($userAgent, 'bot') !== false) || (strpos($userAgent, 'archiver') !== false));
3879 // Prepares the header for HTML output
3880 function loadHtmlHeader () {
3882 // 1.) pre_page_header (mainly loads the page_header template and includes
3883 // meta description)
3884 runFilterChain('pre_page_header');
3886 // Here can be something be added, but normally one of the two filters
3887 // around this line should do the job for you.
3889 // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
3890 // to close the head-tag)
3891 // Include more header data here
3892 runFilterChain('post_page_header');
3895 // Adds page header and footer to output array element
3896 function addPageHeaderFooter () {
3900 // Add them all together. This is maybe to simple
3901 foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
3902 // Add page part if set
3903 if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
3906 // Transfer $OUT to 'output'
3907 $GLOBALS['output'] = $OUT;
3910 // Generates meta description for current module and 'what' value
3911 function generateMetaDescriptionCode () {
3912 // Only include from guest area and if sql_patches has correct version
3913 if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
3914 // Construct dynamic description
3915 $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
3917 // Output it directly
3918 $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
3922 unset($GLOBALS['ref_level']);
3925 // Generates an FQFN for template cache from the given template name
3926 function generateCacheFqfn ($template) {
3928 if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
3929 // Generate the FQFN
3930 $GLOBALS['template_cache_fqfn'][$template] = sprintf("%s_compiled/html/%s.tpl.cache", getConfig('CACHE_PATH'), $template);
3934 return $GLOBALS['template_cache_fqfn'][$template];
3937 // Function to search for the last modified file
3938 function searchDirsRecursive ($dir, &$last_changed, $lookFor = 'Date') {
3940 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir);
3941 // Does it match what we are looking for? (We skip a lot files already!)
3942 // RegexPattern to exclude ., .., .revision, .svn, debug.log or .cache in the filenames
3943 $excludePattern = '@(\.revision|\.svn|debug\.log|\.cache|config\.php)$@';
3945 $ds = getArrayFromDirectory($dir, '', false, true, array(), '.php', $excludePattern);
3946 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count(ds)='.count($ds));
3948 // Walk through all entries
3949 foreach ($ds as $d) {
3950 // Generate proper FQFN
3951 $FQFN = str_replace('//', '/', getConfig('PATH') . $dir . '/' . $d);
3953 // Is it a file and readable?
3954 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir . ',d=' . $d);
3955 if (isFileReadable($FQFN)) {
3956 // $FQFN is a readable file so extract the requested data from it
3957 $check = extractRevisionInfoFromFile($FQFN, $lookFor);
3958 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' found. check=' . $check);
3960 // Is the file more recent?
3961 if ((!isset($last_changed[$lookFor])) || ($last_changed[$lookFor] < $check)) {
3962 // This file is newer as the file before
3963 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'NEWER!');
3964 $last_changed['path_name'] = $FQFN;
3965 $last_changed[$lookFor] = $check;
3969 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' not readable or directory.');
3974 // "Fixes" null or empty string to count of dashes
3975 function fixNullEmptyToDashes ($str, $num) {
3976 // Use str as default
3980 if ((is_null($str)) || (trim($str) == '')) {
3982 $return = str_repeat('-', $num);
3985 // Return final string
3989 // Handles the braces [] of a field (e.g. value of 'name' attribute)
3990 function handleFieldWithBraces ($field) {
3991 // Are there braces [] at the end?
3992 if (substr($field, -2, 2) == '[]') {
3993 // Try to find one and replace it. I do it this way to allow easy
3994 // extending of this code.
3995 foreach (array('admin_list_builder_id_value') as $key) {
3996 // Is the cache entry set?
3997 if (isset($GLOBALS[$key])) {
3999 $field = str_replace('[]', '[' . $GLOBALS[$key] . ']', $field);
4011 //////////////////////////////////////////////////
4012 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
4013 //////////////////////////////////////////////////
4015 if (!function_exists('html_entity_decode')) {
4016 // Taken from documentation on www.php.net
4017 function html_entity_decode ($string) {
4018 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
4019 $trans_tbl = array_flip($trans_tbl);
4020 return strtr($string, $trans_tbl);
4024 if (!function_exists('http_build_query')) {
4025 // Taken from documentation on www.php.net, credits to Marco K. (Germany) and some light mods by R.Haeder
4026 function http_build_query($data, $prefix = '', $sep = '', $key = '') {
4028 foreach ((array)$data as $k => $v) {
4029 if (is_int($k) && $prefix != null) {
4030 $k = urlencode($prefix . $k);
4033 if ((!empty($key)) || ($key === 0)) $k = $key . '[' . urlencode($k) . ']';
4035 if (is_array($v) || is_object($v)) {
4036 array_push($ret, http_build_query($v, '', $sep, $k));
4038 array_push($ret, $k.'='.urlencode($v));
4042 if (empty($sep)) $sep = ini_get('arg_separator.output');
4044 return implode($sep, $ret);