2 /************************************************************************
3 * MXChange v0.2.1 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 - 2008 by Roland Haeder *
21 * For more information visit: http://www.mxchange.org *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the Free Software *
35 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
37 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40 $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
44 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
45 function OUTPUT_HTML ($HTML, $newLine = true) {
46 // Some global variables
49 // Do we have HTML-Code here?
51 // Yes, so we handle it as you have configured
52 switch (getConfig('OUTPUT_MODE'))
55 // That's why you don't need any \n at the end of your HTML code... :-)
56 if (constant('_OB_CACHING') == 'on') {
57 // Output into PHP's internal buffer
60 // That's why you don't need any \n at the end of your HTML code... :-)
61 if ($newLine) print("\n");
63 // Render mode for old or lame servers...
66 // That's why you don't need any \n at the end of your HTML code... :-)
67 if ($newLine) $OUTPUT .= "\n";
72 // If we are switching from render to direct output rendered code
73 if ((!empty($OUTPUT)) && (constant('_OB_CACHING') != 'on')) { outputRawCode($OUTPUT); $OUTPUT = ''; }
75 // The same as above... ^
77 if ($newLine) print("\n");
81 // Huh, something goes wrong or maybe you have edited config.php ???
82 app_die(__FUNCTION__, __LINE__, "<strong>{--FATAL_ERROR--}:</strong> {--LANG_NO_RENDER_DIRECT--}");
85 } elseif ((constant('_OB_CACHING') == 'on') && (isset($GLOBALS['footer_sent'])) && ($GLOBALS['footer_sent'] == 1)) {
86 // Headers already sent?
89 DEBUG_LOG(__FUNCTION__, __LINE__, "Headers already sent! We need debug backtrace here.");
91 // Trigger an user error
92 debug_report_bug("Headers are already sent!");
95 // Output cached HTML code
96 $OUTPUT = ob_get_contents();
98 // Clear output buffer for later output if output is found
99 if (!empty($OUTPUT)) {
104 sendHeader('HTTP/1.1 200');
107 $now = gmdate('D, d M Y H:i:s') . ' GMT';
109 // General headers for no caching
110 sendHeader('Expired: ' . $now); // RFC2616 - Section 14.21
111 sendHeader('Last-Modified: ' . $now);
112 sendHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
113 sendHeader('Pragma: no-cache'); // HTTP/1.0
114 sendHeader('Connection: Close');
116 // Extension 'rewrite' installed?
117 if ((EXT_IS_ACTIVE('rewrite')) && (getOutputMode() != '1') && (getOutputMode() != '-1')) {
118 $OUTPUT = rewriteLinksInCode($OUTPUT);
121 // Compile and run finished rendered HTML code
122 while (strpos($OUTPUT, '{!') > 0) {
123 // Replace _MYSQL_PREFIX
124 $OUTPUT = str_replace("{!_MYSQL_PREFIX!}", getConfig('_MYSQL_PREFIX'), $OUTPUT);
126 // Prepare the content and eval() it...
128 $eval = "\$newContent = \"".COMPILE_CODE(smartAddSlashes($OUTPUT))."\";";
131 // Was that eval okay?
132 if (empty($newContent)) {
133 // Something went wrong!
134 app_die(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . htmlentities($eval) . '</pre>');
136 $OUTPUT = $newContent;
139 // Output code here, DO NOT REMOVE! ;-)
140 outputRawCode($OUTPUT);
141 } elseif ((getConfig('OUTPUT_MODE') == 'render') && (!empty($OUTPUT))) {
142 // Rewrite links when rewrite extension is active
143 if ((EXT_IS_ACTIVE('rewrite')) && (getOutputMode() != '1') && (getOutputMode() != '-1')) {
144 $OUTPUT = rewriteLinksInCode($OUTPUT);
147 // Compile and run finished rendered HTML code
148 while (strpos($OUTPUT, '{!') > 0) {
149 $eval = "\$OUTPUT = \"".COMPILE_CODE(smartAddSlashes($OUTPUT))."\";";
153 // Output code here, DO NOT REMOVE! ;-)
154 outputRawCode($OUTPUT);
158 // Output the raw HTML code
159 function outputRawCode ($HTML) {
160 // Output stripped HTML code to avoid broken JavaScript code, etc.
161 print(stripslashes(stripslashes($HTML)));
163 // Flush the output if only constant('_OB_CACHING') is not 'on'
164 if (constant('_OB_CACHING') != 'on') {
170 // Init fatal message array
171 function initFatalMessages () {
172 $GLOBALS['fatal_messages'] = array();
175 // Getter for whole fatal error messages
176 function getFatalArray () {
177 return $GLOBALS['fatal_messages'];
180 // Add a fatal error message to the queue array
181 function addFatalMessage ($F, $L, $message, $extra='') {
182 if (is_array($extra)) {
183 // Multiple extras for a message with masks
184 $message = call_user_func_array('sprintf', $extra);
185 } elseif (!empty($extra)) {
186 // $message is text with a mask plus extras to insert into the text
187 $message = sprintf($message, $extra);
190 // Add message to $GLOBALS['fatal_messages']
191 $GLOBALS['fatal_messages'][] = $message;
193 // Log fatal messages away
194 DEBUG_LOG($F, $L, " message={$message}");
197 // Getter for total fatal message count
198 function getTotalFatalErrors () {
202 // Do we have at least the first entry?
203 if (!empty($GLOBALS['fatal_messages'][0])) {
205 $count = count($GLOBALS['fatal_messages']);
212 // Load a template file and return it's content (only it's name; do not use ' or ")
213 function LOAD_TEMPLATE ($template, $return=false, $content=array()) {
214 // @TODO Remove this sanity-check if all is fine
215 if (!is_bool($return)) debug_report_bug('return is not bool (' . gettype($return) . ')');
217 // Add more variables which you want to use in your template files
218 global $DATA, $username;
220 // Get whole config array
221 $_CONFIG = getConfigArray();
223 // Make all template names lowercase
224 $template = strtolower($template);
226 // Count the template load
227 incrementConfigEntry('num_templates');
229 // Prepare IP number and User Agent
230 $REMOTE_ADDR = detectRemoteAddr();
231 if (!defined('REMOTE_ADDR')) define('REMOTE_ADDR', $REMOTE_ADDR);
232 $HTTP_USER_AGENT = detectUserAgent();
236 if (empty($GLOBALS['refid'])) $GLOBALS['refid'] = 0;
238 // @DEPRECATED Try to rewrite the if() condition
239 if ($template == 'member_support_form') {
240 // Support request of a member
241 $result = SQL_QUERY_ESC("SELECT `userid`, `gender`, `surname`, `family`, `email` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
242 array(getUserId()), __FUNCTION__, __LINE__);
244 // Is content an array?
245 if (is_array($content)) {
247 $content = merge_array($content, SQL_FETCHARRAY($result));
250 $content['gender'] = translateGender($content['gender']);
253 // @TODO Find all templates which are using these direct variables and rewrite them.
254 // @TODO After this step is done, this else-block is history
255 list($gender, $surname, $family, $email) = SQL_FETCHROW($result);
258 $gender = translateGender($gender);
259 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("DEPRECATION-WARNING: content is not array [%s], template=%s.", gettype($content), $template));
263 SQL_FREERESULT($result);
266 // Generate date/time string
267 $date_time = generateDateTime(time(), '1');
270 $basePath = sprintf("%stemplates/%s/html/", constant('PATH'), getLanguage());
273 // Check for admin/guest/member templates
274 if (strpos($template, 'admin_') > -1) {
275 // Admin template found
277 } elseif (strpos($template, 'guest_') > -1) {
278 // Guest template found
280 } elseif (strpos($template, 'member_') > -1) {
281 // Member template found
283 } elseif (strpos($template, 'install_') > -1) {
284 // Installation template found
286 } elseif (strpos($template, 'ext_') > -1) {
287 // Extension template found
289 } elseif (strpos($template, 'la_') > -1) {
290 // 'Logical-area' template found
292 } elseif (strpos($template, 'js_') > -1) {
293 // JavaScript template found
296 // Test for extension
297 $test = substr($template, 0, strpos($template, '_'));
298 if (EXT_IS_ACTIVE($test)) {
299 // Set extra path to extension's name
304 ////////////////////////
305 // Generate file name //
306 ////////////////////////
307 $FQFN = $basePath . $mode . $template . '.tpl';
309 if ((isWhatSet()) && ((strpos($template, '_header') > 0) || (strpos($template, '_footer') > 0)) && (($mode == 'guest/') || ($mode == 'member/') || ($mode == 'admin/'))) {
310 // Select what depended header/footer template file for admin/guest/member area
311 $file2 = sprintf("%s%s%s_%s.tpl",
319 if (isFileReadable($file2)) $FQFN = $file2;
321 // Remove variable from memory
325 // Does the special template exists?
326 if (!isFileReadable($FQFN)) {
327 // Reset to default template
328 $FQFN = $basePath . $template . '.tpl';
331 // Now does the final template exists?
332 if (isFileReadable($FQFN)) {
333 // The local file does exists so we load it. :)
334 $tmpl_file = readFromFile($FQFN);
336 // Replace ' to our own chars to preventing them being quoted
337 while (strpos($tmpl_file, "'") !== false) { $tmpl_file = str_replace("'", '{QUOT}', $tmpl_file); }
339 // Do we have to compile the code?
341 if ((strpos($tmpl_file, "\$") !== false) || (strpos($tmpl_file, '{--') !== false) || (strpos($tmpl_file, '--}') > 0)) {
343 $tmpl_file = "\$ret=\"".COMPILE_CODE(smartAddSlashes($tmpl_file))."\";";
346 // Simply return loaded code
350 // Normal HTML output?
351 if ($GLOBALS['output_mode'] == 0) {
352 // Add surrounding HTML comments to help finding bugs faster
353 $ret = "<!-- Template " . $template . " - Start -->\n" . $ret . "<!-- Template " . $template . " - End -->\n";
355 } elseif ((IS_ADMIN()) || ((isInstalling()) && (!isInstalled()))) {
356 // Only admins shall see this warning or when installation mode is active
357 $ret = "<br /><span class=\"guest_failed\">{--TEMPLATE_404--}</span><br />
358 (".basename($FQFN).")<br />
360 {--TEMPLATE_CONTENT--}
361 <pre>".print_r($content, true)."</pre>
363 <pre>".print_r($DATA, true)."</pre>
367 // Remove content and data
371 // Do we have some content to output or return?
373 // Not empty so let's put it out! ;)
374 if ($return === true) {
375 // Return the HTML code
381 } elseif (isDebugModeEnabled()) {
382 // Warning, empty output!
383 return "E:" . $template."<br />\n";
387 // Send mail out to an email address
388 function sendEmail ($toEmail, $subject, $message, $HTML = 'N', $mailHeader = '') {
389 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$toEmail},SUBJECT={$subject}<br />");
391 // Compile subject line (for POINTS constant etc.)
392 $eval = "\$subject = decodeEntities(\"".COMPILE_CODE(smartAddSlashes($subject))."\");";
396 if ((!eregi('@', $toEmail)) && ($toEmail > 0)) {
397 // Value detected, is the message extension installed?
398 // @TODO Extension 'msg' does not exist
399 if (EXT_IS_ACTIVE('msg')) {
400 ADD_MESSAGE_TO_BOX($toEmail, $subject, $message, $HTML);
403 // Load email address
404 $result_email = SQL_QUERY_ESC("SELECT `email` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
405 array(bigintval($toEmail)), __FUNCTION__, __LINE__);
406 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):numRows=".SQL_NUMROWS($result_email)."<br />");
408 // Does the user exist?
409 if (SQL_NUMROWS($result_email)) {
410 // Load email address
411 list($toEmail) = SQL_FETCHROW($result_email);
414 $toEmail = constant('WEBMASTER');
418 SQL_FREERESULT($result_email);
420 } elseif ($toEmail == '0') {
422 $toEmail = constant('WEBMASTER');
424 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$toEmail}<br />");
426 // Check for PHPMailer or debug-mode
427 if (!checkPhpMailerUsage()) {
428 // Not in PHPMailer-Mode
429 if (empty($mailHeader)) {
430 // Load email header template
431 $mailHeader = LOAD_EMAIL_TEMPLATE('header');
434 $mailHeader .= LOAD_EMAIL_TEMPLATE('header');
436 } elseif (isDebugModeEnabled()) {
437 if (empty($mailHeader)) {
438 // Load email header template
439 $mailHeader = LOAD_EMAIL_TEMPLATE('header');
442 $mailHeader .= LOAD_EMAIL_TEMPLATE('header');
447 $eval = "\$toEmail = \"".COMPILE_CODE(smartAddSlashes($toEmail))."\";";
451 $eval = "\$message = \"".COMPILE_CODE(smartAddSlashes($message))."\";";
454 // Fix HTML parameter (default is no!)
455 if (empty($HTML)) $HTML = 'N';
456 if (isDebugModeEnabled()) {
457 // In debug mode we want to display the mail instead of sending it away so we can debug this part
459 ".htmlentities(trim($mailHeader))."
461 Subject : " . $subject."
462 Message : " . $message."
464 } elseif (($HTML == 'Y') && (EXT_IS_ACTIVE('html_mail'))) {
465 // Send mail as HTML away
466 sendHtmlEmail($toEmail, $subject, $message, $mailHeader);
467 } elseif (!empty($toEmail)) {
469 sendRawEmail($toEmail, $subject, $message, $mailHeader);
470 } elseif ($HTML == 'N') {
472 sendRawEmail(constant('WEBMASTER'), '[PROBLEM:]' . $subject, $message, $mailHeader);
476 // Check if legacy or PHPMailer command
477 // @TODO Rewrite this to an extension 'smtp'
479 function checkPhpMailerUsage() {
480 return ((getConfig('SMTP_HOSTNAME') != '') && (getConfig('SMTP_USER') != ''));
483 // Send out a raw email with PHPMailer class or legacy mail() command
484 function sendRawEmail ($toEmail, $subject, $message, $from) {
485 // Shall we use PHPMailer class or legacy mode?
486 if (checkPhpMailerUsage()) {
487 // Use PHPMailer class with SMTP enabled
488 loadIncludeOnce('inc/phpmailer/class.phpmailer.php');
489 loadIncludeOnce('inc/phpmailer/class.smtp.php');
492 $mail = new PHPMailer();
493 $mail->PluginDir = sprintf("%sinc/phpmailer/", constant('PATH'));
496 $mail->SMTPAuth = true;
497 $mail->Host = getConfig('SMTP_HOSTNAME');
499 $mail->Username = getConfig('SMTP_USER');
500 $mail->Password = getConfig('SMTP_PASSWORD');
502 $mail->From = constant('WEBMASTER');
506 $mail->FromName = constant('MAIN_TITLE');
507 $mail->Subject = $subject;
508 if ((EXT_IS_ACTIVE('html_mail')) && (strip_tags($message) != $message)) {
509 $mail->Body = $message;
510 $mail->AltBody = 'Your mail program required HTML support to read this mail!';
511 $mail->WordWrap = 70;
514 $mail->Body = decodeEntities($message);
516 $mail->AddAddress($toEmail, '');
517 $mail->AddReplyTo(constant('WEBMASTER'), constant('MAIN_TITLE'));
518 $mail->AddCustomHeader('Errors-To:' . constant('WEBMASTER'));
519 $mail->AddCustomHeader('X-Loop:' . constant('WEBMASTER'));
522 // Use legacy mail() command
523 mail($toEmail, $subject, decodeEntities($message), $from);
527 // Generate a password in a specified length or use default password length
528 function generatePassword ($length = 0) {
529 // Auto-fix invalid length of zero
530 if ($length == 0) $length = getConfig('pass_len');
532 // Initialize array with all allowed chars
533 $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,-,+,_,/,.');
535 // Start creating password
537 for ($i = 0; $i < $length; $i++) {
538 $PASS .= $ABC[mt_rand(0, count($ABC) -1)];
541 // When the size is below 40 we can also add additional security by scrambling
542 // it. Otherwise we may corrupt hashes
543 if (strlen($PASS) <= 40) {
544 // Also scramble the password
545 $PASS = scrambleString($PASS);
548 // Return the password
552 // Generates a human-readable timestamp from the Uni* stamp
553 function generateDateTime ($time, $mode = '0') {
554 // Filter out numbers
555 $time = bigintval($time);
557 // If the stamp is zero it mostly didn't "happen"
560 return getMessage('NEVER_HAPPENED');
563 switch (getLanguage())
565 case 'de': // German date / time format
567 case '0': $ret = date("d.m.Y \u\m H:i \U\h\\r", $time); break;
568 case '1': $ret = strtolower(date("d.m.Y - H:i", $time)); break;
569 case '2': $ret = date("d.m.Y|H:i", $time); break;
570 case '3': $ret = date("d.m.Y", $time); break;
572 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
577 default: // Default is the US date / time format!
579 case '0': $ret = date("r", $time); break;
580 case '1': $ret = date("Y-m-d - g:i A", $time); break;
581 case '2': $ret = date("y-m-d|H:i", $time); break;
582 case '3': $ret = date("y-m-d", $time); break;
584 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
591 // Translates Y/N to yes/no
592 function translateYesNo ($yn) {
594 $translated = "??? (" . $yn.')';
596 case 'Y': $translated = getMessage('YES'); break;
597 case 'N': $translated = getMessage('NO'); break;
600 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected Y/N!", $yn));
608 // Translates the "pool type" into human-readable
609 function translatePoolType ($type) {
610 // Default?type is unknown
611 $translated = sprintf(getMessage('POOL_TYPE_UNKNOWN'), $type);
614 $constName = sprintf("POOL_TYPE_%s", $type);
617 if (defined($constName)) {
619 $translated = getMessage($constName);
622 // Return "translation"
626 // Translates the american decimal dot into a german comma
627 function translateComma ($dotted, $cut = true, $max = 0) {
628 // Default is 3 you can change this in admin area "Misc -> Misc Options"
629 if (!isConfigEntrySet('max_comma')) setConfigEntry('max_comma', '3');
631 // Use from config is default
632 $maxComma = getConfig('max_comma');
634 // Use from parameter?
635 if ($max > 0) $maxComma = $max;
638 if (($cut) && ($max == 0)) {
639 // Test for commata if in cut-mode
640 $com = explode('.', $dotted);
641 if (count($com) < 2) {
642 // Don't display commatas even if there are none... ;-)
648 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "dotted={$dotted},maxComma={$maxComma}");
651 switch (getLanguage()) {
653 $dotted = number_format($dotted, $maxComma, ',', '.');
657 $dotted = number_format($dotted, $maxComma, '.', ',');
661 // Return translated value
665 // Translate Uni*-like gender to human-readable
666 function translateGender ($gender) {
668 $ret = '!' . $gender . '!';
670 // Male/female or company?
672 case 'M': $ret = getMessage('GENDER_M'); break;
673 case 'F': $ret = getMessage('GENDER_F'); break;
674 case 'C': $ret = getMessage('GENDER_C'); break;
676 // Log unknown gender
677 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
681 // Return translated gender
685 // "Translates" the user status
686 function translateUserStatus ($status) {
692 $ret = getMessage(sprintf("ACCOUNT_%s", $status));
697 $ret = getMessage('ACCOUNT_DELETED');
701 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
702 $ret = sprintf(getMessage('UNKNOWN_STATUS'), $status);
710 // Generates an URL for the dereferer
711 function DEREFERER ($URL) {
712 // Don't de-refer our own links!
713 if (substr($URL, 0, strlen(constant('URL'))) != constant('URL')) {
714 // De-refer this link
715 $URL = 'modules.php?module=loader&url=' . encodeString(compileUriCode($URL));
722 // Generates an URL for the frametester
723 function FRAMETESTER ($URL) {
724 // Prepare frametester URL
725 $frametesterUrl = sprintf("{!URL!}/modules.php?module=frametester&url=%s",
726 encodeString(compileUriCode($URL))
728 return $frametesterUrl;
731 // Count entries from e.g. a selection box
732 function countSelection ($array) {
734 if (is_array($array)) {
735 foreach ($array as $key => $selected) {
736 if (!empty($selected)) $ret++;
742 // Generate XHTML code for the CAPTCHA
743 function generateCaptchaCode ($code, $type, $DATA, $uid) {
744 return '<IMG border="0" alt="Code" src="{!URL!}/mailid_top.php?uid=' . $uid . '&' . $type . '=' . $DATA . '&mode=img&code=' . $code . '" />';
747 // Loads an email template and compiles it
748 function LOAD_EMAIL_TEMPLATE ($template, $content = array(), $UID = '0') {
751 // Our configuration is kept non-global here
752 $_CONFIG = getConfigArray();
754 // Make sure all template names are lowercase!
755 $template = strtolower($template);
757 // Default 'nickname' if extension is not installed
760 // Prepare IP number and User Agent
761 $REMOTE_ADDR = detectRemoteAddr();
762 $HTTP_USER_AGENT = detectUserAgent();
765 $ADMIN = constant('MAIN_TITLE');
767 // Is the admin logged in?
770 $aid = getCurrentAdminId();
773 $ADMIN = getAdminEmail($aid);
776 // Neutral email address is default
777 $email = constant('WEBMASTER');
779 // Expiration in a nice output format
780 // NOTE: Use $content[expiration] in your templates instead of $EXPIRATION
781 if (getConfig('auto_purge') == 0) {
782 // Will never expire!
783 $EXPIRATION = getMessage('MAIL_WILL_NEVER_EXPIRE');
785 // Create nice date string
786 $EXPIRATION = createFancyTime(getConfig('auto_purge'));
789 // Is content an array?
790 if (is_array($content)) {
791 // Add expiration to array, $EXPIRATION is now deprecated!
792 $content['expiration'] = $EXPIRATION;
796 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):UID={$UID},template={$template},content[]=".gettype($content)."<br />");
797 if (($UID > 0) && (is_array($content))) {
798 // If nickname extension is installed, fetch nickname as well
799 if (EXT_IS_ACTIVE('nickname')) {
800 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):NICKNAME!<br />");
802 $result = SQL_QUERY_ESC("SELECT `surname`, `family`, `gender`, `email`, `nickname` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
803 array(bigintval($UID)), __FUNCTION__, __LINE__);
805 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):NO-NICK!<br />");
807 $result = SQL_QUERY_ESC("SELECT `surname`, `family`, `gender`, `email` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
808 array(bigintval($UID)), __FUNCTION__, __LINE__);
811 // Fetch and merge data
812 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):content()=".count($content)." - PRE<br />");
813 $content = merge_array($content, SQL_FETCHARRAY($result));
814 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):content()=".count($content)." - AFTER<br />");
817 SQL_FREERESULT($result);
820 // Translate M to male or F to female if present
821 if (isset($content['gender'])) $content['gender'] = translateGender($content['gender']);
823 // Overwrite email from data if present
824 if (isset($content['email'])) $email = $content['email'];
826 // Store email for some functions in global data array
827 $DATA['email'] = $email;
830 $basePath = sprintf("%stemplates/%s/emails/", constant('PATH'), getLanguage());
832 // Check for admin/guest/member templates
833 if (strpos($template, 'admin_') > -1) {
834 // Admin template found
835 $FQFN = $basePath.'admin/' . $template.'.tpl';
836 } elseif (strpos($template, 'guest_') > -1) {
837 // Guest template found
838 $FQFN = $basePath.'guest/' . $template.'.tpl';
839 } elseif (strpos($template, 'member_') > -1) {
840 // Member template found
841 $FQFN = $basePath.'member/' . $template.'.tpl';
843 // Test for extension
844 $test = substr($template, 0, strpos($template, '_'));
845 if (EXT_IS_ACTIVE($test)) {
846 // Set extra path to extension's name
847 $FQFN = $basePath . $test.'/' . $template.'.tpl';
849 // No special filename
850 $FQFN = $basePath . $template.'.tpl';
854 // Does the special template exists?
855 if (!isFileReadable($FQFN)) {
856 // Reset to default template
857 $FQFN = $basePath . $template.'.tpl';
860 // Now does the final template exists?
862 if (isFileReadable($FQFN)) {
863 // The local file does exists so we load it. :)
864 $tmpl_file = readFromFile($FQFN);
865 $tmpl_file = SQL_ESCAPE($tmpl_file);
868 $tmpl_file = "\$newContent = decodeEntities(\"".COMPILE_CODE($tmpl_file)."\");";
870 } elseif (!empty($template)) {
871 // Template file not found!
872 $newContent = "{--TEMPLATE_404--}: " . $template."<br />
873 {--TEMPLATE_CONTENT--}
874 <pre>".print_r($content, true)."</pre>
876 <pre>".print_r($DATA, true)."</pre>
879 // Debug mode not active? Then remove the HTML tags
880 if (!isDebugModeEnabled()) $newContent = strip_tags($newContent);
882 // No template name supplied!
883 $newContent = getMessage('NO_TEMPLATE_SUPPLIED');
886 // Is there some content?
887 if (empty($newContent)) {
889 $newContent = "Compiler error for template {$template}!\nUncompiled content:\n" . $tmpl_file;
890 // Add last error if the required function exists
891 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
894 // Remove content and data
898 // Return compiled content
899 return COMPILE_CODE($newContent);
902 // Generates a timestamp (some wrapper for mktime())
903 function makeTime ($H, $M, $S, $stamp) {
904 // Extract day, month and year from given timestamp
905 $day = date('d', $stamp);
906 $month = date('m', $stamp);
907 $year = date('Y', $stamp);
909 // Create timestamp for wished time which depends on extracted date
910 return mktime($H, $M, $S, $month, $day, $year);
913 // Redirects to an URL and if neccessarry extends it with own base URL
914 function redirectToUrl ($URL) {
915 // Compile out URI codes
916 $URL = compileUriCode($URL);
918 // Check if http(s):// is there
919 if ((substr($URL, 0, 7) != 'http://') && (substr($URL, 0, 8) != 'https://')) {
920 // Make all URLs full-qualified
921 $URL = constant('URL') . '/' . $URL;
924 // Three different debug ways...
925 //* DEBUG: */ debug_report_bug(sprintf("%s[%s:] URL=%s", __FUNCTION__, __LINE__, $URL));
926 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, $URL);
927 //* DEBUG: */ die($URL);
929 // Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
930 $rel = ' rel="external"';
932 // Do we have internal or external URL?
933 if (substr($URL, 0, strlen(constant('URL'))) == constant('URL')) {
934 // Own (=internal) URL
939 $OUTPUT = ob_get_contents();
941 // Clear it only if there is content
942 if (!empty($OUTPUT)) {
946 // Simple probe for bots/spiders from search engines
947 if ((strpos(detectUserAgent(), 'spider') !== false) || (strpos(detectUserAgent(), 'bot') !== false)) {
948 // Secure the URL against bad things such als HTML insertions and so on...
949 $URL = htmlentities(strip_tags($URL), ENT_QUOTES);
951 // Output new location link as anchor
952 OUTPUT_HTML('<a href="' . $URL . '"' . $rel . '>' . $URL . '</a>');
953 } elseif (!headers_sent()) {
954 // Load URL when headers are not sent
955 //* DEBUG: */ debug_report_bug("URL={$URL}");
956 sendHeader('Location: '.str_replace('&', '&', $URL));
958 // Output error message
959 loadInclude('inc/header.php');
960 LOAD_TEMPLATE('redirect_url', false, str_replace('&', '&', $URL));
961 loadInclude('inc/footer.php');
964 // Shut the mailer down here
968 // Wrapper for redirectToUrl but URL comes from a configuration entry
969 function redirectToConfiguredUrl ($configEntry) {
971 $URL = getConfig($configEntry);
976 trigger_error(sprintf("Configuration entry %s is not set!", $configEntry));
984 function COMPILE_CODE ($code, $simple = false, $constants = true, $full = true) {
985 // Is the code a string?
986 if (!is_string($code)) {
987 // Silently return it
991 // Init replacement-array with full security characters
992 $secChars = $GLOBALS['security_chars'];
994 // Select smaller set of chars to replace when we e.g. want to compile URLs
995 if (!$full) $secChars = $GLOBALS['url_chars'];
998 if ($constants === true) {
999 // BEFORE 0.2.1 : Language and data constants
1000 // WITH 0.2.1+ : Only language constants
1001 $code = str_replace('{--','".', str_replace('--}','."', $code));
1003 // BEFORE 0.2.1 : Not used
1004 // WITH 0.2.1+ : Data constants
1005 $code = str_replace('{!','".', str_replace("!}", '."', $code));
1008 // Compile QUOT and other non-HTML codes
1009 foreach ($secChars['to'] as $k => $to) {
1010 // Do the reversed thing as in inc/libs/security_functions.php
1011 $code = str_replace($to, $secChars['from'][$k], $code);
1014 // But shall I keep simple quotes for later use?
1015 if ($simple) $code = str_replace("'", '{QUOT}', $code);
1017 // Find $content[bla][blub] entries
1018 preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
1020 // Are some matches found?
1021 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
1022 // Replace all matches
1023 $matchesFound = array();
1024 foreach ($matches[0] as $key => $match) {
1025 // Fuzzy look has failed by default
1026 $fuzzyFound = false;
1028 // Fuzzy look on match if already found
1029 foreach ($matchesFound as $found => $set) {
1031 $test = substr($found, 0, strlen($match));
1033 // Does this entry exist?
1034 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):found={$found},match={$match},set={$set}<br />");
1035 if ($test == $match) {
1037 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):fuzzyFound!<br />");
1044 if ($fuzzyFound) continue;
1046 // Take all string elements
1047 if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key."_" . $matches[4][$key]]))) {
1048 // Replace it in the code
1049 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):key={$key},match={$match}<br />");
1050 $newMatch = str_replace("[" . $matches[4][$key]."]", "['" . $matches[4][$key]."']", $match);
1051 $code = str_replace($match, "\"." . $newMatch.".\"", $code);
1052 $matchesFound[$key."_" . $matches[4][$key]] = 1;
1053 $matchesFound[$match] = 1;
1054 } elseif (!isset($matchesFound[$match])) {
1055 // Not yet replaced!
1056 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):match={$match}<br />");
1057 $code = str_replace($match, "\"." . $match.".\"", $code);
1058 $matchesFound[$match] = 1;
1063 // Return compiled code
1067 /************************************************************************
1069 * Gaenderter Sortier-Algorythmus, $array wird nach dem Array (!) *
1070 * $a_sort sortiert: *
1072 * $array - Das 3-dimensionale Array, das paralell sortiert werden soll *
1073 * $a_sort - Array, das die Sortiereihenfolge der ersten Elementeben *
1074 * $primary_key - Prim.rschl.ssel aus $a_sort, nach dem sortiert wird *
1075 * $order - Sortiereihenfolge: -1 = a-Z, 0 = keine, 1 = Z-a *
1076 * $nums - true = Als Zahlen sortieren, false = Als Zeichen sortieren *
1078 * $a_sort muss Elemente enthalten, deren Wert Schluessel von $array *
1079 * sind... Klingt kompliziert, suchen Sie mal mein Beispiel, dann sehen *
1080 * Sie, dass es doch nicht so schwer ist! :-) *
1082 ************************************************************************/
1083 function array_pk_sort (&$array, $a_sort, $primary_key = 0, $order = -1, $nums = false) {
1085 while ($primary_key < count($a_sort)) {
1086 foreach ($dummy[$a_sort[$primary_key]] as $key => $value) {
1087 foreach ($dummy[$a_sort[$primary_key]] as $key2 => $value2) {
1090 // Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
1091 if (($key != $key2) && (strcmp(strtolower($dummy[$a_sort[$primary_key]][$key]), strtolower($dummy[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
1092 } elseif ($key != $key2) {
1093 // Sort numbers (E.g.: 9 < 10)
1094 if (($dummy[$a_sort[$primary_key]][$key] < $dummy[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
1095 if (($dummy[$a_sort[$primary_key]][$key] > $dummy[$a_sort[$primary_key]][$key2]) && ($order == 1)) $match = true;
1099 // We have found two different values, so let's sort whole array
1100 foreach ($dummy as $sort_key => $sort_val) {
1101 $t = $dummy[$sort_key][$key];
1102 $dummy[$sort_key][$key] = $dummy[$sort_key][$key2];
1103 $dummy[$sort_key][$key2] = $t;
1114 // Write back sorted array
1119 function ADD_SELECTION ($type, $default, $prefix = '', $id = '0') {
1122 if ($type == 'yn') {
1123 // This is a yes/no selection only!
1124 if ($id > 0) $prefix .= "[" . $id."]";
1125 $OUT .= " <select name=\"" . $prefix."\" class=\"register_select\" size=\"1\">\n";
1127 // Begin with regular selection box here
1128 if (!empty($prefix)) $prefix .= "_";
1130 if ($id > 0) $type2 .= "[" . $id."]";
1131 $OUT .= " <select name=\"".strtolower($prefix . $type2)."\" class=\"register_select\" size=\"1\">\n";
1136 for ($idx = 1; $idx < 32; $idx++) {
1137 $OUT .= "<option value=\"" . $idx."\"";
1138 if ($default == $idx) $OUT .= ' selected="selected"';
1139 $OUT .= ">" . $idx."</option>\n";
1143 case "month": // Month
1144 foreach ($GLOBALS['month_descr'] as $month => $descr) {
1145 $OUT .= "<option value=\"" . $month."\"";
1146 if ($default == $month) $OUT .= ' selected="selected"';
1147 $OUT .= ">" . $descr."</option>\n";
1151 case "year": // Year
1153 $year = date('Y', time());
1155 // Use configured min age or fixed?
1156 if (GET_EXT_VERSION('other') >= '0.2.1') {
1158 $startYear = $year - getConfig('min_age');
1161 $startYear = $year - 16;
1164 // Calculate earliest year (100 years old people can still enter Internet???)
1165 $minYear = $year - 100;
1167 // Check if the default value is larger than minimum and bigger than actual year
1168 if (($default > $minYear) && ($default >= $year)) {
1169 for ($idx = $year; $idx < ($year + 11); $idx++) {
1170 $OUT .= "<option value=\"" . $idx."\"";
1171 if ($default == $idx) $OUT .= ' selected="selected"';
1172 $OUT .= ">" . $idx."</option>\n";
1174 } elseif ($default == -1) {
1175 // Current year minus 1
1176 for ($idx = $startYear; $idx <= ($year + 1); $idx++)
1178 $OUT .= "<option value=\"" . $idx."\">" . $idx."</option>\n";
1181 // Get current year and subtract the configured minimum age
1182 $OUT .= "<option value=\"".($minYear - 1)."\"><" . $minYear."</option>\n";
1183 // Calculate earliest year depending on extension version
1184 if (GET_EXT_VERSION('other') >= '0.2.1') {
1185 // Use configured minimum age
1186 $year = date('Y', time()) - getConfig('min_age');
1188 // Use fixed 16 years age
1189 $year = date('Y', time()) - 16;
1192 // Construct year selection list
1193 for ($idx = $minYear; $idx <= $year; $idx++) {
1194 $OUT .= "<option value=\"" . $idx."\"";
1195 if ($default == $idx) $OUT .= ' selected="selected"';
1196 $OUT .= ">" . $idx."</option>\n";
1203 for ($idx = 0; $idx < 60; $idx+=5) {
1204 if (strlen($idx) == 1) $idx = '0' . $idx;
1205 $OUT .= "<option value=\"" . $idx."\"";
1206 if ($default == $idx) $OUT .= ' selected="selected"';
1207 $OUT .= ">" . $idx."</option>\n";
1212 for ($idx = 0; $idx < 24; $idx++) {
1213 if (strlen($idx) == 1) $idx = '0' . $idx;
1214 $OUT .= "<option value=\"" . $idx."\"";
1215 if ($default == $idx) $OUT .= ' selected="selected"';
1216 $OUT .= ">" . $idx."</option>\n";
1221 $OUT .= "<option value=\"Y\"";
1222 if ($default == 'Y') $OUT .= ' selected="selected"';
1223 $OUT .= ">{--YES--}</option>\n<option value=\"N\"";
1224 if ($default == 'N') $OUT .= ' selected="selected"';
1225 $OUT .= ">{--NO--}</option>\n";
1228 $OUT .= " </select>\n";
1233 // Deprecated : $length
1236 function generateRandomCode ($length, $code, $uid, $DATA = '') {
1237 // Fix missing _MAX constant
1238 // @TODO Rewrite this unnice code
1239 if (!defined('_MAX')) define('_MAX', 15235);
1241 // Build server string
1242 $server = $_SERVER['PHP_SELF'].getConfig('ENCRYPT_SEPERATOR').detectUserAgent().getConfig('ENCRYPT_SEPERATOR').getenv('SERVER_SOFTWARE').getConfig('ENCRYPT_SEPERATOR').detectRemoteAddr().":'.':".filemtime(constant('PATH').'inc/databases.php');
1245 $keys = getConfig('SITE_KEY').getConfig('ENCRYPT_SEPERATOR').getConfig('DATE_KEY');
1246 if (isConfigEntrySet('secret_key')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('secret_key');
1247 if (isConfigEntrySet('file_hash')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('file_hash');
1248 $keys .= getConfig('ENCRYPT_SEPERATOR') . date("d-m-Y (l-F-T)", getConfig('patch_ctime'));
1249 if (isConfigEntrySet('master_salt')) $keys .= getConfig('ENCRYPT_SEPERATOR').getConfig('master_salt');
1251 // Build string from misc data
1252 $data = $code.getConfig('ENCRYPT_SEPERATOR') . $uid.getConfig('ENCRYPT_SEPERATOR') . $DATA;
1254 // Add more additional data
1255 if (isSessionVariableSet('u_hash')) $data .= getConfig('ENCRYPT_SEPERATOR').getSession('u_hash');
1256 if (isUserIdSet()) $data .= getConfig('ENCRYPT_SEPERATOR').getUserId();
1257 if (isSessionVariableSet('mxchange_theme')) $data .= getConfig('ENCRYPT_SEPERATOR').getSession('mxchange_theme');
1258 if (isSessionVariableSet('mx_lang')) $data .= getConfig('ENCRYPT_SEPERATOR').getLanguage();
1259 if (isset($GLOBALS['refid'])) $data .= getConfig('ENCRYPT_SEPERATOR') . $GLOBALS['refid'];
1261 // Calculate number for generating the code
1262 $a = $code + getConfig('_ADD') - 1;
1264 if (isConfigEntrySet('master_hash')) {
1265 // Generate hash with master salt from modula of number with the prime number and other data
1266 $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'));
1268 // Create number from hash
1269 $rcode = hexdec(substr($saltedHash, strlen(getConfig('master_salt')), 9)) / abs(constant('_MAX') - $a + sqrt(getConfig('_ADD'))) / pi();
1271 // Generate hash with "hash of site key" from modula of number with the prime number and other data
1272 $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, 8));
1274 // Create number from hash
1275 $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(constant('_MAX') - $a + sqrt(getConfig('_ADD'))) / pi();
1278 // At least 10 numbers shall be secure enought!
1279 $len = getConfig('code_length');
1280 if ($len == 0) $len = $length;
1281 if ($len == 0) $len = 10;
1283 // Cut off requested counts of number
1284 $return = substr(str_replace('.', '', $rcode), 0, $len);
1286 // Done building code
1290 // Does only allow numbers
1291 function bigintval ($num, $castValue = true) {
1292 // Filter all numbers out
1293 $ret = preg_replace("/[^0123456789]/", '', $num);
1296 if ($castValue) $ret = (double)$ret;
1298 // Has the whole value changed?
1299 // @TODO Remove this if() block if all is working fine
1300 if ('' . $ret . '' != '' . $num . '') {
1302 //debug_report_bug("{$ret}<>{$num}");
1309 // Insert the code in $img_code into jpeg or PNG image
1310 function GENERATE_IMAGE ($img_code, $headerSent=true) {
1311 if ((strlen($img_code) > 6) || (empty($img_code)) || (getConfig('code_length') == 0)) {
1312 // Stop execution of function here because of over-sized code length
1314 } elseif (!$headerSent) {
1315 // Return in an HTML code code
1316 return "<img src=\"{!URL!}/img.php?code=" . $img_code."\" alt=\"Image\" />\n";
1320 $img = sprintf("%s/theme/%s/images/code_bg.%s", constant('PATH'), getCurrentTheme(), getConfig('img_type'));
1321 if (isFileReadable($img)) {
1322 // Switch image type
1323 switch (getConfig('img_type'))
1326 // Okay, load image and hide all errors
1327 $image = @imagecreatefromjpeg($img);
1331 // Okay, load image and hide all errors
1332 $image = @imagecreatefrompng($img);
1336 // Exit function here
1337 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
1341 // Generate text color (red/green/blue; 0 = dark, 255 = bright)
1342 $text_color = imagecolorallocate($image, 0, 0, 0);
1344 // Insert code into image
1345 imagestring($image, 5, 14, 2, $img_code, $text_color);
1347 // Return to browser
1348 sendHeader('Content-Type: image/' . getConfig('img_type'));
1350 // Output image with matching image factory
1351 switch (getConfig('img_type')) {
1352 case 'jpg': imagejpeg($image); break;
1353 case 'png': imagepng($image); break;
1356 // Remove image from memory
1357 imagedestroy($image);
1359 // Create selection box or array of splitted timestamp
1360 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
1361 // Calculate 2-seconds timestamp
1362 $stamp = round($timestamp);
1363 //* DEBUG: */ print("*" . $stamp.'/' . $timestamp."*<br />");
1365 // Do we have a leap year?
1367 $TEST = date('Y', time()) / 4;
1368 $M1 = date('m', time());
1369 $M2 = date('m', (time() + $timestamp));
1371 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1372 if ((floor($TEST) == $TEST) && ($M1 == "02") && ($M2 > "02")) $SWITCH = getConfig('one_day');
1374 // First of all years...
1375 $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
1376 //* DEBUG: */ print("Y={$Y}<br />");
1378 $M = abs(floor($timestamp / 2628000 - $Y * 12));
1379 //* DEBUG: */ print("M={$M}<br />");
1381 $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('one_day')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('one_day')) / 7)));
1382 //* DEBUG: */ print("W={$W}<br />");
1384 $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('one_day')) - ($M / 12 * (365 + $SWITCH / getConfig('one_day'))) - $W * 7));
1385 //* DEBUG: */ print("D={$D}<br />");
1387 $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));
1388 //* DEBUG: */ print("h={$h}<br />");
1390 $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));
1391 //* DEBUG: */ print("m={$m}<br />");
1392 // And at last seconds...
1393 $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));
1394 //* DEBUG: */ print("s={$s}<br />");
1396 // Is seconds zero and time is < 60 seconds?
1397 if (($s == 0) && ($timestamp < 60)) {
1399 $s = round($timestamp);
1403 // Now we convert them in seconds...
1405 if ($return_array) {
1406 // Just put all data in an array for later use
1418 $OUT = "<div align=\"" . $align."\">\n";
1419 $OUT .= "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" class=\"admin_table dashed\">\n";
1422 if (ereg('Y', $display) || (empty($display))) {
1423 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_YEARS--}</strong></td>\n";
1426 if (ereg('M', $display) || (empty($display))) {
1427 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_MONTHS--}</strong></td>\n";
1430 if (ereg("W", $display) || (empty($display))) {
1431 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_WEEKS--}</strong></td>\n";
1434 if (ereg("D", $display) || (empty($display))) {
1435 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_DAYS--}</strong></td>\n";
1438 if (ereg("h", $display) || (empty($display))) {
1439 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_HOURS--}</strong></td>\n";
1442 if (ereg('m', $display) || (empty($display))) {
1443 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_MINUTES--}</strong></td>\n";
1446 if (ereg("s", $display) || (empty($display))) {
1447 $OUT .= " <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_SECONDS--}</strong></td>\n";
1453 if (ereg('Y', $display) || (empty($display))) {
1454 // Generate year selection
1455 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_ye\" size=\"1\">\n";
1456 for ($idx = 0; $idx <= 10; $idx++) {
1457 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1458 if ($idx == $Y) $OUT .= ' selected="selected"';
1459 $OUT .= ">" . $idx."</option>\n";
1461 $OUT .= " </select></td>\n";
1463 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_ye\" value=\"0\" />\n";
1466 if (ereg('M', $display) || (empty($display))) {
1467 // Generate month selection
1468 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_mo\" size=\"1\">\n";
1469 for ($idx = 0; $idx <= 11; $idx++)
1471 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1472 if ($idx == $M) $OUT .= ' selected="selected"';
1473 $OUT .= ">" . $idx."</option>\n";
1475 $OUT .= " </select></td>\n";
1477 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_mo\" value=\"0\" />\n";
1480 if (ereg("W", $display) || (empty($display))) {
1481 // Generate week selection
1482 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_we\" size=\"1\">\n";
1483 for ($idx = 0; $idx <= 4; $idx++) {
1484 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1485 if ($idx == $W) $OUT .= ' selected="selected"';
1486 $OUT .= ">" . $idx."</option>\n";
1488 $OUT .= " </select></td>\n";
1490 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_we\" value=\"0\" />\n";
1493 if (ereg("D", $display) || (empty($display))) {
1494 // Generate day selection
1495 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_da\" size=\"1\">\n";
1496 for ($idx = 0; $idx <= 31; $idx++) {
1497 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1498 if ($idx == $D) $OUT .= ' selected="selected"';
1499 $OUT .= ">" . $idx."</option>\n";
1501 $OUT .= " </select></td>\n";
1503 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_da\" value=\"0\">\n";
1506 if (ereg("h", $display) || (empty($display))) {
1507 // Generate hour selection
1508 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_ho\" size=\"1\">\n";
1509 for ($idx = 0; $idx <= 23; $idx++) {
1510 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1511 if ($idx == $h) $OUT .= ' selected="selected"';
1512 $OUT .= ">" . $idx."</option>\n";
1514 $OUT .= " </select></td>\n";
1516 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_ho\" value=\"0\">\n";
1519 if (ereg('m', $display) || (empty($display))) {
1520 // Generate minute selection
1521 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_mi\" size=\"1\">\n";
1522 for ($idx = 0; $idx <= 59; $idx++) {
1523 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1524 if ($idx == $m) $OUT .= ' selected="selected"';
1525 $OUT .= ">" . $idx."</option>\n";
1527 $OUT .= " </select></td>\n";
1529 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_mi\" value=\"0\">\n";
1532 if (ereg("s", $display) || (empty($display))) {
1533 // Generate second selection
1534 $OUT .= " <td align=\"center\"><select class=\"mini_select\" name=\"" . $prefix."_se\" size=\"1\">\n";
1535 for ($idx = 0; $idx <= 59; $idx++) {
1536 $OUT .= " <option class=\"mini_select\" value=\"" . $idx."\"";
1537 if ($idx == $s) $OUT .= ' selected="selected"';
1538 $OUT .= ">" . $idx."</option>\n";
1540 $OUT .= " </select></td>\n";
1542 $OUT .= "<INPUT type=\"hidden\" name=\"" . $prefix."_se\" value=\"0\">\n";
1545 $OUT .= "</table>\n";
1547 // Return generated HTML code
1553 function createTimestampFromSelections ($prefix, $POST) {
1554 // Initial return value
1557 // Do we have a leap year?
1559 $TEST = date('Y', time()) / 4;
1560 $M1 = date('m', time());
1561 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1562 if ((floor($TEST) == $TEST) && ($M1 == "02") && ($POST[$prefix."_mo"] > "02")) $SWITCH = getConfig('one_day');
1563 // First add years...
1564 $ret += $POST[$prefix."_ye"] * (31536000 + $SWITCH);
1566 $ret += $POST[$prefix."_mo"] * 2628000;
1568 $ret += $POST[$prefix."_we"] * 604800;
1570 $ret += $POST[$prefix."_da"] * 86400;
1572 $ret += $POST[$prefix."_ho"] * 3600;
1574 $ret += $POST[$prefix."_mi"] * 60;
1575 // And at last seconds...
1576 $ret += $POST[$prefix."_se"];
1577 // Return calculated value
1581 // Sends out mail to all administrators
1582 // IMPORTANT: Please use SEND_ADMIN_NOTIFCATION() for now!
1583 function SEND_ADMIN_EMAILS_PRO ($subj, $template, $content, $UID) {
1584 // Trim template name
1585 $template = trim($template);
1587 // Load email template
1588 $message = LOAD_EMAIL_TEMPLATE($template, $content, $UID);
1590 // Check which admin shall receive this mail
1591 $result = SQL_QUERY_ESC("SELECT DISTINCT admin_id FROM `{!_MYSQL_PREFIX!}_admins_mails` WHERE mail_template='%s' ORDER BY admin_id",
1592 array($template), __FUNCTION__, __LINE__);
1593 if (SQL_NUMROWS($result) == 0) {
1594 // Create new entry (to all admins)
1595 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_admins_mails` (admin_id, mail_template) VALUES (0, '%s')",
1596 array($template), __FUNCTION__, __LINE__);
1598 // Load admin IDs...
1599 // @TODO This can be, somehow, rewritten
1600 $adminIds = array();
1601 while ($content = SQL_FETCHARRAY($result)) {
1602 $adminIds[] = $content['admin_id'];
1606 SQL_FREERESULT($result);
1611 // "implode" IDs and query string
1612 $aid = implode(',', $adminIds);
1614 if (EXT_IS_ACTIVE('events')) {
1615 // Add line to user events
1616 EVENTS_ADD_LINE($subj, $message, $UID);
1618 // Log error for debug
1619 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension 'events' missing: tpl=%s,subj=%s,UID=%s",
1625 } elseif ($aid == '0') {
1626 // Select all email adresses
1627 $result = SQL_QUERY("SELECT email FROM `{!_MYSQL_PREFIX!}_admins` ORDER BY `id`",
1628 __FUNCTION__, __LINE__);
1630 // If Admin-ID is not "to-all" select
1631 $result = SQL_QUERY_ESC("SELECT email FROM `{!_MYSQL_PREFIX!}_admins` WHERE id IN (%s) ORDER BY `id`",
1632 array($aid), __FUNCTION__, __LINE__);
1636 // Load email addresses and send away
1637 while ($content = SQL_FETCHARRAY($result)) {
1638 sendEmail($content['email'], $subj, $message);
1642 SQL_FREERESULT($result);
1645 // Creates a 'fancy' human-readable timestamp from a Uni* stamp
1646 function createFancyTime ($stamp) {
1647 // Get data array with years/months/weeks/days/...
1648 $data = createTimeSelections($stamp, '', '', '', true);
1650 foreach($data as $k => $v) {
1652 // Value is greater than 0 "eval" data to return string
1653 $eval = "\$ret .= \", \".\$v.\" {--_".strtoupper($k)."--}\";";
1659 // Do we have something there?
1660 if (strlen($ret) > 0) {
1661 // Remove leading commata and space
1662 $ret = substr($ret, 2);
1665 $ret = "0 {--_SECONDS--}";
1668 // Return fancy time string
1673 function ADD_EMAIL_NAV ($PAGES, $offset, $show_form, $colspan, $return=false) {
1674 $SEP = ''; $TOP = '';
1677 $SEP = "<tr><td colspan=\"" . $colspan."\" class=\"seperator\"> </td></tr>";
1681 for ($page = 1; $page <= $PAGES; $page++) {
1682 // Is the page currently selected or shall we generate a link to it?
1683 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET('page')) && ($page == '1'))) {
1684 // Is currently selected, so only highlight it
1685 $NAV .= "<strong>-";
1687 // Open anchor tag and add base URL
1688 $NAV .= "<a href=\"{!URL!}/modules.php?module=admin&what=" . getWhat()."&page=" . $page."&offset=" . $offset;
1690 // Add userid when we shall show all mails from a single member
1691 if ((REQUEST_ISSET_GET('uid')) && (bigintval(REQUEST_GET('uid')) > 0)) $NAV .= "&uid=".bigintval(REQUEST_GET('uid'));
1693 // Close open anchor tag
1697 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET('page')) && ($page == '1'))) {
1698 // Is currently selected, so only highlight it
1699 $NAV .= "-</strong>";
1705 // Add seperator if we have not yet reached total pages
1706 if ($page < $PAGES) $NAV .= " | ";
1709 // Define constants only once
1710 if (!defined('__NAV_OUTPUT')) {
1711 define('__NAV_OUTPUT' , $NAV);
1712 define('__NAV_COLSPAN', $colspan);
1713 define('__NAV_TOP' , $TOP);
1714 define('__NAV_SEP' , $SEP);
1717 // Load navigation template
1718 $OUT = LOAD_TEMPLATE("admin_email_nav_row", true);
1720 if ($return === true) {
1721 // Return generated HTML-Code
1729 // Extract host from script name
1730 function extractHostnameFromUrl (&$script) {
1731 // Use default SERVER_URL by default... ;) So?
1732 $url = constant('SERVER_URL');
1734 // Is this URL valid?
1735 if (substr($script, 0, 7) == 'http://') {
1736 // Use the hostname from script URL as new hostname
1737 $url = substr($script, 7);
1738 $extract = explode('/', $url);
1740 // Done extracting the URL :)
1743 // Extract host name
1744 $host = str_replace('http://', '', $url);
1745 if (ereg('/', $host)) $host = substr($host, 0, strpos($host, '/'));
1747 // Generate relative URL
1748 //* DEBUG: */ print("SCRIPT=" . $script."<br />");
1749 if (substr(strtolower($script), 0, 7) == 'http://') {
1750 // But only if http:// is in front!
1751 $script = substr($script, (strlen($url) + 7));
1752 } elseif (substr(strtolower($script), 0, 8) == "https://") {
1754 $script = substr($script, (strlen($url) + 8));
1757 //* DEBUG: */ print("SCRIPT=" . $script."<br />");
1758 if (substr($script, 0, 1) == '/') $script = substr($script, 1);
1764 // Send a GET request
1765 function sendGetRequest ($script) {
1766 // Compile the script name
1767 $script = COMPILE_CODE($script);
1769 // Extract host name from script
1770 $host = extractHostnameFromUrl($script);
1772 // Generate GET request header
1773 $request = "GET /" . trim($script) . " HTTP/1.1" . getConfig('HTTP_EOL');
1774 $request .= "Host: " . $host . getConfig('HTTP_EOL');
1775 $request .= "Referer: " . constant('URL') . "/admin.php" . getConfig('HTTP_EOL');
1776 if (defined('FULL_VERSION')) {
1777 $request .= "User-Agent: " . constant('TITLE') . '/' . constant('FULL_VERSION') . getConfig('HTTP_EOL');
1779 $request .= "User-Agent: " . constant('TITLE') . "/?.?.?" . getConfig('HTTP_EOL');
1781 $request .= "Content-Type: text/plain" . getConfig('HTTP_EOL');
1782 $request .= "Cache-Control: no-cache" . getConfig('HTTP_EOL');
1783 $request .= "Connection: Close" . getConfig('HTTP_EOL') . getConfig('HTTP_EOL');
1785 // Send the raw request
1786 $response = sendRawRequest($host, $request);
1788 // Return the result to the caller function
1792 // Send a POST request
1793 function sendPostRequest ($script, $postData) {
1794 // Is postData an array?
1795 if (!is_array($postData)) {
1797 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("postData is not an array. Type: %s", gettype($postData)));
1798 return array('', '', '');
1801 // Compile the script name
1802 $script = COMPILE_CODE($script);
1804 // Extract host name from script
1805 $host = extractHostnameFromUrl($script);
1807 // Construct request
1808 $data = http_build_query($postData, '','&');
1810 // Generate POST request header
1811 $request = "POST /" . trim($script) . " HTTP/1.1" . getConfig('HTTP_EOL');
1812 $request .= "Host: " . $host . getConfig('HTTP_EOL');
1813 $request .= "Referer: " . constant('URL') . "/admin.php" . getConfig('HTTP_EOL');
1814 $request .= "User-Agent: " . constant('TITLE') . '/' . constant('FULL_VERSION') . getConfig('HTTP_EOL');
1815 $request .= "Content-type: application/x-www-form-urlencoded" . getConfig('HTTP_EOL');
1816 $request .= "Content-length: " . strlen($data) . getConfig('HTTP_EOL');
1817 $request .= "Cache-Control: no-cache" . getConfig('HTTP_EOL');
1818 $request .= "Connection: Close" . getConfig('HTTP_EOL') . getConfig('HTTP_EOL');
1821 // Send the raw request
1822 $response = sendRawRequest($host, $request);
1824 // Return the result to the caller function
1828 // Sends a raw request to another host
1829 function sendRawRequest ($host, $request) {
1830 // Init errno and errdesc with 'all fine' values
1831 $errno = 0; $errdesc = '';
1834 $response = array('', '', '');
1836 // Default is not to use proxy
1839 // Are proxy settins set?
1840 if ((getConfig('proxy_host') != '') && (getConfig('proxy_port') > 0)) {
1846 //* DEBUG: */ die("SCRIPT=" . $script."<br />");
1847 if ($useProxy === true) {
1848 // Connect to host through proxy connection
1849 $fp = @fsockopen(COMPILE_CODE(getConfig('proxy_host')), bigintval(getConfig('proxy_port')), $errno, $errdesc, 30);
1851 // Connect to host directly
1852 $fp = @fsockopen($host, 80, $errno, $errdesc, 30);
1856 if (!is_resource($fp)) {
1862 if ($useProxy === true) {
1863 // Generate CONNECT request header
1864 $proxyTunnel = "CONNECT " . $host . ":80 HTTP/1.1" . getConfig('HTTP_EOL');
1865 $proxyTunnel .= "Host: " . $host . getConfig('HTTP_EOL');
1867 // Use login data to proxy? (username at least!)
1868 if (getConfig('proxy_username') != '') {
1870 $encodedAuth = base64_encode(COMPILE_CODE(getConfig('proxy_username')) . getConfig('ENCRYPT_SEPERATOR') . COMPILE_CODE(getConfig('proxy_password')));
1871 $proxyTunnel .= "Proxy-Authorization: Basic " . $encodedAuth . getConfig('HTTP_EOL');
1874 // Add last new-line
1875 $proxyTunnel .= getConfig('HTTP_EOL');
1876 //* DEBUG: */ print("<strong>proxyTunnel=</strong><pre>" . $proxyTunnel."</pre>");
1879 fputs($fp, $proxyTunnel);
1883 // No response received
1887 // Read the first line
1888 $resp = trim(fgets($fp, 10240));
1889 $respArray = explode(' ', $resp);
1890 if ((strtolower($respArray[0]) !== 'http/1.0') || ($respArray[1] != '200')) {
1891 // Invalid response!
1897 fputs($fp, $request);
1900 while (!feof($fp)) {
1901 $response[] = trim(fgets($fp, 1024));
1907 // Skip first empty lines
1909 foreach ($resp as $idx => $line) {
1911 $line = trim($line);
1913 // Is this line empty?
1916 array_shift($response);
1918 // Abort on first non-empty line
1923 //* DEBUG: */ print("<strong>Response:</strong><pre>".print_r($response, true)."</pre>");
1925 // Proxy agent found?
1926 if ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && ($useProxy === true)) {
1927 // Proxy header detected, so remove two lines
1928 array_shift($response);
1929 array_shift($response);
1932 // Was the request successfull?
1933 if ((!eregi('200 OK', $response[0])) || (empty($response[0]))) {
1934 // Not found / access forbidden
1935 $response = array('', '', '');
1942 // Taken from www.php.net eregi() user comments
1943 function isEmailValid ($email) {
1945 $email = COMPILE_CODE($email);
1947 // Check first part of email address
1948 $first = '[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*';
1951 $domain = '[a-z0-9-]+(\.[a-z0-9-]{2,5})+';
1954 $regex = '@^' . $first . '\@' . $domain . '$@iU';
1956 // Return check result
1957 return preg_match($regex, $email);
1960 // Function taken from user comments on www.php.net / function eregi()
1961 function isUrlValid ($URL, $compile=true) {
1962 // Trim URL a little
1963 $URL = trim(urldecode($URL));
1964 //* DEBUG: */ OUTPUT_HTML($URL."<br />");
1966 // Compile some chars out...
1967 if ($compile === true) $URL = compileUriCode($URL, false, false, false);
1968 //* DEBUG: */ OUTPUT_HTML($URL."<br />");
1970 // Check for the extension filter
1971 if (EXT_IS_ACTIVE('filter')) {
1972 // Use the extension's filter set
1973 return FILTER_VALIDATE_URL($URL, false);
1976 // If not installed, perform a simple test. Just make it sure there is always a http:// or
1977 // https:// in front of the URLs
1978 return isUrlValidSimple($URL);
1981 // Generate a list of administrative links to a given userid
1982 function generateMemberAdminActionLinks ($uid, $status = '') {
1983 // Define all main targets
1984 $TARGETS = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
1986 // Begin of navigation links
1987 $eval = "\$OUT = \"[ ";
1989 foreach ($TARGETS as $tar) {
1990 $eval .= "<span class=\\\"admin_user_link\\\"><a href=\\\"{!URL!}/modules.php?module=admin&what=" . $tar."&uid=" . $uid."\\\" title=\\\"{--ADMIN_LINK_";
1991 //* DEBUG: */ OUTPUT_HTML("*" . $tar.'/' . $status."*<br />");
1992 if (($tar == "lock_user") && ($status == 'LOCKED')) {
1993 // Locked accounts shall be unlocked
1994 $eval .= "UNLOCK_USER";
1996 // All other status is fine
1997 $eval .= strtoupper($tar);
1999 $eval .= "_TITLE--}\\\">{--ADMIN_";
2000 if (($tar == "lock_user") && ($status == 'LOCKED')) {
2001 // Locked accounts shall be unlocked
2002 $eval .= "UNLOCK_USER";
2004 // All other status is fine
2005 $eval .= strtoupper($tar);
2007 $eval .= "--}</a></span> | ";
2010 // Finish navigation link
2011 $eval = substr($eval, 0, -7)."]\";";
2018 // Generate an email link
2019 function generateEmailLink ($email, $table = 'admins') {
2020 // Default email link (INSECURE! Spammer can read this by harvester programs)
2021 $EMAIL = 'mailto:' . $email;
2023 // Check for several extensions
2024 if ((EXT_IS_ACTIVE('admins')) && ($table == 'admins')) {
2025 // Create email link for contacting admin in guest area
2026 $EMAIL = generateAdminEmailLink($email);
2027 } elseif ((EXT_IS_ACTIVE('user')) && (GET_EXT_VERSION('user') >= '0.3.3') && ($table == 'user_data')) {
2028 // Create email link for contacting a member within admin area (or later in other areas, too?)
2029 $EMAIL = generateUserEmailLink($email, 'admin');
2030 } elseif ((EXT_IS_ACTIVE('sponsor')) && ($table == 'sponsor_data')) {
2031 // Create email link to contact sponsor within admin area (or like the link above?)
2032 $EMAIL = generateSponsorEmailLink($email, 'sponsor_data');
2035 // Shall I close the link when there is no admin?
2036 if ((!IS_ADMIN()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
2038 // Return email link
2042 // Generate a hash for extra-security for all passwords
2043 function generateHash ($plainText, $salt = '') {
2044 // Is the required extension 'sql_patches' there and a salt is not given?
2045 if (((EXT_VERSION_IS_OLDER('sql_patches', '0.3.6')) || (!EXT_IS_ACTIVE('sql_patches'))) && (empty($salt))) {
2046 // Extension sql_patches is missing/outdated so we hash the plain text with MD5
2047 return md5($plainText);
2050 // Do we miss an arry element here?
2051 if (!isConfigEntrySet('file_hash')) {
2053 debug_report_bug('Missing file_hash in ' . __FUNCTION__ . '.');
2056 // When the salt is empty build a new one, else use the first x configured characters as the salt
2058 // Build server string (inc/databases.php is no longer updated with every commit)
2059 $server = $_SERVER['PHP_SELF'].getConfig('ENCRYPT_SEPERATOR').detectUserAgent().getConfig('ENCRYPT_SEPERATOR').getenv('SERVER_SOFTWARE').getConfig('ENCRYPT_SEPERATOR').detectRemoteAddr();
2062 $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');
2065 $data = $plainText.getConfig('ENCRYPT_SEPERATOR').uniqid(mt_rand(), true).getConfig('ENCRYPT_SEPERATOR').time();
2067 // Calculate number for generating the code
2068 $a = time() + getConfig('_ADD') - 1;
2070 // Generate SHA1 sum from modula of number and the prime number
2071 $sha1 = sha1(($a % getConfig('_PRIME')) . $server.getConfig('ENCRYPT_SEPERATOR') . $keys.getConfig('ENCRYPT_SEPERATOR') . $data.getConfig('ENCRYPT_SEPERATOR').getConfig('DATE_KEY').getConfig('ENCRYPT_SEPERATOR') . $a);
2072 //* DEBUG: */ OUTPUT_HTML("SHA1=" . $sha1." (".strlen($sha1).")<br />");
2073 $sha1 = scrambleString($sha1);
2074 //* DEBUG: */ OUTPUT_HTML("Scrambled=" . $sha1." (".strlen($sha1).")<br />");
2075 //* DEBUG: */ $sha1b = descrambleString($sha1);
2076 //* DEBUG: */ OUTPUT_HTML("Descrambled=" . $sha1b." (".strlen($sha1b).")<br />");
2078 // Generate the password salt string
2079 $salt = substr($sha1, 0, getConfig('salt_length'));
2080 //* DEBUG: */ OUTPUT_HTML($salt." (".strlen($salt).")<br />");
2083 $salt = substr($salt, 0, getConfig('salt_length'));
2084 //* DEBUG: */ OUTPUT_HTML("GIVEN={$salt}<br />");
2088 return $salt.sha1($salt . $plainText);
2091 // Scramble a string
2092 function scrambleString($str) {
2096 // Final check, in case of failture it will return unscrambled string
2097 if (strlen($str) > 40) {
2098 // The string is to long
2100 } elseif (strlen($str) == 40) {
2102 $scrambleNums = explode(':', getConfig('pass_scramble'));
2104 // Generate new numbers
2105 $scrambleNums = explode(':', genScrambleString(strlen($str)));
2108 // Scramble string here
2109 //* DEBUG: */ OUTPUT_HTML("***Original=" . $str."***<br />");
2110 for ($idx = 0; $idx < strlen($str); $idx++) {
2111 // Get char on scrambled position
2112 $char = substr($str, $scrambleNums[$idx], 1);
2114 // Add it to final output string
2115 $scrambled .= $char;
2118 // Return scrambled string
2119 //* DEBUG: */ OUTPUT_HTML("***Scrambled=" . $scrambled."***<br />");
2123 // De-scramble a string scrambled by scrambleString()
2124 function descrambleString($str) {
2125 // Scramble only 40 chars long strings
2126 if (strlen($str) != 40) return $str;
2128 // Load numbers from config
2129 $scrambleNums = explode(':', getConfig('pass_scramble'));
2132 if (count($scrambleNums) != 40) return $str;
2134 // Begin descrambling
2135 $orig = str_repeat(' ', 40);
2136 //* DEBUG: */ OUTPUT_HTML("+++Scrambled=" . $str."+++<br />");
2137 for ($idx = 0; $idx < 40; $idx++) {
2138 $char = substr($str, $idx, 1);
2139 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
2142 // Return scrambled string
2143 //* DEBUG: */ OUTPUT_HTML("+++Original=" . $orig."+++<br />");
2147 // Generated a "string" for scrambling
2148 function genScrambleString ($len) {
2149 // Prepare array for the numbers
2150 $scrambleNumbers = array();
2152 // First we need to setup randomized numbers from 0 to 31
2153 for ($idx = 0; $idx < $len; $idx++) {
2155 $rand = mt_rand(0, ($len -1));
2157 // Check for it by creating more numbers
2158 while (array_key_exists($rand, $scrambleNumbers)) {
2159 $rand = mt_rand(0, ($len -1));
2163 $scrambleNumbers[$rand] = $rand;
2166 // So let's create the string for storing it in database
2167 $scrambleString = implode(':', $scrambleNumbers);
2168 return $scrambleString;
2171 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
2172 function generatePassString ($passHash) {
2173 // Return vanilla password hash
2176 // Is a secret key and master salt already initialized?
2177 if ((getConfig('secret_key') != '') && (getConfig('master_salt') != '')) {
2178 // Only calculate when the secret key is generated
2179 $newHash = ''; $start = 9;
2180 for ($idx = 0; $idx < 10; $idx++) {
2181 $part1 = hexdec(substr($passHash, $start, 4));
2182 $part2 = hexdec(substr(getConfig('secret_key'), $start, 4));
2183 $mod = dechex($idx);
2184 if ($part1 > $part2) {
2185 $mod = dechex(sqrt(($part1 - $part2) * getConfig('_PRIME') / pi()));
2186 } elseif ($part2 > $part1) {
2187 $mod = dechex(sqrt(($part2 - $part1) * getConfig('_PRIME') / pi()));
2189 $mod = substr(round($mod), 0, 4);
2190 $mod = str_repeat('0', 4-strlen($mod)) . $mod;
2191 //* DEBUG: */ OUTPUT_HTML("*" . $start.'=' . $mod."*<br />");
2196 //* DEBUG: */ print($passHash."<br />" . $newHash." (".strlen($newHash).')');
2197 $ret = generateHash($newHash, getConfig('master_salt'));
2198 //* DEBUG: */ print($ret."<br />");
2201 //* DEBUG: */ OUTPUT_HTML("--" . $passHash."--<br />");
2202 $ret = md5($passHash);
2203 //* DEBUG: */ OUTPUT_HTML("++" . $ret."++<br />");
2210 // Fix "deleted" cookies
2211 function fixDeletedCookies ($cookies) {
2212 // Is this an array with entries?
2213 if ((is_array($cookies)) && (count($cookies) > 0)) {
2214 // Then check all cookies if they are marked as deleted!
2215 foreach ($cookies as $cookieName) {
2216 // Is the cookie set to "deleted"?
2217 if (getSession($cookieName) == 'deleted') {
2218 setSession($cookieName, '');
2224 // Output error messages in a fasioned way and die...
2225 function app_die ($F, $L, $message) {
2226 // Check if Script is already dieing and not let it kill itself another 1000 times
2227 if (!isset($GLOBALS['app_died'])) {
2228 // Make sure, that the script realy realy diese here and now
2229 $GLOBALS['app_died'] = true;
2232 loadIncludeOnce('inc/header.php');
2234 // Rewrite message for output
2235 $message = sprintf(getMessage('MXCHANGE_HAS_DIED'), basename($F), $L, $message);
2237 // Better log this message away
2238 DEBUG_LOG($F, $L, $message);
2240 // Load the message template
2241 LOAD_TEMPLATE('admin_settings_saved', false, $message);
2244 loadIncludeOnce('inc/footer.php');
2246 // Script tried to kill itself twice
2247 debug_report_bug('Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
2251 // Display parsing time and number of SQL queries in footer
2252 function displayParsingTime() {
2253 // Is the timer started?
2254 if (!isset($GLOBALS['startTime'])) {
2260 $endTime = microtime(true);
2262 // "Explode" both times
2263 $start = explode(' ', $GLOBALS['startTime']);
2264 $end = explode(' ', $endTime);
2265 $runTime = $end[0] - $start[0];
2266 if ($runTime < 0) $runTime = 0;
2267 $runTime = translateComma($runTime);
2271 'runtime' => $runTime,
2272 'numSQLs' => (getConfig('sql_count') + 1),
2273 'numTemplates' => (getConfig('num_templates') + 1)
2276 // Load the template
2277 LOAD_TEMPLATE('show_timings', false, $content);
2280 // Check wether a boolean constant is set
2281 // Taken from user comments in PHP documentation for function constant()
2282 function isBooleanConstantAndTrue ($constName) { // : Boolean
2283 // Failed by default
2287 if (isset($GLOBALS['cache_array']['const'][$constName])) {
2289 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): " . $constName."-CACHE!<br />");
2290 $res = ($GLOBALS['cache_array']['const'][$constName] === true);
2293 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): " . $constName."-RESOLVE!<br />");
2294 if (defined($constName)) {
2296 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): " . $constName."-FOUND!<br />");
2297 $res = (constant($constName) === true);
2301 $GLOBALS['cache_array']['const'][$constName] = $res;
2303 //* DEBUG: */ var_dump($res);
2309 // Checks if a given apache module is loaded
2310 function isApacheModuleLoaded ($apacheModule) {
2311 // Check it and return result
2312 return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
2315 // Get current theme name
2316 function getCurrentTheme() {
2317 // The default theme is 'default'... ;-)
2320 // Load default theme if not empty from configuration
2321 if (getConfig('default_theme') != '') $ret = getConfig('default_theme');
2323 if (!isSessionVariableSet('mxchange_theme')) {
2324 // Set default theme
2325 setSession('mxchange_theme', $ret);
2326 } elseif ((isSessionVariableSet('mxchange_theme')) && (GET_EXT_VERSION('sql_patches') >= '0.1.4')) {
2327 //die("<pre>".print_r($GLOBALS['cache_array']['themes'], true)."</pre>");
2328 // Get theme from cookie
2329 $ret = getSession('mxchange_theme');
2332 if (getThemeId($ret) == 0) {
2333 // Fix it to default
2336 } elseif ((!isInstalled()) && ((isInstalling()) || (getOutputMode() == true)) && ((REQUEST_ISSET_GET('theme')) || (REQUEST_ISSET_POST('theme')))) {
2337 // Prepare FQFN for checking
2338 $theme = sprintf("%stheme/%s/theme.php", constant('PATH'), REQUEST_GET('theme'));
2340 // Installation mode active
2341 if ((REQUEST_ISSET_GET('theme')) && (isFileReadable($theme))) {
2342 // Set cookie from URL data
2343 setSession('mxchange_theme', REQUEST_GET('theme'));
2344 } elseif (isFileReadable(sprintf("%stheme/%s/theme.php", constant('PATH'), SQL_ESCAPE(REQUEST_POST('theme'))))) {
2345 // Set cookie from posted data
2346 setSession('mxchange_theme', SQL_ESCAPE(REQUEST_POST('theme')));
2350 $ret = getSession('mxchange_theme');
2352 // Invalid design, reset cookie
2353 setSession('mxchange_theme', $ret);
2356 // Add (maybe) found theme.php file to inclusion list
2357 $INC = sprintf("theme/%s/theme.php", SQL_ESCAPE($ret));
2359 // Try to load the requested include file
2360 if (isIncludeReadable($INC)) ADD_INC_TO_POOL($INC);
2362 // Return theme value
2366 // Get id from theme
2367 function getThemeId ($name) {
2368 // Is the extension 'theme' installed?
2369 if (!EXT_IS_ACTIVE('theme')) {
2377 // Is the cache entry there?
2378 if (isset($GLOBALS['cache_array']['themes']['id'][$name])) {
2379 // Get the version from cache
2380 $id = $GLOBALS['cache_array']['themes']['id'][$name];
2383 incrementConfigEntry('cache_hits');
2384 } elseif (GET_EXT_VERSION('cache') != '0.1.8') {
2385 // Check if current theme is already imported or not
2386 $result = SQL_QUERY_ESC("SELECT `id` FROM `{!_MYSQL_PREFIX!}_themes` WHERE theme_path='%s' LIMIT 1",
2387 array($name), __FUNCTION__, __LINE__);
2390 if (SQL_NUMROWS($result) == 1) {
2392 list($id) = SQL_FETCHROW($result);
2396 SQL_FREERESULT($result);
2403 // Generates an error code from given account status
2404 function generateErrorCodeFromUserStatus ($status) {
2405 // @TODO The status should never be empty
2406 if (empty($status)) {
2407 // Something really bad happend here
2408 debug_report_bug(__FUNCTION__ . ': status is empty.');
2411 // Default error code if unknown account status
2412 $errorCode = getCode('UNKNOWN_STATUS');
2414 // Generate constant name
2415 $constantName = sprintf("ID_%s", $status);
2417 // Is the constant there?
2418 if (isCodeSet($constantName)) {
2420 $errorCode = getCode($constantName);
2423 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
2426 // Return error code
2430 // Function to search for the last modifified file
2431 function searchDirsRecursive ($dir, &$last_changed) {
2433 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):dir=" . $dir."<br />");
2434 // Does it match what we are looking for? (We skip a lot files already!)
2435 // RegexPattern to exclude ., .., .revision, .svn, debug.log or .cache in the filenames
2436 $excludePattern = '@(\.revision|debug\.log|\.cache|config\.php)$@';
2437 $ds = getArrayFromDirectory($dir, '', true, false, array(), '.php', $excludePattern);
2438 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):ds[]=".count($ds)."<br />");
2440 // Walk through all entries
2441 foreach ($ds as $d) {
2442 // Generate proper FQFN
2443 $FQFN = str_replace('//', '/', constant('PATH') . $dir. '/'. $d);
2445 // Is it a file and readable?
2446 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):FQFN={$FQFN}<br />");
2447 if (isDirectory($FQFN)) {
2448 // $FQFN is a directory so also crawl into this directory
2450 if (!empty($dir)) $newDir = $dir . '/'. $d;
2451 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):DESCENT: " . $newDir."<br />");
2452 searchDirsRecursive($newDir, $last_changed);
2453 } elseif (isFileReadable($FQFN)) {
2454 // $FQFN is a filename and no directory
2455 $time = filemtime($FQFN);
2456 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):File: " . $d." found. (".($last_changed['time'] - $time).")<br />");
2457 if ($last_changed['time'] < $time) {
2458 // This file is newer as the file before
2459 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>) - NEWER!<br />");
2460 $last_changed['path_name'] = $FQFN;
2461 $last_changed['time'] = $time;
2467 // "Getter" for revision/version data
2468 function getActualVersion ($type = 'Revision') {
2469 // By default nothing is new... ;-)
2472 if (EXT_IS_ACTIVE('cache')) {
2473 // Check if REQUEST_GET('check_revision_data') is setted (switch for manually rewrite the .revision-File)
2474 if (REQUEST_ISSET_GET('check_revision_data') && REQUEST_GET('check_revision_data') == 'yes') {
2475 // Force rebuild by URL parameter
2478 !isset($GLOBALS['cache_array']['revision'][$type])
2480 count($GLOBALS['cache_array']['revision']) < 3
2482 !$GLOBALS['cache_instance']->loadCacheFile('revision')
2488 // Is the cache file outdated/invalid?
2489 if ($new === true) {
2490 // Reload the cache file
2491 $GLOBALS['cache_instance']->loadCacheFile('revision');
2493 // Destroy cache file
2494 $GLOBALS['cache_instance']->destroyCacheFile(false, true);
2496 // @TODO shouldn't do the unset and the reloading $GLOBALS['cache_instance']->destroyCacheFile() Or a new methode like forceCacheReload('revision')?
2497 unset($GLOBALS['cache_array']['revision']);
2499 // Reload load_cach-revison.php
2500 loadInclude('inc/loader/load_cache-revision.php');
2506 // Return found value
2507 return $GLOBALS['cache_array']['revision'][$type][0];
2509 // Old Version without ext-cache active (deprecated ?)
2511 // FQFN of revision file
2512 $FQFN = sprintf("%sinc/cache/.revision", constant('PATH'));
2514 // Check if REQUEST_GET('check_revision_data') is setted (switch for manually rewrite the .revision-File)
2515 if ((REQUEST_ISSET_GET('check_revision_data')) && (REQUEST_GET('check_revision_data') == 'yes')) {
2516 // Forced rebuild of .revision file
2519 // Check for revision file
2520 if (!isFileReadable($FQFN)) {
2521 // Not found, so we need to create it
2524 // Revision file found
2525 $ins_vers = explode("\n", readFromFile($FQFN));
2527 // Get array for mapping information
2528 $mapper = array_flip(getSearchFor());
2529 //* DEBUG: */ print("<pre>".print_r($mapper, true).print_r($ins_vers, true)."</pre>");
2531 // Is the content valid?
2532 if ((!is_array($ins_vers)) || (count($ins_vers) <= 0) || (!isset($ins_vers[$mapper[$type]])) || (trim($ins_vers[$mapper[$type]]) == '') || ($ins_vers[0]) == "new") {
2533 // File needs update!
2536 // Return found value
2537 return trim($ins_vers[$mapper[$type]]);
2542 // Has it been updated?
2543 if ($new === true) {
2544 writeToFile($FQFN, implode("\n", getArrayFromActualVersion()));
2549 // Repares an array we are looking for
2550 // The returned Array is needed twice (in getArrayFromActualVersion() and in getActualVersion() in the old .revision-fallback) so I puted it in an extra function to not polute the global namespace
2551 function getSearchFor () {
2552 // Add Revision, Date, Tag and Author
2553 $searchFor = array('Revision', 'Date', 'Tag', 'Author');
2555 // Return the created array
2559 // @TODO Please describe this function
2560 function getArrayFromActualVersion () {
2564 // Directory to start with search
2565 $last_changed = array(
2570 // Init return array
2571 $akt_vers = array();
2573 // Init value for counting the founded keywords
2576 // Searches all Files and there date of the last modifikation and puts the newest File in $last_changed.
2577 searchDirsRecursive($next_dir, $last_changed); // @TODO small change to API to $last_changed = searchDirsRecursive($next_dir, $time);
2580 $last_file = readFromFile($last_changed['path_name']);
2582 // Get all the keywords to search for
2583 $searchFor = getSearchFor();
2585 // This foreach loops the $searchFor-Tags (array('Revision', 'Date', 'Tag', 'Author') --> could easaly extended in the future)
2586 foreach ($searchFor as $search) {
2587 // Searches for "$search-tag:VALUE$" or "$search-tag::VALUE$"(the stylish keywordversion ;-)) in the lates modified file
2588 $res += preg_match('@\$' . $search.'(:|::) (.*) \$@U', $last_file, $t);
2589 // This trimms the search-result and puts it in the $akt_vers-return array
2590 if (isset($t[2])) $akt_vers[$search] = trim($t[2]);
2593 // Save the last-changed filename for debugging
2594 $akt_vers['File'] = $last_changed['path_name'];
2596 // at least 3 keyword-Tags are needed for propper values
2597 if ($res && $res >= 3
2598 && isset($akt_vers['Revision']) && $akt_vers['Revision'] != ''
2599 && isset($akt_vers['Date']) && $akt_vers['Date'] != ''
2600 && isset($akt_vers['Tag']) && $akt_vers['Tag'] != '') {
2601 // Prepare content witch need special treadment
2603 // Prepare timestamp for date
2604 preg_match('@(....)-(..)-(..) (..):(..):(..)@', $akt_vers['Date'], $match_d);
2605 $akt_vers['Date'] = mktime($match_d[4], $match_d[5], $match_d[6], $match_d[2], $match_d[3], $match_d[1]);
2607 // Add author to the Tag if the author is set and is not quix0r (lead coder)
2608 if ((isset($akt_vers['Author'])) && ($akt_vers['Author'] != "quix0r")) {
2609 $akt_vers['Tag'] .= '-'.strtoupper($akt_vers['Author']);
2613 // No valid Data from the last modificated file so read the Revision from the Server. Fallback-solution!! Should not be removed I think.
2614 $version = sendGetRequest('check-updates3.php');
2617 // Only sets not setted or not proper values to the Online-Server-Fallback-Solution
2618 if (!isset($akt_vers['Revision']) || $akt_vers['Revision'] == '') $akt_vers['Revision'] = trim($version[10]);
2619 if (!isset($akt_vers['Date']) || $akt_vers['Date'] == '') $akt_vers['Date'] = trim($version[9]);
2620 if (!isset($akt_vers['Tag']) || $akt_vers['Tag'] == '') $akt_vers['Tag'] = trim($version[8]);
2621 if (!isset($akt_vers['Author']) || $akt_vers['Author'] == '') $akt_vers['Author'] = "quix0r";
2624 // Return prepared array
2628 // Back-ported from the new ship-simu engine. :-)
2629 function debug_get_printable_backtrace () {
2631 $backtrace = "<ol>\n";
2633 // Get and prepare backtrace for output
2634 $backtraceArray = debug_backtrace();
2635 foreach ($backtraceArray as $key => $trace) {
2636 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
2637 if (!isset($trace['line'])) $trace['line'] = __LINE__;
2638 if (!isset($trace['args'])) $trace['args'] = array();
2639 $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";
2643 $backtrace .= "</ol>\n";
2645 // Return the backtrace
2649 // Output a debug backtrace to the user
2650 function debug_report_bug ($message = '') {
2653 // Is the optional message set?
2654 if (!empty($message)) {
2656 $debug = sprintf("Note: %s<br />\n",
2660 // @TODO Add a little more infos here
2661 DEBUG_LOG(__FUNCTION__, __LINE__, $message);
2665 $debug .= "Please report this bug at <a title=\"Direct link to the bug-tracker\" href=\"http://bugs.mxchange.org\" rel=\"external\" target=\"_blank\">bugs.mxchange.org</a> and include the logfile from <strong>inc/cache/debug.log</strong> in your report (you can now attach files):<pre>";
2666 $debug .= debug_get_printable_backtrace();
2667 $debug .= "</pre>\nRequest-URI: " . $_SERVER['REQUEST_URI']."<br />\n";
2668 $debug .= "Thank you for finding bugs.";
2671 // @TODO This cannot be rewritten to app_die(), try to find a solution for this.
2675 // Generates a ***weak*** seed (taken from de.php.net/mt_srand)
2676 function generateSeed () {
2677 list($usec, $sec) = explode(' ', microtime());
2678 $microTime = (((float)$sec + (float)$usec)) * 100000;
2682 // Converts a message code to a human-readable message
2683 function convertCodeToMessage ($code) {
2686 case getCode('LOGOUT_DONE') : $message = getMessage('LOGOUT_DONE'); break;
2687 case getCode('LOGOUT_FAILED') : $message = "<span class=\"guest_failed\">{--LOGOUT_FAILED--}</span>"; break;
2688 case getCode('DATA_INVALID') : $message = getMessage('MAIL_DATA_INVALID'); break;
2689 case getCode('POSSIBLE_INVALID') : $message = getMessage('MAIL_POSSIBLE_INVALID'); break;
2690 case getCode('ACCOUNT_LOCKED') : $message = getMessage('MEMBER_ACCOUNT_LOCKED_UNC'); break;
2691 case getCode('USER_404') : $message = getMessage('USER_NOT_FOUND'); break;
2692 case getCode('STATS_404') : $message = getMessage('MAIL_STATS_404'); break;
2693 case getCode('ALREADY_CONFIRMED'): $message = getMessage('MAIL_ALREADY_CONFIRMED'); break;
2695 case getCode('ERROR_MAILID'):
2696 if (EXT_IS_ACTIVE($ext, true)) {
2697 $message = getMessage('ERROR_CONFIRMING_MAIL');
2699 $message = sprintf(getMessage('EXTENSION_PROBLEM_NOT_INSTALLED'), 'mailid');
2703 case getCode('EXTENSION_PROBLEM'):
2704 if (REQUEST_ISSET_GET('ext')) {
2705 $message = generateExtensionInactiveNotInstalledMessage(REQUEST_GET('ext'));
2707 $message = getMessage('EXTENSION_PROBLEM_UNSET_EXT');
2711 case getCode('COOKIES_DISABLED') : $message = getMessage('LOGIN_NO_COOKIES'); break;
2712 case getCode('BEG_SAME_AS_OWN') : $message = getMessage('BEG_SAME_UID_AS_OWN'); break;
2713 case getCode('LOGIN_FAILED') : $message = getMessage('LOGIN_FAILED_GENERAL'); break;
2714 case getCode('MODULE_MEM_ONLY') : $message = sprintf(getMessage('MODULE_MEM_ONLY'), REQUEST_GET('mod')); break;
2717 // Missing/invalid code
2718 $message = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code);
2721 DEBUG_LOG(__FUNCTION__, __LINE__, $message);
2725 // Return the message
2729 // Generate a "link" for the given admin id (aid)
2730 function generateAdminLink ($aid) {
2731 // No assigned admin is default
2732 $admin = "<span class=\"admin_note\">{--ADMIN_NO_ADMIN_ASSIGNED--}</span>";
2734 // Zero? = Not assigned
2735 if (bigintval($aid) > 0) {
2736 // Load admin's login
2737 $login = getAdminLogin($aid);
2739 // Is the login valid?
2740 if ($login != '***') {
2741 // Is the extension there?
2742 if (EXT_IS_ACTIVE('admins')) {
2744 $admin = "<a href=\"".generateEmailLink(getAdminEmail($aid), 'admins')."\">" . $login."</a>";
2746 // Extension not found
2747 $admin = sprintf(getMessage('EXTENSION_PROBLEM_NOT_INSTALLED'), 'admins');
2751 $admin = "<div class=\"admin_note\">".sprintf(getMessage('ADMIN_ID_404'), $aid)."</div>";
2759 // Compile characters which are allowed in URLs
2760 function compileUriCode ($code, $simple = true) {
2761 // Compile constants
2762 if (!$simple) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
2764 // Compile QUOT and other non-HTML codes
2765 $code = str_replace('{DOT}', '.',
2766 str_replace('{SLASH}', '/',
2767 str_replace('{QUOT}', "'",
2768 str_replace('{DOLLAR}', '$',
2769 str_replace('{OPEN_ANCHOR}', '(',
2770 str_replace('{CLOSE_ANCHOR}', ')',
2771 str_replace('{OPEN_SQR}', '[',
2772 str_replace('{CLOSE_SQR}', ']',
2773 str_replace('{PER}', '%',
2777 // Return compiled code
2781 // Function taken from user comments on www.php.net / function eregi()
2782 function isUrlValidSimple ($url) {
2784 $url = strip_tags(str_replace("\\", '', COMPILE_CODE(urldecode($url))));
2786 // Allows http and https
2787 $http = "(http|https)+(:\/\/)";
2789 $domain1 = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
2790 // Test double-domains (e.g. .de.vu)
2791 $domain2 = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
2793 $ip = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
2795 $dir = "((/)+([-_\.[:alnum:]])+)*";
2797 $page = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
2798 // ... and the string after and including question character
2799 $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
2800 // Pattern for URLs like http://url/dir/doc.html?var=value
2801 $pattern['d1dpg1'] = $http . $domain1 . $dir . $page . $getstring1;
2802 $pattern['d2dpg1'] = $http . $domain2 . $dir . $page . $getstring1;
2803 $pattern['ipdpg1'] = $http . $ip . $dir . $page . $getstring1;
2804 // Pattern for URLs like http://url/dir/?var=value
2805 $pattern['d1dg1'] = $http . $domain1 . $dir.'/' . $getstring1;
2806 $pattern['d2dg1'] = $http . $domain2 . $dir.'/' . $getstring1;
2807 $pattern['ipdg1'] = $http . $ip . $dir.'/' . $getstring1;
2808 // Pattern for URLs like http://url/dir/page.ext
2809 $pattern['d1dp'] = $http . $domain1 . $dir . $page;
2810 $pattern['d1dp'] = $http . $domain2 . $dir . $page;
2811 $pattern['ipdp'] = $http . $ip . $dir . $page;
2812 // Pattern for URLs like http://url/dir
2813 $pattern['d1d'] = $http . $domain1 . $dir;
2814 $pattern['d2d'] = $http . $domain2 . $dir;
2815 $pattern['ipd'] = $http . $ip . $dir;
2816 // Pattern for URLs like http://url/?var=value
2817 $pattern['d1g1'] = $http . $domain1 . '/' . $getstring1;
2818 $pattern['d2g1'] = $http . $domain2 . '/' . $getstring1;
2819 $pattern['ipg1'] = $http . $ip . '/' . $getstring1;
2820 // Pattern for URLs like http://url?var=value
2821 $pattern['d1g12'] = $http . $domain1 . $getstring1;
2822 $pattern['d2g12'] = $http . $domain2 . $getstring1;
2823 $pattern['ipg12'] = $http . $ip . $getstring1;
2824 // Test all patterns
2826 foreach ($pattern as $key => $pat) {
2828 if (isDebugRegExpressionEnabled()) {
2829 // @TODO Are these convertions still required?
2830 $pat = str_replace('.', "\.", $pat);
2831 $pat = str_replace('@', "\@", $pat);
2832 //* DEBUG: */ OUTPUT_HTML($key."= " . $pat . "<br />");
2835 // Check if expression matches
2836 $reg = ($reg || preg_match(('^' . $pat.'^'), $url));
2839 if ($reg === true) break;
2842 // Return true/false
2846 // Wtites data to a config.php-style file
2847 // @TODO Rewrite this function to use readFromFile() and writeToFile()
2848 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
2849 // Initialize some variables
2855 // Is the file there and read-/write-able?
2856 if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
2857 $search = 'CFG: ' . $comment;
2858 $tmp = $FQFN . '.tmp';
2860 // Open the source file
2861 $fp = fopen($FQFN, 'r') or OUTPUT_HTML('<strong>READ:</strong> ' . $FQFN . '<br />');
2863 // Is the resource valid?
2864 if (is_resource($fp)) {
2865 // Open temporary file
2866 $fp_tmp = fopen($tmp, 'w') or OUTPUT_HTML('<strong>WRITE:</strong> ' . $tmp . '<br />');
2868 // Is the resource again valid?
2869 if (is_resource($fp_tmp)) {
2870 while (!feof($fp)) {
2871 // Read from source file
2872 $line = fgets ($fp, 1024);
2874 if (strpos($line, $search) > -1) { $next = 0; $found = true; }
2877 if ($next === $seek) {
2879 $line = $prefix . $DATA . $suffix . "\n";
2885 // Write to temp file
2886 fputs($fp_tmp, $line);
2892 // Finished writing tmp file
2896 // Close source file
2899 if (($done === true) && ($found === true)) {
2900 // Copy back tmp file and delete tmp :-)
2901 copyFileVerified($tmp, $FQFN, 0644);
2902 return removeFile($tmp);
2903 } elseif ($found === false) {
2904 OUTPUT_HTML('<strong>CHANGE:</strong> 404!');
2906 OUTPUT_HTML('<strong>TMP:</strong> UNDONE!');
2910 // File not found, not readable or writeable
2911 OUTPUT_HTML('<strong>404:</strong> ' . $FQFN . '<br />');
2914 // An error was detected!
2917 // Send notification to admin
2918 function sendAdminNotification ($subject, $templateName, $content=array(), $uid = '0') {
2919 if (GET_EXT_VERSION('admins') >= '0.4.1') {
2921 SEND_ADMIN_EMAILS_PRO($subject, $templateName, $content, $uid);
2923 // Send out out-dated way
2924 $message = LOAD_EMAIL_TEMPLATE($templateName, $content, $uid);
2925 SEND_ADMIN_EMAILS($subject, $message);
2929 // Debug message logger
2930 function DEBUG_LOG ($funcFile, $line, $message, $force=true) {
2931 // Is debug mode enabled?
2932 if ((isDebugModeEnabled()) || ($force === true)) {
2934 $message = str_replace("\r", '', str_replace("\n", '', $message));
2936 // Log this message away, we better don't call app_die() here to prevent an endless loop
2937 $fp = fopen(constant('PATH') . 'inc/cache/debug.log', 'a') or die(__FUNCTION__.'['.__LINE__.']: Cannot write logfile debug.log!');
2938 fwrite($fp, date('d.m.Y|H:i:s', time()) . '|' . getModule() . '|' . basename($funcFile) . '|' . $line . '|' . strip_tags($message) . "\n");
2943 // Load more reset scripts
2944 function runResetIncludes () {
2945 // Is the reset set or old sql_patches?
2946 if ((!isResetModeEnabled()) || (EXT_VERSION_IS_OLDER('sql_patches', '0.4.5'))) {
2948 DEBUG_LOG(__FUNCTION__, __LINE__, 'Cannot run reset! Please report this bug. Thanks');
2951 // Get more daily reset scripts
2952 SET_INC_POOL(getArrayFromDirectory('inc/reset/', 'reset_'));
2955 if (getConfig('DEBUG_RESET') != 'Y') updateConfiguration('last_update', time());
2957 // Is the config entry set?
2958 if (GET_EXT_VERSION('sql_patches') >= '0.4.2') {
2959 // Create current week mark
2960 $currWeek = date('W', time());
2963 if (getConfig('last_week') != $currWeek) {
2964 // Include weekly reset scripts
2965 MERGE_INC_POOL(getArrayFromDirectory('inc/weekly/', 'weekly_'));
2968 if (getConfig('DEBUG_WEEKLY') != 'Y') updateConfiguration('last_week', $currWeek);
2971 // Create current month mark
2972 $currMonth = date('m', time());
2975 if (getConfig('last_month') != $currMonth) {
2976 // Include monthly reset scripts
2977 MERGE_INC_POOL(getArrayFromDirectory('inc/monthly/', 'monthly_'));
2980 if (getConfig('DEBUG_MONTHLY') != 'Y') updateConfiguration('last_month', $currMonth);
2985 runFilterChain('load_includes');
2988 // Handle extra values
2989 function handleExtraValues ($filterFunction, $value, $extraValue) {
2990 // Default is the value itself
2993 // Do we have a special filter function?
2994 if (!empty($filterFunction)) {
2995 // Does the filter function exist?
2996 if (function_exists($filterFunction)) {
2997 // Do we have extra parameters here?
2998 if (!empty($extraValue)) {
2999 // Put both parameters in one new array by default
3000 $args = array($value, $extraValue);
3002 // If we have an array simply use it and pre-extend it with our value
3003 if (is_array($extraValue)) {
3004 // Make the new args array
3005 $args = merge_array(array($value), $extraValue);
3008 // Call the multi-parameter call-back
3009 $ret = call_user_func_array($filterFunction, $args);
3011 // One parameter call
3012 $ret = call_user_func($filterFunction, $value);
3021 // Converts timestamp selections into a timestamp
3022 function convertSelectionsToTimestamp (&$POST, &$DATA, &$id, &$skip) {
3023 // Init test variable
3026 // Get last three chars
3027 $test = substr($id, -3);
3029 // Improved way of checking! :-)
3030 if (in_array($test, array('_ye', '_mo', '_we', '_da', '_ho', '_mi', '_se'))) {
3031 // Found a multi-selection for timings?
3032 $test = substr($id, 0, -3);
3033 if ((isset($POST[$test.'_ye'])) && (isset($POST[$test.'_mo'])) && (isset($POST[$test.'_we'])) && (isset($POST[$test.'_da'])) && (isset($POST[$test.'_ho'])) && (isset($POST[$test.'_mi'])) && (isset($POST[$test.'_se'])) && ($test != $test2)) {
3034 // Generate timestamp
3035 $POST[$test] = createTimestampFromSelections($test, $POST);
3036 $DATA[] = sprintf("%s='%s'", $test, $POST[$test]);
3038 // Remove data from array
3039 foreach (array('ye', 'mo', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
3040 unset($POST[$test.'_' . $rem]);
3044 unset($id); $skip = true; $test2 = $test;
3047 // Process this entry
3053 // Reverts the german decimal comma into Computer decimal dot
3054 function convertCommaToDot ($str) {
3055 // Default float is not a float... ;-)
3058 // Which language is selected?
3059 switch (getLanguage()) {
3060 case 'de': // German language
3061 // Remove german thousand dots first
3062 $str = str_replace('.', '', $str);
3064 // Replace german commata with decimal dot and cast it
3065 $float = (float)str_replace(',', '.', $str);
3068 default: // US and so on
3069 // Remove thousand dots first and cast
3070 $float = (float)str_replace(',', '', $str);
3078 // Handle menu-depending failed logins and return the rendered content
3079 function HANDLE_LOGIN_FAILTURES ($accessLevel) {
3080 // Default output is empty ;-)
3083 // Is the session data set?
3084 if ((isSessionVariableSet('mxchange_' . $accessLevel.'_failures')) && (isSessionVariableSet('mxchange_' . $accessLevel.'_last_fail'))) {
3085 // Ignore zero values
3086 if (getSession('mxchange_' . $accessLevel.'_failures') > 0) {
3087 // Non-guest has login failures found, get both data and prepare it for template
3088 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):accessLevel={$accessLevel}<br />");
3090 'login_failures' => getSession('mxchange_' . $accessLevel.'_failures'),
3091 'last_failure' => generateDateTime(getSession('mxchange_' . $accessLevel.'_last_fail'), '2')
3095 $OUT = LOAD_TEMPLATE('login_failures', true, $content);
3098 // Reset session data
3099 setSession('mxchange_' . $accessLevel.'_failures', '');
3100 setSession('mxchange_' . $accessLevel.'_last_fail', '');
3103 // Return rendered content
3108 function rebuildCacheFiles ($cache, $inc = '') {
3109 // Shall I remove the cache file?
3110 if ((EXT_IS_ACTIVE('cache')) && (isCacheInstanceValid())) {
3112 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
3114 $GLOBALS['cache_instance']->destroyCacheFile();
3117 // Include file given?
3120 $INC = sprintf("inc/loader/load_cache-%s.php", $inc);
3122 // Is the include there?
3123 if (isIncludeReadable($INC)) {
3124 // And rebuild it from scratch
3125 //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): inc={$inc} - LOADED!<br />");
3128 // Include not found!
3129 DEBUG_LOG(__FUNCTION__, __LINE__, "Include {$inc} not found. cache={$cache}");
3135 // Purge admin menu cache
3136 function cachePurgeAdminMenu ($id=0, $action = '', $what = '', $str = '') {
3137 // Is the cache extension enabled or no cache instance or admin menu cache disabled?
3138 if (!EXT_IS_ACTIVE('cache')) {
3139 // Cache extension not active
3141 } elseif (!isCacheInstanceValid()) {
3142 // No cache instance!
3143 DEBUG_LOG(__FUNCTION__, __LINE__, 'No cache instance found.');
3145 } elseif ((!isConfigEntrySet('cache_admin_menu')) || (getConfig('cache_admin_menu') != 'Y')) {
3146 // Caching disabled (currently experiemental!)
3150 // Experiemental feature!
3151 debug_report_bug("<strong>Experimental feature:</strong> You have to delete the admin_*.cache files by yourself at this point.");
3154 // Determines the real remote address
3155 function determineRealRemoteAddress () {
3156 // Is a proxy in use?
3157 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])){
3159 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
3160 } elseif (isset($_SERVER['HTTP_CLIENT_IP'])){
3161 // Yet, another proxy
3162 $address = $_SERVER['HTTP_CLIENT_IP'];
3164 // The regular address when no proxy was used
3165 $address = $_SERVER['REMOTE_ADDR'];
3168 // This strips out the real address from proxy output
3169 if (strstr($address, ',')){
3170 $addressArray = explode(',', $address);
3171 $address = $addressArray[0];
3174 // Return the result
3178 // Adds a bonus mail to the queue
3179 // This is a high-level function!
3180 function addNewBonusMail ($data, $mode = '', $output=true) {
3181 // Use mode from data if not set and availble ;-)
3182 if ((empty($mode)) && (isset($data['mode']))) $mode = $data['mode'];
3184 // Generate receiver list
3185 $RECEIVER = generateReceiverList($data['cat'], $data['receiver'], $mode);
3188 if (!empty($RECEIVER)) {
3189 // Add bonus mail to queue
3190 addBonusMailToQueue(
3202 // Mail inserted into bonus pool
3203 if ($output) LOAD_TEMPLATE('admin_settings_saved', false, getMessage('ADMIN_BONUS_SEND'));
3204 } elseif ($output) {
3205 // More entered than can be reached!
3206 LOAD_TEMPLATE('admin_settings_saved', false, getMessage('ADMIN_MORE_SELECTED'));
3209 DEBUG_LOG(__FUNCTION__, __LINE__, "cat={$data['cat']},receiver={$data['receiver']},data=".base64_encode(serialize($data))." More selected, than available!");
3213 // Determines referal id and sets it
3214 function DETERMINE_REFID () {
3215 // Check if refid is set
3216 if ((REQUEST_ISSET_GET('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
3217 // The variable user comes from the click-counter script click.php and we only accept this here
3218 $GLOBALS['refid'] = bigintval(REQUEST_GET('user'));
3219 } elseif (REQUEST_ISSET_POST('refid')) {
3220 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3221 $GLOBALS['refid'] = strip_tags(REQUEST_POST('refid'));
3222 } elseif (REQUEST_ISSET_GET('refid')) {
3223 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3224 $GLOBALS['refid'] = strip_tags(REQUEST_GET('refid'));
3225 } elseif (REQUEST_ISSET_GET('ref')) {
3226 // Set refid=ref (the referal link uses such variable)
3227 $GLOBALS['refid'] = strip_tags(REQUEST_GET('ref'));
3228 } elseif ((isSessionVariableSet('refid')) && (getSession('refid') != 0)) {
3229 // Set session refid als global
3230 $GLOBALS['refid'] = bigintval(getSession('refid'));
3231 } elseif ((GET_EXT_VERSION('user') >= '0.3.4') && (getConfig('select_user_zero_refid')) == 'Y') {
3232 // Select a random user which has confirmed enougth mails
3233 $GLOBALS['refid'] = determineRandomReferalId();
3234 } elseif ((GET_EXT_VERSION('sql_patches') != '') && (getConfig('def_refid') > 0)) {
3235 // Set default refid as refid in URL
3236 $GLOBALS['refid'] = getConfig('def_refid');
3238 // No default ID when sql_patches is not installed or none set
3239 $GLOBALS['refid'] = 0;
3242 // Set cookie when default refid > 0
3243 if (!isSessionVariableSet('refid') || (!empty($GLOBALS['refid'])) || ((getSession('refid') == '0') && (getConfig('def_refid') > 0))) {
3245 setSession('refid', $GLOBALS['refid']);
3248 // Return determined refid
3249 return $GLOBALS['refid'];
3252 // Enables the reset mode. Only call this function if you really want the
3254 function enableResetMode () {
3255 // Enable the reset mode
3256 $GLOBALS['reset_enabled'] = true;
3259 runFilterChain('reset_enabled');
3262 // Our shutdown-function
3263 function shutdown () {
3264 // Call the filter chain 'shutdown'
3265 runFilterChain('shutdown', null, false);
3267 if (SQL_IS_LINK_UP()) {
3269 SQL_CLOSE(__FILE__, __LINE__);
3270 } elseif ((!isInstalling()) && (isInstalled())) {
3272 addFatalMessage(__FILE__, __LINE__, getMessage('NO_DB_LINK_SHUTDOWN'));
3275 // Stop executing here
3279 // Setter for userid
3280 function setUserId ($userid) {
3281 $GLOBALS['userid'] = bigintval($userid);
3284 // Getter for userid or returns zero
3285 function getUserId () {
3289 // Is the userid set?
3290 if (isUserIdSet()) {
3292 $userid = $GLOBALS['userid'];
3299 // Checks ether the userid is set
3300 function isUserIdSet () {
3301 return (isset($GLOBALS['userid']));
3304 // Handle message codes from URL
3305 function handleCodeMessage () {
3306 if (REQUEST_ISSET_GET('msg')) {
3307 // Default extension is 'unknown'
3310 // Is extension given?
3311 if (REQUEST_ISSET_GET('ext')) $ext = REQUEST_GET('ext');
3313 // Convert the 'msg' parameter from URL to a human-readable message
3314 $message = convertCodeToMessage(REQUEST_GET('msg'));
3316 // Load message template
3317 LOAD_TEMPLATE('message', false, $message);
3321 // Setter for extra title
3322 function setExtraTitle ($extraTitle) {
3323 $GLOBALS['extra_title'] = $extraTitle;
3326 // Getter for extra title
3327 function getExtraTitle () {
3328 // Is the extra title set?
3329 if (!isExtraTitleSet()) {
3330 // No, then abort here
3331 debug_report_bug('extra_title is not set!');
3335 return $GLOBALS['extra_title'];
3338 // Checks if the extra title is set
3339 function isExtraTitleSet () {
3340 return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
3343 // Generates a 'extension foo inactive' message
3344 function generateExtensionInactiveMessage ($ext_name) {
3345 // Is the extension empty?
3346 if (empty($ext_name)) {
3347 // This should not happen
3348 trigger_error(__FUNCTION__ . ': Parameter ext is empty. This should not happen.');
3352 $message = sprintf(getMessage('EXTENSION_PROBLEM_EXT_INACTIVE'), $ext_name);
3354 // Is an admin logged in?
3356 // Then output admin message
3357 $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXT_INACTIVE'), $ext_name);
3360 // Return prepared message
3364 // Generates a 'extension foo not installed' message
3365 function generateExtensionNotInstalledMessage ($ext_name) {
3366 // Is the extension empty?
3367 if (empty($ext_name)) {
3368 // This should not happen
3369 trigger_error(__FUNCTION__ . ': Parameter ext is empty. This should not happen.');
3373 $message = sprintf(getMessage('EXTENSION_PROBLEM_EXT_NOT_INSTALLED'), $ext_name);
3375 // Is an admin logged in?
3377 // Then output admin message
3378 $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXT_NOT_INSTALLED'), $ext_name);
3381 // Return prepared message
3385 // Generates a message depending on if the extension is not installed or not
3387 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
3391 // Is the extension not installed or just deactivated?
3392 switch (isExtensionInstalled($ext_name)) {
3393 case true; // Deactivated!
3394 $message = generateExtensionInactiveMessage($ext_name);
3397 case false; // Not installed!
3398 $message = generateExtensionNotInstalledMessage($ext_name);
3401 default: // Should not happen!
3402 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
3403 $message = sprintf("Invalid state of extension %s detected.", $ext_name);
3407 // Return the message
3411 // Reads a directory recursively by default and searches for files not matching
3412 // an exclusion pattern. You can now keep the exclusion pattern empty for reading
3413 // a whole directory.
3414 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $addBaseDir = true, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = true) {
3415 // Add default entries we should exclude
3416 $excludeArray[] = '.';
3417 $excludeArray[] = '..';
3418 $excludeArray[] = '.svn';
3419 $excludeArray[] = '.htaccess';
3421 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
3426 $dirPointer = opendir(constant('PATH') . $baseDir) or app_die(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
3429 while ($baseFile = readdir($dirPointer)) {
3430 // Exclude '.', '..' and entries in $excludeArray automatically
3431 if (in_array($baseFile, $excludeArray, true)) {
3433 //* DEBUG: */ OUTPUT_HTML('excluded=' . $baseFile . "<br />");
3437 // Construct include filename and FQFN
3438 $fileName = $baseDir . '/' . $baseFile;
3439 $FQFN = constant('PATH') . $fileName;
3441 // Remove double slashes
3442 $FQFN = str_replace('//', '/', $FQFN);
3444 // Check if the base filename matches an exclusion pattern and if the pattern is not empty
3445 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
3446 // These Lines are only for debugging!!
3447 //* DEBUG: */ OUTPUT_HTML('baseDir:' . $baseDir . "<br />");
3448 //* DEBUG: */ OUTPUT_HTML('baseFile:' . $baseFile . "<br />");
3449 //* DEBUG: */ OUTPUT_HTML('FQFN:' . $FQFN . "<br />");
3455 // Skip also files with non-matching prefix genericly
3456 if (($recursive === true) && (isDirectory($FQFN))) {
3457 // Is a redirectory so read it as well
3458 $files = merge_array($files, getArrayFromDirectory ($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
3460 // And skip further processing
3462 } elseif (substr($baseFile, 0, strlen($prefix)) != $prefix) {
3464 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Invalid prefix in file " . $baseFile . ", prefix=" . $prefix);
3466 } elseif (!isFileReadable($FQFN)) {
3467 // Not readable so skip it
3468 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "File " . $FQFN . " is not readable!");
3472 // Is the file a PHP script or other?
3473 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
3474 if ((substr($baseFile, -4, 4) == '.php') || (($fileIncludeDirs === true) && (isDirectory($FQFN)))) {
3475 // Is this a valid include file?
3476 if ($extension == '.php') {
3477 // Remove both for extension name
3478 $extName = substr($baseFile, strlen($prefix), -4);
3481 $extId = GET_EXT_ID($extName);
3483 // Is the extension valid and active?
3484 if (($extId > 0) && (EXT_IS_ACTIVE($extName))) {
3485 // Then add this file
3486 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, 'Extension entry ' . $baseFile . ' added.');
3487 $files[] = $fileName;
3488 } elseif ($extId == 0) {
3489 // Add non-extension files as well
3490 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, 'Regular entry ' . $baseFile . ' added.');
3491 if ($addBaseDir === true) {
3492 $files[] = $fileName;
3494 $files[] = $baseFile;
3498 // We found .php file but should not search for them, why?
3499 debug_report_bug('We should find files with extension=' . $extension . ', but we found a PHP script.');
3502 // Other, generic file found
3503 $files[] = $fileName;
3508 closedir($dirPointer);
3513 // Return array with include files
3514 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, '- Left!');
3518 //////////////////////////////////////////////////
3519 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
3520 //////////////////////////////////////////////////
3522 if (!function_exists('html_entity_decode')) {
3523 // Taken from documentation on www.php.net
3524 function html_entity_decode ($string) {
3525 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
3526 $trans_tbl = array_flip($trans_tbl);
3527 return strtr($string, $trans_tbl);