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
|
<?php
use LAM\PDF\PDFTable;
use LAM\PDF\PDFTableCell;
use LAM\PDF\PDFTableRow;
use LAM\TYPES\ConfiguredType;
/*
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
Copyright (C) 2008 Thomas Manninger
2008 - 2024 Roland Gruber
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* Manages DHCP host entries.
*
* @package modules
*
* @author Thomas Manninger
* @author Roland Gruber
*/
/**
* Manages DHCP host entries.
*
* @package modules
*/
class fixed_ip extends baseModule {
/** fixed ips */
public $fixed_ip = [];
/** already processed? */
public $processed = false;
/** for check if IPs overlap */
public $overlapd;
/** original IPs */
public $orig_ips = [];
/** LDAP attributes */
public $attributes;
/** cached host entries (list of array('cn' => ..., 'iphostnumber' => ..., 'macaddress' => ...)) */
private $hostCache;
/** cache for existing host entries */
private $existingDhcpHostsCache;
/**
* Returns true if this module can manage accounts of the current type, otherwise false.
*
* @return boolean true if module fits
*/
public function can_manage() {
return $this->get_scope() === 'dhcp';
}
/**
* Returns meta data that is interpreted by parent class
*
* @return array array with meta data
*
* @see baseModule::get_metaData()
*/
public function get_metaData() {
$return = [];
// alias name
$return["alias"] = _("Hosts");
// this is a base module
$return["is_base"] = false;
// icon
$return['icon'] = 'computer.svg';
// RDN attribute
$return["RDN"] = ["cn" => "high"];
// LDAP filter
$return["ldap_filter"] = [];
// module dependencies
$return['dependencies'] = ['depends' => ['dhcp_settings'], 'conflicts' => []];
// managed object classes
$return['objectClasses'] = [];
// managed attributes
$return['attributes'] = ['dhcpOption'];
// help Entries
$return['help'] = [
'pc' => [
"Headline" => _("PC name"), 'attr' => 'dhcpOption, host-name',
"Text" => _("The name of the PC.")
],
'mac' => [
"Headline" => _("MAC address"), 'attr' => 'dhcpHWAddress',
"Text" => _("The MAC address of the PC. Example: 11:22:33:44:55:aa")
],
'ip' => [
"Headline" => _("IP address"), 'attr' => 'dhcpStatements, fixed-address',
"Text" => _("The IP address of the PC.")
],
'description' => [
"Headline" => _("Description"), 'attr' => 'dhcpComments',
"Text" => _("Optional description for the PC.")
],
'active' => [
"Headline" => _("Active"), 'attr' => 'dhcpStatements, booting',
"Text" => _("Inactive hosts will not be able to get an address from the DHCP server.")
],
];
// available PDF fields
$return['PDF_fields'] = ['IPlist' => _('IP list')];
return $return;
}
/**
* This function fills the error message array with messages.
*/
public function load_Messages() {
$this->messages['errors'][0] = ['ERROR', _('One or more errors occurred. The invalid fields are marked.'), ''];
}
/**
* Controls if the module button the account page is visible and activated.
*
* @return string status ("enabled", "disabled", "hidden")
*/
public function getButtonStatus() {
if ($this->isRootNode()) {
return "hidden";
}
else {
return "enabled";
}
}
/**
* Checks if IPs are not overlapped.
*
* @param ip IP address
* @return bool not overlapped
**/
private function isNotOverlappedIp($ip) {
if (in_array($ip, $this->overlapd)) {
return false;
}
$this->overlapd[] = $ip;
return true;
}
/**
* Reset the overlapped_range() function
**/
private function reset_overlapped_ip() {
$this->overlapd = [];
}
/**
*
* Check, if a mac address is invalid
* @param string mac address
*
* @return bool true, if mac is invalid
**/
public function check_mac($mac): bool {
$ex = explode(":", $mac);
$invalid = false;
if (count($ex) != 6) {
$invalid = true;
}
foreach ($ex as $value) {
if (!preg_match("/[0-9a-fA-F][0-9a-fA-F]/", $value) || strlen($value) != "2") {
$invalid = true;
}
}
return $invalid;
}
/**
*
* Adapt the fixed ip with the subnet.
*
* @return true, if ip were edit.
*
**/
public function reload_ips() {
$ip_edit = false; // IPs were edited?
// Only run it, when ranges already exists:
if (is_array($this->fixed_ip)) {
$ex_subnet = explode(".", $this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0]);
foreach ($this->fixed_ip as $id => $arr) {
if (!empty($this->fixed_ip[$id]['ip']) && !range::check_subnet_range($this->fixed_ip[$id]['ip'],
$this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0],
$this->getAccountContainer()->getAccountModule('dhcp_settings')->getDHCPOption('subnet-mask'))) {
// Range anpassen:
$ex = explode(".", $this->fixed_ip[$id]['ip']);
$tmp = $this->fixed_ip[$id]['ip'];
$this->fixed_ip[$id]['ip'] = $ex_subnet['0'] . "." . $ex_subnet['1'] . "." . $ex_subnet['2'] . "." . $ex['3'];
if ($tmp != $this->fixed_ip[$id]['ip']) {
$ip_edit = true;
}
}
}
}
return $ip_edit;
}
/**
* This function loads all needed LDAP attributes.
*
* @param array $attr list of attributes
*/
function load_attributes($attr) {
if (!$this->isRootNode()) {
$searchAttributes = ['cn', 'dhcphwaddress', 'dhcpstatements', 'dhcpcomments'];
$entries = searchLDAP($this->getAccountContainer()->dn_orig, '(objectClass=dhcpHost)', $searchAttributes);
for ($i = 0; $i < sizeof($entries); $i++) {
$dhcphwaddress = explode(" ", $entries[$i]['dhcphwaddress'][0]);
$dhcphwaddress = array_pop($dhcphwaddress);
$dhcpstatements = [];
if (isset($entries[$i]['dhcpstatements'][0])) {
$dhcpstatements = $entries[$i]['dhcpstatements'];
}
$this->fixed_ip[$i]['cn'] = $entries[$i]['cn'][0];
$this->fixed_ip[$i]['mac'] = $dhcphwaddress;
$this->fixed_ip[$i]['ip'] = self::extractIP($dhcpstatements);
$this->fixed_ip[$i]['active'] = self::isActive($dhcpstatements);
$this->fixed_ip[$i]['dhcpstatements'] = $dhcpstatements;
$description = '';
if (isset($entries[$i]['dhcpcomments'][0])) {
$description = $entries[$i]['dhcpcomments'][0];
}
$this->fixed_ip[$i]['description'] = $description;
$this->orig_ips[$i]['cn'] = $entries[$i]['cn'][0];
$this->orig_ips[$i]['mac'] = $dhcphwaddress;
$this->orig_ips[$i]['ip'] = self::extractIP($dhcpstatements);
$this->orig_ips[$i]['active'] = self::isActive($dhcpstatements);
$this->orig_ips[$i]['dhcpstatements'] = $dhcpstatements;
$this->orig_ips[$i]['description'] = $description;
}
$this->orderByIP();
}
}
/**
* Orders the host entries by IP address.
*/
private function orderByIP() {
// sort by IP
$order = [];
foreach ($this->fixed_ip as $key => $value) {
$order[$key] = '';
if (!empty($value['dhcpstatements'])) {
$order[$key] = fixed_ip::extractIP($value['dhcpstatements']);
}
}
natcasesort($order);
$newVal = [];
foreach ($order as $index => $sortval) {
$newVal[] = $this->fixed_ip[$index];
}
$this->fixed_ip = $newVal;
}
/**
* Processes user input of the primary module page.
* It checks if all input values are correct and updates the associated LDAP attributes.
*
* @return array list of info/error messages
*/
public function process_attributes() {
$errors = [];
if ($this->isRootNode()) {
return $errors;
}
$this->processed = true;
$this->reset_overlapped_ip();
if ($this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0] != "") {
$error = false; // errors by process_attributes()?
$pcs = [];
foreach ($this->fixed_ip as $id => $arr) {
// Check if ip is to drop
if (isset($_POST['drop_ip_' . $id])) {
// Drop ip:
unset($this->fixed_ip[$id]);
continue;
}
// MAC address
$_POST['mac_' . $id] = strtolower(trim($_POST['mac_' . $id]));
$invalid = $this->check_mac($_POST['mac_' . $id]);
if ($invalid) {
$error = true;
}
$this->fixed_ip[$id]['mac'] = $_POST['mac_' . $id];
// description
if (!get_preg($_POST['description_' . $id], 'ascii')) {
$error = true;
}
$this->fixed_ip[$id]['description'] = $_POST['description_' . $id];
// active
$this->fixed_ip[$id]['active'] = (isset($_POST['active_' . $id]) && ($_POST['active_' . $id] == 'on'));
// Ip address
if (!empty($_POST['ip_' . $id])) {
$_POST['ip_' . $id] = trim($_POST['ip_' . $id]);
}
if ((!empty($_POST['ip_' . $id]) && !(check_ip($_POST['ip_' . $id])))
|| (!empty($_POST['ip_' . $id]) && !$this->isNotOverlappedIp($_POST['ip_' . $id]))) {
$error = true;
$this->fixed_ip[$id]['ip'] = $_POST['ip_' . $id];
}
else {
$this->fixed_ip[$id]['ip'] = $_POST['ip_' . $id];
}
// Is ip correct with subnet:
if (!empty($_POST['ip_' . $id]) && check_ip($_POST['ip_' . $id]) && !range::check_subnet_range($_POST['ip_' . $id],
$this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0],
$this->getAccountContainer()->getAccountModule('dhcp_settings')->getDHCPOption('subnet-mask'))) {
$error = true;
}
// cn:
if (!empty($_POST['pc_' . $id])) {
$_POST['pc_' . $id] = trim($_POST['pc_' . $id]);
}
if (!empty($_POST['pc_' . $id])) {
// name already in use
if (in_array($_POST['pc_' . $id], $pcs)) {
$error = true;
}
else {
$pcs[] = $_POST['pc_' . $id];
}
}
else {
$error = true;
}
if (strlen($_POST['pc_' . $id]) > 30) {
$error = true;
}
if (!preg_match("/^[A-Za-z0-9\\._-]*$/", $_POST['pc_' . $id])) {
$error = true;
}
$this->fixed_ip[$id]['cn'] = $_POST['pc_' . $id];
}
if ($error) {
$errors[] = $this->messages['errors'][0];
}
}
// Add new IP
if (isset($_POST['add_ip']) || ($_POST['pc_add'] != '') || ($_POST['mac_add'] != '')) {
// Add IP:
$active = (isset($_POST['active_add']) && ($_POST['active_add'] == 'on'));
$dhcpstatements = [];
$this->setActive($dhcpstatements, $active);
$this->setIP($dhcpstatements, $_POST['ip_add']);
$this->fixed_ip[] = [
'cn' => $_POST['pc_add'],
'mac' => $_POST['mac_add'],
'description' => $_POST['description_add'],
'ip' => $_POST['ip_add'],
'dhcpstatements' => $dhcpstatements,
'active' => $active,
];
$this->orderByIP();
}
return $errors;
}
/**
* Returns the HTML meta data for the main account page.
*
* @return htmlElement HTML meta data
*/
public function display_html_attributes() {
$return = new htmlResponsiveRow();
if ($this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0] == "") {
$return->add(new htmlStatusMessage('ERROR', _("Please fill out the DHCP settings first.")));
return $return;
}
$this->initCache();
// auto-completion for host names
$autoNames = [];
if (!empty($this->hostCache) && (sizeof($this->hostCache) < 200)) {
foreach ($this->hostCache as $attrs) {
if (!empty($attrs['cn'][0])) {
$autoNames[] = $attrs['cn'][0];
}
}
$autoNames = array_values(array_unique($autoNames));
}
$titles = [_('IP address'), _('PC name'), _('MAC address'), _('Description'), _('Active'), ' '];
$data = [];
// Reset oberlaped ips
$this->reset_overlapped_ip();
// If $ranges is not a array, then create one:
if (!is_array($this->fixed_ip)) {
$this->fixed_ip = [];
}
$pcs = [];
$messages = [];
foreach ($this->fixed_ip as $id => $arr) {
// pc name
$existsInDifferentDn = false;
if (!empty($_POST['pc_' . $id])) {
$existsInDifferentDn = $this->hostNameExists($_POST['pc_' . $id]);
}
if ($this->processed) {
if (strlen($this->fixed_ip[$id]['cn']) > 20) {
$messages[] = new htmlStatusMessage('ERROR', _("The PC name may not be longer than 20 characters."), htmlspecialchars($this->fixed_ip[$id]['cn']));
}
elseif (strlen($this->fixed_ip[$id]['cn']) < 2) {
$messages[] = new htmlStatusMessage('ERROR', _("The PC name needs to be at least 2 characters long."), htmlspecialchars($this->fixed_ip[$id]['cn']));
}
elseif (in_array($this->fixed_ip[$id]['cn'], $pcs)) {
$messages[] = new htmlStatusMessage('ERROR', _("This PC name already exists."), htmlspecialchars($this->fixed_ip[$id]['cn']));
}
elseif (isset($_POST['pc_' . $id]) && !preg_match("/^[A-Za-z0-9\\._-]*$/", $_POST['pc_' . $id])) {
$messages[] = new htmlStatusMessage('ERROR', _("The PC name may only contain A-Z, a-z and 0-9."), htmlspecialchars($_POST['pc_' . $id]));
}
elseif ($existsInDifferentDn !== false) {
$messages[] = new htmlStatusMessage('ERROR', sprintf(_('This PC name already exists in %s. Use e.g. %s.'), $existsInDifferentDn[0], $existsInDifferentDn[1]));
}
}
$pcs[] = $this->fixed_ip[$id]['cn'];
// MAC address
if ($this->processed && $this->check_mac($this->fixed_ip[$id]['mac'])) {
$messages[] = new htmlStatusMessage('ERROR', _("Invalid MAC address."), htmlspecialchars($this->fixed_ip[$id]['mac']));
}
// description
if ($this->processed && !get_preg($this->fixed_ip[$id]['description'], 'ascii')) {
$messages[] = new htmlStatusMessage('ERROR', _("Invalid description."), htmlspecialchars($this->fixed_ip[$id]['description']));
}
// fixed ip
if ($this->processed && !empty($this->fixed_ip[$id]['ip'])) {
if (!check_ip($this->fixed_ip[$id]['ip'])) {
$messages[] = new htmlStatusMessage('ERROR', _("The IP address is invalid."), htmlspecialchars($this->fixed_ip[$id]['ip']));
}
elseif (!range::check_subnet_range($this->fixed_ip[$id]['ip'],
$this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0],
$this->getAccountContainer()->getAccountModule('dhcp_settings')->getDHCPOption('subnet-mask'))) {
$messages[] = new htmlStatusMessage('ERROR', _("The IP address does not match the subnet."), htmlspecialchars($this->fixed_ip[$id]['ip']));
}
elseif (!$this->isNotOverlappedIp($this->fixed_ip[$id]['ip'])) {
$messages[] = new htmlStatusMessage('ERROR', _("The IP address is already in use."), htmlspecialchars($this->fixed_ip[$id]['ip']));
}
}
$entry = [];
$entry[] = new htmlInputField('ip_' . $id, $this->fixed_ip[$id]['ip']);
$pcInput = new htmlInputField('pc_' . $id, $this->fixed_ip[$id]['cn']);
if (!empty($autoNames)) {
$pcInput->enableAutocompletion($autoNames);
}
$entry[] = $pcInput;
$entry[] = new htmlInputField('mac_' . $id, $this->fixed_ip[$id]['mac']);
$entry[] = new htmlInputField('description_' . $id, $this->fixed_ip[$id]['description']);
$entry[] = new htmlInputCheckbox('active_' . $id, $this->fixed_ip[$id]['active']);
$entry[] = new htmlButton('drop_ip_' . $id, 'del.svg', true);
$data[] = $entry;
}
// add host
$newEntry = [];
$newEntry[] = new htmlInputField('ip_add');
$newPCInput = new htmlInputField('pc_add');
if (!empty($autoNames)) {
$newPCInput->enableAutocompletion($autoNames);
}
$newEntry[] = $newPCInput;
$newEntry[] = new htmlInputField('mac_add');
$newEntry[] = new htmlInputField('description_add');
$newEntry[] = new htmlInputCheckbox('active_add', true);
$newEntry[] = new htmlButton('add_ip', 'add.svg', true);
$data[] = $newEntry;
$table = new htmlResponsiveTable($titles, $data);
$table->setWidths(['20%', '20%', '20%', '25%', '10%', '5%']);
$table->colspan = 100;
$return->add($table);
foreach ($messages as $message) {
$return->add($message);
}
// add existing host entry
if (!empty($this->hostCache)) {
$return->addVerticalSpacer('2rem');
$addHostButton = new htmlAccountPageButton(static::class, 'addHost', 'add', _('Add existing host'));
$return->add($addHostButton);
}
return $return;
}
/**
* Checks if the given host name already exists.
*
* @param string $name host name
* @return boolean|array false if not exists, DN + new name suggestion if exists
*/
private function hostNameExists($name) {
$this->fillExistingDhcpHosts();
foreach ($this->existingDhcpHostsCache as &$host) {
if ($name === $host['name']) {
$dn = $host['dn'];
if ($this->getAccountContainer()->isNewAccount || !str_contains($dn, $this->getAccountContainer()->dn_orig)) {
return [$dn, $this->getHostNameSuggestion($name)];
}
}
}
return false;
}
/**
* Returns a suggestion for a free host name.
*
* @param string $name host name
* @return string suggested new name
*/
private function getHostNameSuggestion($name) {
$matches = [];
$number = 0;
$namePrefix = $name;
if (preg_match('/(.*[^0-9])([0-9]+)/', $name, $matches)) {
$namePrefix = $matches[1];
$number = $matches[2];
}
while (true) {
$number++;
$newName = $namePrefix . $number;
$found = false;
foreach ($this->existingDhcpHostsCache as &$host) {
if ($host['name'] === $newName) {
$found = true;
break;
}
}
if (!$found) {
return $newName;
}
}
}
/**
* Returns the HTML meta data for the add host page.
*
* @return htmlElement HTML meta data
*/
public function display_html_addHost() {
$return = new htmlResponsiveRow();
$this->initCache();
$hostNames = [];
$spacer = '####';
foreach ($this->hostCache as $host) {
if (!empty($host['cn'][0])) {
$val = $host['cn'][0];
if (!empty($host['iphostnumber'][0])) {
$val .= $spacer . $host['iphostnumber'][0];
}
else {
$val .= $spacer;
}
if (!empty($host['macaddress'][0])) {
$val .= $spacer . $host['macaddress'][0];
}
else {
$val .= $spacer;
}
$hostNames[$host['cn'][0]] = $val;
}
}
$select = new htmlResponsiveSelect('host', $hostNames, [], _('Host'));
$select->setHasDescriptiveElements(true);
$return->add($select);
$return->addVerticalSpacer('2rem');
$return->addLabel(new htmlAccountPageButton(static::class, 'attributes', 'addHost', _('Add')));
$return->addField(new htmlAccountPageButton(static::class, 'attributes', 'cancel', _('Cancel')));
return $return;
}
/**
* Processes user input of the add host page.
* It checks if all input values are correct and updates the associated LDAP attributes.
*
* @return array list of info/error messages
*/
public function process_addHost() {
$errors = [];
if (isset($_POST['form_subpage_fixed_ip_attributes_addHost'])) {
$val = explode('####', $_POST['host']);
$dhcpstatements = [];
$this->setActive($dhcpstatements, true);
$this->setIP($dhcpstatements, $val[1]);
$this->fixed_ip[] = [
'cn' => $val[0],
'mac' => $val[2],
'description' => '',
'ip' => $val[1],
'dhcpstatements' => $dhcpstatements,
'active' => true,
];
$this->orderByIP();
}
return $errors;
}
/**
* Returns a list of modifications which have to be made to the LDAP account.
*
* @return array list of modifications
* <br>This function returns an array with 3 entries:
* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
* <br>"add" are attributes which have to be added to LDAP entry
* <br>"remove" are attributes which have to be removed from LDAP entry
* <br>"modify" are attributes which have to been modified in LDAP entry
* <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)
*/
public function save_attributes() {
return [];
}
/**
* This function is overwritten because the fixed IPs are set after the ldap_add command.
*
* @param boolean $newAccount
* @param array $attributes LDAP attributes of this entry
* @return array array which contains status messages. Each entry is an array containing the status message parameters.
* @see baseModule::postModifyActions()
*
*/
public function postModifyActions($newAccount, $attributes) {
if (!$this->isRootNode()) {
$ldapSuffix = ',cn=' . $this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0] . ',' . $this->getAccountContainer()->get_type()->getSuffix();
$add = [];
$mod = []; // DN => array(attr => values)
$delete = [];
// Which dns are to delete and to add
foreach ($this->orig_ips as $id => $arr) {
// Exist cn still?
$in_arr = false;
foreach ($this->fixed_ip as $idB => $arr) {
if ($this->orig_ips[$id]['cn'] == $this->fixed_ip[$idB]['cn']) {
$in_arr = true;
// check if IP changed
if ($this->orig_ips[$id]['ip'] != $this->fixed_ip[$idB]['ip']) {
$this->setIP($this->fixed_ip[$idB]['dhcpstatements'], $this->fixed_ip[$idB]['ip']);
$mod['cn=' . $this->orig_ips[$id]['cn'] . $ldapSuffix]['dhcpstatements'] = $this->fixed_ip[$idB]['dhcpstatements'];
}
// check if active changed
if ($this->orig_ips[$id]['active'] != $this->fixed_ip[$idB]['active']) {
$this->setActive($this->fixed_ip[$idB]['dhcpstatements'], $this->fixed_ip[$idB]['active']);
$mod['cn=' . $this->orig_ips[$id]['cn'] . $ldapSuffix]['dhcpstatements'] = $this->fixed_ip[$idB]['dhcpstatements'];
}
// check if MAC changed
if ($this->orig_ips[$id]['mac'] != $this->fixed_ip[$idB]['mac']) {
$mod['cn=' . $this->orig_ips[$id]['cn'] . $ldapSuffix]['dhcpHWAddress'] = ['ethernet ' . $this->fixed_ip[$idB]['mac']];
}
// check if description changed
if ($this->orig_ips[$id]['description'] != $this->fixed_ip[$idB]['description']) {
$mod['cn=' . $this->orig_ips[$id]['cn'] . $ldapSuffix]['dhcpComments'][] = $this->fixed_ip[$idB]['description'];
}
break;
}
}
if (!$in_arr) {
$delete[] = $this->orig_ips[$id]['cn'];
}
}
if (!is_array($this->fixed_ip)) {
$this->fixed_ip = [];
}
// Which entries are new:
foreach ($this->fixed_ip as $id => $arr) {
$in_arr = false;
foreach ($this->orig_ips as $idB => $arr) {
if ($this->orig_ips[$idB]['cn'] == $this->fixed_ip[$id]['cn']) {
$in_arr = true;
}
}
if (!$in_arr) {
$add[] = $this->fixed_ip[$id];
}
}
foreach ($delete as $cn) {
ldap_delete($_SESSION['ldap']->server(), 'cn=' . $cn . $ldapSuffix);
}
foreach ($add as $arr) {
$attr = [];
$attr['cn'] = $arr['cn'];
$attr['objectClass'][0] = 'top';
$attr['objectClass'][1] = 'dhcpHost';
$attr['dhcpHWAddress'] = 'ethernet ' . $arr['mac'];
if ($arr['ip'] != '') {
$attr['dhcpStatements'][] = 'fixed-address ' . $arr['ip'];
}
if ($arr['active'] === false) {
$attr['dhcpStatements'][] = 'deny booting';
}
$attr['dhcpOption'] = 'host-name "' . $arr['cn'] . '"';
if (!empty($arr['description'])) {
$attr['dhcpComments'][] = $arr['description'];
}
if ($attr['cn'] != "") {
ldap_add($_SESSION['ldap']->server(), 'cn=' . $arr['cn'] . $ldapSuffix, $attr);
}
}
// entries to modify
foreach ($mod as $dn => $attrs) {
ldap_modify($_SESSION['ldap']->server(), $dn, $attrs);
}
}
return [];
}
/**
* {@inheritDoc}
* @see baseModule::get_pdfEntries()
*/
function get_pdfEntries($pdfKeys, $typeId) {
$return = [];
if (is_array($this->fixed_ip) && (sizeof($this->fixed_ip) > 0)) {
$pdfTable = new PDFTable();
$pdfRow = new PDFTableRow();
$pdfRow->cells[] = new PDFTableCell(_('PC name'), '20%', null, true);
$pdfRow->cells[] = new PDFTableCell(_('IP address'), '20%', null, true);
$pdfRow->cells[] = new PDFTableCell(_('MAC address'), '20%', null, true);
$pdfRow->cells[] = new PDFTableCell(_('Active'), '10%', null, true);
$pdfRow->cells[] = new PDFTableCell(_('Description'), '30%', null, true);
$pdfTable->rows[] = $pdfRow;
for ($i = 0; $i < sizeof($this->fixed_ip); $i++) {
$name = $this->fixed_ip[$i]['cn'];
$mac = $this->fixed_ip[$i]['mac'];
$ip = $this->fixed_ip[$i]['ip'];
$active = _('yes');
if (!$this->fixed_ip[$i]['active']) {
$active = _('no');
}
$description = $this->fixed_ip[$i]['description'];
$pdfRow = new PDFTableRow();
$pdfRow->cells[] = new PDFTableCell($name, '20%');
$pdfRow->cells[] = new PDFTableCell($ip, '20%');
$pdfRow->cells[] = new PDFTableCell($mac, '20%');
$pdfRow->cells[] = new PDFTableCell($active, '10%');
$pdfRow->cells[] = new PDFTableCell($description, '30%');
$pdfTable->rows[] = $pdfRow;
}
$this->addPDFTable($return, 'IPlist', $pdfTable);
}
return $return;
}
/**
* Extracts the IP from a list of DHCP statements.
*
* @param string $dhcpStatements values of dhcpStatements attribute
*/
public static function extractIP($dhcpStatements) {
$return = null;
if (is_array($dhcpStatements)) {
for ($i = 0; $i < sizeof($dhcpStatements); $i++) {
if (str_starts_with($dhcpStatements[$i], 'fixed-address ')) {
$return = substr($dhcpStatements[$i], strlen('fixed-address') + 1);
break;
}
}
}
return $return;
}
/**
* Sets the IP in a list of DHCP statements.
*
* @param array $dhcpStatements values of dhcpStatements attribute
* @param String $ip new IP
*/
private function setIP(&$dhcpStatements, $ip) {
for ($i = 0; $i < sizeof($dhcpStatements); $i++) {
if (str_starts_with($dhcpStatements[$i], 'fixed-address ')) {
unset($dhcpStatements[$i]);
$dhcpStatements = array_values($dhcpStatements);
}
}
if (!empty($ip)) {
$dhcpStatements[] = 'fixed-address ' . $ip;
}
}
/**
* Returns if this host is active.
*
* @param array $dhcpStatements values of dhcpStatements attribute
*/
public static function isActive($dhcpStatements) {
if (is_array($dhcpStatements)) {
for ($i = 0; $i < sizeof($dhcpStatements); $i++) {
if (strpos($dhcpStatements[$i], ' booting') === (strlen($dhcpStatements[$i]) - strlen(' booting'))) {
$val = substr($dhcpStatements[$i], 0, (strlen($dhcpStatements[$i]) - strlen(' booting')));
if ($val == 'deny') {
return false;
}
break;
}
}
}
return true;
}
/**
* Sets if this host is active.
*
* @param array $dhcpStatements values of dhcpStatements attribute
* @param boolean $active is active
*/
private function setActive(&$dhcpStatements, $active) {
for ($i = 0; $i < sizeof($dhcpStatements); $i++) {
if (str_contains($dhcpStatements[$i], ' booting')) {
unset($dhcpStatements[$i]);
$dhcpStatements = array_values($dhcpStatements);
}
}
if ($active) {
$dhcpStatements[] = 'allow booting';
}
else {
$dhcpStatements[] = 'deny booting';
}
}
/**
* Loads cached host data from LDAP.
*/
private function initCache() {
if ($this->hostCache != null) {
return;
}
$attrs = ['cn', 'iphostnumber', 'macaddress'];
$this->hostCache = [];
$result = searchLDAPByAttribute('cn', '*', null, $attrs, ['host']);
foreach ($result as $attributes) {
$this->hostCache[] = $attributes;
}
}
/**
* Returns if the current DN is the root entry.
*
* @return bool is root
*/
private function isRootNode() {
$rootSuffix = $this->getAccountContainer()->get_type()->getSuffix();
return $this->getAccountContainer()->dn_orig == $rootSuffix;
}
/**
* Fills the list of existing DHCP hosts.
*/
private function fillExistingDhcpHosts() {
if ($this->existingDhcpHostsCache != null) {
return;
}
$entries = searchLDAPByAttribute('cn', '*', 'dhcpHost', ['cn'], ['dhcp']);
$this->existingDhcpHostsCache = [];
foreach ($entries as $entry) {
$this->existingDhcpHostsCache[] = [
'dn' => $entry['dn'],
'name' => $entry['cn'][0]
];
}
}
/**
* @inheritDoc
*/
public function getListAttributeDescriptions(ConfiguredType $type): array {
return [
"fixed_ips" => _("IP address") . ' / ' . _('MAC address') . ' / ' . _("Description")
];
}
/**
* @inheritDoc
*/
public function getListRenderFunction(string $attributeName): ?callable {
if ($attributeName === 'fixed_ips') {
return function(array $entry, string $attribute): ?htmlElement {
// find all fixed addresses:
$entries = searchLDAP($entry['dn'], 'objectClass=dhcpHost', ['dhcpstatements', 'dhcphwaddress', 'cn']);
if (sizeof($entries) > 0) {
// sort by IP
$order = [];
for ($i = 0; $i < sizeof($entries); $i++) {
$order[$i] = '';
if (!empty($entries[$i]['dhcpstatements'])) {
$order[$i] = fixed_ip::extractIP($entries[$i]['dhcpstatements']);
}
}
$group = new htmlGroup();
natcasesort($order);
for ($i = 0; $i < sizeof($order); $i++) {
$dhcpstatements = [];
if (isset($entries[$i]['dhcpstatements'][0])) {
$dhcpstatements = $entries[$i]['dhcpstatements'];
}
$cssClasses = ['nowrap'];
if (!fixed_ip::isActive($dhcpstatements)) {
$cssClasses[] = 'strike-through';
}
$dhcphwaddress = explode(" ", $entries[$i]['dhcphwaddress'][0]);
$ipAddress = fixed_ip::extractIP($dhcpstatements);
$ip = new htmlOutputText($ipAddress);
$ip->setCSSClasses($cssClasses);
$group->addElement($ip);
if (!empty($ipAddress)) {
$group->addElement(new htmlOutputText('<br>', false));
}
$macAddress = array_pop($dhcphwaddress);
$mac = new htmlOutputText($macAddress);
$mac->setCSSClasses($cssClasses);
$group->addElement($mac);
if (!empty($macAddress)) {
$group->addElement(new htmlOutputText('<br>', false));
}
$name = new htmlOutputText($entries[$i]['cn'][0]);
$name->setCSSClasses($cssClasses);
$group->addElement($name);
$group->addElement(new htmlOutputText('<br>', false));
if ($i < (sizeof($order) - 1)) {
$group->addElement(new htmlOutputText('<br>', false));
}
}
return $group;
}
return null;
};
}
return null;
}
}
|