From 6373ad1237c82a561fec8264457e3a3a845f7e87 Mon Sep 17 00:00:00 2001
From: stevetruckstuff <stevetruckstuff@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Fri, 24 Feb 2006 22:31:40 +0000
Subject: [PATCH 1/1] Incoproated template config file.  Templates can now
 include their own javascript files.  If a template pack does not incorporate
 a specific template, the default template will be used instead.

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@10825 7612ce4b-ef26-0410-bec9-ea0150e637f0
---
 functions/page_header.php      |  17 ++-
 include/load_prefs.php         |   3 +
 src/left_main.php              | 266 +++------------------------------
 src/style.php                  |  10 +-
 templates/default/template.php |  46 ++++++
 5 files changed, 94 insertions(+), 248 deletions(-)
 create mode 100644 templates/default/template.php

diff --git a/functions/page_header.php b/functions/page_header.php
index bfdc5872..70d289aa 100644
--- a/functions/page_header.php
+++ b/functions/page_header.php
@@ -195,7 +195,11 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
     }
 
     if( $javascript_on || strpos($sHeaderJs, 'new_js_autodetect_results.value') ) {
-        $sJsBlock = '<script src="'. $sTplDir. 'js/default.js" type="text/javascript"></script>' ."\n";
+        $js_includes = $oTemplate->getJavascriptIncludes();
+        $sJsBlock = '';
+        foreach ($js_includes as $js_file) {
+            $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
+        }
         if ($sHeaderJs) {
             $sJsBlock .= "\n<script type=\"text/javascript\">" .
                         "\n<!--\n" .
@@ -248,7 +252,7 @@ function displayPageHeader($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
  */
 function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
 
-    global $reply_focus, $javascript_on, $action;
+    global $reply_focus, $javascript_on, $action, $oTemplate;
 
     if (empty($sBodyTagJs)) {
         if (strpos($action, 'reply') !== FALSE && $reply_focus) {
@@ -275,7 +279,14 @@ function compose_Header($color, $mailbox, $sHeaderJs='', $sBodyTagJs = '') {
         } else {
         $sJsBlock = '';
         }
-        $sJsBlock .= "\n" . '<script src="'. SM_PATH .'templates/default/js/default.js" type="text/javascript"></script>' ."\n";
+        $sJsBlock .= "\n";
+
+        $js_includes = $oTemplate->getJavascriptIncludes();
+        var_dump($js_includes);
+        foreach ($js_includes as $js_file) {
+            $sJsBlock .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
+        }
+
         displayHtmlHeader (_("Compose"), $sJsBlock);
     } else {
         /* javascript off */
diff --git a/include/load_prefs.php b/include/load_prefs.php
index 337efc1d..5e11b45f 100644
--- a/include/load_prefs.php
+++ b/include/load_prefs.php
@@ -104,6 +104,9 @@ if (!defined('download_php')) {
 
 // user's icon theme, if using icons
 $icon_theme = getPref($data_dir, $username, 'icon_theme', 'images/themes/xp/' );
+if ($icon_theme == 'template') {
+    $icon_theme = $sTplDir . 'images/';
+}
 
 /*
  * NOTE: The $icon_theme_path var should contain the path to the icon 
diff --git a/src/left_main.php b/src/left_main.php
index d0ab3361..13eb9055 100644
--- a/src/left_main.php
+++ b/src/left_main.php
@@ -34,200 +34,6 @@ include_once(SM_PATH . 'templates/util_left_main.php');
 define('SM_BOX_UNCOLLAPSED', 0);
 define('SM_BOX_COLLAPSED',   1);
 
-/* --------------------- FUNCTIONS ------------------------- */
-
-
-
-/**
- * Recursive functions to output a tree of folders.
- * They are called on a list of boxes and iterates over that tree.
- *
- * NOTE: These functions are deprecated and replaced with templates in 1.5.2.
- *       They remain until the advanced tree tempalte is completed also,
- *       at which point both functions below will be removed
- * 
- * @since 1.3.0
- * @deprecated
- */
-function ListBoxes ($boxes, $j=0) {
-    return '';
-}
-
-function ListAdvancedBoxes ($boxes, $mbx, $j='ID.0000' ) {
-    global $data_dir, $username, $color, $unseen_notify, $unseen_type, $unseen_cum,
-        $move_to_trash, $trash_folder, $collapse_folders, $use_special_folder_color;
-
-    if (empty($boxes)) {
-        return;
-    }
-
-    /* use_folder_images only works if the images exist in ../images */
-    $use_folder_images = true;
-
-    $pre = '';
-    $end = '';
-    $collapse = false;
-    $unseen_found = false;
-    $unseen = 0;
-
-    $mailbox = $boxes->mailboxname_full;
-    $mailboxURL = urlencode($mailbox);
-
-     /* get collapse information */
-     if ($collapse_folders) {
-          $form_entry = $j.'F';
-          if (isset($mbx) && isset($mbx[$form_entry])) {
-              $collapse = $mbx[$form_entry];
-              setPref($data_dir, $username, 'collapse_folder_'.$boxes->mailboxname_full ,
-                    $collapse ? SM_BOX_COLLAPSED : SM_BOX_UNCOLLAPSED);
-          } else {
-              $collapse = getPref($data_dir, $username, 'collapse_folder_' . $mailbox);
-              $collapse = ($collapse == '' ? SM_BOX_UNCOLLAPSED : $collapse);
-          }
-          $img_src = ($collapse ? '../images/plus.png' : '../images/minus.png');
-          $collapse_link = '<a href="javascript:void(0)">' .
-                    " <img src=\"$img_src\" border=\"1\" id=$j onclick=\"hidechilds(this)\" style=\"cursor:hand\" /></a>";
-    } else {
-         $collapse_link='';
-    }
-
-    /* get unseen/total messages information */
-    /* Only need to display info when option is set */
-    if (isset($unseen_notify) && ($unseen_notify > 1)) {
-        /* handle Cumulative Unread Message Notification */
-        if ($collapse && $unseen_cum) {
-            foreach ($boxes->mbxs as $cumn_box) {
-                if (!empty($cumn_box->unseen)) $boxes->unseen += $cumn_box->unseen;
-                if (!empty($cumn_box->total)) $boxes->total += $cumn_box->total;
-            }
-        }
-        if (($boxes->unseen !== false) || ($boxes->total !== false)) {
-            if ($boxes->unseen !== false)     $unseen = $boxes->unseen;
-               /*
-                * Should only display unseen info if the folder is inbox
-                * or you set the option for all folders
-                */
-                if ((strtolower($mailbox) == 'inbox') || ($unseen_notify == 3)) {
-                     $unseen_string = $unseen;
-
-                    /* If users requests, display message count too */
-                    if (isset($unseen_type) && ($unseen_type == 2) && ($boxes->total !== false)) {
-                        $unseen_string .= '/' . $boxes->total;
-                    }
-                    if (isset($boxes->recent) && $boxes->recent > 0) {
-                        $unseen_string = "<span class=\"leftrecent\">($unseen_string)</span>";
-                    } else {
-                        $unseen_string = "<span class=\"leftunseen\">($unseen_string)</span>";
-                    }
-
-                    /*
-                     * Finally allow the script to display the values by setting a boolean.
-                     * This can only occur if the unseen count is great than 0 (if you have
-                     * unseen count only), or you have the message count too.
-                     */
-                     if (($unseen > 0) || (isset($unseen_type) && ($unseen_type ==2))) {
-                         $unseen_found = true;
-                     }
-            }
-        }
-    }
-
-    /* If there are unseen message, bold the line. */
-    if ($unseen > 0) { $pre .= '<b>'; }
-
-    /* color special boxes */
-    if ($use_special_folder_color && $boxes->is_special) {
-        $pre .= "<span class=\"leftspecial\">";
-        $end .= '</span>';
-    }
-
-    /* If there are unseen message, close bolding. */
-    if ($unseen > 0) { $end .= '</b>'; }
-
-    /* Print unseen information. */
-    if ($unseen_found) {
-        $end .= "&nbsp;$unseen_string";
-    }
-
-    if (($move_to_trash) && ($mailbox == $trash_folder)) {
-        $pre = "<a class=\"mbx_link\" href=\"right_main.php?PG_SHOWALL=0&amp;startMessage=1&amp;mailbox=$mailboxURL\" target=\"right\">" . $pre;
-        $end .= '</a>';
-        $end .= "\n<small>\n" .
-                '&nbsp;&nbsp;[<a class="mbx_link" href="empty_trash.php">'._("Purge").'</a>]'.
-                '</small>';
-    } else {
-        if (!$boxes->is_noselect) { /* \Noselect boxes can't be selected */
-            $pre = "<a class=\"mbx_link\" href=\"right_main.php?PG_SHOWALL=0&amp;startMessage=1&amp;mailbox=$mailboxURL\" target=\"right\">" . $pre;
-            $end .= '</a>';
-        }
-    }
-
-    // let plugins fiddle with end of line
-    global $imapConnection;
-    $end .= concat_hook_function('left_main_after_each_folder',
-        array(isset($numMessages) ? $numMessages : '',
-              $boxes->mailboxname_full, $imapConnection));
-
-    $out = '';
-    if (!$boxes->is_root) {
-        if ($use_folder_images) {
-            if ($boxes->is_inbox) {
-                $folder_img = '../images/inbox.png';
-            } else if ($boxes->is_sent) {
-                $folder_img = '../images/senti.png';
-            } else if ($boxes->is_trash) {
-                $folder_img = '../images/delitem.png';
-            } else if ($boxes->is_draft) {
-                $folder_img = '../images/draft.png';
-            } else if ($boxes->is_noinferiors) {
-                $folder_img = '../images/folder_noinf.png';
-            } else {
-                $folder_img = '../images/folder.png';
-            }
-            $folder_img = '&nbsp;<img src="'.$folder_img.'" height="15" />&nbsp;';
-        } else {
-            $folder_img = '';
-        }
-        if (!isset($boxes->mbxs[0])) {
-            $out .= '   ' . html_tag( 'div',
-                            $pre . $folder_img .
-                                str_replace( array(' ','<','>'),
-                                             array('&nbsp;','&lt;','&gt;'),
-                                             $boxes->mailboxname_sub) .
-                                $end,
-                            'left', '', 'class="mbx_sub" id="' .$j. '"' ) . "\n";
-        } else {
-
-            $out .= '   ' . html_tag( 'div',
-                            $collapse_link . $pre . $folder_img . '&nbsp;'. $boxes->mailboxname_sub . $end ,
-                            'left', '', 'class="mbx_par" id="' .$j. 'P"' ) . "\n";
-            $out .= '   <input type="hidden" name="mbx['.$j. 'F]" value="'.$collapse.'" id="mbx['.$j.'F]" />'."\n";
-        }
-    }
-
-    $visible = ($collapse ? ' style="display:none"' : ' style="display:block"');
-    if (isset($boxes->mbxs[0]) && !$boxes->is_root) /* mailbox contains childs */
-        $out .= html_tag( 'div', '', 'left', '', 'class="par_area" id='.$j.'.0000 '. $visible ) . "\n";
-
-    if ($j !='ID.0000') {
-       $j = $j .'.0000';
-    }
-    for ($i = 0; $i <count($boxes->mbxs); $i++) {
-        $j++;
-        $out .= ListAdvancedBoxes($boxes->mbxs[$i],$mbx,$j);
-    }
-    if (isset($boxes->mbxs[0]) && !$boxes->is_root) {
-        $out .= '</div>'."\n\n";
-    }
-    
-    return $out;
-}
-
-
-
-
-/* -------------------- MAIN ------------------------ */
-
 /* get globals */
 sqgetGlobalVar('username', $username, SQ_SESSION);
 sqgetGlobalVar('key', $key, SQ_COOKIE);
@@ -236,7 +42,6 @@ sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
 
 sqgetGlobalVar('fold', $fold, SQ_GET);
 sqgetGlobalVar('unfold', $unfold, SQ_GET);
-
 /* end globals */
 
 // open a connection on the imap port (143)
@@ -256,19 +61,13 @@ if (!empty($left_refresh) &&
 }
 
 /**
- * $advanced_tree and is a boolean var which is default set to default
- * SM behaviour.
- * Setting $advanced tree to true causes SM to display a experimental
- * mailbox-tree with dhtml behaviour.  
- * 
- * See templates/default/left_main_advanced.tpl
- **/
-
-/* set this to true if you want to see a nicer mailboxtree */
-if (empty($advanced_tree)) {
-    $advanced_tree=false;
+ * Include extra javascript files needed by template
+ */
+$js_includes = $oTemplate->getJavascriptIncludes();
+foreach ($js_includes as $js_file) {
+    $xtra .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
 }
-
+ 
 // get mailbox list and cache it
 $mailboxes=sqimap_get_mailboxes($imapConnection,false,$show_only_subscribed_folders);
 
@@ -381,46 +180,29 @@ if (empty($unseen_notify)) {
  * sqimap_mailbox_tree() so that the cached mailbox list can be used elsewhere in left_main and beyond
  */
 $boxes = sqimap_mailbox_tree($imapConnection,$mailboxes,$show_only_subscribed_folders);
-
-$mailbox_listing = '';
-if (isset($advanced_tree) && $advanced_tree) {
-    $mailbox_listing = '<form name="collapse" action="left_main.php" method="post" ' .
-         'enctype="multipart/form-data">'."\n";
-    $mailbox_listing .= '<button type="submit" class="button" onmouseover="buttonover(this,true)" onmouseout="buttonover(this,false)" onmousedown="buttonclick(this,true)" onmouseup="buttonclick(this,false)">'. _("Save folder tree") .'</button><br /><br />';
-    $mailbox_listing .= '<div id="mailboxes" class="mailboxes">'."\n\n";
-    sqgetGlobalVar('mbx', $mbx, SQ_POST);
-    if (!isset($mbx)) $mbx=NULL;
-    $mailbox_listing .=ListAdvancedBoxes($boxes, $mbx);
-    $mailbox_listing .= '</div>';
-    $mailbox_listing .= '</form>'."\n";
-} else {
-    $mailbox_listing = ListBoxes($boxes);
-}
-
 $mailbox_structure = getBoxStructure($boxes);
 
 $oTemplate->assign('clock', $clock);
-$oTemplate->assign('mailbox_listing', $mailbox_listing);
-$oTemplate->assign('location_of_bar', $location_of_bar);
-$oTemplate->assign('left_size', $left_size);
-
 $oTemplate->assign('mailboxes', $mailbox_structure);
-$oTemplate->assign('imapConnection', $imapConnection);
-
-$oTemplate->assign('unread_notification_enabled', $unseen_notify!=1);
-$oTemplate->assign('unread_notification_cummulative', $unseen_cum==1);
-$oTemplate->assign('unread_notification_allFolders', $unseen_notify == 3);
-$oTemplate->assign('unread_notification_displayTotal', $unseen_type == 2);
-$oTemplate->assign('collapsable_folders_enabled', $collapse_folders==1);
-$oTemplate->assign('icon_theme_path', $icon_theme_path);
-$oTemplate->assign('use_special_folder_color', $use_special_folder_color);
-$oTemplate->assign('message_recycling_enabled', $move_to_trash);
 
-if (isset($advanced_tree) && $advanced_tree)    {
-    $oTemplate->display('left_main_advanced.tpl');
-}   else    { 
-    $oTemplate->display('left_main.tpl');
-}
+/*
+ * Build an array to pass user prefs to the template in order to avoid using
+ * globals, which are dirty, filthy things in templates. :)
+ */
+$settings = array();
+$settings['imapConnection'] = $imapConnection;
+$settings['iconThemePath'] = $icon_theme_path;
+$settings['templateDirectory'] = $sTplDir;
+$settings['unreadNotificationEnabled'] = $unseen_notify!=1;
+$settings['unreadNotificationAllFolders'] = $unseen_notify == 3;
+$settings['unreadNotificationDisplayTotal'] = $unseen_type == 2;
+$settings['unreadNotificationCummulative'] = $unseen_cum==1;
+$settings['useSpecialFolderColor'] = $use_special_folder_color;
+$settings['messageRecyclingEnabled'] = $move_to_trash;
+$settings['collapsableFoldersEnabled'] = $collapse_folders==1;
+$oTemplate->assign('settings', $settings);
+
+$oTemplate->display('left_main.tpl');
 
 sqimap_logout($imapConnection);
 $oTemplate->display('footer.tpl');
diff --git a/src/style.php b/src/style.php
index 15853436..2f510033 100644
--- a/src/style.php
+++ b/src/style.php
@@ -34,9 +34,13 @@ if (!isset($fontsets) || !is_array($fontsets)) {
 /** start block copy from right_main.php */
 include_once(SM_PATH . 'class/template/template.class.php');
 
-/* get template name and set used template directory */
-if (sqgetGlobalVar('templateid',$templateid,SQ_GET) &&
-    file_exists(SM_PATH.'templates/'.basename($templateid).'/stylesheet.tpl')) {
+/**
+ *  get template name and set used template directory
+ * 
+ *  Existing file check has been moved into the template object, so it is
+ *  not neccesary to do file_exists() here. 
+ * */
+if (sqgetGlobalVar('templateid',$templateid,SQ_GET)) {
     $sTplDir = SM_PATH.'templates/'.basename($templateid).'/';
 } else {
     $sTplDir = SM_PATH.'templates/default/';
diff --git a/templates/default/template.php b/templates/default/template.php
new file mode 100644
index 00000000..12a204a5
--- /dev/null
+++ b/templates/default/template.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * Provides some basic configuration options to the template engine
+ *
+ * @copyright &copy; 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage templates
+ */
+
+/**
+ * Each template provided by this set should be listed in this array.  If a
+ * template is requested that is not listed here, the default template will be
+ * displayed.  The templates listed below must be in the same directory as
+ * this file, e.g. the template root directory.
+ */
+$templates_provided = array (
+                                'error_message.tpl',
+                                'footer.tpl',
+                                'left_main.tpl',
+                                'login.tpl',
+                                'message_list.tpl',
+                                'page_header.tpl',
+                                'paginator.tpl',
+                                'stylesheet.tpl'
+                            );
+
+/**
+ * Required Javascript files for this template set.  If a JS file is listed
+ * here, but not listed in the provided js files below, SquirrelMail will use
+ * the file by the same name in the default template directory.
+ */
+$required_js_files = array  (
+                                'default.js'
+                            );
+                            
+/**
+ * Any aditional Javascript files that are needed by this template should be
+ * listed in this array.  Javascript files must be in a directory called "js/"
+ * within the template root directory.
+ */
+$provided_js_files = array  (
+                                'default.js'
+                            );
+?>
\ No newline at end of file
-- 
2.25.1