functions/attachment_common.php

   1 <?php
   2
   3 /**
   4  * attachment_common.php
   5  *
   6  * This file provides the handling of often-used attachment types.
   7  *
   8  * @copyright 1999-2020 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package squirrelmail
  12  * @todo document attachment $type hook arguments
  13  */
  14
  15 $attachment_common_show_images_list = array();
  16
  17 /**
  18  * Mapping of file extensions to mime types
  19  *
  20  * Used for application/octet-stream mime type detection.
  21  * Supported extensions: bmp, gif, htm, html, jpg, jpeg, php,
  22  * png, rtf, txt, patch (since 1.4.2), vcf
  23  * @global array $FileExtensionToMimeType
  24  */
  25 $FileExtensionToMimeType = array('bmp'  => 'image/x-bitmap',
  26                                  'gif'  => 'image/gif',
  27                                  'htm'  => 'text/html',
  28                                  'html' => 'text/html',
  29                                  'jpe'  => 'image/jpeg',
  30                                  'jpg'  => 'image/jpeg',
  31                                  'jpeg' => 'image/jpeg',
  32                                  'php'  => 'text/plain',
  33                                  'png'  => 'image/png',
  34                                  'rtf'  => 'text/richtext',
  35                                  'txt'  => 'text/plain',
  36                                  'patch'=> 'text/plain',
  37                                  'vcf'  => 'text/x-vcard');
  38
  39 /* Register browser-supported image types */
  40 sqgetGlobalVar('attachment_common_types', $attachment_common_types);
  41 // FIXME: do we use $attachment_common_types that is not extracted by sqgetGlobalVar() ?
  42 if (isset($attachment_common_types)) {
  43     // var is used to detect activation of jpeg image types
  44     unset($jpeg_done);
  45     /* Don't run this before being logged in. That may happen
  46        when plugins include mime.php */
  47     foreach ($attachment_common_types as $val => $v) {
  48         if ($val == 'image/gif')
  49             register_attachment_common('image/gif',       'link_image');
  50         elseif (($val == 'image/jpeg' || $val == 'image/pjpeg' || $val == 'image/jpg') and
  51                 (!isset($jpeg_done))) {
  52             $jpeg_done = 1;
  53             register_attachment_common('image/jpg',       'link_image');
  54             register_attachment_common('image/jpeg',      'link_image');
  55             register_attachment_common('image/pjpeg',     'link_image');
  56         }
  57         elseif ($val == 'image/png')
  58             register_attachment_common('image/png',       'link_image');
  59         elseif ($val == 'image/x-xbitmap')
  60             register_attachment_common('image/x-xbitmap', 'link_image');
  61         elseif ($val == '*/*' || $val == 'image/*') {
  62             /**
  63              * browser (Firefox) declared that anything is acceptable.
  64              * Lets register some common image types.
  65              */
  66             if (! isset($jpeg_done)) {
  67                 $jpeg_done = 1;
  68                 register_attachment_common('image/jpg',   'link_image');
  69                 register_attachment_common('image/jpeg',  'link_image');
  70                 register_attachment_common('image/pjpeg', 'link_image');
  71             }
  72             register_attachment_common('image/gif',       'link_image');
  73             register_attachment_common('image/png',       'link_image');
  74             register_attachment_common('image/x-xbitmap', 'link_image');
  75             // register_attachment_common('image/x-ico',     'link_image');
  76             // register_attachment_common('image/x-icon',    'link_image');
  77             // register_attachment_common('image/bmp',       'link_image');
  78             // register_attachment_common('image/x-ms-bmp',  'link_image');
  79         }
  80     }
  81     unset($jpeg_done);
  82 }
  83
  84 /* Register text-type attachments */
  85 register_attachment_common('message/rfc822', 'link_message');
  86 register_attachment_common('text/plain',     'link_text');
  87 register_attachment_common('text/richtext',  'link_text');
  88
  89 /* Register HTML */
  90 register_attachment_common('text/html',      'link_html');
  91
  92 /* Register vcards */
  93 register_attachment_common('text/x-vcard',   'link_vcard');
  94 register_attachment_common('text/directory', 'link_vcard');
  95
  96 /* Register ics (calendar) */
  97 register_attachment_common('application/ics',  'link_text');
  98
  99 /* Register rules for general types.
 100  * These will be used if there isn't a more specific rule available. */
 101 register_attachment_common('text/*',  'link_text');
 102 register_attachment_common('message/*',  'link_text');
 103
 104 /* Register "unknown" attachments */
 105 register_attachment_common('application/octet-stream', 'octet_stream');
 106
 107
 108 /**
 109  * Function which optimizes readability of the above code, and also
 110  * ensures that the attachment_common code is exectuted before any
 111  * plugin, so that the latter may override the default processing.
 112  *
 113  * Registers 'attachment $type' hooks.
 114  *
 115  * @param string $type Attachment type
 116  * @param string $func Suffix of attachment_common_* function, which
 117  *                     handles $type attachments.
 118  *
 119  * @since 1.2.0
 120  */
 121 function register_attachment_common($type, $func) {
 122     global $squirrelmail_plugin_hooks;
 123     $plugin_type = 'attachment ' . $type;
 124     $fn = 'attachment_common_' . $func;
 125     if (!empty($squirrelmail_plugin_hooks[$plugin_type])) {
 126         $plugins = $squirrelmail_plugin_hooks[$plugin_type];
 127         $plugins = array_merge(array('attachment_common', $fn), $plugins);
 128         $squirrelmail_plugin_hooks[$plugin_type] = $plugins;
 129     } else {
 130         $squirrelmail_plugin_hooks[$plugin_type]['attachment_common'] = $fn;
 131     }
 132 }
 133
 134 /**
 135  * Adds href and text keys to attachment_common array for text attachments
 136  * @param array $Args attachment $type hook arguments
 137  * @since 1.2.0
 138  */
 139 function attachment_common_link_text(&$Args) {
 140     global $base_uri;
 141     /* If there is a text attachment, we would like to create a "View" button
 142        that links to the text attachment viewer.
 143
 144        $Args[0] = the array of actions
 145
 146        Use the name of this file for adding an action
 147        $Args[0]['attachment_common'] = Array for href and text
 148
 149        $Args[0]['attachment_common']['text'] = What is displayed
 150        $Args[0]['attachment_common']['href'] = Where it links to */
 151     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 152
 153     // if sm_encode_html_special_chars() breaks something - find other way to encode & in url.
 154     $Args[0]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. $QUERY_STRING;
 155     $Args[0]['attachment_common']['href'] =
 156           set_url_var($Args[0]['attachment_common']['href'],
 157           'ent_id',$Args[4]);
 158
 159     /* The link that we created needs a name. */
 160     $Args[0]['attachment_common']['text'] = _("View");
 161
 162     /* Each attachment has a filename on the left, which is a link.
 163        Where that link points to can be changed.  Just in case the link above
 164        for viewing text attachments is not the same as the default link for
 165        this file, we'll change it.
 166
 167        This is a lot better in the image links, since the defaultLink will just
 168        download the image, but the one that we set it to will format the page
 169        to have an image tag in the center (looking a lot like this text viewer) */
 170     $Args[5] = $Args[0]['attachment_common']['href'];
 171 }
 172
 173 /**
 174  * Adds href and text keys to attachment_common array for rfc822 attachments
 175  * @param array $Args attachment $type hook arguments
 176  * @since 1.2.6
 177  */
 178 function attachment_common_link_message(&$Args) {
 179     global $base_uri;
 180     $Args[0]['attachment_common']['href'] = $base_uri  . 'src/read_body.php?startMessage=' .
 181         $Args[1] . '&amp;passed_id=' . $Args[2] . '&amp;mailbox=' . $Args[3] .
 182         '&amp;passed_ent_id=' . $Args[4] . '&amp;override_type0=message&amp;override_type1=rfc822';
 183
 184     $Args[0]['attachment_common']['text'] = _("View");
 185
 186     $Args[5] = $Args[0]['attachment_common']['href'];
 187 }
 188
 189 /**
 190  * Adds href and text keys to attachment_common array for html attachments
 191  * @param array $Args attachment $type hook arguments
 192  * @since 1.2.0
 193  */
 194 function attachment_common_link_html(&$Args) {
 195     global $base_uri;
 196     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 197
 198     $Args[0]['attachment_common']['href'] = $base_uri  . 'src/view_text.php?'. $QUERY_STRING.
 199         /* why use the overridetype? can this be removed */
 200         /* override_type might be needed only when we want view other type of messages as html */
 201        '&amp;override_type0=text&amp;override_type1=html';
 202     $Args[0]['attachment_common']['href'] =
 203           set_url_var($Args[0]['attachment_common']['href'],
 204           'ent_id',$Args[4]);
 205
 206     $Args[0]['attachment_common']['text'] = _("View");
 207
 208     $Args[5] = $Args[0]['attachment_common']['href'];
 209 }
 210
 211 /**
 212  * Adds href and text keys to attachment_common array for image attachments
 213  * @param array $Args attachment $type hook arguments
 214  * @since 1.2.0
 215  */
 216 function attachment_common_link_image(&$Args) {
 217     global $attachment_common_show_images_list, $base_uri ;
 218
 219     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 220
 221     $info['passed_id'] = $Args[2];
 222     $info['mailbox'] = $Args[3];
 223     $info['ent_id'] = $Args[4];
 224     $info['name'] = $Args[6];
 225     $info['download_href'] = isset($Args[0]['download link']) ? $Args[0]['download link']['href'] : '';
 226
 227     $attachment_common_show_images_list[] = $info;
 228
 229     $Args[0]['attachment_common']['href'] = $base_uri  . 'src/image.php?'. $QUERY_STRING;
 230     $Args[0]['attachment_common']['href'] =
 231           set_url_var($Args[0]['attachment_common']['href'],
 232           'ent_id',$Args[4]);
 233
 234     $Args[0]['attachment_common']['text'] = _("View");
 235
 236     $Args[5] = $Args[0]['attachment_common']['href'];
 237 }
 238
 239 /**
 240  * Adds href and text keys to attachment_common array for vcard attachments
 241  * @param array $Args attachment $type hook arguments
 242  * @since 1.2.0
 243  */
 244 function attachment_common_link_vcard(&$Args) {
 245     global $base_uri;
 246     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 247
 248     $Args[0]['attachment_common']['href'] = $base_uri  . 'src/vcard.php?'. $QUERY_STRING;
 249     $Args[0]['attachment_common']['href'] =
 250           set_url_var($Args[0]['attachment_common']['href'],
 251           'ent_id',$Args[4]);
 252
 253     $Args[0]['attachment_common']['text'] = _("View Business Card");
 254
 255     $Args[5] = $Args[0]['attachment_common']['href'];
 256 }
 257
 258 /**
 259  * Processes octet-stream attachments.
 260  * Calls attachment_common-load_mime_types and attachment $type hooks.
 261  * @param array $Args attachment $type hook arguments
 262  * @since 1.2.0
 263  */
 264 function attachment_common_octet_stream(&$Args) {
 265     global $FileExtensionToMimeType, $null;
 266
 267 //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.
 268 //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?
 269     do_hook('attachment_common-load_mime_types', $null);
 270
 271     preg_match('/\.([^.]+)$/', $Args[6], $Regs);
 272
 273     $Ext = '';
 274     if (is_array($Regs) && isset($Regs[1])) {
 275         $Ext = strtolower($Regs[1]);
 276     }
 277
 278     if ($Ext == '' || ! isset($FileExtensionToMimeType[$Ext]))
 279         return;
 280
 281     $temp = array(&$Args[0], &$Args[1], &$Args[2], &$Args[3], &$Args[4], &$Args[5],
 282                   &$Args[6], &$Args[7], &$Args[8]);
 283     do_hook('attachment ' . $FileExtensionToMimeType[$Ext], $temp);
 284
 285 }