templates/default/message_list.tpl

   1 <?php
   2
   3 /**
   4  * message_list.tpl
   5  *
   6  * Template for viewing a messages list
   7  *
   8  * The following variables are available in this template:
   9 //FIXME: need to clean (and document) this list, it is just a dump of the array keys of $t
  10  *    $sTemplateID
  11  *    $icon_theme_path
  12  *    $javascript_on
  13  *    $delayed_errors
  14  *    $frames
  15  *    $lang
  16  *    $page_title
  17  *    $header_tags
  18  *    $plugin_output
  19  *    $header_sent
  20  *    $body_tag_js
  21  *    $shortBoxName
  22  *    $provider_link
  23  *    $frame_top
  24  *    $urlMailbox
  25  *    $startMessage
  26  *    $hide_sm_attributions
  27  *    $uri
  28  *    $text
  29  *    $onclick
  30  *    $class
  31  *    $id
  32  *    $target
  33  *    $color
  34  *    $form_name
  35  *    $form_id
  36  *    $page_selector
  37  *    $page_selector_max
  38  *    $messagesPerPage
  39  *    $showall
  40  *    $end_msg
  41  *    $align
  42  *    $iNumberOfMessages
  43  *    $aOrder
  44  *    $aFormElements
  45  *    $sort
  46  *    $pageOffset
  47  *    $baseurl
  48  *    $aMessages
  49  *    $trash_folder
  50  *    $sent_folder
  51  *    $draft_folder
  52  *    $thread_link_uri
  53  *    $thread_name
  54  *    $php_self
  55  *    $mailbox
  56  *    $enablesort
  57  *    $icon_theme
  58  *    $use_icons
  59  *    $alt_index_colors
  60  *    $fancy_index_highlite
  61  *    $aSortSupported
  62  *    $show_label_columns
  63  *    $compact_paginator
  64  *    $aErrors
  65  *    $checkall
  66  *    $preselected
  67  *    $show_personal_names boolean When turned on, all email
  68  *                                 address fields should display
  69  *                                 the personal name and use the
  70  *                                 email address as a tool tip;
  71  *                                 When turned off, this logic
  72  *                                 should be inverted
  73  *    $accesskey_mailbox_toggle_selected The access key to use for the toggle all checkbox
  74  *    $accesskey_mailbox_thread The access key to use for the Thread/Unthread links
  75  *
  76  * @copyright &copy; 1999-2009 The SquirrelMail Project Team
  77  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  78  * @version $Id$
  79  * @package squirrelmail
  80  * @subpackage templates
  81  */
  82
  83
  84 /** add required includes */
  85 include_once(SM_PATH . 'functions/template/message_list_util.php');
  86
  87
  88 /* retrieve the template vars */
  89 extract($t);
  90
  91
  92 if (!empty($plugin_output['mailbox_index_before'])) echo $plugin_output['mailbox_index_before'];
  93
  94
  95 /**
  96  * Calculate string "Viewing message x to y (z total)"
  97  */
  98 $msg_cnt_str = '';
  99 if ($pageOffset < $end_msg) {
 100     $msg_cnt_str = sprintf(_("Viewing Messages: %s to %s (%s total)"),
 101                            '<em>' . $pageOffset . '</em>',
 102                            '<em>' . $end_msg . '</em>',
 103                            $iNumberOfMessages);
 104 } else if ($pageOffset == $end_msg) {
 105     $msg_cnt_str = sprintf(_("Viewing Message: %s (%s total)"),
 106                            '<em>' . $pageOffset . '</em>',
 107                            $iNumberOfMessages);
 108 }
 109
 110
 111 /**
 112  * All icon functionality is now handled through $icon_theme_path.
 113  * $icon_theme_path will contain the path to the user-selected theme.  If it is
 114  * NULL, the user and/or admin have turned off icons.
 115  */
 116
 117
 118 ?>
 119 <div id="message_list">
 120 <form id="<?php echo $form_name;?>" name="<?php echo $form_name;?>" method="post" action="<?php echo $php_self;?>">
 121 <table class="table_empty" cellspacing="0">
 122   <tr>
 123    <td>
 124     <table class="table_standard" cellspacing="0">
 125       <tr>
 126         <td>
 127           <table class="table_empty" cellspacing="0">
 128             <tr>
 129               <td class="links_paginator">
 130 <!-- paginator and thread link string -->
 131                   <?php
 132                      /**
 133                        * The following line gets the output from a separate
 134                        * template altogether (called "paginator.tpl").
 135                        * $this is the Template class object.
 136                        */
 137                       $paginator_str = $this->fetch('paginator.tpl');
 138                       echo $paginator_str . '<small>[<a href="' . $thread_link_uri
 139                                           . ($accesskey_mailbox_thread != 'NONE'
 140                                           ? '" accesskey="' . $accesskey_mailbox_thread . '">'
 141                                           : '">')
 142                                           . $thread_name . '</a>]</small>&nbsp;&nbsp;';
 143                       if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
 144                   ?>
 145 <!-- end paginator and thread link string -->
 146               </td>
 147 <!-- message count string -->
 148               <td class="message_count"><?php echo $msg_cnt_str; ?></td>
 149 <!-- end message count string -->
 150             </tr>
 151           </table>
 152         </td>
 153       </tr>
 154 <?php
 155     if (count($aFormElements)) {
 156 ?>
 157 <!-- start message list form control -->
 158       <tr class="message_list_controls">
 159         <td>
 160                   <?php
 161                      /**
 162                        * The following line gets the output from a separate
 163                        * template altogether (called "message_list_controls.tpl").
 164                        * $this is the Template class object.
 165                        */
 166                       $message_list_controls = $this->fetch('message_list_controls.tpl');
 167                       echo $message_list_controls ."\n"; ?>
 168         </td>
 169       </tr>
 170 <!-- end message list form control -->
 171 <?php
 172     } // if (count($aFormElements))
 173 ?>
 174     </table>
 175 <?php if (!empty($plugin_output['mailbox_form_before'])) echo $plugin_output['mailbox_form_before']; ?>
 176     </td>
 177   </tr>
 178   <tr><td class="spacer"></td></tr>
 179   <tr>
 180     <td>
 181       <table class="table_messageListWrapper" cellspacing="0">
 182         <tr>
 183           <td>
 184             <table class="table_messageList" cellspacing="0">
 185 <!-- table header start -->
 186 <?php
 187 /*
 188  * As an FYI, Firefox on Windows seems to have an issue w/ putting wierd breaks while
 189  * rendering this table if we use THEAD and TH tags.  No other browser or platform has
 190  * this issue.  We will use TR/TD w/ another CSS class to work around this.
 191  */
 192 ?>
 193
 194               <tr class="headerRow">
 195
 196 <?php
 197     $aWidth = calcMessageListColumnWidth($aOrder);
 198     foreach($aOrder as $iCol) {
 199 ?>
 200
 201                     <td style="width:<?php echo $aWidth[$iCol]; ?>%">
 202
 203 <?php
 204         switch ($iCol) {
 205           case SQM_COL_CHECK:
 206               if ($javascript_on) {
 207                   $checked = ($checkall ? ' checked="checked" ' : '');
 208                   $accesskey = ($accesskey_mailbox_toggle_selected == 'NONE' ? ''
 209                                 : ' accesskey="' . $accesskey_mailbox_toggle_selected . '" ');
 210                   echo '<input type="checkbox" name="toggleAll" id="toggleAll" title="'
 211                      . _("Toggle All") . '" onclick="toggle_all(\''
 212                      . $form_name . '\', \'msg\', ' . $fancy_index_highlite
 213                      . '); return false;" ' . $checked . $accesskey . '/>' . "\n";
 214               } else {
 215                   $link = $baseurl
 216                         . "&amp;startMessage=$pageOffset&amp;checkall="
 217                         . ($checkall ? '0' : '1');
 218                   echo "<a href=\"$link\">" . _("All") . '</a>';
 219               }
 220               break;
 221           case SQM_COL_FROM:
 222               echo '<label for="toggleAll">' . _("From") . "</label>\n";
 223               break;
 224           case SQM_COL_DATE:       echo _("Date") . "\n";     break;
 225           case SQM_COL_SUBJ:       echo _("Subject") . "\n";  break;
 226           case SQM_COL_FLAGS:
 227                 echo getIcon($icon_theme_path, 'msg_new.png', '&nbsp;', _("Message Flags")) . "\n";
 228                 break;
 229           case SQM_COL_SIZE:       echo  _("Size") . "\n";    break;
 230           case SQM_COL_PRIO:
 231                 echo getIcon($icon_theme_path, 'prio_high.png', '!', _("Priority")) . "\n";
 232                 break;
 233           case SQM_COL_ATTACHMENT:
 234                 echo getIcon($icon_theme_path, 'attach.png', '+', _("Attachment")) . "\n";
 235                 break;
 236           case SQM_COL_INT_DATE:   echo _("Received") . "\n"; break;
 237           case SQM_COL_TO:
 238               echo '<label for="toggleAll">' . _("To") . "</label>\n";
 239               break;
 240           case SQM_COL_CC:         echo _("Cc") . "\n";       break;
 241           case SQM_COL_BCC:        echo _("Bcc") . "\n";      break;
 242           default: break;
 243         }
 244         // add the sort buttons
 245         if (isset($aSortSupported[$iCol])) {
 246             if ($sort == $aSortSupported[$iCol][0]) {
 247                 $newsort = $aSortSupported[$iCol][1];
 248                 $img = 'up_pointer.png';
 249                 $text_icon = '&#8679;';  // U+21E7 UPWARDS WHITE ARROW
 250             } else if ($sort == $aSortSupported[$iCol][1]) {
 251                 $newsort = 0;
 252                 $img = 'down_pointer.png';
 253                 $text_icon = '&#8681;'; // U+21E9 DOWNWARDS WHITE ARROW
 254             } else {
 255                 $newsort = $aSortSupported[$iCol][0];
 256                 $img = 'sort_none.png';
 257                 $text_icon = '&#9723;'; // U+25FB WHITE MEDIUM SQUARE
 258             }
 259             /* Now that we have everything figured out, show the actual button. */
 260             echo " <a href=\"$baseurl&amp;startMessage=1&amp;srt=$newsort\" style=\"text-decoration:none\">" .
 261                  getIcon($icon_theme_path, $img, $text_icon, _("Click here to change the sorting of the message list")) . "\n" .
 262                  '</a>';
 263         }
 264 ?>
 265                     </td>
 266 <?php
 267     }
 268 ?>
 269               </tr>
 270 <!-- end table header -->
 271
 272 <!-- Message headers start -->
 273 <?php
 274
 275             $i = 0;
 276             $iColCnt = count($aOrder);
 277             $sLine = '';
 278
 279
 280             // this stuff does the auto row highlighting on mouseover
 281             //
 282             if (!empty($plugin_output['checkbox_javascript_onclick'])) $checkbox_javascript_onclick = $plugin_output['checkbox_javascript_onclick'];
 283             else $checkbox_javascript_onclick = '';
 284
 285             if ($javascript_on && $fancy_index_highlite) {
 286                 $checkbox_javascript = ' onclick="this.checked = !this.checked; ' . $checkbox_javascript_onclick . '"';
 287             } else if (!empty($checkbox_javascript_onclick)) {
 288                 $checkbox_javascript = ' onclick="' . $checkbox_javascript_onclick . '"';
 289             } else {
 290                 $checkbox_javascript = '';
 291             }
 292
 293
 294             /**
 295               * main message iteration loop
 296               */
 297             foreach ($aMessages as $iUid => $aMsg) {
 298
 299                 echo $sLine;
 300
 301
 302 /**
 303 * Display message header row in messages list
 304 *
 305 */
 306
 307     $aColumns = $aMsg['columns'];
 308
 309
 310     /**
 311      * Check the flags and set a class var.
 312      */
 313     if (isset($aColumns[SQM_COL_FLAGS])) {
 314         $aFlags = $aColumns[SQM_COL_FLAGS]['value'];
 315         $sFlags = getFlagIcon($aFlags, $icon_theme_path);
 316
 317         /* add the flag string to the value index */
 318         $aColumns[SQM_COL_FLAGS]['value'] = $sFlags;
 319     }
 320     /**
 321      * Check the priority column
 322      */
 323     if (isset($aColumns[SQM_COL_PRIO])) {
 324         $sValue = getPriorityIcon($aColumns[SQM_COL_PRIO]['value'], $icon_theme_path);
 325         $aColumns[SQM_COL_PRIO]['value'] = $sValue;
 326     }
 327
 328     /**
 329      * Check the attachment column
 330      */
 331     if (isset($aColumns[SQM_COL_ATTACHMENT])) {
 332         $sValue = getAttachmentIcon($aColumns[SQM_COL_ATTACHMENT]['value'], $icon_theme_path);
 333         $aColumns[SQM_COL_ATTACHMENT]['value'] = $sValue;
 334     }
 335
 336     $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_even' : 'even');
 337     $non_clicked_class = 'even';
 338
 339     /**
 340      * If alternating row colors is set, adapt the CSS class
 341      */
 342     if (isset($alt_index_colors) && $alt_index_colors) {
 343         if (!($i % 2)) {
 344             $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_odd' : 'odd');
 345             $non_clicked_class = 'odd';
 346         }
 347
 348     }
 349
 350     /**
 351      * Message Highlighting Functionality
 352      */
 353     if (isset($aMsg['row']['color']))
 354     {
 355         if (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite) {
 356 //FIXME: would be best not to use $color directly here; want to move this to be a CSS style-defined value only, but the problem is that this CSS class is being defined on the fly right here
 357             $bgcolor = $color[16];
 358             $class = 'clicked_misc'.$i;
 359         } else {
 360             $bgcolor = $aMsg['row']['color'];
 361             $class = 'misc'.$i;
 362         }
 363         $non_clicked_class = 'misc'.$i;
 364         $non_clicked_bgcolor = $aMsg['row']['color'];
 365     }
 366     else
 367     {
 368         $bgcolor = '';
 369         $non_clicked_bgcolor = '';
 370     }
 371
 372     $row_extra = '';
 373
 374     // this stuff does the auto row highlighting on mouseover
 375     //
 376     if ($javascript_on && $fancy_index_highlite) {
 377         $row_extra = ' onmouseover="rowOver(\''.$form_id . '_msg' . $i.'\');" onmouseout="setPointer(this, ' . $i . ', \'out\', \'' . $non_clicked_class . '\', \'mouse_over\', \'clicked\');" onmousedown="setPointer(this, ' . $i . ', \'click\', \'' . $non_clicked_class . '\', \'mouse_over\', \'clicked\');"';
 378     }
 379     // this does the auto-checking of the checkbox no matter
 380     // where on the row you click
 381     //
 382     $javascript_auto_click = '';
 383     $row_click_extra = '';
 384     if (!empty($plugin_output['row_click_extra'])) $row_click_extra = $plugin_output['row_click_extra'];
 385     if ($javascript_on && $fancy_index_highlite) {
 386         // include the form_id in order to show multiple messages lists. Otherwise id isn't unique
 387         $javascript_auto_click = " onmousedown=\"row_click('$form_id"."_msg$i', event, '$form_name', 'msg[' + $i + ']', '$row_click_extra')\"";
 388     }
 389
 390
 391 /*
 392  * Message Highlighting requires a unique CSS class declaration for proper
 393  * mouseover functionality.  There is no harm in doing this when the mouseover
 394  * functionality is disabled
 395  */
 396 if ($class != 'even' && $class != 'odd'
 397  && $class != 'clicked_even' && $class != 'clicked_odd')
 398 {
 399 ?>
 400 <style type="text/css">
 401 <!--
 402 .table_messageList      tr.<?php echo $class; ?>        { background:<?php echo $bgcolor; ?> }
 403 -->
 404 </style>
 405 <?php
 406 }
 407 if ($non_clicked_class != 'even' && $non_clicked_class != 'odd'
 408  && $non_clicked_class != 'clicked_even' && $non_clicked_class != 'clicked_odd')
 409 {
 410 ?>
 411 <style type="text/css">
 412 <!--
 413 .table_messageList      tr.<?php echo $non_clicked_class; ?>    { background:<?php echo $non_clicked_bgcolor; ?> }
 414 -->
 415 </style>
 416 <?php
 417 }
 418
 419
 420 ?>
 421 <tr <?php echo (empty($class) ? '' : 'class="'.$class.'" ');  echo $row_extra;?>>
 422 <?php
 423     // flag style mumbo jumbo
 424     $sPre = $sEnd = '';
 425     if (isset($aColumns[SQM_COL_FLAGS])) {
 426         if (!in_array('seen',$aFlags) || !$aFlags['seen']) {
 427             $sPre = '<span class="unread">'; $sEnd = '</span>';
 428         }
 429         if (in_array('deleted',$aFlags) && $aFlags['deleted']) {
 430             $sPre = '<span class="deleted">' . $sPre;
 431             $sEnd .= '</span>';
 432         } else {
 433             if (in_array('flagged',$aFlags) && $aFlags['flagged']) {
 434                 $sPre = '<span class="flagged">' . $sPre;
 435                 $sEnd .= '</span>';
 436             }
 437         }
 438     }
 439     /**
 440      * Because the order of the columns and which columns to show is a user preference
 441      * we have to do some php coding to display the columns in the right order
 442      */
 443     foreach ($aOrder as $iCol) {
 444         if (in_array($iCol, $show_label_columns)) {
 445             $sLabelStart = '<label for="'.$form_id."_msg$i\">";
 446             $sLabelEnd = '</label>';
 447         } else {
 448             $sLabelStart = '';
 449             $sLabelEnd = '';
 450         }
 451         $aCol       = (isset($aColumns[$iCol]))    ? $aColumns[$iCol]    : array();
 452         $title      = (isset($aCol['title']))      ? $aCol['title']      : '';
 453         $link       = (isset($aCol['link']))       ? $aCol['link']       : '';
 454         $link_extra = (isset($aCol['link_extra'])) ? $aCol['link_extra'] : '';
 455         $onclick    = (isset($aCol['onclick']))    ? $aCol['onclick']    : '';
 456         $value      = (isset($aCol['value']))      ? $aCol['value']      : '';
 457         $target     = (isset($aCol['target']))     ? $aCol['target']     : '';
 458         if (!$show_personal_names
 459          && !empty($title)
 460          && ($iCol == SQM_COL_FROM
 461           || $iCol == SQM_COL_TO
 462           || $iCol == SQM_COL_CC
 463           || $iCol == SQM_COL_BCC)) {
 464             // swap title and value
 465             $tmp = $title;
 466             $title = $value;
 467             $value = $tmp;
 468         }
 469         if ($iCol !== SQM_COL_CHECK) {
 470             $value = $sLabelStart.$sPre.$value.$sEnd.$sLabelEnd;
 471         }
 472
 473
 474         switch ($iCol) {
 475           case SQM_COL_CHECK:
 476             $checked = (($checkall || in_array($iUid, $preselected)) ? ' checked="checked" ' : '');
 477             if ($javascript_on) {
 478                 echo '<td class="col_check"'. $javascript_auto_click. '>' ?>
 479                 <input type="checkbox" name="<?php echo "msg[$i]";?>" id="<?php echo $form_id."_msg$i";?>" value="<?php echo $iUid;?>" <?php echo $checkbox_javascript . $checked;?> /></td>
 480             <?php
 481             } else {
 482                 echo '<td class="col_check">';
 483                 echo "<input type=\"checkbox\" name=\"msg[".$i."]\" id=\"".$form_id."_msg$i\" value=\"$iUid\" $checked/></td>";
 484             }
 485             break;
 486           case SQM_COL_SUBJ:
 487             $indent = $aCol['indent'];
 488             $sText = "    <td class=\"col_subject\" $javascript_auto_click>";
 489             if ($align['left'] == 'left') {
 490                 $sText .= str_repeat('&nbsp;&nbsp;',$indent);
 491             }
 492             $sText .= "<a href=\"$link\"";
 493             if ($target)     { $sText .= " target=\"$target\"";   }
 494             if ($title)      { $sText .= " title=\"$title\"";     }
 495             if ($onclick)    { $sText .= " onclick=\"$onclick\""; }
 496             if ($link_extra) { $sText .= " $link_extra";          }
 497             if ($javascript_on && $fancy_index_highlite) {
 498                   $sText .= " onmousedown=\"row_click('$form_id"."_msg$i', event, '$form_name', 'msg[' + $i + ']', '$row_click_extra'); setPointer(this." . (empty($bold) ? '' : 'parentNode.') .
 499                             'parentNode.parentNode, ' . $i . ', \'click\', \''. $non_clicked_class. '\', \'mouse_over\', \'clicked\');"';
 500             }
 501             $sText .= ">"
 502                    . $value . '</a>';
 503             if ($align['left'] == 'right') {
 504                 $sText .= str_repeat('&nbsp;&nbsp;',$indent);
 505             }
 506             echo $sText."</td>\n";
 507             break;
 508           case SQM_COL_SIZE:
 509           case SQM_COL_FLAGS:
 510             $sText = "    <td class=\"col_flags\" $javascript_auto_click>"
 511                    . "$value</td>\n";
 512             echo $sText;
 513             break;
 514           case SQM_COL_INT_DATE:
 515           case SQM_COL_DATE:
 516             $sText = "    <td class=\"col_date\" $javascript_auto_click>"
 517                    . $value. "</td>\n";
 518             echo $sText;
 519             break;
 520           default:
 521             $sText = "    <td class=\"col_text\" $javascript_auto_click";
 522             if ($link) {
 523                 $sText .= "><a href=\"$link\"";
 524                 if ($target) { $sText .= " target=\"$target\"";}
 525                 if ($title)  { $sText .= " title=\"$title\""  ;}
 526                 $sText .= ">";
 527             } else {
 528                 if ($title) {$sText .= " title=\"$title\"";}
 529                 $sText .= ">";
 530             }
 531             $sText .= $value;
 532             if ($link) { $sText .= '</a>';}
 533             echo $sText."</td>\n";
 534             break;
 535         }
 536     }
 537
 538             echo '</tr>';
 539             $sLine = "<tr><td colspan=\"$iColCnt\" class=\"spacer\"></td></tr>\n";
 540             ++$i;
 541
 542 /*
 543  * End displaying row part
 544  */
 545         }
 546
 547 ?>
 548 <!-- Message headers end -->
 549                 </table>
 550               </td>
 551             </tr>
 552           </table>
 553         </td>
 554       </tr>
 555       <tr><td class="spacer"></td></tr>
 556       <tr>
 557         <td>
 558           <table class="table_standard" cellspacing="0">
 559             <tr>
 560               <td>
 561                 <table class="table_empty" cellspacing="0">
 562                   <tr>
 563                     <td class="links_paginator"><?php
 564                      /**
 565                        * The following line gets the output from a separate
 566                        * template altogether (called "paginator.tpl").
 567                        * $this is the Template class object.
 568                        */
 569                       $paginator_str = $this->fetch('paginator.tpl');
 570                       echo $paginator_str;
 571                       if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
 572                     ?></td>
 573                     <td class="message_count"><?php echo $msg_cnt_str; ?></td>
 574                   </tr>
 575                 </table>
 576               </td>
 577             </tr>
 578           </table>
 579         </td>
 580       </tr>
 581       <tr>
 582         <td align="right">
 583 <?php if (!empty($plugin_output['mailbox_index_after'])) echo $plugin_output['mailbox_index_after']; ?>
 584         </td>
 585       </tr>
 586     </table>
 587 </form>
 588 </div>
 589
 590 <?php if (!$hide_sm_attributions): ?>
 591 <p class="sqm_squirrelcopyright">&copy; <?php echo SM_COPYRIGHT ?> The SquirrelMail Project Team - <a href="about.php">About SquirrelMail</a></p>
 592 <?php endif; ?>