Changeset 2852 in subversion

Timestamp:

Aug 10, 2009 5:32:44 PM (4 years ago)

Author:

thomasb

Message:

Added 'message_compose' hook

Location:

trunk/roundcubemail

Files:

• CHANGELOG (modified) (1 diff)
• program/include/main.inc (modified) (3 diffs)
• program/steps/mail/compose.inc (modified) (12 diffs)

trunk/roundcubemail/CHANGELOG

@@ -2 +2 @@
 ===========================
 
+- Added 'message_compose' hook
 - Added 'imap_connect' hook (#1485956)
 - Fix vcard_attachments plugin (#1486035)

trunk/roundcubemail/program/include/main.inc

@@ -546 +546 @@
  */
 function get_input_value($fname, $source, $allow_html=FALSE, $charset=NULL)
-  {
+{
   global $OUTPUT;
   $value = NULL;
@@ -583 +583 @@
   else
     return $value;
-  }
+}
+
+/**
+ * Convert array of request parameters (prefixed with _)
+ * to a regular array with non-prefixed keys.
+ *
+ * @param  int   Source to get value from (GPC)
+ * @return array Hash array with all request parameters
+ */
+function request2param($mode = RCUBE_INPUT_GPC)
+{
+  $out = array();
+  $src = $mode == RCUBE_INPUT_GET ? $_GET : ($mode == RCUBE_INPUT_POST ? $_POST : $_REQUEST);
+  foreach ($src as $key => $value) {
+    $fname = $key[0] == '_' ? substr($key, 1) : $key;
+    $out[$fname] = get_input_value($key, $mode);
+  }
+  
+  return $out;
+}
 
 /**
@@ -959 +978 @@
   $args = func_get_args();
 
-  if (class_exists('rcmail', false))
-    rcmail::get_instance()->plugins->exec_hook('console', $args);
+  if (class_exists('rcmail', false)) {
+    $rcmail = rcmail::get_instance();
+    if (is_object($rcmail->plugins))
+      $rcmail->plugins->exec_hook('console', $args);
+  }
 
   $msg = array();

trunk/roundcubemail/program/steps/mail/compose.inc

@@ -39 +39 @@
   $_SESSION['compose'] = array(
     'id' => uniqid(rand()),
-    'param' => array_map('strip_tags', $_GET),
+    'param' => request2param(RCUBE_INPUT_GET),
     'mailbox' => $IMAP->get_mailbox_name(),
   );
   
   // process values like "mailto:foo@bar.com?subject=new+message&cc=another"
-  if ($_SESSION['compose']['param']['_to']) {
-    $mailto = explode('?', $_SESSION['compose']['param']['_to']);
+  if ($_SESSION['compose']['param']['to']) {
+    $mailto = explode('?', $_SESSION['compose']['param']['to']);
     if (count($mailto) > 1) {
-      $_SESSION['compose']['param']['_to'] = $mailto[0];
+      $_SESSION['compose']['param']['to'] = $mailto[0];
       parse_str($mailto[1], $query);
       foreach ($query as $f => $val)
-        $_SESSION['compose']['param']["_$f"] = $val;
-    }
-  }
+        $_SESSION['compose']['param'][$f] = $val;
+    }
+  }
+  
+  // pipe compose parameters thru plugins
+  $plugin = $RCMAIL->plugins->exec_hook('message_compose', $_SESSION['compose']);
+  $_SESSION['compose']['param'] = $plugin['param'];
 
   // redirect to a unique URL with all parameters stored in session
@@ -72 +76 @@
 
 // get reference message and set compose mode
-if ($msg_uid = $_SESSION['compose']['param']['_reply_uid'])
+if ($msg_uid = $_SESSION['compose']['param']['reply_uid'])
   $compose_mode = RCUBE_COMPOSE_REPLY;
-else if ($msg_uid = $_SESSION['compose']['param']['_forward_uid'])
+else if ($msg_uid = $_SESSION['compose']['param']['forward_uid'])
   $compose_mode = RCUBE_COMPOSE_FORWARD;
-else if ($msg_uid = $_SESSION['compose']['param']['_uid'])
+else if ($msg_uid = $_SESSION['compose']['param']['uid'])
   $compose_mode = RCUBE_COMPOSE_EDIT;
-else if ($msg_uid = $_SESSION['compose']['param']['_draft_uid']) {
+else if ($msg_uid = $_SESSION['compose']['param']['draft_uid']) {
   $RCMAIL->imap->set_mailbox($CONFIG['drafts_mbox']);
   $compose_mode = RCUBE_COMPOSE_DRAFT;
@@ -99 +103 @@
     $_SESSION['compose']['references']  = trim($MESSAGE->headers->references . " " . $MESSAGE->headers->messageID);
 
-    if (!empty($_SESSION['compose']['param']['_all']))
+    if (!empty($_SESSION['compose']['param']['all']))
       $MESSAGE->reply_all = 1;
   }
@@ -139 +143 @@
     case 'to':
       $fname = '_to';
-      $header = 'to';
+      $header = $param = 'to';
       
       // we have a set of recipients stored is session
-      if (($mailto_id = $_SESSION['compose']['param']['_mailto']) && $_SESSION['mailto'][$mailto_id])
+      if (($mailto_id = $_SESSION['compose']['param']['mailto']) && $_SESSION['mailto'][$mailto_id])
         $fvalue = urldecode($_SESSION['mailto'][$mailto_id]);
       
@@ -149 +153 @@
       {
         $fname = '_cc';
-        $header = 'cc';
+        $header = $param = 'cc';
       }
     case 'bcc':
@@ -155 +159 @@
       {
         $fname = '_bcc';
-        $header = 'bcc';
+        $header = $param = 'bcc';
       }
         
@@ -165 +169 @@
     case 'reply-to':
       $fname = '_replyto';
+      $param = 'replyto';
       $allow_attrib = array('id', 'class', 'style', 'size', 'tabindex');
       $field_type = 'html_inputfield';
@@ -170 +175 @@
   }
  
-  if ($fname && !empty($_POST[$fname]))
+  if ($fname && !empty($_POST[$fname])) {
     $fvalue = get_input_value($fname, RCUBE_INPUT_POST, TRUE);
-  else if ($fname && !$fvalue && !empty($_SESSION['compose']['param'][$fname]))
-    $fvalue = $_SESSION['compose']['param'][$fname];
-  else if ($header && $compose_mode == RCUBE_COMPOSE_REPLY)
-  {
+  }
+  else if ($fname && !$fvalue && !empty($_SESSION['compose']['param'][$param])) {
+    $fvalue = $_SESSION['compose']['param'][$param];
+  }
+  else if ($header && $compose_mode == RCUBE_COMPOSE_REPLY) {
     // get recipent address(es) out of the message headers
     if ($header=='to' && !empty($MESSAGE->headers->replyto))
@@ -299 +305 @@
 
       // add signature to array
-      if (!empty($sql_arr['signature']) && empty($_SESSION['compose']['param']['_nosig']))
+      if (!empty($sql_arr['signature']) && empty($_SESSION['compose']['param']['nosig']))
       {
         $a_signatures[$identity_id]['text'] = $sql_arr['signature'];
@@ -369 +375 @@
   {
     $body = get_input_value('_message', RCUBE_INPUT_POST, true);
+  }
+  else if ($_SESSION['compose']['param']['body'])
+  {
+    $body = $_SESSION['compose']['param']['body'];
+    $isHtml = false;
   }
   else if ($compose_mode)
@@ -393 +404 @@
       $body = rcmail_create_draft_body($body, $isHtml);
   }
-  else if (!empty($_SESSION['compose']['param']['_body']))
-  {
-    $body = $_SESSION['compose']['param']['_body'];
+  else if (!empty($_SESSION['compose']['param']['body']))
+  {
+    $body = $_SESSION['compose']['param']['body'];
   }
 
@@ -720 +731 @@
     $subject = $MESSAGE->subject;
   }
-  else if (!empty($_SESSION['compose']['param']['_subject'])) {
-    $subject = $_SESSION['compose']['param']['_subject'];
+  else if (!empty($_SESSION['compose']['param']['subject'])) {
+    $subject = $_SESSION['compose']['param']['subject'];
   }