Add fixme/note
[squirrelmail.git] / functions / prefs.php
CommitLineData
59177427 1<?php
2ba13803 2
35586184 3/**
4 * prefs.php
5 *
202bcbcc 6 * This contains functions for filebased user prefs locations
35586184 7 *
4b5049de 8 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
31841a9e 10 * @version $Id$
d6c32258 11 * @package squirrelmail
ace4c62c 12 * @subpackage prefs
35586184 13 */
14
ace4c62c 15
7b294953 16
3499f99f 17/* Hashing functions */
fb120846 18
8b096f0a 19/**
20 * Given a username and datafilename, this will return the path to the
21 * hashed location of that datafile.
22 *
23 * @param string username the username of the current user
598294a7 24 * @param string dir the SquirrelMail datadir
8b096f0a 25 * @param string datafile the name of the file to open
26 * @param bool hash_seach default true
27 * @return string the hashed location of datafile
ace4c62c 28 * @since 1.2.0
8b096f0a 29 */
3392dc86 30function getHashedFile($username, $dir, $datafile, $hash_search = true) {
3392dc86 31
311339a0 32 /* Remove trailing slash from $dir if found */
33 if (substr($dir, -1) == '/') {
34 $dir = substr($dir, 0, strlen($dir) - 1);
35 }
62f7daa5 36
3392dc86 37 /* Compute the hash for this user and extract the hash directories. */
38 $hash_dirs = computeHashDirs($username);
39
40 /* First, get and make sure the full hash directory exists. */
41 $real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
42
12719a10 43 /* Set the value of our real data file, after we've removed unwanted characters. */
44 $datafile = str_replace('/', '_', $datafile);
4fc152a6 45 $result = "$real_hash_dir/$datafile";
3392dc86 46
47 /* Check for this file in the real hash directory. */
3a94810f 48 if ($hash_search && !@file_exists($result)) {
3392dc86 49 /* First check the base directory, the most common location. */
3a94810f 50 if (@file_exists("$dir/$datafile")) {
3392dc86 51 rename("$dir/$datafile", $result);
52
53 /* Then check the full range of possible hash directories. */
54 } else {
55 $check_hash_dir = $dir;
56 for ($h = 0; $h < 4; ++$h) {
57 $check_hash_dir .= '/' . $hash_dirs[$h];
311339a0 58 if (@is_readable("$check_hash_dir/$datafile")) {
3392dc86 59 rename("$check_hash_dir/$datafile", $result);
60 break;
61 }
62 }
63 }
64 }
62f7daa5 65
3392dc86 66 /* Return the full hashed datafile path. */
67 return ($result);
68}
69
8b096f0a 70/**
71 * Helper function for getHashedFile, given a username returns the hashed
72 * dir for that username.
73 *
74 * @param string username the username of the current user
598294a7 75 * @param string dir the SquirrelMail datadir
8b096f0a 76 * @param string hash_dirs default ''
77 * @return the path to the hash dir for username
ace4c62c 78 * @since 1.2.0
8b096f0a 79 */
3392dc86 80function getHashedDir($username, $dir, $hash_dirs = '') {
81 global $dir_hash_level;
82
3a94810f 83 /* Remove trailing slash from $dir if found */
84 if (substr($dir, -1) == '/') {
85 $dir = substr($dir, 0, strlen($dir) - 1);
86 }
62f7daa5 87
3392dc86 88 /* If necessary, populate the hash dir variable. */
89 if ($hash_dirs == '') {
90 $hash_dirs = computeHashDirs($username);
91 }
92
93 /* Make sure the full hash directory exists. */
94 $real_hash_dir = $dir;
95 for ($h = 0; $h < $dir_hash_level; ++$h) {
96 $real_hash_dir .= '/' . $hash_dirs[$h];
3a94810f 97 if (!@is_dir($real_hash_dir)) {
f8cde393 98//FIXME: When safe_mode is turned on, the error suppression below makes debugging safe_mode UID/GID restrictions tricky... for now, I will add a check in configtest
3a94810f 99 if (!@mkdir($real_hash_dir, 0770)) {
ae13f72f 100 error_box ( sprintf(_("Error creating directory %s."), $real_hash_dir) . "\n" .
101 _("Could not create hashed directory structure!") . "\n" .
102 _("Please contact your system administrator and report this error.") );
3a94810f 103 exit;
104 }
3392dc86 105 }
106 }
107
108 /* And return that directory. */
109 return ($real_hash_dir);
110}
111
8b096f0a 112/**
113 * Helper function for getHashDir which does the actual hash calculation.
114 *
115 * @param string username the username to calculate the hash dir for
116 * @return array a list of hash dirs for this username
ace4c62c 117 * @since 1.2.0
8b096f0a 118 */
3392dc86 119function computeHashDirs($username) {
120 /* Compute the hash for this user and extract the hash directories. */
121 $hash = base_convert(crc32($username), 10, 16);
122 $hash_dirs = array();
123 for ($h = 0; $h < 4; ++ $h) {
124 $hash_dirs[] = substr($hash, $h, 1);
125 }
126
127 /* Return our array of hash directories. */
128 return ($hash_dirs);
129}