Source for file addressbook.php

Documentation is available at addressbook.php

  1. <?php
  2. /**
  3.  * functions/addressbook.php - Functions and classes for the addressbook system
  4.  *
  5.  * Functions require SM_PATH and support of forms.php functions
  6.  *
  7.  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  8.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  9.  * @version $Id: addressbook.php,v 1.100 2006/08/31 05:43:18 tokul Exp $
  10.  * @package squirrelmail
  11.  * @subpackage addressbook
  12.  */
  13.  
  14. /**
  15.  * Create and initialize an addressbook object.
  16.  * @param boolean $showerr display any address book init errors. html page header
  17.  *  must be created before calling addressbook_init() with $showerr enabled.
  18.  * @param boolean $onlylocal enable only local address book backends. Should
  19.  *   be used when code does not need access to remote backends. Backends
  20.  *   that provide read only address books with limited listing options can be
  21.  *   tagged as remote.
  22.  * @return object address book object.
  23.  */
  24. function addressbook_init($showerr = true, $onlylocal = false) {
  25.     global $data_dir, $username, $ldap_server, $address_book_global_filename;
  26.     global $addrbook_dsn, $addrbook_table;
  27.     global $abook_global_file, $abook_global_file_writeable, $abook_global_file_listing;
  28.     global $addrbook_global_dsn, $addrbook_global_table, $addrbook_global_writeable, $addrbook_global_listing;
  29.     global $abook_file_line_length;
  30.  
  31.     /* Create a new addressbook object */
  32.     $abook = new AddressBook;
  33.  
  34.     /* Create empty error message */
  35.     $abook_init_error='';
  36.  
  37.     /*
  38.         Always add a local backend. We use *either* file-based *or* a
  39.         database addressbook. If $addrbook_dsn is set, the database
  40.         backend is used. If not, addressbooks are stores in files.
  41.     */
  42.     if (isset($addrbook_dsn) && !empty($addrbook_dsn)) {
  43.         /* Database */
  44.         if (!isset($addrbook_table) || empty($addrbook_table)) {
  45.             $addrbook_table = 'address';
  46.         }
  47.         $r = $abook->add_backend('database', Array('dsn' => $addrbook_dsn,
  48.                             'owner' => $username,
  49.                             'table' => $addrbook_table));
  50.         if (!$r && $showerr) {
  51.             $abook_init_error.=_("Error initializing address book database.") . "\n" . $abook->error;
  52.         }
  53.     } else {
  54.         /* File */
  55.         $filename = getHashedFile($username, $data_dir, "$username.abook");
  56.         $r = $abook->add_backend('local_file', Array('filename' => $filename,
  57.                                                      'line_length' => $abook_file_line_length,
  58.                                                      'create'   => true));
  59.         if(!$r && $showerr) {
  60.             // no need to use $abook->error, because message explains error.
  61.             $abook_init_error.=sprintf( _("Error opening file %s"), $filename );
  62.         }
  63.     }
  64.  
  65.     /* Global file based addressbook */
  66.     if (isset($abook_global_file) &&
  67.         isset($abook_global_file_writeable) &&
  68.         isset($abook_global_file_listing) &&
  69.         trim($abook_global_file)!=''){
  70.  
  71.         // Detect place of address book
  72.         if (! preg_match("/[\/\\\]/",$abook_global_file)) {
  73.             /* no path chars, address book stored in data directory
  74.              * make sure that there is a slash between data directory
  75.              * and address book file name
  76.              */
  77.             $abook_global_filename=$data_dir
  78.                 . ((substr($data_dir, -1) != '/') ? '/' : '')
  79.                 . $abook_global_file;
  80.         } elseif (preg_match("/^\/|\w:/",$abook_global_file)) {
  81.             // full path is set in options (starts with slash or x:)
  82.             $abook_global_filename=$abook_global_file;
  83.         } else {
  84.             $abook_global_filename=SM_PATH . $abook_global_file;
  85.         }
  86.  
  87.         $r = $abook->add_backend('local_file',array('filename'=>$abook_global_filename,
  88.                                                     'name' => _("Global address book"),
  89.                                                     'detect_writeable' => false,
  90.                                                     'line_length' => $abook_file_line_length,
  91.                                                     'writeable'=> $abook_global_file_writeable,
  92.                                                     'listing' => $abook_global_file_listing));
  93.  
  94.         /* global abook init error is not fatal. add error message and continue */
  95.         if (!$r && $showerr) {
  96.             if ($abook_init_error!='') $abook_init_error.="\n";
  97.             $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error;
  98.         }
  99.     }
  100.  
  101.     /* Load global addressbook from SQL if configured */
  102.     if (isset($addrbook_global_dsn) && !empty($addrbook_global_dsn)) {
  103.       /* Database configured */
  104.       if (!isset($addrbook_global_table) || empty($addrbook_global_table)) {
  105.           $addrbook_global_table = 'global_abook';
  106.       }
  107.       $r = $abook->add_backend('database',
  108.                                Array('dsn' => $addrbook_global_dsn,
  109.                                      'owner' => 'global',
  110.                                      'name' => _("Global address book"),
  111.                                      'writeable' => $addrbook_global_writeable,
  112.                                      'listing' => $addrbook_global_listing,
  113.                                      'table' => $addrbook_global_table));
  114.       /* global abook init error is not fatal. add error message and continue */
  115.       if (!$r && $showerr) {
  116.           if ($abook_init_error!='') $abook_init_error.="\n";
  117.           $abook_init_error.=_("Error initializing global address book.") . "\n" . $abook->error;
  118.       }
  119.     }
  120.  
  121.     /*
  122.      * hook allows to include different address book backends.
  123.      * plugins should extract $abook and $r from arguments
  124.      * and use same add_backend commands as above functions.
  125.      * Since 1.5.2 hook sends third ($onlylocal) argument to address book
  126.      * plugins in order to allow detection of local address book init.
  127.      * @since 1.5.1 and 1.4.5
  128.      */
  129.     $hookReturn = do_hook('abook_init', $abook, $r, $onlylocal);
  130.     $abook = $hookReturn[1];
  131.     $r = $hookReturn[2];
  132.     if (!$r && $showerr) {
  133.         if ($abook_init_error!='') $abook_init_error.="\n";
  134.         $abook_init_error.=_("Error initializing other address books.") . "\n" . $abook->error;
  135.     }
  136.  
  137.     /* Load configured LDAP servers (if PHP has LDAP support) */
  138.     if (isset($ldap_server) && is_array($ldap_server)) {
  139.         reset($ldap_server);
  140.         while (list($undef,$param) = each($ldap_server)) {
  141.             if (!is_array($param))
  142.                 continue;
  143.  
  144.             /* if onlylocal is true, we only add writeable ldap servers */
  145.             if ($onlylocal && (!isset($param['writeable']) || $param['writeable'] != true))
  146.                 continue;
  147.  
  148.             $r = $abook->add_backend('ldap_server', $param);
  149.             if (!$r && $showerr) {
  150.                 if ($abook_init_error!='') $abook_init_error.="\n";
  151.                 $abook_init_error.=sprintf(_("Error initializing LDAP server %s:"), $param['host'])."\n";
  152.                 $abook_init_error.= $abook->error;
  153.             }
  154.         }
  155.     } // end of ldap server init
  156.  
  157.     /**
  158.      * display address book init errors.
  159.      */
  160.     if ($abook_init_error!='' && $showerr) {
  161.         error_box(nl2br(htmlspecialchars($abook_init_error)));
  162.     }
  163.  
  164.     /* Return the initialized object */
  165.     return $abook;
  166. }
  167.  
  168. /**
  169.  * Display the "new address" form
  170.  *
  171.  * Form is not closed and you must add closing form tag.
  172.  * @since 1.5.1
  173.  * @param string $form_url form action url
  174.  * @param string $name form name
  175.  * @param string $title form title
  176.  * @param string $button form button name
  177.  * @param array $defdata values of form fields
  178.  */
  179. function abook_create_form($form_url,$name,$title,$button,$defdata=array()) {
  180.     global $oTemplate;
  181.  
  182.     echo addForm($form_url, 'post', 'f_add');
  183.  
  184.     if ($button == _("Update address")) {
  185.         $edit = true;
  186.         $backends = NULL;
  187.     } else {
  188.         $edit = false;
  189.         $backends = getWritableBackends();
  190.     }
  191.     
  192.     $fields = array (
  193.                         'nickname'  => 'NickName',
  194.                         'firstname' => 'FirstName',
  195.                         'lastname'  => 'LastName',
  196.                         'email'     => 'Email',
  197.                         'label'     => 'Info',
  198.                     );
  199.     $values = array();
  200.     foreach ($fields as $sqm=>$template) {
  201.         $values[$template] = isset($defdata[$sqm]) ? $defdata[$sqm] : '';
  202.     }
  203.     
  204.     $oTemplate->assign('writable_backends', $backends);
  205.     $oTemplate->assign('values', $values);
  206.     $oTemplate->assign('edit', $edit);
  207.     
  208.     $oTemplate->display('addrbook_addedit.tpl');
  209. }
  210.  
  211.  
  212. /**
  213.  *   Had to move this function outside of the Addressbook Class
  214.  *   PHP 4.0.4 Seemed to be having problems with inline functions.
  215.  *   Note: this can return now since we don't support 4.0.4 anymore.
  216.  */
  217. function addressbook_cmp($a,$b) {
  218.  
  219.     if($a['backend'] > $b['backend']) {
  220.         return 1;
  221.     } else if($a['backend'] < $b['backend']) {
  222.         return -1;
  223.     }
  224.  
  225.     return (strtolower($a['name']) > strtolower($b['name'])) ? 1 : -1;
  226.  
  227. }
  228.  
  229. /**
  230.  * Retrieve a list of writable backends
  231.  * @since 1.5.2
  232.  */
  233. function getWritableBackends () {
  234.     global $abook;
  235.     
  236.     $write = array();
  237.     $backends = $abook->get_backend_list();
  238.     while (list($undef,$v) = each($backends)) {
  239.         if ($v->writeable) {
  240.             $write[$v->bnum]=$v->sname;
  241.         }
  242.     }
  243.  
  244.     return $write;
  245. }
  246.  
  247. /**
  248.  * Sort array by the key "name"
  249.  */
  250. function alistcmp($a,$b) {
  251.     $abook_sort_order=get_abook_sort();
  252.  
  253.     switch ($abook_sort_order) {
  254.     case 0:
  255.     case 1:
  256.       $abook_sort='nickname';
  257.       break;
  258.     case 4:
  259.     case 5:
  260.       $abook_sort='email';
  261.       break;
  262.     case 6:
  263.     case 7:
  264.       $abook_sort='label';
  265.       break;
  266.     case 2:
  267.     case 3:
  268.     case 8:
  269.     default:
  270.       $abook_sort='name';
  271.     }
  272.  
  273.     if ($a['backend'] > $b['backend']) {
  274.         return 1;
  275.     } else {
  276.         if ($a['backend'] < $b['backend']) {
  277.             return -1;
  278.         }
  279.     }
  280.  
  281.     if( (($abook_sort_order+2) % 2) == 1) {
  282.       return (strtolower($a[$abook_sort]) < strtolower($b[$abook_sort])) ? 1 : -1;
  283.     } else {
  284.       return (strtolower($a[$abook_sort]) > strtolower($b[$abook_sort])) ? 1 : -1;
  285.     }
  286. }
  287.  
  288. /**
  289.  * Address book sorting options
  290.  *
  291.  * returns address book sorting order
  292.  * @return integer book sorting options order
  293.  */
  294. function get_abook_sort() {
  295.     global $data_dir, $username;
  296.  
  297.     /* get sorting order */
  298.     if(sqgetGlobalVar('abook_sort_order', $temp, SQ_GET)) {
  299.       $abook_sort_order = (int) $temp;
  300.  
  301.       if ($abook_sort_order < 0 or $abook_sort_order > 8)
  302.         $abook_sort_order=8;
  303.  
  304.       setPref($data_dir, $username, 'abook_sort_order', $abook_sort_order);
  305.     } else {
  306.       /* get previous sorting options. default to unsorted */
  307.       $abook_sort_order = getPref($data_dir, $username, 'abook_sort_order', 8);
  308.     }
  309.  
  310.     return $abook_sort_order;
  311. }
  312.  
  313. /**
  314.  * This function shows the address book sort button.
  315.  *
  316.  * @param integer $abook_sort_order current sort value
  317.  * @param string $alt_tag alt tag value (string visible to text only browsers)
  318.  * @param integer $Down sort value when list is sorted ascending
  319.  * @param integer $Up sort value when list is sorted descending
  320.  * @return string html code with sorting images and urls
  321.  */
  322. function show_abook_sort_button($abook_sort_order, $alt_tag, $Down, $Up ) {
  323.     global $form_url, $icon_theme_path;
  324.  
  325.      /* Figure out which image we want to use. */
  326.     if ($abook_sort_order != $Up && $abook_sort_order != $Down) {
  327.         $img = 'sort_none.png';
  328.         $text_icon = '&#9723;'; // U+25FB WHITE MEDIUM SQUARE
  329.         $which = $Up;
  330.     } elseif ($abook_sort_order == $Up) {
  331.         $img = 'up_pointer.png';
  332.         $text_icon = '&#8679;'; // U+21E7 UPWARDS WHITE ARROW
  333.         $which = $Down;
  334.     } else {
  335.         $img = 'down_pointer.png';
  336.         $text_icon = '&#8681;'; // U+21E9 DOWNWARDS WHITE ARROW
  337.         $which = 8;
  338.     }
  339.  
  340.     /* Now that we have everything figured out, show the actual button. */
  341.     return '&nbsp;<a href="' . $form_url .'?abook_sort_order=' . $which .
  342.            '" style="text-decoration:none" title="'.$alt_tag.'">' .
  343.            getIcon($icon_theme_path, $img, $text_icon, $alt_tag) .
  344.            '</a>';
  345. }
  346.  
  347.  
  348. /**
  349.  * This is the main address book class that connect all the
  350.  * backends and provide services to the functions above.
  351.  * @package squirrelmail
  352.  * @subpackage addressbook
  353.  */
  354. class AddressBook {
  355.     /**
  356.      * Enabled address book backends
  357.      * @var array 
  358.      */
  359.     var $backends    = array();
  360.     /**
  361.      * Number of enabled backends
  362.      * @var integer 
  363.      */
  364.     var $numbackends = 0;
  365.     /**
  366.      * Error messages
  367.      * @var string 
  368.      */
  369.     var $error       = '';
  370.     /**
  371.      * id of backend with personal address book
  372.      * @var integer 
  373.      */
  374.     var $localbackend = 0;
  375.     /**
  376.      * Name of backend with personal address book
  377.      * @var string 
  378.      */
  379.     var $localbackendname = '';
  380.     /**
  381.      * Controls use of 'extra' field
  382.      *
  383.      * Extra field can be used to add link to form, which allows
  384.      * to modify all fields supported by backend. This is the only field
  385.      * that is not sanitized with htmlspecialchars. Backends MUST make
  386.      * sure that field data is sanitized and displayed correctly inside
  387.      * table cell. Use of html formating in other address book fields is
  388.      * not allowed. Backends that don't return 'extra' row in address book
  389.      * data should not modify this object property.
  390.      * @var boolean 
  391.      * @since 1.5.1
  392.      */
  393.     var $add_extra_field = false;
  394.  
  395.     /**
  396.      * Constructor function.
  397.      */
  398.     function AddressBook() {
  399.         $this->localbackendname = _("Personal address book");
  400.     }
  401.  
  402.     /**
  403.      * Return an array of backends of a given type,
  404.      * or all backends if no type is specified.
  405.      * @param string $type backend type
  406.      * @return array list of backends
  407.      */
  408.     function get_backend_list($type = '') {
  409.         $ret = array();
  410.         for ($i = 1 ; $i <= $this->numbackends ; $i++) {
  411.             if (empty($type) || $type == $this->backends[$i]->btype) {
  412.                 $ret[] = &$this->backends[$i];
  413.             }
  414.         }
  415.         return $ret;
  416.     }
  417.  
  418.  
  419.     /* ========================== Public ======================== */
  420.  
  421.     /**
  422.      * Add a new backend.
  423.      *
  424.      * @param string $backend backend name (without the abook_ prefix)
  425.      * @param mixed optional variable that is passed to the backend constructor.
  426.      *  See each of the backend classes for valid parameters
  427.      * @return integer number of backends
  428.      */
  429.     function add_backend($backend, $param = '') {
  430.         static $backend_classes;
  431.         if (!isset($backend_classes)) {
  432.             $backend_classes = array();
  433.         }
  434.         if (!isset($backend_classes[$backend])) {
  435.             /**
  436.               * Support backend provided by plugins. Plugin function must
  437.               * return an associative array with as key the backend name ($backend)
  438.               * and as value the file including the path containing the backend class.
  439.               * i.e.: $aBackend = array('backend_template' => SM_PATH . 'plugins/abook_backend_template/functions.php')
  440.               *
  441.               * NB: Because the backend files are included from within this function they DO NOT have access to
  442.               * vars in the global scope. This function is the global scope for the included backend !!!
  443.               */
  444.             $aBackend = do_hook('abook_add_class');
  445.             if (isset($aBackend) && is_array($aBackend) && isset($aBackend[$backend])) {
  446.                 require_once($aBackend[$backend]);
  447.             } else {
  448.                 require_once(SM_PATH . 'functions/abook_'.$backend.'.php');
  449.             }
  450.             $backend_classes[$backend] = true;
  451.         }
  452.         $backend_name = 'abook_' . $backend;
  453.         $newback = new $backend_name($param);
  454.         //eval('$newback = new ' . $backend_name . '($param);');
  455.         if(!empty($newback->error)) {
  456.             $this->error = $newback->error;
  457.             return false;
  458.         }
  459.  
  460.         $this->numbackends++;
  461.  
  462.         $newback->bnum = $this->numbackends;
  463.         $this->backends[$this->numbackends] = $newback;
  464.  
  465.         /* Store ID of first local backend added */
  466.         if ($this->localbackend == 0 && $newback->btype == 'local') {
  467.             $this->localbackend = $this->numbackends;
  468.             $this->localbackendname = $newback->sname;
  469.         }
  470.  
  471.         return $this->numbackends;
  472.     }
  473.  
  474.  
  475.     /**
  476.      * create string with name and email address
  477.      *
  478.      * This function takes a $row array as returned by the addressbook
  479.      * search and returns an e-mail address with the full name or
  480.      * nickname optionally prepended.
  481.      * @param array $row address book entry
  482.      * @return string email address with real name prepended
  483.      */
  484.     function full_address($row) {
  485.         global $addrsrch_fullname, $data_dir, $username;
  486.         $prefix = getPref($data_dir, $username, 'addrsrch_fullname');
  487.         if (($prefix != "" || (isset($addrsrch_fullname) &&
  488.             $prefix == $addrsrch_fullname)) && $prefix != 'noprefix') {
  489.             $name = ($prefix == 'nickname' ? $row['nickname'] : $row['name']);
  490.             return $name . ' <' . trim($row['email']) . '>';
  491.         } else {
  492.             return trim($row['email']);
  493.         }
  494.     }
  495.  
  496.     /**
  497.      * Search for entries in address books
  498.      *
  499.      * Return a list of addresses matching expression in
  500.      * all backends of a given type.
  501.      * @param string $expression search expression
  502.      * @param integer $bnum backend number. default to search in all backends
  503.      * @return array search results
  504.      */
  505.     function search($expression, $bnum = -1) {
  506.         $ret = array();
  507.         $this->error = '';
  508.  
  509.         /* Search all backends */
  510.         if ($bnum == -1) {
  511.             $sel = $this->get_backend_list('');
  512.             $failed = 0;
  513.             for ($i = 0 ; $i < sizeof($sel) ; $i++) {
  514.                 $backend = &$sel[$i];
  515.                 $backend->error = '';
  516.      &nb