6 * Copyright (c) 1999-2005 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This contains functions for manipulating user preferences
12 * @package squirrelmail
15 /** Include global.php */
16 require_once(SM_PATH
. 'functions/global.php');
18 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION
);
19 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION
);
21 if ( !sqsession_is_registered('prefs_are_cached') ||
22 !isset( $prefs_cache) ||
23 !is_array( $prefs_cache)
25 $prefs_are_cached = false;
26 $prefs_cache = array();
29 if (isset($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
30 require_once(SM_PATH
. $prefs_backend);
31 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
32 require_once(SM_PATH
. 'functions/db_prefs.php');
34 require_once(SM_PATH
. 'functions/file_prefs.php');
37 /* Hashing functions */
40 * Given a username and datafilename, this will return the path to the
41 * hashed location of that datafile.
43 * @param string username the username of the current user
44 * @param string dir the squirrelmail datadir
45 * @param string datafile the name of the file to open
46 * @param bool hash_seach default true
47 * @return string the hashed location of datafile
49 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
51 /* Remove trailing slash from $dir if found */
52 if (substr($dir, -1) == '/') {
53 $dir = substr($dir, 0, strlen($dir) - 1);
56 /* Compute the hash for this user and extract the hash directories. */
57 $hash_dirs = computeHashDirs($username);
59 /* First, get and make sure the full hash directory exists. */
60 $real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
62 /* Set the value of our real data file, after we've removed unwanted characters. */
63 $datafile = str_replace('/', '_', $datafile);
64 $result = "$real_hash_dir/$datafile";
66 /* Check for this file in the real hash directory. */
67 if ($hash_search && !@file_exists
($result)) {
68 /* First check the base directory, the most common location. */
69 if (@file_exists
("$dir/$datafile")) {
70 rename("$dir/$datafile", $result);
72 /* Then check the full range of possible hash directories. */
74 $check_hash_dir = $dir;
75 for ($h = 0; $h < 4; ++
$h) {
76 $check_hash_dir .= '/' . $hash_dirs[$h];
77 if (@is_readable
("$check_hash_dir/$datafile")) {
78 rename("$check_hash_dir/$datafile", $result);
85 /* Return the full hashed datafile path. */
90 * Helper function for getHashedFile, given a username returns the hashed
91 * dir for that username.
93 * @param string username the username of the current user
94 * @param string dir the squirrelmail datadir
95 * @param string hash_dirs default ''
96 * @return the path to the hash dir for username
98 function getHashedDir($username, $dir, $hash_dirs = '') {
99 global $dir_hash_level;
101 /* Remove trailing slash from $dir if found */
102 if (substr($dir, -1) == '/') {
103 $dir = substr($dir, 0, strlen($dir) - 1);
106 /* If necessary, populate the hash dir variable. */
107 if ($hash_dirs == '') {
108 $hash_dirs = computeHashDirs($username);
111 /* Make sure the full hash directory exists. */
112 $real_hash_dir = $dir;
113 for ($h = 0; $h < $dir_hash_level; ++
$h) {
114 $real_hash_dir .= '/' . $hash_dirs[$h];
115 if (!@is_dir
($real_hash_dir)) {
116 if (!@mkdir
($real_hash_dir, 0770)) {
117 echo sprintf(_("Error creating directory %s."), $real_hash_dir) . '<br />' .
118 _("Could not create hashed directory structure!") . "<br />\n" .
119 _("Please contact your system administrator and report this error.") . "<br />\n";
125 /* And return that directory. */
126 return ($real_hash_dir);
130 * Helper function for getHashDir which does the actual hash calculation.
132 * @param string username the username to calculate the hash dir for
133 * @return array a list of hash dirs for this username
135 function computeHashDirs($username) {
136 /* Compute the hash for this user and extract the hash directories. */
137 $hash = base_convert(crc32($username), 10, 16);
138 $hash_dirs = array();
139 for ($h = 0; $h < 4; ++
$h) {
140 $hash_dirs[] = substr($hash, $h, 1);
143 /* Return our array of hash directories. */
148 * FIXME: Undocumented function
150 function checkForJavascript($reset = FALSE)
152 global $data_dir, $username, $javascript_on, $javascript_setting;
154 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION
) )
155 return $javascript_on;
157 if ( $reset ||
!isset($javascript_setting) )
158 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT
);
160 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
161 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
162 $js_autodetect_results = SMPREF_JS_OFF
;
164 if ( $javascript_setting == SMPREF_JS_AUTODETECT
)
165 $javascript_on = $js_autodetect_results;
167 $javascript_on = $javascript_setting;
169 sqsession_register($javascript_on, 'javascript_on');
170 return $javascript_on;