source: subversion/trunk/roundcubemail/program/steps/mail/func.inc @ 4733

Last change on this file since 4733 was 4733, checked in by alec, 2 years ago
  • Fix problems with subfolders of INBOX folder on some IMAP servers (#1487725)
  • Fix handling of folders that doesn't belong to any namespace (#1487637)
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 56.2 KB
Line 
1<?php
2
3/*
4 +-----------------------------------------------------------------------+
5 | program/steps/mail/func.inc                                           |
6 |                                                                       |
7 | This file is part of the Roundcube Webmail client                     |
8 | Copyright (C) 2005-2010, The Roundcube Dev Team                       |
9 | Licensed under the GNU GPL                                            |
10 |                                                                       |
11 | PURPOSE:                                                              |
12 |   Provide webmail functionality and GUI objects                       |
13 |                                                                       |
14 +-----------------------------------------------------------------------+
15 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
16 +-----------------------------------------------------------------------+
17
18 $Id$
19
20*/
21
22// setup some global vars used by mail steps
23$SENT_MBOX = $RCMAIL->config->get('sent_mbox');
24$DRAFTS_MBOX = $RCMAIL->config->get('drafts_mbox');
25$SEARCH_MODS_DEFAULT = array(
26    '*'         => array('subject'=>1, 'from'=>1),
27    $SENT_MBOX  => array('subject'=>1, 'to'=>1),
28    $DRAFTS_MBOX => array('subject'=>1, 'to'=>1)
29);
30
31// actions that do not require imap connection here
32$NOIMAP_ACTIONS = array('addcontact', 'autocomplete', 'upload', 'display-attachment', 'remove-attachment', 'get');
33
34// always instantiate imap object (but not yet connect to server)
35$RCMAIL->imap_init();
36
37// log in to imap server
38if (!in_array($RCMAIL->action, $NOIMAP_ACTIONS) && !$RCMAIL->imap_connect()) {
39  $RCMAIL->kill_session();
40
41  if ($OUTPUT->ajax_call)
42    $OUTPUT->redirect(array(), 2000);
43
44  $OUTPUT->set_env('task', 'login');
45  $OUTPUT->send('login');
46}
47
48// set imap properties and session vars
49if (strlen(trim($mbox = get_input_value('_mbox', RCUBE_INPUT_GPC, true))))
50  $IMAP->set_mailbox(($_SESSION['mbox'] = $mbox));
51else if ($IMAP)
52  $_SESSION['mbox'] = $IMAP->get_mailbox_name();
53
54if (!empty($_GET['_page']))
55  $IMAP->set_page(($_SESSION['page'] = intval($_GET['_page'])));
56
57// set default sort col/order to session
58if (!isset($_SESSION['sort_col']))
59  $_SESSION['sort_col'] = !empty($CONFIG['message_sort_col']) ? $CONFIG['message_sort_col'] : '';
60if (!isset($_SESSION['sort_order']))
61  $_SESSION['sort_order'] = strtoupper($CONFIG['message_sort_order']) == 'ASC' ? 'ASC' : 'DESC';
62
63// set threads mode
64$a_threading = $RCMAIL->config->get('message_threading', array());
65if (isset($_GET['_threads'])) {
66  if ($_GET['_threads'])
67    $a_threading[$_SESSION['mbox']] = true;
68  else
69    unset($a_threading[$_SESSION['mbox']]);
70  $RCMAIL->user->save_prefs(array('message_threading' => $a_threading));
71}
72$IMAP->set_threading($a_threading[$_SESSION['mbox']]);
73
74// set message set for search result
75if (!empty($_REQUEST['_search']) && isset($_SESSION['search'])
76    && $_SESSION['search_request'] == $_REQUEST['_search']
77) {
78  $IMAP->set_search_set($_SESSION['search']);
79  $OUTPUT->set_env('search_request', $_REQUEST['_search']);
80  $OUTPUT->set_env('search_text', $_SESSION['last_text_search']);
81}
82
83// set main env variables, labels and page title
84if (empty($RCMAIL->action) || $RCMAIL->action == 'list') {
85  $mbox_name = $IMAP->get_mailbox_name();
86
87  if (empty($RCMAIL->action)) {
88    // initialize searching result if search_filter is used
89    if ($_SESSION['search_filter'] && $_SESSION['search_filter'] != 'ALL') {
90      $search_request = md5($mbox_name.$_SESSION['search_filter']);
91
92      $IMAP->search($mbox_name, $_SESSION['search_filter'], RCMAIL_CHARSET, $_SESSION['sort_col']);
93      $_SESSION['search'] = $IMAP->get_search_set();
94      $_SESSION['search_request'] = $search_request;
95      $OUTPUT->set_env('search_request', $search_request);
96      }
97
98      $search_mods = $RCMAIL->config->get('search_mods', $SEARCH_MODS_DEFAULT);
99      $OUTPUT->set_env('search_mods', $search_mods);
100  }
101
102  // set current mailbox and some other vars in client environment
103  $OUTPUT->set_env('mailbox', $mbox_name);
104  $OUTPUT->set_env('pagesize', $IMAP->page_size);
105  $OUTPUT->set_env('quota', $IMAP->get_capability('QUOTA'));
106  $OUTPUT->set_env('delimiter', $IMAP->get_hierarchy_delimiter());
107  $OUTPUT->set_env('threading', (bool) $IMAP->threading);
108  $OUTPUT->set_env('threads', $IMAP->threading || $IMAP->get_capability('THREAD'));
109
110  if ($CONFIG['flag_for_deletion'])
111    $OUTPUT->set_env('flag_for_deletion', true);
112  if ($CONFIG['read_when_deleted'])
113    $OUTPUT->set_env('read_when_deleted', true);
114  if ($CONFIG['skip_deleted'])
115    $OUTPUT->set_env('skip_deleted', true);
116  if ($CONFIG['display_next'])
117    $OUTPUT->set_env('display_next', true);
118
119  $OUTPUT->set_env('preview_pane_mark_read', $RCMAIL->config->get('preview_pane_mark_read', 0));
120
121  if ($CONFIG['trash_mbox'])
122    $OUTPUT->set_env('trash_mailbox', $CONFIG['trash_mbox']);
123  if ($CONFIG['drafts_mbox'])
124    $OUTPUT->set_env('drafts_mailbox', $CONFIG['drafts_mbox']);
125  if ($CONFIG['junk_mbox'])
126    $OUTPUT->set_env('junk_mailbox', $CONFIG['junk_mbox']);
127
128  if (!$OUTPUT->ajax_call)
129    $OUTPUT->add_label('checkingmail', 'deletemessage', 'movemessagetotrash',
130      'movingmessage', 'copyingmessage', 'deletingmessage', 'markingmessage',
131      'copy', 'move', 'quota');
132
133  $OUTPUT->set_pagetitle(rcmail_localize_foldername($IMAP->mod_mailbox($mbox_name)));
134}
135
136
137/**
138 * return the message list as HTML table
139 */
140function rcmail_message_list($attrib)
141{
142  global $IMAP, $CONFIG, $OUTPUT;
143
144  // add some labels to client
145  $OUTPUT->add_label('from', 'to');
146
147  // add id to message list table if not specified
148  if (!strlen($attrib['id']))
149    $attrib['id'] = 'rcubemessagelist';
150
151  // define list of cols to be displayed based on parameter or config
152  if (empty($attrib['columns'])) {
153    $a_show_cols = is_array($CONFIG['list_cols']) ? $CONFIG['list_cols'] : array('subject');
154    $OUTPUT->set_env('col_movable', !in_array('list_cols', (array)$CONFIG['dont_override']));
155  }
156  else {
157    $a_show_cols = preg_split('/[\s,;]+/', strip_quotes($attrib['columns']));
158    $attrib['columns'] = $a_show_cols;
159  }
160
161  // save some variables for use in ajax list
162  $_SESSION['list_attrib'] = $attrib;
163
164  $mbox = $IMAP->get_mailbox_name();
165  $delim = $IMAP->get_hierarchy_delimiter();
166
167  // show 'to' instead of 'from' in sent/draft messages
168  if ((strpos($mbox.$delim, $CONFIG['sent_mbox'].$delim)===0 || strpos($mbox.$delim, $CONFIG['drafts_mbox'].$delim)===0)
169      && (($f = array_search('from', $a_show_cols)) !== false) && array_search('to', $a_show_cols) === false)
170    $a_show_cols[$f] = 'to';
171
172  // make sure 'threads' and 'subject' columns are present
173  if (!in_array('subject', $a_show_cols))
174    array_unshift($a_show_cols, 'subject');
175  if (!in_array('threads', $a_show_cols))
176    array_unshift($a_show_cols, 'threads');
177
178  $skin_path = $_SESSION['skin_path'] = $CONFIG['skin_path'];
179
180  // set client env
181  $OUTPUT->add_gui_object('messagelist', $attrib['id']);
182  $OUTPUT->set_env('autoexpand_threads', intval($CONFIG['autoexpand_threads']));
183  $OUTPUT->set_env('sort_col', $_SESSION['sort_col']);
184  $OUTPUT->set_env('sort_order', $_SESSION['sort_order']);
185  $OUTPUT->set_env('messages', array());
186  $OUTPUT->set_env('coltypes', $a_show_cols);
187
188  $OUTPUT->include_script('list.js');
189
190  $thead = '';
191  foreach (rcmail_message_list_head($attrib, $a_show_cols) as $cell)
192    $thead .= html::tag('td', array('class' => $cell['className'], 'id' => $cell['id']), $cell['html']);
193
194  return html::tag('table',
195    $attrib,
196    html::tag('thead', null, html::tag('tr', null, $thead)) .
197      html::tag('tbody', null, ''),
198        array('style', 'class', 'id', 'cellpadding', 'cellspacing', 'border', 'summary'));
199}
200
201
202/**
203 * return javascript commands to add rows to the message list
204 */
205function rcmail_js_message_list($a_headers, $insert_top=FALSE, $a_show_cols=null)
206{
207  global $CONFIG, $IMAP, $RCMAIL, $OUTPUT;
208
209  if (empty($a_show_cols)) {
210    if (!empty($_SESSION['list_attrib']['columns']))
211      $a_show_cols = $_SESSION['list_attrib']['columns'];
212    else
213      $a_show_cols = is_array($CONFIG['list_cols']) ? $CONFIG['list_cols'] : array('subject');
214  }
215  else {
216    if (!is_array($a_show_cols))
217      $a_show_cols = preg_split('/[\s,;]+/', strip_quotes($a_show_cols));
218    $head_replace = true;
219  }
220
221  $mbox = $IMAP->get_mailbox_name();
222  $delim = $IMAP->get_hierarchy_delimiter();
223
224  // make sure 'threads' and 'subject' columns are present
225  if (!in_array('subject', $a_show_cols))
226    array_unshift($a_show_cols, 'subject');
227  if (!in_array('threads', $a_show_cols))
228    array_unshift($a_show_cols, 'threads');
229
230  $_SESSION['list_attrib']['columns'] = $a_show_cols;
231
232  // show 'to' instead of 'from' in sent/draft messages
233  if ((strpos($mbox.$delim, $CONFIG['sent_mbox'].$delim)===0 || strpos($mbox.$delim, $CONFIG['drafts_mbox'].$delim)===0)
234      && (($f = array_search('from', $a_show_cols)) !== false) && array_search('to', $a_show_cols) === false)
235    $a_show_cols[$f] = 'to';
236
237  // Make sure there are no duplicated columns (#1486999)
238  $a_show_cols = array_unique($a_show_cols);
239
240  // Plugins may set header's list_cols/list_flags and other rcube_mail_header variables
241  // and list columns
242  $plugin = $RCMAIL->plugins->exec_hook('messages_list',
243    array('messages' => $a_headers, 'cols' => $a_show_cols));
244
245  $a_show_cols = $plugin['cols'];
246  $a_headers   = $plugin['messages'];
247
248  $thead = $head_replace ? rcmail_message_list_head($_SESSION['list_attrib'], $a_show_cols) : NULL;
249
250  $OUTPUT->command('set_message_coltypes', $a_show_cols, $thead);
251
252  if (empty($a_headers))
253    return;
254
255  // remove 'threads', 'attachment', 'flag', 'status' columns, we don't need them here
256  foreach (array('threads', 'attachment', 'flag', 'status') as $col) {
257    if (($key = array_search($col, $a_show_cols)) !== FALSE)
258      unset($a_show_cols[$key]);
259  }
260
261  // loop through message headers
262  foreach ($a_headers as $n => $header) {
263    if (empty($header))
264      continue;
265
266    $a_msg_cols = array();
267    $a_msg_flags = array();
268
269    $IMAP->set_charset(!empty($header->charset) ? $header->charset : $CONFIG['default_charset']);
270
271    // format each col; similar as in rcmail_message_list()
272    foreach ($a_show_cols as $col) {
273      if (in_array($col, array('from', 'to', 'cc', 'replyto')))
274        $cont = Q(rcmail_address_string($header->$col, 3), 'show');
275      else if ($col=='subject') {
276        $cont = trim($IMAP->decode_header($header->$col));
277        if (!$cont) $cont = rcube_label('nosubject');
278        $cont = Q($cont);
279      }
280      else if ($col=='size')
281        $cont = show_bytes($header->$col);
282      else if ($col=='date')
283        $cont = format_date($header->date);
284      else
285        $cont = Q($header->$col);
286
287      $a_msg_cols[$col] = $cont;
288    }
289
290    if ($header->depth)
291      $a_msg_flags['depth'] = $header->depth;
292    else if ($header->has_children)
293      $roots[] = $header->uid;
294    if ($header->parent_uid)
295      $a_msg_flags['parent_uid'] = $header->parent_uid;
296    if ($header->has_children)
297      $a_msg_flags['has_children'] = $header->has_children;
298    if ($header->unread_children)
299      $a_msg_flags['unread_children'] = $header->unread_children;
300    if ($header->deleted)
301      $a_msg_flags['deleted'] = 1;
302    if (!$header->seen)
303      $a_msg_flags['unread'] = 1;
304    if ($header->answered)
305      $a_msg_flags['replied'] = 1;
306    if ($header->forwarded)
307      $a_msg_flags['forwarded'] = 1;
308    if ($header->flagged)
309      $a_msg_flags['flagged'] = 1;
310    if ($header->others['list-post'])
311      $a_msg_flags['ml'] = 1;
312
313    $a_msg_flags['ctype'] = Q($header->ctype);
314    $a_msg_flags['mbox'] = $mbox;
315
316    // merge with plugin result
317    if (!empty($header->list_flags) && is_array($header->list_flags))
318      $a_msg_flags = array_merge($a_msg_flags, $header->list_flags);
319    if (!empty($header->list_cols) && is_array($header->list_cols))
320      $a_msg_cols = array_merge($a_msg_cols, $header->list_cols);
321
322    $OUTPUT->command('add_message_row',
323      $header->uid,
324      $a_msg_cols,
325      $a_msg_flags,
326      $insert_top);
327  }
328
329  if ($IMAP->threading) {
330    $OUTPUT->command('init_threads', (array) $roots);
331  }
332}
333
334
335/*
336 * Creates <THEAD> for message list table
337 */
338function rcmail_message_list_head($attrib, $a_show_cols)
339{
340  global $CONFIG;
341
342  $skin_path = $_SESSION['skin_path'];
343  $image_tag = html::img(array('src' => "%s%s", 'alt' => "%s"));
344
345  // check to see if we have some settings for sorting
346  $sort_col   = $_SESSION['sort_col'];
347  $sort_order = $_SESSION['sort_order'];
348
349  // define sortable columns
350  $a_sort_cols = array('subject', 'date', 'from', 'to', 'size', 'cc');
351
352  if (!empty($attrib['optionsmenuicon'])) {
353    $onclick = 'return ' . JS_OBJECT_NAME . ".command('menu-open', 'messagelistmenu')";
354    if ($attrib['optionsmenuicon'] === true || $attrib['optionsmenuicon'] == 'true')
355      $list_menu = html::div(array('onclick' => $onclick, 'class' => 'listmenu',
356        'id' => 'listmenulink', 'title' => rcube_label('listoptions')));
357    else
358      $list_menu = html::a(array('href' => '#', 'onclick' => $onclick),
359        html::img(array('src' => $skin_path . $attrib['optionsmenuicon'],
360          'id' => 'listmenulink', 'title' => rcube_label('listoptions')))
361      );
362  }
363  else
364    $list_menu = '';
365
366  $cells = array();
367
368  foreach ($a_show_cols as $col) {
369    // get column name
370    switch ($col) {
371      case 'flag':
372        $col_name = '<span class="flagged">&nbsp;</span>';
373        break;
374      case 'attachment':
375      case 'status':
376        $col_name = '<span class="' . $col .'">&nbsp;</span>';
377        break;
378      case 'threads':
379        $col_name = $list_menu;
380        break;
381      default:
382        $col_name = Q(rcube_label($col));
383    }
384
385    // make sort links
386    if (in_array($col, $a_sort_cols))
387      $col_name = html::a(array('href'=>"./#sort", 'onclick' => 'return '.JS_OBJECT_NAME.".command('sort','".$col."',this)", 'title' => rcube_label('sortby')), $col_name);
388
389    $sort_class = $col == $sort_col ? " sorted$sort_order" : '';
390    $class_name = $col.$sort_class;
391
392    // put it all together
393    $cells[] = array('className' => $class_name, 'id' => "rcm$col", 'html' => $col_name);
394  }
395
396  return $cells;
397}
398
399
400/**
401 * return an HTML iframe for loading mail content
402 */
403function rcmail_messagecontent_frame($attrib)
404  {
405  global $OUTPUT, $RCMAIL;
406
407  if (empty($attrib['id']))
408    $attrib['id'] = 'rcmailcontentwindow';
409
410  $attrib['name'] = $attrib['id'];
411
412  if ($RCMAIL->config->get('preview_pane'))
413    $OUTPUT->set_env('contentframe', $attrib['id']);
414  $OUTPUT->set_env('blankpage', $attrib['src'] ? $OUTPUT->abs_url($attrib['src']) : 'program/blank.gif');
415
416  return html::iframe($attrib);
417  }
418
419
420function rcmail_messagecount_display($attrib)
421  {
422  global $RCMAIL;
423
424  if (!$attrib['id'])
425    $attrib['id'] = 'rcmcountdisplay';
426
427  $RCMAIL->output->add_gui_object('countdisplay', $attrib['id']);
428
429  $content =  $RCMAIL->action != 'show' ? rcmail_get_messagecount_text() : rcube_label('loading');
430
431  return html::span($attrib, $content);
432  }
433
434
435function rcmail_get_messagecount_text($count=NULL, $page=NULL)
436  {
437  global $RCMAIL, $IMAP;
438
439  if ($page===NULL)
440    $page = $IMAP->list_page;
441
442  $start_msg = ($page-1) * $IMAP->page_size + 1;
443
444  if ($count!==NULL)
445    $max = $count;
446  else if ($RCMAIL->action)
447    $max = $IMAP->messagecount(NULL, $IMAP->threading ? 'THREADS' : 'ALL');
448
449  if ($max==0)
450    $out = rcube_label('mailboxempty');
451  else
452    $out = rcube_label(array('name' => $IMAP->threading ? 'threadsfromto' : 'messagesfromto',
453            'vars' => array('from'  => $start_msg,
454            'to'    => min($max, $start_msg + $IMAP->page_size - 1),
455            'count' => $max)));
456
457  return Q($out);
458  }
459
460
461function rcmail_mailbox_name_display($attrib)
462{
463  global $RCMAIL;
464
465  if (!$attrib['id'])
466    $attrib['id'] = 'rcmmailboxname';
467
468  $RCMAIL->output->add_gui_object('mailboxname', $attrib['id']);
469
470  return html::span($attrib, rcmail_get_mailbox_name_text());
471}
472
473
474function rcmail_get_mailbox_name_text()
475{
476  global $RCMAIL;
477  return rcmail_localize_foldername($RCMAIL->imap->get_mailbox_name());
478}
479
480
481function rcmail_send_unread_count($mbox_name, $force=false, $count=null)
482{
483  global $RCMAIL;
484
485  $old_unseen = rcmail_get_unseen_count($mbox_name);
486
487  if ($count === null)
488    $unseen = $RCMAIL->imap->messagecount($mbox_name, 'UNSEEN', $force);
489  else
490    $unseen = $count;
491
492  if ($unseen != $old_unseen || ($mbox_name == 'INBOX'))
493    $RCMAIL->output->command('set_unread_count', $mbox_name, $unseen, ($mbox_name == 'INBOX'));
494
495  rcmail_set_unseen_count($mbox_name, $unseen);
496
497  return $unseen;
498}
499
500
501function rcmail_set_unseen_count($mbox_name, $count)
502{
503  // @TODO: this data is doubled (session and cache tables) if caching is enabled
504
505  // Make sure we have an array here (#1487066)
506  if (!is_array($_SESSION['unseen_count']))
507    $_SESSION['unseen_count'] = array();
508
509  $_SESSION['unseen_count'][$mbox_name] = $count;
510}
511
512
513function rcmail_get_unseen_count($mbox_name)
514{
515  if (is_array($_SESSION['unseen_count']) && array_key_exists($mbox_name, $_SESSION['unseen_count']))
516    return $_SESSION['unseen_count'][$mbox_name];
517  else
518    return null;
519}
520
521
522/**
523 * Sets message is_safe flag according to 'show_images' option value
524 *
525 * @param object rcube_message Message
526 */
527function rcmail_check_safe(&$message)
528{
529  global $RCMAIL;
530
531  $show_images = $RCMAIL->config->get('show_images');
532  if (!$message->is_safe
533    && !empty($show_images)
534    && $message->has_html_part())
535  {
536    switch($show_images) {
537      case '1': // known senders only
538        $CONTACTS = new rcube_contacts($RCMAIL->db, $_SESSION['user_id']);
539        if ($CONTACTS->search('email', $message->sender['mailto'], true, false)->count) {
540          $message->set_safe(true);
541        }
542      break;
543      case '2': // always
544        $message->set_safe(true);
545      break;
546    }
547  }
548}
549
550
551/**
552 * Cleans up the given message HTML Body (for displaying)
553 *
554 * @param string HTML
555 * @param array  Display parameters
556 * @param array  CID map replaces (inline images)
557 * @return string Clean HTML
558 */
559function rcmail_wash_html($html, $p = array(), $cid_replaces)
560{
561  global $REMOTE_OBJECTS;
562
563  $p += array('safe' => false, 'inline_html' => true);
564
565  // special replacements (not properly handled by washtml class)
566  $html_search = array(
567    '/(<\/nobr>)(\s+)(<nobr>)/i',       // space(s) between <NOBR>
568    '/<title[^>]*>.*<\/title>/i',       // PHP bug #32547 workaround: remove title tag
569    '/^(\0\0\xFE\xFF|\xFF\xFE\0\0|\xFE\xFF|\xFF\xFE|\xEF\xBB\xBF)/',    // byte-order mark (only outlook?)
570    '/<html\s[^>]+>/i',                 // washtml/DOMDocument cannot handle xml namespaces
571  );
572  $html_replace = array(
573    '\\1'.' &nbsp; '.'\\3',
574    '',
575    '',
576    '<html>',
577  );
578  $html = preg_replace($html_search, $html_replace, $html);
579
580  // PCRE errors handling (#1486856), should we use something like for every preg_* use?
581  if ($html === null && ($preg_error = preg_last_error()) != PREG_NO_ERROR) {
582    $errstr = "Could not clean up HTML message! PCRE Error: $preg_error.";
583
584    if ($preg_error == PREG_BACKTRACK_LIMIT_ERROR)
585      $errstr .= " Consider raising pcre.backtrack_limit!";
586    if ($preg_error == PREG_RECURSION_LIMIT_ERROR)
587      $errstr .= " Consider raising pcre.recursion_limit!";
588
589    raise_error(array('code' => 600, 'type' => 'php',
590        'line' => __LINE__, 'file' => __FILE__,
591        'message' => $errstr), true, false);
592    return '';
593  }
594
595  // fix (unknown/malformed) HTML tags before "wash"
596  $html = preg_replace_callback('/(<[\/]*)([^\s>]+)/', 'rcmail_html_tag_callback', $html);
597
598  // charset was converted to UTF-8 in rcube_imap::get_message_part(),
599  // -> change charset specification in HTML accordingly
600  $charset_pattern = '(<meta\s+[^>]*content=)[\'"]?(\w+\/\w+;\s*charset=)([a-z0-9-_]+[\'"]?)';
601  if (preg_match("/$charset_pattern/Ui", $html)) {
602    $html = preg_replace("/$charset_pattern/i", '\\1"\\2'.RCMAIL_CHARSET.'"', $html);
603  }
604  else {
605    // add meta content-type to malformed messages, washtml cannot work without that
606    if (!preg_match('/<head[^>]*>(.*)<\/head>/Uims', $html))
607      $html = '<head></head>'. $html;
608    $html = substr_replace($html, '<meta http-equiv="Content-Type" content="text/html; charset='.RCMAIL_CHARSET.'" />', intval(stripos($html, '<head>')+6), 0);
609  }
610
611  // turn relative into absolute urls
612  $html = rcmail_resolve_base($html);
613
614  // clean HTML with washhtml by Frederic Motte
615  $wash_opts = array(
616    'show_washed' => false,
617    'allow_remote' => $p['safe'],
618    'blocked_src' => "./program/blocked.gif",
619    'charset' => RCMAIL_CHARSET,
620    'cid_map' => $cid_replaces,
621    'html_elements' => array('body'),
622  );
623
624  if (!$p['inline_html']) {
625    $wash_opts['html_elements'] = array('html','head','title','body');
626  }
627  if ($p['safe']) {
628    $wash_opts['html_elements'][] = 'link';
629    $wash_opts['html_attribs'] = array('rel','type');
630  }
631
632  // overwrite washer options with options from plugins
633  if (isset($p['html_elements']))
634    $wash_opts['html_elements'] = $p['html_elements'];
635  if (isset($p['html_attribs']))
636    $wash_opts['html_attribs'] = $p['html_attribs'];
637
638  // initialize HTML washer
639  $washer = new washtml($wash_opts);
640
641  if (!$p['skip_washer_form_callback'])
642    $washer->add_callback('form', 'rcmail_washtml_callback');
643
644  // allow CSS styles, will be sanitized by rcmail_washtml_callback()
645  if (!$p['skip_washer_style_callback'])
646    $washer->add_callback('style', 'rcmail_washtml_callback');
647
648  $html = $washer->wash($html);
649  $REMOTE_OBJECTS = $washer->extlinks;
650
651  return $html;
652}
653
654
655/**
656 * Convert the given message part to proper HTML
657 * which can be displayed the message view
658 *
659 * @param object rcube_message_part Message part
660 * @param array  Display parameters array
661 * @return string Formatted HTML string
662 */
663function rcmail_print_body($part, $p = array())
664{
665  global $RCMAIL;
666
667  // trigger plugin hook
668  $data = $RCMAIL->plugins->exec_hook('message_part_before',
669    array('type' => $part->ctype_secondary, 'body' => $part->body, 'id' => $part->mime_id)
670        + $p + array('safe' => false, 'plain' => false, 'inline_html' => true));
671
672  // convert html to text/plain
673  if ($data['type'] == 'html' && $data['plain']) {
674    $txt = new html2text($data['body'], false, true);
675    $body = $txt->get_text();
676    $part->ctype_secondary = 'plain';
677  }
678  // text/html
679  else if ($data['type'] == 'html') {
680    $body = rcmail_wash_html($data['body'], $data, $part->replaces);
681    $part->ctype_secondary = $data['type'];
682  }
683  // text/enriched
684  else if ($data['type'] == 'enriched') {
685    $part->ctype_secondary = 'html';
686    require_once(INSTALL_PATH . 'program/lib/enriched.inc');
687    $body = Q(enriched_to_html($data['body']), 'show');
688  }
689  else {
690    // assert plaintext
691    $body = $part->body;
692    $part->ctype_secondary = $data['type'] = 'plain';
693  }
694
695  // free some memory (hopefully)
696  unset($data['body']);
697
698  // plaintext postprocessing
699  if ($part->ctype_secondary == 'plain')
700    $body = rcmail_plain_body($body, $part->ctype_parameters['format'] == 'flowed');
701
702  // allow post-processing of the message body
703  $data = $RCMAIL->plugins->exec_hook('message_part_after',
704    array('type' => $part->ctype_secondary, 'body' => $body, 'id' => $part->mime_id) + $data);
705
706  return $data['type'] == 'html' ? $data['body'] : html::tag('pre', array(), $data['body']);
707}
708
709
710/**
711 * Handle links and citation marks in plain text message
712 *
713 * @param string  Plain text string
714 * @param boolean Text uses format=flowed
715 *
716 * @return string Formatted HTML string
717 */
718function rcmail_plain_body($body, $flowed=false)
719{
720  global $RCMAIL;
721
722  // make links and email-addresses clickable
723  $replacer = new rcube_string_replacer;
724
725  // search for patterns like links and e-mail addresses
726  $body = preg_replace_callback($replacer->link_pattern, array($replacer, 'link_callback'), $body);
727  $body = preg_replace_callback($replacer->mailto_pattern, array($replacer, 'mailto_callback'), $body);
728
729  // split body into single lines
730  $body = preg_split('/\r?\n/', $body);
731  $quote_level = 0;
732  $last = -1;
733
734  // find/mark quoted lines...
735  for ($n=0, $cnt=count($body); $n < $cnt; $n++) {
736    if ($body[$n][0] == '>' && preg_match('/^(>+\s*)+/', $body[$n], $regs)) {
737      $q = strlen(preg_replace('/\s/', '', $regs[0]));
738      $body[$n] = substr($body[$n], strlen($regs[0]));
739
740      if ($q > $quote_level) {
741        $body[$n] = $replacer->get_replacement($replacer->add(
742          str_repeat('<blockquote>', $q - $quote_level))) . $body[$n];
743      }
744      else if ($q < $quote_level) {
745        $body[$n] = $replacer->get_replacement($replacer->add(
746          str_repeat('</blockquote>', $quote_level - $q))) . $body[$n];
747      }
748      else if ($flowed) {
749        // previous line is flowed
750        if (isset($body[$last]) && $body[$n]
751          && $body[$last][strlen($body[$last])-1] == ' ') {
752          // merge lines
753          $body[$last] .= $body[$n];
754          unset($body[$n]);
755        }
756        else {
757          $last = $n;
758        }
759      }
760    }
761    else {
762      $q = 0;
763      if ($flowed) {
764        // sig separator - line is fixed
765        if ($body[$n] == '-- ') {
766          $last = $last_sig = $n;
767        }
768        else {
769          // remove space-stuffing
770          if ($body[$n][0] == ' ')
771            $body[$n] = substr($body[$n], 1);
772
773          // previous line is flowed?
774          if (isset($body[$last]) && $body[$n]
775            && $last != $last_sig
776            && $body[$last][strlen($body[$last])-1] == ' '
777          ) {
778            $body[$last] .= $body[$n];
779            unset($body[$n]);
780          }
781          else {
782            $last = $n;
783          }
784        }
785        if ($quote_level > 0)
786          $body[$last] = $replacer->get_replacement($replacer->add(
787            str_repeat('</blockquote>', $quote_level))) . $body[$last];
788      }
789      else if ($quote_level > 0)
790        $body[$n] = $replacer->get_replacement($replacer->add(
791          str_repeat('</blockquote>', $quote_level))) . $body[$n];
792    }
793
794    $quote_level = $q;
795  }
796
797  $body = join("\n", $body);
798
799  // quote plain text (don't use Q() here, to display entities "as is")
800  $table = get_html_translation_table(HTML_SPECIALCHARS);
801  unset($table['?']);
802  $body = strtr($body, $table);
803
804  // colorize signature (up to <sig_max_lines> lines)
805  $len = strlen($body);
806  $sig_max_lines = $RCMAIL->config->get('sig_max_lines', 15);
807  while (($sp = strrpos($body, "-- \n", $sp ? -$len+$sp-1 : 0)) !== false) {
808    if ($sp == 0 || $body[$sp-1] == "\n") {
809      // do not touch blocks with more that X lines
810      if (substr_count($body, "\n", $sp) < $sig_max_lines)
811        $body = substr($body, 0, max(0, $sp))
812          .'<span class="sig">'.substr($body, $sp).'</span>';
813      break;
814    }
815  }
816
817  // insert url/mailto links and citation tags
818  $body = $replacer->resolve($body);
819
820  return $body;
821}
822
823
824/**
825 * Callback function for washtml cleaning class
826 */
827function rcmail_washtml_callback($tagname, $attrib, $content)
828{
829  switch ($tagname) {
830    case 'form':
831      $out = html::div('form', $content);
832      break;
833
834    case 'style':
835      // decode all escaped entities and reduce to ascii strings
836      $stripped = preg_replace('/[^a-zA-Z\(:;]/', '', rcmail_xss_entity_decode($content));
837
838      // now check for evil strings like expression, behavior or url()
839      if (!preg_match('/expression|behavior|url\(|import[^a]/', $stripped)) {
840        $out = html::tag('style', array('type' => 'text/css'), $content);
841        break;
842      }
843
844    default:
845      $out = '';
846  }
847
848  return $out;
849}
850
851
852/**
853 * Callback function for HTML tags fixing
854 */
855function rcmail_html_tag_callback($matches)
856{
857  $tagname = $matches[2];
858
859  $tagname = preg_replace(array(
860    '/:.*$/',                   // Microsoft's Smart Tags <st1:xxxx>
861    '/[^a-z0-9_\[\]\!-]/i',     // forbidden characters
862    ), '', $tagname);
863
864  return $matches[1].$tagname;
865}
866
867
868/**
869 * return table with message headers
870 */
871function rcmail_message_headers($attrib, $headers=NULL)
872  {
873  global $IMAP, $OUTPUT, $MESSAGE, $PRINT_MODE, $RCMAIL;
874  static $sa_attrib;
875
876  // keep header table attrib
877  if (is_array($attrib) && !$sa_attrib)
878    $sa_attrib = $attrib;
879  else if (!is_array($attrib) && is_array($sa_attrib))
880    $attrib = $sa_attrib;
881
882  if (!isset($MESSAGE))
883    return FALSE;
884
885  // get associative array of headers object
886  if (!$headers)
887    $headers = is_object($MESSAGE->headers) ? get_object_vars($MESSAGE->headers) : $MESSAGE->headers;
888
889  // show these headers
890  $standard_headers = array('subject', 'from', 'to', 'cc', 'bcc', 'replyto',
891    'mail-reply-to', 'mail-followup-to', 'date');
892  $output_headers = array();
893
894  foreach ($standard_headers as $hkey) {
895    if ($headers[$hkey])
896      $value = $headers[$hkey];
897    else if ($headers['others'][$hkey])
898      $value = $headers['others'][$hkey];
899    else
900      continue;
901
902    if ($hkey == 'date') {
903      if ($PRINT_MODE)
904        $header_value = format_date($value, $RCMAIL->config->get('date_long', 'x'));
905      else
906        $header_value = format_date($value);
907    }
908    else if ($hkey == 'replyto') {
909      if ($headers['replyto'] != $headers['from'])
910        $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
911      else
912        continue;
913    }
914    else if ($hkey == 'mail-reply-to') {
915      if ($headers['mail-replyto'] != $headers['reply-to']
916        && $headers['reply-to'] != $headers['from']
917      )
918        $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
919      else
920        continue;
921    }
922    else if ($hkey == 'mail-followup-to') {
923      $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
924    }
925    else if (in_array($hkey, array('from', 'to', 'cc', 'bcc')))
926      $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
927    else if ($hkey == 'subject' && empty($value))
928      $header_value = rcube_label('nosubject');
929    else
930      $header_value = trim($IMAP->decode_header($value));
931
932    $output_headers[$hkey] = array(
933        'title' => rcube_label(preg_replace('/(^mail-|-)/', '', $hkey)),
934        'value' => $header_value, 'raw' => $value
935    );
936  }
937
938  $plugin = $RCMAIL->plugins->exec_hook('message_headers_output',
939    array('output' => $output_headers, 'headers' => $MESSAGE->headers));
940
941  // compose html table
942  $table = new html_table(array('cols' => 2));
943
944  foreach ($plugin['output'] as $hkey => $row) {
945    $table->add(array('class' => 'header-title'), Q($row['title']));
946    $table->add(array('class' => 'header '.$hkey), Q($row['value'], ($hkey == 'subject' ? 'strict' : 'show')));
947  }
948
949  return $table->show($attrib);
950}
951
952
953/**
954 * return block to show full message headers
955 */
956function rcmail_message_full_headers($attrib, $headers=NULL)
957{
958  global $OUTPUT;
959
960  $html = html::div(array('class' => "more-headers show-headers", 'onclick' => "return ".JS_OBJECT_NAME.".command('load-headers','',this)"), '');
961  $html .= html::div(array('id' => "all-headers", 'class' => "all", 'style' => 'display:none'), html::div(array('id' => 'headers-source'), ''));
962
963  $OUTPUT->add_gui_object('all_headers_row', 'all-headers');
964  $OUTPUT->add_gui_object('all_headers_box', 'headers-source');
965
966  return html::div($attrib, $html);
967}
968
969
970/**
971 * Handler for the 'messagebody' GUI object
972 *
973 * @param array Named parameters
974 * @return string HTML content showing the message body
975 */
976function rcmail_message_body($attrib)
977  {
978  global $CONFIG, $OUTPUT, $MESSAGE, $IMAP, $RCMAIL, $REMOTE_OBJECTS;
979
980  if (!is_array($MESSAGE->parts) && empty($MESSAGE->body))
981    return '';
982
983  if (!$attrib['id'])
984    $attrib['id'] = 'rcmailMsgBody';
985
986  $safe_mode = $MESSAGE->is_safe || intval($_GET['_safe']);
987  $out = '';
988
989  $header_attrib = array();
990  foreach ($attrib as $attr => $value)
991    if (preg_match('/^headertable([a-z]+)$/i', $attr, $regs))
992      $header_attrib[$regs[1]] = $value;
993
994  if (!empty($MESSAGE->parts))
995    {
996    foreach ($MESSAGE->parts as $i => $part)
997      {
998      if ($part->type == 'headers')
999        $out .= rcmail_message_headers(sizeof($header_attrib) ? $header_attrib : NULL, $part->headers);
1000      else if ($part->type == 'content' && $part->size)
1001        {
1002        if (empty($part->ctype_parameters) || empty($part->ctype_parameters['charset']))
1003          $part->ctype_parameters['charset'] = $MESSAGE->headers->charset;
1004
1005        // fetch part if not available
1006        if (!isset($part->body))
1007          $part->body = $MESSAGE->get_part_content($part->mime_id);
1008
1009        // message is cached but not exists (#1485443), or other error
1010        if ($part->body === false) {
1011          rcmail_message_error($MESSAGE->uid);
1012        }
1013
1014        $plugin = $RCMAIL->plugins->exec_hook('message_body_prefix', array(
1015          'part' => $part, 'prefix' => ''));
1016
1017        $body = rcmail_print_body($part, array('safe' => $safe_mode, 'plain' => !$CONFIG['prefer_html']));
1018
1019        if ($part->ctype_secondary == 'html') {
1020          $body = rcmail_html4inline($body, $attrib['id'], 'rcmBody', $attrs);
1021          $div_attr = array('class' => 'message-htmlpart');
1022          $style = array();
1023
1024          if (!empty($attrs)) {
1025            foreach ($attrs as $a_idx => $a_val)
1026              $style[] = $a_idx . ': ' . $a_val;
1027            if (!empty($style))
1028              $div_attr['style'] = implode('; ', $style);
1029          }
1030
1031          $out .= html::div($div_attr, $plugin['prefix'] . $body);
1032        }
1033        else
1034          $out .= html::div('message-part', $plugin['prefix'] . $body);
1035        }
1036      }
1037    }
1038  else {
1039    $plugin = $RCMAIL->plugins->exec_hook('message_body_prefix', array(
1040      'part' => $MESSAGE, 'prefix' => ''));
1041
1042    $out .= html::div('message-part', $plugin['prefix'] . html::tag('pre', array(),
1043      rcmail_plain_body(Q($MESSAGE->body, 'strict', false))));
1044    }
1045
1046  $ctype_primary = strtolower($MESSAGE->structure->ctype_primary);
1047  $ctype_secondary = strtolower($MESSAGE->structure->ctype_secondary);
1048
1049  // list images after mail body
1050  if ($CONFIG['inline_images']
1051      && $ctype_primary == 'multipart'
1052      && !empty($MESSAGE->attachments))
1053    {
1054    foreach ($MESSAGE->attachments as $attach_prop) {
1055      // Content-Type: image/*...
1056      if (preg_match('/^image\//i', $attach_prop->mimetype) ||
1057        // ...or known file extension: many clients are using application/octet-stream
1058        ($attach_prop->filename &&
1059          preg_match('/^application\/octet-stream$/i', $attach_prop->mimetype) &&
1060          preg_match('/\.(jpg|jpeg|png|gif|bmp)$/i', $attach_prop->filename))
1061      ) {
1062        $out .= html::tag('hr') . html::p(array('align' => "center"),
1063          html::img(array(
1064            'src' => $MESSAGE->get_part_url($attach_prop->mime_id),
1065            'title' => $attach_prop->filename,
1066            'alt' => $attach_prop->filename,
1067          )));
1068        }
1069    }
1070  }
1071
1072  // tell client that there are blocked remote objects
1073  if ($REMOTE_OBJECTS && !$safe_mode)
1074    $OUTPUT->set_env('blockedobjects', true);
1075
1076  return html::div($attrib, $out);
1077  }
1078
1079
1080/**
1081 * Convert all relative URLs according to a <base> in HTML
1082 */
1083function rcmail_resolve_base($body)
1084{
1085  // check for <base href=...>
1086  if (preg_match('!(<base.*href=["\']?)([hftps]{3,5}://[a-z0-9/.%-]+)!i', $body, $regs)) {
1087    $replacer = new rcube_base_replacer($regs[2]);
1088
1089    // replace all relative paths
1090    $body = preg_replace_callback('/(src|background|href)=(["\']?)([^"\'\s]+)(\2|\s|>)/Ui', array($replacer, 'callback'), $body);
1091    $body = preg_replace_callback('/(url\s*\()(["\']?)([^"\'\)\s]+)(\2)\)/Ui', array($replacer, 'callback'), $body);
1092  }
1093
1094  return $body;
1095}
1096
1097/**
1098 * modify a HTML message that it can be displayed inside a HTML page
1099 */
1100function rcmail_html4inline($body, $container_id, $body_id='', &$attributes=null)
1101{
1102  $last_style_pos = 0;
1103  $body_lc = strtolower($body);
1104  $cont_id = $container_id.($body_id ? ' div.'.$body_id : '');
1105
1106  // find STYLE tags
1107  while (($pos = strpos($body_lc, '<style', $last_style_pos)) && ($pos2 = strpos($body_lc, '</style>', $pos)))
1108  {
1109    $pos = strpos($body_lc, '>', $pos)+1;
1110
1111    // replace all css definitions with #container [def]
1112    $styles = rcmail_mod_css_styles(
1113      substr($body, $pos, $pos2-$pos), $cont_id);
1114
1115    $body = substr($body, 0, $pos) . $styles . substr($body, $pos2);
1116    $body_lc = strtolower($body);
1117    $last_style_pos = $pos2;
1118  }
1119
1120  // modify HTML links to open a new window if clicked
1121  $GLOBALS['rcmail_html_container_id'] = $container_id;
1122  $body = preg_replace_callback('/<(a|link)\s+([^>]+)>/Ui', 'rcmail_alter_html_link', $body);
1123  unset($GLOBALS['rcmail_html_container_id']);
1124
1125  $body = preg_replace(array(
1126      // add comments arround html and other tags
1127      '/(<!DOCTYPE[^>]*>)/i',
1128      '/(<\?xml[^>]*>)/i',
1129      '/(<\/?html[^>]*>)/i',
1130      '/(<\/?head[^>]*>)/i',
1131      '/(<title[^>]*>.*<\/title>)/Ui',
1132      '/(<\/?meta[^>]*>)/i',
1133      // quote <? of php and xml files that are specified as text/html
1134      '/<\?/',
1135      '/\?>/',
1136      // replace <body> with <div>
1137      '/<body([^>]*)>/i',
1138      '/<\/body>/i',
1139      ),
1140    array(
1141      '<!--\\1-->',
1142      '<!--\\1-->',
1143      '<!--\\1-->',
1144      '<!--\\1-->',
1145      '<!--\\1-->',
1146      '<!--\\1-->',
1147      '&lt;?',
1148      '?&gt;',
1149      '<div class="'.$body_id.'"\\1>',
1150      '</div>',
1151      ),
1152    $body);
1153
1154  $attributes = array();
1155
1156  // Handle body attributes that doesn't play nicely with div elements
1157  $regexp = '/<div class="' . preg_quote($body_id, '/') . '"([^>]*)/';
1158  if (preg_match($regexp, $body, $m)) {
1159    $attrs = $m[0];
1160    // Get bgcolor, we'll set it as background-color of the message container
1161    if ($m[1] && preg_match('/bgcolor=["\']*([a-z0-9#]+)["\']*/', $attrs, $mb)) {
1162      $attributes['background-color'] = $mb[1];
1163      $attrs = preg_replace('/bgcolor=["\']*([a-z0-9#]+)["\']*/', '', $attrs);
1164    }
1165    // Get background, we'll set it as background-image of the message container
1166    if ($m[1] && preg_match('/background=["\']*([^"\'>\s]+)["\']*/', $attrs, $mb)) {
1167      $attributes['background-image'] = 'url('.$mb[1].')';
1168      $attrs = preg_replace('/background=["\']*([^"\'>\s]+)["\']*/', '', $attrs);
1169    }
1170    if (!empty($attributes)) {
1171      $body = preg_replace($regexp, rtrim($attrs), $body, 1);
1172    }
1173
1174    // handle body styles related to background image
1175    if ($attributes['background-image']) {
1176      // get body style
1177      if (preg_match('/#'.preg_quote($cont_id, '/').'\s+\{([^}]+)}/i', $body, $m)) {
1178        // get background related style
1179        if (preg_match_all('/(background-position|background-repeat)\s*:\s*([^;]+);/i', $m[1], $ma, PREG_SET_ORDER)) {
1180          foreach ($ma as $style)
1181            $attributes[$style[1]] = $style[2];
1182        }
1183      }
1184    }
1185  }
1186  // make sure there's 'rcmBody' div, we need it for proper css modification
1187  // its name is hardcoded in rcmail_message_body() also
1188  else {
1189    $body = '<div class="' . $body_id . '">' . $body . '</div>';
1190  }
1191
1192  return $body;
1193}
1194
1195
1196/**
1197 * parse link attributes and set correct target
1198 */
1199function rcmail_alter_html_link($matches)
1200{
1201  global $RCMAIL;
1202
1203  // Support unicode/punycode in top-level domain part
1204  $EMAIL_PATTERN = '([a-z0-9][a-z0-9\-\.\+\_]*@[^&@"\'.][^@&"\']*\\.([^\\x00-\\x40\\x5b-\\x60\\x7b-\\x7f]{2,}|xn--[a-z0-9]{2,}))';
1205
1206  $tag = $matches[1];
1207  $attrib = parse_attrib_string($matches[2]);
1208  $end = '>';
1209
1210  // Remove non-printable characters in URL (#1487805)
1211  $attrib['href'] = preg_replace('/[\x00-\x1F]/', '', $attrib['href']);
1212
1213  if ($tag == 'link' && preg_match('/^https?:\/\//i', $attrib['href'])) {
1214    $tempurl = 'tmp-' . md5($attrib['href']) . '.css';
1215    $_SESSION['modcssurls'][$tempurl] = $attrib['href'];
1216    $attrib['href'] = $RCMAIL->url(array('task' => 'utils', 'action' => 'modcss', 'u' => $tempurl, 'c' => $GLOBALS['rcmail_html_container_id']));
1217    $end = ' />';
1218  }
1219  else if (preg_match('/^mailto:'.$EMAIL_PATTERN.'(\?[^"\'>]+)?/i', $attrib['href'], $mailto)) {
1220    $attrib['href'] = $mailto[0];
1221    $attrib['onclick'] = sprintf(
1222      "return %s.command('compose','%s',this)",
1223      JS_OBJECT_NAME,
1224      JQ($mailto[1].$mailto[3]));
1225  }
1226  else if (!empty($attrib['href']) && $attrib['href'][0] != '#') {
1227    $attrib['target'] = '_blank';
1228  }
1229
1230  return "<$tag" . html::attrib_string($attrib, array('href','name','target','onclick','id','class','style','title','rel','type','media')) . $end;
1231}
1232
1233
1234/**
1235 * decode address string and re-format it as HTML links
1236 */
1237function rcmail_address_string($input, $max=null, $linked=false, $addicon=null)
1238{
1239  global $IMAP, $RCMAIL, $PRINT_MODE, $CONFIG;
1240  static $got_writable_abook = null;
1241
1242  $a_parts = $IMAP->decode_address_list($input);
1243
1244  if (!sizeof($a_parts))
1245    return $input;
1246
1247  $c = count($a_parts);
1248  $j = 0;
1249  $out = '';
1250
1251  if ($got_writable_abook === null && $books = $RCMAIL->get_address_sources(true)) {
1252    $got_writable_abook = true;
1253  }
1254
1255  foreach ($a_parts as $part) {
1256    $j++;
1257
1258    $name   = $part['name'];
1259    $mailto = $part['mailto'];
1260    $string = $part['string'];
1261
1262    // IDNA ASCII to Unicode
1263    if ($name == $mailto)
1264      $name = rcube_idn_to_utf8($name);
1265    if ($string == $mailto)
1266      $string = rcube_idn_to_utf8($string);
1267    $mailto = rcube_idn_to_utf8($mailto);
1268
1269    if ($PRINT_MODE) {
1270      $out .= sprintf('%s &lt;%s&gt;', Q($name), $mailto);
1271    }
1272    else if (check_email($part['mailto'], false)) {
1273      if ($linked) {
1274        $address = html::a(array(
1275            'href' => 'mailto:'.$mailto,
1276            'onclick' => sprintf("return %s.command('compose','%s',this)", JS_OBJECT_NAME, JQ($mailto)),
1277            'title' => $mailto,
1278            'class' => "rcmContactAddress",
1279          ),
1280        Q($name ? $name : $mailto));
1281      }
1282      else {
1283        $address = html::span(array('title' => $mailto, 'class' => "rcmContactAddress"),
1284          Q($name ? $name : $mailto));
1285      }
1286
1287      if ($addicon && $got_writable_abook) {
1288        $address = html::span(null, $address . html::a(array(
1289            'href' => "#add",
1290            'onclick' => sprintf("return %s.command('add-contact','%s',this)", JS_OBJECT_NAME, urlencode($string)),
1291            'title' => rcube_label('addtoaddressbook'),
1292          ),
1293          html::img(array(
1294            'src' => $CONFIG['skin_path'] . $addicon,
1295            'alt' => "Add contact",
1296          ))));
1297      }
1298      $out .= $address;
1299    }
1300    else {
1301      if ($name)
1302        $out .= Q($name);
1303      if ($mailto)
1304        $out .= (strlen($out) ? ' ' : '') . sprintf('&lt;%s&gt;', Q($mailto));
1305    }
1306
1307    if ($c>$j)
1308      $out .= ','.($max ? '&nbsp;' : ' ');
1309
1310    if ($max && $j==$max && $c>$j) {
1311      $out .= '...';
1312      break;
1313    }
1314  }
1315
1316  return $out;
1317}
1318
1319
1320/**
1321 * Wrap text to a given number of characters per line
1322 * but respect the mail quotation of replies messages (>).
1323 * Finally add another quotation level by prpending the lines
1324 * with >
1325 *
1326 * @param string Text to wrap
1327 * @param int The line width
1328 * @return string The wrapped text
1329 */
1330function rcmail_wrap_and_quote($text, $length = 72)
1331{
1332  // Rebuild the message body with a maximum of $max chars, while keeping quoted message.
1333  $max = min(77, $length + 8);
1334  $lines = preg_split('/\r?\n/', trim($text));
1335  $out = '';
1336
1337  foreach ($lines as $line) {
1338    // don't wrap already quoted lines
1339    if ($line[0] == '>')
1340      $line = '>' . rtrim($line);
1341    else if (mb_strlen($line) > $max) {
1342      $newline = '';
1343      foreach(explode("\n", rc_wordwrap($line, $length - 2)) as $l) {
1344        if (strlen($l))
1345          $newline .= '> ' . $l . "\n";
1346        else
1347          $newline .= ">\n";
1348      }
1349      $line = rtrim($newline);
1350    }
1351    else
1352      $line = '> ' . $line;
1353
1354    // Append the line
1355    $out .= $line . "\n";
1356  }
1357
1358  return $out;
1359}
1360
1361
1362function rcmail_draftinfo_encode($p)
1363{
1364  $parts = array();
1365  foreach ($p as $key => $val)
1366    $parts[] = $key . '=' . ($key == 'folder' ? base64_encode($val) : $val);
1367
1368  return join('; ', $parts);
1369}
1370
1371
1372function rcmail_draftinfo_decode($str)
1373{
1374  $info = array();
1375  foreach (preg_split('/;\s+/', $str) as $part) {
1376    list($key, $val) = explode('=', $part, 2);
1377    if ($key == 'folder')
1378      $val = base64_decode($val);
1379    $info[$key] = $val;
1380  }
1381
1382  return $info;
1383}
1384
1385
1386function rcmail_message_part_controls()
1387{
1388  global $MESSAGE;
1389
1390  $part = asciiwords(get_input_value('_part', RCUBE_INPUT_GPC));
1391  if (!is_object($MESSAGE) || !is_array($MESSAGE->parts) || !($_GET['_uid'] && $_GET['_part']) || !$MESSAGE->mime_parts[$part])
1392    return '';
1393
1394  $part = $MESSAGE->mime_parts[$part];
1395  $table = new html_table(array('cols' => 3));
1396
1397  if (!empty($part->filename)) {
1398    $table->add('title', Q(rcube_label('filename')));
1399    $table->add(null, Q($part->filename));
1400    $table->add(null, '[' . html::a('?'.str_replace('_frame=', '_download=', $_SERVER['QUERY_STRING']), Q(rcube_label('download'))) . ']');
1401  }
1402
1403  if (!empty($part->size)) {
1404    $table->add('title', Q(rcube_label('filesize')));
1405    $table->add(null, Q(show_bytes($part->size)));
1406  }
1407
1408  return $table->show($attrib);
1409}
1410
1411
1412
1413function rcmail_message_part_frame($attrib)
1414{
1415  global $MESSAGE;
1416
1417  $part = $MESSAGE->mime_parts[asciiwords(get_input_value('_part', RCUBE_INPUT_GPC))];
1418  $ctype_primary = strtolower($part->ctype_primary);
1419
1420  $attrib['src'] = './?' . str_replace('_frame=', ($ctype_primary=='text' ? '_show=' : '_preload='), $_SERVER['QUERY_STRING']);
1421
1422  return html::iframe($attrib);
1423}
1424
1425
1426/**
1427 * clear message composing settings
1428 */
1429function rcmail_compose_cleanup($id)
1430{
1431  if (!isset($_SESSION['compose_data'][$id]))
1432    return;
1433
1434  $rcmail = rcmail::get_instance();
1435  $rcmail->plugins->exec_hook('attachments_cleanup', array('group' => $id));
1436  unset($_SESSION['compose_data'][$id]);
1437}
1438
1439
1440/**
1441 * Send the given message using the configured method
1442 *
1443 * @param object $message    Reference to Mail_MIME object
1444 * @param string $from       Sender address string
1445 * @param array  $mailto     Array of recipient address strings
1446 * @param array  $smtp_error SMTP error array (reference)
1447 * @param string $body_file  Location of file with saved message body (reference)
1448 * @param array  $smtp_opts  SMTP options (e.g. DSN request)
1449 *
1450 * @return boolean Send status.
1451 */
1452function rcmail_deliver_message(&$message, $from, $mailto, &$smtp_error, &$body_file, $smtp_opts=null)
1453{
1454  global $CONFIG, $RCMAIL;
1455
1456  $headers = $message->headers();
1457
1458  // send thru SMTP server using custom SMTP library
1459  if ($CONFIG['smtp_server']) {
1460    // generate list of recipients
1461    $a_recipients = array($mailto);
1462
1463    if (strlen($headers['Cc']))
1464      $a_recipients[] = $headers['Cc'];
1465    if (strlen($headers['Bcc']))
1466      $a_recipients[] = $headers['Bcc'];
1467
1468    // clean Bcc from header for recipients
1469    $send_headers = $headers;
1470    unset($send_headers['Bcc']);
1471    // here too, it because txtHeaders() below use $message->_headers not only $send_headers
1472    unset($message->_headers['Bcc']);
1473
1474    $smtp_headers = $message->txtHeaders($send_headers, true);
1475
1476    if ($message->getParam('delay_file_io')) {
1477      // use common temp dir
1478      $temp_dir = $RCMAIL->config->get('temp_dir');
1479      $body_file = tempnam($temp_dir, 'rcmMsg');
1480      if (PEAR::isError($mime_result = $message->saveMessageBody($body_file))) {
1481        raise_error(array('code' => 600, 'type' => 'php',
1482            'file' => __FILE__, 'line' => __LINE__,
1483            'message' => "Could not create message: ".$mime_result->getMessage()),
1484            TRUE, FALSE);
1485        return false;
1486      }
1487      $msg_body = fopen($body_file, 'r');
1488    } else {
1489      $msg_body = $message->get();
1490    }
1491
1492    // send message
1493    if (!is_object($RCMAIL->smtp))
1494      $RCMAIL->smtp_init(true);
1495
1496    $sent = $RCMAIL->smtp->send_mail($from, $a_recipients, $smtp_headers, $msg_body, $smtp_opts);
1497    $smtp_response = $RCMAIL->smtp->get_response();
1498    $smtp_error = $RCMAIL->smtp->get_error();
1499
1500    // log error
1501    if (!$sent)
1502      raise_error(array('code' => 800, 'type' => 'smtp', 'line' => __LINE__, 'file' => __FILE__,
1503                        'message' => "SMTP error: ".join("\n", $smtp_response)), TRUE, FALSE);
1504  }
1505  // send mail using PHP's mail() function
1506  else {
1507    // unset some headers because they will be added by the mail() function
1508    $headers_enc = $message->headers($headers);
1509    $headers_php = $message->_headers;
1510    unset($headers_php['To'], $headers_php['Subject']);
1511
1512    // reset stored headers and overwrite
1513    $message->_headers = array();
1514    $header_str = $message->txtHeaders($headers_php);
1515
1516    // #1485779
1517    if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1518      if (preg_match_all('/<([^@]+@[^>]+)>/', $headers_enc['To'], $m)) {
1519        $headers_enc['To'] = implode(', ', $m[1]);
1520      }
1521    }
1522
1523    $msg_body = $message->get();
1524
1525    if (PEAR::isError($msg_body))
1526      raise_error(array('code' => 600, 'type' => 'php',
1527            'file' => __FILE__, 'line' => __LINE__,
1528            'message' => "Could not create message: ".$msg_body->getMessage()),
1529            TRUE, FALSE);
1530    else {
1531      $delim   = $RCMAIL->config->header_delimiter();
1532      $to      = $headers_enc['To'];
1533      $subject = $headers_enc['Subject'];
1534      $header_str = rtrim($header_str);
1535
1536      if ($delim != "\r\n") {
1537        $header_str = str_replace("\r\n", $delim, $header_str);
1538        $msg_body   = str_replace("\r\n", $delim, $msg_body);
1539        $to         = str_replace("\r\n", $delim, $to);
1540        $subject    = str_replace("\r\n", $delim, $subject);
1541      }
1542
1543      if (ini_get('safe_mode'))
1544        $sent = mail($to, $subject, $msg_body, $header_str);
1545      else
1546        $sent = mail($to, $subject, $msg_body, $header_str, "-f$from");
1547    }
1548  }
1549
1550  if ($sent) {
1551    $RCMAIL->plugins->exec_hook('message_sent', array('headers' => $headers, 'body' => $msg_body));
1552
1553    // remove MDN headers after sending
1554    unset($headers['Return-Receipt-To'], $headers['Disposition-Notification-To']);
1555
1556    // get all recipients
1557    if ($headers['Cc'])
1558      $mailto .= $headers['Cc'];
1559    if ($headers['Bcc'])
1560      $mailto .= $headers['Bcc'];
1561    if (preg_match_all('/<([^@]+@[^>]+)>/', $mailto, $m))
1562      $mailto = implode(', ', array_unique($m[1]));
1563
1564    if ($CONFIG['smtp_log']) {
1565      write_log('sendmail', sprintf("User %s [%s]; Message for %s; %s",
1566        $RCMAIL->user->get_username(),
1567        $_SERVER['REMOTE_ADDR'],
1568        $mailto,
1569        !empty($smtp_response) ? join('; ', $smtp_response) : ''));
1570    }
1571  }
1572
1573  if (is_resource($msg_body)) {
1574    fclose($msg_body);
1575  }
1576
1577  $message->_headers = array();
1578  $message->headers($headers);
1579
1580  return $sent;
1581}
1582
1583/**
1584 * Send the MDN response
1585 *
1586 * @param mixed $message    Original message object (rcube_message) or UID
1587 * @param array $smtp_error SMTP error array (reference)
1588 *
1589 * @return boolean Send status
1590 */
1591function rcmail_send_mdn($message, &$smtp_error)
1592{
1593  global $RCMAIL, $IMAP;
1594
1595  if (!is_a($message, rcube_message))
1596    $message = new rcube_message($message);
1597
1598  if ($message->headers->mdn_to && !$message->headers->mdn_sent &&
1599    ($IMAP->check_permflag('MDNSENT') || $IMAP->check_permflag('*')))
1600  {
1601    $identity = $RCMAIL->user->get_identity();
1602    $sender = format_email_recipient($identity['email'], $identity['name']);
1603    $recipient = array_shift($IMAP->decode_address_list($message->headers->mdn_to));
1604    $mailto = $recipient['mailto'];
1605
1606    $compose = new Mail_mime("\r\n");
1607
1608    $compose->setParam('text_encoding', 'quoted-printable');
1609    $compose->setParam('html_encoding', 'quoted-printable');
1610    $compose->setParam('head_encoding', 'quoted-printable');
1611    $compose->setParam('head_charset', RCMAIL_CHARSET);
1612    $compose->setParam('html_charset', RCMAIL_CHARSET);
1613    $compose->setParam('text_charset', RCMAIL_CHARSET);
1614
1615    // compose headers array
1616    $headers = array(
1617      'Date' => rcmail_user_date(),
1618      'From' => $sender,
1619      'To'   => $message->headers->mdn_to,
1620      'Subject' => rcube_label('receiptread') . ': ' . $message->subject,
1621      'Message-ID' => rcmail_gen_message_id(),
1622      'X-Sender' => $identity['email'],
1623      'References' => trim($message->headers->references . ' ' . $message->headers->messageID),
1624    );
1625
1626    if ($agent = $RCMAIL->config->get('useragent'))
1627      $headers['User-Agent'] = $agent;
1628
1629    $body = rcube_label("yourmessage") . "\r\n\r\n" .
1630      "\t" . rcube_label("to") . ': ' . rcube_imap::decode_mime_string($message->headers->to, $message->headers->charset) . "\r\n" .
1631      "\t" . rcube_label("subject") . ': ' . $message->subject . "\r\n" .
1632      "\t" . rcube_label("sent") . ': ' . format_date($message->headers->date, $RCMAIL->config->get('date_long')) . "\r\n" .
1633      "\r\n" . rcube_label("receiptnote") . "\r\n";
1634
1635    $ua = $RCMAIL->config->get('useragent', "Roundcube Webmail (Version ".RCMAIL_VERSION.")");
1636    $report = "Reporting-UA: $ua\r\n";
1637
1638    if ($message->headers->to)
1639        $report .= "Original-Recipient: {$message->headers->to}\r\n";
1640
1641    $report .= "Final-Recipient: rfc822; {$identity['email']}\r\n" .
1642               "Original-Message-ID: {$message->headers->messageID}\r\n" .
1643               "Disposition: manual-action/MDN-sent-manually; displayed\r\n";
1644
1645    $compose->headers($headers);
1646    $compose->setContentType('multipart/report', array('report-type'=> 'disposition-notification'));
1647    $compose->setTXTBody(rc_wordwrap($body, 75, "\r\n"));
1648    $compose->addAttachment($report, 'message/disposition-notification', 'MDNPart2.txt', false, '7bit', 'inline');
1649
1650    $sent = rcmail_deliver_message($compose, $identity['email'], $mailto, $smtp_error, $body_file);
1651
1652    if ($sent)
1653    {
1654      $IMAP->set_flag($message->uid, 'MDNSENT');
1655      return true;
1656    }
1657  }
1658
1659  return false;
1660}
1661
1662// Returns unique Message-ID
1663function rcmail_gen_message_id()
1664{
1665  global $RCMAIL;
1666
1667  $local_part  = md5(uniqid('rcmail'.mt_rand(),true));
1668  $domain_part = $RCMAIL->user->get_username('domain');
1669
1670  // Try to find FQDN, some spamfilters doesn't like 'localhost' (#1486924)
1671  if (!preg_match('/\.[a-z]+$/i', $domain_part)) {
1672    if (($host = preg_replace('/:[0-9]+$/', '', $_SERVER['HTTP_HOST']))
1673      && preg_match('/\.[a-z]+$/i', $host)) {
1674        $domain_part = $host;
1675    }
1676    else if (($host = preg_replace('/:[0-9]+$/', '', $_SERVER['SERVER_NAME']))
1677      && preg_match('/\.[a-z]+$/i', $host)) {
1678        $domain_part = $host;
1679    }
1680  }
1681
1682  return sprintf('<%s@%s>', $local_part, $domain_part);
1683}
1684
1685// Returns RFC2822 formatted current date in user's timezone
1686function rcmail_user_date()
1687{
1688  global $CONFIG;
1689
1690  // get user's timezone
1691  if ($CONFIG['timezone'] === 'auto') {
1692    $tz = isset($_SESSION['timezone']) ? $_SESSION['timezone'] : date('Z')/3600;
1693  }
1694  else {
1695    $tz = $CONFIG['timezone'];
1696    if ($CONFIG['dst_active'])
1697      $tz++;
1698  }
1699
1700  $date = time() + $tz * 60 * 60;
1701  $date = gmdate('r', $date);
1702  $tz   = sprintf('%+05d', intval($tz) * 100 + ($tz - intval($tz)) * 60);
1703  $date = preg_replace('/[+-][0-9]{4}$/', $tz, $date);
1704
1705  return $date;
1706}
1707
1708// Fixes some content-type names
1709function rcmail_fix_mimetype($name)
1710{
1711  // Some versions of Outlook create garbage Content-Type:
1712  // application/pdf.A520491B_3BF7_494D_8855_7FAC2C6C0608
1713  if (preg_match('/^application\/pdf.+/', $name))
1714    $name = 'application/pdf';
1715
1716  return $name;
1717}
1718
1719function rcmail_search_filter($attrib)
1720{
1721  global $OUTPUT, $CONFIG;
1722
1723  if (!strlen($attrib['id']))
1724    $attrib['id'] = 'rcmlistfilter';
1725
1726  $attrib['onchange'] = JS_OBJECT_NAME.'.filter_mailbox(this.value)';
1727
1728  /*
1729    RFC3501 (6.4.4): 'ALL', 'RECENT',
1730    'ANSWERED', 'DELETED', 'FLAGGED', 'SEEN',
1731    'UNANSWERED', 'UNDELETED', 'UNFLAGGED', 'UNSEEN',
1732    'NEW', // = (RECENT UNSEEN)
1733    'OLD' // = NOT RECENT
1734  */
1735
1736  $select_filter = new html_select($attrib);
1737  $select_filter->add(rcube_label('all'), 'ALL');
1738  $select_filter->add(rcube_label('unread'), 'UNSEEN');
1739  $select_filter->add(rcube_label('flagged'), 'FLAGGED');
1740  $select_filter->add(rcube_label('unanswered'), 'UNANSWERED');
1741  if (!$CONFIG['skip_deleted'])
1742    $select_filter->add(rcube_label('deleted'), 'DELETED');
1743
1744  $out = $select_filter->show($_SESSION['search_filter']);
1745
1746  $OUTPUT->add_gui_object('search_filter', $attrib['id']);
1747
1748  return $out;
1749}
1750
1751function rcmail_message_error($uid=null)
1752{
1753  global $RCMAIL;
1754
1755  // Set env variables for messageerror.html template
1756  if ($RCMAIL->action == 'show') {
1757    $mbox_name = $RCMAIL->imap->get_mailbox_name();
1758    $RCMAIL->output->set_env('mailbox', $mbox_name);
1759    $RCMAIL->output->set_env('uid', null);
1760  }
1761  // display error message
1762  $RCMAIL->output->show_message('messageopenerror', 'error');
1763  // ... display message error page
1764  $RCMAIL->output->send('messageerror');
1765}
1766
1767// register UI objects
1768$OUTPUT->add_handlers(array(
1769  'mailboxlist' => 'rcmail_mailbox_list',
1770  'messages' => 'rcmail_message_list',
1771  'messagecountdisplay' => 'rcmail_messagecount_display',
1772  'quotadisplay' => 'rcmail_quota_display',
1773  'mailboxname' => 'rcmail_mailbox_name_display',
1774  'messageheaders' => 'rcmail_message_headers',
1775  'messagefullheaders' => 'rcmail_message_full_headers',
1776  'messagebody' => 'rcmail_message_body',
1777  'messagecontentframe' => 'rcmail_messagecontent_frame',
1778  'messagepartframe' => 'rcmail_message_part_frame',
1779  'messagepartcontrols' => 'rcmail_message_part_controls',
1780  'searchfilter' => 'rcmail_search_filter',
1781  'searchform' => array($OUTPUT, 'search_form'),
1782));
1783
1784// register action aliases
1785$RCMAIL->register_action_map(array(
1786    'preview' => 'show.inc',
1787    'print'   => 'show.inc',
1788    'moveto'  => 'move_del.inc',
1789    'delete'  => 'move_del.inc',
1790    'send'    => 'sendmail.inc',
1791    'expunge' => 'folders.inc',
1792    'purge'   => 'folders.inc',
1793    'remove-attachment'  => 'attachments.inc',
1794    'display-attachment' => 'attachments.inc',
1795    'upload'             => 'attachments.inc',
1796    'group-expand'       => 'autocomplete.inc',
1797));
Note: See TracBrowser for help on using the repository browser.