summaryrefslogtreecommitdiff
path: root/plugins/help/help.php
blob: ab665d0a8be8087c167444246798145f0ad56459 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?php

/**
 * 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)
 * 
 **/

class help extends rcube_plugin
{
    // all task excluding 'login' and 'logout'
    public $task = '?(?!login|logout).*';
    // we've got no ajax handlers
    public $noajax = true;
    // skip frames
    public $noframe = true;

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

        // register task
        $this->register_task('help');

        // register actions
        $this->register_action('index', array($this, 'action'));
        $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',
            'class'      => 'button-help',
            'classsel'   => 'button-help button-selected',
            '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();
        if (is_file($this->home . "/$skin_path/help.css")) {
            $this->include_stylesheet("$skin_path/help.css");
        }
    }

    function action()
    {
        $rcmail = rcmail::get_instance();

        // register UI objects
        $rcmail->output->add_handlers(array(
            'helpcontent' => array($this, 'content'),
        ));

        if ($rcmail->action == 'about')
            $rcmail->output->set_pagetitle($this->gettext('about'));
        else if ($rcmail->action == 'license')
            $rcmail->output->set_pagetitle($this->gettext('license'));
        else
            $rcmail->output->set_pagetitle($this->gettext('help'));

        $rcmail->output->send('help.help');
    }

    function content($attrib)
    {
        $rcmail = rcmail::get_instance();

        switch ($rcmail->action) {
            case 'about':
                if (is_readable($this->home . '/content/about.html')) {
                    return @file_get_contents($this->home . '/content/about.html');
                }
                $default = $rcmail->url(array('_task' => 'settings', '_action' => 'about', '_framed' => 1));
                $src     = $rcmail->config->get('help_about_url', $default);
                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 (!empty($src)) {
            $attrib['src'] = $this->resolve_language($src);
        }

        if (empty($attrib['id']))
            $attrib['id'] = 'rcmailhelpcontent';

        $attrib['name'] = $attrib['id'];

        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);
    }
}