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