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