Happy New Year
[squirrelmail.git] / functions / attachment_common.php
index 0aec18e730225deae40db9136d55f6560d585491..427ee4dab7c4a47504890dc01b17ad134ae98dbd 100644 (file)
@@ -5,13 +5,14 @@
  *
  * This file provides the handling of often-used attachment types.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright 1999-2018 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  * @todo document attachment $type hook arguments
  */
 
+$attachment_common_show_images_list = array();
 
 /**
  * Mapping of file extensions to mime types
@@ -102,16 +103,29 @@ register_attachment_common('application/octet-stream', 'octet_stream');
 
 
 /**
- * Function which optimizes readability of the above code
+ * Function which optimizes readability of the above code, and also
+ * ensures that the attachment_common code is exectuted before any
+ * plugin, so that the latter may override the default processing.
+ *
  * Registers 'attachment $type' hooks.
- * @param string $type attachment type
- * @param string $func suffix of attachment_common_* function, which handles $type attachments.
+ *
+ * @param string $type Attachment type
+ * @param string $func Suffix of attachment_common_* function, which 
+ *                     handles $type attachments.
+ *
  * @since 1.2.0
  */
 function register_attachment_common($type, $func) {
     global $squirrelmail_plugin_hooks;
-    $squirrelmail_plugin_hooks['attachment ' . $type]['attachment_common'] =
-                      'attachment_common_' . $func;
+    $plugin_type = 'attachment ' . $type;
+    $fn = 'attachment_common_' . $func;
+    if (!empty($squirrelmail_plugin_hooks[$plugin_type])) {
+        $plugins = $squirrelmail_plugin_hooks[$plugin_type];
+        $plugins = array_merge(array('attachment_common', $fn), $plugins);
+        $squirrelmail_plugin_hooks[$plugin_type] = $plugins;
+    } else {
+        $squirrelmail_plugin_hooks[$plugin_type]['attachment_common'] = $fn;
+    }
 }
 
 /**
@@ -124,23 +138,23 @@ function attachment_common_link_text(&$Args) {
     /* If there is a text attachment, we would like to create a "View" button
        that links to the text attachment viewer.
 
-       $Args[1] = the array of actions
+       $Args[0] = the array of actions
 
        Use the name of this file for adding an action
-       $Args[1]['attachment_common'] = Array for href and text
+       $Args[0]['attachment_common'] = Array for href and text
 
-       $Args[1]['attachment_common']['text'] = What is displayed
-       $Args[1]['attachment_common']['href'] = Where it links to */
+       $Args[0]['attachment_common']['text'] = What is displayed
+       $Args[0]['attachment_common']['href'] = Where it links to */
     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 
-    // if htmlspecialchars() breaks something - find other way to encode & in url.
-    $Args[1]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. htmlspecialchars($QUERY_STRING);
-    $Args[1]['attachment_common']['href'] =
-          set_url_var($Args[1]['attachment_common']['href'],
-          'ent_id',$Args[5]);
+    // if sm_encode_html_special_chars() breaks something - find other way to encode & in url.
+    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. $QUERY_STRING;
+    $Args[0]['attachment_common']['href'] =
+          set_url_var($Args[0]['attachment_common']['href'],
+          'ent_id',$Args[4]);
 
     /* The link that we created needs a name. */
-    $Args[1]['attachment_common']['text'] = _("View");
+    $Args[0]['attachment_common']['text'] = _("View");
 
     /* Each attachment has a filename on the left, which is a link.
        Where that link points to can be changed.  Just in case the link above
@@ -150,7 +164,7 @@ function attachment_common_link_text(&$Args) {
        This is a lot better in the image links, since the defaultLink will just
        download the image, but the one that we set it to will format the page
        to have an image tag in the center (looking a lot like this text viewer) */
-    $Args[6] = $Args[1]['attachment_common']['href'];
+    $Args[5] = $Args[0]['attachment_common']['href'];
 }
 
 /**
@@ -160,13 +174,13 @@ function attachment_common_link_text(&$Args) {
  */
 function attachment_common_link_message(&$Args) {
     global $base_uri;
-    $Args[1]['attachment_common']['href'] = $base_uri  . 'src/read_body.php?startMessage=' .
-        $Args[2] . '&passed_id=' . $Args[3] . '&mailbox=' . $Args[4] .
-        '&passed_ent_id=' . $Args[5] . '&override_type0=message&override_type1=rfc822';
+    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/read_body.php?startMessage=' .
+        $Args[1] . '&passed_id=' . $Args[2] . '&mailbox=' . $Args[3] .
+        '&passed_ent_id=' . $Args[4] . '&override_type0=message&override_type1=rfc822';
 
-    $Args[1]['attachment_common']['text'] = _("View");
+    $Args[0]['attachment_common']['text'] = _("View");
 
-    $Args[6] = $Args[1]['attachment_common']['href'];
+    $Args[5] = $Args[0]['attachment_common']['href'];
 }
 
 /**
@@ -178,17 +192,17 @@ function attachment_common_link_html(&$Args) {
     global $base_uri;
     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 
-    $Args[1]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. htmlspecialchars($QUERY_STRING).
+    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. $QUERY_STRING.
         /* why use the overridetype? can this be removed */
         /* override_type might be needed only when we want view other type of messages as html */
        '&override_type0=text&override_type1=html';
-    $Args[1]['attachment_common']['href'] =
-          set_url_var($Args[1]['attachment_common']['href'],
-          'ent_id',$Args[5]);
+    $Args[0]['attachment_common']['href'] =
+          set_url_var($Args[0]['attachment_common']['href'],
+          'ent_id',$Args[4]);
 
-    $Args[1]['attachment_common']['text'] = _("View");
+    $Args[0]['attachment_common']['text'] = _("View");
 
-    $Args[6] = $Args[1]['attachment_common']['href'];
+    $Args[5] = $Args[0]['attachment_common']['href'];
 }
 
 /**
@@ -201,20 +215,22 @@ function attachment_common_link_image(&$Args) {
 
     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 
-    $info['passed_id'] = $Args[3];
-    $info['mailbox'] = $Args[4];
-    $info['ent_id'] = $Args[5];
-
+    $info['passed_id'] = $Args[2];
+    $info['mailbox'] = $Args[3];
+    $info['ent_id'] = $Args[4];
+    $info['name'] = $Args[6];
+    $info['download_href'] = isset($Args[0]['download link']) ? $Args[0]['download link']['href'] : '';
+    
     $attachment_common_show_images_list[] = $info;
 
-    $Args[1]['attachment_common']['href'] = $base_uri  . 'src/image.php?'. htmlspecialchars($QUERY_STRING);
-    $Args[1]['attachment_common']['href'] =
-          set_url_var($Args[1]['attachment_common']['href'],
-          'ent_id',$Args[5]);
+    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/image.php?'. $QUERY_STRING;
+    $Args[0]['attachment_common']['href'] =
+          set_url_var($Args[0]['attachment_common']['href'],
+          'ent_id',$Args[4]);
 
-    $Args[1]['attachment_common']['text'] = _("View");
+    $Args[0]['attachment_common']['text'] = _("View");
 
-    $Args[6] = $Args[1]['attachment_common']['href'];
+    $Args[5] = $Args[0]['attachment_common']['href'];
 }
 
 /**
@@ -226,14 +242,14 @@ function attachment_common_link_vcard(&$Args) {
     global $base_uri;
     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 
-    $Args[1]['attachment_common']['href'] = $base_uri  . 'src/vcard.php?'. htmlspecialchars($QUERY_STRING);
-    $Args[1]['attachment_common']['href'] =
-          set_url_var($Args[1]['attachment_common']['href'],
-          'ent_id',$Args[5]);
+    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/vcard.php?'. $QUERY_STRING;
+    $Args[0]['attachment_common']['href'] =
+          set_url_var($Args[0]['attachment_common']['href'],
+          'ent_id',$Args[4]);
 
-    $Args[1]['attachment_common']['text'] = _("View Business Card");
+    $Args[0]['attachment_common']['text'] = _("View Business Card");
 
-    $Args[6] = $Args[1]['attachment_common']['href'];
+    $Args[5] = $Args[0]['attachment_common']['href'];
 }
 
 /**
@@ -243,24 +259,25 @@ function attachment_common_link_vcard(&$Args) {
  * @since 1.2.0
  */
 function attachment_common_octet_stream(&$Args) {
-    global $FileExtensionToMimeType;
+    global $FileExtensionToMimeType, $null;
 
-    do_hook('attachment_common-load_mime_types');
+//FIXME: I propose removing this hook; I don't like having two hooks close together, but moreover, this hook appears to merely give plugins the chance to add to the global $FileExtensionToMimeType variable, which they can do in any hook before now - I'd recommend prefs_backend (which is what config_override used to be) because it's the one hook run at the beginning of almost all page requests in init.php -- the con is that we don't need it run on ALL page requests, do we?  There may be another hook in THIS page request that we can recommend, in which case, we *really should* remove this hook here.
+//FIXME: or at least we can move this hook up to the top of this file where $FileExtensionToMimeType is defined.  What else is this hook here for?  What plugins use it?
+    do_hook('attachment_common-load_mime_types', $null);
 
-    ereg('\\.([^\\.]+)$', $Args[7], $Regs);
+    preg_match('/\.([^.]+)$/', $Args[7], $Regs);
 
-    $Ext = strtolower($Regs[1]);
+    $Ext = '';
+    if (is_array($Regs) && isset($Regs[1])) {
+        $Ext = $Regs[1];
+        $Ext = strtolower($Regs[1]);
+    }
 
     if ($Ext == '' || ! isset($FileExtensionToMimeType[$Ext]))
         return;
 
-    $Ret = do_hook('attachment ' . $FileExtensionToMimeType[$Ext],
-        $Args[1], $Args[2], $Args[3], $Args[4], $Args[5], $Args[6],
-        $Args[7], $Args[8], $Args[9]);
+    $temp = array(&$Args[0], &$Args[1], &$Args[2], &$Args[3], &$Args[4], &$Args[5],
+                  &$Args[6], &$Args[7], &$Args[8]);
+    do_hook('attachment ' . $FileExtensionToMimeType[$Ext], $temp);
 
-    foreach ($Ret as $a => $b) {
-        $Args[$a] = $b;
-    }
 }
-
-?>
\ No newline at end of file