From 2965a981b7ec22866fbdf2d567d87e2d068d3617 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Fri, 31 Jul 2015 16:04:08 -0400
Subject: [PATCH] Allow to search and import missing PGP pubkeys from keyservers using Publickey.js

---
 plugins/help/help.php |   94 ++++++++++++++++++++++++++++++++++++++++-------
 1 files changed, 80 insertions(+), 14 deletions(-)

diff --git a/plugins/help/help.php b/plugins/help/help.php
index 1a76cbb..5387c9f 100644
--- a/plugins/help/help.php
+++ b/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,8 +22,7 @@
 
     function init()
     {
-        $rcmail = rcmail::get_instance();
-
+        $this->load_config();
         $this->add_texts('localization/', false);
 
         // register task
@@ -33,6 +33,14 @@
         $this->register_action('about', array($this, 'action'));
         $this->register_action('license', array($this, 'action'));
 
+        $this->add_hook('startup', array($this, 'startup'));
+        $this->add_hook('error_page', array($this, 'error_page'));
+    }
+
+    function startup($args)
+    {
+        $rcmail = rcmail::get_instance();
+
         // add taskbar button
         $this->add_button(array(
             'command'    => 'help',
@@ -41,6 +49,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();
@@ -53,11 +64,10 @@
     {
         $rcmail = rcmail::get_instance();
 
-        $this->load_config();
-
         // register UI objects
         $rcmail->output->add_handlers(array(
             'helpcontent' => array($this, 'content'),
+            'tablink' => array($this, 'tablink'),
         ));
 
         if ($rcmail->action == 'about')
@@ -70,28 +80,84 @@
         $rcmail->output->send('help.help');
     }
 
+    function tablink($attrib)
+    {
+        $rcmail = rcmail::get_instance();
+
+        $attrib['name'] = 'helplink' . $attrib['action'];
+        $attrib['href'] = $rcmail->url(array('_action' => $attrib['action'], '_extwin' => !empty($_REQUEST['_extwin']) ? 1 : null));
+
+        // title might be already translated here, so revert to it's initial value
+        // so button() will translate it correctly
+        $attrib['title'] = $attrib['label'];
+
+        return $rcmail->output->button($attrib);
+    }
+
     function content($attrib)
     {
         $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');
+                }
+                $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 ($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';
 
         $attrib['name'] = $attrib['id'];
 
-        return html::tag('iframe', $attrib, '', array(
-            'id', 'class', 'style', 'src', 'width', 'height', 'frameborder'));
+        return $rcmail->output->frame($attrib);
     }
 
+    function error_page($args)
+    {
+        $rcmail = rcmail::get_instance();
+
+        if ($args['code'] == 403 && $rcmail->request_status == rcube::REQUEST_ERROR_URL && ($url = $rcmail->config->get('help_csrf_info'))) {
+            $args['text'] .= '<p>' . html::a(array('href' => $url, 'target' => '_blank'), $this->gettext('csrfinfo')) . '</p>';
+        }
+
+        return $args;
+    }
+
+    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);
+    }
 }

--
Gitblit v1.9.1