/usr/share/php/Horde/Ldap/Filter.php is in php-horde-ldap 2.0.3-1.
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 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | <?php
/**
* Object representation of a part of a LDAP filter.
*
* The purpose of this class is to easily build LDAP filters without having to
* worry about correct escaping etc.
*
* A filter is built using several independent filter objects which are
* combined afterwards. This object works in two modes, depending how the
* object is created.
*
* If the object is created using the {@link create()} method, then this is a
* leaf-object. If the object is created using the {@link combine()} method,
* then this is a container object.
*
* LDAP filters are defined in RFC 2254.
*
* @see http://www.ietf.org/rfc/rfc2254.txt
*
* A short example:
* <code>
* $filter0 = Horde_Ldap_Filter::create('stars', 'equals', '***');
* $filter_not0 = Horde_Ldap_Filter::combine('not', $filter0);
*
* $filter1 = Horde_Ldap_Filter::create('gn', 'begins', 'bar');
* $filter2 = Horde_Ldap_Filter::create('gn', 'ends', 'baz');
* $filter_comp = Horde_Ldap_Filter::combine('or', array($filter_not0, $filter1, $filter2));
*
* echo (string)$filter_comp;
* // This will output: (|(!(stars=\0x5c0x2a\0x5c0x2a\0x5c0x2a))(gn=bar*)(gn=*baz))
* // The stars in $filter0 are treaten as real stars unless you disable escaping.
* </code>
*
* Copyright 2009 Benedikt Hallinger
* Copyright 2010-2013 Horde LLC (http://www.horde.org/)
*
* @category Horde
* @package Ldap
* @author Benedikt Hallinger <beni@php.net>
* @author Jan Schneider <jan@horde.org>
* @license http://www.gnu.org/licenses/lgpl-3.0.html LGPL-3.0
*/
class Horde_Ldap_Filter
{
/**
* Storage for combination of filters.
*
* This variable holds a array of filter objects that should be combined by
* this filter object.
*
* @var array
*/
protected $_filters = array();
/**
* Operator for sub-filters.
*
* @var string
*/
protected $_operator;
/**
* Single filter.
*
* If this is a leaf filter, the filter representation is store here.
*
* @var string
*/
protected $_filter;
/**
* Constructor.
*
* Construction of Horde_Ldap_Filter objects should happen through either
* {@link create()} or {@link combine()} which give you more control.
* However, you may use the constructor if you already have generated
* filters.
*
* @param array $params List of object parameters
*/
protected function __construct(array $params)
{
foreach ($params as $param => $value) {
if (in_array($param, array('filter', 'filters', 'operator'))) {
$this->{'_' . $param} = $value;
}
}
}
/**
* Creates a new part of an LDAP filter.
*
* The following matching rules exists:
* - equals: One of the attributes values is exactly $value.
* Please note that case sensitiviness depends on the
* attributes syntax configured in the server.
* - begins: One of the attributes values must begin with $value.
* - ends: One of the attributes values must end with $value.
* - contains: One of the attributes values must contain $value.
* - present | any: The attribute can contain any value but must exist.
* - greater: The attributes value is greater than $value.
* - less: The attributes value is less than $value.
* - greaterOrEqual: The attributes value is greater or equal than $value.
* - lessOrEqual: The attributes value is less or equal than $value.
* - approx: One of the attributes values is similar to $value.
*
* If $escape is set to true then $value will be escaped. If set to false
* then $value will be treaten as a raw filter value string. You should
* then escape it yourself using {@link
* Horde_Ldap_Util::escapeFilterValue()}.
*
* Examples:
* <code>
* // This will find entries that contain an attribute "sn" that ends with
* // "foobar":
* $filter = Horde_Ldap_Filter::create('sn', 'ends', 'foobar');
*
* // This will find entries that contain an attribute "sn" that has any
* // value set:
* $filter = Horde_Ldap_Filter::create('sn', 'any');
* </code>
*
* @param string $attribute Name of the attribute the filter should apply
* to.
* @param string $match Matching rule (equals, begins, ends, contains,
* greater, less, greaterOrEqual, lessOrEqual,
* approx, any).
* @param string $value If given, then this is used as a filter value.
* @param boolean $escape Should $value be escaped?
*
* @return Horde_Ldap_Filter
* @throws Horde_Ldap_Exception
*/
public static function create($attribute, $match, $value = '',
$escape = true)
{
if ($escape) {
$array = Horde_Ldap_Util::escapeFilterValue(array($value));
$value = $array[0];
}
switch (Horde_String::lower($match)) {
case 'equals':
case '=':
$filter = '(' . $attribute . '=' . $value . ')';
break;
case 'begins':
$filter = '(' . $attribute . '=' . $value . '*)';
break;
case 'ends':
$filter = '(' . $attribute . '=*' . $value . ')';
break;
case 'contains':
$filter = '(' . $attribute . '=*' . $value . '*)';
break;
case 'greater':
case '>':
$filter = '(' . $attribute . '>' . $value . ')';
break;
case 'less':
case '>':
$filter = '(' . $attribute . '<' . $value . ')';
break;
case 'greaterorequal':
case '>=':
$filter = '(' . $attribute . '>=' . $value . ')';
break;
case 'lessorequal':
case '<=':
$filter = '(' . $attribute . '<=' . $value . ')';
break;
case 'approx':
case '~=':
$filter = '(' . $attribute . '~=' . $value . ')';
break;
case 'any':
case 'present':
$filter = '(' . $attribute . '=*)';
break;
default:
throw new Horde_Ldap_Exception('Matching rule "' . $match . '" unknown');
}
return new Horde_Ldap_Filter(array('filter' => $filter));
}
/**
* Combines two or more filter objects using a logical operator.
*
* Example:
* <code>
* $filter = Horde_Ldap_Filter::combine('or', array($filter1, $filter2));
* </code>
*
* If the array contains filter strings instead of filter objects, they
* will be parsed.
*
* @param string $operator
* The logical operator, either "and", "or", "not" or the logical
* equivalents "&", "|", "!".
* @param array|Horde_Ldap_Filter|string $filters
* Array with Horde_Ldap_Filter objects and/or strings or a single
* filter when using the "not" operator.
*
* @return Horde_Ldap_Filter
* @throws Horde_Ldap_Exception
*/
public static function combine($operator, $filters)
{
// Substitute named operators with logical operators.
switch ($operator) {
case 'and':
$operator = '&';
break;
case 'or':
$operator = '|';
break;
case 'not':
$operator = '!';
break;
}
// Tests for sane operation.
switch ($operator) {
case '!':
// Not-combination, here we only accept one filter object or filter
// string.
if ($filters instanceof Horde_Ldap_Filter) {
$filters = array($filters); // force array
} elseif (is_string($filters)) {
$filters = array(self::parse($filters));
} elseif (is_array($filters)) {
throw new Horde_Ldap_Exception('Operator is "not" but $filter is an array');
} else {
throw new Horde_Ldap_Exception('Operator is "not" but $filter is not a valid Horde_Ldap_Filter nor a filter string');
}
break;
case '&':
case '|':
if (!is_array($filters) || count($filters) < 2) {
throw new Horde_Ldap_Exception('Parameter $filters is not an array or contains less than two Horde_Ldap_Filter objects');
}
break;
default:
throw new Horde_Ldap_Exception('Logical operator is unknown');
}
foreach ($filters as $key => $testfilter) {
// Check for errors.
if (is_string($testfilter)) {
// String found, try to parse into an filter object.
$filters[$key] = self::parse($testfilter);
} elseif (!($testfilter instanceof Horde_Ldap_Filter)) {
throw new Horde_Ldap_Exception('Invalid object passed in array $filters!');
}
}
return new Horde_Ldap_Filter(array('filters' => $filters,
'operator' => $operator));
}
/**
* Builds a filter (commonly for objectClass attributes) from different
* configuration options.
*
* @param array $params Hash with configuration options that build the
* search filter. Possible hash keys:
* - 'filter': An LDAP filter string.
* - 'objectclass' (string): An objectClass name.
* - 'objectclass' (array): A list of objectClass
* names.
* @param string $operator How to combine mutliple 'objectclass' entries.
* 'and' or 'or'.
*
* @return Horde_Ldap_Filter A filter matching the specified criteria.
* @throws Horde_Ldap_Exception
*/
public static function build(array $params, $operator = 'and')
{
if (!empty($params['filter'])) {
return self::parse($params['filter']);
}
if (!is_array($params['objectclass'])) {
return self::create('objectclass', 'equals', $params['objectclass']);
}
$filters = array();
foreach ($params['objectclass'] as $objectclass) {
$filters[] = self::create('objectclass', 'equals', $objectclass);
}
if (count($filters) == 1) {
return $filters[0];
}
return self::combine($operator, $filters);
}
/**
* Parses a string into a Horde_Ldap_Filter object.
*
* @todo Leaf-mode: Do we need to escape at all? what about *-chars? Check
* for the need of encoding values, tackle problems (see code comments).
*
* @param string $filter An LDAP filter string.
*
* @return Horde_Ldap_Filter
* @throws Horde_Ldap_Exception
*/
public static function parse($filter)
{
if (!preg_match('/^\((.+?)\)$/', $filter, $matches)) {
throw new Horde_Ldap_Exception('Invalid filter syntax, filter components must be enclosed in round brackets');
}
if (in_array(substr($matches[1], 0, 1), array('!', '|', '&'))) {
return self::_parseCombination($matches[1]);
} else {
return self::_parseLeaf($matches[1]);
}
}
/**
* Parses combined subfilter strings.
*
* Passes subfilters to parse() and combines the objects using the logical
* operator detected. Each subfilter could be an arbitary complex
* subfilter.
*
* @param string $filter An LDAP filter string.
*
* @return Horde_Ldap_Filter
* @throws Horde_Ldap_Exception
*/
protected static function _parseCombination($filter)
{
// Extract logical operator and filter arguments.
$operator = substr($filter, 0, 1);
$filter = substr($filter, 1);
// Split $filter into individual subfilters. We cannot use split() for
// this, because we do not know the complexiness of the
// subfilter. Thus, we look trough the filter string and just recognize
// ending filters at the first level. We record the index number of the
// char and use that information later to split the string.
$sub_index_pos = array();
// Previous character looked at.
$prev_char = '';
// Denotes the current bracket level we are, >1 is too deep, 1 is ok, 0
// is outside any subcomponent.
$level = 0;
for ($curpos = 0, $len = strlen($filter); $curpos < $len; $curpos++) {
$cur_char = $filter{$curpos};
// Rise/lower bracket level.
if ($cur_char == '(' && $prev_char != '\\') {
$level++;
} elseif ($cur_char == ')' && $prev_char != '\\') {
$level--;
}
if ($cur_char == '(' && $prev_char == ')' && $level == 1) {
// Mark the position for splitting.
$sub_index_pos[] = $curpos;
}
$prev_char = $cur_char;
}
// Now perform the splits. To get the last part too, we need to add the
// "END" index to the split array.
$sub_index_pos[] = strlen($filter);
$subfilters = array();
$oldpos = 0;
foreach ($sub_index_pos as $s_pos) {
$str_part = substr($filter, $oldpos, $s_pos - $oldpos);
$subfilters[] = $str_part;
$oldpos = $s_pos;
}
if (count($subfilters) > 1) {
// Several subfilters found.
if ($operator == '!') {
throw new Horde_Ldap_Exception('Invalid filter syntax: NOT operator detected but several arguments given');
}
} elseif (!count($subfilters)) {
// This should not happen unless the user specified a wrong filter.
throw new Horde_Ldap_Exception('Invalid filter syntax: got operator ' . $operator . ' but no argument');
}
// Now parse the subfilters into objects and combine them using the
// operator.
$subfilters_o = array();
foreach ($subfilters as $s_s) {
$subfilters_o[] = self::parse($s_s);
}
if (count($subfilters_o) == 1) {
$subfilters_o = $subfilters_o[0];
}
return self::combine($operator, $subfilters_o);
}
/**
* Parses a single leaf component.
*
* @param string $filter An LDAP filter string.
*
* @return Horde_Ldap_Filter
* @throws Horde_Ldap_Exception
*/
protected static function _parseLeaf($filter)
{
// Detect multiple leaf components.
// [TODO] Maybe this will make problems with filters containing
// brackets inside the value.
if (strpos($filter, ')(')) {
throw new Horde_Ldap_Exception('Invalid filter syntax: multiple leaf components detected');
}
$filter_parts = preg_split('/(?<!\\\\)(=|=~|>|<|>=|<=)/', $filter, 2, PREG_SPLIT_DELIM_CAPTURE);
if (count($filter_parts) != 3) {
throw new Horde_Ldap_Exception('Invalid filter syntax: unknown matching rule used');
}
// [TODO]: Do we need to escape at all? what about *-chars user provide
// and that should remain special? I think, those prevent
// escaping! We need to check against PERL Net::LDAP!
// $value_arr = Horde_Ldap_Util::escapeFilterValue(array($filter_parts[2]));
// $value = $value_arr[0];
return new Horde_Ldap_Filter(array('filter' => '(' . $filter_parts[0] . $filter_parts[1] . $filter_parts[2] . ')'));
}
/**
* Returns the string representation of this filter.
*
* This method runs through all filter objects and creates the string
* representation of the filter.
*
* @return string
*/
public function __toString()
{
if (!count($this->_filters)) {
return $this->_filter;
}
$return = '';
foreach ($this->_filters as $filter) {
$return .= (string)$filter;
}
return '(' . $this->_operator . $return . ')';
}
}
|