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