Cleanup, remove file paths from doc

Aleksander Machniak

2012-12-18 d2534c63f2c0b640a39fce2a71b14a5dcda6e7fd

 program/lib/Roundcube/rcube.php

@@ -2,8 +2,6 @@

/*
 +-----------------------------------------------------------------------+
 | program/include/rcube.php                                             |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
 | Copyright (C) 2011-2012, Kolab Systems AG                             |
@@ -36,7 +34,7 @@
    /**
     * Singleton instace of rcube
     *
     * @var rcmail
     * @var rcube
     */
    static protected $instance;

@@ -379,7 +377,7 @@
    {
        $storage = $this->get_storage();

        $storage->set_charset($this->config->get('default_charset', RCMAIL_CHARSET));
        $storage->set_charset($this->config->get('default_charset', RCUBE_CHARSET));

        if ($default_folders = $this->config->get('default_folders')) {
            $storage->set_default_folders($default_folders);
@@ -596,8 +594,8 @@
            ob_start();

            // get english labels (these should be complete)
            @include(INSTALL_PATH . 'program/localization/en_US/labels.inc');
            @include(INSTALL_PATH . 'program/localization/en_US/messages.inc');
            @include(RCUBE_LOCALIZATION_DIR . 'en_US/labels.inc');
            @include(RCUBE_LOCALIZATION_DIR . 'en_US/messages.inc');

            if (is_array($labels))
                $this->texts = $labels;
@@ -605,9 +603,9 @@
                $this->texts = array_merge($this->texts, $messages);

            // include user language files
            if ($lang != 'en' && $lang != 'en_US' && is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
                include_once(INSTALL_PATH . 'program/localization/' . $lang . '/labels.inc');
                include_once(INSTALL_PATH . 'program/localization/' . $lang . '/messages.inc');
            if ($lang != 'en' && $lang != 'en_US' && is_dir(RCUBE_LOCALIZATION_DIR . $lang)) {
                include_once(RCUBE_LOCALIZATION_DIR . $lang . '/labels.inc');
                include_once(RCUBE_LOCALIZATION_DIR . $lang . '/messages.inc');

                if (is_array($labels))
                    $this->texts = array_merge($this->texts, $labels);
@@ -645,7 +643,7 @@
        }

        if (empty($rcube_languages)) {
            @include(INSTALL_PATH . 'program/localization/index.inc');
            @include(RCUBE_LOCALIZATION_DIR . 'index.inc');
        }

        // check if we have an alias for that language
@@ -666,7 +664,7 @@
            }
        }

        if (!isset($rcube_languages[$lang]) || !is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
        if (!isset($rcube_languages[$lang]) || !is_dir(RCUBE_LOCALIZATION_DIR . $lang)) {
            $lang = 'en_US';
        }

@@ -684,11 +682,11 @@
        static $sa_languages = array();

        if (!sizeof($sa_languages)) {
            @include(INSTALL_PATH . 'program/localization/index.inc');
            @include(RCUBE_LOCALIZATION_DIR . 'index.inc');

            if ($dh = @opendir(INSTALL_PATH . 'program/localization')) {
            if ($dh = @opendir(RCUBE_LOCALIZATION_DIR)) {
                while (($name = readdir($dh)) !== false) {
                    if ($name[0] == '.' || !is_dir(INSTALL_PATH . 'program/localization/' . $name)) {
                    if ($name[0] == '.' || !is_dir(RCUBE_LOCALIZATION_DIR . $name)) {
                        continue;
                    }

@@ -894,6 +892,30 @@


    /**
     * Quote a given string.
     * Shortcut function for rcube_utils::rep_specialchars_output()
     *
     * @return string HTML-quoted string
     */
    public static function Q($str, $mode = 'strict', $newlines = true)
    {
        return rcube_utils::rep_specialchars_output($str, 'html', $mode, $newlines);
    }


    /**
     * Quote a given string for javascript output.
     * Shortcut function for rcube_utils::rep_specialchars_output()
     *
     * @return string JS-quoted string
     */
    public static function JQ($str)
    {
        return rcube_utils::rep_specialchars_output($str, 'js');
    }


    /**
     * Construct shell command, execute it and return output as string.
     * Keywords {keyword} are replaced with arguments
     *
@@ -1017,7 +1039,7 @@
        $log_dir  = self::$instance ? self::$instance->config->get('log_dir') : null;

        if (empty($log_dir)) {
            $log_dir = INSTALL_PATH . 'logs';
            $log_dir = RCUBE_INSTALL_PATH . 'logs';
        }

        // try to open specific log file for writing
@@ -1203,8 +1225,38 @@
        if (is_object($this->user)) {
            return $this->user->get_username();
        }
        else if (isset($_SESSION['username'])) {
            return $_SESSION['username'];
        }
    }

        return null;

    /**
     * Getter for logged user email (derived from user name not identity).
     *
     * @return string User email address
     */
    public function get_user_email()
    {
        if (is_object($this->user)) {
            return $this->user->get_username('mail');
        }
    }


    /**
     * Getter for logged user password.
     *
     * @return string User password
     */
    public function get_user_password()
    {
        if ($this->password) {
            return $this->password;
        }
        else if ($_SESSION['password']) {
            return $this->decrypt($_SESSION['password']);
        }
    }
}

@@ -1212,7 +1264,8 @@
/**
 * Lightweight plugin API class serving as a dummy if plugins are not enabled
 *
 * @package Core
 * @package Framework
 * @subpackage Core
 */
class rcube_dummy_plugin_api
{