2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 08/25/2003 *
4 * =================== Last change: 11/29/2005 *
6 * -------------------------------------------------------------------- *
7 * File : functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Many non-MySQL functions (also file access) *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // Sends out all headers required for HTTP/1.1 reply
46 function sendHttpHeaders () {
48 $now = gmdate('D, d M Y H:i:s') . ' GMT';
51 sendHeader('HTTP/1.1 ' . getHttpStatus());
53 // General headers for no caching
54 sendHeader('Expires: ' . $now); // RFC2616 - Section 14.21
55 sendHeader('Last-Modified: ' . $now);
56 sendHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
57 sendHeader('Pragma: no-cache'); // HTTP/1.0
58 sendHeader('Connection: Close');
59 sendHeader('Content-Type: ' . getContentType() . '; charset=UTF-8');
60 sendHeader('Content-Language: ' . getLanguage());
63 // Init fatal message array
64 function initFatalMessages () {
65 $GLOBALS['fatal_messages'] = array();
68 // Getter for whole fatal error messages
69 function getFatalArray () {
70 return $GLOBALS['fatal_messages'];
73 // Add a fatal error message to the queue array
74 function addFatalMessage ($F, $L, $message, $extra = '') {
75 if (is_array($extra)) {
76 // Multiple extras for a message with masks
77 $message = call_user_func_array('sprintf', $extra);
78 } elseif (!empty($extra)) {
79 // $message is text with a mask plus extras to insert into the text
80 $message = sprintf($message, $extra);
83 // Add message to $GLOBALS['fatal_messages']
84 $GLOBALS['fatal_messages'][] = $message;
86 // Log fatal messages away
87 logDebugMessage($F, $L, 'Fatal error message: ' . $message);
90 // Getter for total fatal message count
91 function getTotalFatalErrors () {
95 // Do we have at least the first entry?
96 if (!empty($GLOBALS['fatal_messages'][0])) {
98 $count = count($GLOBALS['fatal_messages']);
105 // Send mail out to an email address
106 function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '') {
107 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "TO={$toEmail},SUBJECT={$subject}<br />");
109 // Compile subject line (for POINTS constant etc.)
110 eval('$subject = decodeEntities("' . compileRawCode(escapeQuotes($subject)) . '");');
113 if ((!isInStringIgnoreCase('@', $toEmail)) && ($toEmail > 0)) {
114 // Value detected, is the message extension installed?
115 // @TODO Extension 'msg' does not exist
116 if (isExtensionActive('msg')) {
117 ADD_MESSAGE_TO_BOX($toEmail, $subject, $message, $isHtml);
120 // Does the user exist?
121 if (fetchUserData($toEmail)) {
123 $toEmail = getUserData('email');
126 $toEmail = getConfig('WEBMASTER');
129 } elseif ($toEmail == '0') {
131 $toEmail = getConfig('WEBMASTER');
133 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "TO={$toEmail}<br />");
135 // Check for PHPMailer or debug-mode
136 if ((!checkPhpMailerUsage()) || (isDebugModeEnabled())) {
137 // Not in PHPMailer-Mode
138 if (empty($mailHeader)) {
139 // Load email header template
140 $mailHeader = loadEmailTemplate('header');
143 $mailHeader .= loadEmailTemplate('header');
147 // Fix HTML parameter (default is no!)
148 if (empty($isHtml)) $isHtml = 'N';
150 // Debug mode enabled?
151 if (isDebugModeEnabled()) {
152 // In debug mode we want to display the mail instead of sending it away so we can debug this part
154 Headers : ' . encodeEntities(utf8_decode(trim($mailHeader))) . '
155 To : ' . encodeEntities(utf8_decode($toEmail)) . '
156 Subject : ' . encodeEntities(utf8_decode($subject)) . '
157 Message : ' . encodeEntities(utf8_decode($message)) . '
160 // This is always fine
162 } elseif (($isHtml == 'Y') && (isExtensionActive('html_mail'))) {
163 // Send mail as HTML away
164 return sendHtmlEmail($toEmail, $subject, $message, $mailHeader);
165 } elseif (!empty($toEmail)) {
167 return sendRawEmail($toEmail, $subject, $message, $mailHeader);
168 } elseif ($isHtml != 'Y') {
170 return sendRawEmail(getConfig('WEBMASTER'), '[PROBLEM:]' . $subject, $message, $mailHeader);
173 // Why did we end up here? This should not happen
174 debug_report_bug(__FUNCTION__, __LINE__, 'Ending up: template=' . $template);
177 // Check to use wether legacy mail() command or PHPMailer class
178 // @TODO Rewrite this to an extension 'smtp'
180 function checkPhpMailerUsage() {
181 return ((getConfig('SMTP_HOSTNAME') != '') && (getConfig('SMTP_USER') != ''));
184 // Send out a raw email with PHPMailer class or legacy mail() command
185 function sendRawEmail ($toEmail, $subject, $message, $from) {
186 // Just compile all again, to put out all configs, etc.
187 eval('$toEmail = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($toEmail)), false) . '");');
188 eval('$subject = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($subject)), false) . '");');
189 eval('$message = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($message)), false) . '");');
190 eval('$from = decodeEntities("' . doFinalCompilation(compileRawCode(escapeQuotes($from)) , false) . '");');
192 // Shall we use PHPMailer class or legacy mode?
193 if (checkPhpMailerUsage()) {
194 // Use PHPMailer class with SMTP enabled
195 loadIncludeOnce('inc/phpmailer/class.phpmailer.php');
196 loadIncludeOnce('inc/phpmailer/class.smtp.php');
199 $mail = new PHPMailer();
201 // Set charset to UTF-8
202 $mail->CharSet = 'UTF-8';
204 // Path for PHPMailer
205 $mail->PluginDir = sprintf("%sinc/phpmailer/", getPath());
208 $mail->SMTPAuth = true;
209 $mail->Host = getConfig('SMTP_HOSTNAME');
211 $mail->Username = getConfig('SMTP_USER');
212 $mail->Password = getConfig('SMTP_PASSWORD');
214 $mail->From = getConfig('WEBMASTER');
218 $mail->FromName = getMainTitle();
219 $mail->Subject = $subject;
220 if ((isExtensionActive('html_mail')) && (secureString($message) != $message)) {
221 $mail->Body = $message;
222 $mail->AltBody = 'Your mail program required HTML support to read this mail!';
223 $mail->WordWrap = 70;
226 $mail->Body = decodeEntities($message);
228 $mail->AddAddress($toEmail, '');
229 $mail->AddReplyTo(getConfig('WEBMASTER'), getMainTitle());
230 $mail->AddCustomHeader('Errors-To:' . getConfig('WEBMASTER'));
231 $mail->AddCustomHeader('X-Loop:' . getConfig('WEBMASTER'));
234 // Has an error occured?
235 if (!empty($mail->ErrorInfo)) {
237 logDebugMessage(__FUNCTION__, __LINE__, 'Error while sending mail: ' . $mail->ErrorInfo);
246 // Use legacy mail() command
247 return mail($toEmail, $subject, decodeEntities($message), $from);
251 // Generate a password in a specified length or use default password length
252 function generatePassword ($length = '0') {
253 // Auto-fix invalid length of zero
254 if ($length == '0') $length = getConfig('pass_len');
256 // Initialize array with all allowed chars
257 $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,-,+,_,/,.');
259 // Start creating password
261 for ($i = '0'; $i < $length; $i++) {
262 $PASS .= $ABC[mt_rand(0, count($ABC) -1)];
265 // When the size is below 40 we can also add additional security by scrambling
266 // it. Otherwise we may corrupt hashes
267 if (strlen($PASS) <= 40) {
268 // Also scramble the password
269 $PASS = scrambleString($PASS);
272 // Return the password
276 // Generates a human-readable timestamp from the Uni* stamp
277 function generateDateTime ($time, $mode = '0') {
278 // If the stamp is zero it mostly didn't "happen"
281 return '{--NEVER_HAPPENED--}';
284 // Filter out numbers
285 $time = bigintval($time);
288 if (isset($GLOBALS[__FUNCTION__][$time][$mode])) {
290 return $GLOBALS[__FUNCTION__][$time][$mode];
294 switch (getLanguage()) {
295 case 'de': // German date / time format
297 case '0': $ret = date("d.m.Y \u\m H:i \U\h\\r", $time); break;
298 case '1': $ret = strtolower(date('d.m.Y - H:i', $time)); break;
299 case '2': $ret = date('d.m.Y|H:i', $time); break;
300 case '3': $ret = date('d.m.Y', $time); break;
301 case '4': $ret = date('d.m.Y|H:i:s', $time); break;
302 case '5': $ret = date('d-m-Y (l-F-T)', $time); break;
303 case '6': $ret = date('Ymd', $time); break;
305 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
310 default: // Default is the US date / time format!
312 case '0': $ret = date('r', $time); break;
313 case '1': $ret = strtolower(date('Y-m-d - g:i A', $time)); break;
314 case '2': $ret = date('y-m-d|H:i', $time); break;
315 case '3': $ret = date('y-m-d', $time); break;
316 case '4': $ret = date('d.m.Y|H:i:s', $time); break;
317 case '5': $ret = date('d-m-Y (l-F-T)', $time); break;
318 case '6': $ret = date('Ymd', $time); break;
320 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
326 $GLOBALS[__FUNCTION__][$time][$mode] = $ret;
332 // Translates Y/N to yes/no
333 function translateYesNo ($yn) {
335 if (!isset($GLOBALS[__FUNCTION__][$yn])) {
337 $GLOBALS[__FUNCTION__][$yn] = '??? (' . $yn . ')';
339 case 'Y': $GLOBALS[__FUNCTION__][$yn] = '{--YES--}'; break;
340 case 'N': $GLOBALS[__FUNCTION__][$yn] = '{--NO--}'; break;
343 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected Y/N!", $yn));
349 return $GLOBALS[__FUNCTION__][$yn];
352 // Translates the "pool type" into human-readable
353 function translatePoolType ($type) {
354 // Return "translation"
355 return sprintf("{--POOL_TYPE_%s--}", $type);
358 // Translates the american decimal dot into a german comma
359 function translateComma ($dotted, $cut = true, $max = '0') {
360 // First, cast all to double, due to PHP changes
361 $dotted = (double) $dotted;
363 // Default is 3 you can change this in admin area "Misc -> Misc Options"
364 if (!isConfigEntrySet('max_comma')) setConfigEntry('max_comma', 3);
366 // Use from config is default
367 $maxComma = getConfig('max_comma');
369 // Use from parameter?
370 if ($max > 0) $maxComma = $max;
373 if (($cut === true) && ($max == '0')) {
374 // Test for commata if in cut-mode
375 $com = explode('.', $dotted);
376 if (count($com) < 2) {
377 // Don't display commatas even if there are none... ;-)
385 $translated = $dotted;
386 switch (getLanguage()) {
387 case 'de': // German language
388 $translated = number_format($dotted, $maxComma, ',', '.');
391 default: // All others
392 $translated = number_format($dotted, $maxComma, '.', ',');
396 // Return translated value
397 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dotted=' . $dotted . ',translated=' . $translated . ',maxComma=' . $maxComma);
401 // Translate Uni*-like gender to human-readable
402 function translateGender ($gender) {
404 $ret = '!' . $gender . '!';
406 // Male/female or company?
409 $ret = sprintf("{--GENDER_%s--}", $gender);
413 // Please report bugs on unknown genders
414 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
418 // Return translated gender
422 // "Translates" the user status
423 function translateUserStatus ($status) {
424 // Generate message depending on status
429 $ret = sprintf("{--ACCOUNT_STATUS_%s--}", $status);
434 $ret = '{--ACCOUNT_STATUS_DELETED--}';
438 // Please report all unknown status
439 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown status %s(%s) detected.", $status, gettype($status)));
447 // "Translates" 'visible' and 'locked' to a CSS class
448 function translateMenuVisibleLocked ($content, $prefix = '') {
449 // Translate 'visible' and keep an eye on the prefix
450 switch ($content['visible']) {
452 case 'Y': $content['visible_css'] = $prefix . 'menu_visible' ; break;
453 case 'N': $content['visible_css'] = $prefix . 'menu_invisible'; break;
455 // Please report this
456 debug_report_bug(__FUNCTION__, __LINE__, 'Unsupported visible value detected. content=<pre>' . print_r($content, true) . '</pre>');
460 // Translate 'locked' and keep an eye on the prefix
461 switch ($content['locked']) {
463 case 'Y': $content['locked_css'] = $prefix . 'menu_locked' ; break;
464 case 'N': $content['locked_css'] = $prefix . 'menu_unlocked'; break;
466 // Please report this
467 debug_report_bug(__FUNCTION__, __LINE__, 'Unsupported locked value detected. content=<pre>' . print_r($content, true) . '</pre>');
471 // Return the resulting array
475 // Generates an URL for the dereferer
476 function generateDerefererUrl ($URL) {
477 // Don't de-refer our own links!
478 if (substr($URL, 0, strlen(getUrl())) != getUrl()) {
479 // De-refer this link
480 $URL = '{%url=modules.php?module=loader&url=' . encodeString(compileUriCode($URL)) . '%}';
487 // Generates an URL for the frametester
488 function generateFrametesterUrl ($URL) {
489 // Prepare frametester URL
490 $frametesterUrl = sprintf("{%%url=modules.php?module=frametester&url=%s%%}",
491 encodeString(compileUriCode($URL))
494 // Return the new URL
495 return $frametesterUrl;
498 // Count entries from e.g. a selection box
499 function countSelection ($array) {
501 if (!is_array($array)) {
503 debug_report_bug(__FUNCTION__, __LINE__, 'No array provided.');
510 foreach ($array as $key => $selected) {
512 if (!empty($selected)) $ret++;
515 // Return counted selections
519 // Generates a timestamp (some wrapper for mktime())
520 function makeTime ($hours, $minutes, $seconds, $stamp) {
521 // Extract day, month and year from given timestamp
522 $days = getDay($stamp);
523 $months = getMonth($stamp);
524 $years = getYear($stamp);
526 // Create timestamp for wished time which depends on extracted date
537 // Redirects to an URL and if neccessarry extends it with own base URL
538 function redirectToUrl ($URL, $allowSpider = true) {
540 if (substr($URL, 0, 6) == '{%url=') $URL = substr($URL, 6, -2);
543 eval('$URL = "' . compileRawCode(encodeUrl($URL)) . '";');
545 // Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
546 $rel = ' rel="external"';
548 // Do we have internal or external URL?
549 if (substr($URL, 0, strlen(getUrl())) == getUrl()) {
550 // Own (=internal) URL
554 // Three different ways to debug...
555 //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s[%s:] URL=%s", __FUNCTION__, __LINE__, $URL));
556 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $URL);
557 //* DEBUG: */ die($URL);
559 // Simple probe for bots/spiders from search engines
560 if ((isSpider()) && ($allowSpider === true)) {
562 setHttpStatus('200 OK');
564 // Set content-type here to fix a missing array element
565 setContentType('text/html');
567 // Output new location link as anchor
568 outputHtml('<a href="' . $URL . '"' . $rel . '>' . secureString($URL) . '</a>');
569 } elseif (!headers_sent()) {
570 // Clear output buffer
573 // Clear own output buffer
574 $GLOBALS['output'] = '';
577 setHttpStatus('302 Found');
579 // Load URL when headers are not sent
580 sendRawRedirect(doFinalCompilation(str_replace('&', '&', $URL), false));
582 // Output error message
583 loadInclude('inc/header.php');
584 loadTemplate('redirect_url', false, str_replace('&', '&', $URL));
585 loadInclude('inc/footer.php');
588 // Shut the mailer down here
592 /************************************************************************
594 * Gaenderter Sortier-Algorythmus, $array wird nach dem Array (!) *
595 * $a_sort sortiert: *
597 * $array - Das 3-dimensionale Array, das paralell sortiert werden soll *
598 * $a_sort - Array, das die Sortiereihenfolge der ersten Elementeben *
599 * $primary_key - Prim.rschl.ssel aus $a_sort, nach dem sortiert wird *
600 * $order - Sortiereihenfolge: -1 = a-Z, 0 = keine, 1 = Z-a *
601 * $nums - true = Als Zahlen sortieren, false = Als Zeichen sortieren *
603 * $a_sort muss Elemente enthalten, deren Wert Schluessel von $array *
604 * sind... Klingt kompliziert, suchen Sie mal mein Beispiel, dann sehen *
605 * Sie, dass es doch nicht so schwer ist! :-) *
607 ************************************************************************/
608 function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums = false) {
610 while ($primary_key < count($a_sort)) {
611 foreach ($dummy[$a_sort[$primary_key]] as $key => $value) {
612 foreach ($dummy[$a_sort[$primary_key]] as $key2 => $value2) {
614 if ($nums === false) {
615 // Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
616 if (($key != $key2) && (strcmp(strtolower($dummy[$a_sort[$primary_key]][$key]), strtolower($dummy[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
617 } elseif ($key != $key2) {
618 // Sort numbers (E.g.: 9 < 10)
619 if (($dummy[$a_sort[$primary_key]][$key] < $dummy[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
620 if (($dummy[$a_sort[$primary_key]][$key] > $dummy[$a_sort[$primary_key]][$key2]) && ($order == 1)) $match = true;
624 // We have found two different values, so let's sort whole array
625 foreach ($dummy as $sort_key => $sort_val) {
626 $t = $dummy[$sort_key][$key];
627 $dummy[$sort_key][$key] = $dummy[$sort_key][$key2];
628 $dummy[$sort_key][$key2] = $t;
639 // Write back sorted array
645 // Deprecated : $length
648 function generateRandomCode ($length, $code, $userid, $DATA = '') {
649 // Build server string
650 $server = $_SERVER['PHP_SELF'] . getEncryptSeperator() . detectUserAgent() . getEncryptSeperator() . getenv('SERVER_SOFTWARE') . getEncryptSeperator() . detectRemoteAddr();
653 $keys = getConfig('SITE_KEY') . getEncryptSeperator() . getConfig('DATE_KEY');
654 if (isConfigEntrySet('secret_key')) $keys .= getEncryptSeperator().getSecretKey();
655 if (isConfigEntrySet('file_hash')) $keys .= getEncryptSeperator().getFileHash();
656 $keys .= getEncryptSeperator() . getDateFromPatchTime();
657 if (isConfigEntrySet('master_salt')) $keys .= getEncryptSeperator().getMasterSalt();
659 // Build string from misc data
660 $data = $code . getEncryptSeperator() . $userid . getEncryptSeperator() . $DATA;
662 // Add more additional data
663 if (isSessionVariableSet('u_hash')) $data .= getEncryptSeperator() . getSession('u_hash');
665 // Add referal id, language, theme and userid
666 $data .= getEncryptSeperator() . determineReferalId();
667 $data .= getEncryptSeperator() . getLanguage();
668 $data .= getEncryptSeperator() . getCurrentTheme();
669 $data .= getEncryptSeperator() . getMemberId();
671 // Calculate number for generating the code
672 $a = $code + getConfig('_ADD') - 1;
674 if (isConfigEntrySet('master_salt')) {
675 // Generate hash with master salt from modula of number with the prime number and other data
676 $saltedHash = generateHash(($a % getPrime()) . getEncryptSeperator() . $server . getEncryptSeperator() . $keys . getEncryptSeperator() . $data . getEncryptSeperator() . getConfig('DATE_KEY') . getEncryptSeperator() . $a, getMasterSalt());
678 // Create number from hash
679 $rcode = hexdec(substr($saltedHash, strlen(getMasterSalt()), 9)) / abs(getConfig('rand_no') - $a + sqrt(getConfig('_ADD'))) / pi();
681 // Generate hash with "hash of site key" from modula of number with the prime number and other data
682 $saltedHash = generateHash(($a % getPrime()) . getEncryptSeperator() . $server . getEncryptSeperator() . $keys . getEncryptSeperator() . $data . getEncryptSeperator() . getConfig('DATE_KEY') . getEncryptSeperator() . $a, substr(sha1(getConfig('SITE_KEY')), 0, getSaltLength()));
684 // Create number from hash
685 $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(getConfig('rand_no') - $a + sqrt(getConfig('_ADD'))) / pi();
688 // At least 10 numbers shall be secure enought!
689 $len = getConfig('code_length');
690 if ($len == '0') $len = $length;
691 if ($len == '0') $len = 10;
693 // Cut off requested counts of number
694 $return = substr(str_replace('.', '', $rcode), 0, $len);
696 // Done building code
700 // Does only allow numbers
701 function bigintval ($num, $castValue = true, $abortOnMismatch = true) {
702 // Filter all numbers out
703 $ret = preg_replace('/[^0123456789]/', '', $num);
706 if ($castValue === true) $ret = (double)$ret;
708 // Has the whole value changed?
709 if (('' . $ret . '' != '' . $num . '') && ($abortOnMismatch === true)) {
711 debug_report_bug(__FUNCTION__, __LINE__, 'Problem with number found. ret=' . $ret . ', num='. $num);
718 // Creates a Uni* timestamp from given selection data and prefix
719 function createTimestampFromSelections ($prefix, $postData) {
720 // Initial return value
723 // Do we have a leap year?
725 $TEST = getYear() / 4;
728 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
729 if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02')) $SWITCH = getConfig('ONE_DAY');
731 // First add years...
732 $ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
735 $ret += $postData[$prefix . '_mo'] * 2628000;
738 $ret += $postData[$prefix . '_we'] * 604800;
741 $ret += $postData[$prefix . '_da'] * 86400;
744 $ret += $postData[$prefix . '_ho'] * 3600;
747 $ret += $postData[$prefix . '_mi'] * 60;
749 // And at last seconds...
750 $ret += $postData[$prefix . '_se'];
752 // Return calculated value
756 // Creates a 'fancy' human-readable timestamp from a Uni* stamp
757 function createFancyTime ($stamp) {
758 // Get data array with years/months/weeks/days/...
759 $data = createTimeSelections($stamp, '', '', '', true);
761 foreach($data as $k => $v) {
763 // Value is greater than 0 "eval" data to return string
764 eval('$ret .= ", ".$v." {--_' . strtoupper($k) . '--}";');
769 // Do we have something there?
770 if (strlen($ret) > 0) {
771 // Remove leading commata and space
772 $ret = substr($ret, 2);
775 $ret = '0 {--_SECONDS--}';
778 // Return fancy time string
782 // Extract host from script name
783 function extractHostnameFromUrl (&$script) {
784 // Use default SERVER_URL by default... ;) So?
785 $url = getServerUrl();
787 // Is this URL valid?
788 if (substr($script, 0, 7) == 'http://') {
789 // Use the hostname from script URL as new hostname
790 $url = substr($script, 7);
791 $extract = explode('/', $url);
793 // Done extracting the URL :)
797 $host = str_replace('http://', '', $url);
798 if (isInString('/', $host)) $host = substr($host, 0, strpos($host, '/'));
800 // Generate relative URL
801 //* DEBUG: */ debugOutput('SCRIPT=' . $script);
802 if (substr(strtolower($script), 0, 7) == 'http://') {
803 // But only if http:// is in front!
804 $script = substr($script, (strlen($url) + 7));
805 } elseif (substr(strtolower($script), 0, 8) == 'https://') {
807 $script = substr($script, (strlen($url) + 8));
810 //* DEBUG: */ debugOutput('SCRIPT=' . $script);
811 if (substr($script, 0, 1) == '/') $script = substr($script, 1);
817 // Send a GET request
818 function sendGetRequest ($script, $data = array()) {
819 // Extract host name from script
820 $host = extractHostnameFromUrl($script);
823 $body = http_build_query($data, '', '&');
825 // Do we have a question-mark in the script?
826 if (strpos($script, '?') === false) {
827 // No, so first char must be question mark
837 // Remove trailed & to make it more conform
838 if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
840 // Generate GET request header
841 $request = 'GET /' . trim($script) . ' HTTP/1.1' . getConfig('HTTP_EOL');
842 $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
843 $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
844 if (isConfigEntrySet('FULL_VERSION')) {
845 $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
847 $request .= 'User-Agent: ' . getTitle() . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
849 $request .= 'Accept: image/png,image/*;q=0.8,text/plain,text/html,*/*;q=0.5' . getConfig('HTTP_EOL');
850 $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
851 $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
852 $request .= 'Connection: close' . getConfig('HTTP_EOL');
853 $request .= getConfig('HTTP_EOL');
855 // Send the raw request
856 $response = sendRawRequest($host, $request);
858 // Return the result to the caller function
862 // Send a POST request
863 function sendPostRequest ($script, $postData) {
864 // Is postData an array?
865 if (!is_array($postData)) {
867 logDebugMessage(__FUNCTION__, __LINE__, sprintf("postData is not an array. Type: %s", gettype($postData)));
868 return array('', '', '');
871 // Extract host name from script
872 $host = extractHostnameFromUrl($script);
874 // Construct request body
875 $body = http_build_query($postData, '', '&');
877 // Generate POST request header
878 $request = 'POST /' . trim($script) . ' HTTP/1.0' . getConfig('HTTP_EOL');
879 $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
880 $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
881 $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
882 $request .= 'Accept: text/plain;q=0.8' . getConfig('HTTP_EOL');
883 $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
884 $request .= 'Cache-Control: no-cache' . getConfig('HTTP_EOL');
885 $request .= 'Content-Type: application/x-www-form-urlencoded' . getConfig('HTTP_EOL');
886 $request .= 'Content-Length: ' . strlen($body) . getConfig('HTTP_EOL');
887 $request .= 'Connection: close' . getConfig('HTTP_EOL');
888 $request .= getConfig('HTTP_EOL');
893 // Send the raw request
894 $response = sendRawRequest($host, $request);
896 // Return the result to the caller function
900 // Sends a raw request to another host
901 function sendRawRequest ($host, $request) {
902 // Init errno and errdesc with 'all fine' values
903 $errno = '0'; $errdesc = '';
906 $response = array('', '', '');
908 // Default is not to use proxy
911 // Are proxy settins set?
918 loadIncludeOnce('inc/classes/resolver.class.php');
920 // Get resolver instance
921 $resolver = new HostnameResolver();
924 //* DEBUG: */ die('SCRIPT=' . $script);
925 if ($useProxy === true) {
926 // Resolve hostname into IP address
927 $ip = $resolver->resolveHostname(compileRawCode(getConfig('proxy_host')));
929 // Connect to host through proxy connection
930 $fp = fsockopen($ip, bigintval(getConfig('proxy_port')), $errno, $errdesc, 30);
932 // Resolve hostname into IP address
933 $ip = $resolver->resolveHostname($host);
935 // Connect to host directly
936 $fp = fsockopen($ip, 80, $errno, $errdesc, 30);
940 if (!is_resource($fp)) {
942 logDebugMessage(__FUNCTION__, __LINE__, $errdesc . ' (' . $errno . ')');
944 } elseif ((!stream_set_blocking($fp, 0)) || (!stream_set_timeout($fp, 1))) {
945 // Cannot set non-blocking mode or timeout
946 logDebugMessage(__FUNCTION__, __LINE__, socket_strerror(socket_last_error()));
951 if ($useProxy === true) {
952 // Setup proxy tunnel
953 $response = setupProxyTunnel($host, $fp);
955 // If the response is invalid, abort
956 if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) {
958 logDebugMessage(__FUNCTION__, __LINE__, 'Proxy tunnel not working?');
964 fwrite($fp, $request);
967 $start = microtime(true);
971 // Get info from stream
972 $info = stream_get_meta_data($fp);
974 // Is it timed out? 15 seconds is a really patient...
975 if (($info['timed_out'] == true) || (microtime(true) - $start) > 15) {
977 logDebugMessage(__FUNCTION__, __LINE__, 'Timed out to get data from host ' . $host);
983 // Get line from stream
984 $line = fgets($fp, 128);
986 // Ignore empty lines because of non-blocking mode
988 // uslepp a little to avoid 100% CPU load
995 // Add it to response
996 $response[] = trim($line);
1002 // Time request if debug-mode is enabled
1003 if (isDebugModeEnabled()) {
1004 // Add debug message...
1005 logDebugMessage(__FUNCTION__, __LINE__, 'Request took ' . (microtime(true) - $start) . ' seconds and returned ' . count($response) . ' line(s).');
1008 // Skip first empty lines
1010 foreach ($resp as $idx => $line) {
1012 $line = trim($line);
1014 // Is this line empty?
1017 array_shift($response);
1019 // Abort on first non-empty line
1024 //* DEBUG: */ debugOutput('<strong>Request:</strong><pre>'.print_r($request, true).'</pre>');
1025 //* DEBUG: */ debugOutput('<strong>Response:</strong><pre>'.print_r($response, true).'</pre>');
1027 // Proxy agent found or something went wrong?
1028 if (!isset($response[0])) {
1029 // No response, maybe timeout
1030 $response = array('', '', '');
1031 logDebugMessage(__FUNCTION__, __LINE__, 'Invalid empty response array, maybe timed out?');
1032 } elseif ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && ($useProxy === true)) {
1033 // Proxy header detected, so remove two lines
1034 array_shift($response);
1035 array_shift($response);
1038 // Was the request successfull?
1039 if ((!isInStringIgnoreCase('200 OK', $response[0])) || (empty($response[0]))) {
1040 // Not found / access forbidden
1041 logDebugMessage(__FUNCTION__, __LINE__, 'Unexpected status code ' . $response[0] . ' detected. "200 OK" was expected.');
1042 $response = array('', '', '');
1049 // Sets up a proxy tunnel for given hostname and through resource
1050 function setupProxyTunnel ($host, $resource) {
1052 $response = array('', '', '');
1054 // Generate CONNECT request header
1055 $proxyTunnel = 'CONNECT ' . $host . ':80 HTTP/1.0' . getConfig('HTTP_EOL');
1056 $proxyTunnel .= 'Host: ' . $host . getConfig('HTTP_EOL');
1058 // Use login data to proxy? (username at least!)
1059 if (getConfig('proxy_username') != '') {
1061 $encodedAuth = base64_encode(compileRawCode(getConfig('proxy_username')) . ':' . compileRawCode(getConfig('proxy_password')));
1062 $proxyTunnel .= 'Proxy-Authorization: Basic ' . $encodedAuth . getConfig('HTTP_EOL');
1065 // Add last new-line
1066 $proxyTunnel .= getConfig('HTTP_EOL');
1067 //* DEBUG: */ debugOutput('<strong>proxyTunnel=</strong><pre>' . $proxyTunnel.'</pre>');
1070 fwrite($fp, $proxyTunnel);
1074 // No response received
1078 // Read the first line
1079 $resp = trim(fgets($fp, 10240));
1080 $respArray = explode(' ', $resp);
1081 if ((strtolower($respArray[0]) !== 'http/1.0') || ($respArray[1] != '200')) {
1082 // Invalid response!
1090 // Taken from www.php.net isInStringIgnoreCase() user comments
1091 function isEmailValid ($email) {
1092 // Check first part of email address
1093 $first = '[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*';
1096 $domain = '[a-z0-9-]+(\.[a-z0-9-]{2,5})+';
1099 $regex = '@^' . $first . '\@' . $domain . '$@iU';
1101 // Return check result
1102 return preg_match($regex, $email);
1105 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
1106 function isUrlValid ($URL, $compile=true) {
1107 // Trim URL a little
1108 $URL = trim(urldecode($URL));
1109 //* DEBUG: */ debugOutput($URL);
1111 // Compile some chars out...
1112 if ($compile === true) $URL = compileUriCode($URL, false, false, false);
1113 //* DEBUG: */ debugOutput($URL);
1115 // Check for the extension filter
1116 if (isExtensionActive('filter')) {
1117 // Use the extension's filter set
1118 return FILTER_VALIDATE_URL($URL, false);
1121 // If not installed, perform a simple test. Just make it sure there is always a http:// or
1122 // https:// in front of the URLs
1123 return isUrlValidSimple($URL);
1126 // Generate a hash for extra-security for all passwords
1127 function generateHash ($plainText, $salt = '', $hash = true) {
1129 //* DEBUG: */ debugOutput('plainText('.strlen($plainText).')=' . $plainText . ',salt('.strlen($salt).')=' . $salt . ',hash=' . intval($hash));
1131 // Is the required extension 'sql_patches' there and a salt is not given?
1132 // 123 4 43 3 4 432 2 3 32 2 3 32 2 3 3 21
1133 if (((isExtensionInstalledAndOlder('sql_patches', '0.3.6')) && (empty($salt))) || (!isExtensionActive('sql_patches')) || (!isExtensionInstalledAndNewer('other', '0.2.5')) || (strlen($salt) == 32)) {
1134 // Extension sql_patches is missing/outdated so we hash the plain text with MD5
1135 if ($hash === true) {
1136 // Is plain password
1137 return md5($plainText);
1139 // Is already a hash
1144 // Do we miss an arry element here?
1145 if (!isConfigEntrySet('file_hash')) {
1147 debug_report_bug(__FUNCTION__, __LINE__, 'Missing file_hash in ' . __FUNCTION__ . '.');
1150 // When the salt is empty build a new one, else use the first x configured characters as the salt
1152 // Build server string for more entropy
1153 $server = $_SERVER['PHP_SELF'] . getEncryptSeperator() . detectUserAgent() . getEncryptSeperator() . getenv('SERVER_SOFTWARE') . getEncryptSeperator() . detectRemoteAddr();
1156 $keys = getConfig('SITE_KEY') . getEncryptSeperator() . getConfig('DATE_KEY') . getEncryptSeperator() . getSecretKey() . getEncryptSeperator() . getFileHash() . getEncryptSeperator() . getDateFromPatchTime() . getEncryptSeperator() . getMasterSalt();
1159 $data = $plainText . getEncryptSeperator() . uniqid(mt_rand(), true) . getEncryptSeperator() . time();
1161 // Calculate number for generating the code
1162 $a = time() + getConfig('_ADD') - 1;
1164 // Generate SHA1 sum from modula of number and the prime number
1165 $sha1 = sha1(($a % getPrime()) . $server . getEncryptSeperator() . $keys . getEncryptSeperator() . $data . getEncryptSeperator() . getConfig('DATE_KEY') . getEncryptSeperator() . $a);
1166 //* DEBUG: */ debugOutput('SHA1=' . $sha1.' ('.strlen($sha1).')<br />');
1167 $sha1 = scrambleString($sha1);
1168 //* DEBUG: */ debugOutput('Scrambled=' . $sha1.' ('.strlen($sha1).')<br />');
1169 //* DEBUG: */ $sha1b = descrambleString($sha1);
1170 //* DEBUG: */ debugOutput('Descrambled=' . $sha1b.' ('.strlen($sha1b).')<br />');
1172 // Generate the password salt string
1173 $salt = substr($sha1, 0, getSaltLength());
1174 //* DEBUG: */ debugOutput($salt.' ('.strlen($salt).')<br />');
1177 //* DEBUG: */ debugOutput('salt=' . $salt);
1178 $salt = substr($salt, 0, getSaltLength());
1179 //* DEBUG: */ debugOutput('salt=' . $salt . '(' . strlen($salt) . '/' . getSaltLength() . ')<br />');
1181 // Sanity check on salt
1182 if (strlen($salt) != getSaltLength()) {
1184 debug_report_bug(__FUNCTION__, __LINE__, 'salt length mismatch! ('.strlen($salt).'/'.getSaltLength().')');
1188 // Generate final hash (for debug output)
1189 $finalHash = $salt . sha1($salt . $plainText);
1192 //* DEBUG: */ debugOutput('finalHash('.strlen($finalHash).')=' . $finalHash);
1198 // Scramble a string
1199 function scrambleString($str) {
1203 // Final check, in case of failture it will return unscrambled string
1204 if (strlen($str) > 40) {
1205 // The string is to long
1207 } elseif (strlen($str) == 40) {
1209 $scrambleNums = explode(':', getPassScramble());
1211 // Generate new numbers
1212 $scrambleNums = explode(':', genScrambleString(strlen($str)));
1215 // Compare both lengths and abort if different
1216 if (strlen($str) != count($scrambleNums)) return $str;
1218 // Scramble string here
1219 //* DEBUG: */ debugOutput('***Original=' . $str.'***<br />');
1220 for ($idx = 0; $idx < strlen($str); $idx++) {
1221 // Get char on scrambled position
1222 $char = substr($str, $scrambleNums[$idx], 1);
1224 // Add it to final output string
1225 $scrambled .= $char;
1228 // Return scrambled string
1229 //* DEBUG: */ debugOutput('***Scrambled=' . $scrambled.'***<br />');
1233 // De-scramble a string scrambled by scrambleString()
1234 function descrambleString($str) {
1235 // Scramble only 40 chars long strings
1236 if (strlen($str) != 40) return $str;
1238 // Load numbers from config
1239 $scrambleNums = explode(':', getPassScramble());
1242 if (count($scrambleNums) != 40) return $str;
1244 // Begin descrambling
1245 $orig = str_repeat(' ', 40);
1246 //* DEBUG: */ debugOutput('+++Scrambled=' . $str.'+++<br />');
1247 for ($idx = 0; $idx < 40; $idx++) {
1248 $char = substr($str, $idx, 1);
1249 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
1252 // Return scrambled string
1253 //* DEBUG: */ debugOutput('+++Original=' . $orig.'+++<br />');
1257 // Generated a "string" for scrambling
1258 function genScrambleString ($len) {
1259 // Prepare array for the numbers
1260 $scrambleNumbers = array();
1262 // First we need to setup randomized numbers from 0 to 31
1263 for ($idx = 0; $idx < $len; $idx++) {
1265 $rand = mt_rand(0, ($len -1));
1267 // Check for it by creating more numbers
1268 while (array_key_exists($rand, $scrambleNumbers)) {
1269 $rand = mt_rand(0, ($len -1));
1273 $scrambleNumbers[$rand] = $rand;
1276 // So let's create the string for storing it in database
1277 $scrambleString = implode(':', $scrambleNumbers);
1278 return $scrambleString;
1281 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
1282 function encodeHashForCookie ($passHash) {
1283 // Return vanilla password hash
1286 // Is a secret key and master salt already initialized?
1287 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, intval(isExtensionInstalled('sql_patches')) . '/' . intval(isConfigEntrySet('_PRIME')) . '/' . intval(isConfigEntrySet('secret_key')) . '/' . intval(isConfigEntrySet('master_salt')));
1288 if ((isExtensionInstalled('sql_patches')) && (isConfigEntrySet('_PRIME')) && (isConfigEntrySet('secret_key')) && (isConfigEntrySet('master_salt'))) {
1289 // Only calculate when the secret key is generated
1290 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '/' . strlen(getSecretKey()));
1291 if ((strlen($passHash) != 49) || (strlen(getSecretKey()) != 40)) {
1292 // Both keys must have same length so return unencrypted
1293 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '!=49/' . strlen(getSecretKey()) . '!=40');
1297 $newHash = ''; $start = 9;
1298 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'passHash=' . $passHash . '(' . strlen($passHash) . ')');
1299 for ($idx = 0; $idx < 20; $idx++) {
1300 $part1 = hexdec(substr($passHash, ($idx * 2) + (strlen($passHash) - strlen(getSecretKey())), 2));
1301 $part2 = hexdec(substr(getSecretKey(), $start, 2));
1302 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'part1=' . $part1 . '/part2=' . $part2);
1303 $mod = dechex($idx);
1304 if ($part1 > $part2) {
1305 $mod = dechex(sqrt(($part1 - $part2) * getPrime() / pi()));
1306 } elseif ($part2 > $part1) {
1307 $mod = dechex(sqrt(($part2 - $part1) * getPrime() / pi()));
1309 $mod = substr($mod, 0, 2);
1310 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'part1=' . $part1 . '/part2=' . $part2 . '/mod=' . $mod . '(' . strlen($mod) . ')');
1311 $mod = str_repeat(0, (2 - strlen($mod))) . $mod;
1312 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mod(' . ($idx * 2) . ')=' . $mod . '*');
1317 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $passHash . ',' . $newHash . ' (' . strlen($newHash) . ')');
1318 $ret = generateHash($newHash, getMasterSalt());
1322 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret . '');
1326 // Fix "deleted" cookies
1327 function fixDeletedCookies ($cookies) {
1328 // Is this an array with entries?
1329 if ((is_array($cookies)) && (count($cookies) > 0)) {
1330 // Then check all cookies if they are marked as deleted!
1331 foreach ($cookies as $cookieName) {
1332 // Is the cookie set to "deleted"?
1333 if (getSession($cookieName) == 'deleted') {
1334 setSession($cookieName, '');
1340 // Checks if a given apache module is loaded
1341 function isApacheModuleLoaded ($apacheModule) {
1342 // Check it and return result
1343 return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
1346 // Get current theme name
1347 function getCurrentTheme () {
1348 // The default theme is 'default'... ;-)
1351 // Do we have ext-theme installed and active?
1352 if (isExtensionActive('theme')) {
1353 // Call inner method
1354 $ret = getActualTheme();
1357 // Return theme value
1361 // Generates an error code from given account status
1362 function generateErrorCodeFromUserStatus ($status='') {
1363 // If no status is provided, use the default, cached
1364 if ((empty($status)) && (isMember())) {
1366 $status = getUserData('status');
1369 // Default error code if unknown account status
1370 $errorCode = getCode('ACCOUNT_STATUS_UNKNOWN');
1372 // Generate constant name
1373 $codeName = sprintf("ACCOUNT_STATUS_%s", strtoupper($status));
1375 // Is the constant there?
1376 if (isCodeSet($codeName)) {
1378 $errorCode = getCode($codeName);
1381 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
1384 // Return error code
1388 // Back-ported from the new ship-simu engine. :-)
1389 function debug_get_printable_backtrace () {
1391 $backtrace = '<ol>';
1393 // Get and prepare backtrace for output
1394 $backtraceArray = debug_backtrace();
1395 foreach ($backtraceArray as $key => $trace) {
1396 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1397 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1398 if (!isset($trace['args'])) $trace['args'] = array();
1399 $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>';
1403 $backtrace .= '</ol>';
1405 // Return the backtrace
1409 // A mail-able backtrace
1410 function debug_get_mailable_backtrace () {
1414 // Get and prepare backtrace for output
1415 $backtraceArray = debug_backtrace();
1416 foreach ($backtraceArray as $key => $trace) {
1417 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1418 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1419 if (!isset($trace['args'])) $trace['args'] = array();
1420 $backtrace .= ($key+1) . '.:' . basename($trace['file']) . ':' . $trace['line'] . ', ' . $trace['function'] . '(' . count($trace['args']) . ")\n";
1423 // Return the backtrace
1427 // Generates a ***weak*** seed
1428 function generateSeed () {
1429 return microtime(true) * 100000;
1432 // Converts a message code to a human-readable message
1433 function getMessageFromErrorCode ($code) {
1437 case getCode('LOGOUT_DONE') : $message = '{--LOGOUT_DONE--}'; break;
1438 case getCode('LOGOUT_FAILED') : $message = '<span class="guest_failed">{--LOGOUT_FAILED--}</span>'; break;
1439 case getCode('DATA_INVALID') : $message = '{--MAIL_DATA_INVALID--}'; break;
1440 case getCode('POSSIBLE_INVALID') : $message = '{--MAIL_POSSIBLE_INVALID--}'; break;
1441 case getCode('USER_404') : $message = '{--USER_404--}'; break;
1442 case getCode('STATS_404') : $message = '{--MAIL_STATS_404--}'; break;
1443 case getCode('ALREADY_CONFIRMED') : $message = '{--MAIL_ALREADY_CONFIRMED--}'; break;
1444 case getCode('WRONG_PASS') : $message = '{--LOGIN_WRONG_PASS--}'; break;
1445 case getCode('WRONG_ID') : $message = '{--LOGIN_WRONG_ID--}'; break;
1446 case getCode('ACCOUNT_LOCKED') : $message = '{--LOGIN_STATUS_LOCKED--}'; break;
1447 case getCode('ACCOUNT_UNCONFIRMED'): $message = '{--LOGIN_STATUS_UNCONFIRMED--}'; break;
1448 case getCode('COOKIES_DISABLED') : $message = '{--LOGIN_COOKIES_DISABLED--}'; break;
1449 case getCode('BEG_SAME_AS_OWN') : $message = '{--BEG_SAME_UID_AS_OWN--}'; break;
1450 case getCode('LOGIN_FAILED') : $message = '{--GUEST_LOGIN_FAILED_GENERAL--}'; break;
1451 case getCode('MODULE_MEMBER_ONLY') : $message = getMaskedMessage('MODULE_MEMBER_ONLY', getRequestParameter('mod')); break;
1452 case getCode('OVERLENGTH') : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
1453 case getCode('URL_FOUND') : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
1454 case getCode('SUBJECT_URL') : $message = '{--MEMBER_SUBJECT_CONTAINS_URL--}'; break;
1455 case getCode('BLIST_URL') : $message = '{--MEMBER_URL_BLACK_LISTED--}<br />{--MEMBER_BLIST_TIME--}: ' . generateDateTime(getRequestParameter('blist'), 0); break;
1456 case getCode('NO_RECS_LEFT') : $message = '{--MEMBER_SELECTED_MORE_RECS--}'; break;
1457 case getCode('INVALID_TAGS') : $message = '{--MEMBER_HTML_INVALID_TAGS--}'; break;
1458 case getCode('MORE_POINTS') : $message = '{--MEMBER_MORE_POINTS_NEEDED--}'; break;
1459 case getCode('MORE_RECEIVERS1') : $message = '{--MEMBER_ENTER_MORE_RECEIVERS--}'; break;
1460 case getCode('MORE_RECEIVERS2') : $message = '{--MEMBER_NO_MORE_RECEIVERS_FOUND--}'; break;
1461 case getCode('MORE_RECEIVERS3') : $message = '{--MEMBER_ENTER_MORE_MIN_RECEIVERS--}'; break;
1462 case getCode('INVALID_URL') : $message = '{--MEMBER_ENTER_INVALID_URL--}'; break;
1463 case getCode('NO_MAIL_TYPE') : $message = '{--MEMBER_NO_MAIL_TYPE_SELECTED--}'; break;
1464 case getCode('UNKNOWN_ERROR') : $message = '{--LOGIN_UNKNOWN_ERROR--}'; break;
1465 case getCode('UNKNOWN_STATUS') : $message = '{--LOGIN_UNKNOWN_STATUS--}'; break;
1467 case getCode('ERROR_MAILID'):
1468 if (isExtensionActive('mailid', true)) {
1469 $message = '{--ERROR_CONFIRMING_MAIL--}';
1471 $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', 'mailid');
1475 case getCode('EXTENSION_PROBLEM'):
1476 if (isGetRequestParameterSet('ext')) {
1477 $message = generateExtensionInactiveNotInstalledMessage(getRequestParameter('ext'));
1479 $message = '{--EXTENSION_PROBLEM_UNSET_EXT--}';
1483 case getCode('URL_TLOCK'):
1484 // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
1485 $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
1486 array(bigintval(getRequestParameter('id'))), __FUNCTION__, __LINE__);
1488 // Load timestamp from last order
1489 list($timestamp) = SQL_FETCHROW($result);
1492 SQL_FREERESULT($result);
1494 // Translate it for templates
1495 $timestamp = generateDateTime($timestamp, 1);
1497 // Calculate hours...
1498 $STD = round(getConfig('url_tlock') / 60 / 60);
1501 $MIN = round((getConfig('url_tlock') - $STD * 60 * 60) / 60);
1504 $SEC = getConfig('url_tlock') - $STD * 60 * 60 - $MIN * 60;
1506 // Finally contruct the message
1507 // @TODO Rewrite this old lost code to a template
1508 $message = "{--MEMBER_URL_TIME_LOCK--}<br />{--CONFIG_URL_TLOCK--} ".$STD."
1509 {--_HOURS--}, ".$MIN." {--_MINUTES--} {--_AND--} ".$SEC." {--_SECONDS--}<br />
1510 {--MEMBER_LAST_TLOCK--}: ".$timestamp;
1514 // Missing/invalid code
1515 $message = getMaskedMessage('UNKNOWN_MAILID_CODE', $code);
1518 logDebugMessage(__FUNCTION__, __LINE__, $message);
1522 // Return the message
1526 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
1527 function isUrlValidSimple ($url) {
1529 $url = secureString(str_replace("\\", '', compileRawCode(urldecode($url))));
1531 // Allows http and https
1532 $http = "(http|https)+(:\/\/)";
1534 $domain1 = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
1535 // Test double-domains (e.g. .de.vu)
1536 $domain2 = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
1538 $ip = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
1540 $dir = "((/)+([-_\.[:alnum:]])+)*";
1542 $page = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
1543 // ... and the string after and including question character
1544 $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
1545 // Pattern for URLs like http://url/dir/doc.html?var=value
1546 $pattern['d1dpg1'] = $http . $domain1 . $dir . $page . $getstring1;
1547 $pattern['d2dpg1'] = $http . $domain2 . $dir . $page . $getstring1;
1548 $pattern['ipdpg1'] = $http . $ip . $dir . $page . $getstring1;
1549 // Pattern for URLs like http://url/dir/?var=value
1550 $pattern['d1dg1'] = $http . $domain1 . $dir.'/' . $getstring1;
1551 $pattern['d2dg1'] = $http . $domain2 . $dir.'/' . $getstring1;
1552 $pattern['ipdg1'] = $http . $ip . $dir.'/' . $getstring1;
1553 // Pattern for URLs like http://url/dir/page.ext
1554 $pattern['d1dp'] = $http . $domain1 . $dir . $page;
1555 $pattern['d1dp'] = $http . $domain2 . $dir . $page;
1556 $pattern['ipdp'] = $http . $ip . $dir . $page;
1557 // Pattern for URLs like http://url/dir
1558 $pattern['d1d'] = $http . $domain1 . $dir;
1559 $pattern['d2d'] = $http . $domain2 . $dir;
1560 $pattern['ipd'] = $http . $ip . $dir;
1561 // Pattern for URLs like http://url/?var=value
1562 $pattern['d1g1'] = $http . $domain1 . '/' . $getstring1;
1563 $pattern['d2g1'] = $http . $domain2 . '/' . $getstring1;
1564 $pattern['ipg1'] = $http . $ip . '/' . $getstring1;
1565 // Pattern for URLs like http://url?var=value
1566 $pattern['d1g12'] = $http . $domain1 . $getstring1;
1567 $pattern['d2g12'] = $http . $domain2 . $getstring1;
1568 $pattern['ipg12'] = $http . $ip . $getstring1;
1570 // Test all patterns
1572 foreach ($pattern as $key => $pat) {
1574 if (isDebugRegularExpressionEnabled()) {
1575 // @TODO Are these convertions still required?
1576 $pat = str_replace('.', "\.", $pat);
1577 $pat = str_replace('@', "\@", $pat);
1578 //* DEBUG: */ debugOutput($key."= " . $pat);
1581 // Check if expression matches
1582 $reg = ($reg || preg_match(('^' . $pat . '^'), $url));
1585 if ($reg === true) break;
1588 // Return true/false
1592 // Wtites data to a config.php-style file
1593 // @TODO Rewrite this function to use readFromFile() and writeToFile()
1594 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
1595 // Initialize some variables
1601 // Is the file there and read-/write-able?
1602 if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
1603 $search = 'CFG: ' . $comment;
1604 $tmp = $FQFN . '.tmp';
1606 // Open the source file
1607 $fp = fopen($FQFN, 'r') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read. file=' . basename($FQFN));
1609 // Is the resource valid?
1610 if (is_resource($fp)) {
1611 // Open temporary file
1612 $fp_tmp = fopen($tmp, 'w') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write. tmp=' . basename($tmp) . ',file=' . $FQFN);
1614 // Is the resource again valid?
1615 if (is_resource($fp_tmp)) {
1616 // Mark temporary file as readable
1617 $GLOBALS['file_readable'][$tmp] = true;
1620 while (!feof($fp)) {
1621 // Read from source file
1622 $line = fgets ($fp, 1024);
1624 if (strpos($line, $search) > -1) { $next = '0'; $found = true; }
1627 if ($next === $seek) {
1629 $line = $prefix . $DATA . $suffix . "\n";
1635 // Write to temp file
1636 fwrite($fp_tmp, $line);
1642 // Finished writing tmp file
1646 // Close source file
1649 if (($done === true) && ($found === true)) {
1650 // Copy back tmp file and delete tmp :-)
1651 copyFileVerified($tmp, $FQFN, 0644);
1652 return removeFile($tmp);
1653 } elseif ($found === false) {
1654 outputHtml('<strong>CHANGE:</strong> 404!');
1656 outputHtml('<strong>TMP:</strong> UNDONE!');
1660 // File not found, not readable or writeable
1661 debug_report_bug(__FUNCTION__, __LINE__, 'File not readable/writeable. file=' . basename($FQFN));
1664 // An error was detected!
1667 // Send notification to admin
1668 function sendAdminNotification ($subject, $templateName, $content=array(), $userid = '0') {
1669 if ((isExtensionInstalledAndNewer('admins', '0.4.1')) && (function_exists('sendAdminsEmails'))) {
1671 sendAdminsEmails($subject, $templateName, $content, $userid);
1673 // Send out out-dated way
1674 $message = loadEmailTemplate($templateName, $content, $userid);
1675 sendAdminEmails($subject, $message);
1679 // Debug message logger
1680 function logDebugMessage ($funcFile, $line, $message, $force=true) {
1681 // Is debug mode enabled?
1682 if ((isDebugModeEnabled()) || ($force === true)) {
1684 $message = str_replace("\r", '', str_replace("\n", '', $message));
1686 // Log this message away
1687 $fp = fopen(getCachePath() . 'debug.log', 'a') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write logfile debug.log!');
1688 fwrite($fp, generateDateTime(time(), '4') . '|' . getModule(false) . '|' . basename($funcFile) . '|' . $line . '|' . $message . "\n");
1693 // Handle extra values
1694 function handleExtraValues ($filterFunction, $value, $extraValue) {
1695 // Default is the value itself
1698 // Do we have a special filter function?
1699 if (!empty($filterFunction)) {
1700 // Does the filter function exist?
1701 if (function_exists($filterFunction)) {
1702 // Do we have extra parameters here?
1703 if (!empty($extraValue)) {
1704 // Put both parameters in one new array by default
1705 $args = array($value, $extraValue);
1707 // If we have an array simply use it and pre-extend it with our value
1708 if (is_array($extraValue)) {
1709 // Make the new args array
1710 $args = merge_array(array($value), $extraValue);
1713 // Call the multi-parameter call-back
1714 $ret = call_user_func_array($filterFunction, $args);
1716 // One parameter call
1717 $ret = call_user_func($filterFunction, $value);
1726 // Converts timestamp selections into a timestamp
1727 function convertSelectionsToTimestamp (&$postData, &$DATA, &$id, &$skip) {
1728 // Init test variable
1732 // Get last three chars
1733 $test = substr($id, -3);
1735 // Improved way of checking! :-)
1736 if (in_array($test, array('_ye', '_mo', '_we', '_da', '_ho', '_mi', '_se'))) {
1737 // Found a multi-selection for timings?
1738 $test = substr($id, 0, -3);
1739 if ((isset($postData[$test.'_ye'])) && (isset($postData[$test.'_mo'])) && (isset($postData[$test.'_we'])) && (isset($postData[$test.'_da'])) && (isset($postData[$test.'_ho'])) && (isset($postData[$test.'_mi'])) && (isset($postData[$test.'_se'])) && ($test != $test2)) {
1740 // Generate timestamp
1741 $postData[$test] = createTimestampFromSelections($test, $postData);
1742 $DATA[] = sprintf("`%s`='%s'", $test, $postData[$test]);
1743 $GLOBALS['skip_config'][$test] = true;
1745 // Remove data from array
1746 foreach (array('ye', 'mo', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
1747 unset($postData[$test . '_' . $rem]);
1758 // Reverts the german decimal comma into Computer decimal dot
1759 function convertCommaToDot ($str) {
1760 // Default float is not a float... ;-)
1763 // Which language is selected?
1764 switch (getLanguage()) {
1765 case 'de': // German language
1766 // Remove german thousand dots first
1767 $str = str_replace('.', '', $str);
1769 // Replace german commata with decimal dot and cast it
1770 $float = (float)str_replace(',', '.', $str);
1773 default: // US and so on
1774 // Remove thousand dots first and cast
1775 $float = (float)str_replace(',', '', $str);
1783 // Handle menu-depending failed logins and return the rendered content
1784 function handleLoginFailures ($accessLevel) {
1785 // Default output is empty ;-)
1788 // Is the session data set?
1789 if ((isSessionVariableSet('mailer_' . $accessLevel . '_failures')) && (isSessionVariableSet('mailer_' . $accessLevel . '_last_failure'))) {
1790 // Ignore zero values
1791 if (getSession('mailer_' . $accessLevel . '_failures') > 0) {
1792 // Non-guest has login failures found, get both data and prepare it for template
1793 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "accessLevel={$accessLevel}<br />");
1795 'login_failures' => 'mailer_' . $accessLevel . '_failures',
1796 'last_failure' => generateDateTime(getSession('mailer_' . $accessLevel . '_last_failure'), 2)
1800 $OUT = loadTemplate('login_failures', true, $content);
1803 // Reset session data
1804 setSession('mailer_' . $accessLevel . '_failures', '');
1805 setSession('mailer_' . $accessLevel . '_last_failure', '');
1808 // Return rendered content
1813 function rebuildCache ($cache, $inc = '', $force = false) {
1815 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("cache=%s, inc=%s, force=%s", $cache, $inc, intval($force)));
1817 // Shall I remove the cache file?
1818 if (isCacheInstanceValid()) {
1820 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
1822 $GLOBALS['cache_instance']->removeCacheFile($force);
1825 // Include file given?
1828 $inc = sprintf("inc/loader/load_cache-%s.php", $inc);
1830 // Is the include there?
1831 if (isIncludeReadable($inc)) {
1832 // And rebuild it from scratch
1833 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "inc={$inc} - LOADED!<br />");
1836 // Include not found!
1837 logDebugMessage(__FUNCTION__, __LINE__, "Include {$inc} not found. cache={$cache}");
1843 // Determines the real remote address
1844 function determineRealRemoteAddress () {
1845 // Is a proxy in use?
1846 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) {
1848 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
1849 } elseif (isset($_SERVER['HTTP_CLIENT_IP'])) {
1850 // Yet, another proxy
1851 $address = $_SERVER['HTTP_CLIENT_IP'];
1853 // The regular address when no proxy was used
1854 $address = $_SERVER['REMOTE_ADDR'];
1857 // This strips out the real address from proxy output
1858 if (strstr($address, ',')) {
1859 $addressArray = explode(',', $address);
1860 $address = $addressArray[0];
1863 // Return the result
1867 // Adds a bonus mail to the queue
1868 // This is a high-level function!
1869 function addNewBonusMail ($data, $mode = '', $output=true) {
1870 // Use mode from data if not set and availble ;-)
1871 if ((empty($mode)) && (isset($data['mode']))) $mode = $data['mode'];
1873 // Generate receiver list
1874 $receiver = generateReceiverList($data['cat'], $data['receiver'], $mode);
1877 if (!empty($receiver)) {
1878 // Add bonus mail to queue
1879 addBonusMailToQueue(
1891 // Mail inserted into bonus pool
1892 if ($output === true) {
1893 loadTemplate('admin_settings_saved', false, '{--ADMIN_BONUS_SEND--}');
1895 } elseif ($output === true) {
1896 // More entered than can be reached!
1897 loadTemplate('admin_settings_saved', false, '{--ADMIN_MORE_SELECTED--}');
1900 logDebugMessage(__FUNCTION__, __LINE__, 'cat=' . $data['cat'] . ',receiver=' . $data['receiver'] . ',data=' . base64_encode(serialize($data)) . ' More selected, than available!');
1904 // Determines referal id and sets it
1905 function determineReferalId () {
1906 // Skip this in non-html-mode and outside ref.php
1907 if ((getScriptOutputMode() != 0) && (basename($_SERVER['PHP_SELF']) != 'ref.php')) return false;
1909 // Check if refid is set
1910 if ((isset($GLOBALS['refid'])) && ($GLOBALS['refid'] > 0)) {
1912 } elseif ((isGetRequestParameterSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
1913 // The variable user comes from the click-counter script click.php and we only accept this here
1914 $GLOBALS['refid'] = bigintval(getRequestParameter('user'));
1915 } elseif (isPostRequestParameterSet('refid')) {
1916 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
1917 $GLOBALS['refid'] = secureString(postRequestParameter('refid'));
1918 } elseif (isGetRequestParameterSet('refid')) {
1919 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
1920 $GLOBALS['refid'] = secureString(getRequestParameter('refid'));
1921 } elseif (isGetRequestParameterSet('ref')) {
1922 // Set refid=ref (the referal link uses such variable)
1923 $GLOBALS['refid'] = secureString(getRequestParameter('ref'));
1924 } elseif ((isSessionVariableSet('refid')) && (isValidUserId(getSession('refid')))) {
1925 // Set session refid als global
1926 $GLOBALS['refid'] = bigintval(getSession('refid'));
1927 } elseif ((isExtensionInstalledAndNewer('user', '0.3.4')) && (isRandomReferalIdEnabled())) {
1928 // Select a random user which has confirmed enougth mails
1929 $GLOBALS['refid'] = determineRandomReferalId();
1930 } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getConfig('def_refid')))) {
1931 // Set default refid as refid in URL
1932 $GLOBALS['refid'] = getConfig('def_refid');
1934 // No default id when sql_patches is not installed or none set
1935 $GLOBALS['refid'] = '0';
1938 // Set cookie when default refid > 0
1939 if (!isSessionVariableSet('refid') || (!empty($GLOBALS['refid'])) || ((!isValidUserId(getSession('refid'))) && (isConfigEntrySet('def_refid')) && (isValidUserId(getConfig('def_refid'))))) {
1940 // Default is not found
1943 // Do we have nickname or userid set?
1944 if ((isExtensionActive('nickname')) && (isNicknameUsed($GLOBALS['refid']))) {
1945 // Nickname in URL, so load the id
1946 $found = fetchUserData($GLOBALS['refid'], 'nickname');
1947 } elseif ($GLOBALS['refid'] > 0) {
1948 // Direct userid entered
1949 $found = fetchUserData($GLOBALS['refid']);
1952 // Is the record valid?
1953 if ((($found === false) || (!isUserDataValid())) && (isConfigEntrySet('def_refid'))) {
1954 // No, then reset referal id
1955 $GLOBALS['refid'] = getConfig('def_refid');
1959 setSession('refid', $GLOBALS['refid']);
1962 // Return determined refid
1963 return $GLOBALS['refid'];
1966 // Enables the reset mode and runs it
1967 function doReset () {
1968 // Enable the reset mode
1969 $GLOBALS['reset_enabled'] = true;
1972 runFilterChain('reset');
1975 // Our shutdown-function
1976 function shutdown () {
1977 // Call the filter chain 'shutdown'
1978 runFilterChain('shutdown', null);
1980 // Check if not in installation phase and the link is up
1981 if ((!isInstallationPhase()) && (SQL_IS_LINK_UP())) {
1983 SQL_CLOSE(__FUNCTION__, __LINE__);
1984 } elseif (!isInstallationPhase()) {
1986 addFatalMessage(__FUNCTION__, __LINE__, '{--NO_DB_LINK_SHUTDOWN--}');
1989 // Stop executing here
1994 function initMemberId () {
1995 $GLOBALS['member_id'] = '0';
1998 // Setter for member id
1999 function setMemberId ($memberid) {
2000 // We should not set member id to zero
2001 if ($memberid == '0') debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
2004 $GLOBALS['member_id'] = bigintval($memberid);
2007 // Getter for member id or returns zero
2008 function getMemberId () {
2009 // Default member id
2012 // Is the member id set?
2013 if (isMemberIdSet()) {
2015 $memberid = $GLOBALS['member_id'];
2022 // Checks ether the member id is set
2023 function isMemberIdSet () {
2024 return (isset($GLOBALS['member_id']));
2027 // Setter for extra title
2028 function setExtraTitle ($extraTitle) {
2029 $GLOBALS['extra_title'] = $extraTitle;
2032 // Getter for extra title
2033 function getExtraTitle () {
2034 // Is the extra title set?
2035 if (!isExtraTitleSet()) {
2036 // No, then abort here
2037 debug_report_bug(__FUNCTION__, __LINE__, 'extra_title is not set!');
2041 return $GLOBALS['extra_title'];
2044 // Checks if the extra title is set
2045 function isExtraTitleSet () {
2046 return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
2049 // Reads a directory recursively by default and searches for files not matching
2050 // an exclusion pattern. You can now keep the exclusion pattern empty for reading
2051 // a whole directory.
2052 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $addBaseDir = true, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = true, $suffix = '') {
2053 // Add default entries we should exclude
2054 $excludeArray[] = '.';
2055 $excludeArray[] = '..';
2056 $excludeArray[] = '.svn';
2057 $excludeArray[] = '.htaccess';
2059 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
2064 $dirPointer = opendir(getPath() . $baseDir) or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
2067 while ($baseFile = readdir($dirPointer)) {
2068 // Exclude '.', '..' and entries in $excludeArray automatically
2069 if (in_array($baseFile, $excludeArray, true)) {
2071 //* DEBUG: */ debugOutput('excluded=' . $baseFile);
2075 // Construct include filename and FQFN
2076 $fileName = $baseDir . $baseFile;
2077 $FQFN = getPath() . $fileName;
2079 // Remove double slashes
2080 $FQFN = str_replace('//', '/', $FQFN);
2082 // Check if the base filenname matches an exclusion pattern and if the pattern is not empty
2083 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
2084 // These Lines are only for debugging!!
2085 //* DEBUG: */ debugOutput('baseDir:' . $baseDir);
2086 //* DEBUG: */ debugOutput('baseFile:' . $baseFile);
2087 //* DEBUG: */ debugOutput('FQFN:' . $FQFN);
2093 // Skip also files with non-matching prefix genericly
2094 if (($recursive === true) && (isDirectory($FQFN))) {
2095 // Is a redirectory so read it as well
2096 $files = merge_array($files, getArrayFromDirectory($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
2098 // And skip further processing
2100 } elseif (substr($baseFile, 0, strlen($prefix)) != $prefix) {
2102 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid prefix in file " . $baseFile . ", prefix=" . $prefix);
2104 } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
2105 // Skip wrong suffix as well
2106 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Invalid suffix in file " . $baseFile . ", suffix=" . $suffix);
2108 } elseif (!isFileReadable($FQFN)) {
2109 // Not readable so skip it
2110 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "File " . $FQFN . " is not readable!");
2114 // Is the file a PHP script or other?
2115 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
2116 if ((substr($baseFile, -4, 4) == '.php') || (($fileIncludeDirs === true) && (isDirectory($FQFN)))) {
2117 // Is this a valid include file?
2118 if ($extension == '.php') {
2119 // Remove both for extension name
2120 $extName = substr($baseFile, strlen($prefix), -4);
2122 // Is the extension valid and active?
2123 if (isExtensionNameValid($extName)) {
2124 // Then add this file
2125 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension entry ' . $baseFile . ' added.');
2126 $files[] = $fileName;
2128 // Add non-extension files as well
2129 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Regular entry ' . $baseFile . ' added.');
2130 if ($addBaseDir === true) {
2131 $files[] = $fileName;
2133 $files[] = $baseFile;
2137 // We found .php file but should not search for them, why?
2138 debug_report_bug(__FUNCTION__, __LINE__, 'We should find files with extension=' . $extension . ', but we found a PHP script.');
2140 } elseif (substr($baseFile, -4, 4) == $extension) {
2141 // Other, generic file found
2142 $files[] = $fileName;
2147 closedir($dirPointer);
2152 // Return array with include files
2153 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
2157 // Maps a module name into a database table name
2158 function mapModuleToTable ($moduleName) {
2159 // Map only these, still lame code...
2160 switch ($moduleName) {
2161 // 'index' is the guest's menu
2162 case 'index': $moduleName = 'guest'; break;
2163 // ... and 'login' the member's menu
2164 case 'login': $moduleName = 'member'; break;
2165 // Anything else will not be mapped, silently.
2172 // Add SQL debug data to array for later output
2173 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
2174 // Already executed?
2175 if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
2176 // Then abort here, we don't need to profile a query twice
2180 // Remeber this as profiled (or not, but we don't care here)
2181 $GLOBALS['debug_sqls'][$F][$L][$sqlString] = true;
2183 // Do we have cache?
2184 if (!isset($GLOBALS['debug_sql_available'])) {
2185 // Check it and cache it in $GLOBALS
2186 $GLOBALS['debug_sql_available'] = ((isConfigurationLoaded()) && (isDisplayDebugSqlEnabled()));
2189 // Don't execute anything here if we don't need or ext-other is missing
2190 if ($GLOBALS['debug_sql_available'] === false) {
2196 'num_rows' => SQL_NUMROWS($result),
2197 'affected' => SQL_AFFECTEDROWS(),
2198 'sql_str' => $sqlString,
2199 'timing' => $timing,
2200 'file' => basename($F),
2205 $GLOBALS['debug_sqls'][] = $record;
2208 // Initializes the cache instance
2209 function initCacheInstance () {
2210 // Load include for CacheSystem class
2211 loadIncludeOnce('inc/classes/cachesystem.class.php');
2213 // Initialize cache system only when it's needed
2214 $GLOBALS['cache_instance'] = new CacheSystem();
2215 if ($GLOBALS['cache_instance']->getStatus() != 'done') {
2216 // Failed to initialize cache sustem
2217 addFatalMessage(__FUNCTION__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_CANNOT_INITIALIZE--}');
2221 // Getter for message from array or raw message
2222 function getMessageFromIndexedArray ($message, $pos, $array) {
2223 // Check if the requested message was found in array
2224 if (isset($array[$pos])) {
2225 // ... if yes then use it!
2226 $ret = $array[$pos];
2228 // ... else use default message
2236 // Convert ';' to ', ' for e.g. receiver list
2237 function convertReceivers ($old) {
2238 return str_replace(';', ', ', $old);
2241 // Get a module from filename and access level
2242 function getModuleFromFileName ($file, $accessLevel) {
2243 // Default is 'invalid';
2244 $modCheck = 'invalid';
2246 // @TODO This is still very static, rewrite it somehow
2247 switch ($accessLevel) {
2249 $modCheck = 'admin';
2255 $modCheck = getModule();
2258 default: // Unsupported file name / access level
2259 debug_report_bug(__FUNCTION__, __LINE__, 'Unsupported file name=' . basename($file) . '/access level=' . $accessLevel);
2267 // Encodes an URL for adding session id, etc.
2268 function encodeUrl ($url, $outputMode = '0') {
2269 // Do we have already have a PHPSESSID inside or view.php is called? Then abort here
2270 if ((strpos($url, session_name()) !== false) || (getScriptOutputMode() == -3)) return $url;
2272 // Do we have a valid session?
2273 if (((!isset($GLOBALS['valid_session'])) || ($GLOBALS['valid_session'] === false) || (!isset($_COOKIE[session_name()]))) && (isSpider() === false)) {
2275 // Determine right seperator
2276 $seperator = '&';
2277 if (strpos($url, '?') === false) {
2280 } elseif ((getScriptOutputMode() != '0') || ($outputMode != '0')) {
2286 if (session_id() != '') {
2287 $url .= $seperator . session_name() . '=' . session_id();
2292 if ((substr($url, 0, strlen(getUrl())) != getUrl()) && (substr($url, 0, 7) != '{?URL?}') && (substr($url, 0, 7) != 'http://') && (substr($url, 0, 8) != 'https://')) {
2294 $url = '{?URL?}/' . $url;
2301 // Simple check for spider
2302 function isSpider () {
2304 $userAgent = strtolower(detectUserAgent(true));
2306 // It should not be empty, if so it is better a spider/bot
2307 if (empty($userAgent)) return true;
2310 return ((strpos($userAgent, 'spider') !== false) || (strpos($userAgent, 'slurp') !== false) || (strpos($userAgent, 'bot') !== false) || (strpos($userAgent, 'archiver') !== false));
2313 // Function to search for the last modified file
2314 function searchDirsRecursive ($dir, &$last_changed, $lookFor = 'Date') {
2316 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir);
2317 // Does it match what we are looking for? (We skip a lot files already!)
2318 // RegexPattern to exclude ., .., .revision, .svn, debug.log or .cache in the filenames
2319 $excludePattern = '@(\.revision|\.svn|debug\.log|\.cache|config\.php)$@';
2321 $ds = getArrayFromDirectory($dir, '', false, true, array(), '.php', $excludePattern);
2322 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count(ds)='.count($ds));
2324 // Walk through all entries
2325 foreach ($ds as $d) {
2326 // Generate proper FQFN
2327 $FQFN = str_replace('//', '/', getPath() . $dir . '/' . $d);
2329 // Is it a file and readable?
2330 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir . ',d=' . $d);
2331 if (isFileReadable($FQFN)) {
2332 // $FQFN is a readable file so extract the requested data from it
2333 $check = extractRevisionInfoFromFile($FQFN, $lookFor);
2334 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' found. check=' . $check);
2336 // Is the file more recent?
2337 if ((!isset($last_changed[$lookFor])) || ($last_changed[$lookFor] < $check)) {
2338 // This file is newer as the file before
2339 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'NEWER!');
2340 $last_changed['path_name'] = $FQFN;
2341 $last_changed[$lookFor] = $check;
2345 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' not readable or directory.');
2350 // Handles the braces [] of a field (e.g. value of 'name' attribute)
2351 function handleFieldWithBraces ($field) {
2352 // Are there braces [] at the end?
2353 if (substr($field, -2, 2) == '[]') {
2354 // Try to find one and replace it. I do it this way to allow easy
2355 // extending of this code.
2356 foreach (array('admin_list_builder_id_value') as $key) {
2357 // Is the cache entry set?
2358 if (isset($GLOBALS[$key])) {
2360 $field = str_replace('[]', '[' . $GLOBALS[$key] . ']', $field);
2372 // Converts a userid so it can be used in SQL queries
2373 function makeDatabaseUserId ($userid) {
2374 // Is it a valid username?
2375 if (isValidUserId($userid)) {
2377 $userid = bigintval($userid);
2379 // Is not valid or zero
2387 //////////////////////////////////////////////////
2388 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
2389 //////////////////////////////////////////////////
2391 if (!function_exists('html_entity_decode')) {
2392 // Taken from documentation on www.php.net
2393 function html_entity_decode ($string) {
2394 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
2395 $trans_tbl = array_flip($trans_tbl);
2396 return strtr($string, $trans_tbl);
2400 if (!function_exists('http_build_query')) {
2401 // Taken from documentation on www.php.net, credits to Marco K. (Germany) and some light mods by R.Haeder
2402 function http_build_query($data, $prefix = '', $sep = '', $key = '') {
2404 foreach ((array)$data as $k => $v) {
2405 if (is_int($k) && $prefix != null) {
2406 $k = urlencode($prefix . $k);
2409 if ((!empty($key)) || ($key === 0)) $k = $key . '[' . urlencode($k) . ']';
2411 if (is_array($v) || is_object($v)) {
2412 array_push($ret, http_build_query($v, '', $sep, $k));
2414 array_push($ret, $k.'='.urlencode($v));
2418 if (empty($sep)) $sep = ini_get('arg_separator.output');
2420 return implode($sep, $ret);