6 * Template for viewing a messages list
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
26 * $hide_sm_attributions
60 * $fancy_index_highlite
68 * @copyright © 1999-2006 The SquirrelMail Project Team
69 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
71 * @package squirrelmail
72 * @subpackage templates
76 /** add required includes */
77 include_once(SM_PATH . 'functions/template/message_list_util.php');
80 /* retrieve the template vars */
84 if (!empty($plugin_output['mailbox_index_before'])) echo $plugin_output['mailbox_index_before'];
88 * Calculate string "Viewing message x to y (z total)"
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>',
96 } else if ($pageOffset == $end_msg) {
97 $msg_cnt_str = sprintf(_("Viewing Message: %s (%s total)"),
98 '<em>' . $pageOffset . '</em>',
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.
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">
116 <table class="table_standard" cellspacing="0">
119 <table class="table_empty" cellspacing="0">
121 <td class="links_paginator">
122 <!-- paginator and thread link string -->
125 * The following line gets the output from a separate
126 * template altogether (called "paginator.tpl").
127 * $this is the Template class object.
129 $paginator_str = $this->fetch('paginator.tpl');
130 echo $paginator_str . '<small>[<a href="' . $thread_link_uri
131 . '">' . $thread_name . '</a>]</small> ';
132 if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
134 <!-- end paginator and thread link string -->
136 <!-- message count string -->
137 <td class="message_count"><?php echo $msg_cnt_str; ?></td>
138 <!-- end message count string -->
144 if (count($aFormElements)) {
146 <!-- start message list form control -->
147 <tr class="message_list_controls">
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.
155 $message_list_controls = $this->fetch('message_list_controls.tpl');
156 echo $message_list_controls ."\n"; ?>
159 <!-- end message list form control -->
161 } // if (count($aFormElements))
164 <?php if (!empty($plugin_output['mailbox_form_before'])) echo $plugin_output['mailbox_form_before']; ?>
167 <tr><td class="spacer"></td></tr>
170 <table class="table_messageListWrapper" cellspacing="0">
173 <table class="table_messageList" cellspacing="0">
174 <!-- table header start -->
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.
183 <tr class="headerRow">
186 $aWidth = calcMessageListColumnWidth($aOrder);
187 foreach($aOrder as $iCol) {
190 <td style="width:<?php echo $aWidth[$iCol]; ?>%">
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";
200 . "&startMessage=$pageOffset&checkall="
201 . ($checkall ? '0' : '1');
202 echo "<a href=\"$link\">"._("All").'</a>';
206 echo '<label for="toggleAll">' . _("From") . "</label>\n";
208 case SQM_COL_DATE: echo _("Date") . "\n"; break;
209 case SQM_COL_SUBJ: echo _("Subject") . "\n"; break;
211 echo getIcon($icon_theme_path, 'msg_new.png', ' ', _("Message Flags")) . "\n";
213 case SQM_COL_SIZE: echo _("Size") . "\n"; break;
215 echo getIcon($icon_theme_path, 'prio_high.png', '!', _("Priority")) . "\n";
217 case SQM_COL_ATTACHMENT:
218 echo getIcon($icon_theme_path, 'attach.png', '+', _("Attachment")) . "\n";
220 case SQM_COL_INT_DATE: echo _("Received") . "\n"; break;
222 echo '<label for="toggleAll">' . _("To") . "</label>\n";
224 case SQM_COL_CC: echo _("Cc") . "\n"; break;
225 case SQM_COL_BCC: echo _("Bcc") . "\n"; break;
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 = '⇧'; // U+21E7 UPWARDS WHITE ARROW
234 } else if ($sort == $aSortSupported[$iCol][1]) {
236 $img = 'down_pointer.png';
237 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
239 $newsort = $aSortSupported[$iCol][0];
240 $img = 'sort_none.png';
241 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
243 /* Now that we have everything figured out, show the actual button. */
244 echo " <a href=\"$baseurl&startMessage=1&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" .
254 <!-- end table header -->
256 <!-- Message headers start -->
260 $iColCnt = count($aOrder);
264 // this stuff does the auto row highlighting on mouseover
266 if ($javascript_on && $fancy_index_highlite) {
267 $checkbox_javascript = ' onclick="this.checked = !this.checked;"';
269 $checkbox_javascript = '';
274 * main message iteration loop
276 foreach ($aMessages as $iUid => $aMsg) {
282 * Display message header row in messages list
286 $aColumns = $aMsg['columns'];
290 * Check the flags and set a class var.
292 if (isset($aColumns[SQM_COL_FLAGS])) {
293 $aFlags = $aColumns[SQM_COL_FLAGS]['value'];
294 $sFlags = getFlagIcon($aFlags, $icon_theme_path);
296 /* add the flag string to the value index */
297 $aColumns[SQM_COL_FLAGS]['value'] = $sFlags;
300 * Check the priority column
302 if (isset($aColumns[SQM_COL_PRIO])) {
303 $sValue = getPriorityIcon($aColumns[SQM_COL_PRIO]['value'], $icon_theme_path);
304 $aColumns[SQM_COL_PRIO]['value'] = $sValue;
308 * Check the attachment column
310 if (isset($aColumns[SQM_COL_ATTACHMENT])) {
311 $sValue = getAttachmentIcon($aColumns[SQM_COL_ATTACHMENT]['value'], $icon_theme_path);
312 $aColumns[SQM_COL_ATTACHMENT]['value'] = $sValue;
315 $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_even' : 'even');
316 $non_clicked_class = 'even';
319 * If alternating row colors is set, adapt the CSS class
321 if (isset($alt_index_colors) && $alt_index_colors) {
323 $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_odd' : 'odd');
324 $non_clicked_class = 'odd';
330 * Message Highlighting Functionality
332 if (isset($aMsg['row']['color']))
334 if (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite) {
335 //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
336 $bgcolor = $color[16];
337 $class = 'clicked_misc'.$i;
339 $bgcolor = $aMsg['row']['color'];
342 $non_clicked_class = 'misc'.$i;
343 $non_clicked_bgcolor = $aMsg['row']['color'];
348 $non_clicked_bgcolor = '';
353 // this stuff does the auto row highlighting on mouseover
355 if ($javascript_on && $fancy_index_highlite) {
356 $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\');"';
358 // this does the auto-checking of the checkbox no matter
359 // where on the row you click
361 $javascript_auto_click = '';
362 if ($javascript_on && $fancy_index_highlite) {
363 // include the form_id in order to show multiple messages lists. Otherwise id isn't unique
364 $javascript_auto_click = " onmousedown=\"row_click('$form_id"."_msg$i')\"";
369 * Message Highlighting requires a unique CSS class declaration for proper
370 * mouseover functionality. There is no harm in doing this when the mouseover
371 * functionality is disabled
373 if ($class != 'even' && $class != 'odd'
374 && $class != 'clicked_even' && $class != 'clicked_odd')
377 <style type="text/css">
379 .table_messageList tr.<?php echo $class; ?> { background:<?php echo $bgcolor; ?> }
384 if ($non_clicked_class != 'even' && $non_clicked_class != 'odd'
385 && $non_clicked_class != 'clicked_even' && $non_clicked_class != 'clicked_odd')
388 <style type="text/css">
390 .table_messageList tr.<?php echo $non_clicked_class; ?> { background:<?php echo $non_clicked_bgcolor; ?> }
398 <tr <?php echo (empty($class) ? '' : 'class="'.$class.'" '); echo $row_extra;?>>
400 // flag style mumbo jumbo
402 if (isset($aColumns[SQM_COL_FLAGS])) {
403 if (!in_array('seen',$aFlags) || !$aFlags['seen']) {
404 $sPre = '<span class="unread">'; $sEnd = '</span>';
406 if (in_array('deleted',$aFlags) && $aFlags['deleted']) {
407 $sPre = '<span class="deleted">' . $sPre;
410 if (in_array('flagged',$aFlags) && $aFlags['flagged']) {
411 $sPre = '<span class="flagged">' . $sPre;
417 * Because the order of the columns and which columns to show is a user preference
418 * we have to do some php coding to display the columns in the right order
420 foreach ($aOrder as $iCol) {
421 if (in_array($iCol, $show_label_columns)) {
422 $sLabelStart = '<label for="'.$form_id."_msg$i\">";
423 $sLabelEnd = '</label>';
428 $aCol = (isset($aColumns[$iCol])) ? $aColumns[$iCol] : array();
429 $title = (isset($aCol['title'])) ? $aCol['title'] : '';
430 $link = (isset($aCol['link'])) ? $aCol['link'] : '';
431 $link_extra = (isset($aCol['link_extra'])) ? $aCol['link_extra'] : '';
432 $onclick = (isset($aCol['onclick'])) ? $aCol['onclick'] : '';
433 $value = (isset($aCol['value'])) ? $aCol['value'] : '';
434 $target = (isset($aCol['target'])) ? $aCol['target'] : '';
435 if ($iCol !== SQM_COL_CHECK) {
436 $value = $sLabelStart.$sPre.$value.$sEnd.$sLabelEnd;
442 $checked = (($checkall || in_array($iUid, $preselected)) ? ' checked="checked" ' : '');
443 if ($javascript_on) {
444 echo '<td class="col_check"'. $javascript_auto_click. '>' ?>
445 <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>
448 echo '<td class="col_check">';
449 echo "<input type=\"checkbox\" name=\"msg[".$i."]\" id=\"".$form_id."_msg$i\" value=\"$iUid\" $checked/></td>";
453 $indent = $aCol['indent'];
454 $sText = " <td class=\"col_subject\" $javascript_auto_click>";
455 if ($align['left'] == 'left') {
456 $sText .= str_repeat(' ',$indent);
458 $sText .= "<a href=\"$link\"";
459 if ($target) { $sText .= " target=\"$target\""; }
460 if ($title) { $sText .= " title=\"$title\""; }
461 if ($onclick) { $sText .= " onclick=\"$onclick\""; }
462 if ($link_extra) { $sText .= " $link_extra"; }
463 if ($javascript_on && $fancy_index_highlite) {
464 $sText .= " onmousedown=\"row_click('$form_id"."_msg$i'); setPointer(this." . (empty($bold) ? '' : 'parentNode.') .
465 'parentNode.parentNode, ' . $i . ', \'click\', \''. $non_clicked_class. '\', \'mouse_over\', \'clicked\');"';
469 if ($align['left'] == 'right') {
470 $sText .= str_repeat(' ',$indent);
472 echo $sText."</td>\n";
476 $sText = " <td class=\"col_flags\" $javascript_auto_click>"
480 case SQM_COL_INT_DATE:
482 $sText = " <td class=\"col_date\" $javascript_auto_click>"
487 $sText = " <td class=\"col_text\" $javascript_auto_click";
489 $sText .= "><a href=\"$link\"";
490 if ($target) { $sText .= " target=\"$target\"";}
491 if ($title) { $sText .= " title=\"$title\"" ;}
494 if ($title) {$sText .= " title=\"$title\"";}
498 if ($link) { $sText .= '</a>';}
499 echo $sText."</td>\n";
505 $sLine = "<tr><td colspan=\"$iColCnt\" class=\"spacer\"></td></tr>\n";
509 * End displaying row part
514 <!-- Message headers end -->
521 <tr><td class="spacer"></td></tr>
524 <table class="table_standard" cellspacing="0">
527 <table class="table_empty" cellspacing="0">
529 <td class="links_paginator"><?php
531 * The following line gets the output from a separate
532 * template altogether (called "paginator.tpl").
533 * $this is the Template class object.
535 $paginator_str = $this->fetch('paginator.tpl');
537 if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
539 <td class="message_count"><?php echo $msg_cnt_str; ?></td>
549 <?php if (!empty($plugin_output['mailbox_index_after'])) echo $plugin_output['mailbox_index_after']; ?>
556 <?php if (!$hide_sm_attributions): ?>
557 <p class="sqm_squirrelcopyright">© <?php echo SM_COPYRIGHT ?> The SquirrelMail Project Team - <a href="about.php">About SquirrelMail</a></p>