Do it the right way
[squirrelmail.git] / templates / default / message_list.tpl
index 6040788559f3e3bcf06594dbfa1f3e4e7bf646ab..81c221e793b5e5b7bbfaf6cf0250303539bdaad8 100644 (file)
@@ -57,6 +57,8 @@
  *    $use_icons
  *    $alt_index_colors
  *    $fancy_index_highlite
+ *    $aSortSupported
+ *    $show_label_columns
  *    $compact_paginator
  *    $aErrors
  *
  * @subpackage templates
  */
 
+
 /** add required includes */
-include_once(SM_PATH . 'templates/util_message_list.php');
+include_once(SM_PATH . 'functions/template/message_list_util.php');
+
 
 /* retrieve the template vars */
 extract($t);
 
-//FIXME: no hooks in templates!
-global $null;
-do_hook('mailbox_index_before', $null);
+
+if (!empty($plugin_output['mailbox_index_before'])) echo $plugin_output['mailbox_index_before'];
+
 
 /**
  * Calculate string "Viewing message x to y (z total)"
@@ -83,61 +87,22 @@ do_hook('mailbox_index_before', $null);
 $msg_cnt_str = '';
 if ($pageOffset < $end_msg) {
     $msg_cnt_str = sprintf(_("Viewing Messages: %s to %s (%s total)"),
-                    '<em>'.$pageOffset.'</em>', '<em>'.$end_msg.'</em>', $iNumberOfMessages);
+                           '<em>' . $pageOffset . '</em>',
+                           '<em>' . $end_msg . '</em>',
+                           $iNumberOfMessages);
 } else if ($pageOffset == $end_msg) {
-    $msg_cnt_str = sprintf(_("Viewing Message: %s (%s total)"), '<em>'.$pageOffset.'</em>', $iNumberOfMessages);
+    $msg_cnt_str = sprintf(_("Viewing Message: %s (%s total)"),
+                           '<em>' . $pageOffset . '</em>',
+                           $iNumberOfMessages);
 }
 
 
-
-if (!($sort & SQSORT_THREAD) && $enablesort) {
-    $aSortSupported = array(SQM_COL_SUBJ =>     array(SQSORT_SUBJ_ASC     , SQSORT_SUBJ_DESC),
-                            SQM_COL_DATE =>     array(SQSORT_DATE_DESC    , SQSORT_DATE_ASC),
-                            SQM_COL_INT_DATE => array(SQSORT_INT_DATE_DESC, SQSORT_INT_DATE_ASC),
-                            SQM_COL_FROM =>     array(SQSORT_FROM_ASC     , SQSORT_FROM_DESC),
-                            SQM_COL_TO =>       array(SQSORT_TO_ASC       , SQSORT_TO_DESC),
-                            SQM_COL_CC =>       array(SQSORT_CC_ASC       , SQSORT_CC_DESC),
-                            SQM_COL_SIZE =>     array(SQSORT_SIZE_ASC     , SQSORT_SIZE_DESC));
-} else {
-    $aSortSupported = array();
-}
-
-// figure out which columns should serve as labels for checkbox:
-// we try to grab the two columns before and after the checkbox,
-// except the subject column, since it is the link that opens
-// the message view
-//
-// if $javascript_on is set, then the highlighting code takes
-// care of this; just skip it
-//
-$show_label_columns = array();
-$index_order_part = array();
-if (!($javascript_on && $fancy_index_highlite)) {
-    $get_next_two = 0;
-    $last_order_part = 0;
-    $last_last_order_part = 0;
-    foreach ($aOrder as $index_order_part) {
-        if ($index_order_part == SQM_COL_CHECK) {
-            $get_next_two = 1;
-            if ($last_last_order_part != SQM_COL_SUBJ)
-                $show_label_columns[] = $last_last_order_part;
-            if ($last_order_part != SQM_COL_SUBJ)
-                $show_label_columns[] = $last_order_part;
-
-        } else if ($get_next_two > 0 && $get_next_two < 3 && $index_order_part != SQM_COL_SUBJ) {
-            $show_label_columns[] = $index_order_part;
-            $get_next_two++;
-        }
-        $last_last_order_part = $last_order_part;
-        $last_order_part = $index_order_part;
-    }
-}
-
 /**
  * All icon functionality is now handled through $icon_theme_path.
  * $icon_theme_path will contain the path to the user-selected theme.  If it is
  * NULL, the user and/or admin have turned off icons.
-*/
+ */
+
 
 // set this to an empty string to turn off extra
 // highlighting of checked rows
@@ -145,6 +110,7 @@ if (!($javascript_on && $fancy_index_highlite)) {
 //$clickedColor = '';
 $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
 
+
 ?>
 <div id="message_list">
 <form id="<?php echo $form_name;?>" name="<?php echo $form_name;?>" method="post" action="<?php echo $php_self;?>">
@@ -159,8 +125,10 @@ $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
               <td class="links_paginator">
 <!-- paginator and thread link string -->
                   <?php
-                      /**
-                       * because the template is included in the display function we refer to $oTemplate with $this
+                     /**
+                       * The following line gets the output from a separate 
+                       * template altogether (called "paginator.tpl").
+                       * $this is the Template class object.
                        */
                       $paginator_str = $this->fetch('paginator.tpl');
                       echo $paginator_str . $thread_link_str ."\n"; ?>
@@ -179,76 +147,14 @@ $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
 <!-- start message list form control -->
       <tr class="message_list_controls">
         <td>
-          <table class="table_empty" cellspacing="0">
-            <tr>
-              <td class="message_control_buttons">
-
-<?php
-        foreach ($aFormElements as $key => $value) {
-            switch ($value[1]) {
-            case 'submit':
-                if ($key != 'moveButton' && $key != 'copyButton' && $key != 'delete' && $key != 'undeleteButton') { // add move in a different table cell
-?>
-                  <input type="submit" name="<?php echo $key; ?>" value="<?php echo $value[0]; ?>" class="message_control_button" />&nbsp;
-<?php
-                }
-                break;
-            case 'checkbox':
-                if ($key != 'bypass_trash') {
-?>
-                  <input type="checkbox" name="<?php echo $key; ?>" id="<?php echo $key; ?>" /><label for="<?php echo $key; ?>"><?php echo $value[0]; ?></label>&nbsp;
-<?php
-                }
-                break;
-            case 'hidden':
-                 echo '<input type="hidden" name="'.$key.'" value="'. $value[0]."\">\n";
-                 break;
-            default: break;
-            }
-        }
-?>
-              </td>
-              <td class="message_control_delete">
-
-
-<?php
-        if (isset($aFormElements['delete'])) {
-?>
-                  <input type="submit" name="delete" value="<?php echo $aFormElements['delete'][0]; ?>" class="message_control_button" />&nbsp;
- <?php
-            if (isset($aFormElements['bypass_trash'])) {
-?>
-                  <input type="checkbox" name="bypass_trash" id="bypass_trash" /><label for="bypass_trash"><?php echo $aFormElements['bypass_trash'][0]; ?></label>&nbsp;
-<?php
-            }
-            if (isset($aFormElements['undeleteButton'])) {
-?>
-                  <input type="submit" name="undeleteButton" value="<?php echo $aFormElements['undeleteButton'][0]; ?>" class="message_control_button" />&nbsp;
-<?php
-            }
-?>
-              </td>
-<?php
-        } // if (isset($aFormElements['delete']))
-        if (isset($aFormElements['moveButton']) || isset($aFormElements['copyButton'])) {
-?>
-              <td class="message_control_move">
-                    <select name="targetMailbox">
-                       <?php echo $aFormElements['targetMailbox'][0];?>
-                    </select>
-<?php         if (isset($aFormElements['moveButton'])) { ?>
-                  <input type="submit" name="moveButton" value="<?php echo $aFormElements['moveButton'][0]; ?>" class="message_control_button" />
-<?php         }
-              if (isset($aFormElements['copyButton'])) { ?>
-                  <input type="submit" name="copyButton" value="<?php echo $aFormElements['copyButton'][0]; ?>" class="message_control_button" />
-<?php         } ?>
-              </td>
-
-<?php
-        } // if (isset($aFormElements['move']))
-?>
-            </tr>
-          </table>
+                  <?php
+                     /**
+                       * The following line gets the output from a separate
+                       * template altogether (called "message_list_controls.tpl").
+                       * $this is the Template class object.
+                       */
+                      $message_list_controls = $this->fetch('message_list_controls.tpl');
+                      echo $message_list_controls ."\n"; ?>
         </td>
       </tr>
 <!-- end message list form control -->
@@ -256,10 +162,7 @@ $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
     } // if (count($aFormElements))
 ?>
     </table>
-<?php
-    //FIXME: no hooks in templates!
-    do_hook('mailbox_form_before', $null);
-?>
+<?php if (!empty($plugin_output['mailbox_form_before'])) echo $plugin_output['mailbox_form_before']; ?>
     </td>
   </tr>
   <tr><td class="spacer"></td></tr>
@@ -277,12 +180,16 @@ $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
  * this issue.  We will use TR/TD w/ another CSS class to work around this.
  */
 ?>
+
               <tr class="headerRow">
+
 <?php
     $aWidth = calcMessageListColumnWidth($aOrder);
     foreach($aOrder as $iCol) {
 ?>
+
                     <td style="width:<?php echo $aWidth[$iCol]; ?>%">
+
 <?php
         switch ($iCol) {
           case SQM_COL_CHECK:
@@ -347,29 +254,31 @@ $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
 
 <!-- Message headers start -->
 <?php
+
             $i = 0;
             $iColCnt = count($aOrder);
             $sLine = '';
 
+
             // this stuff does the auto row highlighting on mouseover
             //
             if ($javascript_on && $fancy_index_highlite) {
-
                 $mouseoverColor = $color[5];
-
-                // set this to an empty string to turn off extra
-                // highlighting of checked rows
-                //
-                //$clickedColor = '';
-                $clickedColor = (!empty($color[16])) ? $color[16] : $color[2];
-
                 $checkbox_javascript = ' onclick="this.checked = !this.checked;"';
+                // $clickedColor is defined at top of this file
             } else {
                 $checkbox_javascript = '';
             }
+
+
+            /**
+              * main message iteration loop
+              */
             foreach ($aMessages as $iUid => $aMsg) {
+
                 echo $sLine;
 
+
 /**
 * Display message header row in messages list
 *
@@ -426,7 +335,7 @@ $clickedColor = (empty($color[16])) ? $color[2] : $color[16];
     // this stuff does the auto row highlighting on mouseover
     //
     if ($javascript_on && $fancy_index_highlite) {
-        $row_extra .= ' onmouseover="rowOver(\''.$form_id . '_msg' . $i.'\');" onmouseout="setPointer(this, ' . $i . ', \'out\', \'' . $class . '\', \'mouse_over\', \'clicked\');" onmousedown="setPointer(this, ' . $i . ', \'click\', \'' . $class . '\', \'mouse_over\', \'clicked\');"';
+        $row_extra = ' onmouseover="rowOver(\''.$form_id . '_msg' . $i.'\');" onmouseout="setPointer(this, ' . $i . ', \'out\', \'' . $class . '\', \'mouse_over\', \'clicked\');" onmousedown="setPointer(this, ' . $i . ', \'click\', \'' . $class . '\', \'mouse_over\', \'clicked\');"';
     }
     // this does the auto-checking of the checkbox no matter
     // where on the row you click
@@ -488,7 +397,6 @@ if ($class != 'even' && $class != 'odd')
         $link       = (isset($aCol['link']))       ? $aCol['link']       : '';
         $link_extra = (isset($aCol['link_extra'])) ? $aCol['link_extra'] : '';
         $onclick    = (isset($aCol['onclick']))    ? $aCol['onclick']    : '';
-        $link       = (isset($aCol['link']))       ? $aCol['link']       : '';
         $value      = (isset($aCol['value']))      ? $aCol['value']      : '';
         $target     = (isset($aCol['target']))     ? $aCol['target']     : '';
         if ($iCol !== SQM_COL_CHECK) {
@@ -504,7 +412,7 @@ if ($class != 'even' && $class != 'odd')
             <?php
             } else {
                 echo '<td class="col_check">';
-                $checked = ($checkall) ? " checked=checked " : " ";
+                $checked = ($checkall) ? ' checked=checked ' : '';
                 echo "<input type=\"checkbox\" name=\"msg[".$i."]\" id=\"".$form_id."_msg$i\" value=\"$iUid\" $checked/></td>";
             }
             break;
@@ -524,8 +432,8 @@ if ($class != 'even' && $class != 'odd')
                             'parentNode.parentNode, ' . $i . ', \'click\', \''. $class. '\', \'mouse_over\', \'' .
                              $clickedColor .'\');"';
             }
-            $sText .= ">";
-            $sText .= $value . '</a>';
+            $sText .= ">"
+                   . $value . '</a>';
             if ($align['left'] == 'right') {
                 $sText .= str_repeat('&nbsp;&nbsp;',$indent);
             }
@@ -533,14 +441,14 @@ if ($class != 'even' && $class != 'odd')
             break;
           case SQM_COL_SIZE:
           case SQM_COL_FLAGS:
-            $sText = "    <td class=\"col_flags\" $javascript_auto_click>";
-            $sText .= "$value</td>\n";
+            $sText = "    <td class=\"col_flags\" $javascript_auto_click>"
+                   . "$value</td>\n";
             echo $sText;
             break;
           case SQM_COL_INT_DATE:
           case SQM_COL_DATE:
-            $sText = "    <td class=\"col_date\" $javascript_auto_click>";
-            $sText .= $value. "</td>\n";
+            $sText = "    <td class=\"col_date\" $javascript_auto_click>"
+                   . $value. "</td>\n";
             echo $sText;
             break;
           default:
@@ -560,9 +468,8 @@ if ($class != 'even' && $class != 'odd')
             break;
         }
     }
-?>
-                  </tr>
-<?php
+
+            echo '</tr>';
             $sLine = "<tr><td colspan=\"$iColCnt\" class=\"spacer\"></td></tr>\n";
             ++$i;
 
@@ -587,7 +494,15 @@ if ($class != 'even' && $class != 'odd')
               <td>
                 <table class="table_empty" cellspacing="0">
                   <tr>
-                    <td class="links_paginator"><?php echo $paginator_str; ?></td>
+                    <td class="links_paginator"><?php 
+                     /**
+                       * The following line gets the output from a separate 
+                       * template altogether (called "paginator.tpl").
+                       * $this is the Template class object.
+                       */
+                      $paginator_str = $this->fetch('paginator.tpl');
+                      echo $paginator_str; 
+                    ?></td>
                     <td class="message_count"><?php echo $msg_cnt_str; ?></td>
                   </tr>
                 </table>
@@ -598,7 +513,7 @@ if ($class != 'even' && $class != 'odd')
       </tr>
       <tr>
         <td>
-        <?php /* FIXME: no hooks in templates!! */ do_hook('mailbox_index_after', $null); ?>
+<?php if (!empty($plugin_output['mailbox_index_after'])) echo $plugin_output['mailbox_index_after']; ?>
         </td>
       </tr>
     </table>