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
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
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
76 * @copyright © 1999-2009 The SquirrelMail Project Team
77 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
79 * @package squirrelmail
80 * @subpackage templates
84 /** add required includes */
85 include_once(SM_PATH . 'functions/template/message_list_util.php');
88 /* retrieve the template vars */
92 if (!empty($plugin_output['mailbox_index_before'])) echo $plugin_output['mailbox_index_before'];
96 * Calculate string "Viewing message x to y (z total)"
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>',
104 } else if ($pageOffset == $end_msg) {
105 $msg_cnt_str = sprintf(_("Viewing Message: %s (%s total)"),
106 '<em>' . $pageOffset . '</em>',
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.
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">
124 <table class="table_standard" cellspacing="0">
127 <table class="table_empty" cellspacing="0">
129 <td class="links_paginator">
130 <!-- paginator and thread link string -->
133 * The following line gets the output from a separate
134 * template altogether (called "paginator.tpl").
135 * $this is the Template class object.
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 . '">'
142 . $thread_name . '</a>]</small> ';
143 if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
145 <!-- end paginator and thread link string -->
147 <!-- message count string -->
148 <td class="message_count"><?php echo $msg_cnt_str; ?></td>
149 <!-- end message count string -->
155 if (count($aFormElements)) {
157 <!-- start message list form control -->
158 <tr class="message_list_controls">
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.
166 $message_list_controls = $this->fetch('message_list_controls.tpl');
167 echo $message_list_controls ."\n"; ?>
170 <!-- end message list form control -->
172 } // if (count($aFormElements))
175 <?php if (!empty($plugin_output['mailbox_form_before'])) echo $plugin_output['mailbox_form_before']; ?>
178 <tr><td class="spacer"></td></tr>
181 <table class="table_messageListWrapper" cellspacing="0">
184 <table class="table_messageList" cellspacing="0">
185 <!-- table header start -->
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.
194 <tr class="headerRow">
197 $aWidth = calcMessageListColumnWidth($aOrder);
198 foreach($aOrder as $iCol) {
201 <td style="width:<?php echo $aWidth[$iCol]; ?>%">
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";
216 . "&startMessage=$pageOffset&checkall="
217 . ($checkall ? '0' : '1');
218 echo "<a href=\"$link\">" . _("All") . '</a>';
222 echo '<label for="toggleAll">' . _("From") . "</label>\n";
224 case SQM_COL_DATE: echo _("Date") . "\n"; break;
225 case SQM_COL_SUBJ: echo _("Subject") . "\n"; break;
227 echo getIcon($icon_theme_path, 'msg_new.png', ' ', _("Message Flags")) . "\n";
229 case SQM_COL_SIZE: echo _("Size") . "\n"; break;
231 echo getIcon($icon_theme_path, 'prio_high.png', '!', _("Priority")) . "\n";
233 case SQM_COL_ATTACHMENT:
234 echo getIcon($icon_theme_path, 'attach.png', '+', _("Attachment")) . "\n";
236 case SQM_COL_INT_DATE: echo _("Received") . "\n"; break;
238 echo '<label for="toggleAll">' . _("To") . "</label>\n";
240 case SQM_COL_CC: echo _("Cc") . "\n"; break;
241 case SQM_COL_BCC: echo _("Bcc") . "\n"; break;
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 = '⇧'; // U+21E7 UPWARDS WHITE ARROW
250 } else if ($sort == $aSortSupported[$iCol][1]) {
252 $img = 'down_pointer.png';
253 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
255 $newsort = $aSortSupported[$iCol][0];
256 $img = 'sort_none.png';
257 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
259 /* Now that we have everything figured out, show the actual button. */
260 echo " <a href=\"$baseurl&startMessage=1&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" .
270 <!-- end table header -->
272 <!-- Message headers start -->
276 $iColCnt = count($aOrder);
280 // this stuff does the auto row highlighting on mouseover
282 if (!empty($plugin_output['checkbox_javascript_onclick'])) $checkbox_javascript_onclick = $plugin_output['checkbox_javascript_onclick'];
283 else $checkbox_javascript_onclick = '';
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 . '"';
290 $checkbox_javascript = '';
295 * main message iteration loop
297 foreach ($aMessages as $iUid => $aMsg) {
303 * Display message header row in messages list
307 $aColumns = $aMsg['columns'];
311 * Check the flags and set a class var.
313 if (isset($aColumns[SQM_COL_FLAGS])) {
314 $aFlags = $aColumns[SQM_COL_FLAGS]['value'];
315 $sFlags = getFlagIcon($aFlags, $icon_theme_path);
317 /* add the flag string to the value index */
318 $aColumns[SQM_COL_FLAGS]['value'] = $sFlags;
321 * Check the priority column
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;
329 * Check the attachment column
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;
336 $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_even' : 'even');
337 $non_clicked_class = 'even';
340 * If alternating row colors is set, adapt the CSS class
342 if (isset($alt_index_colors) && $alt_index_colors) {
344 $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_odd' : 'odd');
345 $non_clicked_class = 'odd';
351 * Message Highlighting Functionality
353 if (isset($aMsg['row']['color']))
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;
360 $bgcolor = $aMsg['row']['color'];
363 $non_clicked_class = 'misc'.$i;
364 $non_clicked_bgcolor = $aMsg['row']['color'];
369 $non_clicked_bgcolor = '';
374 // this stuff does the auto row highlighting on mouseover
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\');"';
379 // this does the auto-checking of the checkbox no matter
380 // where on the row you click
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')\"";
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
396 if ($class != 'even' && $class != 'odd'
397 && $class != 'clicked_even' && $class != 'clicked_odd')
400 <style type="text/css">
402 .table_messageList tr.<?php echo $class; ?> { background:<?php echo $bgcolor; ?> }
407 if ($non_clicked_class != 'even' && $non_clicked_class != 'odd'
408 && $non_clicked_class != 'clicked_even' && $non_clicked_class != 'clicked_odd')
411 <style type="text/css">
413 .table_messageList tr.<?php echo $non_clicked_class; ?> { background:<?php echo $non_clicked_bgcolor; ?> }
421 <tr <?php echo (empty($class) ? '' : 'class="'.$class.'" '); echo $row_extra;?>>
423 // flag style mumbo jumbo
425 if (isset($aColumns[SQM_COL_FLAGS])) {
426 if (!in_array('seen',$aFlags) || !$aFlags['seen']) {
427 $sPre = '<span class="unread">'; $sEnd = '</span>';
429 if (in_array('deleted',$aFlags) && $aFlags['deleted']) {
430 $sPre = '<span class="deleted">' . $sPre;
433 if (in_array('flagged',$aFlags) && $aFlags['flagged']) {
434 $sPre = '<span class="flagged">' . $sPre;
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
443 foreach ($aOrder as $iCol) {
444 if (in_array($iCol, $show_label_columns)) {
445 $sLabelStart = '<label for="'.$form_id."_msg$i\">";
446 $sLabelEnd = '</label>';
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
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
469 if ($iCol !== SQM_COL_CHECK) {
470 $value = $sLabelStart.$sPre.$value.$sEnd.$sLabelEnd;
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>
482 echo '<td class="col_check">';
483 echo "<input type=\"checkbox\" name=\"msg[".$i."]\" id=\"".$form_id."_msg$i\" value=\"$iUid\" $checked/></td>";
487 $indent = $aCol['indent'];
488 $sText = " <td class=\"col_subject\" $javascript_auto_click>";
489 if ($align['left'] == 'left') {
490 $sText .= str_repeat(' ',$indent);
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\');"';
503 if ($align['left'] == 'right') {
504 $sText .= str_repeat(' ',$indent);
506 echo $sText."</td>\n";
510 $sText = " <td class=\"col_flags\" $javascript_auto_click>"
514 case SQM_COL_INT_DATE:
516 $sText = " <td class=\"col_date\" $javascript_auto_click>"
521 $sText = " <td class=\"col_text\" $javascript_auto_click";
523 $sText .= "><a href=\"$link\"";
524 if ($target) { $sText .= " target=\"$target\"";}
525 if ($title) { $sText .= " title=\"$title\"" ;}
528 if ($title) {$sText .= " title=\"$title\"";}
532 if ($link) { $sText .= '</a>';}
533 echo $sText."</td>\n";
539 $sLine = "<tr><td colspan=\"$iColCnt\" class=\"spacer\"></td></tr>\n";
543 * End displaying row part
548 <!-- Message headers end -->
555 <tr><td class="spacer"></td></tr>
558 <table class="table_standard" cellspacing="0">
561 <table class="table_empty" cellspacing="0">
563 <td class="links_paginator"><?php
565 * The following line gets the output from a separate
566 * template altogether (called "paginator.tpl").
567 * $this is the Template class object.
569 $paginator_str = $this->fetch('paginator.tpl');
571 if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
573 <td class="message_count"><?php echo $msg_cnt_str; ?></td>
583 <?php if (!empty($plugin_output['mailbox_index_after'])) echo $plugin_output['mailbox_index_after']; ?>
590 <?php if (!$hide_sm_attributions): ?>
591 <p class="sqm_squirrelcopyright">© <?php echo SM_COPYRIGHT ?> The SquirrelMail Project Team - <a href="about.php">About SquirrelMail</a></p>