program/steps/mail/func.inc

   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, Roundcube Dev. - Switzerland                 |
   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: func.inc 4389 2011-01-04 11:16:54Z alec $
  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('*' => array('subject'=>1, 'from'=>1), $SENT_MBOX => array('subject'=>1, 'to'=>1), $DRAFTS_MBOX => array('subject'=>1, 'to'=>1));
  26
  27 // Simplified for IDN in Unicode
  28 //$EMAIL_ADDRESS_PATTERN = '([a-z0-9][a-z0-9\-\.\+\_]*@[a-z0-9][a-z0-9\-\.]*\\.[a-z]{2,5})';
  29 $EMAIL_ADDRESS_PATTERN = '([a-z0-9][a-z0-9\-\.\+\_]*@[^&@"\'.][^@&"\']*\\.[a-z]{2,5})';
  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
  38 if (!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
  49 if (strlen(trim($mbox = get_input_value('_mbox', RCUBE_INPUT_GPC, true))))
  50   $IMAP->set_mailbox(($_SESSION['mbox'] = $mbox));
  51 else if ($IMAP)
  52   $_SESSION['mbox'] = $IMAP->get_mailbox_name();
  53
  54 if (!empty($_GET['_page']))
  55   $IMAP->set_page(($_SESSION['page'] = intval($_GET['_page'])));
  56
  57 // set default sort col/order to session
  58 if (!isset($_SESSION['sort_col']))
  59   $_SESSION['sort_col'] = $CONFIG['message_sort_col'];
  60 if (!isset($_SESSION['sort_order']))
  61   $_SESSION['sort_order'] = $CONFIG['message_sort_order'];
  62
  63 // set threads mode
  64 $a_threading = $RCMAIL->config->get('message_threading', array());
  65 if (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
  75 if (!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
  84 if (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($mbox_name));
 134 }
 135
 136
 137 /**
 138  * return the message list as HTML table
 139  */
 140 function 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  */
 205 function 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 = abbreviate_string(trim($IMAP->decode_header($header->$col)), 160);
 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  */
 338 function 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  */
 403 function 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
 420 function 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
 435 function 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
 461 function 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
 474 function rcmail_get_mailbox_name_text()
 475 {
 476   global $RCMAIL;
 477   return rcmail_localize_foldername($RCMAIL->imap->get_mailbox_name());
 478 }
 479
 480
 481 function 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
 501 function 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
 513 function 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  */
 527 function 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  */
 559 function 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   // turn relative into absolute urls
 611   $html = rcmail_resolve_base($html);
 612
 613   // clean HTML with washhtml by Frederic Motte
 614   $wash_opts = array(
 615     'show_washed' => false,
 616     'allow_remote' => $p['safe'],
 617     'blocked_src' => "./program/blocked.gif",
 618     'charset' => RCMAIL_CHARSET,
 619     'cid_map' => $cid_replaces,
 620     'html_elements' => array('body'),
 621   );
 622
 623   if (!$p['inline_html']) {
 624     $wash_opts['html_elements'] = array('html','head','title','body');
 625   }
 626   if ($p['safe']) {
 627     $wash_opts['html_elements'][] = 'link';
 628     $wash_opts['html_attribs'] = array('rel','type');
 629   }
 630
 631   // overwrite washer options with options from plugins
 632   if (isset($p['html_elements']))
 633     $wash_opts['html_elements'] = $p['html_elements'];
 634   if (isset($p['html_attribs']))
 635     $wash_opts['html_attribs'] = $p['html_attribs'];
 636
 637   // initialize HTML washer
 638   $washer = new washtml($wash_opts);
 639
 640   if (!$p['skip_washer_form_callback'])
 641     $washer->add_callback('form', 'rcmail_washtml_callback');
 642
 643   // allow CSS styles, will be sanitized by rcmail_washtml_callback()
 644   if (!$p['skip_washer_style_callback'])
 645     $washer->add_callback('style', 'rcmail_washtml_callback');
 646
 647   $html = $washer->wash($html);
 648   $REMOTE_OBJECTS = $washer->extlinks;
 649
 650   return $html;
 651 }
 652
 653
 654 /**
 655  * Convert the given message part to proper HTML
 656  * which can be displayed the message view
 657  *
 658  * @param object rcube_message_part Message part
 659  * @param array  Display parameters array
 660  * @return string Formatted HTML string
 661  */
 662 function rcmail_print_body($part, $p = array())
 663 {
 664   global $RCMAIL;
 665
 666   // trigger plugin hook
 667   $data = $RCMAIL->plugins->exec_hook('message_part_before',
 668     array('type' => $part->ctype_secondary, 'body' => $part->body) + $p + array('safe' => false, 'plain' => false, 'inline_html' => true));
 669
 670   // convert html to text/plain
 671   if ($data['type'] == 'html' && $data['plain']) {
 672     $txt = new html2text($data['body'], false, true);
 673     $body = $txt->get_text();
 674     $part->ctype_secondary = 'plain';
 675   }
 676   // text/html
 677   else if ($data['type'] == 'html') {
 678     $body = rcmail_wash_html($data['body'], $data, $part->replaces);
 679     $part->ctype_secondary = $data['type'];
 680   }
 681   // text/enriched
 682   else if ($data['type'] == 'enriched') {
 683     $part->ctype_secondary = 'html';
 684     require_once('lib/enriched.inc');
 685     $body = Q(enriched_to_html($data['body']), 'show');
 686   }
 687   else {
 688     // assert plaintext
 689     $body = $part->body;
 690     $part->ctype_secondary = $data['type'] = 'plain';
 691   }
 692
 693   // free some memory (hopefully)
 694   unset($data['body']);
 695
 696   // plaintext postprocessing
 697   if ($part->ctype_secondary == 'plain')
 698     $body = rcmail_plain_body($body, $part->ctype_parameters['format'] == 'flowed');
 699
 700   // allow post-processing of the message body
 701   $data = $RCMAIL->plugins->exec_hook('message_part_after', array('type' => $part->ctype_secondary, 'body' => $body) + $data);
 702
 703   return $data['type'] == 'html' ? $data['body'] : html::tag('pre', array(), $data['body']);
 704 }
 705
 706
 707 /**
 708  * Handle links and citation marks in plain text message
 709  *
 710  * @param string  Plain text string
 711  * @param boolean Text uses format=flowed
 712  *
 713  * @return string Formatted HTML string
 714  */
 715 function rcmail_plain_body($body, $flowed=false)
 716 {
 717   global $RCMAIL;
 718
 719   // make links and email-addresses clickable
 720   $replacer = new rcube_string_replacer;
 721
 722   // search for patterns like links and e-mail addresses
 723   $body = preg_replace_callback($replacer->link_pattern, array($replacer, 'link_callback'), $body);
 724   $body = preg_replace_callback($replacer->mailto_pattern, array($replacer, 'mailto_callback'), $body);
 725
 726   // split body into single lines
 727   $a_lines = preg_split('/\r?\n/', $body);
 728   $quote_level = 0;
 729   $last = -1;
 730
 731   // find/mark quoted lines...
 732   for ($n=0, $cnt=count($a_lines); $n < $cnt; $n++) {
 733     if ($a_lines[$n][0] == '>' && preg_match('/^(>+\s*)+/', $a_lines[$n], $regs)) {
 734       $q = strlen(preg_replace('/\s/', '', $regs[0]));
 735       $a_lines[$n] = substr($a_lines[$n], strlen($regs[0]));
 736
 737       if ($q > $quote_level)
 738         $a_lines[$n] = $replacer->get_replacement($replacer->add(
 739           str_repeat('<blockquote>', $q - $quote_level))) . $a_lines[$n];
 740       else if ($q < $quote_level)
 741         $a_lines[$n] = $replacer->get_replacement($replacer->add(
 742           str_repeat('</blockquote>', $quote_level - $q))) . $a_lines[$n];
 743       else if ($flowed) {
 744         // previous line is flowed
 745         if (isset($a_lines[$last]) && $a_lines[$n]
 746           && $a_lines[$last][strlen($a_lines[$last])-1] == ' ') {
 747           // merge lines
 748           $a_lines[$last] .= $a_lines[$n];
 749           unset($a_lines[$n]);
 750         }
 751         else
 752           $last = $n;
 753       }
 754     }
 755     else {
 756       $q = 0;
 757       if ($flowed) {
 758         // sig separator - line is fixed
 759         if ($a_lines[$n] == '-- ') {
 760           $last = $n;
 761         }
 762         else {
 763           // remove space-stuffing
 764           if ($a_lines[$n][0] == ' ')
 765             $a_lines[$n] = substr($a_lines[$n], 1);
 766
 767           // previous line is flowed?
 768           if (isset($a_lines[$last]) && $a_lines[$n]
 769             && $a_lines[$last] != '-- '
 770             && $a_lines[$last][strlen($a_lines[$last])-1] == ' '
 771           ) {
 772             $a_lines[$last] .= $a_lines[$n];
 773             unset($a_lines[$n]);
 774           }
 775           else {
 776             $last = $n;
 777           }
 778         }
 779         if ($quote_level > 0)
 780           $a_lines[$last] = $replacer->get_replacement($replacer->add(
 781             str_repeat('</blockquote>', $quote_level))) . $a_lines[$last];
 782       }
 783       else if ($quote_level > 0)
 784         $a_lines[$n] = $replacer->get_replacement($replacer->add(
 785           str_repeat('</blockquote>', $quote_level))) . $a_lines[$n];
 786     }
 787
 788     $quote_level = $q;
 789   }
 790
 791   $body = join("\n", $a_lines);
 792
 793   // quote plain text (don't use Q() here, to display entities "as is")
 794   $table = get_html_translation_table(HTML_SPECIALCHARS);
 795   unset($table['?']);
 796   $body = strtr($body, $table);
 797
 798   // colorize signature (up to <sig_max_lines> lines)
 799   $len = strlen($body);
 800   $sig_max_lines = $RCMAIL->config->get('sig_max_lines', 15);
 801   while (($sp = strrpos($body, "-- \n", $sp ? -$len+$sp-1 : 0)) !== false) {
 802     if ($sp == 0 || $body[$sp-1] == "\n") {
 803       // do not touch blocks with more that X lines
 804       if (substr_count($body, "\n", $sp) < $sig_max_lines)
 805         $body = substr($body, 0, max(0, $sp))
 806           .'<span class="sig">'.substr($body, $sp).'</span>';
 807       break;
 808     }
 809   }
 810
 811   // insert url/mailto links and citation tags
 812   $body = $replacer->resolve($body);
 813
 814   return $body;
 815 }
 816
 817
 818 /**
 819  * Callback function for washtml cleaning class
 820  */
 821 function rcmail_washtml_callback($tagname, $attrib, $content)
 822 {
 823   switch ($tagname) {
 824     case 'form':
 825       $out = html::div('form', $content);
 826       break;
 827
 828     case 'style':
 829       // decode all escaped entities and reduce to ascii strings
 830       $stripped = preg_replace('/[^a-zA-Z\(:]/', '', rcmail_xss_entity_decode($content));
 831
 832       // now check for evil strings like expression, behavior or url()
 833       if (!preg_match('/expression|behavior|url\(|import/', $stripped)) {
 834         $out = html::tag('style', array('type' => 'text/css'), $content);
 835         break;
 836       }
 837
 838     default:
 839       $out = '';
 840   }
 841
 842   return $out;
 843 }
 844
 845
 846 /**
 847  * Callback function for HTML tags fixing
 848  */
 849 function rcmail_html_tag_callback($matches)
 850 {
 851   $tagname = $matches[2];
 852
 853   $tagname = preg_replace(array(
 854     '/:.*$/',                   // Microsoft's Smart Tags <st1:xxxx>
 855     '/[^a-z0-9_\[\]\!-]/i',     // forbidden characters
 856     ), '', $tagname);
 857
 858   return $matches[1].$tagname;
 859 }
 860
 861
 862 /**
 863  * return table with message headers
 864  */
 865 function rcmail_message_headers($attrib, $headers=NULL)
 866   {
 867   global $IMAP, $OUTPUT, $MESSAGE, $PRINT_MODE, $RCMAIL;
 868   static $sa_attrib;
 869
 870   // keep header table attrib
 871   if (is_array($attrib) && !$sa_attrib)
 872     $sa_attrib = $attrib;
 873   else if (!is_array($attrib) && is_array($sa_attrib))
 874     $attrib = $sa_attrib;
 875
 876   if (!isset($MESSAGE))
 877     return FALSE;
 878
 879   // get associative array of headers object
 880   if (!$headers)
 881     $headers = is_object($MESSAGE->headers) ? get_object_vars($MESSAGE->headers) : $MESSAGE->headers;
 882
 883   // show these headers
 884   $standard_headers = array('subject', 'from', 'to', 'cc', 'bcc', 'replyto',
 885     'mail-reply-to', 'mail-followup-to', 'date');
 886   $output_headers = array();
 887
 888   foreach ($standard_headers as $hkey) {
 889     if ($headers[$hkey])
 890       $value = $headers[$hkey];
 891     else if ($headers['others'][$hkey])
 892       $value = $headers['others'][$hkey];
 893     else
 894       continue;
 895
 896     if ($hkey == 'date') {
 897       if ($PRINT_MODE)
 898         $header_value = format_date($value, $RCMAIL->config->get('date_long', 'x'));
 899       else
 900         $header_value = format_date($value);
 901     }
 902     else if ($hkey == 'replyto') {
 903       if ($headers['replyto'] != $headers['from'])
 904         $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
 905       else
 906         continue;
 907     }
 908     else if ($hkey == 'mail-reply-to') {
 909       if ($headers['mail-replyto'] != $headers['reply-to']
 910         && $headers['reply-to'] != $headers['from']
 911       )
 912         $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
 913       else
 914         continue;
 915     }
 916     else if ($hkey == 'mail-followup-to') {
 917       $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
 918     }
 919     else if (in_array($hkey, array('from', 'to', 'cc', 'bcc')))
 920       $header_value = rcmail_address_string($value, null, true, $attrib['addicon']);
 921     else if ($hkey == 'subject' && empty($value))
 922       $header_value = rcube_label('nosubject');
 923     else
 924       $header_value = trim($IMAP->decode_header($value));
 925
 926     $output_headers[$hkey] = array(
 927         'title' => rcube_label(preg_replace('/(^mail-|-)/', '', $hkey)),
 928         'value' => $header_value, 'raw' => $value
 929     );
 930   }
 931
 932   $plugin = $RCMAIL->plugins->exec_hook('message_headers_output',
 933     array('output' => $output_headers, 'headers' => $MESSAGE->headers));
 934
 935   // compose html table
 936   $table = new html_table(array('cols' => 2));
 937
 938   foreach ($plugin['output'] as $hkey => $row) {
 939     $table->add(array('class' => 'header-title'), Q($row['title']));
 940     $table->add(array('class' => 'header '.$hkey), Q($row['value'], ($hkey == 'subject' ? 'strict' : 'show')));
 941   }
 942
 943   // all headers division
 944   $table->add(array('colspan' => 2, 'class' => "more-headers show-headers", 'onclick' => "return ".JS_OBJECT_NAME.".command('load-headers','',this)"), '');
 945   $table->add_row(array('id' => "all-headers"));
 946   $table->add(array('colspan' => 2, 'class' => "all"), html::div(array('id' => 'headers-source'), ''));
 947
 948   $OUTPUT->add_gui_object('all_headers_row', 'all-headers');
 949   $OUTPUT->add_gui_object('all_headers_box', 'headers-source');
 950
 951   return $table->show($attrib);
 952   }
 953
 954
 955 /**
 956  * Handler for the 'messagebody' GUI object
 957  *
 958  * @param array Named parameters
 959  * @return string HTML content showing the message body
 960  */
 961 function rcmail_message_body($attrib)
 962   {
 963   global $CONFIG, $OUTPUT, $MESSAGE, $IMAP, $RCMAIL, $REMOTE_OBJECTS;
 964
 965   if (!is_array($MESSAGE->parts) && empty($MESSAGE->body))
 966     return '';
 967
 968   if (!$attrib['id'])
 969     $attrib['id'] = 'rcmailMsgBody';
 970
 971   $safe_mode = $MESSAGE->is_safe || intval($_GET['_safe']);
 972   $out = '';
 973
 974   $header_attrib = array();
 975   foreach ($attrib as $attr => $value)
 976     if (preg_match('/^headertable([a-z]+)$/i', $attr, $regs))
 977       $header_attrib[$regs[1]] = $value;
 978
 979   if (!empty($MESSAGE->parts))
 980     {
 981     foreach ($MESSAGE->parts as $i => $part)
 982       {
 983       if ($part->type == 'headers')
 984         $out .= rcmail_message_headers(sizeof($header_attrib) ? $header_attrib : NULL, $part->headers);
 985       else if ($part->type == 'content' && $part->size)
 986         {
 987         if (empty($part->ctype_parameters) || empty($part->ctype_parameters['charset']))
 988           $part->ctype_parameters['charset'] = $MESSAGE->headers->charset;
 989
 990         // fetch part if not available
 991         if (!isset($part->body))
 992           $part->body = $MESSAGE->get_part_content($part->mime_id);
 993
 994         // message is cached but not exists (#1485443), or other error
 995         if ($part->body === false) {
 996           rcmail_message_error($MESSAGE->uid);
 997         }
 998
 999         $plugin = $RCMAIL->plugins->exec_hook('message_body_prefix', array(
1000           'part' => $part, 'prefix' => ''));
1001
1002         $body = rcmail_print_body($part, array('safe' => $safe_mode, 'plain' => !$CONFIG['prefer_html']));
1003
1004         if ($part->ctype_secondary == 'html') {
1005           $body = rcmail_html4inline($body, $attrib['id'], 'rcmBody', $attrs);
1006           $div_attr = array('class' => 'message-htmlpart');
1007           $style = array();
1008
1009           if (!empty($attrs)) {
1010             foreach ($attrs as $a_idx => $a_val)
1011               $style[] = $a_idx . ': ' . $a_val;
1012             if (!empty($style))
1013               $div_attr['style'] = implode('; ', $style);
1014           }
1015
1016           $out .= html::div($div_attr, $plugin['prefix'] . $body);
1017         }
1018         else
1019           $out .= html::div('message-part', $plugin['prefix'] . $body);
1020         }
1021       }
1022     }
1023   else {
1024     $plugin = $RCMAIL->plugins->exec_hook('message_body_prefix', array(
1025       'part' => $MESSAGE, 'prefix' => ''));
1026
1027     $out .= html::div('message-part', $plugin['prefix'] . html::tag('pre', array(),
1028       rcmail_plain_body(Q($MESSAGE->body, 'strict', false))));
1029     }
1030
1031   $ctype_primary = strtolower($MESSAGE->structure->ctype_primary);
1032   $ctype_secondary = strtolower($MESSAGE->structure->ctype_secondary);
1033
1034   // list images after mail body
1035   if ($CONFIG['inline_images']
1036       && $ctype_primary == 'multipart'
1037       && !empty($MESSAGE->attachments))
1038     {
1039     foreach ($MESSAGE->attachments as $attach_prop) {
1040       // Content-Type: image/*...
1041       if (preg_match('/^image\//i', $attach_prop->mimetype) ||
1042         // ...or known file extension: many clients are using application/octet-stream
1043         ($attach_prop->filename &&
1044           preg_match('/^application\/octet-stream$/i', $attach_prop->mimetype) &&
1045           preg_match('/\.(jpg|jpeg|png|gif|bmp)$/i', $attach_prop->filename))
1046       ) {
1047         $out .= html::tag('hr') . html::p(array('align' => "center"),
1048           html::img(array(
1049             'src' => $MESSAGE->get_part_url($attach_prop->mime_id),
1050             'title' => $attach_prop->filename,
1051             'alt' => $attach_prop->filename,
1052           )));
1053         }
1054     }
1055   }
1056
1057   // tell client that there are blocked remote objects
1058   if ($REMOTE_OBJECTS && !$safe_mode)
1059     $OUTPUT->set_env('blockedobjects', true);
1060
1061   return html::div($attrib, $out);
1062   }
1063
1064
1065 /**
1066  * Convert all relative URLs according to a <base> in HTML
1067  */
1068 function rcmail_resolve_base($body)
1069 {
1070   // check for <base href=...>
1071   if (preg_match('!(<base.*href=["\']?)([hftps]{3,5}://[a-z0-9/.%-]+)!i', $body, $regs)) {
1072     $replacer = new rcube_base_replacer($regs[2]);
1073
1074     // replace all relative paths
1075     $body = preg_replace_callback('/(src|background|href)=(["\']?)([\.\/]+[^"\'\s]+)(\2|\s|>)/Ui', array($replacer, 'callback'), $body);
1076     $body = preg_replace_callback('/(url\s*\()(["\']?)([\.\/]+[^"\'\)\s]+)(\2)\)/Ui', array($replacer, 'callback'), $body);
1077   }
1078
1079   return $body;
1080 }
1081
1082 /**
1083  * modify a HTML message that it can be displayed inside a HTML page
1084  */
1085 function rcmail_html4inline($body, $container_id, $body_id='', &$attributes=null)
1086 {
1087   $last_style_pos = 0;
1088   $body_lc = strtolower($body);
1089   $cont_id = $container_id.($body_id ? ' div.'.$body_id : '');
1090
1091   // find STYLE tags
1092   while (($pos = strpos($body_lc, '<style', $last_style_pos)) && ($pos2 = strpos($body_lc, '</style>', $pos)))
1093   {
1094     $pos = strpos($body_lc, '>', $pos)+1;
1095
1096     // replace all css definitions with #container [def]
1097     $styles = rcmail_mod_css_styles(
1098       substr($body, $pos, $pos2-$pos), $cont_id);
1099
1100     $body = substr($body, 0, $pos) . $styles . substr($body, $pos2);
1101     $body_lc = strtolower($body);
1102     $last_style_pos = $pos2;
1103   }
1104
1105   // modify HTML links to open a new window if clicked
1106   $GLOBALS['rcmail_html_container_id'] = $container_id;
1107   $body = preg_replace_callback('/<(a|link)\s+([^>]+)>/Ui', 'rcmail_alter_html_link', $body);
1108   unset($GLOBALS['rcmail_html_container_id']);
1109
1110   $body = preg_replace(array(
1111       // add comments arround html and other tags
1112       '/(<!DOCTYPE[^>]*>)/i',
1113       '/(<\?xml[^>]*>)/i',
1114       '/(<\/?html[^>]*>)/i',
1115       '/(<\/?head[^>]*>)/i',
1116       '/(<title[^>]*>.*<\/title>)/Ui',
1117       '/(<\/?meta[^>]*>)/i',
1118       // quote <? of php and xml files that are specified as text/html
1119       '/<\?/',
1120       '/\?>/',
1121       // replace <body> with <div>
1122       '/<body([^>]*)>/i',
1123       '/<\/body>/i',
1124       ),
1125     array(
1126       '<!--\\1-->',
1127       '<!--\\1-->',
1128       '<!--\\1-->',
1129       '<!--\\1-->',
1130       '<!--\\1-->',
1131       '<!--\\1-->',
1132       '&lt;?',
1133       '?&gt;',
1134       '<div class="'.$body_id.'"\\1>',
1135       '</div>',
1136       ),
1137     $body);
1138
1139   $attributes = array();
1140
1141   // Handle body attributes that doesn't play nicely with div elements
1142   $regexp = '/<div class="' . preg_quote($body_id, '/') . '"([^>]*)/';
1143   if (preg_match($regexp, $body, $m)) {
1144     $attrs = $m[0];
1145     // Get bgcolor, we'll set it as background-color of the message container
1146     if ($m[1] && preg_match('/bgcolor=["\']*([a-z0-9#]+)["\']*/', $attrs, $mb)) {
1147       $attributes['background-color'] = $mb[1];
1148       $attrs = preg_replace('/bgcolor=["\']*([a-z0-9#]+)["\']*/', '', $attrs);
1149     }
1150     // Get background, we'll set it as background-image of the message container
1151     if ($m[1] && preg_match('/background=["\']*([^"\'>\s]+)["\']*/', $attrs, $mb)) {
1152       $attributes['background-image'] = 'url('.$mb[1].')';
1153       $attrs = preg_replace('/background=["\']*([^"\'>\s]+)["\']*/', '', $attrs);
1154     }
1155     if (!empty($attributes)) {
1156       $body = preg_replace($regexp, rtrim($attrs), $body, 1);
1157     }
1158
1159     // handle body styles related to background image
1160     if ($attributes['background-image']) {
1161       // get body style
1162       if (preg_match('/#'.preg_quote($cont_id, '/').'\s+\{([^}]+)}/i', $body, $m)) {
1163         // get background related style
1164         if (preg_match_all('/(background-position|background-repeat)\s*:\s*([^;]+);/i', $m[1], $ma, PREG_SET_ORDER)) {
1165           foreach ($ma as $style)
1166             $attributes[$style[1]] = $style[2];
1167         }
1168       }
1169     }
1170   }
1171   // make sure there's 'rcmBody' div, we need it for proper css modification
1172   // its name is hardcoded in rcmail_message_body() also
1173   else {
1174     $body = '<div class="' . $body_id . '">' . $body . '</div>';
1175   }
1176
1177   return $body;
1178 }
1179
1180
1181 /**
1182  * parse link attributes and set correct target
1183  */
1184 function rcmail_alter_html_link($matches)
1185 {
1186   global $EMAIL_ADDRESS_PATTERN;
1187
1188   $tag = $matches[1];
1189   $attrib = parse_attrib_string($matches[2]);
1190   $end = '>';
1191
1192   if ($tag == 'link' && preg_match('/^https?:\/\//i', $attrib['href'])) {
1193     $attrib['href'] = "?_task=utils&amp;_action=modcss&amp;u=" . urlencode($attrib['href'])
1194         . "&amp;c=" . urlencode($GLOBALS['rcmail_html_container_id']);
1195     $end = ' />';
1196   }
1197   else if (preg_match('/^mailto:'.$EMAIL_ADDRESS_PATTERN.'(\?[^"\'>]+)?/i', $attrib['href'], $mailto)) {
1198     $attrib['href'] = $mailto[0];
1199     $attrib['onclick'] = sprintf(
1200       "return %s.command('compose','%s',this)",
1201       JS_OBJECT_NAME,
1202       JQ($mailto[1].$mailto[2]));
1203   }
1204   else if (!empty($attrib['href']) && $attrib['href'][0] != '#') {
1205     $attrib['target'] = '_blank';
1206   }
1207
1208   return "<$tag" . html::attrib_string($attrib, array('href','name','target','onclick','id','class','style','title','rel','type','media')) . $end;
1209 }
1210
1211
1212 /**
1213  * decode address string and re-format it as HTML links
1214  */
1215 function rcmail_address_string($input, $max=null, $linked=false, $addicon=null)
1216 {
1217   global $IMAP, $RCMAIL, $PRINT_MODE, $CONFIG;
1218   static $got_writable_abook = null;
1219
1220   $a_parts = $IMAP->decode_address_list($input);
1221
1222   if (!sizeof($a_parts))
1223     return $input;
1224
1225   $c = count($a_parts);
1226   $j = 0;
1227   $out = '';
1228
1229   if ($got_writable_abook === null && $books = $RCMAIL->get_address_sources(true)) {
1230     $got_writable_abook = true;
1231   }
1232
1233   foreach ($a_parts as $part) {
1234     $j++;
1235
1236     $name   = $part['name'];
1237     $mailto = $part['mailto'];
1238     $string = $part['string'];
1239
1240     // IDNA ASCII to Unicode
1241     if ($name == $mailto)
1242       $name = idn_to_utf8($name);
1243     if ($string == $mailto)
1244       $string = idn_to_utf8($string);
1245     $mailto = idn_to_utf8($mailto);
1246
1247     if ($PRINT_MODE) {
1248       $out .= sprintf('%s &lt;%s&gt;', Q($name), $mailto);
1249     }
1250     else if (check_email($part['mailto'], false)) {
1251       if ($linked) {
1252         $out .= html::a(array(
1253             'href' => 'mailto:'.$mailto,
1254             'onclick' => sprintf("return %s.command('compose','%s',this)", JS_OBJECT_NAME, JQ($mailto)),
1255             'title' => $mailto,
1256             'class' => "rcmContactAddress",
1257           ),
1258         Q($name ? $name : $mailto));
1259       }
1260       else {
1261         $out .= html::span(array('title' => $mailto, 'class' => "rcmContactAddress"),
1262           Q($name ? $name : $mailto));
1263       }
1264
1265       if ($addicon && $got_writable_abook) {
1266         $out .= '&nbsp;' . html::a(array(
1267             'href' => "#add",
1268             'onclick' => sprintf("return %s.command('add-contact','%s',this)", JS_OBJECT_NAME, urlencode($string)),
1269             'title' => rcube_label('addtoaddressbook'),
1270           ),
1271           html::img(array(
1272             'src' => $CONFIG['skin_path'] . $addicon,
1273             'alt' => "Add contact",
1274           )));
1275       }
1276     }
1277     else {
1278       if ($name)
1279         $out .= Q($name);
1280       if ($mailto)
1281         $out .= (strlen($out) ? ' ' : '') . sprintf('&lt;%s&gt;', Q($mailto));
1282     }
1283
1284     if ($c>$j)
1285       $out .= ','.($max ? '&nbsp;' : ' ');
1286
1287     if ($max && $j==$max && $c>$j) {
1288       $out .= '...';
1289       break;
1290     }
1291   }
1292
1293   return $out;
1294 }
1295
1296
1297 /**
1298  * Wrap text to a given number of characters per line
1299  * but respect the mail quotation of replies messages (>).
1300  * Finally add another quotation level by prpending the lines
1301  * with >
1302  *
1303  * @param string Text to wrap
1304  * @param int The line width
1305  * @return string The wrapped text
1306  */
1307 function rcmail_wrap_and_quote($text, $length = 72)
1308 {
1309   // Rebuild the message body with a maximum of $max chars, while keeping quoted message.
1310   $max = min(77, $length + 8);
1311   $lines = preg_split('/\r?\n/', trim($text));
1312   $out = '';
1313
1314   foreach ($lines as $line) {
1315     // don't wrap already quoted lines
1316     if ($line[0] == '>')
1317       $line = '>' . rtrim($line);
1318     else if (mb_strlen($line) > $max) {
1319       $newline = '';
1320       foreach(explode("\n", rc_wordwrap($line, $length - 2)) as $l) {
1321         if (strlen($l))
1322           $newline .= '> ' . $l . "\n";
1323         else
1324           $newline .= ">\n";
1325       }
1326       $line = rtrim($newline);
1327     }
1328     else
1329       $line = '> ' . $line;
1330
1331     // Append the line
1332     $out .= $line . "\n";
1333   }
1334
1335   return $out;
1336 }
1337
1338
1339 function rcmail_draftinfo_encode($p)
1340 {
1341   $parts = array();
1342   foreach ($p as $key => $val)
1343     $parts[] = $key . '=' . ($key == 'folder' ? base64_encode($val) : $val);
1344
1345   return join('; ', $parts);
1346 }
1347
1348
1349 function rcmail_draftinfo_decode($str)
1350 {
1351   $info = array();
1352   foreach (preg_split('/;\s+/', $str) as $part) {
1353     list($key, $val) = explode('=', $part, 2);
1354     if ($key == 'folder')
1355       $val = base64_decode($val);
1356     $info[$key] = $val;
1357   }
1358
1359   return $info;
1360 }
1361
1362
1363 function rcmail_message_part_controls()
1364 {
1365   global $MESSAGE;
1366
1367   $part = asciiwords(get_input_value('_part', RCUBE_INPUT_GPC));
1368   if (!is_object($MESSAGE) || !is_array($MESSAGE->parts) || !($_GET['_uid'] && $_GET['_part']) || !$MESSAGE->mime_parts[$part])
1369     return '';
1370
1371   $part = $MESSAGE->mime_parts[$part];
1372   $table = new html_table(array('cols' => 3));
1373
1374   if (!empty($part->filename)) {
1375     $table->add('title', Q(rcube_label('filename')));
1376     $table->add(null, Q($part->filename));
1377     $table->add(null, '[' . html::a('?'.str_replace('_frame=', '_download=', $_SERVER['QUERY_STRING']), Q(rcube_label('download'))) . ']');
1378   }
1379
1380   if (!empty($part->size)) {
1381     $table->add('title', Q(rcube_label('filesize')));
1382     $table->add(null, Q(show_bytes($part->size)));
1383   }
1384
1385   return $table->show($attrib);
1386 }
1387
1388
1389
1390 function rcmail_message_part_frame($attrib)
1391 {
1392   global $MESSAGE;
1393
1394   $part = $MESSAGE->mime_parts[asciiwords(get_input_value('_part', RCUBE_INPUT_GPC))];
1395   $ctype_primary = strtolower($part->ctype_primary);
1396
1397   $attrib['src'] = './?' . str_replace('_frame=', ($ctype_primary=='text' ? '_show=' : '_preload='), $_SERVER['QUERY_STRING']);
1398
1399   return html::iframe($attrib);
1400 }
1401
1402
1403 /**
1404  * clear message composing settings
1405  */
1406 function rcmail_compose_cleanup()
1407 {
1408   if (!isset($_SESSION['compose']))
1409     return;
1410
1411   $rcmail = rcmail::get_instance();
1412   $rcmail->plugins->exec_hook('attachments_cleanup', array());
1413   $rcmail->session->remove('compose');
1414 }
1415
1416
1417 /**
1418  * Send the given message using the configured method
1419  *
1420  * @param object $message    Reference to Mail_MIME object
1421  * @param string $from       Sender address string
1422  * @param array  $mailto     Array of recipient address strings
1423  * @param array  $smtp_error SMTP error array (reference)
1424  * @param string $body_file  Location of file with saved message body (reference)
1425  * @param array  $smtp_opts  SMTP options (e.g. DSN request)
1426  *
1427  * @return boolean Send status.
1428  */
1429 function rcmail_deliver_message(&$message, $from, $mailto, &$smtp_error, &$body_file, $smtp_opts=null)
1430 {
1431   global $CONFIG, $RCMAIL;
1432
1433   $headers = $message->headers();
1434
1435   // send thru SMTP server using custom SMTP library
1436   if ($CONFIG['smtp_server']) {
1437     // generate list of recipients
1438     $a_recipients = array($mailto);
1439
1440     if (strlen($headers['Cc']))
1441       $a_recipients[] = $headers['Cc'];
1442     if (strlen($headers['Bcc']))
1443       $a_recipients[] = $headers['Bcc'];
1444
1445     // clean Bcc from header for recipients
1446     $send_headers = $headers;
1447     unset($send_headers['Bcc']);
1448     // here too, it because txtHeaders() below use $message->_headers not only $send_headers
1449     unset($message->_headers['Bcc']);
1450
1451     $smtp_headers = $message->txtHeaders($send_headers, true);
1452
1453     if ($message->getParam('delay_file_io')) {
1454       // use common temp dir
1455       $temp_dir = $RCMAIL->config->get('temp_dir');
1456       $body_file = tempnam($temp_dir, 'rcmMsg');
1457       if (PEAR::isError($mime_result = $message->saveMessageBody($body_file))) {
1458         raise_error(array('code' => 600, 'type' => 'php',
1459             'file' => __FILE__, 'line' => __LINE__,
1460             'message' => "Could not create message: ".$mime_result->getMessage()),
1461             TRUE, FALSE);
1462         return false;
1463       }
1464       $msg_body = fopen($body_file, 'r');
1465     } else {
1466       $msg_body = $message->get();
1467     }
1468
1469     // send message
1470     if (!is_object($RCMAIL->smtp))
1471       $RCMAIL->smtp_init(true);
1472
1473     $sent = $RCMAIL->smtp->send_mail($from, $a_recipients, $smtp_headers, $msg_body, $smtp_opts);
1474     $smtp_response = $RCMAIL->smtp->get_response();
1475     $smtp_error = $RCMAIL->smtp->get_error();
1476
1477     // log error
1478     if (!$sent)
1479       raise_error(array('code' => 800, 'type' => 'smtp', 'line' => __LINE__, 'file' => __FILE__,
1480                         'message' => "SMTP error: ".join("\n", $smtp_response)), TRUE, FALSE);
1481   }
1482   // send mail using PHP's mail() function
1483   else {
1484     // unset some headers because they will be added by the mail() function
1485     $headers_enc = $message->headers($headers);
1486     $headers_php = $message->_headers;
1487     unset($headers_php['To'], $headers_php['Subject']);
1488
1489     // reset stored headers and overwrite
1490     $message->_headers = array();
1491     $header_str = $message->txtHeaders($headers_php);
1492
1493     // #1485779
1494     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1495       if (preg_match_all('/<([^@]+@[^>]+)>/', $headers_enc['To'], $m)) {
1496         $headers_enc['To'] = implode(', ', $m[1]);
1497       }
1498     }
1499
1500     $msg_body = $message->get();
1501
1502     if (PEAR::isError($msg_body))
1503       raise_error(array('code' => 600, 'type' => 'php',
1504             'file' => __FILE__, 'line' => __LINE__,
1505             'message' => "Could not create message: ".$msg_body->getMessage()),
1506             TRUE, FALSE);
1507     else {
1508       $delim   = $RCMAIL->config->header_delimiter();
1509       $to      = $headers_enc['To'];
1510       $subject = $headers_enc['Subject'];
1511       $header_str = rtrim($header_str);
1512
1513       if ($delim != "\r\n") {
1514         $header_str = str_replace("\r\n", $delim, $header_str);
1515         $msg_body   = str_replace("\r\n", $delim, $msg_body);
1516         $to         = str_replace("\r\n", $delim, $to);
1517         $subject    = str_replace("\r\n", $delim, $subject);
1518       }
1519
1520       if (ini_get('safe_mode'))
1521         $sent = mail($to, $subject, $msg_body, $header_str);
1522       else
1523         $sent = mail($to, $subject, $msg_body, $header_str, "-f$from");
1524     }
1525   }
1526
1527   if ($sent) {
1528     $RCMAIL->plugins->exec_hook('message_sent', array('headers' => $headers, 'body' => $msg_body));
1529
1530     // remove MDN headers after sending
1531     unset($headers['Return-Receipt-To'], $headers['Disposition-Notification-To']);
1532
1533     // get all recipients
1534     if ($headers['Cc'])
1535       $mailto .= $headers['Cc'];
1536     if ($headers['Bcc'])
1537       $mailto .= $headers['Bcc'];
1538     if (preg_match_all('/<([^@]+@[^>]+)>/', $mailto, $m))
1539       $mailto = implode(', ', array_unique($m[1]));
1540
1541     if ($CONFIG['smtp_log']) {
1542       write_log('sendmail', sprintf("User %s [%s]; Message for %s; %s",
1543         $RCMAIL->user->get_username(),
1544         $_SERVER['REMOTE_ADDR'],
1545         $mailto,
1546         !empty($smtp_response) ? join('; ', $smtp_response) : ''));
1547     }
1548   }
1549
1550   if (is_resource($msg_body)) {
1551     fclose($msg_body);
1552   }
1553
1554   $message->_headers = array();
1555   $message->headers($headers);
1556
1557   return $sent;
1558 }
1559
1560 /**
1561  * Send the MDN response
1562  *
1563  * @param mixed $message    Original message object (rcube_message) or UID
1564  * @param array $smtp_error SMTP error array (reference)
1565  *
1566  * @return boolean Send status
1567  */
1568 function rcmail_send_mdn($message, &$smtp_error)
1569 {
1570   global $RCMAIL, $IMAP;
1571
1572   if (!is_a($message, rcube_message))
1573     $message = new rcube_message($message);
1574
1575   if ($message->headers->mdn_to && !$message->headers->mdn_sent &&
1576     ($IMAP->check_permflag('MDNSENT') || $IMAP->check_permflag('*')))
1577   {
1578     $identity = $RCMAIL->user->get_identity();
1579     $sender = format_email_recipient($identity['email'], $identity['name']);
1580     $recipient = array_shift($IMAP->decode_address_list($message->headers->mdn_to));
1581     $mailto = $recipient['mailto'];
1582
1583     $compose = new Mail_mime("\r\n");
1584
1585     $compose->setParam('text_encoding', 'quoted-printable');
1586     $compose->setParam('html_encoding', 'quoted-printable');
1587     $compose->setParam('head_encoding', 'quoted-printable');
1588     $compose->setParam('head_charset', RCMAIL_CHARSET);
1589     $compose->setParam('html_charset', RCMAIL_CHARSET);
1590     $compose->setParam('text_charset', RCMAIL_CHARSET);
1591
1592     // compose headers array
1593     $headers = array(
1594       'Date' => rcmail_user_date(),
1595       'From' => $sender,
1596       'To'   => $message->headers->mdn_to,
1597       'Subject' => rcube_label('receiptread') . ': ' . $message->subject,
1598       'Message-ID' => rcmail_gen_message_id(),
1599       'X-Sender' => $identity['email'],
1600       'References' => trim($message->headers->references . ' ' . $message->headers->messageID),
1601     );
1602
1603     if ($agent = $RCMAIL->config->get('useragent'))
1604       $headers['User-Agent'] = $agent;
1605
1606     $body = rcube_label("yourmessage") . "\r\n\r\n" .
1607       "\t" . rcube_label("to") . ': ' . rcube_imap::decode_mime_string($message->headers->to, $message->headers->charset) . "\r\n" .
1608       "\t" . rcube_label("subject") . ': ' . $message->subject . "\r\n" .
1609       "\t" . rcube_label("sent") . ': ' . format_date($message->headers->date, $RCMAIL->config->get('date_long')) . "\r\n" .
1610       "\r\n" . rcube_label("receiptnote") . "\r\n";
1611
1612     $ua = $RCMAIL->config->get('useragent', "Roundcube Webmail (Version ".RCMAIL_VERSION.")");
1613     $report = "Reporting-UA: $ua\r\n";
1614
1615     if ($message->headers->to)
1616         $report .= "Original-Recipient: {$message->headers->to}\r\n";
1617
1618     $report .= "Final-Recipient: rfc822; {$identity['email']}\r\n" .
1619                "Original-Message-ID: {$message->headers->messageID}\r\n" .
1620                "Disposition: manual-action/MDN-sent-manually; displayed\r\n";
1621
1622     $compose->headers($headers);
1623     $compose->setContentType('multipart/report', array('report-type'=> 'disposition-notification'));
1624     $compose->setTXTBody(rc_wordwrap($body, 75, "\r\n"));
1625     $compose->addAttachment($report, 'message/disposition-notification', 'MDNPart2.txt', false, '7bit', 'inline');
1626
1627     $sent = rcmail_deliver_message($compose, $identity['email'], $mailto, $smtp_error, $body_file);
1628
1629     if ($sent)
1630     {
1631       $IMAP->set_flag($message->uid, 'MDNSENT');
1632       return true;
1633     }
1634   }
1635
1636   return false;
1637 }
1638
1639 // Returns unique Message-ID
1640 function rcmail_gen_message_id()
1641 {
1642   global $RCMAIL;
1643
1644   $local_part  = md5(uniqid('rcmail'.mt_rand(),true));
1645   $domain_part = $RCMAIL->user->get_username('domain');
1646
1647   // Try to find FQDN, some spamfilters doesn't like 'localhost' (#1486924)
1648   if (!preg_match('/\.[a-z]+$/i', $domain_part)) {
1649     if (($host = preg_replace('/:[0-9]+$/', '', $_SERVER['HTTP_HOST']))
1650       && preg_match('/\.[a-z]+$/i', $host)) {
1651         $domain_part = $host;
1652     }
1653     else if (($host = preg_replace('/:[0-9]+$/', '', $_SERVER['SERVER_NAME']))
1654       && preg_match('/\.[a-z]+$/i', $host)) {
1655         $domain_part = $host;
1656     }
1657   }
1658
1659   return sprintf('<%s@%s>', $local_part, $domain_part);
1660 }
1661
1662 // Returns RFC2822 formatted current date in user's timezone
1663 function rcmail_user_date()
1664 {
1665   global $CONFIG;
1666
1667   // get user's timezone
1668   if ($CONFIG['timezone'] === 'auto') {
1669     $tz = isset($_SESSION['timezone']) ? $_SESSION['timezone'] : date('Z')/3600;
1670   }
1671   else {
1672     $tz = $CONFIG['timezone'];
1673     if ($CONFIG['dst_active'])
1674       $tz++;
1675   }
1676
1677   $date = time() + $tz * 60 * 60;
1678   $date = gmdate('r', $date);
1679   $tz   = sprintf('%+05d', intval($tz) * 100 + ($tz - intval($tz)) * 60);
1680   $date = preg_replace('/[+-][0-9]{4}$/', $tz, $date);
1681
1682   return $date;
1683 }
1684
1685 // Fixes some content-type names
1686 function rcmail_fix_mimetype($name)
1687 {
1688   // Some versions of Outlook create garbage Content-Type:
1689   // application/pdf.A520491B_3BF7_494D_8855_7FAC2C6C0608
1690   if (preg_match('/^application\/pdf.+/', $name))
1691     $name = 'application/pdf';
1692
1693   return $name;
1694 }
1695
1696 function rcmail_search_filter($attrib)
1697 {
1698   global $OUTPUT, $CONFIG;
1699
1700   if (!strlen($attrib['id']))
1701     $attrib['id'] = 'rcmlistfilter';
1702
1703   $attrib['onchange'] = JS_OBJECT_NAME.'.filter_mailbox(this.value)';
1704
1705   /*
1706     RFC3501 (6.4.4): 'ALL', 'RECENT',
1707     'ANSWERED', 'DELETED', 'FLAGGED', 'SEEN',
1708     'UNANSWERED', 'UNDELETED', 'UNFLAGGED', 'UNSEEN',
1709     'NEW', // = (RECENT UNSEEN)
1710     'OLD' // = NOT RECENT
1711   */
1712
1713   $select_filter = new html_select($attrib);
1714   $select_filter->add(rcube_label('all'), 'ALL');
1715   $select_filter->add(rcube_label('unread'), 'UNSEEN');
1716   $select_filter->add(rcube_label('flagged'), 'FLAGGED');
1717   $select_filter->add(rcube_label('unanswered'), 'UNANSWERED');
1718   if (!$CONFIG['skip_deleted'])
1719     $select_filter->add(rcube_label('deleted'), 'DELETED');
1720
1721   $out = $select_filter->show($_SESSION['search_filter']);
1722
1723   $OUTPUT->add_gui_object('search_filter', $attrib['id']);
1724
1725   return $out;
1726 }
1727
1728 function rcmail_message_error($uid=null)
1729 {
1730   global $RCMAIL;
1731
1732   // Set env variables for messageerror.html template
1733   if ($RCMAIL->action == 'show') {
1734     $mbox_name = $RCMAIL->imap->get_mailbox_name();
1735     $RCMAIL->output->set_env('mailbox', $mbox_name);
1736     $RCMAIL->output->set_env('uid', null);
1737   }
1738   // display error message
1739   $RCMAIL->output->show_message('messageopenerror', 'error');
1740   // ... display message error page
1741   $RCMAIL->output->send('messageerror');
1742 }
1743
1744 // register UI objects
1745 $OUTPUT->add_handlers(array(
1746   'mailboxlist' => 'rcmail_mailbox_list',
1747   'messages' => 'rcmail_message_list',
1748   'messagecountdisplay' => 'rcmail_messagecount_display',
1749   'quotadisplay' => 'rcmail_quota_display',
1750   'mailboxname' => 'rcmail_mailbox_name_display',
1751   'messageheaders' => 'rcmail_message_headers',
1752   'messagebody' => 'rcmail_message_body',
1753   'messagecontentframe' => 'rcmail_messagecontent_frame',
1754   'messagepartframe' => 'rcmail_message_part_frame',
1755   'messagepartcontrols' => 'rcmail_message_part_controls',
1756   'searchfilter' => 'rcmail_search_filter',
1757   'searchform' => array($OUTPUT, 'search_form'),
1758 ));
1759
1760