functions/attachment_common.php

   1 <?php
   2
   3 /**
   4  * attachment_common.php
   5  *
   6  * Copyright (c) 1999-2005 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This file provides the handling of often-used attachment types.
  10  *
  11  * @version $Id$
  12  * @package squirrelmail
  13  */
  14
  15 /**
  16  * FIXME Needs phpDocumentator style documentation
  17  */
  18 require_once(SM_PATH . 'functions/global.php');
  19
  20 global $attachment_common_show_images_list;
  21 $attachment_common_show_images_list = array();
  22
  23 global $FileExtensionToMimeType, $attachment_common_types;
  24 $FileExtensionToMimeType = array('bmp'  => 'image/x-bitmap',
  25                                  'gif'  => 'image/gif',
  26                                  'htm'  => 'text/html',
  27                                  'html' => 'text/html',
  28                                  'jpg'  => 'image/jpeg',
  29                                  'jpeg' => 'image/jpeg',
  30                                  'php'  => 'text/plain',
  31                                  'png'  => 'image/png',
  32                                  'rtf'  => 'text/richtext',
  33                                  'txt'  => 'text/plain',
  34                                  'patch'=> 'text/plain',
  35                                  'vcf'  => 'text/x-vcard');
  36
  37 /* Register browser-supported image types */
  38 sqgetGlobalVar('attachment_common_types', $attachment_common_types);
  39 if (isset($attachment_common_types)) {
  40     /* Don't run this before being logged in. That may happen
  41        when plugins include mime.php */
  42     foreach ($attachment_common_types as $val => $v) {
  43         if ($val == 'image/gif')
  44             register_attachment_common('image/gif',       'link_image');
  45         elseif (($val == 'image/jpeg' || $val == 'image/pjpeg') and
  46                 (!isset($jpeg_done))) {
  47             $jpeg_done = 1;
  48             register_attachment_common('image/jpeg',      'link_image');
  49             register_attachment_common('image/pjpeg',     'link_image');
  50         }
  51         elseif ($val == 'image/png')
  52             register_attachment_common('image/png',       'link_image');
  53         elseif ($val == 'image/x-xbitmap')
  54             register_attachment_common('image/x-xbitmap', 'link_image');
  55     }
  56     unset($jpeg_done);
  57 }
  58
  59 /* Register text-type attachments */
  60 register_attachment_common('message/rfc822', 'link_message');
  61 register_attachment_common('text/plain',     'link_text');
  62 register_attachment_common('text/richtext',  'link_text');
  63
  64 /* Register HTML */
  65 register_attachment_common('text/html',      'link_html');
  66
  67
  68 /* Register vcards */
  69 register_attachment_common('text/x-vcard',   'link_vcard');
  70 register_attachment_common('text/directory', 'link_vcard');
  71
  72 /* Register rules for general types.
  73  * These will be used if there isn't a more specific rule available. */
  74 register_attachment_common('text/*',  'link_text');
  75 register_attachment_common('message/*',  'link_text');
  76
  77 /* Register "unknown" attachments */
  78 register_attachment_common('application/octet-stream', 'octet_stream');
  79
  80
  81 /* Function which optimizes readability of the above code */
  82
  83 function register_attachment_common($type, $func) {
  84     global $squirrelmail_plugin_hooks;
  85     $squirrelmail_plugin_hooks['attachment ' . $type]['attachment_common'] =
  86                       'attachment_common_' . $func;
  87 }
  88
  89
  90 function attachment_common_link_text(&$Args) {
  91     /* If there is a text attachment, we would like to create a "View" button
  92        that links to the text attachment viewer.
  93
  94        $Args[1] = the array of actions
  95
  96        Use the name of this file for adding an action
  97        $Args[1]['attachment_common'] = Array for href and text
  98
  99        $Args[1]['attachment_common']['text'] = What is displayed
 100        $Args[1]['attachment_common']['href'] = Where it links to */
 101     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 102
 103     $Args[1]['attachment_common']['href'] = SM_PATH . 'src/view_text.php?'. $QUERY_STRING;
 104     $Args[1]['attachment_common']['href'] =
 105           set_url_var($Args[1]['attachment_common']['href'],
 106           'ent_id',$Args[5]);
 107
 108     /* The link that we created needs a name. */
 109     $Args[1]['attachment_common']['text'] = _("View");
 110
 111     /* Each attachment has a filename on the left, which is a link.
 112        Where that link points to can be changed.  Just in case the link above
 113        for viewing text attachments is not the same as the default link for
 114        this file, we'll change it.
 115
 116        This is a lot better in the image links, since the defaultLink will just
 117        download the image, but the one that we set it to will format the page
 118        to have an image tag in the center (looking a lot like this text viewer) */
 119     $Args[6] = $Args[1]['attachment_common']['href'];
 120 }
 121
 122 function attachment_common_link_message(&$Args) {
 123     $Args[1]['attachment_common']['href'] = SM_PATH . 'src/read_body.php?startMessage=' .
 124         $Args[2] . '&amp;passed_id=' . $Args[3] . '&amp;mailbox=' . $Args[4] .
 125         '&amp;passed_ent_id=' . $Args[5] . '&amp;override_type0=message&amp;override_type1=rfc822';
 126
 127     $Args[1]['attachment_common']['text'] = _("View");
 128
 129     $Args[6] = $Args[1]['attachment_common']['href'];
 130 }
 131
 132
 133 function attachment_common_link_html(&$Args) {
 134     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 135
 136     $Args[1]['attachment_common']['href'] = SM_PATH . 'src/view_text.php?'. $QUERY_STRING.
 137        /* why use the overridetype? can this be removed */
 138        '&amp;override_type0=text&amp;override_type1=html';
 139     $Args[1]['attachment_common']['href'] =
 140           set_url_var($Args[1]['attachment_common']['href'],
 141           'ent_id',$Args[5]);
 142
 143     $Args[1]['attachment_common']['text'] = _("View");
 144
 145     $Args[6] = $Args[1]['attachment_common']['href'];
 146 }
 147
 148 function attachment_common_link_image(&$Args) {
 149     global $attachment_common_show_images_list;
 150
 151     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 152
 153     $info['passed_id'] = $Args[3];
 154     $info['mailbox'] = $Args[4];
 155     $info['ent_id'] = $Args[5];
 156
 157     $attachment_common_show_images_list[] = $info;
 158
 159     $Args[1]['attachment_common']['href'] = SM_PATH . 'src/image.php?'. $QUERY_STRING;
 160     $Args[1]['attachment_common']['href'] =
 161           set_url_var($Args[1]['attachment_common']['href'],
 162           'ent_id',$Args[5]);
 163
 164     $Args[1]['attachment_common']['text'] = _("View");
 165
 166     $Args[6] = $Args[1]['attachment_common']['href'];
 167 }
 168
 169
 170 function attachment_common_link_vcard(&$Args) {
 171     sqgetGlobalVar('QUERY_STRING', $QUERY_STRING, SQ_SERVER);
 172
 173     $Args[1]['attachment_common']['href'] = SM_PATH . 'src/vcard.php?'. $QUERY_STRING;
 174     $Args[1]['attachment_common']['href'] =
 175           set_url_var($Args[1]['attachment_common']['href'],
 176           'ent_id',$Args[5]);
 177
 178     $Args[1]['attachment_common']['text'] = _("View Business Card");
 179
 180     $Args[6] = $Args[1]['attachment_common']['href'];
 181 }
 182
 183
 184 function attachment_common_octet_stream(&$Args) {
 185     global $FileExtensionToMimeType;
 186
 187     do_hook('attachment_common-load_mime_types');
 188
 189     ereg('\\.([^\\.]+)$', $Args[7], $Regs);
 190
 191     $Ext = strtolower($Regs[1]);
 192
 193     if ($Ext == '' || ! isset($FileExtensionToMimeType[$Ext]))
 194         return;
 195
 196     $Ret = do_hook('attachment ' . $FileExtensionToMimeType[$Ext],
 197         $Args[1], $Args[2], $Args[3], $Args[4], $Args[5], $Args[6],
 198         $Args[7], $Args[8], $Args[9]);
 199
 200     foreach ($Ret as $a => $b) {
 201         $Args[$a] = $b;
 202     }
 203 }
 204
 205 ?>