Improve help plugin with some options to display contents according to the ...

Thomas Bruederli

2013-07-04 08167e91140e533dbc52279071767813fee8401c

 plugins/help/help.php

@@ -1,9 +1,10 @@
<?php

/**
 * Help Plugin
 * Roundcube Help Plugin
 *
 * @author Aleksander 'A.L.E.C' Machniak
 * @author Thomas Bruederli <thomas@roundcube.net>
 * @license GNU GPLv3+
 *
 * Configuration (see config.inc.php.dist)
@@ -21,6 +22,7 @@

    function init()
    {
        $this->load_config();
        $this->add_texts('localization/', false);

        // register task
@@ -31,6 +33,8 @@
        $this->register_action('about', array($this, 'action'));
        $this->register_action('license', array($this, 'action'));

        $rcmail = rcmail::get_instance();

        // add taskbar button
        $this->add_button(array(
            'command'    => 'help',
@@ -39,6 +43,9 @@
            'innerclass' => 'button-inner',
            'label'      => 'help.help',
        ), 'taskbar');

        $this->include_script('help.js');
        $rcmail->output->set_env('help_open_extwin', $rcmail->config->get('help_open_extwin', false), true);

        // add style for taskbar button (must be here) and Help UI
        $skin_path = $this->local_skin_path();
@@ -50,8 +57,6 @@
    function action()
    {
        $rcmail = rcmail::get_instance();

        $this->load_config();

        // register UI objects
        $rcmail->output->add_handlers(array(
@@ -72,16 +77,39 @@
    {
        $rcmail = rcmail::get_instance();

        if ($rcmail->action == 'about') {
            return @file_get_contents($this->home.'/content/about.html');
        }
        else if ($rcmail->action == 'license') {
            return @file_get_contents($this->home.'/content/license.html');
        switch ($rcmail->action) {
            case 'about':
                if (is_readable($this->home . '/content/about.html')) {
                    return @file_get_contents($this->home . '/content/about.html');
                }
                $src = $rcmail->config->get('help_about_url', $rcmail->url(array('_task' => 'settings', '_action' => 'about')));
                break;

            case 'license':
                if (is_readable($this->home . '/content/license.html')) {
                    return @file_get_contents($this->home . '/content/license.html');
                }
                $src = $rcmail->config->get('help_license_url', 'http://www.gnu.org/licenses/gpl-3.0-standalone.html');
                break;

            default:
                $src = $rcmail->config->get('help_source');

                // resolve task/action for depp linking
                $index_map = $rcmail->config->get('help_index_map', array());
                $rel = $_REQUEST['_rel'];
                list($task,$action) = explode('/', $rel);
                if ($add = $index_map[$rel])
                    $src .= $add;
                else if ($add = $index_map[$task])
                    $src .= $add;
                break;
        }

        // default content: iframe
        if ($src = $rcmail->config->get('help_source'))
            $attrib['src'] = $src;
        if (!empty($src)) {
            $attrib['src'] = $this->resolve_language($src);
        }

        if (empty($attrib['id']))
            $attrib['id'] = 'rcmailhelpcontent';
@@ -91,4 +119,13 @@
        return $rcmail->output->frame($attrib);
    }


    private function resolve_language($path)
    {
        // resolve language placeholder
        $rcmail = rcmail::get_instance();
        $langmap = $rcmail->config->get('help_language_map', array('*' => 'en_US'));
        $lang = !empty($langmap[$_SESSION['language']]) ? $langmap[$_SESSION['language']] : $langmap['*'];
        return str_replace('%l', $lang, $path);
    }
}