PHP7: Fixed some E_WARNING errors that previously were E_STRICT

Aleksander Machniak

2015-08-07 1b39d9a6c744a393e7930c2493cc2ddc9c9e95bf

 program/lib/Roundcube/rcube_ldap.php

@@ -1,6 +1,6 @@
<?php

/*
/**
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2006-2013, The Roundcube Dev Team                       |
@@ -64,7 +64,8 @@

    private $base_dn        = '';
    private $groups_base_dn = '';
    private $group_url;
    private $group_data;
    private $group_search_cache;
    private $cache;


@@ -101,8 +102,8 @@
            // add group name attrib to the list of attributes to be fetched
            $fetch_attributes[] = $this->prop['groups']['name_attr'];
        }
        if (is_array($p['group_filters']) && count($p['group_filters'])) {
            $this->groups = true;
        if (is_array($p['group_filters'])) {
            $this->groups = $this->groups || count($p['group_filters']);

            foreach ($p['group_filters'] as $k => $group_filter) {
                // set default name attribute to cn
@@ -116,13 +117,14 @@

        // fieldmap property is given
        if (is_array($p['fieldmap'])) {
            $p['fieldmap'] = array_filter($p['fieldmap']);
            foreach ($p['fieldmap'] as $rf => $lf)
                $this->fieldmap[$rf] = $this->_attr_name(strtolower($lf));
        }
        else if (!empty($p)) {
            // read deprecated *_field properties to remain backwards compatible
            foreach ($p as $prop => $value)
                if (preg_match('/^(.+)_field$/', $prop, $matches))
                if (!empty($value) && preg_match('/^(.+)_field$/', $prop, $matches))
                    $this->fieldmap[$matches[1]] = $this->_attr_name(strtolower($value));
        }

@@ -232,16 +234,14 @@

        // initialize ldap wrapper object
        $this->ldap = new rcube_ldap_generic($this->prop);
        $this->ldap->set_cache($this->cache);
        $this->ldap->set_debug($this->debug);
        $this->ldap->config_set(array('cache' => $this->cache, 'debug' => $this->debug));

        $this->_connect();
    }


    /**
    * Establish a connection to the LDAP server
    */
     * Establish a connection to the LDAP server
     */
    private function _connect()
    {
        $rcube = rcube::get_instance();
@@ -282,12 +282,21 @@
                }

                // Get the pieces needed for variable replacement.
                if ($fu = $rcube->get_user_email())
                if ($fu = $rcube->get_user_email()) {
                    list($u, $d) = explode('@', $fu);
                else
                }
                else {
                    $d = $this->mail_domain;
                }

                $dc = 'dc='.strtr($d, array('.' => ',dc=')); // hierarchal domain string

                // resolve $dc through LDAP
                if (!empty($this->prop['domain_filter']) && !empty($this->prop['search_bind_dn']) &&
                        method_exists($this->ldap, 'domain_root_dn')) {
                    $this->ldap->bind($this->prop['search_bind_dn'], $this->prop['search_bind_pw']);
                    $dc = $this->ldap->domain_root_dn($d);
                }

                $replaces = array('%dn' => '', '%dc' => $dc, '%d' => $d, '%fu' => $fu, '%u' => $u);

@@ -320,8 +329,7 @@
                            // we need to use a separate LDAP connection
                            if (!empty($this->prop['vlv'])) {
                                $ldap = new rcube_ldap_generic($this->prop);
                                $ldap->set_debug($this->debug);
                                $ldap->set_cache($this->cache);
                                $ldap->config_set(array('cache' => $this->cache, 'debug' => $this->debug));
                                if (!$ldap->connect($host)) {
                                    continue;
                                }
@@ -335,7 +343,7 @@
                        $res = $ldap->search($search_base_dn, $search_filter, 'sub', $search_attribs);
                        if ($res) {
                            $res->rewind();
                            $replaces['%dn'] = $res->get_dn();
                            $replaces['%dn'] = key($res->entries(TRUE));

                            // add more replacements from 'search_bind_attrib' config
                            if ($search_bind_attrib) {
@@ -383,7 +391,7 @@
                        $this->prop['groups'][$k] = strtr($this->prop['groups'][$k], $replaces);
                }

                if (!empty($this->prop['group_filters'])) {
                if (is_array($this->prop['group_filters'])) {
                    foreach ($this->prop['group_filters'] as $i => $gf) {
                        if (!empty($gf['base_dn']))
                            $this->prop['group_filters'][$i]['base_dn'] = strtr($gf['base_dn'], $replaces);
@@ -430,7 +438,6 @@
        return $this->ready;
    }


    /**
     * Close connection to LDAP server
     */
@@ -441,7 +448,6 @@
        }
    }


    /**
     * Returns address book name
     *
@@ -451,7 +457,6 @@
    {
        return $this->prop['name'];
    }


    /**
     * Set internal list page
@@ -475,7 +480,6 @@
        $this->ldap->set_vlv_page($this->list_page, $this->page_size);
    }


    /**
     * Set internal sort settings
     *
@@ -488,7 +492,6 @@
            $this->sort_col = $this->coltypes[$sort_col]['attributes'][0];
    }


    /**
     * Save a search string for future listings
     *
@@ -498,7 +501,6 @@
    {
        $this->filter = $filter;
    }


    /**
     * Getter for saved search properties
@@ -510,7 +512,6 @@
        return $this->filter;
    }


    /**
     * Reset all saved results and search parameters
     */
@@ -521,14 +522,13 @@
        $this->filter = '';
    }


    /**
     * List the current set of contact records
     *
     * @param  array  List of cols to show
     * @param  int    Only return this number of records
     * @param array List of cols to show
     * @param int   Only return this number of records
     *
     * @return array  Indexed list of contact records, each a hash array
     * @return array Indexed list of contact records, each a hash array
     */
    function list_records($cols=null, $subset=0)
    {
@@ -698,8 +698,9 @@

        for ($i=0; $i < $entry['memberurl']['count']; $i++) {
            // extract components from url
            if (!preg_match('!ldap:///([^\?]+)\?\?(\w+)\?(.*)$!', $entry['memberurl'][$i], $m))
            if (!preg_match('!ldap://[^/]*/([^\?]+)\?\?(\w+)\?(.*)$!', $entry['memberurl'][$i], $m)) {
                continue;
            }

            // add search filter if any
            $filter = $this->filter ? '(&(' . $m[3] . ')(' . $this->filter . '))' : $m[3];
@@ -725,7 +726,6 @@
    {
        return strcmp($a[$this->sort_col][0], $b[$this->sort_col][0]);
    }


    /**
     * Search contacts
@@ -766,16 +766,16 @@
        if ($this->prop['vlv_search'] && $this->ready && join(',', (array)$fields) == join(',', $list_fields)) {
            $this->result = new rcube_result_set(0);

            $search_suffix = $this->prop['fuzzy_search'] && $mode != 1 ? '*' : '';
            $this->ldap->config_set('fuzzy_search', intval($this->prop['fuzzy_search'] && $mode != 1));
            $ldap_data = $this->ldap->search($this->base_dn, $this->prop['filter'], $this->prop['scope'], $this->prop['attributes'],
                array('search' => $value . $search_suffix /*, 'sort' => $this->prop['sort'] */));
                array('search' => $value /*, 'sort' => $this->prop['sort'] */));
            if ($ldap_data === false) {
                return $this->result;
            }

            // get all entries of this page and post-filter those that really match the query
            $search = mb_strtolower($value);
            foreach ($ldap_data as $i => $entry) {
            foreach ($ldap_data as $entry) {
                $rec = $this->_ldap2result($entry);
                foreach ($fields as $f) {
                    foreach ((array)$rec[$f] as $val) {
@@ -791,33 +791,24 @@
            return $this->result;
        }

        // use AND operator for advanced searches
        $filter = is_array($value) ? '(&' : '(|';
        // set wildcards
        $wp = $ws = '';
        if (!empty($this->prop['fuzzy_search']) && $mode != 1) {
            $ws = '*';
            if (!$mode) {
                $wp = '*';
            }
        }
        // advanced per-attribute search
        if (is_array($value)) {
            // use AND operator for advanced searches
            $filter = '(&';

        if ($fields == '*') {
            // search_fields are required for fulltext search
            if (empty($this->prop['search_fields'])) {
                $this->set_error(self::ERROR_SEARCH, 'nofulltextsearch');
                $this->result = new rcube_result_set();
                return $this->result;
            }
            if (is_array($this->prop['search_fields'])) {
                foreach ($this->prop['search_fields'] as $field) {
                    $filter .= "($field=$wp" . rcube_ldap_generic::quote_string($value) . "$ws)";
            // set wildcards
            $wp = $ws = '';
            if (!empty($this->prop['fuzzy_search']) && $mode != 1) {
                $ws = '*';
                if (!$mode) {
                    $wp = '*';
                }
            }
        }
        else {

            foreach ((array)$fields as $idx => $field) {
                $val = is_array($value) ? $value[$idx] : $value;
                $val = $value[$idx];
                if (!strlen($val))
                    continue;
                if ($attrs = $this->_map_field($field)) {
                    if (count($attrs) > 1)
                        $filter .= '(|';
@@ -827,8 +818,32 @@
                        $filter .= ')';
                }
            }

            $filter .= ')';
        }
        $filter .= ')';
        else {
            if ($fields == '*') {
                // search_fields are required for fulltext search
                if (empty($this->prop['search_fields'])) {
                    $this->set_error(self::ERROR_SEARCH, 'nofulltextsearch');
                    $this->result = new rcube_result_set();
                    return $this->result;
                }
                $attributes = (array)$this->prop['search_fields'];
            }
            else {
                // map address book fields into ldap attributes
                $attributes = array();
                foreach ((array) $fields as $field) {
                    if ($this->coltypes[$field] && ($attrs = $this->coltypes[$field]['attributes'])) {
                        $attributes = array_merge($attributes, (array) $attrs);
                    }
                }
            }

            // compose a full-text-like search filter
            $filter = rcube_ldap_generic::fulltext_search_filter($value, $attributes, $mode);
        }

        // add required (non empty) fields filter
        $req_filter = '';
@@ -866,7 +881,6 @@
        return $this->result;
    }


    /**
     * Count number of available contacts in database
     *
@@ -895,7 +909,6 @@
        return new rcube_result_set($count, ($this->list_page-1) * $this->page_size);
    }


    /**
     * Return the last result set
     *
@@ -905,7 +918,6 @@
    {
        return $this->result;
    }


    /**
     * Get a specific contact record
@@ -948,6 +960,22 @@
        return $assoc ? $res : $this->result;
    }

    /**
     * Returns the last error occurred (e.g. when updating/inserting failed)
     *
     * @return array Hash array with the following fields: type, message
     */
    function get_error()
    {
        $err = $this->error;

        // check ldap connection for errors
        if (!$err && $this->ldap->get_error()) {
            $err = array(self::ERROR_SEARCH, $this->ldap->get_error());
        }

        return $err;
    }

    /**
     * Check the given data before saving.
@@ -1020,15 +1048,17 @@
        return true;
    }


    /**
     * Create a new contact record
     *
     * @param array    Hash array with save data
     * @param array Associative array with save data
     *  Keys:   Field name with optional section in the form FIELD:SECTION
     *  Values: Field value. Can be either a string or an array of strings for multiple values
     * @param boolean True to check for duplicates first
     *
     * @return encoded record ID on success, False on error
     * @return mixed The created record ID on success, False on error
     */
    function insert($save_cols)
    function insert($save_cols, $check = false)
    {
        // Map out the column names to their LDAP ones to build the new entry.
        $newentry = $this->_map_data($save_cols);
@@ -1066,7 +1096,7 @@
            }
        }

        if (!$this->ldap->add($dn, $newentry)) {
        if (!$this->ldap->add_entry($dn, $newentry)) {
            $this->set_error(self::ERROR_SAVING, 'errorsaving');
            return false;
        }
@@ -1078,7 +1108,7 @@
                'objectClass' => (array) $this->prop['sub_fields'][$xidx],
            );

            $this->ldap->add($xdn, $xf);
            $this->ldap->add_entry($xdn, $xf);
        }

        $dn = self::dn_encode($dn);
@@ -1089,7 +1119,6 @@

        return $dn;
    }


    /**
     * Update a specific contact record
@@ -1221,7 +1250,7 @@
        if (!empty($subdeldata)) {
            foreach ($subdeldata as $fld => $val) {
                $subdn = $fld.'='.rcube_ldap_generic::quote_string($val).','.$dn;
                if (!$this->ldap->delete($subdn)) {
                if (!$this->ldap->delete_entry($subdn)) {
                    return false;
                }
            }
@@ -1265,13 +1294,12 @@
                    $fld => $val,
                    'objectClass' => (array) $this->prop['sub_fields'][$fld],
                );
                $this->ldap->add($subdn, $xf);
                $this->ldap->add_entry($subdn, $xf);
            }
        }

        return $newdn ? $newdn : true;
    }


    /**
     * Mark one or more contact records as deleted
@@ -1295,7 +1323,7 @@
            if ($this->sub_filter) {
                if ($entries = $this->ldap->list_entries($dn, $this->sub_filter)) {
                    foreach ($entries as $entry) {
                        if (!$this->ldap->delete($entry['dn'])) {
                        if (!$this->ldap->delete_entry($entry['dn'])) {
                            $this->set_error(self::ERROR_SAVING, 'errorsaving');
                            return false;
                        }
@@ -1304,12 +1332,12 @@
            }

            // Delete the record.
            if (!$this->ldap->delete($dn)) {
            if (!$this->ldap->delete_entry($dn)) {
                $this->set_error(self::ERROR_SAVING, 'errorsaving');
                return false;
            }

            // remove contact from all groups where he was member
            // remove contact from all groups where he was a member
            if ($this->groups) {
                $dn = self::dn_encode($dn);
                $group_ids = $this->get_record_groups($dn);
@@ -1321,7 +1349,6 @@

        return count($ids);
    }


    /**
     * Remove all contact records
@@ -1342,7 +1369,7 @@

        if ($with_groups && $this->groups && ($groups = $this->_fetch_groups()) && count($groups)) {
            foreach ($groups as $group) {
                $this->ldap->delete($group['dn']);
                $this->ldap->delete_entry($group['dn']);
            }

            if ($this->cache) {
@@ -1390,7 +1417,6 @@
            }
        }
    }


    /**
     * Converts LDAP entry into an array
@@ -1450,7 +1476,6 @@
        return $out;
    }


    /**
     * Return LDAP attribute(s) for the given field
     */
@@ -1458,7 +1483,6 @@
    {
        return (array)$this->coltypes[$field]['attributes'];
    }


    /**
     * Convert a record data set into LDAP field attributes
@@ -1515,7 +1539,6 @@
        return $ldap_data;
    }


    /**
     * Returns unified attribute name (resolving aliases)
     */
@@ -1547,17 +1570,6 @@
    }

    /**
     * Prints debug info to the log
     */
    private function _debug($str)
    {
        if ($this->debug) {
            rcube::write_log('ldap', $str);
        }
    }


    /**
     * Activate/deactivate debug mode
     *
     * @param boolean $dbg True if LDAP commands should be logged
@@ -1567,10 +1579,9 @@
        $this->debug = $dbg;

        if ($this->ldap) {
            $this->ldap->set_debug($dbg);
            $this->ldap->config_set('debug', $dbg);
        }
    }


    /**
     * Setter for the current group
@@ -1604,12 +1615,12 @@
            return array();
        }

        $group_cache = $this->_fetch_groups();
        $group_cache = $this->_fetch_groups($search, $mode);
        $groups      = array();

        if ($search) {
            foreach ($group_cache as $group) {
                if ($this->compare_search_value('name', $group['name'], $search, $mode)) {
                if ($this->compare_search_value('name', $group['name'], mb_strtolower($search), $mode)) {
                    $groups[] = $group;
                }
            }
@@ -1624,10 +1635,19 @@
    /**
     * Fetch groups from server
     */
    private function _fetch_groups($vlv_page = null)
    private function _fetch_groups($search = null, $mode = 0, $vlv_page = null)
    {
        // reset group search cache
        if ($search !== null && $vlv_page === null) {
            $this->group_search_cache = null;
        }
        // return in-memory cache from previous search results
        else if (is_array($this->group_search_cache) && $vlv_page === null) {
            return $this->group_search_cache;
        }

        // special case: list groups from 'group_filters' config
        if ($vlv_page === null && !empty($this->prop['group_filters'])) {
        if ($vlv_page === null && $search === null && is_array($this->prop['group_filters'])) {
            $groups = array();
            $rcube  = rcube::get_instance();

@@ -1644,7 +1664,7 @@
            return $groups;
        }

        if ($this->cache && $vlv_page === null && ($groups = $this->cache->get('groups')) !== null) {
        if ($this->cache && $search === null && $vlv_page === null && ($groups = $this->cache->get('groups')) !== null) {
            return $groups;
        }

@@ -1666,12 +1686,26 @@
            }

            $ldap = clone $this->ldap;
            $ldap->set_config($this->prop['groups']);
            $ldap->config_set($this->prop['groups']);
            $ldap->set_vlv_page($vlv_page+1, $page_size);
        }

        $attrs     = array_unique(array('dn', 'objectClass', $name_attr, $email_attr, $sort_attr));
        $ldap_data = $ldap->search($base_dn, $filter, $scope, $attrs, $this->prop['groups']);
        $props = array('sort' => $this->prop['groups']['sort']);
        $attrs = array_unique(array('dn', 'objectClass', $name_attr, $email_attr, $sort_attr));

        // add search filter
        if ($search !== null) {
            // set wildcards
            $wp = $ws = '';
            if (!empty($this->prop['fuzzy_search']) && $mode != 1) {
                $ws = '*';
                $wp = !$mode ? '*' : '';
            }
            $filter = "(&$filter($name_attr=$wp" . rcube_ldap_generic::quote_string($search) . "$ws))";
            $props['search'] = $wp . $search . $ws;
        }

        $ldap_data = $ldap->search($base_dn, $filter, $scope, $attrs, $props);

        if ($ldap_data === false) {
            return array();
@@ -1708,7 +1742,7 @@

        // call recursively until we have fetched all groups
        while ($this->prop['groups']['vlv'] && $group_count == $page_size) {
            $next_page   = $this->_fetch_groups(++$vlv_page);
            $next_page   = $this->_fetch_groups($search, $mode, ++$vlv_page);
            $groups      = array_merge($groups, $next_page);
            $group_count = count($next_page);
        }
@@ -1719,8 +1753,11 @@
        }

        // cache this
        if ($this->cache) {
        if ($this->cache && $search === null) {
            $this->cache->set('groups', $groups);
        }
        else if ($search !== null) {
            $this->group_search_cache = $groups;
        }

        return $groups;
@@ -1790,7 +1827,7 @@
            $member_attr => '',
        );

        if (!$this->ldap->add($new_dn, $new_entry)) {
        if (!$this->ldap->add_entry($new_dn, $new_entry)) {
            $this->set_error(self::ERROR_SAVING, 'errorsaving');
            return false;
        }
@@ -1813,7 +1850,7 @@
        $group_cache = $this->_fetch_groups();
        $del_dn      = $group_cache[$group_id]['dn'];

        if (!$this->ldap->delete($del_dn)) {
        if (!$this->ldap->delete_entry($del_dn)) {
            $this->set_error(self::ERROR_SAVING, 'errorsaving');
            return false;
        }
@@ -1948,7 +1985,7 @@
        $filter = strtr("(|(member=$contact_dn)(uniqueMember=$contact_dn)$add_filter)", array('\\' => '\\\\'));

        $ldap_data = $this->ldap->search($base_dn, $filter, 'sub', array('dn', $name_attr));
        if ($res === false) {
        if ($ldap_data === false) {
            return array();
        }

@@ -1988,7 +2025,6 @@
        return $default;
    }


    /**
     * HTML-safe DN string encoding
     *
@@ -2015,5 +2051,4 @@
        $str = str_pad(strtr($str, '-_', '+/'), strlen($str) % 4, '=', STR_PAD_RIGHT);
        return base64_decode($str);
    }

}