Minor cleanups
[squirrelmail.git] / functions / prefs.php
CommitLineData
59177427 1<?php
2ba13803 2
35586184 3/**
4 * prefs.php
5 *
82d304a0 6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This contains functions for manipulating user preferences
10 *
31841a9e 11 * @version $Id$
d6c32258 12 * @package squirrelmail
35586184 13 */
14
d6c32258 15/** Include global.php */
0b97a708 16require_once(SM_PATH . 'functions/global.php');
17
0365891c 18sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
19sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
0b97a708 20
d7c82551 21if ( !sqsession_is_registered('prefs_are_cached') ||
93b2364f 22 !isset( $prefs_cache) ||
62f7daa5 23 !is_array( $prefs_cache)
cccfa9c2 24 ) {
35586184 25 $prefs_are_cached = false;
26 $prefs_cache = array();
27}
31ac7db8 28
55994cd6 29if (isset($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
30 require_once(SM_PATH . $prefs_backend);
31} elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
b68edc75 32 require_once(SM_PATH . 'functions/db_prefs.php');
3499f99f 33} else {
b68edc75 34 require_once(SM_PATH . 'functions/file_prefs.php');
7b294953 35}
36
3499f99f 37/* Hashing functions */
fb120846 38
8b096f0a 39/**
40 * Given a username and datafilename, this will return the path to the
41 * hashed location of that datafile.
42 *
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
48 */
3392dc86 49function getHashedFile($username, $dir, $datafile, $hash_search = true) {
50 global $dir_hash_level;
51
311339a0 52 /* Remove trailing slash from $dir if found */
53 if (substr($dir, -1) == '/') {
54 $dir = substr($dir, 0, strlen($dir) - 1);
55 }
62f7daa5 56
3392dc86 57 /* Compute the hash for this user and extract the hash directories. */
58 $hash_dirs = computeHashDirs($username);
59
60 /* First, get and make sure the full hash directory exists. */
61 $real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
62
12719a10 63 /* Set the value of our real data file, after we've removed unwanted characters. */
64 $datafile = str_replace('/', '_', $datafile);
4fc152a6 65 $result = "$real_hash_dir/$datafile";
3392dc86 66
67 /* Check for this file in the real hash directory. */
3a94810f 68 if ($hash_search && !@file_exists($result)) {
3392dc86 69 /* First check the base directory, the most common location. */
3a94810f 70 if (@file_exists("$dir/$datafile")) {
3392dc86 71 rename("$dir/$datafile", $result);
72
73 /* Then check the full range of possible hash directories. */
74 } else {
75 $check_hash_dir = $dir;
76 for ($h = 0; $h < 4; ++$h) {
77 $check_hash_dir .= '/' . $hash_dirs[$h];
311339a0 78 if (@is_readable("$check_hash_dir/$datafile")) {
3392dc86 79 rename("$check_hash_dir/$datafile", $result);
80 break;
81 }
82 }
83 }
84 }
62f7daa5 85
3392dc86 86 /* Return the full hashed datafile path. */
87 return ($result);
88}
89
8b096f0a 90/**
91 * Helper function for getHashedFile, given a username returns the hashed
92 * dir for that username.
93 *
94 * @param string username the username of the current user
95 * @param string dir the squirrelmail datadir
96 * @param string hash_dirs default ''
97 * @return the path to the hash dir for username
98 */
3392dc86 99function getHashedDir($username, $dir, $hash_dirs = '') {
100 global $dir_hash_level;
101
3a94810f 102 /* Remove trailing slash from $dir if found */
103 if (substr($dir, -1) == '/') {
104 $dir = substr($dir, 0, strlen($dir) - 1);
105 }
62f7daa5 106
3392dc86 107 /* If necessary, populate the hash dir variable. */
108 if ($hash_dirs == '') {
109 $hash_dirs = computeHashDirs($username);
110 }
111
112 /* Make sure the full hash directory exists. */
113 $real_hash_dir = $dir;
114 for ($h = 0; $h < $dir_hash_level; ++$h) {
115 $real_hash_dir .= '/' . $hash_dirs[$h];
3a94810f 116 if (!@is_dir($real_hash_dir)) {
117 if (!@mkdir($real_hash_dir, 0770)) {
6fd95361 118 echo sprintf(_("Error creating directory %s."), $real_hash_dir) . '<br />' .
119 _("Could not create hashed directory structure!") . "<br />\n" .
120 _("Please contact your system administrator and report this error.") . "<br />\n";
3a94810f 121 exit;
122 }
3392dc86 123 }
124 }
125
126 /* And return that directory. */
127 return ($real_hash_dir);
128}
129
8b096f0a 130/**
131 * Helper function for getHashDir which does the actual hash calculation.
132 *
133 * @param string username the username to calculate the hash dir for
134 * @return array a list of hash dirs for this username
135 */
3392dc86 136function computeHashDirs($username) {
137 /* Compute the hash for this user and extract the hash directories. */
138 $hash = base_convert(crc32($username), 10, 16);
139 $hash_dirs = array();
140 for ($h = 0; $h < 4; ++ $h) {
141 $hash_dirs[] = substr($hash, $h, 1);
142 }
143
144 /* Return our array of hash directories. */
145 return ($hash_dirs);
146}
147
e9219f94 148/**
149 * FIXME: Undocumented function
e9219f94 150 */
ae958cd3 151function checkForJavascript($reset = FALSE)
1a531551 152{
ae958cd3 153 global $data_dir, $username, $javascript_on, $javascript_setting;
1a531551 154
ae958cd3 155 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
156 return $javascript_on;
157
158 if ( $reset || !isset($javascript_setting) )
159 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
1a531551 160
ae958cd3 161 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
162 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
163 $js_autodetect_results = SMPREF_JS_OFF;
1a531551 164
165 if ( $javascript_setting == SMPREF_JS_AUTODETECT )
ae958cd3 166 $javascript_on = $js_autodetect_results;
1a531551 167 else
ae958cd3 168 $javascript_on = $javascript_setting;
1a531551 169
ae958cd3 170 sqsession_register($javascript_on, 'javascript_on');
171 return $javascript_on;
1a531551 172}
173
e9219f94 174?>