Changeset 2209 in subversion

Timestamp:

Jan 1, 2009 1:02:59 PM (4 years ago)

Author:

thomasb

Message:

Add plugin-api implementation from old devel branch

Location:

branches/devel-api

Files:

• config/main.inc.php.dist (modified) (1 diff)
• index.php (modified) (3 diffs)
• plugins (added)
• plugins/autologon (added)
• plugins/autologon/autologon.php (added)
• plugins/emoticons (added)
• plugins/emoticons/emoticons.php (added)
• program/include/main.inc (modified) (1 diff)
• program/include/rcmail.php (modified) (4 diffs)
• program/include/rcube_config.php (modified) (1 diff)
• program/include/rcube_plugin.php (added)
• program/include/rcube_plugin_api.php (added)
• program/steps/mail/func.inc (modified) (4 diffs)

branches/devel-api/config/main.inc.php.dist

@@ -35 +35 @@
 // use this folder to store temp files (must be writeable for apache user)
 $rcmail_config['temp_dir'] = 'temp/';
+
+// use this folder to search for plugin sources
+$rcmail_config['plugins_dir'] = 'plugins/';
+
+// List of active plugins. Add the name of a directory found in 'plugins_dir'
+$rcmail_config['plugins'] = array();
 
 // enable caching of messages and mailbox data in the local database.

branches/devel-api/index.php

@@ -3 +3 @@
  +-------------------------------------------------------------------------+
  | RoundCube Webmail IMAP Client                                           |
- | Version 0.2-20080829                                                    |
- |                                                                         |
- | Copyright (C) 2005-2008, RoundCube Dev. - Switzerland                   |
+ | Version 0.2-20090101                                                    |
+ |                                                                         |
+ | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland                   |
  |                                                                         |
  | This program is free software; you can redistribute it and/or modify    |
@@ -71 +71 @@
 }
 
+
+// trigger startup plugin hook
+$startup = $RCMAIL->plugins->exec_hook('startup', array('task' => $RCMAIL->task, 'action' => $RCMAIL->action));
+$RCMAIL->set_task($startup['task']);
+$RCMAIL->action = $startup['action'];
+
+
 // try to log in
 if ($RCMAIL->action=='login' && $RCMAIL->task=='mail') {
-  $host = $RCMAIL->autoselect_host();
+  $auth = $RCMAIL->plugins->exec_hook('authenticate', array(
+    'host' => $RCMAIL->autoselect_host(),
+    'user' => trim(get_input_value('_user', RCUBE_INPUT_POST)),
+  )) + array('pass' => get_input_value('_pass', RCUBE_INPUT_POST, true, 'ISO-8859-1'));
   
   // check if client supports cookies
@@ -79 +89 @@
     $OUTPUT->show_message("cookiesdisabled", 'warning');
   }
-  else if ($_SESSION['temp'] && !empty($_POST['_user']) && !empty($_POST['_pass']) &&
-           $RCMAIL->login(trim(get_input_value('_user', RCUBE_INPUT_POST), ' '),
-              get_input_value('_pass', RCUBE_INPUT_POST, true, 'ISO-8859-1'), $host)) {
+  else if ($_SESSION['temp'] && !empty($auth['user']) && !empty($auth['host']) && isset($auth['pass']) && 
+            $RCMAIL->login($auth['user'], $auth['pass'], $auth['host'])) {
     // create new session ID
     unset($_SESSION['temp']);

branches/devel-api/program/include/main.inc

@@ -296 +296 @@
 function rep_specialchars_output($str, $enctype='', $mode='', $newlines=TRUE)
   {
-  global $OUTPUT;
   static $html_encode_arr = false;
   static $js_rep_table = false;
   static $xml_rep_table = false;
 
-  $charset = $OUTPUT->get_charset();
+  $charset = rcmail::get_instance()->config->get('charset', RCMAIL_CHARSET);
   $is_iso_8859_1 = false;
   if ($charset == 'ISO-8859-1') {

branches/devel-api/program/include/rcmail.php

@@ -38 +38 @@
   public $imap;
   public $output;
+  public $plugins;
   public $task = 'mail';
   public $action = '';
@@ -48 +49 @@
    * This implements the 'singleton' design pattern
    *
-   * @return object qvert The one and only instance
+   * @return object rcmail The one and only instance
    */
   static function get_instance()
@@ -89 +90 @@
       openlog($syslog_id, LOG_ODELAY, $syslog_facility);
     }
-                                
+
     // set task and action properties
     $this->set_task(strip_quotes(get_input_value('_task', RCUBE_INPUT_GPC)));
@@ -132 +133 @@
     if ($this->task == 'mail')
       $this->imap_init();
+      
+    // create plugin API and load plugins
+    $this->plugins = rcube_plugin_api::get_instance();
   }
   

branches/devel-api/program/include/rcube_config.php

@@ -75 +75 @@
     $this->prop['log_dir'] = $this->prop['log_dir'] ? unslashify($this->prop['log_dir']) : INSTALL_PATH . 'logs';
     $this->prop['temp_dir'] = $this->prop['temp_dir'] ? unslashify($this->prop['temp_dir']) : INSTALL_PATH . 'temp';
+    $this->prop['plugins_dir'] = $this->prop['plugins_dir'] ? unslashify($this->prop['plugins_dir']) : INSTALL_PATH . 'plugins';
 
     // fix default imap folders encoding

branches/devel-api/program/steps/mail/func.inc

@@ -626 +626 @@
 function rcmail_print_body($part, $p = array())
 {
-  global $REMOTE_OBJECTS;
-  
-  $p += array('safe' => false, 'plain' => false, 'inline_html' => true);
+  global $RCMAIL, $REMOTE_OBJECTS;
+  
+  // trigger plugin hook
+  $data = $RCMAIL->plugins->exec_hook('message-body-before',
+    array('type' => $part->ctype_secondary, 'body' => $part->body) + $p + array('safe' => false, 'plain' => false, 'inline_html' => true));
   
   // convert html to text/plain
-  if ($part->ctype_secondary == 'html' && $p['plain']) {
-    $txt = new html2text($part->body, false, true);
+  if ($data['type'] == 'html' && $data['plain']) {
+    $txt = new html2text($data['body'], false, true);
     $body = $txt->get_text();
     $part->ctype_secondary = 'plain';
   }
   // text/html
-  else if ($part->ctype_secondary == 'html') {
-    $html = $part->body;
+  else if ($data['type'] == 'html') {
+    $html = $data['body'];
 
     // special replacements (not properly handled by washtml class)
@@ -676 +678 @@
     $wash_opts = array(
       'show_washed' => false,
-      'allow_remote' => $p['safe'],
+      'allow_remote' => $data['safe'],
       'blocked_src' => "./program/blocked.gif",
       'charset' => RCMAIL_CHARSET,
@@ -683 +685 @@
     );
     
-    if (!$p['inline_html']) {
+    if (!$data['inline_html']) {
       $wash_opts['html_elements'] = array('html','head','title','body');
     }
@@ -696 +698 @@
     $body = $washer->wash($html);
     $REMOTE_OBJECTS = $washer->extlinks;
-
-    return $body;
+    
+    $part->ctype_secondary = $data['type'];
   }
   // text/enriched
-  else if ($part->ctype_secondary=='enriched') {
+  else if ($data['type'] == 'enriched') {
     $part->ctype_secondary = 'html';
-    return Q(enriched_to_html($part->body), 'show');
-  }
-  else
+    $body = Q(enriched_to_html($data['body']), 'show');
+  }
+  else {
+    // assert plaintext
+    $part->ctype_secondary = $data['type'] = 'plain';
     $body = $part->body;
-
-
-  /**** assert plaintext ****/
-
-  // make links and email-addresses clickable
-  $convert_patterns = $convert_replaces = $replace_strings = array();
-  
-  $url_chars = 'a-z0-9_\-\+\*\$\/&%=@#:;';
-  $url_chars_within = '\?\.~,!';
-
-  $convert_patterns[] = "/([\w]+):\/\/([a-z0-9\-\.]+[a-z]{2,4}([$url_chars$url_chars_within]*[$url_chars])?)/ie";
-  $convert_replaces[] = "rcmail_str_replacement('<a href=\"\\1://\\2\" target=\"_blank\">\\1://\\2</a>', \$replace_strings)";
-
-  $convert_patterns[] = "/([^\/:]|\s)(www\.)([a-z0-9\-]{2,}[a-z]{2,4}([$url_chars$url_chars_within]*[$url_chars])?)/ie";
-  $convert_replaces[] = "rcmail_str_replacement('\\1<a href=\"http://\\2\\3\" target=\"_blank\">\\2\\3</a>', \$replace_strings)";
-  
-  $convert_patterns[] = '/([a-z0-9][a-z0-9\-\.\+\_]*@[a-z0-9]([a-z0-9\-][.]?)*[a-z0-9]\\.[a-z]{2,5})/ie';
-  $convert_replaces[] = "rcmail_str_replacement('<a href=\"mailto:\\1\" onclick=\"return ".JS_OBJECT_NAME.".command(\'compose\',\'\\1\',this)\">\\1</a>', \$replace_strings)";
-  
-  // search for patterns like links and e-mail addresses
-  $body = preg_replace($convert_patterns, $convert_replaces, $body);
-
-  // split body into single lines
-  $a_lines = preg_split('/\r?\n/', $body);
-  $quote_level = 0;
-
-  // colorize quoted parts
-  for ($n=0; $n < sizeof($a_lines); $n++) {
-    $line = $a_lines[$n];
-    $quotation = '';
-    $q = 0;
-    
-    if (preg_match('/^(>+\s*)+/', $line, $regs)) {
-      $q    = strlen(preg_replace('/\s/', '', $regs[0]));
-      $line = substr($line, strlen($regs[0]));
-
-      if ($q > $quote_level)
-        $quotation = str_repeat('<blockquote>', $q - $quote_level);
-      else if ($q < $quote_level)
-        $quotation = str_repeat("</blockquote>", $quote_level - $q);
-    }
-    else if ($quote_level > 0)
-      $quotation = str_repeat("</blockquote>", $quote_level);
-
-    $quote_level = $q;
-    $a_lines[$n] = $quotation . Q($line, 'replace', false);  // htmlquote plaintext
-  }
-
-  // insert the links for urls and mailtos
-  $body = preg_replace("/##string_replacement\{([0-9]+)\}##/e", "\$replace_strings[\\1]", join("\n", $a_lines));
-
-  return html::tag('pre', array(), $body);
+  }
+
+
+  if ($part->ctype_secondary == 'plain') {
+    // make links and email-addresses clickable
+    $convert_patterns = $convert_replaces = $replace_strings = array();
+  
+    $url_chars = 'a-z0-9_\-\+\*\$\/&%=@#:;';
+    $url_chars_within = '\?\.~,!';
+
+    $convert_patterns[] = "/([\w]+):\/\/([a-z0-9\-\.]+[a-z]{2,4}([$url_chars$url_chars_within]*[$url_chars])?)/ie";
+    $convert_replaces[] = "rcmail_str_replacement('<a href=\"\\1://\\2\" target=\"_blank\">\\1://\\2</a>', \$replace_strings)";
+
+    $convert_patterns[] = "/([^\/:]|\s)(www\.)([a-z0-9\-]{2,}[a-z]{2,4}([$url_chars$url_chars_within]*[$url_chars])?)/ie";
+    $convert_replaces[] = "rcmail_str_replacement('\\1<a href=\"http://\\2\\3\" target=\"_blank\">\\2\\3</a>', \$replace_strings)";
+  
+    $convert_patterns[] = '/([a-z0-9][a-z0-9\-\.\+\_]*@[a-z0-9]([a-z0-9\-][.]?)*[a-z0-9]\\.[a-z]{2,5})/ie';
+    $convert_replaces[] = "rcmail_str_replacement('<a href=\"mailto:\\1\" onclick=\"return ".JS_OBJECT_NAME.".command(\'compose\',\'\\1\',this)\">\\1</a>', \$replace_strings)";
+  
+    // search for patterns like links and e-mail addresses
+    $body = preg_replace($convert_patterns, $convert_replaces, $body);
+
+    // split body into single lines
+    $a_lines = preg_split('/\r?\n/', $body);
+    $quote_level = 0;
+
+    // colorize quoted parts
+    for ($n=0; $n < sizeof($a_lines); $n++) {
+      $line = $a_lines[$n];
+      $quotation = '';
+      $q = 0;
+    
+      if (preg_match('/^(>+\s*)+/', $line, $regs)) {
+        $q    = strlen(preg_replace('/\s/', '', $regs[0]));
+        $line = substr($line, strlen($regs[0]));
+
+        if ($q > $quote_level)
+          $quotation = str_repeat('<blockquote>', $q - $quote_level);
+        else if ($q < $quote_level)
+          $quotation = str_repeat("</blockquote>", $quote_level - $q);
+      }
+      else if ($quote_level > 0)
+        $quotation = str_repeat("</blockquote>", $quote_level);
+
+      $quote_level = $q;
+      $a_lines[$n] = $quotation . Q($line, 'replace', false);  // htmlquote plaintext
+    }
+
+    // insert the links for urls and mailtos
+    $body = preg_replace("/##string_replacement\{([0-9]+)\}##/e", "\$replace_strings[\\1]", join("\n", $a_lines));
+  }
+  
+  // allow post-processing of the message body
+  $data = $RCMAIL->plugins->exec_hook('message-body-after', array('type' => $part->ctype_secondary, 'body' => $body) + $data);
+
+  return $data['type'] == 'html' ? $data['body'] : html::tag('pre', array(), $data['body']);
 }