Source for file abook_ldap_server.php

Documentation is available at abook_ldap_server.php

  1. <?php
  2.  
  3. /**
  4.  * abook_ldap_server.php
  5.  *
  6.  * Address book backend for LDAP server
  7.  *
  8.  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: abook_ldap_server.php,v 1.18.2.9 2006/04/14 22:27:07 jervfors Exp $
  11.  * @package squirrelmail
  12.  * @subpackage addressbook
  13.  */
  14.  
  15. /**
  16.  * Address book backend for LDAP server
  17.  *
  18.  * An array with the following elements must be passed to
  19.  * the class constructor (elements marked ? are optional):
  20.  * <pre>
  21.  *    host      => LDAP server hostname/IP-address
  22.  *    base      => LDAP server root (base dn). Empty string allowed.
  23.  *  ? port      => LDAP server TCP port number (default: 389)
  24.  *  ? charset   => LDAP server charset (default: utf-8)
  25.  *  ? name      => Name for LDAP server (default "LDAP: hostname")
  26.  *                 Used to tag the result data
  27.  *  ? maxrows   => Maximum # of rows in search result
  28.  *  ? timeout   => Timeout for LDAP operations (in seconds, default: 30)
  29.  *                 Might not work for all LDAP libraries or servers.
  30.  *  ? binddn    => LDAP Bind DN.
  31.  *  ? bindpw    => LDAP Bind Password.
  32.  *  ? protocol  => LDAP Bind protocol.
  33.  * </pre>
  34.  * NOTE. This class should not be used directly. Use the
  35.  *       "AddressBook" class instead.
  36.  * @package squirrelmail
  37.  * @subpackage addressbook
  38.  */
  39. class abook_ldap_server extends addressbook_backend {
  40.     /**
  41.      * @var string backend type
  42.      */
  43.     var $btype = 'remote';
  44.     /**
  45.      * @var string backend name
  46.      */
  47.     var $bname = 'ldap_server';
  48.  
  49.     /* Parameters changed by class */
  50.     /**
  51.      * @var string displayed name
  52.      */
  53.     var $sname   = 'LDAP';       /* Service name */
  54.     /**
  55.      * @var string LDAP server name or address or url
  56.      */
  57.     var $server  = '';
  58.     /**
  59.      * @var integer LDAP server port
  60.      */
  61.     var $port    = 389;
  62.     /**
  63.      * @var string LDAP base DN
  64.      */
  65.     var $basedn  = '';
  66.     /**
  67.      * @var string charset used for entries in LDAP server
  68.      */
  69.     var $charset = 'utf-8';
  70.     /**
  71.      * @var object PHP LDAP link ID
  72.      */
  73.     var $linkid  = false;
  74.     /**
  75.      * @var bool True if LDAP server is bound
  76.      */
  77.     var $bound   = false;
  78.     /**
  79.      * @var integer max rows in result
  80.      */
  81.     var $maxrows = 250;
  82.     /**
  83.      * @var integer timeout of LDAP operations (in seconds)
  84.      */
  85.     var $timeout = 30;
  86.     /**
  87.      * @var string DN to bind to (non-anonymous bind)
  88.      * @since 1.5.0 and 1.4.3
  89.      */
  90.     var $binddn = '';
  91.     /**
  92.      * @var string  password to bind with (non-anonymous bind)
  93.      * @since 1.5.0 and 1.4.3
  94.      */
  95.     var $bindpw = '';
  96.     /**
  97.      * @var integer protocol used to connect to ldap server
  98.      * @since 1.5.0 and 1.4.3
  99.      */
  100.     var $protocol = '';
  101.  
  102.     /**
  103.      * Constructor. Connects to database
  104.      * @param array connection options
  105.      */
  106.     function abook_ldap_server($param) {
  107.         if(!function_exists('ldap_connect')) {
  108.             $this->set_error('LDAP support missing from PHP');
  109.             return;
  110.         }
  111.         if(is_array($param)) {
  112.             $this->server = $param['host'];
  113.             $this->basedn = $param['base'];
  114.             if(!empty($param['port'])) {
  115.                 $this->port = $param['port'];
  116.             }
  117.             if(!empty($param['charset'])) {
  118.                 $this->charset = strtolower($param['charset']);
  119.             }
  120.             if(isset($param['maxrows'])) {
  121.                 $this->maxrows = $param['maxrows'];
  122.             }
  123.             if(isset($param['timeout'])) {
  124.                 $this->timeout = $param['timeout'];
  125.             }
  126.             if(isset($param['binddn'])) {
  127.                 $this->binddn = $param['binddn'];
  128.             }
  129.             if(isset($param['bindpw'])) {
  130.                 $this->bindpw = $param['bindpw'];
  131.             }
  132.             if(isset($param['protocol'])) {
  133.                 $this->protocol = $param['protocol'];
  134.             }
  135.             if(empty($param['name'])) {
  136.                 $this->sname = 'LDAP: ' . $param['host'];
  137.             }
  138.             else {
  139.                 $this->sname = $param['name'];
  140.             }
  141.  
  142.             $this->open(true);
  143.         } else {
  144.             $this->set_error('Invalid argument to constructor');
  145.         }
  146.     }
  147.  
  148.  
  149.     /**
  150.      * Open the LDAP server.
  151.      * @param bool $new is it a new connection
  152.      * @return bool 
  153.      */
  154.     function open($new = false) {
  155.         $this->error = '';
  156.  
  157.         /* Connection is already open */
  158.         if($this->linkid != false && !$new) {
  159.             return true;
  160.         }
  161.  
  162.         $this->linkid = @ldap_connect($this->server, $this->port);
  163.         if(!$this->linkid) {
  164.             if(function_exists('ldap_error')) {
  165.                 return $this->set_error(ldap_error($this->linkid));
  166.             } else {
  167.                 return $this->set_error('ldap_connect failed');
  168.             }
  169.         }
  170.  
  171.         if(!empty($this->protocol)) {
  172.             if(!@ldap_set_option($this->linkid, LDAP_OPT_PROTOCOL_VERSION, $this->protocol)) {
  173.                 if(function_exists('ldap_error')) {
  174.                     return $this->set_error(ldap_error($this->linkid));
  175.                 } else {
  176.                     return $this->set_error('ldap_set_option failed');
  177.                 }
  178.             }
  179.         }
  180.  
  181.         if(!empty($this->binddn)) {
  182.             if(!@ldap_bind($this->linkid, $this->binddn, $this->bindpw)) {
  183.                 if(function_exists('ldap_error')) {
  184.                     return $this->set_error(ldap_error($this->linkid));
  185.                 } else {
  186.                     return $this->set_error('authenticated ldap_bind failed');
  187.                 }
  188.               }
  189.         } else {
  190.             if(!@ldap_bind($this->linkid)) {
  191.                 if(function_exists('ldap_error')) {
  192.                     return $this->set_error(ldap_error($this->linkid));
  193.                 } else {
  194.                     return $this->set_error('anonymous ldap_bind failed');
  195.                 }
  196.             }
  197.         }
  198.  
  199.         $this->bound = true;
  200.  
  201.         return true;
  202.     }
  203.  
  204.     /**
  205.      * Converts string to the charset used by LDAP server
  206.      * @param string string that has to be converted
  207.      * @return string converted string
  208.      */
  209.     function charset_encode($str) {
  210.         global $default_charset;
  211.         if($this->charset != $default_charset) {
  212.             return charset_convert($default_charset,$str,$this->charset,false);
  213.         } else {
  214.             return $str;
  215.         }
  216.     }
  217.  
  218.     /**
  219.      * Convert from charset used by LDAP server to charset used by translation
  220.      *
  221.      * Output must be sanitized.
  222.      * @param string string that has to be converted
  223.      * @return string converted string
  224.      */
  225.     function charset_decode($str) {
  226.         global $default_charset;
  227.         if ($this->charset != $default_charset) {
  228.             return charset_convert($this->charset,$str,$default_charset,false);
  229.         } else {
  230.             return $str;
  231.         }
  232.     }
  233.  
  234.     /**
  235.      * Sanitizes ldap search strings.
  236.      * See rfc2254
  237.      * @link http://www.faqs.org/rfcs/rfc2254.html
  238.      * @since 1.5.1 and 1.4.5
  239.      * @param string $string 
  240.      * @return string sanitized string
  241.      */
  242.     function ldapspecialchars($string) {
  243.         $sanitized=array('\\' => '\5c',
  244.                          '*' => '\2a',
  245.                          '(' => '\28',
  246.                          ')' => '\29',
  247.                          "\x00" => '\00');
  248.  
  249.         return str_replace(array_keys($sanitized),array_values($sanitized),$string);
  250.     }
  251.  
  252.     /* ========================== Public ======================== */
  253.  
  254.     /**
  255.      * Search the LDAP server
  256.      * @param string $expr search expression
  257.      * @return array search results
  258.      */
  259.     function search($expr) {
  260.         /* To be replaced by advanded search expression parsing */
  261.         if(is_array($expr)) return false;
  262.  
  263.         /* Encode the expression */
  264.         $expr = $this->charset_encode($expr);
  265.  
  266.         /*
  267.          * allow use of one asterisk in search. 
  268.          * Don't allow any ldap special chars if search is different
  269.          */
  270.         if($expr!='*') {
  271.             $expr = '*' . $this->ldapspecialchars($expr) . '*';
  272.             /* Undo sanitizing of * symbol */
  273.             $expr = str_replace('\2a','*',$expr);
  274.         }
  275.         $expression = "cn=$expr";
  276.  
  277.         /* Make sure connection is there */
  278.         if(!$this->open()) {
  279.             return false;
  280.         }
  281.  
  282.         $sret = @ldap_search($this->linkid, $this->basedn, $expression,
  283.             array('dn', 'o', 'ou', 'sn', 'givenname', 'cn', 'mail'),
  284.             0, $this->maxrows, $this->timeout);
  285.  
  286.         /* Should get error from server using the ldap_error() function,
  287.          * but it only exist in the PHP LDAP documentation. */
  288.         if(!$sret) {
  289.             if(function_exists('ldap_error')) {
  290.                 return $this->set_error(ldap_error($this->linkid));
  291.             } else {
  292.                 return $this->set_error('ldap_search failed');
  293.             }
  294.         }
  295.  
  296.         if(@ldap_count_entries($this->linkid, $sret) <= 0) {
  297.             return array();
  298.         }
  299.  
  300.         /* Get results */
  301.         $ret = array();
  302.         $returned_rows = 0;
  303.         $res = @ldap_get_entries($this->linkid, $sret);
  304.         for($i = 0 ; $i < $res['count'] ; $i++) {
  305.             $row = $res[$i];
  306.  
  307.             /* Extract data common for all e-mail addresses
  308.              * of an object. Use only the first name */
  309.             $nickname = $this->charset_decode($row['dn']);
  310.             $fullname = $this->charset_decode($row['cn'][0]);
  311.  
  312.             if(!empty($row['ou'][0])) {
  313.                 $label = $this->charset_decode($row['ou'][0]);
  314.             }
  315.             else if(!empty($row['o'][0])) {
  316.                 $label = $this->charset_decode($row['o'][0]);
  317.             } else {
  318.                 $label = '';
  319.             }
  320.  
  321.             if(empty($row['givenname'][0])) {
  322.                 $firstname = '';
  323.             } else {
  324.                 $firstname = $this->charset_decode($row['givenname'][0]);
  325.             }
  326.  
  327.             if(empty($row['sn'][0])) {
  328.                 $surname = '';
  329.             } else {
  330.                 $surname = $this->charset_decode($row['sn'][0]);
  331.             }
  332.  
  333.             /* Add one row to result for each e-mail address */
  334.             if(isset($row['mail']['count'])) {
  335.                 for($j = 0 ; $j < $row['mail']['count'] ; $j++) {
  336.                     array_push($ret, array('nickname'  => $nickname,
  337.                    'name'      => $fullname,
  338.                    'firstname' => $firstname,
  339.                    'lastname'  => $surname,
  340.                    'email'     => $row['mail'][$j],
  341.                    'label'     => $label,
  342.                    'backend'   => $this->bnum,
  343.                    'source'    => &$this->sname));
  344.  
  345.                     // Limit number of hits
  346.                     $returned_rows++;
  347.                     if(($returned_rows >= $this->maxrows) &&
  348.                        ($this->maxrows > 0) ) {
  349.                         ldap_free_result($sret);
  350.                         return $ret;
  351.                     }
  352.  
  353.                 } // for($j ...)
  354.  
  355.             } // isset($row['mail']['count'])
  356.  
  357.         }
  358.  
  359.         ldap_free_result($sret);
  360.         return $ret;
  361.     } /* end search() */
  362.  
  363.  
  364.     /**
  365.      * List all entries present in LDAP server
  366.      *
  367.      * If you run a tiny LDAP server and you want the "List All" button
  368.      * to show EVERYONE, disable first return call and enable the second one.
  369.      * Remember that maxrows setting might limit list of returned entries.
  370.      *
  371.      * Careful with this -- it could get quite large for big sites.
  372.      * @return array all entries in ldap server
  373.      */
  374.      function list_addr() {
  375.          return array();
  376.          // return $this->search('*');
  377.      }
  378. }
  379. ?>

Documentation generated on Sat, 07 Oct 2006 16:29:36 +0300 by phpDocumentor 1.3.0RC6