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 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
|
<?php
/*
This code is part of FusionDirectory (http://www.fusiondirectory.org/)
Copyright (C) 2003-2010 Cajus Pollmeier
Copyright (C) 2011-2013 FusionDirectory
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*!
* \file class_plugin.inc
* Source code for the class plugin
*/
/*!
* \brief This is the base class for all plugins.
*
* \author Cajus Pollmeier <pollmeier@gonicus.de>
* \version 2.00
* \date 24.07.2003
*
* This is the base class for all plugins. It can be used standalone or
* can be included by the tabs class. All management should be done
* within this class. Extend your plugins from this class.
*/
class plugin
{
/*!
* \brief Reference to parent object
*
* This variable is used when the plugin is included in tabs
* and keeps reference to the tab class. Communication to other
* tabs is possible by 'name'. So the 'fax' plugin can ask the
* 'userinfo' plugin for the fax number.
*
* \sa tab
*/
var $parent = NULL;
/*!
\brief Configuration container
Access to global configuration
*/
var $config = NULL;
/*!
\brief Mark plugin as account
Defines whether this plugin is defined as an account or not.
This has consequences for the plugin to be saved from tab
mode. If it is set to 'FALSE' the tab will call the delete
function, else the save function. Should be set to 'TRUE' if
the construtor detects a valid LDAP object.
\sa plugin::__construct()
*/
var $is_account = FALSE;
var $initially_was_account = FALSE;
/*!
\brief Mark plugin as template
Defines whether we are creating a template or a normal object.
Has conseqences on the way execute() shows the formular and how
save() puts the data to LDAP.
\sa plugin::save() plugin::execute()
*/
var $is_template = FALSE;
var $ignore_account = FALSE;
var $is_modified = FALSE;
/*!
\brief Represent temporary LDAP data
This is only used internally.
*/
var $attrs = array();
/* Keep set of conflicting plugins */
var $conflicts = array();
/*!
\brief Used standard values
dn
*/
var $dn = "";
var $uid = "";
var $sn = "";
var $givenName = "";
var $acl = "*none*";
var $dialog = FALSE;
/* attribute list for save action */
var $attributes = array();
var $objectclasses = array();
var $is_new = TRUE;
var $saved_attributes = array();
var $acl_base = "";
var $acl_category = "";
var $read_only = FALSE; // Used when the entry is opened as "readonly" due to locks.
/* This can be set to render the tabulators in another stylesheet */
var $pl_notify = FALSE;
/* Object entry CSN */
var $entryCSN = "";
var $CSN_check_active = FALSE;
var $selected_edit_values = array();
/*!
* \brief plugin constructor
*
* If 'dn' is set, the node loads the given 'dn' from LDAP
*
* \param $config configuration
*
* \param $dn Distinguished name to initialize plugin from
*
* \param $object NULL
*
* \sa plugin()
*/
function __construct (&$config, $dn = NULL, $object = NULL)
{
/* Configuration is fine, allways */
$this->config = &$config;
$this->dn = $dn;
// Ensure that we've a valid acl_category set.
if (empty($this->acl_category)) {
$tmp = pluglist::pluginInfos(get_class($this));
if (isset($tmp['plCategory'])) {
$c = key($tmp['plCategory']);
if (is_numeric($c)) {
$c = $tmp['plCategory'][0];
}
$this->acl_category = $c."/";
}
}
/* Handle new accounts, don't read information from LDAP */
if ($this->dn != "new") {
/* Check if this entry was opened in read only mode */
if (isset($_POST['open_readonly'])) {
if (session::global_is_set("LOCK_CACHE")) {
$cache = &session::get("LOCK_CACHE");
if (isset($cache['READ_ONLY'][$this->dn])) {
$this->read_only = TRUE;
}
}
}
/* Save current dn as acl_base */
$this->acl_base = $this->dn;
}
/* Get LDAP descriptor */
if (($this->dn != "new" && $this->dn !== NULL) || ($object !== NULL)) {
/* Load data to 'attrs' and save 'dn' */
if ($object !== NULL) {
$this->attrs = $object->attrs;
} else {
$ldap = $this->config->get_ldap_link();
$ldap->cat($this->dn);
$this->attrs = $ldap->fetch();
}
/* Set the template flag according to the existence of objectClass gosaUserTemplate */
if (isset($this->attrs['objectClass'])) {
if (in_array_ics ("gosaUserTemplate", $this->attrs['objectClass'])) {
$this->is_template = TRUE;
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "found", "Template check");
}
}
/* Is Account? */
if ($this->is_this_account($this->attrs)) {
$this->is_account = TRUE;
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "found", "Object check");
}
}
$this->loadAttributes();
$this->prepareSavedAttributes();
/* Save initial account state */
$this->initially_was_account = $this->is_account;
}
protected function loadAttributes()
{
/* Copy needed attributes */
foreach ($this->attributes as $val) {
$found = array_key_ics($val, $this->attrs);
if ($found != "") {
$this->$val = $found[0];
}
}
}
function is_this_account($attrs)
{
$found = TRUE;
foreach ($this->objectclasses as $obj) {
if (preg_match('/top/i', $obj)) {
continue;
}
if (!isset($attrs['objectClass']) || !in_array_ics ($obj, $attrs['objectClass'])) {
$found = FALSE;
break;
}
}
return $found;
}
function prepareSavedAttributes()
{
/* Prepare saved attributes */
$this->saved_attributes = $this->attrs;
foreach (array_keys($this->saved_attributes) as $index) {
if (is_numeric($index)) {
unset($this->saved_attributes[$index]);
continue;
}
if (!in_array_ics($index, $this->attributes) && strcasecmp('objectClass', $index)) {
unset($this->saved_attributes[$index]);
continue;
}
if (isset($this->saved_attributes[$index][0])) {
if (!isset($this->saved_attributes[$index]["count"])) {
$this->saved_attributes[$index]["count"] = count($this->saved_attributes[$index]);
}
if ($this->saved_attributes[$index]["count"] == 1) {
$tmp = $this->saved_attributes[$index][0];
unset($this->saved_attributes[$index]);
$this->saved_attributes[$index] = $tmp;
continue;
}
}
unset($this->saved_attributes[$index]["count"]);
}
}
/*!
* \brief This function is called on the copied object to set its dn to where it will be saved
*/
function resetCopyInfos()
{
$this->dn = 'new';
$this->orig_dn = $this->dn;
$this->saved_attributes = array();
$this->initially_was_account = FALSE;
$this->postCopyHook();
}
/*!
* \brief Generates the html output for this node
*/
function execute()
{
/* This one is empty currently. Fabian - please fill in the docu code */
session::global_set('current_class_for_help', get_class($this));
/* Reset Lock message POST/GET check array, to prevent perg_match errors*/
session::set('LOCK_VARS_TO_USE', array());
session::set('LOCK_VARS_USED_GET', array());
session::set('LOCK_VARS_USED_POST', array());
session::set('LOCK_VARS_USED_REQUEST', array());
}
/*!
* \brief Removes object from parent
*/
function remove_from_parent()
{
/* include global link_info */
$ldap = $this->config->get_ldap_link();
/* Get current objectClasses in order to add the required ones */
$ldap->cat($this->dn);
$tmp = $ldap->fetch ();
$oc = array();
if (isset($tmp['objectClass'])) {
$oc = $tmp['objectClass'];
unset($oc['count']);
}
/* Remove objectClasses from entry */
$ldap->cd($this->dn);
$this->attrs = array();
$this->attrs['objectClass'] = array_remove_entries_ics($this->objectclasses, $oc);
/* Unset attributes from entry */
foreach ($this->attributes as $val) {
$this->attrs["$val"] = array();
}
/* Do not write in plugin base class, this must be done by
children, since there are normally additional attribs,
lists, etc. */
if ($this->initially_was_account) {
$this->handle_pre_events('remove');
}
}
/*!
* \brief Save HTML posted data to object
*/
function save_object()
{
/* Update entry CSN if it is empty. */
if (empty($this->entryCSN) && $this->CSN_check_active) {
$this->entryCSN = getEntryCSN($this->dn);
}
/* Save values to object */
foreach ($this->attributes as $val) {
if ($this->acl_is_writeable($val) && isset ($_POST["$val"])) {
/* Check for modifications */
$data = $_POST["$val"];
if ($this->$val != $data) {
$this->is_modified = TRUE;
}
$this->$val = $data;
/* Okay, how can I explain this fix ...
* In firefox, disabled option fields aren't selectable ... but in IE you can select these fileds.
* So IE posts these 'unselectable' option, with value = chr(194)
* chr(194) seems to be the in between the ...option> </option.. because there is no value=".." specified in these option fields
* This was added for W3c compliance, but now causes these ... ldap errors ...
* So we set these Fields to ""; a normal empty string, and we can check these values in plugin::check() again ...
*/
if (isset($data[0]) && ($data[0] == chr(194))) {
$data = "";
}
$this->$val = $data;
}
}
}
/*!
* \brief Save data to LDAP, depending on is_account we save or delete
*/
function save()
{
/* include global link_info */
$ldap = $this->config->get_ldap_link();
/* Save all plugins */
$this->entryCSN = "";
/* Start with empty array */
$this->attrs = array();
/* Get current objectClasses in order to add the required ones */
$ldap->cat($this->dn);
$tmp = $ldap->fetch ();
$oc = array();
if (isset($tmp['objectClass'])) {
$oc = $tmp["objectClass"];
unset($oc['count']);
$this->is_new = FALSE;
} else {
$this->is_new = TRUE;
}
/* Load (minimum) attributes, add missing ones */
$this->attrs['objectClass'] = array_merge_unique($oc, $this->objectclasses);
/* Copy standard attributes */
foreach ($this->attributes as $val) {
if ($this->$val != "") {
$this->attrs["$val"] = $this->$val;
} elseif (!$this->is_new) {
$this->attrs["$val"] = array();
}
}
if ($this->is_new) {
$this->handle_pre_events('add');
} else {
$this->handle_pre_events('modify');
}
}
/*!
* \brief Remove attributes, empty arrays, arrays
* single attributes that do not differ
*/
function cleanup()
{
foreach ($this->attrs as $index => $value) {
/* Convert arrays with one element to non arrays, if the saved
attributes are no array, too */
if (is_array($this->attrs[$index]) &&
count ($this->attrs[$index]) == 1 &&
isset($this->saved_attributes[$index]) &&
!is_array($this->saved_attributes[$index])) {
$this->attrs[$index] = $this->attrs[$index][0];
}
/* Remove emtpy arrays if they do not differ */
if (is_array($this->attrs[$index]) &&
count($this->attrs[$index]) == 0 &&
!isset($this->saved_attributes[$index])) {
unset ($this->attrs[$index]);
continue;
}
/* Remove single attributes that do not differ */
if (!is_array($this->attrs[$index]) &&
isset($this->saved_attributes[$index]) &&
!is_array($this->saved_attributes[$index]) &&
$this->attrs[$index] == $this->saved_attributes[$index]) {
unset ($this->attrs[$index]);
continue;
}
/* Remove arrays that do not differ */
if (is_array($this->attrs[$index]) &&
isset($this->saved_attributes[$index]) &&
is_array($this->saved_attributes[$index])) {
if (!array_differs($this->attrs[$index], $this->saved_attributes[$index])) {
unset ($this->attrs[$index]);
continue;
}
}
}
/* Update saved attributes and ensure that next cleanups will be successful too */
foreach ($this->attrs as $name => $value) {
$this->saved_attributes[$name] = $value;
}
}
/*!
* \brief Check formular input
*/
function check()
{
$message = array();
/* Skip if we've no config object */
if (!isset($this->config) || !is_object($this->config)) {
return $message;
}
self::callHook($this, 'CHECK', array(), $returnOutput);
if (!empty($returnOutput)) {
$message[] = join("\n", $returnOutput);
}
/* Check entryCSN */
if ($this->CSN_check_active) {
$current_csn = getEntryCSN($this->dn);
if (($current_csn != $this->entryCSN) && !empty($this->entryCSN) && !empty($current_csn)) {
$this->entryCSN = $current_csn;
$message[] = _("The object has changed since opened in FusionDirectory. All changes that may be done by others get lost if you save this entry!");
}
}
return $message;
}
/*
* \brief Adapt from template, using 'dn'
*
* \param string $dn The DN
*
* \param array $skip A new array
*/
function adapt_from_template($attrs, $skip = array())
{
$this->attrs = $attrs;
/* Walk through attributes */
foreach ($this->attributes as $val) {
/* Skip the ones in skip list */
if (in_array($val, $skip)) {
continue;
}
if (isset($this->attrs["$val"][0])) {
$this->$val = $this->attrs["$val"][0];
}
}
/* Is Account? */
$this->is_account = $this->is_this_account($this->attrs);
}
public function setNeedEditMode ($bool)
{
}
static function tpl_fetch_template($dn)
{
global $config;
$ldap = $config->get_ldap_link();
$ldap->cat($dn);
$attrs = $ldap->fetch();
//~ $attrs = self::tpl_template_to_attrs($attrs);
$depends = self::tpl_attrs_depends($attrs);
$attrs = self::tpl_sort_attrs($attrs, $depends);
return array($attrs, $depends);
}
/* Apply a modifier
* Returns an array of possible values */
static function tpl_apply_modifier($m, $args, $str)
{
mb_internal_encoding('UTF-8');
mb_regex_encoding('UTF-8');
if (is_array($str) && (strtolower($m) == $m)) {
/* $str is an array and $m is lowercase, so it's a string modifier */
$str = $str[0];
}
switch ($m) {
case 'F': // First
return array($str[0]);
case 'L': // Last
return array(end($str));
case 'J': // Join
if (isset($args[0])) {
return array(join($args[0], $str));
} else {
return array(join($str));
}
case 'b': // base64
if (isset($args[0]) && ($args[0] == 'd')) {
return array(base64_decode($str));
}
return array(base64_encode($str));
case 'c': // comment
return array('');
case 'u': // uppercase
return array(mb_strtoupper($str, 'UTF-8'));
case 'l': // lowercase
return array(mb_strtolower($str, 'UTF-8'));
case 'a': // remove accent
$str = htmlentities($str, ENT_NOQUOTES, 'UTF-8');
$str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str);
$str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str); // handle ligatures
return array(preg_replace('#&[^;]+;#', '', $str)); // delete unhandled characters
case 'p': // spaces
return array(preg_replace('/\s/u', '', $str));
case 's': // substring
if (count($args) < 1) {
trigger_error("Missing 's' substr modifier parameter");
}
if (count($args) < 2) {
array_unshift($args, 0);
}
if (preg_match('/^(\d+)-(\d+)$/', $args[1], $m)) {
$res = array();
for ($i = $m[1];$i < $m[2]; ++$i) {
$res[] = substr($str, $args[0], $i);
}
return array_unique($res);
} else {
return array(substr($str, $args[0], $args[1]));
}
default:
trigger_error("Unkown modifier '$m'");
return array($str);
}
}
static function tpl_parse_mask($mask, $attrs)
{
if ($mask == "|") {
return array("%");
}
$modifiers = '';
if (preg_match('/^([^|]+)\|/', $mask, $m)) {
$modifiers = $m[1];
$mask = substr($mask, strlen($m[0]));
}
if (isset($attrs[$mask])) {
$result = array($attrs[$mask]);
if (is_array($result[0])) {
unset($result[0]['count']);
}
} else {
if (!preg_match('/c/', $modifiers)) {
trigger_error("'$mask' was not found in attributes");
}
$result = array('');
}
$len = strlen($modifiers);
for ($i = 0; $i < $len; ++$i) {
$args = array();
$modifier = $modifiers[$i];
if (preg_match('/^\[([^\]]+)\].*$/', substr($modifiers, $i + 1), $m)) {
/* get modifier args */
$args = explode(',', $m[1]);
$i += strlen($m[1]) + 2;
}
$result_tmp = array();
foreach ($result as $r) {
$result_tmp = array_merge($result_tmp, self::tpl_apply_modifier($modifier, $args, $r));
}
$result = $result_tmp;
}
foreach ($result as &$r) { // Array that were not converted by a modifier into a string are now converted to strings
if (is_array($r)) {
$r = $r[0];
}
}
unset($r);
return $result;
}
static function tpl_depends_of (&$cache, $depends, $key, $forbidden = NULL)
{
if (isset($cache[$key])) {
return $cache[$key];
}
if ($forbidden === NULL) {
$forbidden = $key;
} elseif ($forbidden == $key) {
die('Error : recursive dependency');
}
$array =
array_map(
function ($a) use (&$cache, $depends, $forbidden)
{
return plugin::tpl_depends_of ($cache, $depends, $a, $forbidden);
},
$depends[$key]
);
$array[] = $depends[$key];
$cache[$key] = array_unique(call_user_func_array('array_merge_recursive', $array));
return $cache[$key];
}
static function tpl_attrs_depends($attrs)
{
/* Compute dependencies of each attr */
$depends = array();
foreach ($attrs as $key => $values) {
$depends[$key] = array();
if (!is_array($values)) {
$values = array($values);
}
unset ($values['count']);
foreach ($values as $value) {
$offset = 0;
while (preg_match('/%([^%\|]+\|)?([^%]+)%/', $value, $m, PREG_OFFSET_CAPTURE, $offset)) {
$offset = $m[0][1] + strlen($m[0][0]);
$depends[$key][] = $m[2][0];
if (!isset($attrs[$m[2][0]])) { // Dependency which has no value might be missing
$attrs[$m[2][0]] = array();
$depends[$m[2][0]] = array();
}
}
}
}
/* Flattens dependencies */
$flatdepends = array();
foreach ($depends as $key => $value) {
self::tpl_depends_of($flatdepends, $depends, $key);
}
return $flatdepends;
}
static function tpl_sort_attrs($attrs, $flatdepends)
{
/* Sort attrs depending of dependencies */
uksort($attrs, function ($k1, $k2) use ($flatdepends) {
if (in_array($k1, $flatdepends[$k2])) {
return -1;
} elseif (in_array($k2, $flatdepends[$k1])) {
return 1;
} else { // When no direct dependency, we sort by number of dependencies
$c1 = count($flatdepends[$k1]);
$c2 = count($flatdepends[$k2]);
if ($c1 == $c2) {
return 0;
}
return (($c1 < $c2) ? -1 : 1);
}
});
return $attrs;
}
/*! Brief Return attrs needed before applying template
*
* return an array of attributes which are needed by the template
*/
static function tpl_needed_attrs($attrs, $flatdepends)
{
$needed = array();
$dependencies = array_unique(call_user_func_array('array_merge', $flatdepends));
foreach ($dependencies as $attr) {
if (empty($flatdepends[$attr])) {
$needed[] = $attr;
}
}
return $needed;
}
/*! Brief Parse attrs template masks
*
* return an array with the final values of attributes
*/
static function tpl_parse_attrs($attrs)
{
foreach ($attrs as &$attr) {
if (is_array($attr)) {
foreach ($attr as $key => &$string) {
if (!is_numeric($key)) {
continue;
}
$string = self::tpl_parse_string($string, $attrs);
}
unset($string);
}
}
unset($attr);
return $attrs;
}
/*! Brief Parse template masks in a single string
*
* return the string with patterns replaced by their values
*/
static function tpl_parse_string($string, $attrs)
{
$offset = 0;
while (preg_match('/%([^%]+)%/', $string, $m, PREG_OFFSET_CAPTURE, $offset)) {
$replace = self::tpl_parse_mask($m[1][0], $attrs);
$replace = $replace[0];
$string = substr_replace($string, $replace, $m[0][1], strlen($m[0][0]));
$offset = $m[0][1] + strlen($replace);
}
return $string;
}
/*!
* \brief Show header message for tab dialogs
*
* \param string $button_text The button text
*
* \param string $text The text
*
* \param boolean $disabled FALSE
*/
function show_enable_header($button_text, $text, $disabled = FALSE, $name = "modify_state")
{
return $this->show_header($button_text, $text, FALSE, $disabled, $name);
}
/*!
* \brief Show header message for tab dialogs
*
* \param string $button_text The button text
*
* \param string $text The text
*
* \param boolean $disabled FALSE
*/
function show_disable_header($button_text, $text, $disabled = FALSE, $name = "modify_state")
{
return $this->show_header($button_text, $text, TRUE, $disabled, $name);
}
/*!
* \brief Show header message for tab dialogs
*
* \param string $button_text The button text
*
* \param string $text The text
*
* \param boolean $plugin_enabled
*
* \param boolean $button_disabled FALSE
*/
function show_header($button_text, $text, $plugin_enabled, $button_disabled = FALSE, $name = "modify_state")
{
if (($button_disabled) || ((!$this->acl_is_createable() && !$plugin_enabled) || (!$this->acl_is_removeable() && $plugin_enabled))) {
$state = "disabled=\"disabled\"";
} else {
$state = "";
}
$display = "<div width=\"100%\"><p><b>$text</b><br/>\n";
$display .= "<input type=\"submit\" value=\"$button_text\" name=\"$name\" ".$state.
"></p></div><hr class=\"separator\"/>";
return $display;
}
/*!
* \brief Executes a command after an object has been copied
*/
function postCopyHook()
{
}
/*!
* \brief Create unique DN
*
* \param string $data
*
* \param string $base
*/
function create_unique_dn2($data, $base)
{
$ldap = $this->config->get_ldap_link();
$base = preg_replace("/^,*/", "", $base);
/* Try to use plain entry first */
$dn = "$data,$base";
$attribute = preg_replace('/=.*$/', '', $data);
$ldap->cat ($dn, array('dn'));
if (!$ldap->fetch()) {
return $dn;
}
/* Look for additional attributes */
foreach ($this->attributes as $attr) {
if ($attr == $attribute || $this->$attr == "") {
continue;
}
$dn = "$data+$attr=".$this->$attr.",$base";
$ldap->cat ($dn, array('dn'));
if (!$ldap->fetch()) {
return $dn;
}
}
/* None found */
return "none";
}
/*!
* \brief Create unique DN
*
* \param string $attribute
*
* \param string $base
*/
function create_unique_dn($attribute, $base)
{
$ldap = $this->config->get_ldap_link();
$base = preg_replace('/^,*/', '', $base);
/* Try to use plain entry first */
$dn = "$attribute=".$this->$attribute.",$base";
$ldap->cat($dn, array('dn'));
if (!$ldap->fetch()) {
return $dn;
}
/* Look for additional attributes */
foreach ($this->attributes as $attr) {
if ($attr == $attribute || $this->$attr == "" || is_array($this->$attr)) {
continue;
}
$dn = "$attribute=".$this->$attribute."+$attr=".$this->$attr.",$base";
$ldap->cat($dn, array('dn'));
if (!$ldap->fetch()) {
return $dn;
}
}
/* None found */
return 'none';
}
/*!
* \brief ldap rebind
*
* \param string $ldap
*
* \param string $referral
*/
function rebind($ldap, $referral)
{
$credentials = LDAP::get_credentials($referral, $this->config->current['REFERRAL']);
if (ldap_bind($ldap, $credentials['ADMIN'], $this->config->get_credentials($credentials['PASSWORD']))) {
$this->error = "Success";
$this->hascon = TRUE;
$this->reconnect = TRUE;
return 0;
} else {
$this->error = "Could not bind to " . $credentials['ADMIN'];
return NULL;
}
}
/*
* \brief Recursively copy ldap object
*
* \param string $src_dn The DN source
*
* \param string $dst_dn The DN destination
*/
function _copy($src_dn, $dst_dn)
{
$ldap = $this->config->get_ldap_link();
$ldap->cat($src_dn);
$attrs = $ldap->fetch();
/* Grummble. This really sucks. PHP ldap doesn't support rdn stuff. */
$ds = ldap_connect($this->config->current['SERVER']);
ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['REFERRAL'])) {
ldap_set_rebind_proc($ds, array(&$this, "rebind"));
}
$pwd = $this->config->get_credentials($this->config->current['ADMINPASSWORD']);
ldap_bind($ds, $this->config->current['ADMINDN'], $pwd);
/* Fill data from LDAP */
$new = array();
if ($sr = ldap_read($ds, LDAP::fix($src_dn), "objectClass=*")) {
if ($ei = ldap_first_entry($ds, $sr)) {
foreach (array_keys($attrs) as $attr) {
if ($info = @ldap_get_values_len($ds, $ei, $attr)) {
for ($i = 0; $i < $info['count']; $i++) {
if ($info['count'] == 1) {
$new[$attr] = $info[$i];
} else {
$new[$attr][] = $info[$i];
}
}
}
}
}
}
/* close connexion */
ldap_unbind($ds);
/* Adapt naming attribute */
$dst_name = preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
$dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
$new[$dst_name] = LDAP::fix($dst_val);
/* Check if this is a department.
* If it is a dep. && there is a , override in his ou
* change \2C to , again, else this entry can't be saved ...
*/
if (isset($new['ou']) && preg_match("/\\,/", $new['ou'])) {
$new['ou'] = str_replace("\\\\,", ",", $new['ou']);
}
/* Save copy */
$ldap->connect();
$ldap->cd($this->config->current['BASE']);
$ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
/* FAIvariable=.../..., cn=..
could not be saved, because the attribute FAIvariable was different to
the dn FAIvariable=..., cn=... */
if (!is_array($new['objectClass'])) {
$new['objectClass'] = array($new['objectClass']);
}
if (in_array_ics("FAIdebconfInfo", $new['objectClass'])) {
$new['FAIvariable'] = $ldap->fix($new['FAIvariable']);
}
$ldap->cd($dst_dn);
$ldap->add($new);
if (!$ldap->success()) {
trigger_error("Trying to save $dst_dn failed.",
E_USER_WARNING);
return FALSE;
}
return TRUE;
}
/*
* \brief Copy ldap object.
* This is a workaround function
*
* \param string $src_dn The DN source
*
* \param string $dst_dn The DN destination
*/
function copy($src_dn, $dst_dn)
{
/* Rename dn in possible object groups */
$ldap = $this->config->get_ldap_link();
$ldap->cat($dst_dn);
$attrs = $ldap->fetch();
if (count($attrs)) {
trigger_error("Trying to overwrite ".LDAP::fix($dst_dn).", which already exists.",
E_USER_WARNING);
return FALSE;
}
$ldap->cat($src_dn);
$attrs = $ldap->fetch();
if (!count($attrs)) {
trigger_error("Trying to move ".LDAP::fix($src_dn).", which does not seem to exist.",
E_USER_WARNING);
return FALSE;
}
$ldap->cd($src_dn);
$ldap->search("objectClass=*", array("dn"));
while ($attrs = $ldap->fetch()) {
$src = $attrs['dn'];
$dst = preg_replace("/".preg_quote($src_dn, '/')."$/", $dst_dn, $attrs['dn']);
$this->_copy($src, $dst);
}
return TRUE;
}
/*!
* \brief Rename/Move a given src_dn to the given dest_dn
*
* Move a given ldap object indentified by $src_dn to the
* given destination $dst_dn
*
* - Ensure that all references are updated (ogroups)
* - Update ACLs
* - Update accessTo
*
* \param string $src_dn the source DN.
*
* \param string $dst_dn the destination DN.
*
* \return boolean TRUE on success else FALSE.
*/
private function rename($src_dn, $dst_dn)
{
/* Try to move the source entry to the destination position */
$ldap = $this->config->get_ldap_link();
$ldap->cd($this->config->current['BASE']);
$ldap->create_missing_trees(preg_replace("/^[^,]+,/", "", $dst_dn));
if (!$ldap->rename_dn($src_dn, $dst_dn)) {
new log("debug", "Ldap Protocol v3 implementation error, ldap_rename failed, falling back to manual copy.",
"FROM: $src_dn -- TO: $dst_dn", array(), $ldap->get_error());
@DEBUG(DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, "Rename failed FROM: $src_dn -- TO: $dst_dn",
"Ldap Protocol v3 implementation error, falling back to maunal method.");
return FALSE;
}
return TRUE;
}
/*!
* \brief Move ldap entries from one place to another
*
* \param string $src_dn the source DN.
*
* \param string $dst_dn the destination DN.
*/
function move($src_dn, $dst_dn)
{
/* Do not move if only upper- lowercase has changed */
if (strtolower($src_dn) == strtolower($dst_dn)) {
return TRUE;
}
/* Try to move with ldap routines, if this was not successfull
fall back to the old style copy & remove method
*/
if (!$this->rename($src_dn, $dst_dn)) {
/* Copy source to destination */
if (!$this->copy($src_dn, $dst_dn)) {
return FALSE;
}
/* Delete source */
$ldap = $this->config->get_ldap_link();
$ldap->rmdir_recursive($src_dn);
if (!$ldap->success()) {
trigger_error("Trying to delete $src_dn failed.", E_USER_WARNING);
return FALSE;
}
}
/* Get list of users,groups and roles within this tree,
maybe we have to update ACL references.
* TODO : replace this with a call to handleForeignKeys on sub objects
*/
$leaf_objs = get_list("(|(objectClass=posixGroup)(objectClass=gosaAccount)(objectClass=gosaRole))", array("all"), $dst_dn,
array("dn","objectClass"), GL_SUBSEARCH | GL_NO_ACL_CHECK);
foreach ($leaf_objs as $obj) {
$new_dn = $obj['dn'];
$old_dn = preg_replace("/".preg_quote(LDAP::convert($dst_dn), '/')."$/i", $src_dn, LDAP::convert($new_dn));
$this->update_acls($old_dn, $new_dn);
}
/* Check if there are gosa departments moved.
If there were deps moved, the force reload of config->deps.
*/
$leaf_deps = get_list("(objectClass=gosaDepartment)", array("all"), $dst_dn,
array("dn","objectClass"), GL_SUBSEARCH | GL_NO_ACL_CHECK);
if (count($leaf_deps)) {
$this->config->get_departments();
$this->config->make_idepartments();
session::global_set("config", $this->config);
$ui = get_userinfo();
$ui->reset_acl_cache();
}
$this->handleForeignKeys($src_dn, $dst_dn);
return TRUE;
}
/*! \brief This function returns an LDAP filter for this plugin object classes
*/
function getObjectClassFilter ()
{
if (!empty($this->objectclasses)) {
return "(&(objectClass=".implode(")(objectClass=", $this->objectclasses)."))";
} else {
return "";
}
}
function handleForeignKeys ($olddn = NULL, $newdn = NULL, $mode = 'move')
{
if (($olddn !== NULL) && ($olddn == $newdn)) {
return;
}
$this->browseForeignKeys(
'handle_'.$mode,
$olddn,
$newdn
);
}
function browseForeignKeys($mode, $param1 = NULL, $param2 = NULL)
{
if (preg_match('/^handle_/', $mode)) {
$olddn = $param1;
$newdn = $param2;
$classes = array(get_class($this));
} elseif ($mode == 'references') {
$classes = array_keys($this->parent->by_object);
}
// We group by objetType concerned
$foreignRefs = array();
foreach ($classes as $tabclass) {
$infos = pluglist::pluginInfos($tabclass);
foreach ($infos['plForeignRefs'] as $field => $refs) {
if (preg_match('/^handle_/', $mode)) {
if ($newdn !== NULL) {
// Move action
if (($field != 'dn') && ($mode == 'handle_move')) {
// We only change dn
continue;
}
} elseif ($olddn === NULL) {
// Edit action
if ($field == 'dn') {
// dn did not change
continue;
} elseif (!$this->attributeHaveChanged($field)) {
// only look at changed attributes
continue;
}
}
// else = delete action, all fields are concerned, nothing to do here
}
foreach ($refs as $ref) {
$class = $ref[0];
$ofield = $ref[1];
$filter = $ref[2];
$cinfos = pluglist::pluginInfos($class);
foreach ($cinfos['plObjectType'] as $key => $objectType) {
if (!is_numeric($key)) {
$objectType = $key;
}
if (preg_match('/^handle_/', $mode)) {
if ($field == 'dn') {
$oldvalue = $olddn;
$newvalue = $newdn;
} elseif (($olddn !== NULL) && ($newdn === NULL)) {
$oldvalue = $this->attributeInitialValue($field);
$newvalue = NULL;
} else {
$oldvalue = $this->attributeInitialValue($field);
$newvalue = $this->attributeValue($field);
}
$foreignRefs[$objectType]['refs'][$class][$ofield] =
array(
'field' => $field,
'oldvalue' => $oldvalue,
'newvalue' => $newvalue,
'tab' => $tabclass,
);
$filter = plugin::tpl_parse_string($filter, array('oldvalue' => $oldvalue, 'newvalue' => $newvalue));
} elseif ($mode == 'references') {
$foreignRefs[$objectType]['refs'][$class]['name'] = $cinfos['plShortName'];
$foreignRefs[$objectType]['refs'][$class]['fields'][$ofield] =
array(
'tab' => $tabclass,
'tabname' => $this->parent->by_name[$tabclass],
'field' => $field,
'value' => $this->parent->by_object[$tabclass]->$field,
);
$filter = plugin::tpl_parse_string($filter, array('oldvalue' => $this->parent->by_object[$tabclass]->$field));
}
if (!preg_match('/^\(.*\)$/', $filter)) {
$filter = '('.$filter.')';
}
$foreignRefs[$objectType]['filters'][$filter] = $filter;
}
}
}
}
$refs = array();
// For each concerned objectType
foreach ($foreignRefs as $objectType => $tabRefs) {
// Compute filter
$filters = array_values($tabRefs['filters']);
$filter = '(|'.join($filters).')';
// Search objects
try {
$objects = objects::ls($objectType, array('dn' => 'raw'), NULL, $filter);
} catch (EmptyFilterException $e) {
continue;
}
// For each object of this type
foreach (array_keys($objects) as $dn) {
// Build the object
$tabobject = objects::open($dn, $objectType);
if (preg_match('/^handle_/', $mode)) {
// For each tab concerned
foreach ($tabRefs['refs'] as $tab => $fieldRefs) {
// If the tab is activated on this object
if (isset($tabobject->by_object[$tab])) {
// For each field
foreach ($fieldRefs as $ofield => $field) {
// call plugin::foreignKeyUpdate(ldapname, oldvalue, newvalue, source) on the object
$tabobject->by_object[$tab]->foreignKeyUpdate(
$ofield,
$field['oldvalue'],
$field['newvalue'],
array(
'CLASS' => $field['tab'],
'FIELD' => $field['field'],
'MODE' => preg_replace('/^handle_/', '', $mode),
)
);
}
$tabobject->by_object[$tab]->save_object();
$tabobject->by_object[$tab]->save();
}
}
} elseif ($mode == 'references') {
// For each tab concerned
foreach ($tabRefs['refs'] as $tab => $tab_infos) {
// If the tab is activated on this object
if (isset($tabobject->by_object[$tab])) {
// For each field
foreach ($tab_infos['fields'] as $ofield => $field) {
if ($tabobject->by_object[$tab]->foreignKeyCheck(
$ofield,
$field['value'],
array('CLASS' => $field['tab'], 'FIELD' => $field['field'])
)) {
if (!isset($refs[$dn])) {
$refs[$dn] = array(
'link' => '',
'tabs' => array(),
);
try {
$refs[$dn]['link'] = objects::link($dn, $objectType);
} catch (Exception $e) {
trigger_error("Could not create link to $dn: ".$e->getMessage());
$refs[$dn]['link'] = $dn;
}
}
if (!isset($refs[$dn]['tabs'][$tab])) {
$refs[$dn]['tabs'][$tab] = array(
'link' => '',
'fields' => array(),
);
try {
$refs[$dn]['tabs'][$tab]['link'] = objects::link($dn, $objectType, "tab_$tab", sprintf(_('Tab "%s"'), $tab_infos['name']));
} catch (Exception $e) {
trigger_error("Could not create link to $dn $tab: ".$e->getMessage());
$refs[$dn]['tabs'][$tab]['link'] = $tab;
}
}
$refs[$dn]['tabs'][$tab]['fields'][$ofield] = $field;
}
}
}
}
}
}
}
if ($mode == 'references') {
return $refs;
}
}
protected function attributeValue($field)
{
return $this->$field;
}
protected function attributeInitialValue($field)
{
die("Foreign key was declared but there is no method attributeInitialValue to handle it!".
" Class:".get_class($this).", Field:$field");
}
protected function attributeHaveChanged($field)
{
die("Foreign key was declared but there is no method attributeHaveChanged to handle it!".
" Class:".get_class($this).", Field:$field");
}
/*
* Source is an array like this:
* array(
* 'CLASS' => class,
* 'FIELD' => field,
* 'MODE' => mode
* )
* mode being either 'copy' or 'move', defaults to 'move'
*/
function foreignKeyUpdate ($field, $oldvalue, $newvalue, $source)
{
die("Foreign key was declared but there is no method foreignKeyUpdate to handle it!".
" Class:".get_class($this).", Field:$field, Source:(".join(',', $source).").");
}
function foreignKeyCheck ($field, $value, $source)
{
die("Foreign key was declared but there is no method foreignKeyCheck to handle it!".
" Class:".get_class($this).", Field:$field, Source:(".join(',', $source).").");
}
/* \brief Move/Rename complete trees
*
* \param string $src_dn the source DN.
*
* \param string $dst_dn the destination DN.
*/
function recursive_move($src_dn, $dst_dn)
{
trigger_error('Deprecated method : plugin::recursive_move, use plugin::move instead');
return $this->move($src_dn, $dst_dn);
}
/*! \brief Forward command execution requests
* to the pre/post hook execution method.
*
* \param string $when must be PRE or POST
*
* \param string $mode add, remove or modify
*
* \param array $addAttrs
*/
protected function handle_hooks($when, $mode, $addAttrs = array())
{
switch ($mode) {
case 'add':
plugin::callHook($this, $when.'CREATE', $addAttrs);
break;
case 'modify':
plugin::callHook($this, $when.'MODIFY', $addAttrs);
break;
case 'remove':
plugin::callHook($this, $when.'REMOVE', $addAttrs);
break;
default:
trigger_error(sprintf('Invalid %s event type given %s! Valid types are [add,modify,remove].', strtolower($when), $mode));
break;
}
}
/*! \brief Forward command execution requests
* to the post hook execution method.
*/
function handle_post_events($mode, $addAttrs = array())
{
/* Update foreign keys */
if ($mode == 'remove') {
$this->handleForeignKeys($this->dn, NULL);
} elseif ($mode == 'modify') {
$this->handleForeignKeys();
}
return $this->handle_hooks('POST', $mode, $addAttrs);
}
/*!
* \brief Forward command execution requests
* to the pre hook execution method.
*/
function handle_pre_events($mode, $addAttrs = array())
{
return $this->handle_hooks('PRE', $mode, $addAttrs);
}
/*!
* \brief Calls external hooks which are defined for this plugin (fusiondirectory.conf)
* Replaces placeholder by class values of this plugin instance.
* Allows to a add special replacements.
*/
static function callHook($plugin, $cmd, $addAttrs = array(), &$returnOutput = array(), &$returnCode = NULL)
{
global $config;
$command = $config->search(get_class($plugin), $cmd, array('menu','tabs','hooks'));
if ($command != "") {
// Walk trough attributes list and add the plugins attributes.
foreach ($plugin->attributes as $attr) {
$addAttrs[$attr] = $plugin->$attr;
}
$ui = get_userinfo();
$addAttrs['callerDN'] = $ui->dn;
$addAttrs['dn'] = $plugin->dn;
$addAttrs['location'] = $config->current['NAME'];
if (isset($plugin->parent->by_object)) {
foreach ($plugin->parent->by_object as $object) {
foreach ($object->attributes as $attr) {
if (!isset($addAttrs[$attr])) {
$addAttrs[$attr] = $object->$attr;
}
}
}
}
$command = self::tpl_parse_string($command, $addAttrs);
// If there are still some %.. in our command, try to fill these with some other class vars (FIXME: useless)
if (preg_match("/%/", $command)) {
$addAttrs = array();
$attrs = get_object_vars($plugin);
foreach ($attrs as $name => $value) {
if (is_array($value)) {
$s = "";
foreach ($value as $val) {
if (is_string($val) || is_int($val) || is_float($val) || is_bool($val)) {
$s .= $val.'|';
}
}
$value = trim($s, '|');
}
if (!is_string($value) && !is_int($value) && !is_float($value) && !is_bool($value)) {
continue;
}
$addAttrs[$name] = $value;
}
$command = self::tpl_parse_string($command, $addAttrs);
}
@DEBUG(DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
exec($command, $arr, $returnCode);
$returnOutput = $arr;
if ($returnCode != 0) {
$str = implode("\n", $arr);
@DEBUG(DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execution failed code: ".$returnCode);
$message = msgPool::cmdexecfailed($cmd, $command, get_class($plugin));
if (!empty($str)) {
$message .= "Result: ".$str;
}
msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
} elseif (is_array($arr)) {
$str = implode("\n", $arr);
@DEBUG(DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Result: ".$str);
if (!empty($str) && $config->get_cfg_value("displayHookOutput", "FALSE") == "TRUE") {
msg_dialog::display('['.get_class($plugin).' '.strtolower($cmd)."hook] $command", $str, INFO_DIALOG);
}
}
}
}
/*! \brief Test for removability of the object
*
* Allows testing of conditions for removal of object. If removal should be aborted
* the function needs to remove an error message.
*/
function allow_remove()
{
$reason = "";
return $reason;
}
/*!
* \brief Return plugin informations for acl handling
*
* \return an array
*/
static function plInfo()
{
return array();
}
/*!
* \brief Set acl base
*
* \param string $base
*/
function set_acl_base($base)
{
$this->acl_base = $base;
}
/*!
* \brief Set acl category
*
* \param string $category
*/
function set_acl_category($category)
{
$this->acl_category = "$category/";
}
/*! \brief Can we write the acl */
function acl_is_writeable($attribute, $skip_write = FALSE)
{
if ($this->read_only) {
return FALSE;
}
$ui = get_userinfo();
return preg_match('/w/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute, $skip_write));
}
/*!
* \brief Can we read the acl
*
* \param string $attribute
*/
function acl_is_readable($attribute)
{
$ui = get_userinfo();
return preg_match('/r/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute));
}
/*!
* \brief Can we create the acl
*
* \param string $base Empty string
*/
function acl_is_createable($base = "")
{
if ($this->read_only) {
return FALSE;
}
$ui = get_userinfo();
if ($base == "") {
$base = $this->acl_base;
}
return preg_match('/c/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
}
/*!
* \brief Can we remove the acl
*
* \param string $base Empty string
*/
function acl_is_removeable($base = "")
{
if ($this->read_only) {
return FALSE;
}
$ui = get_userinfo();
if ($base == "") {
$base = $this->acl_base;
}
return preg_match('/d/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
}
/*!
* \brief Can we move the acl
*
* \param string $base Empty string
*/
function acl_is_moveable($base = "")
{
if ($this->read_only) {
return FALSE;
}
$ui = get_userinfo();
if ($base == "") {
$base = $this->acl_base;
}
return preg_match('/m/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
}
/*! \brief get the acl */
function getacl($attribute, $skip_write = FALSE)
{
$ui = get_userinfo();
$skip_write |= $this->read_only;
return $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute, $skip_write);
}
/*!
* \brief Returns a list of all available departments for this object.
*
* If this object is new, all departments we are allowed to create a new user in
* are returned. If this is an existing object, return all deps.
* We are allowed to move tis object too.
*
* \return array [dn] => "..name" // All deps. we are allowed to act on.
*/
function get_allowed_bases()
{
$deps = array();
/* Is this a new object ? Or just an edited existing object */
if (!$this->initially_was_account && $this->is_account) {
$new = TRUE;
} else {
$new = FALSE;
}
foreach ($this->config->idepartments as $dn => $name) {
if ($new && $this->acl_is_createable($dn)) {
$deps[$dn] = $name;
} elseif (!$new && $this->acl_is_moveable($dn)) {
$deps[$dn] = $name;
}
}
/* Add current base */
if (isset($this->base) && isset($this->config->idepartments[$this->base])) {
$deps[$this->base] = $this->config->idepartments[$this->base];
} elseif (strtolower($this->dn) != strtolower($this->config->current['BASE'])) {
trigger_error("Cannot return list of departments, no default base found in class ".get_class($this).". (base is '".$this->base."')");
}
return $deps;
}
/*
* \brief This function updates ACL settings if $old_dn was used.
*
* \param string $old_dn specifies the actually used dn
*
* \param string $new_dn specifies the destiantion dn
*
* \param boolean $output_changes FALSE
*/
function update_acls($old_dn, $new_dn, $output_changes = FALSE)
{
/* Check if old_dn is empty. This should never happen */
if (empty($old_dn) || empty($new_dn)) {
trigger_error("Failed to check acl dependencies, wrong dn given.");
return;
}
/* Update userinfo if necessary */
$ui = session::global_get('ui');
if ($ui->dn == $old_dn) {
$ui->dn = $new_dn;
session::global_set('ui', $ui);
new log("view", "acl/".get_class($this), $this->dn, array(), "Updated current object dn from '".$old_dn."' to '".$new_dn."'");
}
}
/*!
* \brief Enable the Serial ID check
*
* This function enables the entry Serial ID check. If an entry was edited while
* we have edited the entry too, an error message will be shown.
* To configure this check correctly read the FAQ.
*/
function enable_CSN_check()
{
$this->CSN_check_active = TRUE;
$this->entryCSN = getEntryCSN($this->dn);
}
function is_modal_dialog()
{
return (isset($this->dialog) && $this->dialog);
}
}
?>
|