Permalink
Browse files

Documentation, code style and cleanup

  • Loading branch information...
thomascube committed Aug 7, 2007
1 parent 93be5b7 commit 6d969b4d9020560d3491d19a5b0487e325e9bce4
View
@@ -4,7 +4,7 @@ php_flag log_errors On
php_value error_log logs/errors
php_value upload_max_filesize 2M
-<FilesMatch "(\.inc|\~)$|^_">
+<FilesMatch "(\.inc|\~)$">
Order allow,deny
Deny from all
</FilesMatch>
View
@@ -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
+
View
@@ -81,7 +81,6 @@
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');
View
@@ -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 "<b>$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 '<br />';
flush();
- }
}
+}
?>
View
@@ -1,106 +0,0 @@
-<?php
-
-/*
- +-----------------------------------------------------------------------+
- | program/include/cache.inc |
- | |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2005, RoundCube Dev, - Switzerland |
- | Licensed under the GNU GPL |
- | |
- | PURPOSE: |
- | Provide access to the application cache |
- | |
- +-----------------------------------------------------------------------+
- | Author: Thomas Bruederli <roundcube@gmail.com> |
- +-----------------------------------------------------------------------+
-
- $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);
- }
-
-
-?>
Oops, something went wrong.

0 comments on commit 6d969b4

Please sign in to comment.