Docs for page prefs.php

Description

prefs.php

This contains functions for filebased user prefs locations

version: $Id: prefs.php 14840 2020-01-07 07:42:38Z pdontthink $
copyright: 1999-2020 The SquirrelMail Project Team
filesource: Source Code for this file
license: GNU Public License

Includes

include_once (SM_PATH.'functions/display_messages.php') (line 20)

include this for error messages

require_once (SM_PATH.'functions/global.php') (line 16)

Include global.php

require_once (SM_PATH.$prefs_backend) (line 37)

require_once (SM_PATH.'functions/file_prefs.php') (line 41)

require_once (SM_PATH.'functions/db_prefs.php') (line 39)

require_once (SM_PATH.'functions/plugin.php') (line 17)

Functions

computeHashDirs (line 162)

Helper function for getHashDir which does the actual hash calculation.

Uses a crc32 algorithm by default, but if you put the following in config/config_local.php, you can force md5 instead: $hash_dirs_use_md5 = TRUE;

You may also specify that if usernames are in full email address format, the domain part (beginning with "@") be stripped before calculating the crc or md5. Do that by putting the following in config/config_local.php: $hash_dirs_strip_domain = TRUE;

return: a list of hash dirs for this username
since: 1.2.0

array computeHashDirs (string $username)

string $username: username the username to calculate the hash dir for

getHashedDir (line 109)

Helper function for getHashedFile(), given a username returns the hashed dir for that username.

NOTE that the hashed dir will be created if it doesn't already exist.

return: path to the hash dir for username

the getHashedDir (string $username, string $dir, [string $hash_dirs = ''])

string $username: username the username of the current user
string $dir: dir the squirrelmail datadir
string $hash_dirs: hash_dirs default ''

getHashedFile (line 56)

Given a username and datafilename, this will return the path to the hashed location of that datafile.

return: the hashed location of datafile

string getHashedFile (string $username, string $dir, string $datafile, [bool $hash_search = true])

string $username: username the username of the current user
string $dir: dir the squirrelmail datadir
string $datafile: datafile the name of the file to open
bool $hash_search: hash_seach default true

/functions/prefs.php