Add support for user-provided alternate stylesheets
[squirrelmail.git] / include / options / display.php
index 813589acf56ced46eba42fcfb5a61a9424b294e6..2774c9c372dbd52ce24bc201c2cd8d2810500826 100644 (file)
@@ -16,6 +16,11 @@ define('SMOPT_GRP_GENERAL', 0);
 define('SMOPT_GRP_MAILBOX', 1);
 define('SMOPT_GRP_MESSAGE', 2);
 
+/**
+ * Icon themes and user CSS themes should probably both be moved to conf.pl
+ * 
+ * TODO: move to conf.pl
+ **/
 // load icon themes if in use
 global $use_icons;
 if ($use_icons) {
@@ -32,6 +37,19 @@ if ($use_icons) {
     }
 }
 
+// load user-provided CSS themes
+global $css_themes;
+$dirName = SM_PATH . 'css';
+if (is_readable($dirName) && is_dir($dirName)) {
+    $d = dir($dirName);
+    while($dir = $d->read()) {
+        if ($dir != "." && $dir != "..") {
+            if (is_dir($dirName."/".$dir) && file_exists("$dirName/$dir/config.php"))
+                include("$dirName/$dir/config.php");
+        }
+    }
+}
+
 global $use_iframe;
 if (! isset($use_iframe)) $use_iframe=false;
 
@@ -49,9 +67,10 @@ if (! isset($use_iframe)) $use_iframe=false;
  * @return array all option information
  */
 function load_optpage_data_display() {
-    global $theme, $fontsets, $language, $languages,
+    global $theme, $fontsets, $language, $languages,$aTemplateSet,
     $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
-    $show_alternative_names, $use_icons, $use_iframe;
+    $show_alternative_names, $use_icons, $use_iframe, $sTemplateID, 
+    $oTemplate, $css_themes;
 
     /* Build a simple array into which we will build options. */
     $optgrps = array();
@@ -65,53 +84,99 @@ function load_optpage_data_display() {
     $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options");
     $optvals[SMOPT_GRP_GENERAL] = array();
 
+    /* load the template set option */
+    $templateset_values = array();
+
+    foreach ($aTemplateSet as $sKey => $aTemplateSetAttributes) {
+        $templateset_values[$aTemplateSetAttributes['NAME']] = $aTemplateSetAttributes['ID'];
+    }
+    ksort($templateset_values);
+    $templateset_values = array_flip($templateset_values);
+    // display template options only when there is more than one template
+    if (count($templateset_values)>1) {
+        $optvals[SMOPT_GRP_GENERAL][] = array(
+            'name'    => 'sTemplateID',
+            'caption' => _("Skin"),
+            'type'    => SMOPT_TYPE_STRLIST,
+            'refresh' => SMOPT_REFRESH_ALL,
+            'posvals' => $templateset_values,
+            'save'    => 'save_option_template'
+        );
+    }
+
     /* Load the theme option. */
+
+    /**
+     * User themes start with a 'u_', template themes start with a 't_' to
+     * differentiate which is which.  This seems kind of hackish, but we can
+     * come up with a better solution later.
+     * 
+     * TODO: Clean me.
+     **/
     $theme_values = array();
-    foreach ($theme as $theme_key => $theme_attributes) {
-        $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
+    
+    // Always provide the template default first.
+    $theme_values['none'] = 'Template Default Theme';
+
+    // List alternate themes provided by templates first
+/*
+ * Since this requires mods to the template class, I'm holding off on alternate
+ * template styles until Paul finishes template inheritence.
+ *      -- SB, 2006-09-30
+ * 
+    $template_provided = $oTemplate->get_alternative_stylesheets();
+    asort($template_provided);
+    foreach ($template_provided as $sheet=>$name) {
+        $theme_values['t_'.$sheet] = 'Template Theme - '.htmlspecialchars($name);
     }
-    ksort($theme_values);
-    $theme_values = array_flip($theme_values);
+*/
+    // Next, list styles provided in SM_PATH/css/
+    // FIXME, these should probably be defined in conf.pl!!
+    asort($css_themes);
+    foreach ($css_themes as $style) {
+        $theme_values['u_'.$style['PATH']] = 'User Theme - '.htmlspecialchars($style['NAME']);
+    }
+
     $optvals[SMOPT_GRP_GENERAL][] = array(
         'name'    => 'chosen_theme',
         'caption' => _("Theme"),
         'type'    => SMOPT_TYPE_STRLIST,
         'refresh' => SMOPT_REFRESH_ALL,
         'posvals' => $theme_values,
-        'save'    => 'save_option_theme'
+        'save'    => 'css_theme_save'
     );
 
-    $css_values = array( 'none' => _("Default" ) );
-    $css_dir = SM_PATH . 'themes/css';
-    if (is_readable($css_dir) && is_dir($css_dir)) {
-        $handle=opendir($css_dir);
-        while ($file = readdir($handle) ) {
-            if ( substr( $file, -4 ) == '.css' ) {
-                $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
-            }
+    /* Icon theme selection */
+    if ($use_icons) {
+        global $icon_themes, $icon_theme;
+
+        $temp = array();
+        $value = 0;
+        for ($count = 0; $count < sizeof($icon_themes); $count++) {
+            $temp[$icon_themes[$count]['PATH']] = $icon_themes[$count]['NAME'];
+        }
+        if (sizeof($icon_themes) > 0) {
+            $optvals[SMOPT_GRP_GENERAL][] = array(
+                'name'          => 'icon_theme',
+                'caption'       => _("Icon Theme"),
+                'type'          => SMOPT_TYPE_STRLIST,
+                'refresh'       => SMOPT_REFRESH_NONE,
+                'posvals'       => $temp,
+                'save'          => 'icon_theme_save'
+            );
         }
-        closedir($handle);
     }
 
-    /*
-    if ( count( $css_values ) > 1 ) {
+    $fontset_values = array();
+    $fontset_list = array();
 
-        $optvals[SMOPT_GRP_GENERAL][] = array(
-            'name'    => 'custom_css',
-            'caption' => _("Custom Stylesheet"),
-            'type'    => SMOPT_TYPE_STRLIST,
-            'refresh' => SMOPT_REFRESH_ALL,
-            'posvals' => $css_values
-        );
+    if (!empty($fontsets) && is_array($fontsets)) {
 
+        foreach (array_keys($fontsets) as $fontset_key) {
+            $fontset_list[$fontset_key]=$fontset_key;
+        }
+        ksort($fontset_list);
     }
-    */
-
-    $fontset_values = array();
-    foreach (array_keys($fontsets) as $fontset_key) {
-        $fontset_list[$fontset_key]=$fontset_key;
-    }
-    ksort($fontset_list);
 
     if (count($fontset_list) > 1) {
         $fontset_list = array_merge(array('' => _("Default font style")), $fontset_list);
@@ -153,7 +218,7 @@ function load_optpage_data_display() {
         array_merge(array('' => _("Default")), $language_values);
     $language = $squirrelmail_language;
 
-    // add language selection only when more than 2 languages are available 
+    // add language selection only when more than 2 languages are available
     // (default, English and some other)
     if (count($language_values)>2) {
         $optvals[SMOPT_GRP_GENERAL][] = array(
@@ -222,27 +287,6 @@ function load_optpage_data_display() {
         'refresh' => SMOPT_REFRESH_NONE
     );
 
-    if ($use_icons) {
-        global $icon_themes, $icon_theme;
-        $temp = array();
-        for ($count = 0; $count < sizeof($icon_themes); $count++) {
-            $temp[$count] = $icon_themes[$count]['NAME'];
-            if ($icon_theme == $icon_themes[$count]['PATH'])
-                $value = $count;
-        }
-        if (sizeof($icon_themes) > 0) {
-            $optvals[SMOPT_GRP_MAILBOX][] = array(
-                'name'          => 'icon_theme',
-                'caption'       => _("Message Flags Icon Theme"),
-                'type'          => SMOPT_TYPE_STRLIST,
-                'refresh'       => SMOPT_REFRESH_NONE,
-                'posvals'       => $temp,
-                'initial_value' => $value,
-                'save'          => 'icon_theme_save'
-            );
-        }
-    }
-
     $optvals[SMOPT_GRP_MAILBOX][] = array(
         'name'    => 'show_flag_buttons',
         'caption' => _("Show Flag / Unflag Buttons"),
@@ -250,6 +294,13 @@ function load_optpage_data_display() {
         'refresh' => SMOPT_REFRESH_NONE
     );
 
+    $optvals[SMOPT_GRP_MAILBOX][] = array(
+        'name'    => 'show_copy_buttons',
+        'caption' => _("Enable Message Copy Buttons"),
+        'type'    => SMOPT_TYPE_BOOLEAN,
+        'refresh' => SMOPT_REFRESH_NONE
+    );
+
     $optvals[SMOPT_GRP_MAILBOX][] = array(
         'name'    => 'page_selector',
         'caption' => _("Enable Page Selector"),
@@ -295,6 +346,7 @@ function load_optpage_data_display() {
         'size'    => SMOPT_SIZE_TINY
     );
 /*
+FIXME!
   disabled because the template doesn't support it (yet?)
     $optvals[SMOPT_GRP_MAILBOX][] = array(
         'name'    => 'show_recipient_instead',
@@ -377,7 +429,7 @@ function load_optpage_data_display() {
 
     $optvals[SMOPT_GRP_MESSAGE][] = array(
         'name'    => 'delete_prev_next_display',
-        'caption' => _("Show 'Delete & Prev/Next' Links"),
+        'caption' => _("Show 'Delete &amp; Prev/Next' Links"),
         'type'    => SMOPT_TYPE_BOOLEAN,
         'refresh' => SMOPT_REFRESH_ALL
     );
@@ -394,6 +446,29 @@ function load_optpage_data_display() {
 /** Define any specialized save functions for this option page. ***/
 /******************************************************************/
 
+/**
+ * This function saves a new template setting.
+ * It updates the template array.
+ */
+function save_option_template($option) {
+    global $aTemplateSet;
+
+    /* Do checking to make sure $new_theme is in the array. */
+    $templateset_in_array = false;
+    for ($i = 0; $i < count($aTemplateSet); ++$i) {
+        if ($aTemplateSet[$i]['ID'] == $option->new_value) {
+            $templateset_in_array = true;
+            break;
+        }
+    }
+
+    if (!$templateset_in_array) {
+        $option->new_value = '';
+    }
+    /* Save the option like normal. */
+    save_option($option);
+}
+
 /**
  * This function saves a new theme setting.
  * It updates the theme array.
@@ -430,18 +505,40 @@ function save_option_javascript_autodetect($option) {
  * This function saves the user's icon theme setting
  */
 function icon_theme_save($option) {
-
     global $icon_themes, $data_dir, $username;
 
 
     // Don't assume the new value is there, double check
     // and only save if found
     //
-    if (isset($icon_themes[$option->new_value]['PATH']))
-        setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value]['PATH']);
+    $found = false;
+    while (!$found && (list($index, $data) = each($icon_themes))) {
+        if ($data['PATH'] == $option->new_value)
+            $found = true;
+    }
+    if ($found)
+        setPref($data_dir, $username, 'icon_theme', $option->new_value);
     else
        setPref($data_dir, $username, 'icon_theme', 'none');
 
 }
 
-?>
\ No newline at end of file
+function css_theme_save ($option) {
+    global $css_themes, $data_dir, $username;
+
+    // Don't assume the new value is there, double check
+    // and only save if found
+    //
+    $found = false;
+    reset($css_themes);
+    while (!$found && (list($index, $data) = each($css_themes))) {
+        if ('u_'.$data['PATH'] == $option->new_value)
+            $found = true;
+    }
+    if ($found)
+        setPref($data_dir, $username, 'chosen_theme', $option->new_value);
+    else
+       setPref($data_dir, $username, 'chosen_theme', 'none');
+}
+
+