From 6d969b4d9020560d3491d19a5b0487e325e9bce4 Mon Sep 17 00:00:00 2001 From: thomascube Date: Tue, 7 Aug 2007 21:02:12 +0000 Subject: [PATCH] Documentation, code style and cleanup --- .htaccess | 2 +- bin/makedoc.sh | 18 + index.php | 1 - program/include/bugs.inc | 90 +- program/include/cache.inc | 106 -- program/include/main.inc | 515 ++++----- program/include/rcmail_template.inc | 308 +++++- program/include/rcube_contacts.inc | 9 +- program/include/rcube_db.inc | 2 +- program/include/rcube_html.inc | 671 ++++++++++++ program/include/rcube_imap.inc | 377 +++++-- program/include/rcube_ldap.inc | 41 +- program/include/rcube_mdb2.inc | 6 +- program/include/rcube_shared.inc | 1513 +++++---------------------- program/include/rcube_smtp.inc | 11 +- program/include/rcube_sqlite.inc | 52 +- 16 files changed, 1912 insertions(+), 1810 deletions(-) create mode 100755 bin/makedoc.sh delete mode 100644 program/include/cache.inc create mode 100644 program/include/rcube_html.inc diff --git a/.htaccess b/.htaccess index 9474105de..b69de0cfd 100644 --- a/.htaccess +++ b/.htaccess @@ -4,7 +4,7 @@ php_flag log_errors On php_value error_log logs/errors php_value upload_max_filesize 2M - + Order allow,deny Deny from all diff --git a/bin/makedoc.sh b/bin/makedoc.sh new file mode 100755 index 000000000..5925d0a3f --- /dev/null +++ b/bin/makedoc.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +TITLE="RoundCube Classes" +PACKAGES="Core" + +PATH_PROJECT=$PWD/program/include +PATH_DOCS=$PWD/doc/phpdoc +PATH_PHPDOC=/usr/local/php5/bin/phpdoc + +OUTPUTFORMAT=HTML +CONVERTER=frames +TEMPLATE=earthli +PRIVATE=off + +# make documentation +$PATH_PHPDOC -d $PATH_PROJECT -t $PATH_DOCS -ti "$TITLE" -dn $PACKAGES \ +-o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE + diff --git a/index.php b/index.php index 60474998f..9908cf2a0 100644 --- a/index.php +++ b/index.php @@ -81,7 +81,6 @@ require_once('include/rcube_shared.inc'); require_once('include/rcube_imap.inc'); require_once('include/bugs.inc'); require_once('include/main.inc'); -require_once('include/cache.inc'); require_once('PEAR.php'); diff --git a/program/include/bugs.inc b/program/include/bugs.inc index 946a910be..9d98ef45b 100644 --- a/program/include/bugs.inc +++ b/program/include/bugs.inc @@ -4,8 +4,8 @@ +-----------------------------------------------------------------------+ | program/include/bugs.inc | | | - | This file is part of the BQube Webmail client | - | Copyright (C) 2005, BQube Dev - Switzerland | + | This file is part of the RoudCube Webmail client | + | Copyright (C) 2005-2007, RoudCube Dev - Switzerland | | Licensed under the GNU GPL | | | | PURPOSE: | @@ -20,19 +20,29 @@ */ -// throw system error and show error page -function raise_error($arg=array(), $log=FALSE, $terminate=FALSE) +/** + * Error handling and logging functions + * + * @package Core + */ + + +/** + * Throw system error and show error page + * + * @param array Named parameters + * - code: Error code (required) + * - type: Error type [php|db|imap|javascript] (required) + * - message: Error message + * - file: File where error occured + * - line: Line where error occured + * @param boolean True to log the error + * @param boolean Terminate script execution + */ +function raise_error($arg=array(), $log=false, $terminate=false) { global $__page_content, $CONFIG, $OUTPUT, $ERROR_CODE, $ERROR_MESSAGE; - /* $arg keys: - int code - string type (php, xpath, db, imap, javascript) - string message - sring file - int line - */ - // report bug (if not incompatible browser) if ($log && $arg['type'] && $arg['message']) log_bug($arg); @@ -48,61 +58,53 @@ function raise_error($arg=array(), $log=FALSE, $terminate=FALSE) } -// report error +/** + * Report error according to configured debug_level + * + * @param array Named parameters + * @see raise_error() + */ function log_bug($arg_arr) - { +{ global $CONFIG, $INSTALL_PATH; $program = $arg_arr['type']=='xpath' ? 'XPath' : strtoupper($arg_arr['type']); // write error to local log file if ($CONFIG['debug_level'] & 1) - { - $log_entry = sprintf("[%s] %s Error: %s in %s on line %d\n", - date("d-M-Y H:i:s O", mktime()), - $program, - $arg_arr['message'], - $arg_arr['file'], - $arg_arr['line']); + { + $log_entry = sprintf( + "[%s] %s Error: %s in %s on line %d\n", + date("d-M-Y H:i:s O", mktime()), + $program, + $arg_arr['message'], + $arg_arr['file'], + $arg_arr['line']); if (empty($CONFIG['log_dir'])) $CONFIG['log_dir'] = $INSTALL_PATH.'logs'; // try to open specific log file for writing if ($fp = @fopen($CONFIG['log_dir'].'/errors', 'a')) - - { + { fwrite($fp, $log_entry); fclose($fp); - } + } else - { + { // send error to PHPs error handler trigger_error($arg_arr['message']); - } } + } -/* // resport the bug to the global bug reporting system if ($CONFIG['debug_level'] & 2) - { - $delm = '%AC'; - http_request(sprintf('http://roundcube.net/log/bug.php?_type=%s&_domain=%s&_server_ip=%s&_client_ip=%s&_useragent=%s&_url=%s%%3A//%s&_errors=%s%s%s%s%s', - $arg_arr['type'], - $GLOBALS['HTTP_HOST'], - $GLOBALS['SERVER_ADDR'], - $GLOBALS['REMOTE_ADDR'], - rawurlencode($GLOBALS['HTTP_USER_AGENT']), - $GLOBALS['SERVER_PORT']==43 ? 'https' : 'http', - $GLOBALS['HTTP_HOST'].$GLOBALS['REQUEST_URI'], - $arg_arr['file'], $delm, - $arg_arr['line'], $delm, - rawurlencode($arg_arr['message']))); - } -*/ + { + // TODO: Send error via HTTP + } // show error if debug_mode is on if ($CONFIG['debug_level'] & 4) - { + { print "$program Error"; if (!empty($arg_arr['file']) && !empty($arg_arr['line'])) @@ -112,7 +114,7 @@ function log_bug($arg_arr) print nl2br($arg_arr['message']); print '
'; flush(); - } } +} ?> diff --git a/program/include/cache.inc b/program/include/cache.inc deleted file mode 100644 index 06e0681ce..000000000 --- a/program/include/cache.inc +++ /dev/null @@ -1,106 +0,0 @@ - | - +-----------------------------------------------------------------------+ - - $Id$ - -*/ - - -function rcube_read_cache($key) - { - global $DB, $CACHE_KEYS; - - // query db - $sql_result = $DB->query("SELECT cache_id, data - FROM ".get_table_name('cache')." - WHERE user_id=? - AND cache_key=?", - $_SESSION['user_id'], - $key); - - // get cached data - if ($sql_arr = $DB->fetch_assoc($sql_result)) - { - $data = $sql_arr['data']; - $CACHE_KEYS[$key] = $sql_arr['cache_id']; - } - else - $data = FALSE; - - return $data; - } - - -function rcube_write_cache($key, $data, $session_cache=FALSE) - { - global $DB, $CACHE_KEYS, $sess_id; - - // check if we already have a cache entry for this key - if (!isset($CACHE_KEYS[$key])) - { - $sql_result = $DB->query("SELECT cache_id - FROM ".get_table_name('cache')." - WHERE user_id=? - AND cache_key=?", - $_SESSION['user_id'], - $key); - - if ($sql_arr = $DB->fetch_assoc($sql_result)) - $CACHE_KEYS[$key] = $sql_arr['cache_id']; - else - $CACHE_KEYS[$key] = FALSE; - } - - // update existing cache record - if ($CACHE_KEYS[$key]) - { - $DB->query("UPDATE ".get_table_name('cache')." - SET created=now(), - data=? - WHERE user_id=? - AND cache_key=?", - $data, - $_SESSION['user_id'], - $key); - } - // add new cache record - else - { - $DB->query("INSERT INTO ".get_table_name('cache')." - (created, user_id, session_id, cache_key, data) - VALUES (now(), ?, ?, ?, ?)", - $_SESSION['user_id'], - $session_cache ? $sess_id : 'NULL', - $key, - $data); - } - } - - -function rcube_clear_cache($key) - { - global $DB; - - $DB->query("DELETE FROM ".get_table_name('cache')." - WHERE user_id=? - AND cache_key=?", - $_SESSION['user_id'], - $key); - } - - -?> \ No newline at end of file diff --git a/program/include/main.inc b/program/include/main.inc index e46cb5385..aa1de9754 100644 --- a/program/include/main.inc +++ b/program/include/main.inc @@ -19,6 +19,13 @@ */ +/** + * RoundCube Webmail common functions + * + * @package Core + * @author Thomas Bruederli + */ + require_once('lib/des.inc'); require_once('lib/utf7.inc'); require_once('lib/utf8.class.php'); @@ -31,7 +38,12 @@ define('RCUBE_INPUT_POST', 0x0102); define('RCUBE_INPUT_GPC', 0x0103); -// register session and connect to server +/** + * Initial startup function + * to register session, create database and imap connections + * + * @param string Current task + */ function rcmail_startup($task='mail') { global $sess_id, $sess_user_lang; @@ -48,9 +60,11 @@ function rcmail_startup($task='mail') ini_set('session.gc_maxlifetime', ($CONFIG['session_lifetime']) * 120); // prepare DB connection - require_once('include/rcube_'.(empty($CONFIG['db_backend']) ? 'db' : $CONFIG['db_backend']).'.inc'); + $dbwrapper = empty($CONFIG['db_backend']) ? 'db' : $CONFIG['db_backend']; + $dbclass = "rcube_" . $dbwrapper; + require_once("include/$dbclass.inc"); - $DB = new rcube_db($CONFIG['db_dsnw'], $CONFIG['db_dsnr'], $CONFIG['db_persistent']); + $DB = new $dbclass($CONFIG['db_dsnw'], $CONFIG['db_dsnr'], $CONFIG['db_persistent']); $DB->sqlite_initials = $INSTALL_PATH.'SQL/sqlite.initial.sql'; $DB->db_connect('w'); @@ -101,7 +115,11 @@ function rcmail_startup($task='mail') } -// load roundcube configuration into global var +/** + * Load roundcube configuration array + * + * @return array Named configuration parameters + */ function rcmail_load_config() { global $INSTALL_PATH; @@ -139,7 +157,12 @@ function rcmail_load_config() } -// load a host-specific config file if configured +/** + * Load a host-specific config file if configured + * This will merge the host specific configuration with the given one + * + * @param array Global configuration parameters + */ function rcmail_load_host_config(&$config) { $fname = NULL; @@ -157,7 +180,13 @@ function rcmail_load_host_config(&$config) } -// create authorization hash +/** + * Create unique authorization hash + * + * @param string Session ID + * @param int Timestamp + * @return string The generated auth hash + */ function rcmail_auth_hash($sess_id, $ts) { global $CONFIG; @@ -175,7 +204,11 @@ function rcmail_auth_hash($sess_id, $ts) } -// compare the auth hash sent by the client with the local session credentials +/** + * Check the auth hash sent by the client against the local session credentials + * + * @return boolean True if valid, False if not + */ function rcmail_authenticate_session() { global $CONFIG, $SESS_CLIENT_IP, $SESS_CHANGED; @@ -206,7 +239,11 @@ function rcmail_authenticate_session() } -// create IMAP object and connect to server +/** + * Create global IMAP object and connect to server + * + * @param boolean True if connection should be established + */ function rcmail_imap_init($connect=FALSE) { global $CONFIG, $DB, $IMAP, $OUTPUT; @@ -235,8 +272,10 @@ function rcmail_imap_init($connect=FALSE) } -// set root dir and last stored mailbox -// this must be done AFTER connecting to the server +/** + * Set root dir and last stored mailbox + * This must be done AFTER connecting to the server! + */ function rcmail_set_imap_prop() { global $CONFIG, $IMAP; @@ -255,7 +294,9 @@ function rcmail_set_imap_prop() } -// do these things on script shutdown +/** + * Do these things on script shutdown + */ function rcmail_shutdown() { global $IMAP; @@ -271,7 +312,9 @@ function rcmail_shutdown() } -// destroy session data and remove cookie +/** + * Destroy session data and remove cookie + */ function rcmail_kill_session() { // save user preferences @@ -292,7 +335,12 @@ function rcmail_kill_session() } -// return correct name for a specific database table +/** + * Return correct name for a specific database table + * + * @param string Table name + * @return string Translated table name + */ function get_table_name($table) { global $CONFIG; @@ -307,8 +355,13 @@ function get_table_name($table) } -// return correct name for a specific database sequence -// (used for Postres only) +/** + * Return correct name for a specific database sequence + * (used for Postres only) + * + * @param string Secuence name + * @return string Translated sequence name + */ function get_sequence_name($sequence) { global $CONFIG; @@ -323,7 +376,13 @@ function get_sequence_name($sequence) } -// check the given string and returns language properties +/** + * Check the given string and returns language properties + * + * @param string Language code + * @param string Peropert name + * @return string Property value + */ function rcube_language_prop($lang, $prop='lang') { global $INSTALL_PATH; @@ -360,7 +419,11 @@ function rcube_language_prop($lang, $prop='lang') } -// init output object for GUI and add common scripts +/** + * Init output object for GUI and add common scripts. + * This will instantiate a rcmail_template object and set + * environment vars according to the current session and configuration + */ function rcmail_load_gui() { global $CONFIG, $OUTPUT, $sess_user_lang; @@ -399,7 +462,10 @@ function rcmail_load_gui() } -// set localization charset based on the given language +/** + * Set localization charset based on the given language. + * This also creates a global property for mbstring usage. + */ function rcmail_set_locale($lang) { global $OUTPUT, $MBSTRING; @@ -418,7 +484,11 @@ function rcmail_set_locale($lang) } -// auto-select IMAP host based on the posted login information +/** + * Auto-select IMAP host based on the posted login information + * + * @return string Selected IMAP host + */ function rcmail_autoselect_host() { global $CONFIG; @@ -446,7 +516,15 @@ function rcmail_autoselect_host() } -// perfom login to the IMAP server and to the webmail service +/** + * Perfom login to the IMAP server and to the webmail service. + * This will also create a new user entry if auto_create_user is configured. + * + * @param string IMAP user name + * @param string IMAP password + * @param string IMAP host + * @return boolean True on success, False on failure + */ function rcmail_login($user, $pass, $host=NULL) { global $CONFIG, $IMAP, $DB, $sess_user_lang; @@ -575,7 +653,13 @@ function rcmail_login($user, $pass, $host=NULL) } -// create new entry in users and identities table +/** + * Create new entry in users and identities table + * + * @param string User name + * @param string IMAP host + * @return mixed New user ID or False on failure + */ function rcmail_create_user($user, $host) { global $DB, $CONFIG, $IMAP; @@ -646,7 +730,11 @@ function rcmail_create_user($user, $host) } -// load virtuser table in array +/** + * Load virtuser table in array + * + * @return array Virtuser table entries + */ function rcmail_getvirtualfile() { global $CONFIG; @@ -659,7 +747,12 @@ function rcmail_getvirtualfile() } -// find matches of the given pattern in virtuser table +/** + * Find matches of the given pattern in virtuser table + * + * @param string Regular expression to search for + * @return array Matching entries + */ function rcmail_findinvirtual($pattern) { $result = array(); @@ -682,7 +775,12 @@ function rcmail_findinvirtual($pattern) } -// resolve username with virtuser table +/** + * Resolve username using a virtuser table + * + * @param string E-mail address to resolve + * @return string Resolved IMAP username + */ function rcmail_email2user($email) { $user = $email; @@ -703,7 +801,12 @@ function rcmail_email2user($email) } -// resolve e-mail address with virtuser table +/** + * Resolve e-mail address from virtuser table + * + * @param string User name + * @return string Resolved e-mail address + */ function rcmail_user2email($user) { $email = ""; @@ -724,6 +827,12 @@ function rcmail_user2email($user) } +/** + * Write the given user prefs to the user's record + * + * @param mixed User prefs to save + * @return boolean True on success, False on failure + */ function rcmail_save_user_prefs($a_user_prefs) { global $DB, $CONFIG, $sess_user_lang; @@ -747,7 +856,11 @@ function rcmail_save_user_prefs($a_user_prefs) } -// overwrite action variable +/** + * Overwrite action variable + * + * @param string New action value + */ function rcmail_overwrite_action($action) { global $OUTPUT; @@ -789,7 +902,12 @@ function show_message($message, $type='notice', $vars=NULL) } -// encrypt IMAP password using DES encryption +/** + * Encrypt IMAP password using DES encryption + * + * @param string Password to encrypt + * @return string Encryprted string + */ function encrypt_passwd($pass) { $cypher = des(get_des_key(), $pass, 1, 0, NULL); @@ -797,7 +915,12 @@ function encrypt_passwd($pass) } -// decrypt IMAP password using DES encryption +/** + * Decrypt IMAP password using DES encryption + * + * @param string Encrypted password + * @return string Plain password + */ function decrypt_passwd($cypher) { $pass = des(get_des_key(), base64_decode($cypher), 0, 0, NULL); @@ -805,7 +928,11 @@ function decrypt_passwd($cypher) } -// return a 24 byte key for the DES encryption +/** + * Return a 24 byte key for the DES encryption + * + * @return string DES encryption key + */ function get_des_key() { $key = !empty($GLOBALS['CONFIG']['des_key']) ? $GLOBALS['CONFIG']['des_key'] : 'rcmail?24BitPwDkeyF**ECB'; @@ -821,7 +948,11 @@ function get_des_key() } -// read directory program/localization/ and return a list of available languages +/** + * Read directory program/localization and return a list of available languages + * + * @return array List of available localizations + */ function rcube_list_languages() { global $CONFIG, $INSTALL_PATH; @@ -848,7 +979,9 @@ function rcube_list_languages() } -// add a localized label to the client environment +/** + * Add a localized label to the client environment + */ function rcube_add_label() { global $OUTPUT; @@ -859,7 +992,10 @@ function rcube_add_label() } -// remove temp files older than two day +/** + * Garbage collector function for temp files. + * Remove temp files older than two days + */ function rcmail_temp_gc() { $tmp = unslashify($CONFIG['temp_dir']); @@ -881,7 +1017,10 @@ function rcmail_temp_gc() } -// remove all expired message cache records +/** + * Garbage collector for cache entries. + * Remove all expired message cache records + */ function rcmail_message_cache_gc() { global $DB, $CONFIG; @@ -1054,8 +1193,11 @@ function rep_specialchars_output($str, $enctype='', $mode='', $newlines=TRUE) } /** - * Quote a given string. Alias function for rep_specialchars_output - * @see rep_specialchars_output + * Quote a given string. + * Shortcut function for rep_specialchars_output + * + * @return string HTML-quoted string + * @see rep_specialchars_output() */ function Q($str, $mode='strict', $newlines=TRUE) { @@ -1063,8 +1205,11 @@ function Q($str, $mode='strict', $newlines=TRUE) } /** - * Quote a given string. Alias function for rep_specialchars_output - * @see rep_specialchars_output + * Quote a given string for javascript output. + * Shortcut function for rep_specialchars_output + * + * @return string JS-quoted string + * @see rep_specialchars_output() */ function JQ($str) { @@ -1116,16 +1261,24 @@ function get_input_value($fname, $source, $allow_html=FALSE, $charset=NULL) return $value; } + /** * Remove single and double quotes from given string + * + * @param string Input value + * @return string Dequoted string */ function strip_quotes($str) { return preg_replace('/[\'"]/', '', $str); } + /** * Remove new lines characters from given string + * + * @param string Input value + * @return string Stripped string */ function strip_newlines($str) { @@ -1133,7 +1286,12 @@ function strip_newlines($str) } -// return boolean if a specific template exists +/** + * Check if a specific template exists + * + * @param string Template name + * @return boolean True if template exists + */ function template_exists($name) { global $CONFIG; @@ -1144,15 +1302,25 @@ function template_exists($name) } -// Wrapper for rcmail_template::parse() -// @deprecated +/** + * Wrapper for rcmail_template::parse() + * @deprecated + */ function parse_template($name='main', $exit=true) { $GLOBALS['OUTPUT']->parse($name, $exit); } - +/** + * Create a HTML table based on the given data + * + * @param array Named table attributes + * @param mixed Table row data. Either a two-dimensional array or a valid SQL result set + * @param array List of cols to show + * @param string Name of the identifier col + * @return string HTML table code + */ function rcube_table_output($attrib, $table_data, $a_show_cols, $id_col) { global $DB; @@ -1254,7 +1422,12 @@ function rcmail_get_edit_field($col, $value, $attrib, $type='text') } -// return the mail domain configured for the given host +/** + * Return the mail domain configured for the given host + * + * @param string IMAP host + * @return string Resolved SMTP host + */ function rcmail_mail_domain($host) { global $CONFIG; @@ -1272,7 +1445,13 @@ function rcmail_mail_domain($host) } -// compose a valid attribute string for HTML tags +/** + * Compose a valid attribute string for HTML tags + * + * @param array Named tag attributes + * @param array List of allowed attributes + * @return string HTML formatted attribute string + */ function create_attrib_string($attrib, $allowed_attribs=array('id', 'class', 'style')) { // allow the following attributes to be added to the