Happy New Year
[squirrelmail.git] / functions / attachment_common.php
index 379572ad1b5434241fa65668c4041c3aa27bfcb5..dd3ba71857b7e2a86edc05d729272cda41d84926 100644 (file)
@@ -5,7 +5,7 @@
  *
  * This file provides the handling of often-used attachment types.
  *
- * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @copyright 1999-2020 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -103,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;
+    }
 }
 
 /**
@@ -134,8 +147,8 @@ function attachment_common_link_text(&$Args) {
        $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[0]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. htmlspecialchars($QUERY_STRING);
+    // 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]);
@@ -151,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[5] = $Args[1]['attachment_common']['href'];
+    $Args[5] = $Args[0]['attachment_common']['href'];
 }
 
 /**
@@ -179,7 +192,7 @@ function attachment_common_link_html(&$Args) {
     global $base_uri;
     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 
-    $Args[0]['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';
@@ -210,7 +223,7 @@ function attachment_common_link_image(&$Args) {
     
     $attachment_common_show_images_list[] = $info;
 
-    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/image.php?'. htmlspecialchars($QUERY_STRING);
+    $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]);
@@ -229,7 +242,7 @@ function attachment_common_link_vcard(&$Args) {
     global $base_uri;
     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 
-    $Args[0]['attachment_common']['href'] = $base_uri  . 'src/vcard.php?'. htmlspecialchars($QUERY_STRING);
+    $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]);
@@ -248,17 +261,23 @@ function attachment_common_link_vcard(&$Args) {
 function attachment_common_octet_stream(&$Args) {
     global $FileExtensionToMimeType, $null;
 
+//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[6], $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;
 
-    do_hook('attachment ' . $FileExtensionToMimeType[$Ext],
-        $temp=array(&$Args[0], &$Args[1], &$Args[2], &$Args[3], &$Args[4], &$Args[5],
-        &$Args[6], &$Args[7], &$Args[8]));
+    $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);
 
 }