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