phpDocumentor updates
[squirrelmail.git] / include / options / personal.php
index a15d5ba55d83eb5a23b4d742453f3d50905f9139..62a0abcb770e3e5fddc08fd091ba229d19647cec 100644 (file)
@@ -3,17 +3,17 @@
 /**
  * options_personal.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Displays all options relating to personal information
  *
- * $Id$
+ * @copyright © 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
  */
 
 /** SquirrelMail required files. */
 require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'include/timezones.php');
 
 /* Define the group constants for the personal options page. */
 define('SMOPT_GRP_CONTACT', 0);
@@ -21,11 +21,23 @@ define('SMOPT_GRP_REPLY', 1);
 define('SMOPT_GRP_SIG', 2);
 define('SMOPT_GRP_TZ', 3);
 
-/* Define the optpage load function for the personal options page. */
+/**
+ * This function builds an array with all the information about
+ * the options available to the user, and returns it. The options
+ * are grouped by the groups in which they are displayed.
+ * For each option, the following information is stored:
+ * - name: the internal (variable) name
+ * - caption: the description of the option in the UI
+ * - type: one of SMOPT_TYPE_*
+ * - refresh: one of SMOPT_REFRESH_*
+ * - size: one of SMOPT_SIZE_*
+ * - save: the name of a function to call when saving this option
+ * @return array all option information
+ */
 function load_optpage_data_personal() {
     global $data_dir, $username, $edit_identity, $edit_name,
            $full_name, $reply_to, $email_address, $signature, $tzChangeAllowed,
-           $color;
+           $color, $timeZone;
 
     /* Set the values of some global variables. */
     $full_name = getPref($data_dir, $username, 'full_name');
@@ -106,9 +118,9 @@ function load_optpage_data_personal() {
     );
 
     if ($edit_identity) {
-        $identities_link_value = '<A HREF="options_identities.php">'
+        $identities_link_value = '<a href="options_identities.php">'
                                . _("Edit Advanced Identities")
-                               . '</A> '
+                               . '</a> '
                                . _("(discards changes made on this form so far)");
         $optvals[SMOPT_GRP_CONTACT][] = array(
             'name'    => 'identities_link',
@@ -118,25 +130,50 @@ function load_optpage_data_personal() {
             'comment' =>  $identities_link_value
         );
     }
-    
+
     if ( $tzChangeAllowed ) {
         $TZ_ARRAY[SMPREF_NONE] = _("Same as server");
-        $tzfile = SM_PATH . 'locale/timezones.cfg';
-               if ((!is_readable($tzfile)) or (!$fd = fopen($tzfile,'r'))) {
-               $message = _("Error opening timezone config, contact administrator.");
-               }
-               if (isset($message)) {
-                   plain_error_message($message, $color);
-                   exit;
-       }
-        while (!feof ($fd)) {
-            $zone = fgets($fd, 1024);
-            if( $zone ) {
-                $zone = trim($zone);
-                $TZ_ARRAY[$zone] = $zone;
+
+        $aTimeZones = sq_get_tz_array();
+        unset($message);
+        if (! empty($aTimeZones)) {
+            // check if current timezone is linked to other TZ and update it
+            if ($timeZone != SMPREF_NONE && $timeZone != "" &&
+                isset($aTimeZones[$timeZone]['LINK'])) {
+                $timeZone = $aTimeZones[$timeZone]['LINK'];
+                // TODO: recheck setting of $timeZone
+                // setPref($data_dir,$username,'timezone',$timeZone);
+            }
+
+            // sort time zones by name. sq_get_tz_array() returns sorted by key.
+            // asort($aTimeZones);
+
+            // add all 'TZ' entries to TZ_ARRAY
+            foreach ($aTimeZones as $TzKey => $TzData) {
+                if (! isset($TzData['LINK'])) {
+                    // Old display format
+                    $TZ_ARRAY[$TzKey] = $TzKey;
+
+                    // US Eastern standard time (America/New_York) - needs asort($aTimeZones)
+                    //$TZ_ARRAY[$TzKey] = (isset($TzData['NAME']) ? $TzData['NAME']." ($TzKey)" : "($TzKey)");
+
+                    // US Eastern standard time if NAME is present or America/New_York if NAME not present
+                    // needs sorting after all data is added or uasort()
+                    //$TZ_ARRAY[$TzKey] = (isset($TzData['NAME']) ? $TzData['NAME'] : $TzKey);
+
+                    // (America/New_Your) US Eastern standard time
+                    //$TZ_ARRAY[$TzKey] = "($TzKey)" . (isset($TzData['NAME']) ? ' '.$TzData['NAME'] : '');
+                }
             }
+        } else {
+            $message = _("Error opening timezone config, contact administrator.");
+        }
+
+        // TODO: make error user friendly
+        if (isset($message)) {
+            plain_error_message($message, $color);
+            exit;
         }
-        fclose ($fd);
 
         $optgrps[SMOPT_GRP_TZ] = _("Timezone Options");
         $optvals[SMOPT_GRP_TZ] = array();
@@ -149,7 +186,7 @@ function load_optpage_data_personal() {
             'posvals' => $TZ_ARRAY
         );
     }
-    
+
     /*** Load the Reply Citation Options into the array ***/
     $optgrps[SMOPT_GRP_REPLY] = _("Reply Citation Options");
     $optvals[SMOPT_GRP_REPLY] = array();
@@ -160,7 +197,8 @@ function load_optpage_data_personal() {
         'type'    => SMOPT_TYPE_STRLIST,
         'refresh' => SMOPT_REFRESH_NONE,
         'posvals' => array(SMPREF_NONE    => _("No Citation"),
-                           'author_said'  => _("AUTHOR Said"),
+                           'author_said'  => _("AUTHOR Wrote"),
+                           'date_time_author' => _("On DATE, AUTHOR Wrote"),
                            'quote_who'    => _("Quote Who XML"),
                            'user-defined' => _("User-Defined"))
     );
@@ -211,9 +249,12 @@ function load_optpage_data_personal() {
 /** Define any specialized save functions for this option page. ***/
 /******************************************************************/
 
+/**
+ * Saves the signature option.
+ */
 function save_option_signature($option) {
     global $data_dir, $username;
     setSig($data_dir, $username, 'g', $option->new_value);
 }
 
-?>
+?>
\ No newline at end of file