avoid E_STRICT errors
[squirrelmail.git] / src / options_identities.php
index aff95a75c31fe7aa32ff05548d3cae94ca663fc9..bb9dcaeb194d972a6eaa3e1a0a7b6dd9f5f18c85 100644 (file)
 /**
  * options_identities.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Display Identities Options
  *
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
+ * @since 1.1.3
  */
 
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
-/***    + Base level indent should begin at left margin, as    ***/
-/***      the require_once below looks.                        ***/
-/***    + All identation should consist of four space blocks   ***/
-/***    + Tab characters are evil.                             ***/
-/***    + all comments should use "slash-star ... star-slash"  ***/
-/***      style -- no pound characters, no slash-slash style   ***/
-/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
-/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
-/***    + Please use ' instead of ", when possible. Note "     ***/
-/***      should always be used in _( ) function calls.        ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
-require_once('../src/validate.php');
-require_once('../functions/display_messages.php');
-
-   if (isset($return)) {
-      SaveUpdateFunction();
-      header('Location: options_personal.php');
-      exit();
-   }
-   
-   displayPageHeader($color, 'None');
-
-   $Info = do_hook('options_identities_process', 0);
-   if ($Info[1])
-      SaveUpdateFunction();
-
-   if (CheckAndDoDefault() || CheckAndDoPromote()) {
-      SaveUpdateFunction();
-   }
-   if (isset($update) || CheckForDelete())
-      SaveUpdateFunction();
-
-   LoadInfo($full_name, $email_address, $reply_to, '');
-
-?>
-<br>
-<table width=95% align=center border=0 cellpadding=2 cellspacing=0>
-<tr><td bgcolor="<?php echo $color[0] ?>" align="center">
-
-      <b><?php echo _("Options") . ' - ' . _("Advanced Identities"); ?></b>
-
-    <table width="100%" border="0" cellpadding="1" cellspacing="1">
-    <tr><td bgcolor="<?php echo $color[4] ?>" align="center">
-
-<form name=f action="options_identities.php" method=post><br>
-
-<?PHP do_hook('options_identities_top'); ?>
-
-<table width=80% cellpadding=2 cellspacing=0 border=0>
-  <tr bgcolor="<?PHP echo $color[9] ?>">
-    <th colspan=2 align=center><?PHP echo _("Default Identity") ?></th>
-  </tr>
-<?PHP
-
-   ShowTableInfo($full_name, $email_address, $reply_to, '');
-  
-   $num = 1;
-   while (LoadInfo($full_name, $email_address, $reply_to, $num))
-   {
-?>
-  <tr bgcolor="<?PHP echo $color[9] ?>">
-    <th colspan=2 align=center><?PHP printf (_("Alternate Identity %d"),
-    $num) ?></th>
-  </tr>
-<?PHP
-       ShowTableInfo($full_name, $email_address, $reply_to, $num);
-       $num ++;
-   }
-   
-?>
-  <tr bgcolor="<?PHP echo $color[9] ?>">
-    <th colspan=2 align=center><?PHP echo _("Add a New Identity") ?></th>
-  </tr>
-<?
-
-   ShowTableInfo('', '', '', $num);
-?>
-</table>
-</form>
-
-    </td></tr>
-    </table>
-
-</td></tr>
-</table>
-</body></html>
-
-<?PHP
-
-    function SaveUpdateFunction() {
-        global $username, $data_dir, $full_name, $email_address, $reply_to;
-
-        $i = 1;
-        $fakeI = 1;
-        $name = 'form_for_' . $i;
-        global $$name;
-        while (isset($$name))
-        {
-            $name = 'delete_' . $i;
-            global $$name;
-            if (isset($$name)) {
-                $fakeI --;
-            } else {
-                do_hook('options_identities_renumber', $i, $fakeI);
-                $filled = 0;
-
-                $name = 'full_name' . $i;
-                global $$name;
-            if ($$name != '')
-                $filled ++;
-                setPref($data_dir, $username, 'full_name' . $fakeI, $$name);
-
-                $name = 'email_address' . $i;
-                global $$name;
-            if ($$name != '')
-                $filled ++;
-                setPref($data_dir, $username, 'email_address' . $fakeI, $$name);
-
-                $name = 'reply_to' . $i;
-                global $$name;
-            if ($$name != '')
-                $filled ++;
-                setPref($data_dir, $username, 'reply_to' . $fakeI, $$name);
-
-            if ($filled == 0)
-                $fakeI --;
-            }
-
-            $fakeI ++;
-            $i ++;
-            $name = 'form_for_' . $i;
-            global $$name;
-        }
+/** This is the options_identities page */
+define('PAGE_NAME', 'options_identities');
 
-        setPref($data_dir, $username, 'identities', $fakeI);
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
 
-        while ($fakeI != $i)
-        {
-            removePref($data_dir, $username, 'full_name' . $fakeI);
-            removePref($data_dir, $username, 'email_address' . $fakeI);
-            removePref($data_dir, $username, 'reply_to' . $fakeI);
-            $fakeI ++;
-        }
+/* SquirrelMail required files. */
+require_once(SM_PATH . 'functions/identity.php');
 
-        setPref($data_dir, $username, 'full_name', $full_name);
-        setPref($data_dir, $username, 'email_address', $email_address);
-        setPref($data_dir, $username, 'reply_to', $reply_to);
-    }
+/* make sure that page is not available when $edit_identity is false */
+if (!$edit_identity) {
+    error_box(_("Editing identities is disabled."));
+    $oTemplate->display('footer.tpl');
+    die();
+}
 
-    function CheckAndDoDefault() {
-        global $username, $data_dir, $full_name, $email_address, $reply_to;
-
-        $i = 1;
-        $name = 'form_for_' . $i;
-        global $$name;
-        while (isset($$name))
-        {
-            $name = 'make_default_' . $i;
-            global $$name;
-            if (isset($$name)) {
-                do_hook('options_identities_renumber', $i, 'default');
-                global $full_name, $email_address, $reply_to;
-
-                $name = 'full_name' . $i;
-                global $$name;
-                $temp = $full_name;
-                $full_name = $$name;
-                $$name = $temp;
-
-                $name = 'email_address' . $i;
-                global $$name;
-                $temp = $email_address;
-                $email_address = $$name;
-                $$name = $temp;
-
-                $name = 'reply_to' . $i;
-                global $$name;
-                $temp = $reply_to;
-                $reply_to = $$name;
-                $$name = $temp;
-
-                return true;
-            }
-
-            $i ++;
-            $name = 'form_for_' . $i;
-            global $$name;
+if (!sqgetGlobalVar('identities', $identities, SQ_SESSION)) {
+    $identities = get_identities();
+}
+sqgetGlobalVar('newidentities', $newidentities, SQ_POST);
+sqgetGlobalVar('smaction', $smaction, SQ_POST);
+sqgetGlobalVar('return', $return, SQ_POST);
+
+// First lets see if there are any actions to perform //
+if (!empty($smaction) && is_array($smaction)) {
+
+    $doaction = '';
+    $identid = 0;
+
+    foreach($smaction as $action=>$row) {
+        // we only need to extract the action and the identity we are
+        // altering
+
+        foreach($row as $iKey=>$data) {
+            $identid = $iKey;
         }
-        return FALSE;
+
+        $doaction = $action;
     }
 
-    function CheckForDelete() {
-        global $username, $data_dir, $full_name, $email_address, $reply_to;
-
-        $i = 1;
-        $name = 'form_for_' . $i;
-        global $$name;
-        while (isset($$name))
-        {
-            $name = 'delete_' . $i;
-            global $$name;
-            if (isset($$name)) {
-                return true;
-            }
-
-            $i ++;
-            $name = 'form_for_' . $i;
-            global $$name;
-        }
-        return false;
+    $identities = sqfixidentities( $newidentities , $identid , $action );
+    save_identities($identities);
+}
+
+if (!empty($return)) {
+    header('Location: ' . get_location() . '/options_personal.php');
+    exit;
+}
+
+displayPageHeader($color);
+
+/* since 1.1.3 */
+do_hook('options_identities_top', $null);
+
+$i = array();
+foreach ($identities as $key=>$ident) {
+    $a = array();
+    $a['Title'] = $key==0 ? _("Default Identity") : sprintf(_("Alternate Identity %d"), $key);
+    $a['New'] = false;
+    $a['Default'] = $key==0;
+    $a['FullName'] = htmlspecialchars($ident['full_name']);
+    $a['Email'] = htmlspecialchars($ident['email_address']);
+    $a['ReplyTo'] = htmlspecialchars($ident['reply_to']);
+    $a['Signature'] = htmlspecialchars($ident['signature']);
+    $i[$key] = $a;
+}
+
+$a = array();
+$a['Title'] = _("Add New Identity");
+$a['New'] = true;
+$a['Default'] = false;
+$a['FullName'] = '';
+$a['Email'] = '';
+$a['ReplyTo'] = '';
+$a['Signature'] = '';
+$i[count($i)] = $a;
+
+//FIXME: NO HTML IN THE CORE
+echo '<form name="f" action="options_identities.php" method="post">' . "\n";
+
+$oTemplate->assign('identities', $i);
+$oTemplate->display('options_advidentity_list.tpl');
+
+//FIXME: NO HTML IN THE CORE
+echo "</form>\n";
+
+$oTemplate->display('footer.tpl');
+
+/**
+ * The functions below should not be needed with the additions of templates,
+ * however they will remain in case plugins use them.
+ */
+
+/**
+ * Returns html formated identity form fields
+ *
+ * Contains options_identities_buttons and option_identities_table hooks.
+ * Before 1.4.5/1.5.1 hooks were placed in ShowTableInfo() function.
+ * In 1.1.3-1.4.1 they were called in do_hook function with two or
+ * three arguments. Since 1.4.1 hooks are called in concat_hook_function.
+ * Arguments are moved to array.
+ *
+ * options_identities_buttons hook uses array with two keys. First array key is
+ * boolean variable used to indicate empty identity field. Second array key
+ * is integer variable used to indicate identity number
+ *
+ * options_identities_table hook uses array with three keys. First array key is
+ * a string containing background color style CSS (1.4.1-1.4.4/1.5.0 uses only
+ * html color code). Second array key is boolean variable used to indicate empty
+ * identity field. Third array key is integer variable used to indicate identity
+ * number
+ * @param string $title Name displayed in header row
+ * @param array $identity Identity information
+ * @param integer $id identity ID
+ * @return string html formatted table rows with form fields for identity management
+ * @since 1.5.1 and 1.4.5 (was called ShowTableInfo() in 1.1.3-1.4.4 and 1.5.0)
+ */
+function ShowIdentityInfo($title, $identity, $id ) {
+    global $color;
+
+    if (empty($identity['full_name']) && empty($identity['email_address']) && empty($identity['reply_to']) && empty($identity['signature'])) {
+        $bg = '';
+        $empty = true;
+    } else {
+        $bg = ' style="background-color:' . $color[0] . ';"';
+        $empty = false;
     }
 
-    function CheckAndDoPromote() {
-        global $username, $data_dir, $full_name, $email_address, $reply_to;
-
-        $i = 1;
-        $name = 'form_for_' . $i;
-        global $$name;
-        while (isset($$name)) {
-            $name = 'promote_' . $i;
-            global $$name;
-            if (isset($$name) && $i > 1) {
-                do_hook('options_identities_renumber', $i, $i - 1);
-
-            $nameA = 'full_name' . $i;
-            $nameB = 'full_name' . ($i - 1);
-            global $$nameA, $$nameB;
-            $temp = $$nameA;
-            $$nameA = $$nameB;
-            $$nameB = $temp;
-
-            $nameA = 'email_address' . $i;
-            $nameB = 'email_address' . ($i - 1);
-            global $$nameA, $$nameB;
-            $temp = $$nameA;
-            $$nameA = $$nameB;
-            $$nameB = $temp;
-
-            $nameA = 'reply_to' . $i;
-            $nameB = 'reply_to' . ($i - 1);
-            global $$nameA, $$nameB;
-            $temp = $$nameA;
-            $$nameA = $$nameB;
-            $$nameB = $temp;
-
-            return true;
-            }
-
-            $i ++;
-            $name = 'form_for_' . $i;
-            global $$name;
+    $name = 'newidentities[%d][%s]';
+
+
+    $return_str = '';
+
+//FIXME: NO HTML IN THE CORE
+    $return_str .= '<tr>' . "\n";
+    $return_str .= '  <th style="text-align:center;background-color:' . $color[9] . ';" colspan="2">' . $title . '</th> '. "\n";
+    $return_str .= '</tr>' . "\n";
+    $return_str .= sti_input( _("Full Name") , sprintf($name, $id, 'full_name'), $identity['full_name'], $bg);
+    $return_str .= sti_input( _("E-Mail Address") , sprintf($name, $id, 'email_address'), $identity['email_address'], $bg);
+    $return_str .= sti_input( _("Reply To"), sprintf($name, $id, 'reply_to'), $identity['reply_to'], $bg);
+    $return_str .= sti_textarea( _("Signature"), sprintf($name, $id, 'signature'), $identity['signature'], $bg);
+    $temp = array(&$bg, &$empty, &$id);
+    $return_str .= concat_hook_function('options_identities_table', $temp);
+    $return_str .= '<tr' . $bg . '> ' . "\n";
+    $return_str .= '  <td> &nbsp; </td>' . "\n";
+    $return_str .= '  <td>' . "\n";
+    $return_str .= '    <input type="submit" name="smaction[save][' . $id . ']" value="' . _("Save / Update") . '" />' . "\n";
+
+    if (!$empty && $id > 0) {
+        $return_str .= '    <input type="submit" name="smaction[makedefault][' . $id . ']" value="' . _("Make Default") . '" />' . "\n";
+        $return_str .= '    <input type="submit" name="smaction[delete]['.$id.']" value="' . _("Delete") . '" />' . "\n";
+
+        if ($id > 1) {
+            $return_str .= '    <input type="submit" name="smaction[move]['.$id.']" value="' . _("Move Up") . '" />' . "\n";
         }
-        return false;
+
     }
 
-    function LoadInfo(&$n, &$e, &$r, $post) {
-        global $username, $data_dir;
+    $temp = array(&$empty, &$id);
+    $return_str .= concat_hook_function('options_identities_buttons', $temp);
+    $return_str .= '  </td>' . "\n";
+    $return_str .= '</tr>' . "\n";
+    $return_str .= '<tr>' . "\n";
+    $return_str .= '  <td colspan="2"> &nbsp; </td>' . "\n";
+    $return_str .= '</tr>';
 
-        $n = getPref($data_dir, $username, 'full_name' . $post);
-        $e = getPref($data_dir, $username, 'email_address' . $post);
-        $r = getPref($data_dir, $username, 'reply_to' . $post);
+    return $return_str;
 
-        if ($n != '' || $e != '' || $r != '')
-            return true;
-    }
+}
 
-function sti_input( $title, $hd, $data, $post, $bg ) {
+/**
+ * Creates html formated table row with input field
+ * @param string $title Name displayed next to input field
+ * @param string $name Name of input field
+ * @param string $data Default value of input field (data is sanitized with htmlspecialchars)
+ * @param string $bgcolor html attributes added to row element (tr)
+ * @return string html formated table row with text input field
+ * @since 1.2.0 (arguments differ since 1.4.5/1.5.1)
+ * @todo check right-to-left language issues
+ * @access private
+ */
+function sti_input( $title, $name, $data, $bgcolor ) {
+//FIXME: NO HTML IN THE CORE
+    $str = '';
+    $str .= '<tr' . $bgcolor . ">\n";
+    $str .= '  <td style="white-space: nowrap;text-align:right;">' . $title . ' </td>' . "\n";
+    $str .= '  <td> <input type="text" name="' . $name . '" size="50" value="'. htmlspecialchars($data) . '" /> </td>' . "\n";
+    $str .= '</tr>';
 
-    echo "<tr$bg><td align=right nowrap>$title:".
-         '</td><td>'.
-         '<input size=50 type=text value="' . htmlspecialchars($data) .
-         "\" name=\"$hd$post\"></td></tr>";
+    return $str;
 
 }
 
-function ShowTableInfo($full_name, $email_address, $reply_to, $post) {
-    global $color;
+/**
+ * Creates html formated table row with textarea field
+ * @param string $title Name displayed next to textarea field
+ * @param string $name Name of textarea field
+ * @param string $data Default value of textarea field  (data is sanitized with htmlspecialchars)
+ * @param string $bgcolor html attributes added to row element (tr)
+ * @return string html formated table row with textarea
+ * @since 1.2.5 (arguments differ since 1.4.5/1.5.1)
+ * @todo check right-to-left language issues
+ * @access private
+ */
+function sti_textarea( $title, $name, $data, $bgcolor ) {
+//FIXME: NO HTML IN THE CORE
+    $str = '';
+    $str .= '<tr' . $bgcolor . ">\n";
+    $str .= '  <td style="white-space: nowrap;text-align:right;">' . $title . ' </td>' . "\n";
+    $str .= '  <td> <textarea name="' . $name . '" cols="50" rows="5">'. htmlspecialchars($data) . '</textarea> </td>' . "\n";
+    $str .= '</tr>';
+
+    return $str;
 
-    $OtherBG = ' bgcolor="' . $color[0] . '"';
-    if ($full_name == '' && $email_address == '' && $reply_to == '')
-        $OtherBG = '';
-
-    if ($full_name == '' && $email_address == '' && $reply_to == '')
-        $isEmptySection = true;
-    else
-        $isEmptySection = false;
-
-    sti_input( _("Full Name"), 'full_name', $full_name, $post, $OtherBG );
-    sti_input( _("E-Mail Address"), 'email_address', $email_address, $post, $OtherBG );
-    sti_input( _("Reply To"), 'reply_to', $reply_to, $post, $OtherBG );
-
-    do_hook('options_identities_table', $OtherBG, $isEmptySection, $post);
-    echo "<tr$OtherBG>".
-         '<td>&nbsp;</td><td>'.
-         "<input type=hidden name=\"form_for_$post\" value=\"1\">".
-         '<input type=submit name="update" value="'.
-         _("Save / Update") . '">';
-    if (! $isEmptySection && $post != '') {
-        echo "<input type=submit name=\"make_default_$post\" value=\"".
-             _("Make Default") . '">'.
-             "<input type=submit name=\"delete_$post\" value=\"".
-             _("Delete") . '">';
-    }
-    if (! $isEmptySection && $post != '' && $post > 1) {
-        echo '<input type=submit name="promote_' . $post . '" value="'.
-             _("Move Up") . '">';
-    }
-    do_hook('options_identities_buttons', $isEmptySection, $post);
-    echo '</td></tr>'.
-         '<tr><td colspan="2">&nbsp;</td></tr>';
 }
-?>
+