R2L by Yoav
[squirrelmail.git] / functions / addressbook.php
index 1bac6c0c9c61ff54ccb9b7f0307afde6c36e5c26..269b199417a630682ea9462f30ee73865816d6a2 100644 (file)
 <?php
 
-  /**
-   **  addressbook.php
-   **
-   **  Functions and classes for the addressbook system.
-   **
-   **/
-    
-   $addressbook_php = true;
-
-   // Include backends here.
-   include("../functions/abook_local_file.php");
-   include("../functions/abook_ldap_server.php");
-
-   // Create and initialize an addressbook object. 
-   // Returns the created object
-   function addressbook_init($showerr = true, $onlylocal = false) {
-      global $data_dir, $username, $ldap_server;
-      
-      // Create a new addressbook object
-      $abook = new AddressBook;
-      
-      // Always add a local backend
-      $filename = sprintf("%s%s.abook", $data_dir, $username);
-      $r = $abook->add_backend("local_file", Array("filename" => $filename,
-                                                  "create"   => true));
-      if(!$r && $showerr) {
-        printf(_("Error opening file %s"), $filename);
-        exit;
-      }
-
-      if($onlylocal)
-       return $abook;
-
-      // Load configured LDAP servers
-      reset($ldap_server);
-      while(list($key,$param) = each($ldap_server)) {
-        if(is_array($param)) {
-           $r = $abook->add_backend("ldap_server", $param);
-            if(!$r && $showerr) {
-              printf("&nbsp;"._("Error initializing LDAP server %s:")."<BR>\n",
-                     $param["host"]);
-              printf("&nbsp;".$abook->error);
-              exit;
+/**
+ * addressbook.php
+ *
+ * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Manage personal address book.
+ *
+ * $Id$
+ */
+
+require_once('../src/validate.php');
+require_once('../functions/array.php');
+require_once('../functions/display_messages.php');
+require_once('../functions/addressbook.php');
+require_once('../functions/strings.php');
+require_once('../functions/html.php');
+
+/* Make an input field */
+function adressbook_inp_field($label, $field, $name, $size, $values, $add) {
+    global $color;
+    $td_str = '<INPUT NAME="' . $name . '[' . $field . ']" SIZE="' . $size . '" VALUE="';
+    if (isset($values[$field])) {
+        $td_str .= htmlspecialchars($values[$field]);
+    }
+    $td_str .= '">' . $add . '';
+    return html_tag( 'tr' ,
+        html_tag( 'td', $label . ':', 'right', $color[4]) .
+        html_tag( 'td', $td_str, 'left', $color[4])
+        )
+    . "\n";
+}
+
+/* Output form to add and modify address data */
+function address_form($name, $submittext, $values = array()) {
+    global $color;
+    echo html_tag( 'table',
+                       adressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
+                           '<SMALL>' . _("Must be unique") . '</SMALL>') .
+                       adressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
+                       adressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
+                       adressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
+                       adressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
+                       html_tag( 'tr',
+                           html_tag( 'td',
+                                       '<INPUT TYPE=submit NAME="' . $name . '[SUBMIT]" VALUE="' .
+                                       $submittext . '">',
+                                   'center', $color[4], 'colspan="2"')
+                       )
+    , 'center', '', 'border="0" cellpadding="1" cols="2" width="90%"') ."\n";
+}
+
+
+/* Open addressbook, with error messages on but without LDAP (the *
+ * second "true"). Don't need LDAP here anyway                    */
+$abook = addressbook_init(true, true);
+if($abook->localbackend == 0) {
+    plain_error_message(
+        _("No personal address book is defined. Contact administrator."),
+        $color);
+    exit();
+}
+
+displayPageHeader($color, 'None');
+
+
+$defdata   = array();
+$formerror = '';
+$abortform = false;
+$showaddrlist = true;
+$defselected  = array();
+
+
+/* Handle user's actions */
+if($REQUEST_METHOD == 'POST') {
+
+    /**************************************************
+     * Add new address                                *
+     **************************************************/
+    if (!empty($addaddr['nickname'])) {
+
+        $r = $abook->add($addaddr, $abook->localbackend);
+
+        /* Handle error messages */
+        if (!$r) {
+            /* Remove backend name from error string */
+            $errstr = $abook->error;
+            $errstr = ereg_replace('^\[.*\] *', '', $errstr);
+
+            $formerror = $errstr;
+            $showaddrlist = false;
+            $defdata = $addaddr;
+        }
+
+    } else {
+
+        /************************************************
+         * Delete address(es)                           *
+         ************************************************/
+        if ((!empty($deladdr)) && sizeof($sel) > 0) {
+            $orig_sel = $sel;
+            sort($sel);
+
+            /* The selected addresses are identidied by "backend:nickname". *
+             * Sort the list and process one backend at the time            */
+            $prevback  = -1;
+            $subsel    = array();
+            $delfailed = false;
+
+            for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
+                list($sbackend, $snick) = explode(':', $sel[$i]);
+
+                /* When we get to a new backend, process addresses in *
+                 * previous one.                                      */
+                if ($prevback != $sbackend && $prevback != -1) {
+
+                    $r = $abook->remove($subsel, $prevback);
+                    if (!$r) {
+                        $formerror = $abook->error;
+                        $i = sizeof($sel);
+                        $delfailed = true;
+                        break;
+                    }
+                    $subsel   = array();
+                }
+
+                /* Queue for processing */
+                array_push($subsel, $snick);
+                $prevback = $sbackend;
+            }
+
+            if (!$delfailed) {
+                $r = $abook->remove($subsel, $prevback);
+                if (!$r) { /* Handle errors */
+                    $formerror = $abook->error;
+                    $delfailed = true;
+                }
+            }
+
+            if ($delfailed) {
+                $showaddrlist = true;
+                $defselected  = $orig_sel;
             }
-         }
-      }
-
-      // Return the initialized object
-      return $abook;
-   }
-
-
-
-  /**
-   ** This is the main address book class that connect all the
-   ** backends and provide services to the functions above.
-   **
-   **/
-   class AddressBook { 
-      var $backends    = array();
-      var $numbackends = 0;
-      var $error       = "";
-      var $localbackend = 0;
-
-      // Constructor function.
-      function AddressBook() {
-      }
-
-      // Return an array of backends of a given type, 
-      // or all backends if no type is specified.
-      function get_backend_list($type = "") {
-        $ret = array();
-        for($i = 1 ; $i <= $this->numbackends ; $i++) {
-           if(empty($type) || $type == $this->backends[$i]->btype) {
-              array_push($ret, &$this->backends[$i]);
-           }
-        }
-        return $ret;
-      }
-
-
-      // ========================== Public ========================
-
-      // Add a new backend. $backend is the name of a backend
-      // (without the abook_ prefix), and $param is an optional
-      // mixed variable that is passed to the backend constructor.
-      // See each of the backend classes for valid parameters.
-      function add_backend($backend, $param = "") {
-        $backend_name = "abook_".$backend;
-        eval("\$newback = new $backend_name(\$param);");
-        if(!empty($newback->error)) {
-           $this->error = $newback->error;
-           return false;
-        }
-
-        $this->numbackends++;
-       
-        $newback->bnum = $this->numbackends;
-        $this->backends[$this->numbackends] = $newback;
-
-        // Store ID of first local backend added
-        if($this->localbackend == 0 && $newback->btype == "local")
-           $this->localbackend = $this->numbackends;
-
-        return $this->numbackends;
-      }
-
-
-      // Return a list of addresses matching expression in
-      // all backends of a given type.
-      function search($expression, $btype = "") {
-        $ret = array();
-        $this->error = "";
-
-        $sel = $this->get_backend_list($btype);
-        $failed = 0;
-        for($i = 0 ; $i < sizeof($sel) ; $i++) {
-           $backend = &$sel[$i];
-           $backend->error = "";
-           $res = $backend->search($expression);
-           if(is_array($res)) {
-              $ret = array_merge($ret, $res);
-           } else {
-              $this->error = $this->error . "<br>\n". $backend->error;
-              $failed++;
-           }
-        }
-
-        // Only fail if all backends failed
-        if($failed >= sizeof($sel))
-           return false;
-
-        return $ret;
-      }
-
-
-      // Return a sorted search
-      function s_search($expression, $btype = "") {
-
-        $ret = $this->search($expression, $btype);
-        if(!is_array($ret))
-           return $ret;
-
-        // Inline function - Not nice, but still.. 
-        function cmp($a,$b) {   
-           if($a["backend"] > $b["backend"]) 
-              return 1;
-           else if($a["backend"] < $b["backend"]) 
-              return -1;
-        
-           return (strtolower($a["name"]) > strtolower($b["name"])) ? 1 : -1;
-        }
-
-        usort($ret, 'cmp');
-        return $ret;
-      }
-
-
-      // Lookup an address by alias. Only possible in
-      // local backends.
-      function lookup($alias) {
-        $ret = array();
-
-        $sel = $this->get_backend_list("local");
-        for($i = 0 ; $i < sizeof($sel) ; $i++) {
-           $backend = &$sel[$i];
-           $backend->error = "";
-           $res = $backend->lookup($alias);
-           if(is_array($res)) {
-              return $res;
-           } else {
-              $this->error = $backend->error;
-              return false;
-           }
-        }
-
-        return $ret;
-      }
-
-
-      // Return all addresses
-      function list_addr() {
-        $ret = array();
-
-        $sel = $this->get_backend_list("local");
-        for($i = 0 ; $i < sizeof($sel) ; $i++) {
-           $backend = &$sel[$i];
-           $backend->error = "";
-           $res = $backend->list_addr();
-           if(is_array($res)) {
-              $ret = array_merge($ret, $res);
-           } else {
-              $this->error = $backend->error;
-              return false;
-           }
-        }
-
-        return $ret;
-      }
-
-
-      // Create a new address from $userdata, in backend $bnum.
-      // Return the backend number that the/ address was added
-      // to, or false if it failed.
-      function add($userdata, $bnum) {
-
-        // Validate data
-        if(!is_array($userdata)) {
-           $this->error = _("Invalid input data");
-           return false;
-        }
-        if(empty($userdata["fullname"]) &&
-           empty($userdata["lastname"])) {
-           $this->error = _("Name is missing");
-           return false;
-        }
-        if(empty($userdata["email"])) {
-           $this->error = _("E-mail address is missing");
-           return false;
-        }
-        if(empty($userdata["nickname"])) {
-           $userdata["nickname"] = $userdata["email"];
-        }
-
-        // Check that specified backend accept new entries
-        if(!$this->backends[$bnum]->writeable) {
-           $this->error = _("Addressbook is read-only");
-           return false;
-        }
-
-        // Add address to backend
-        $res = $this->backends[$bnum]->add($userdata);
-        if($res) {
-           return $bnum;
-        } else {
-           $this->error = $this->backends[$bnum]->error;
-           return false;
-        }
-
-        return false;  // Not reached
-      }
-
-   }
-
-
-  /**
-   ** Generic backend that all other backends extend
-   **/
-   class addressbook_backend {
-
-      // Variables that all backends must provide.
-      var $btype      = "dummy";
-      var $bname      = "dummy";
-      var $sname      = "Dummy backend";
-
-      // Variables common for all backends, but that 
-      // should not be changed by the backends.
-      var $bnum       = -1;
-      var $error      = "";
-      var $writeable  = false;
-
-      function set_error($string) {
-        $this->error = "[" . $this->sname . "] " . $string;
-        return false;
-      }
-
-
-      // ========================== Public ========================
-
-      function search($expression) {
-        $this->set_error("search not implemented");
-        return false;
-      }
-
-      function lookup($alias) {
-        $this->set_error("lookup not implemented");
-        return false;
-      }
-
-      function list_addr() {
-        $this->set_error("list_addr not implemented");
-        return false;
-      }
-
-      function add($userdata) {
-        $this->set_error("add not implemented");
-        return false;
-      }
-
-   }
 
+        } else {
+
+            /***********************************************
+             * Update/modify address                       *
+             ***********************************************/
+            if (!empty($editaddr)) {
+
+                /* Stage one: Copy data into form */
+                if (isset($sel) && sizeof($sel) > 0) {
+                    if(sizeof($sel) > 1) {
+                        $formerror = _("You can only edit one address at the time");
+                        $showaddrlist = true;
+                        $defselected = $sel;
+                    } else {
+                        $abortform = true;
+                        list($ebackend, $enick) = explode(':', $sel[0]);
+                        $olddata = $abook->lookup($enick, $ebackend);
+
+                        /* Display the "new address" form */
+                        echo '<FORM ACTION="' . $PHP_SELF . '" METHOD="POST">' .
+                             "\n" .
+                             html_tag( 'table',
+                                html_tag( 'tr',
+                                   html_tag( 'td',
+                                      "\n". '<strong>' . _("Update address") . '</strong>' ."\n",
+                                      'center', $color[0] )
+                                   ),
+                             'center', '', 'width="100%" cols="1"' ) .
+                        address_form("editaddr", _("Update address"), $olddata);
+                        echo '<INPUT TYPE=hidden NAME=oldnick VALUE="' . 
+                             htmlspecialchars($olddata["nickname"]) . "\">\n" .
+                             '<INPUT TYPE=hidden NAME=backend VALUE="' .
+                             htmlspecialchars($olddata["backend"]) . "\">\n" .
+                             '<INPUT TYPE=hidden NAME=doedit VALUE=1>' . "\n" .
+                             '</FORM>';
+                    }
+                } else {
+
+                    /* Stage two: Write new data */
+                    if ($doedit = 1) {
+                        $newdata = $editaddr;
+                        $r = $abook->modify($oldnick, $newdata, $backend);
+
+                        /* Handle error messages */
+                        if (!$r) {
+                            /* Display error */
+                             echo html_tag( 'table',
+                                html_tag( 'tr',
+                                   html_tag( 'td',
+                                      "\n". '<br><strong><font color="' . $color[2] .
+                                      '">' . _("ERROR") . ': ' . $abook->error . '</font></strong>' ."\n",
+                                      'center' )
+                                   ),
+                             'center', '', 'width="100%" cols="1"' );
+
+                            /* Display the "new address" form again */
+                            echo '<FORM ACTION="' . $PHP_SELF .
+                                 '" METHOD="POST">' . "\n" .
+                                 html_tag( 'table',
+                                     html_tag( 'tr',
+                                         html_tag( 'td',
+                                                    "\n". '<br><strong>' . _("Update address") . '</strong>' ."\n",
+                                         'center', $color[0] )
+                                     ),
+                                 'center', '', 'width="100%" cols="1"' ) .
+                            address_form("editaddr", _("Update address"), $newdata);
+                            echo '<INPUT TYPE=hidden NAME=oldnick VALUE="' .
+                                 htmlspecialchars($oldnick) . "\">\n" .
+                                 '<INPUT TYPE=hidden NAME=backend VALUE="' .
+                                 htmlspecialchars($backend) . "\">\n" .
+                                 '<INPUT TYPE=hidden NAME=doedit VALUE=1>' .
+                                 "\n" . '</FORM>';
+                            $abortform = true;
+                        }
+                    } else {
+
+                        /* Should not get here... */
+                        plain_error_message(_("Unknown error"), $color);
+                        $abortform = true;
+                    }
+                }
+            } /* !empty($editaddr)                  - Update/modify address */
+        } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
+    } /* !empty($addaddr['nickname'])               - Add new address */
+
+    // Some times we end output before forms are printed
+    if($abortform) {
+       echo "</BODY></HTML>\n";
+       exit();
+    }
+}
+
+
+/* =================================================================== *
+ * The following is only executed on a GET request, or on a POST when  *
+ * a user is added, or when "delete" or "modify" was successful.       *
+ * =================================================================== */
+
+/* Display error messages */
+if (!empty($formerror)) {
+    echo html_tag( 'table',
+        html_tag( 'tr',
+            html_tag( 'td',
+                   "\n". '<br><strong><font color="' . $color[2] .
+                   '">' . _("ERROR") . ': ' . $formerror . '</font></strong>' ."\n",
+            'center' )
+        ),
+    'center', '', 'width="100%" cols="1"' );
+}
+
+
+/* Display the address management part */
+if ($showaddrlist) {
+    /* Get and sort address list */
+    $alist = $abook->list_addr();
+    if(!is_array($alist)) {
+        plain_error_message($abook->error, $color);
+        exit;
+    }
+
+    usort($alist,'alistcmp');
+    $prevbackend = -1;
+    $headerprinted = false;
+
+    echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
+
+    /* List addresses */
+    if (count($alist) > 0) {
+        echo '<FORM ACTION="' . $PHP_SELF . '" METHOD="POST">' . "\n";
+        while(list($undef,$row) = each($alist)) {
+    
+            /* New table header for each backend */
+            if($prevbackend != $row['backend']) {
+                if($prevbackend < 0) {
+                    echo html_tag( 'table',
+                                    html_tag( 'tr',
+                                          html_tag( 'td',
+                                                     '<INPUT TYPE=submit NAME=editaddr VALUE="' . 
+                                                     _("Edit selected") . "\">\n" .
+                                                     '<INPUT TYPE=submit NAME=deladdr VALUE="' .
+                                                     _("Delete selected") . "\">\n",
+                                          'center', '', 'colspan="5"' )
+                                    ) .
+                                    html_tag( 'tr',
+                                          html_tag( 'td', '&nbsp;<br>', 'center', '', 'colspan="5"' )
+                                    ) ,
+                             'center' );
+                }
+    
+                echo html_tag( 'table',
+                                html_tag( 'tr',
+                                    html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] )
+                                ) ,
+                        'center', '', 'width="95%" cols="1"' ) ."\n"
+                . html_tag( 'table', '', 'center', '', 'cols="5" border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
+                      html_tag( 'tr', "\n" .
+                          html_tag( 'th', '&nbsp;', 'left', '', 'width="1%"' ) .
+                          html_tag( 'th', _("Nickname"), 'left', '', 'width="1%"' ) .
+                          html_tag( 'th', _("Name"), 'left', '', 'width="1%"' ) .
+                          html_tag( 'th', _("E-mail"), 'left', '', 'width="1%"' ) .
+                          html_tag( 'th', _("Info"), 'left', '', 'width="1%"' ) ,
+                      '', $color[9] ) . "\n";
+    
+                $line = 0;
+                $headerprinted = true;
+            } /* End of header */
+    
+            $prevbackend = $row['backend'];
+    
+            /* Check if this user is selected */
+            if(in_array($row['backend'] . ':' . $row['nickname'], $defselected)) {
+                $selected = 'CHECKED';
+            } else {
+                $selected = '';
+            }
+    
+            /* Print one row */
+            $tr_bgcolor = '';
+            if ($line % 2) { $tr_bgcolor = $color[0]; }
+            echo html_tag( 'tr', '') .
+            html_tag( 'td',
+                '<SMALL>' .
+                '<INPUT TYPE=checkbox ' . $selected . ' NAME="sel[]" VALUE="' .
+                $row['backend'] . ':' . $row['nickname'] . '"></SMALL>' ,
+                'center', '', 'valign="top" width="1%"' ) .
+            html_tag( 'td', '&nbsp;' . $row['nickname'] . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
+            html_tag( 'td', '&nbsp;' . $row['name'] . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
+            html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . '&nbsp;';
+            if ($compose_new_win == '1') {
+                echo '<a href="javascript:void(0)" onclick=comp_in_new(false,"compose.php?send_to='.rawurlencode($row['email']).'")>';
+            }
+            else {
+                echo '<A HREF="compose.php?send_to=' . rawurlencode($row['email']).'">';
+            }
+            echo $row['email'] . '</A>&nbsp;</td>'."\n".
+            html_tag( 'td', '&nbsp;' . $row['label'] . '&nbsp;', 'left', '', 'valign="top" width="1%"' ) .
+            "</tr>\n";
+            $line++;
+        }
+    
+        /* End of list. Close table. */
+        if ($headerprinted) {
+            echo html_tag( 'tr',
+                        html_tag( 'td',
+                                '<INPUT TYPE="submit" NAME="editaddr" VALUE="' . _("Edit selected") .
+                                "\">\n" .
+                                '<INPUT TYPE="submit" NAME="deladdr" VALUE="' . _("Delete selected") .
+                                "\">\n",
+                         'center', '', 'colspan="5"' )
+                    );
+        }
+        echo '</table></FORM>';
+    }
+} /* end of addresslist */
+
+
+/* Display the "new address" form */
+echo '<a name="AddAddress"></a>' . "\n" .
+    '<FORM ACTION="' . $PHP_SELF . '" NAME=f_add METHOD="POST">' . "\n" .
+    html_tag( 'table',
+        html_tag( 'tr',
+            html_tag( 'td', "\n". '<strong>' . sprintf(_("Add to %s"), $abook->localbackendname) . '</strong>' . "\n",
+                'center', $color[0]
+            )
+        )
+    , 'center', '', 'width="100%" cols="1"' ) ."\n";
+address_form('addaddr', _("Add address"), $defdata);
+echo '</FORM>';
+
+/* Add hook for anything that wants on the bottom */
+do_hook('addressbook_bottom');
 ?>
+
+</BODY></HTML>
\ No newline at end of file