Reverted of changes in 1704, see ticket #160
[mailer.git] / inc / wrapper-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 04/04/2009 *
4  * ===================                          Last change: 04/04/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : wrapper-functions.php                            *
8  * -------------------------------------------------------------------- *
9  * Short description : Wrapper functions                                *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Wrapper-Funktionen                               *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
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                  *
23  *                                                                      *
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.                                  *
28  *                                                                      *
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.                         *
33  *                                                                      *
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,               *
37  * MA  02110-1301  USA                                                  *
38  ************************************************************************/
39
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
42         die();
43 } // END - if
44
45 // Read a given file
46 function readFromFile ($FQFN) {
47         // Sanity-check if file is there (should be there, but just to make it sure)
48         if (!isFileReadable($FQFN)) {
49                 // This should not happen
50                 debug_report_bug(__FUNCTION__.': File ' . basename($FQFN) . ' is not readable!');
51         } // END - if
52
53         // Is it cached?
54         if (!isset($GLOBALS['file_content'][$FQFN])) {
55                 // Load the file
56                 if (function_exists('file_get_contents')) {
57                         // Use new function
58                         $GLOBALS['file_content'][$FQFN] = file_get_contents($FQFN);
59                 } else {
60                         // Fall-back to implode-file chain
61                         $GLOBALS['file_content'][$FQFN] = implode('', file($FQFN));
62                 }
63         } // END - if
64
65         // Return the content
66         return $GLOBALS['file_content'][$FQFN];
67 }
68
69 // Writes content to a file
70 function writeToFile ($FQFN, $content, $aquireLock = false) {
71         // Is the file writeable?
72         if ((isFileReadable($FQFN)) && (!is_writeable($FQFN)) && (!changeMode($FQFN, 0644))) {
73                 // Not writeable!
74                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
75
76                 // Failed! :(
77                 return false;
78         } // END - if
79
80         // By default all is failed...
81         $return = false;
82
83         // Is the function there?
84         if (function_exists('file_put_contents')) {
85                 // With lock?
86                 if ($aquireLock === true) {
87                         // Write it directly with lock
88                         $return = file_put_contents($FQFN, $content, LOCK_EX);
89                 } else {
90                         // Write it directly
91                         $return = file_put_contents($FQFN, $content);
92                 }
93         } else {
94                 // Write it with fopen
95                 $fp = fopen($FQFN, 'w') or app_die(__FUNCTION__, __LINE__, "Cannot write file ".basename($FQFN).'!');
96
97                 // Aquire lock
98                 if ($aquireLock === true) flock($fp, LOCK_EX);
99
100                 // Write content
101                 fwrite($fp, $content);
102
103                 // Close stream
104                 fclose($fp);
105         }
106
107         // Mark it as readable
108         $GLOBALS['file_readable'][$FQFN] = true;
109
110         // Remember content in cache
111         $GLOBALS['file_content'][$FQFN] = $content;
112
113         // Return status
114         return changeMode($FQFN, 0644);
115 }
116
117 // Clears the output buffer. This function does *NOT* backup sent content.
118 function clearOutputBuffer () {
119         // Trigger an error on failure
120         if (!ob_end_clean()) {
121                 // Failed!
122                 debug_report_bug(__FUNCTION__.': Failed to clean output buffer.');
123         } // END - if
124 }
125
126 // Encode strings
127 // @TODO Implement $compress
128 function encodeString ($str, $compress = true) {
129         $str = urlencode(base64_encode(compileUriCode($str)));
130         return $str;
131 }
132
133 // Decode strings encoded with encodeString()
134 // @TODO Implement $decompress
135 function decodeString ($str, $decompress = true) {
136         $str = compileUriCode(base64_decode(urldecode(compileUriCode($str))));
137         return $str;
138 }
139
140 // Decode entities in a nicer way
141 function decodeEntities ($str, $quote = ENT_NOQUOTES) {
142         // Decode the entities to UTF-8 now
143         $decodedString = html_entity_decode($str, $quote, 'UTF-8');
144
145         // Return decoded string
146         return $decodedString;
147 }
148
149 // Merges an array together but only if both are arrays
150 function merge_array ($array1, $array2) {
151         // Are both an array?
152         if ((!is_array($array1)) && (!is_array($array2))) {
153                 // Both are not arrays
154                 debug_report_bug(__FUNCTION__ . ': No arrays provided!');
155         } elseif (!is_array($array1)) {
156                 // Left one is not an array
157                 debug_report_bug(sprintf("[%s:%s] array1 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array1)));
158         } elseif (!is_array($array2)) {
159                 // Right one is not an array
160                 debug_report_bug(sprintf("[%s:%s] array2 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array2)));
161         }
162
163         // Merge all together
164         return array_merge($array1, $array2);
165 }
166
167 // Check if given FQFN is a readable file
168 function isFileReadable ($FQFN) {
169         // Do we have cache?
170         if (!isset($GLOBALS['file_readable'][$FQFN])) {
171                 // Check all...
172                 $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN)));
173
174                 // Debug message
175                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CHECK! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')');
176         } else {
177                 // Cache used
178                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CACHE! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')');
179         }
180
181         // Return result
182         return $GLOBALS['file_readable'][$FQFN];
183 }
184
185 // Checks wether the given FQFN is a directory and not ., .. or .svn
186 function isDirectory ($FQFN) {
187         // Do we have cache?
188         if (!isset($GLOBALS['is_directory'][$FQFN])) {
189                 // Generate baseName
190                 $baseName = basename($FQFN);
191
192                 // Check it
193                 $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
194         } // END - if
195
196         // Return the result
197         return $GLOBALS['is_directory'][$FQFN];
198 }
199
200 // "Getter" for remote IP number
201 function detectRemoteAddr () {
202         // Get remote ip from environment
203         $remoteAddr = determineRealRemoteAddress();
204
205         // Is removeip installed?
206         if (isExtensionActive('removeip')) {
207                 // Then anonymize it
208                 $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
209         } // END - if
210
211         // Return it
212         return $remoteAddr;
213 }
214
215 // "Getter" for remote hostname
216 function detectRemoteHostname () {
217         // Get remote ip from environment
218         $remoteHost = getenv('REMOTE_HOST');
219
220         // Is removeip installed?
221         if (isExtensionActive('removeip')) {
222                 // Then anonymize it
223                 $remoteHost = getAnonymousRemoteHost($remoteHost);
224         } // END - if
225
226         // Return it
227         return $remoteHost;
228 }
229
230 // "Getter" for user agent
231 function detectUserAgent ($alwaysReal = false) {
232         // Get remote ip from environment
233         $userAgent = getenv('HTTP_USER_AGENT');
234
235         // Is removeip installed?
236         if ((isExtensionActive('removeip')) && ($alwaysReal === false)) {
237                 // Then anonymize it
238                 $userAgent = getAnonymousUserAgent($userAgent);
239         } // END - if
240
241         // Return it
242         return $userAgent;
243 }
244
245 // "Getter" for referer
246 function detectReferer () {
247         // Get remote ip from environment
248         $referer = getenv('HTTP_REFERER');
249
250         // Is removeip installed?
251         if (isExtensionActive('removeip')) {
252                 // Then anonymize it
253                 $referer = getAnonymousReferer($referer);
254         } // END - if
255
256         // Return it
257         return $referer;
258 }
259
260 // "Getter" for request URI
261 function detectRequestUri () {
262         // Return it
263         return (getenv('REQUEST_URI'));
264 }
265
266 // "Getter" for query string
267 function detectQueryString () {
268         return str_replace('&', '&amp;', (getenv('QUERY_STRING')));
269 }
270
271 // "Getter" for SERVER_NAME
272 function detectServerName () {
273         // Return it
274         return (getenv('SERVER_NAME'));
275 }
276
277 // Check wether we are installing
278 function isInstalling () {
279         // Determine wether we are installing
280         if (!isset($GLOBALS['mxchange_installing'])) {
281                 // Check URL (css.php/js.php need this)
282                 $GLOBALS['mxchange_installing'] = isGetRequestParameterSet('installing');
283         } // END - if
284
285         // Return result
286         return $GLOBALS['mxchange_installing'];
287 }
288
289 // Check wether this script is installed
290 function isInstalled () {
291         // Do we have cache?
292         if (!isset($GLOBALS['is_installed'])) {
293                 // Determine wether this script is installed
294                 $GLOBALS['is_installed'] = (
295                 (
296                         // First is config
297                         (
298                                 (
299                                         isConfigEntrySet('MXCHANGE_INSTALLED')
300                                 ) && (
301                                         getConfig('MXCHANGE_INSTALLED') == 'Y'
302                                 )
303                         )
304                 ) || (
305                         // New config file found and loaded
306                         isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
307                 ) || (
308                         (
309                                 // New config file found, but not yet read
310                                 isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
311                         ) && (
312                                 (
313                                         // Only new config file is found
314                                         !isIncludeReadable('inc/config.php')
315                                 ) || (
316                                         // Is installation mode
317                                         !isInstalling()
318                                 )
319                         )
320                 ));
321         } // END - if
322
323         // Then use the cache
324         return $GLOBALS['is_installed'];
325 }
326
327 // Check wether an admin is registered
328 function isAdminRegistered () {
329         return ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
330 }
331
332 // Checks wether the reset mode is active
333 function isResetModeEnabled () {
334         // Now simply check it
335         return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
336 }
337
338 // Checks wether the debug mode is enabled
339 function isDebugModeEnabled () {
340         // Simply check it
341         return ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
342 }
343
344 // Checks wether SQL debugging is enabled
345 function isSqlDebuggingEnabled () {
346         return ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y'));
347 }
348
349 // Checks wether we shall debug regular expressions
350 function isDebugRegExpressionEnabled () {
351         // Simply check it
352         return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
353 }
354
355 // Checks wether the cache instance is valid
356 function isCacheInstanceValid () {
357         return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
358 }
359
360 // Copies a file from source to destination and verifies if that goes fine.
361 // This function should wrap the copy() command and make a nicer debug backtrace
362 // even if there is no xdebug extension installed.
363 function copyFileVerified ($source, $dest, $chmod = '') {
364         // Failed is the default
365         $status = false;
366
367         // Is the source file there?
368         if (!isFileReadable($source)) {
369                 // Then abort here
370                 debug_report_bug('Cannot read from source file ' . basename($source) . '.');
371         } // END - if
372
373         // Is the target directory there?
374         if (!isDirectory(dirname($dest))) {
375                 // Then abort here
376                 debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.');
377         } // END - if
378
379         // Now try to copy it
380         if (!copy($source, $dest)) {
381                 // Something went wrong
382                 debug_report_bug('copy() has failed to copy the file.');
383         } else {
384                 // Reset cache
385                 $GLOBALS['file_readable'][$dest] = true;
386         }
387
388         // If there are chmod rights set, apply them
389         if (!empty($chmod)) {
390                 // Try to apply them
391                 $status = changeMode($dest, $chmod);
392         } else {
393                 // All fine
394                 $status = true;
395         }
396
397         // All fine
398         return $status;
399 }
400
401 // Wrapper function for header()
402 // Send a header but checks before if we can do so
403 function sendHeader ($header) {
404         // Send the header
405         $GLOBALS['header'][] = trim($header);
406 }
407
408 // Flushes all headers
409 function flushHeaders () {
410         // Is the header already sent?
411         if (headers_sent()) {
412                 // Then abort here
413                 debug_report_bug('Headers already sent!');
414         } // END - if
415
416         // Flush all headers if found
417         if ((isset($GLOBALS['header'])) && (is_array($GLOBALS['header']))) {
418                 foreach ($GLOBALS['header'] as $header) {
419                         header($header);
420                 } // END - foreach
421         } // END - if
422
423         // Mark them as flushed
424         $GLOBALS['header'] = array();
425 }
426
427 // Wrapper function for chmod()
428 // @TODO Do some more sanity check here
429 function changeMode ($FQFN, $mode) {
430         // Is the file/directory there?
431         if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
432                 // Neither, so abort here
433                 debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.');
434         } // END - if
435
436         // Try to set them
437         chmod($FQFN, $mode);
438 }
439
440 // Wrapper for unlink()
441 function removeFile ($FQFN) {
442         // Is the file there?
443         if (isFileReadable($FQFN)) {
444                 // Reset cache first
445                 $GLOBALS['file_readable'][$FQFN] = false;
446
447                 // Yes, so remove it
448                 return unlink($FQFN);
449         } // END - if
450
451         // All fine if no file was removed. If we change this to 'false' or rewrite
452         // above if() block it would be to restrictive.
453         return true;
454 }
455
456 // Wrapper for $_POST['sel']
457 function countPostSelection ($element = 'sel') {
458         // Is it set?
459         if (isPostRequestParameterSet($element)) {
460                 // Return counted elements
461                 return countSelection(postRequestParameter($element));
462         } else {
463                 // Return zero if not found
464                 return 0;
465         }
466 }
467
468 // Checks wether the config-local.php is loaded
469 function isConfigLocalLoaded () {
470         return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
471 }
472
473 // Checks wether a nickname or userid was entered and caches the result
474 function isNicknameUsed ($userid) {
475         // Default is false
476         $isUsed = false;
477
478         // Is the cache there
479         if (isset($GLOBALS['is_nickname_used'][$userid])) {
480                 // Then use it
481                 $isUsed = $GLOBALS['is_nickname_used'][$userid];
482         } else {
483                 // Determine it
484                 $isUsed = (('' . round($userid) . '') != $userid);
485
486                 // And write it to the cache
487                 $GLOBALS['is_nickname_used'][$userid] = $isUsed;
488         }
489
490         // Return the result
491         return $isUsed;
492 }
493
494 // Getter for 'what' value
495 function getWhat () {
496         // Default is null
497         $what = null;
498
499         // Is the value set?
500         if (isWhatSet(true)) {
501                 // Then use it
502                 $what = $GLOBALS['what'];
503         } // END - if
504
505         // Return it
506         return $what;
507 }
508
509 // Setter for 'what' value
510 function setWhat ($newWhat) {
511         $GLOBALS['what'] = SQL_ESCAPE($newWhat);
512 }
513
514 // Setter for 'what' from configuration
515 function setWhatFromConfig ($configEntry) {
516         // Get 'what' from config
517         $what = getConfig($configEntry);
518
519         // Set it
520         setWhat($what);
521 }
522
523 // Checks wether what is set and optionally aborts on miss
524 function isWhatSet ($strict =  false) {
525         // Check for it
526         $isset = isset($GLOBALS['what']);
527
528         // Should we abort here?
529         if (($strict === true) && ($isset === false)) {
530                 // Output backtrace
531                 debug_report_bug('what is empty.');
532         } // END - if
533
534         // Return it
535         return $isset;
536 }
537
538 // Getter for 'action' value
539 function getAction () {
540         // Default is null
541         $action = null;
542
543         // Is the value set?
544         if (isActionSet(true)) {
545                 // Then use it
546                 $action = $GLOBALS['action'];
547         } // END - if
548
549         // Return it
550         return $action;
551 }
552
553 // Setter for 'action' value
554 function setAction ($newAction) {
555         $GLOBALS['action'] = SQL_ESCAPE($newAction);
556 }
557
558 // Checks wether action is set and optionally aborts on miss
559 function isActionSet ($strict =  false) {
560         // Check for it
561         $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action'])));
562
563         // Should we abort here?
564         if (($strict === true) && ($isset === false)) {
565                 // Output backtrace
566                 debug_report_bug('action is empty.');
567         } // END - if
568
569         // Return it
570         return $isset;
571 }
572
573 // Getter for 'module' value
574 function getModule ($strict = true) {
575         // Default is null
576         $module = null;
577
578         // Is the value set?
579         if (isModuleSet($strict)) {
580                 // Then use it
581                 $module = $GLOBALS['module'];
582         } // END - if
583
584         // Return it
585         return $module;
586 }
587
588 // Setter for 'module' value
589 function setModule ($newModule) {
590         // Secure it and make all modules lower-case
591         $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
592 }
593
594 // Checks wether module is set and optionally aborts on miss
595 function isModuleSet ($strict =  false) {
596         // Check for it
597         $isset = (!empty($GLOBALS['module']));
598
599         // Should we abort here?
600         if (($strict === true) && ($isset === false)) {
601                 // Output backtrace
602                 debug_report_bug('module is empty.');
603         } // END - if
604
605         // Return it
606         return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
607 }
608
609 // Getter for 'output_mode' value
610 function getOutputMode () {
611         // Default is null
612         $output_mode = null;
613
614         // Is the value set?
615         if (isOutputModeSet(true)) {
616                 // Then use it
617                 $output_mode = $GLOBALS['output_mode'];
618         } // END - if
619
620         // Return it
621         return $output_mode;
622 }
623
624 // Setter for 'output_mode' value
625 function setOutputMode ($newOutputMode) {
626         $GLOBALS['output_mode'] = (int) $newOutputMode;
627 }
628
629 // Checks wether output_mode is set and optionally aborts on miss
630 function isOutputModeSet ($strict =  false) {
631         // Check for it
632         $isset = (isset($GLOBALS['output_mode']));
633
634         // Should we abort here?
635         if (($strict === true) && ($isset === false)) {
636                 // Output backtrace
637                 debug_report_bug('output_mode is empty.');
638         } // END - if
639
640         // Return it
641         return $isset;
642 }
643
644 // Enables block-mode
645 function enableBlockMode ($enabled = true) {
646         $GLOBALS['block_mode'] = $enabled;
647 }
648
649 // Checks wether block-mode is enabled
650 function isBlockModeEnabled () {
651         // Abort if not set
652         if (!isset($GLOBALS['block_mode'])) {
653                 // Needs to be fixed
654                 debug_report_bug(__FUNCTION__ . ': block_mode is not set.');
655         } // END - if
656
657         // Return it
658         return $GLOBALS['block_mode'];
659 }
660
661 // Wrapper function for addPointsThroughReferalSystem()
662 function addPointsDirectly ($subject, $userid, $points) {
663         // Reset level here
664         unset($GLOBALS['ref_level']);
665
666         // Call more complicated method (due to more parameters)
667         return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct');
668 }
669
670 // Wrapper function to redirect from member-only modules to index
671 function redirectToIndexMemberOnlyModule () {
672         // Do the redirect here
673         redirectToUrl('modules.php?module=index&amp;code=' . getCode('MODULE_MEM_ONLY') . '&amp;mod=' . getModule());
674 }
675
676 // Wrapper function for checking if extension is installed and newer or same version
677 function isExtensionInstalledAndNewer ($ext_name, $version) {
678         // Return it
679         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=&gt;'.$version.'<br />';
680         return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
681 }
682
683 // Wrapper function for checking if extension is installed and older than given version
684 function isExtensionInstalledAndOlder ($ext_name, $version) {
685         // Return it
686         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'&lt;'.$version.'<br />';
687         return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
688 }
689
690 // Set username
691 function setUsername ($userName) {
692         $GLOBALS['username'] = (string) $userName;
693 }
694
695 // Get username
696 function getUsername () {
697         // default is guest
698         $username = getMessage('USERNAME_GUEST');
699
700         // User name set?
701         if (isset($GLOBALS['username'])) {
702                 // Use the set name
703                 $username = $GLOBALS['username'];
704         } // END - if
705
706         // Return it
707         return $username;
708 }
709
710 // Wrapper function for installation phase
711 function isInstallationPhase () {
712         // Do we have cache?
713         if (!isset($GLOBALS['installation_phase'])) {
714                 // Determine it
715                 $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling()));
716         } // END - if
717
718         // Return result
719         return $GLOBALS['installation_phase'];
720 }
721
722 // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
723 function isDemoModeActive () {
724         return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
725 }
726
727 // Wrapper function to redirect to de-refered URL
728 function redirectToDereferedUrl ($URL) {
729         // De-refer the URL
730         $URL = generateDerefererUrl($URL);
731
732         // Redirect to to
733         redirectToUrl($URL);
734 }
735
736 // Getter for PHP caching value
737 function getPhpCaching () {
738         return $GLOBALS['php_caching'];
739 }
740
741 // Checks wether the admin hash is set
742 function isAdminHashSet ($admin) {
743         if (!isset($GLOBALS['cache_array']['admin'])) debug_report_bug('Cache not set.');
744         return isset($GLOBALS['cache_array']['admin']['password'][$admin]);
745 }
746
747 // Setter for admin hash
748 function setAdminHash ($admin, $hash) {
749         $GLOBALS['cache_array']['admin']['password'][$admin] = $hash;
750 }
751
752 // Init user data array
753 function initUserData () {
754         // User id should not be zero
755         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
756
757         // Init the user
758         $GLOBALS['user_data'][getCurrentUserId()] = array();
759 }
760
761 // Getter for user data
762 function getUserData ($column) {
763         // User id should not be zero
764         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
765
766         // Return the value
767         return $GLOBALS['user_data'][getCurrentUserId()][$column];
768 }
769
770 // Geter for whole user data array
771 function getUserDataArray () {
772         // User id should not be zero
773         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
774
775         // Get the whole array
776         return $GLOBALS['user_data'][getCurrentUserId()];
777 }
778
779 // Checks if the user data is valid, this may indicate that the user has logged
780 // in, but you should use isMember() if you want to find that out.
781 function isUserDataValid () {
782         // User id should not be zero so abort here
783         if (!isCurrentUserIdSet()) return false;
784
785         // Is the array there and filled?
786         return ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
787 }
788
789 // Setter for current userid
790 function setCurrentUserId ($userid) {
791         $GLOBALS['current_userid'] = bigintval($userid);
792 }
793
794 // Getter for current userid
795 function getCurrentUserId () {
796         // Userid must be set before it can be used
797         if (!isCurrentUserIdSet()) {
798                 // Not set
799                 debug_report_bug('User id is not set.');
800         } // END - if
801
802         // Return the userid
803         return $GLOBALS['current_userid'];
804 }
805
806 // Checks if current userid is set
807 function isCurrentUserIdSet () {
808         return isset($GLOBALS['current_userid']);
809 }
810
811 // Checks wether we are debugging template cache
812 function isDebuggingTemplateCache () {
813         return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y');
814 }
815
816 // Wrapper for fetchUserData() and getUserData() calls
817 function getFetchedUserData ($keyColumn, $userId, $valueColumn) {
818         // Default is 'guest'
819         $data = getMessage('USERNAME_GUEST');
820
821         // Can we fetch the user data?
822         if (($userId > 0) && (fetchUserData($userId, $keyColumn))) {
823                 // Now get the data back
824                 $data = getUserData($valueColumn);
825         } // END - if
826
827         // Return it
828         return $data;
829 }
830
831 // [EOF]
832 ?>