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 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
|
<?php
/**
* Classes and functions for fetching and parsing schema from an LDAP server.
*
* @author The phpLDAPadmin development team
* @package phpLDAPadmin
*/
/**
* Generic parent class for all schema items. A schema item is
* an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
* All schema items have at least two things in common: An OID
* and a description. This class provides an implementation for
* these two data.
*
* @package phpLDAPadmin
* @subpackage Schema
*/
abstract class SchemaItem {
# The schema item's name.
protected $name = '';
# The OID of this schema item.
private $oid = null;
# The description of this schema item.
protected $description = '';
# Boolean value indicating whether this objectClass is obsolete
protected $is_obsolete = false;
public function setOID($oid) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->oid = $oid;
}
public function setDescription($desc) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->description = $desc;
}
public function getOID() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->oid);
return $this->oid;
}
public function getDescription() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->description);
return $this->description;
}
/**
* Gets whether this objectClass is flagged as obsolete by the LDAP server.
*/
public function getIsObsolete() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->is_obsolete);
return $this->is_obsolete;
}
/**
* Return the objects name.
*
* param boolean $lower Return the name in lower case (default)
* @return string The name
*/
public function getName($lower=true) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->name);
return $lower ? strtolower($this->name) : $this->name;
}
}
/**
* Represents an LDAP objectClass
*
* @package phpLDAPadmin
* @subpackage Schema
*/
class ObjectClass extends SchemaItem {
# The server ID that this objectclass belongs to.
private $server_id = null;
# Array of objectClass names from which this objectClass inherits
private $sup_classes = array();
# One of STRUCTURAL, ABSTRACT, or AUXILIARY
private $type;
# Arrays of attribute names that this objectClass requires
private $must_attrs = array();
# Arrays of attribute names that this objectClass allows, but does not require
private $may_attrs = array();
# Arrays of attribute names that this objectClass has been forced to MAY attrs, due to configuration
private $force_may = array();
# Array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
private $children_objectclasses = array();
# The objectclass hierarchy
private $hierarchy = array();
/**
* Creates a new ObjectClass object given a raw LDAP objectClass string.
*/
public function __construct($class,$server) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$this->server_id = $server->getIndex();
$this->type = $server->getValue('server','schema_oclass_default');
$strings = preg_split('/[\s,]+/',$class,-1,PREG_SPLIT_DELIM_CAPTURE);
$str_count = count($strings);
for ($i=0; $i < $str_count; $i++) {
switch ($strings[$i]) {
case '(':
break;
case 'NAME':
if ($strings[$i+1]!='(') {
do {
$i++;
if (strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match('/\'$/s',$strings[$i]));
} else {
$i++;
do {
$i++;
if (strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match('/\'$/s',$strings[$i]));
do {
$i++;
} while (! preg_match('/\)+\)?/',$strings[$i]));
}
$this->name = preg_replace('/^\'/','',$this->name);
$this->name = preg_replace('/\'$/','',$this->name);
if (DEBUG_ENABLED)
debug_log('Case NAME returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->name);
break;
case 'DESC':
do {
$i++;
if (strlen($this->description) == 0)
$this->description=$this->description.$strings[$i];
else
$this->description=$this->description.' '.$strings[$i];
} while (! preg_match('/\'$/s',$strings[$i]));
if (DEBUG_ENABLED)
debug_log('Case DESC returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->description);
break;
case 'OBSOLETE':
$this->is_obsolete = TRUE;
if (DEBUG_ENABLED)
debug_log('Case OBSOLETE returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->is_obsolete);
break;
case 'SUP':
if ($strings[$i+1] != '(') {
$i++;
array_push($this->sup_classes,preg_replace("/'/",'',$strings[$i]));
} else {
$i++;
do {
$i++;
if ($strings[$i] != '$')
array_push($this->sup_classes,preg_replace("/'/",'',$strings[$i]));
} while (! preg_match('/\)+\)?/',$strings[$i+1]));
}
if (DEBUG_ENABLED)
debug_log('Case SUP returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->sup_classes);
break;
case 'ABSTRACT':
$this->type = 'abstract';
if (DEBUG_ENABLED)
debug_log('Case ABSTRACT returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->type);
break;
case 'STRUCTURAL':
$this->type = 'structural';
if (DEBUG_ENABLED)
debug_log('Case STRUCTURAL returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->type);
break;
case 'AUXILIARY':
$this->type = 'auxiliary';
if (DEBUG_ENABLED)
debug_log('Case AUXILIARY returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->type);
break;
case 'MUST':
$attrs = array();
$i = $this->parseList(++$i,$strings,$attrs);
if (DEBUG_ENABLED)
debug_log('parseList returned %d (%s)',8,0,__FILE__,__LINE__,__METHOD__,$i,$attrs);
foreach ($attrs as $string) {
$attr = new ObjectClass_ObjectClassAttribute($string,$this->name);
if ($server->isForceMay($attr->getName())) {
array_push($this->force_may,$attr);
array_push($this->may_attrs,$attr);
} else
array_push($this->must_attrs,$attr);
}
if (DEBUG_ENABLED)
debug_log('Case MUST returned (%s) (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->must_attrs,$this->force_may);
break;
case 'MAY':
$attrs = array();
$i = $this->parseList(++$i,$strings,$attrs);
if (DEBUG_ENABLED)
debug_log('parseList returned %d (%s)',8,0,__FILE__,__LINE__,__METHOD__,$i,$attrs);
foreach ($attrs as $string) {
$attr = new ObjectClass_ObjectClassAttribute($string,$this->name);
array_push($this->may_attrs,$attr);
}
if (DEBUG_ENABLED)
debug_log('Case MAY returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->may_attrs);
break;
default:
if (preg_match('/[\d\.]+/i',$strings[$i]) && $i == 1) {
$this->setOID($strings[$i]);
if (DEBUG_ENABLED)
debug_log('Case default returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->getOID());
}
break;
}
}
$this->description = preg_replace("/^\'/",'',$this->description);
$this->description = preg_replace("/\'$/",'',$this->description);
if (DEBUG_ENABLED)
debug_log('Returning () - NAME (%s), DESCRIPTION (%s), MUST (%s), MAY (%s), FORCE MAY (%s)',9,0,__FILE__,__LINE__,__METHOD__,
$this->name,$this->description,$this->must_attrs,$this->may_attrs,$this->force_may);
}
/**
* Parse an LDAP schema list
*/
private function parseList($i,$strings,&$attrs) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
/*
* A list starts with a ( followed by a list of attributes separated by $ terminated by )
* The first token can therefore be a ( or a (NAME or a (NAME)
* The last token can therefore be a ) or NAME)
* The last token may be terminate by more than one bracket
*/
$string = $strings[$i];
if (! preg_match('/^\(/',$string)) {
# A bareword only - can be terminated by a ) if the last item
if (preg_match('/\)+$/',$string))
$string = preg_replace('/\)+$/','',$string);
array_push($attrs,$string);
} elseif (preg_match('/^\(.*\)$/',$string)) {
$string = preg_replace('/^\(/','',$string);
$string = preg_replace('/\)+$/','',$string);
array_push($attrs,$string);
} else {
# Handle the opening cases first
if ($string == '(') {
$i++;
} elseif (preg_match('/^\(./',$string)) {
$string = preg_replace('/^\(/','',$string);
array_push($attrs,$string);
$i++;
}
# Token is either a name, a $ or a ')'
# NAME can be terminated by one or more ')'
while (! preg_match('/\)+$/',$strings[$i])) {
$string = $strings[$i];
if ($string == '$') {
$i++;
continue;
}
if (preg_match('/\)$/',$string))
$string = preg_replace('/\)+$/','',$string);
else
$i++;
array_push($attrs,$string);
}
}
sort($attrs);
if (DEBUG_ENABLED)
debug_log('Returning (%d,[%s],[%s])',9,0,__FILE__,__LINE__,__METHOD__,$i,$strings,$attrs);
return $i;
}
/**
* This will return all our parent ObjectClass Objects
*/
public function getParents() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
if ((count($this->sup_classes) == 1) && ($this->sup_classes[0] == 'top'))
return array();
$server = $_SESSION[APPCONFIG]->getServer($this->server_id);
$return = array();
foreach ($this->sup_classes as $object_class) {
array_push($return,$object_class);
$oc = $server->getSchemaObjectClass($object_class);
if ($oc)
$return = array_merge($return,$oc->getParents());
}
return $return;
}
/**
* Gets an array of AttributeType objects that entries of this ObjectClass must define.
* This differs from getMustAttrNames in that it returns an array of AttributeType objects
*
* @param array $parents An array of ObjectClass objects to use when traversing
* the inheritance tree. This presents some what of a bootstrapping problem
* as we must fetch all objectClasses to determine through inheritance which
* attributes this objectClass requires.
* @return array The array of required AttributeType objects.
*
* @see getMustAttrNames
* @see getMayAttrs
* @see getMayAttrNames
*/
public function getMustAttrs($parents=false) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (! $parents)
return $this->must_attrs;
$server = $_SESSION[APPCONFIG]->getServer($this->server_id);
$attrs = $this->must_attrs;
foreach ($this->getParents() as $sup_class) {
$sc = $server->getSchemaObjectClass($sup_class);
$attrs = array_merge($attrs,$sc->getMustAttrs());
}
masort($attrs,'name,source');
# Remove any duplicates
foreach ($attrs as $index => $attr)
if (isset($allattr[$attr->getName()]))
unset($attrs[$index]);
else
$allattr[$attr->getName()] = 1;
return $attrs;
}
/**
* Gets an array of AttributeType objects that entries of this ObjectClass may define.
* This differs from getMayAttrNames in that it returns an array of AttributeType objects
*
* @param array $parents An array of ObjectClass objects to use when traversing
* the inheritance tree. This presents some what of a bootstrapping problem
* as we must fetch all objectClasses to determine through inheritance which
* attributes this objectClass provides.
* @return array The array of allowed AttributeType objects.
*
* @see getMustAttrNames
* @see getMustAttrs
* @see getMayAttrNames
* @see AttributeType
*/
public function getMayAttrs($parents=false) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (! $parents)
return $this->may_attrs;
$server = $_SESSION[APPCONFIG]->getServer($this->server_id);
$attrs = $this->may_attrs;
foreach ($this->getParents() as $sup_class) {
$sc = $server->getSchemaObjectClass($sup_class);
$attrs = array_merge($attrs,$sc->getMayAttrs());
}
masort($attrs,'name,source');
# Remove any duplicates
foreach ($attrs as $index => $attr)
if (isset($allattr[$attr->name]))
unset($attrs[$index]);
else
$allattr[$attr->name] = 1;
return $attrs;
}
public function getForceMayAttrs() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
return $this->force_may;
}
/**
* Gets an array of attribute names (strings) that entries of this ObjectClass must define.
* This differs from getMustAttrs in that it returns an array of strings rather than
* array of AttributeType objects
*
* @param array $parents An array of ObjectClass objects to use when traversing
* the inheritance tree. This presents some what of a bootstrapping problem
* as we must fetch all objectClasses to determine through inheritance which
* attributes this objectClass provides.
* @return array The array of allowed attribute names (strings).
*
* @see getMustAttrs
* @see getMayAttrs
* @see getMayAttrNames
*/
public function getMustAttrNames($parents=false) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$attr_names = array();
foreach ($this->getMustAttrs($parents) as $attr)
array_push($attr_names,$attr->getName());
return $attr_names;
}
/**
* Gets an array of attribute names (strings) that entries of this ObjectClass must define.
* This differs from getMayAttrs in that it returns an array of strings rather than
* array of AttributeType objects
*
* @param array $parents An array of ObjectClass objects to use when traversing
* the inheritance tree. This presents some what of a bootstrapping problem
* as we must fetch all objectClasses to determine through inheritance which
* attributes this objectClass provides.
* @return array The array of allowed attribute names (strings).
*
* @see getMustAttrs
* @see getMayAttrs
* @see getMustAttrNames
*/
public function getMayAttrNames($parents=false) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$attr_names = array();
foreach ($this->getMayAttrs($parents) as $attr)
array_push($attr_names,$attr->getName());
return $attr_names;
}
/**
* Adds an objectClass to the list of objectClasses that inherit
* from this objectClass.
*
* @param String $name The name of the objectClass to add
* @return boolean Returns true on success or false on failure (objectclass already existed for example)
*/
public function addChildObjectClass($name) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$name = trim($name);
foreach ($this->children_objectclasses as $existing_objectclass)
if (strcasecmp($name,$existing_objectclass) == 0)
return false;
array_push($this->children_objectclasses,$name);
}
/**
* Returns the array of objectClass names which inherit from this objectClass.
*
* @return Array Names of objectClasses which inherit from this objectClass.
*/
public function getChildObjectClasses() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
return $this->children_objectclasses;
}
/**
* Gets the objectClass names from which this objectClass inherits.
*
* @return array An array of objectClass names (strings)
*/
public function getSupClasses() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
return $this->sup_classes;
}
/**
* Return if this objectClass is related to $oclass
*
* @param array ObjectClasses that this attribute may be related to
*/
public function isRelated($oclass) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
# If I am in the array, we'll just return false
if (in_array_ignore_case($this->name,$oclass))
return false;
$server = $_SESSION[APPCONFIG]->getServer($this->server_id);
foreach ($oclass as $object_class) {
$oc = $server->getSchemaObjectClass($object_class);
if ($oc->isStructural() && in_array_ignore_case($this->getName(),$oc->getParents()))
return true;
}
return false;
}
/**
* Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.
*/
public function getType() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->type);
return $this->type;
}
/**
* Adds the specified array of attributes to this objectClass' list of
* MUST attributes. The resulting array of must attributes will contain
* unique members.
*
* @param array $attr An array of attribute names (strings) to add.
*/
private function addMustAttrs($attr) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (! is_array($attr) || ! count($attr))
return;
$this->must_attrs = array_values(array_unique(array_merge($this->must_attrs,$attr)));
}
/**
* Behaves identically to addMustAttrs, but it operates on the MAY
* attributes of this objectClass.
*
* @param array $attr An array of attribute names (strings) to add.
*/
private function addMayAttrs($attr) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (! is_array($attr) || ! count($attr))
return;
$this->may_attrs = array_values(array_unique(array_merge($this->may_attrs,$attr)));
}
/**
* Determine if an array is listed in the force_may attrs
*/
public function isForceMay($attr) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
foreach ($this->force_may as $forcemay)
if ($forcemay->getName() == $attr)
return true;
return false;
}
public function isStructural() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
if ($this->type == 'structural')
return true;
else
return false;
}
}
/**
* A simple class for representing AttributeTypes used only by the ObjectClass class.
* Users should never instantiate this class. It represents an attribute internal to
* an ObjectClass. If PHP supported inner-classes and variable permissions, this would
* be interior to class ObjectClass and flagged private. The reason this class is used
* and not the "real" class AttributeType is because this class supports the notion of
* a "source" objectClass, meaning that it keeps track of which objectClass originally
* specified it. This class is therefore used by the class ObjectClass to determine
* inheritance.
*
* @package phpLDAPadmin
* @subpackage Schema
*/
class ObjectClass_ObjectClassAttribute {
# This Attribute's name (needs to be public, as we sort on it with masort).
public $name;
# This Attribute's root (needs to be public, as we sort on it with masort).
public $source;
/**
* Creates a new ObjectClass_ObjectClassAttribute with specified name and source objectClass.
*
* @param string $name the name of the new attribute.
* @param string $source the name of the ObjectClass which specifies this attribute.
*/
public function __construct($name,$source) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$this->name = $name;
$this->source = $source;
}
# Gets this attribute's name
public function getName($lower=true) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->name);
return $lower ? strtolower($this->name) : $this->name;
}
# Gets the name of the ObjectClass which originally specified this attribute.
public function getSource() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->source);
return $this->source;
}
}
/**
* Represents an LDAP AttributeType
*
* @package phpLDAPadmin
* @subpackage Schema
*/
class AttributeType extends SchemaItem {
# The attribute from which this attribute inherits (if any)
private $sup_attribute = '';
# The equality rule used
private $equality = null;
# The ordering of the attributeType
private $ordering = null;
# Boolean: supports substring matching?
private $sub_str = null;
# The full syntax string, ie 1.2.3.4{16}
private $syntax = '';
private $syntax_oid = '';
# boolean: is single valued only?
private $is_single_value = false;
# boolean: is collective?
private $is_collective = false;
# boolean: can use modify?
private $is_no_user_modification = false;
# The usage string set by the LDAP schema
private $usage = null;
# An array of alias attribute names, strings
private $aliases = array();
# The max number of characters this attribute can be
private $max_length = null;
# A string description of the syntax type (taken from the LDAPSyntaxes)
private $type = '';
# An array of objectClasses which use this attributeType (must be set by caller)
private $used_in_object_classes = array();
# A list of object class names that require this attribute type.
private $required_by_object_classes = array();
# This attribute has been forced a MAY attribute by the configuration.
private $forced_as_may = false;
/**
* Creates a new AttributeType object from a raw LDAP AttributeType string.
*/
public function __construct($attr) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$strings = preg_split('/[\s,]+/',$attr,-1,PREG_SPLIT_DELIM_CAPTURE);
for($i=0; $i<count($strings); $i++) {
switch($strings[$i]) {
case '(':
break;
case 'NAME':
# Some schema's return a (' instead of a ( '
if ($strings[$i+1] != '(' && ! preg_match('/^\(/',$strings[$i+1])) {
do {
$i++;
if (strlen($this->name)==0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
# This attribute has no aliases
$this->aliases = array();
} else {
$i++;
do {
# In case we came here becaues of a ('
if (preg_match('/^\(/',$strings[$i]))
$strings[$i] = preg_replace('/^\(/','',$strings[$i]);
else
$i++;
if (strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
# Add alias names for this attribute
while ($strings[++$i] != ')') {
$alias = $strings[$i];
$alias = preg_replace("/^\'/",'',$alias);
$alias = preg_replace("/\'$/",'',$alias);
$this->addAlias($alias);
}
}
if (DEBUG_ENABLED)
debug_log('Case NAME returned (%s) (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->name,$this->aliases);
break;
case 'DESC':
do {
$i++;
if (strlen($this->description)==0)
$this->description=$this->description.$strings[$i];
else
$this->description=$this->description.' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
if (DEBUG_ENABLED)
debug_log('Case DESC returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->description);
break;
case 'OBSOLETE':
$this->is_obsolete = TRUE;
if (DEBUG_ENABLED)
debug_log('Case OBSOLETE returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->is_obsolete);
break;
case 'SUP':
$i++;
$this->sup_attribute = $strings[$i];
if (DEBUG_ENABLED)
debug_log('Case SUP returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->sup_attribute);
break;
case 'EQUALITY':
$i++;
$this->equality = $strings[$i];
if (DEBUG_ENABLED)
debug_log('Case EQUALITY returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->equality);
break;
case 'ORDERING':
$i++;
$this->ordering = $strings[$i];
if (DEBUG_ENABLED)
debug_log('Case ORDERING returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->ordering);
break;
case 'SUBSTR':
$i++;
$this->sub_str = $strings[$i];
if (DEBUG_ENABLED)
debug_log('Case SUBSTR returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->sub_str);
break;
case 'SYNTAX':
$i++;
$this->syntax = $strings[$i];
$this->syntax_oid = preg_replace('/{\d+}$/','',$this->syntax);
# Does this SYNTAX string specify a max length (ie, 1.2.3.4{16})
if (preg_match('/{(\d+)}$/',$this->syntax,$this->max_length))
$this->max_length = $this->max_length[1];
else
$this->max_length = null;
if ($i < count($strings) - 1 && $strings[$i+1] == '{') {
do {
$i++;
$this->name .= ' '.$strings[$i];
} while ($strings[$i] != '}');
}
if (DEBUG_ENABLED)
debug_log('Case SYNTAX returned (%s) (%s) (%s)',8,0,__FILE__,__LINE__,__METHOD__,
$this->syntax,$this->syntax_oid,$this->max_length);
break;
case 'SINGLE-VALUE':
$this->is_single_value = TRUE;
if (DEBUG_ENABLED)
debug_log('Case SINGLE-VALUE returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->is_single_value);
break;
case 'COLLECTIVE':
$this->is_collective = TRUE;
if (DEBUG_ENABLED)
debug_log('Case COLLECTIVE returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->is_collective);
break;
case 'NO-USER-MODIFICATION':
$this->is_no_user_modification = TRUE;
if (DEBUG_ENABLED)
debug_log('Case NO-USER-MODIFICATION returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->is_no_user_modification);
break;
case 'USAGE':
$i++;
$this->usage = $strings[$i];
if (DEBUG_ENABLED)
debug_log('Case USAGE returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->usage);
break;
default:
if (preg_match('/[\d\.]+/i',$strings[$i]) && $i == 1) {
$this->setOID($strings[$i]);
if (DEBUG_ENABLED)
debug_log('Case default returned (%s)',8,0,__FILE__,__LINE__,__METHOD__,$this->getOID());
}
}
}
$this->name = preg_replace("/^\'/",'',$this->name);
$this->name = preg_replace("/\'$/",'',$this->name);
$this->description = preg_replace("/^\'/",'',$this->description);
$this->description = preg_replace("/\'$/",'',$this->description);
$this->syntax = preg_replace("/^\'/",'',$this->syntax);
$this->syntax = preg_replace("/\'$/",'',$this->syntax);
$this->syntax_oid = preg_replace("/^\'/",'',$this->syntax_oid);
$this->syntax_oid = preg_replace("/\'$/",'',$this->syntax_oid);
$this->sup_attribute = preg_replace("/^\'/",'',$this->sup_attribute);
$this->sup_attribute = preg_replace("/\'$/",'',$this->sup_attribute);
if (DEBUG_ENABLED)
debug_log('Returning ()',9,0,__FILE__,__LINE__,__METHOD__);
}
/**
* Gets this attribute's usage string as defined by the LDAP server
*
* @return string
*/
public function getUsage() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->usage);
return $this->usage;
}
/**
* Gets this attribute's parent attribute (if any). If this attribute does not
* inherit from another attribute, null is returned.
*
* @return string
*/
public function getSupAttribute() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->sup_attribute);
return $this->sup_attribute;
}
/**
* Gets this attribute's equality string
*
* @return string
*/
public function getEquality() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->equality);
return $this->equality;
}
/**
* Gets this attribute's ordering specification.
*
* @return string
*/
public function getOrdering() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->ordering);
return $this->ordering;
}
/**
* Gets this attribute's substring matching specification
*
* @return string
*/
public function getSubstr() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->sub_str);
return $this->sub_str;
}
/**
* Gets the names of attributes that are an alias for this attribute (if any).
*
* @return array An array of names of attributes which alias this attribute or
* an empty array if no attribute aliases this object.
*/
public function getAliases() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->aliases);
return $this->aliases;
}
/**
* Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).
*
* @param string $attr_name The name of the attribute to check.
* @return boolean True if the specified attribute is an alias for this one, or false otherwise.
*/
public function isAliasFor($attr_name) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
foreach ($this->aliases as $alias_attr_name)
if (strcasecmp($alias_attr_name,$attr_name) == 0)
return true;
return false;
}
/**
* Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").
*
* @return string The raw syntax string
*/
public function getSyntaxString() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->syntax);
return $this->syntax;
}
/**
* Gets this attribute's syntax OID. Differs from getSyntaxString() in that this
* function only returns the actual OID with any length specification removed.
* Ie, if the syntax string is "1.2.3.4{16}", this function only retruns
* "1.2.3.4".
*
* @return string The syntax OID string.
*/
public function getSyntaxOID() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->syntax_oid);
return $this->syntax_oid;
}
/**
* Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
*
* @return int The maximum length (in characters) of this attribute or null if no maximum is specified.
*/
public function getMaxLength() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->max_length);
return $this->max_length;
}
/**
* Gets whether this attribute is single-valued. If this attribute only supports single values, true
* is returned. If this attribute supports multiple values, false is returned.
*
* @return boolean Returns true if this attribute is single-valued or false otherwise.
*/
public function getIsSingleValue() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->is_single_value);
return $this->is_single_value;
}
/**
* Sets whether this attribute is single-valued.
*
* @param boolean $is
*/
public function setIsSingleValue($is) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->is_single_value = $is;
}
/**
* Gets whether this attribute is collective.
*
* @return boolean Returns true if this attribute is collective and false otherwise.
*/
public function getIsCollective() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->is_collective);
return $this->is_collective;
}
/**
* Gets whether this attribute is not modifiable by users.
*
* @return boolean Returns true if this attribute is not modifiable by users.
*/
public function getIsNoUserModification() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->is_no_user_modification);
return $this->is_no_user_modification;
}
/**
* Gets this attribute's type
*
* @return string The attribute's type.
*/
public function getType() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->type);
return $this->type;
}
/**
* Removes an attribute name from this attribute's alias array.
*
* @param string $remove_alias_name The name of the attribute to remove.
* @return boolean true on success or false on failure (ie, if the specified
* attribute name is not found in this attribute's list of aliases)
*/
public function removeAlias($remove_alias_name) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
foreach ($this->aliases as $i => $alias_name) {
if (strcasecmp($alias_name,$remove_alias_name) == 0) {
unset($this->aliases[$i]);
$this->aliases = array_values($this->aliases);
return true;
}
}
return false;
}
/**
* Adds an attribute name to the alias array.
*
* @param string $alias The name of a new attribute to add to this attribute's list of aliases.
*/
public function addAlias($alias) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
array_push($this->aliases,$alias);
}
/**
* Sets this attriute's name.
*
* @param string $name The new name to give this attribute.
*/
public function setName($name) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->name = $name;
}
/**
* Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).
*
* @param string $attr The name of the new parent (SUP) attribute
*/
public function setSupAttribute($attr) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->sup_attribute = $attr;
}
/**
* Sets this attribute's list of aliases.
*
* @param array $aliases The array of alias names (strings)
*/
public function setAliases($aliases) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->aliases = $aliases;
}
/**
* Sets this attribute's type.
*
* @param string $type The new type.
*/
public function setType($type) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->type = $type;
}
/**
* Adds an objectClass name to this attribute's list of "used in" objectClasses,
* that is the list of objectClasses which provide this attribute.
*
* @param string $name The name of the objectClass to add.
*/
public function addUsedInObjectClass($name) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
foreach ($this->used_in_object_classes as $used_in_object_class) {
if (DEBUG_ENABLED)
debug_log('Checking (%s) with (%s)',8,0,__FILE__,__LINE__,__METHOD__,$used_in_object_class,$name);
if (strcasecmp($used_in_object_class,$name) == 0)
return false;
}
array_push($this->used_in_object_classes,$name);
}
/**
* Gets the list of "used in" objectClasses, that is the list of objectClasses
* which provide this attribute.
*
* @return array An array of names of objectclasses (strings) which provide this attribute
*/
public function getUsedInObjectClasses() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->used_in_object_classes);
return $this->used_in_object_classes;
}
/**
* Adds an objectClass name to this attribute's list of "required by" objectClasses,
* that is the list of objectClasses which must have this attribute.
*
* @param string $name The name of the objectClass to add.
*/
public function addRequiredByObjectClass($name) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
foreach ($this->required_by_object_classes as $required_by_object_class)
if (strcasecmp($required_by_object_class,$name) == 0)
return false;
array_push($this->required_by_object_classes,$name);
}
/**
* Gets the list of "required by" objectClasses, that is the list of objectClasses
* which provide must have attribute.
*
* @return array An array of names of objectclasses (strings) which provide this attribute
*/
public function getRequiredByObjectClasses() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->required_by_object_classes);
return $this->required_by_object_classes;
}
/**
* This function will mark this attribute as a forced MAY attribute
*/
public function setForceMay() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->forced_as_may = true;
}
public function isForceMay() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->forced_as_may);
return $this->forced_as_may;
}
}
/**
* Represents an LDAP Syntax
*
* @package phpLDAPadmin
* @subpackage Schema
*/
class Syntax extends SchemaItem {
/**
* Creates a new Syntax object from a raw LDAP syntax string.
*/
public function __construct($class) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$strings = preg_split('/[\s,]+/',$class,-1,PREG_SPLIT_DELIM_CAPTURE);
for($i=0; $i<count($strings); $i++) {
switch($strings[$i]) {
case '(':
break;
case 'DESC':
do {
$i++;
if (strlen($this->description) == 0)
$this->description=$this->description.$strings[$i];
else
$this->description=$this->description.' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
break;
default:
if (preg_match('/[\d\.]+/i',$strings[$i]) && $i == 1)
$this->setOID($strings[$i]);
}
}
$this->description = preg_replace("/^\'/",'',$this->description);
$this->description = preg_replace("/\'$/",'',$this->description);
}
}
/**
* Represents an LDAP MatchingRule
*
* @package phpLDAPadmin
* @subpackage Schema
*/
class MatchingRule extends SchemaItem {
# This rule's syntax OID
private $syntax = '';
# An array of attribute names who use this MatchingRule
private $used_by_attrs = array();
/**
* Creates a new MatchingRule object from a raw LDAP MatchingRule string.
*/
function __construct($strings) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$strings = preg_split('/[\s,]+/',$strings,-1,PREG_SPLIT_DELIM_CAPTURE);
for ($i=0; $i<count($strings); $i++) {
switch($strings[$i]) {
case '(':
break;
case 'NAME':
if ($strings[$i+1] != '(') {
do {
$i++;
if (strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
} else {
$i++;
do {
$i++;
if (strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
do {
$i++;
} while (! preg_match('/\)+\)?/',$strings[$i]));
}
$this->name = preg_replace("/^\'/",'',$this->name);
$this->name = preg_replace("/\'$/",'',$this->name);
break;
case 'DESC':
do {
$i++;
if (strlen($this->description)==0)
$this->description=$this->description.$strings[$i];
else
$this->description=$this->description.' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
break;
case 'OBSOLETE':
$this->is_obsolete = TRUE;
break;
case 'SYNTAX':
$this->syntax = $strings[++$i];
break;
default:
if (preg_match('/[\d\.]+/i',$strings[$i]) && $i == 1)
$this->setOID($strings[$i]);
}
}
$this->description = preg_replace("/^\'/",'',$this->description);
$this->description = preg_replace("/\'$/",'',$this->description);
}
/**
* Sets the list of used_by_attrs to the array specified by $attrs;
*
* @param array $attrs The array of attribute names (strings) which use this MatchingRule
*/
public function setUsedByAttrs($attrs) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs);
$this->used_by_attrs = $attrs;
}
/**
* Adds an attribute name to the list of attributes who use this MatchingRule
*
* @return true if the attribute was added and false otherwise (already in the list)
*/
public function addUsedByAttr($attr) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
foreach ($this->used_by_attrs as $attr_name)
if (strcasecmp($attr_name,$attr) == 0)
return false;
array_push($this->used_by_attrs,$attr);
return true;
}
/**
* Gets an array of attribute names (strings) which use this MatchingRule
*
* @return array The array of attribute names (strings).
*/
public function getUsedByAttrs() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->used_by_attrs);
return $this->used_by_attrs;
}
}
/**
* Represents an LDAP schema matchingRuleUse entry
*
* @package phpLDAPadmin
* @subpackage Schema
*/
class MatchingRuleUse extends SchemaItem {
# An array of attribute names who use this MatchingRule
private $used_by_attrs = array();
function __construct($strings) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,0,__FILE__,__LINE__,__METHOD__,$fargs);
$strings = preg_split('/[\s,]+/',$strings,-1,PREG_SPLIT_DELIM_CAPTURE);
for($i=0; $i<count($strings); $i++) {
switch($strings[$i]) {
case '(':
break;
case 'NAME':
if ($strings[$i+1] != '(') {
do {
$i++;
if (! isset($this->name) || strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
} else {
$i++;
do {
$i++;
if (strlen($this->name) == 0)
$this->name = $strings[$i];
else
$this->name .= ' '.$strings[$i];
} while (! preg_match("/\'$/s",$strings[$i]));
do {
$i++;
} while (! preg_match('/\)+\)?/',$strings[$i]));
}
$this->name = preg_replace("/^\'/",'',$this->name);
$this->name = preg_replace("/\'$/",'',$this->name);
break;
case 'APPLIES':
if ($strings[$i+1] != '(') {
# Has a single attribute name
$i++;
$this->used_by_attrs = array($strings[$i]);
} else {
# Has multiple attribute names
$i++;
while ($strings[$i] != ')') {
$i++;
$new_attr = $strings[$i];
$new_attr = preg_replace("/^\'/",'',$new_attr);
$new_attr = preg_replace("/\'$/",'',$new_attr);
array_push($this->used_by_attrs,$new_attr);
$i++;
}
}
break;
default:
if (preg_match('/[\d\.]+/i',$strings[$i]) && $i == 1)
$this->setOID($strings[$i]);
}
}
sort($this->used_by_attrs);
}
/**
* Gets an array of attribute names (strings) which use this MatchingRuleUse object.
*
* @return array The array of attribute names (strings).
*/
public function getUsedByAttrs() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',9,1,__FILE__,__LINE__,__METHOD__,$fargs,$this->used_by_attrs);
return $this->used_by_attrs;
}
}
?>
|