- Help plugin

- support 'dummy' task (for plugins)

1 files changed, 90 insertions, 0 deletions

diff --git a/plugins/help/help.php b/plugins/help/help.php
new file mode 100644
index 000000000..336321c88
--- /dev/null
+++ b/plugins/help/help.php
@@ -0,0 +1,90 @@
+<?php
+
+/**
+ * Help Plugin
+ *
+ * @author Aleksander 'A.L.E.C' Machniak
+ * @licence GNU GPL
+ *
+ * Enable the plugin in config/main.inc.php and set Help content iframe source
+ *   $rcmail_config['help_source'] = 'http://trac.roundcube.net/wiki';
+ * 
+ **/
+ 
+class help extends rcube_plugin
+{
+    function init()
+    {
+      $this->add_texts('localization/', false);
+      
+      // register actions
+      $this->register_action('plugin.help', array($this, 'action'));
+      $this->register_action('plugin.helpabout', array($this, 'action'));
+      $this->register_action('plugin.helplicense', array($this, 'action'));
+
+      // add taskbar button
+      $this->add_button(array(
+	'name' 	=> 'helptask',
+	'class'	=> 'button-help',
+	'label'	=> 'help.help',
+	'href'	=> './?_task=dummy&_action=plugin.help',
+        ), 'taskbar');
+
+      $skin = rcmail::get_instance()->config->get('skin');
+      if (!file_exists($this->home."/skins/$skin/help.css"))
+	$skin = 'default';
+
+      // add style for taskbar button (must be here) and Help UI    
+      $this->include_stylesheet("skins/$skin/help.css");
+    }
+
+    function action()
+    {
+      $rcmail = rcmail::get_instance();
+
+      // register UI objects
+      $rcmail->output->add_handlers(array(
+	    'helpcontent' => array($this, 'content'),
+      ));
+
+      if ($rcmail->action == 'plugin.helpabout')
+	$rcmail->output->set_pagetitle($this->gettext('about'));
+      else if ($rcmail->action == 'plugin.helplicense')
+        $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();
+
+      if ($rcmail->action == 'plugin.helpabout') {
+	return @file_get_contents($this->home.'/content/about.html');
+      }
+      else if ($rcmail->action == 'plugin.helplicense') {
+	return @file_get_contents($this->home.'/content/license.html');
+      }
+
+      // default content: iframe
+
+      if ($src = $rcmail->config->get('help_source'))
+	$attrib['src'] = $src;
+
+      if (empty($attrib['id']))
+        $attrib['id'] = 'rcmailhelpcontent';
+    
+      // allow the following attributes to be added to the <iframe> tag
+      $attrib_str = create_attrib_string($attrib, array('id', 'class', 'style', 'src', 'width', 'height', 'frameborder'));
+      $framename = $attrib['id'];
+
+      $out = sprintf('<iframe name="%s"%s></iframe>'."\n", $framename, $attrib_str);
+    
+      return $out;
+    }
+    
+}
+
+?>