/usr/share/php/Horde/Kolab/Server/Ldap.php is in php-horde-kolab-server 2.0.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | <?php
/**
* The driver for accessing objects stored in LDAP.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Server
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Server
*/
/**
* This class provides methods to deal with objects stored in
* a LDAP db.
*
* Copyright 2008-2013 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Server
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Server
*/
abstract class Horde_Kolab_Server_Ldap
implements Horde_Kolab_Server_Interface
{
/**
* The GUID of the current user.
*
* @var string|boolean
*/
private $_guid = false;
/**
* LDAP connection handle.
*
* @var Horde_Kolab_Server_Connection
*/
private $_conn;
/**
* Base DN of the LDAP server.
*
* @var string
*/
private $_base_dn;
/**
* Constructor.
*
* @param Horde_Kolab_Server_Connection $connection The LDAP connection.
* @param string $base_dn The LDAP server base DN.
* @param string $filter A global filter to add
* to all queries.
*/
public function __construct(
Horde_Kolab_Server_Connection_Interface $connection,
$base_dn
) {
$this->_conn = $connection;
$this->_base_dn = $base_dn;
try {
Horde_Ldap::checkLDAPExtension();
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
$e->getMessage(),
Horde_Kolab_Server_Exception::MISSING_LDAP_EXTENSION,
$e
);
}
}
/**
* Connect to the server.
*
* @param string $guid The global unique id of the user.
* @param string $pass The password.
*
* @return NULL.
*
* @throws Horde_Kolab_Server_Exception If the connection failed.
*/
public function connectGuid($guid = '', $pass = '')
{
/** Do we need to switch the user? */
if ($guid !== $this->_guid) {
try {
$this->_conn->getRead()->bind($guid, $pass);
} catch (Horde_Ldap_Exception $e) {
if ($e->getCode() == 49) {
throw new Horde_Kolab_Server_Exception_Bindfailed(
'Invalid username/password!',
Horde_Kolab_Server_Exception::BIND_FAILED,
$e
);
} else {
throw new Horde_Kolab_Server_Exception(
'Bind failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
}
$this->_guid = $guid;
}
}
/**
* Get the current GUID
*
* @return string The GUID of the connected user.
*/
public function getGuid()
{
return $this->_guid;
}
/**
* Get the base GUID of this server
*
* @return string The base GUID of this server.
*/
public function getBaseGuid()
{
return $this->_base_dn;
}
/**
* Low level access to reading object data.
*
* @param string $guid The object to retrieve.
*
* @return array An array of attributes.
*
* @throws Horde_Kolab_Server_Exception If the search operation hit an error
* or returned no result.
*/
public function read($guid)
{
$params = array('scope' => 'base');
$data = $this->_search(null, $params, $guid);
if ($data->count() == 0) {
throw new Horde_Kolab_Server_Exception(
'Empty result!',
Horde_Kolab_Server_Exception::EMPTY_RESULT
);
}
$result = $data->asArray();
return array_pop($result);
}
/**
* Low level access to reading some object attributes.
*
* @param string $guid The object to retrieve.
* @param string $attrs Restrict to these attributes.
*
* @return array An array of attributes.
*
* @throws Horde_Kolab_Server_Exception If the search operation hit an error
* or returned no result.
*/
public function readAttributes($guid, array $attrs)
{
$params = array(
'scope' => 'base',
'attributes' => $attrs
);
$data = $this->_search(null, $params, $guid);
if ($data->count() == 0) {
throw new Horde_Kolab_Server_Exception(
'Empty result!',
Horde_Kolab_Server_Exception::EMPTY_RESULT
);
}
$result = $data->asArray();
return array_pop($result);
}
/**
* Finds object data matching a given set of criteria.
*
* @param string $query The LDAP search query
* @param array $params Additional search parameters.
*
* @return Horde_Kolab_Server_Result The result object.
*
* @throws Horde_Kolab_Server_Exception
*/
public function find($query, array $params = array())
{
return $this->findBelow($query, $this->_base_dn, $params);
}
/**
* Modify existing object data.
*
* @param Horde_Kolab_Server_Object $object The object to be modified.
* @param array $data The attributes of the object
* to be stored.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function save(
Horde_Kolab_Server_Object_Interface $object,
array $data
) {
$changes = new Horde_Kolab_Server_Ldap_Changes($object, $data);
try {
$entry = $this->_conn->getWrite()->getEntry(
$object->getGuid(), array_keys($data)
);
$this->_conn->getWrite()->modify($entry, $changes->getChangeset());
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Saving failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
}
/**
* Add new object data.
*
* @param Horde_Kolab_Server_Object $object The object to be added.
* @param array $data The attributes of the object
* to be added.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function add(
Horde_Kolab_Server_Object_Interface $object,
array $data
) {
try {
$entry = Horde_Ldap_Entry::createFresh($object->getGuid(), $data);
$this->_conn->getWrite()->add($entry);
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Adding object failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
}
/**
* Delete an object.
*
* @param string $guid The UID of the object to be deleted.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function delete($guid)
{
try {
$this->_conn->getWrite()->delete($guid);
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Deleting object failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
}
/**
* Rename an object.
*
* @param string $guid The UID of the object to be renamed.
* @param string $new The new UID of the object.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function rename($guid, $new)
{
try {
$this->_conn->getWrite()->move($guid, $new);
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Renaming object failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
}
/**
* Return the ldap schema.
*
* @return Horde_Ldap_Schema The LDAP schema.
*
* @throws Horde_Kolab_Server_Exception If retrieval of the schema failed.
*/
public function getSchema()
{
try {
return $this->_conn->getRead()->schema();
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Retrieving the schema failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
}
/**
* Get the parent GUID of this object.
*
* @param string $guid The GUID of the child.
*
* @return string the parent GUID of this object.
*/
public function getParentGuid($guid)
{
try {
$base = Horde_Ldap_Util::explodeDN(
$guid,
array(
'casefold' => 'none',
'reverse' => false,
'onlyvalues' => false
)
);
$id = array_shift($base);
$parent = Horde_Ldap_Util::canonicalDN(
$base, array('casefold' => 'none')
);
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Retrieving the parent object failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
return $parent;
}
/**
* Search for object data.
*
* @param string $filter The LDAP search filter.
* @param array $params Additional search parameters.
* @param string $base The search base
*
* @return array The result array.
*
* @throws Horde_Kolab_Server_Exception If the search operation encountered
* a problem.
*/
protected function _search($filter, array $params, $base)
{
try {
$search = $this->_conn->getRead()->search($base, $filter, $params);
} catch (Horde_Ldap_Exception $e) {
throw new Horde_Kolab_Server_Exception(
'Search failed!',
Horde_Kolab_Server_Exception::SYSTEM,
$e
);
}
return new Horde_Kolab_Server_Result_Ldap($search);
}
}
|