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 <?php
/**
***********************************************************************************************
* Class handle role rights, cards and other things of users
*
* @copyright 2004-2016 The Admidio Team
* @see http://www.admidio.org/
* @license https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License v2.0 only
***********************************************************************************************
*/
/**
* @class User
* Diese Klasse dient dazu ein Userobjekt zu erstellen.
* Ein User kann ueber diese Klasse in der Datenbank verwaltet werden
*
* Beside the methods of the parent class there are the following additional methods:
*
* deleteUserFieldData() - delete all user data of profile fields;
* user record will not be deleted
* getListViewRights() - Liefert ein Array mit allen Rollen und der
* Berechtigung, ob der User die Liste einsehen darf
* - aehnlich getProperty, allerdings suche ueber usf_id
* getVCard() - Es wird eine vCard des Users als String zurueckgegeben
* setRoleMembership($roleId, $startDate = DATE_NOW, $endDate = '9999-12-31', $leader = '')
* - set a role membership for the current user
* if memberships to this user and role exists within the period than merge them to one new membership
* viewProfile - Ueberprueft ob der User das Profil eines uebrgebenen
* Users einsehen darf
* viewRole - Ueberprueft ob der User eine uebergebene Rolle(Liste)
* einsehen darf
* isAdministrator() - gibt true/false zurueck, falls der User Mitglied der
* Rolle "Webmaster" ist
*/
class User extends TableAccess
{
protected $administrator;
public $mProfileFieldsData; ///< object with current user field structure
public $roles_rights = array(); ///< Array with all roles rights and the status of the current user e.g. array('rol_assign_roles' => '0', 'rol_approve_users' => '1' ...)
protected $listViewRights = array(); ///< Array with all roles and a flag if the user could view this role e.g. array('role_id_1' => '1', 'role_id_2' => '0' ...)
protected $listMailRights = array(); ///< Array with all roles and a flag if the user could write a mail to this role e.g. array('role_id_1' => '1', 'role_id_2' => '0' ...)
protected $rolesMembership = array(); ///< Array with all roles who the user is assigned
protected $rolesMembershipLeader = array(); ///< Array with all roles who the user is assigned and is leader (key = role_id; value = rol_leader_rights)
protected $rolesMembershipNoLeader = array(); ///< Array with all roles who the user is assigned and is not a leader of the role
protected $organizationId; ///< the organization for which the rights are read, could be changed with method @b setOrganization
protected $assignRoles; ///< Flag if the user has the right to assign at least one role
protected $saveChangesWithoutRights; ///< If this flag is set then a user can save changes to the user if he hasn't the necessary rights
protected $usersEditAllowed = array(); ///< Array with all user ids where the current user is allowed to edit the profile.
/**
* Constructor that will create an object of a recordset of the users table.
* If the id is set than this recordset will be loaded.
* @param \Database $database Object of the class Database. This should be the default global object @b $gDb.
* @param \ProfileFields $userFields An object of the ProfileFields class with the profile field structure
* of the current organization. This could be the default object @b $gProfileFields.
* @param int $userId The id of the user who should be loaded. If id isn't set than an empty
* object with no specific user is created.
*/
public function __construct(&$database, ProfileFields $userFields = null, $userId = 0)
{
global $gCurrentOrganization;
if($userFields !== null)
{
$this->mProfileFieldsData = clone $userFields; // create explicit a copy of the object (param is in PHP5 a reference)
$this->mProfileFieldsData->setDatabase($database);
}
$this->organizationId = (int) $gCurrentOrganization->getValue('org_id');
parent::__construct($database, TBL_USERS, 'usr', $userId);
}
/**
* Assign the user to all roles that have set the flag @b rol_default_registration.
* These flag should be set if you want that every new user should get this role.
*/
public function assignDefaultRoles()
{
global $gMessage, $gL10n;
$this->db->startTransaction();
// every user will get the default roles for registration, if the current user has the right to assign roles
// than the roles assignment dialog will be shown
$sql = 'SELECT rol_id
FROM '.TBL_ROLES.'
INNER JOIN '.TBL_CATEGORIES.'
ON cat_id = rol_cat_id
WHERE rol_default_registration = 1
AND cat_org_id = '.$this->organizationId;
$defaultRolesStatement = $this->db->query($sql);
if($defaultRolesStatement->rowCount() === 0)
{
$gMessage->show($gL10n->get('PRO_NO_DEFAULT_ROLE'));
// => EXIT
}
while($rolId = $defaultRolesStatement->fetchColumn())
{
// starts a membership for role from now
$this->setRoleMembership($rolId);
}
$this->db->endTransaction();
}
/**
* The method reads all roles where this user has a valid membership and checks the rights of
* those roles. It stores all rights that the user get at last through one role in an array.
* In addition the method checks which roles lists the user could see in an separate array.
* Also an array with all roles where the user has the right to write an email will be stored.
* The method considered the role leader rights of each role if this is set and the current
* user is a leader in a role.
* @param string $right The database column name of the right that should be checked. If this param
* is not set then only the arrays are filled.
* @return bool Return true if a special right should be checked and the user has this right.
*/
public function checkRolesRight($right = null)
{
if ((int) $this->getValue('usr_id') === 0)
{
return false;
}
if (count($this->roles_rights) === 0)
{
$this->assignRoles = false;
$tmpRolesRights = array(
'rol_all_lists_view' => false,
'rol_announcements' => false,
'rol_approve_users' => false,
'rol_assign_roles' => false,
'rol_dates' => false,
'rol_download' => false,
'rol_edit_user' => false,
'rol_guestbook' => false,
'rol_guestbook_comments' => false,
'rol_mail_to_all' => false,
'rol_photo' => false,
'rol_profile' => false,
'rol_weblinks' => false,
'rol_inventory' => false
);
// Alle Rollen der Organisation einlesen und ggf. Mitgliedschaft dazu joinen
$sql = 'SELECT *
FROM '.TBL_ROLES.'
INNER JOIN '.TBL_CATEGORIES.'
ON cat_id = rol_cat_id
LEFT JOIN '.TBL_MEMBERS.'
ON mem_rol_id = rol_id
AND mem_usr_id = '.$this->getValue('usr_id').'
AND mem_begin <= \''.DATE_NOW.'\'
AND mem_end > \''.DATE_NOW.'\'
WHERE rol_valid = 1
AND ( cat_org_id = '.$this->organizationId.'
OR cat_org_id IS NULL )';
$rolesStatement = $this->db->query($sql);
while ($row = $rolesStatement->fetch())
{
if ($row['mem_usr_id'] > 0)
{
// Sql selects all roles. Only consider roles where user is a member.
if ($row['mem_leader'] == 1)
{
// if user is leader in this role than add role id and leader rights to array
$this->rolesMembershipLeader[$row['rol_id']] = $row['rol_leader_rights'];
// if role leader could assign new members then remember this setting
// roles for confirmation of dates should be ignored
if ($row['cat_name_intern'] !== 'CONFIRMATION_OF_PARTICIPATION'
&& ($row['rol_leader_rights'] == ROLE_LEADER_MEMBERS_ASSIGN || $row['rol_leader_rights'] == ROLE_LEADER_MEMBERS_ASSIGN_EDIT))
{
$this->assignRoles = true;
}
}
else
{
$this->rolesMembershipNoLeader[] = (int) $row['rol_id'];
}
// add role to membership array
$this->rolesMembership[] = (int) $row['rol_id'];
// Rechte der Rollen in das Array uebertragen,
// falls diese noch nicht durch andere Rollen gesetzt wurden
foreach ($tmpRolesRights as $key => $value)
{
if (!$value && $row[$key] == '1')
{
$tmpRolesRights[$key] = true;
}
}
// set flag assignRoles of user can manage roles
if ($row['rol_assign_roles'] == 1)
{
$this->assignRoles = true;
}
// set administrator flag
if ($row['rol_administrator'] == 1)
{
$this->administrator = true;
}
}
// Listenansichtseinstellung merken
// Leiter duerfen die Rolle sehen
if ($row['mem_usr_id'] > 0 && ($row['rol_this_list_view'] > 0 || $row['mem_leader'] == 1))
{
// Mitgliedschaft bei der Rolle und diese nicht gesperrt, dann anschauen
$this->listViewRights[$row['rol_id']] = true;
}
elseif ($row['rol_this_list_view'] == 2)
{
// andere Rollen anschauen, wenn jeder sie sehen darf
$this->listViewRights[$row['rol_id']] = true;
}
else
{
$this->listViewRights[$row['rol_id']] = false;
}
// Mailrechte setzen
// Leiter duerfen der Rolle Mails schreiben
if ($row['mem_usr_id'] > 0 && ($row['rol_mail_this_role'] > 0 || $row['mem_leader'] == 1))
{
// Mitgliedschaft bei der Rolle und diese nicht gesperrt, dann anschauen
$this->listMailRights[$row['rol_id']] = true;
}
elseif ($row['rol_mail_this_role'] >= 2)
{
// andere Rollen anschauen, wenn jeder sie sehen darf
$this->listMailRights[$row['rol_id']] = true;
}
else
{
$this->listMailRights[$row['rol_id']] = false;
}
}
$this->roles_rights = $tmpRolesRights;
// ist das Recht 'alle Listen einsehen' gesetzt, dann dies auch im Array bei allen Rollen setzen
if ($this->roles_rights['rol_all_lists_view'])
{
$this->listViewRights = array_fill_keys(array_keys($this->listViewRights), true);
}
// ist das Recht 'allen Rollen EMails schreiben' gesetzt, dann dies auch im Array bei allen Rollen setzen
if ($this->roles_rights['rol_mail_to_all'])
{
$this->listMailRights = array_fill_keys(array_keys($this->listMailRights), true);
}
}
return $right === null || $this->roles_rights[$right];
}
/**
* Check if a valid password is set for the user and return true if the correct password
* was set. Optional the current session could be updated to a valid login session.
* @param string $password The password for the current user. This should not be encoded.
* @param bool $setAutoLogin If set to true then this login will be stored in AutoLogin table
* and the user doesn't need to login another time with this browser.
* To use this functionality @b $updateSessionCookies must be set to true.
* @param bool $updateSessionCookies The current session will be updated to a valid login.
* If set to false then the login is only valid for the current script.
* @param bool $updateHash If set to true the code will check if the current password hash uses
* the best hashing algorithm. If not the password will be rehashed with
* the new algorithm. If set to false the password will not be rehashed.
* @param bool $isAdministrator If set to true the code will check if the current password hash uses
* @return true|string Return true if login was successful and a string with the reason why the login failed.
* Possible reasons: SYS_LOGIN_MAX_INVALID_LOGIN
* SYS_LOGIN_NOT_ACTIVATED
* SYS_LOGIN_USER_NO_MEMBER_IN_ORGANISATION
* SYS_LOGIN_USER_NO_ADMINISTRATOR
* SYS_LOGIN_USERNAME_PASSWORD_INCORRECT
*/
public function checkLogin($password, $setAutoLogin = false, $updateSessionCookies = true, $updateHash = true, $isAdministrator = false)
{
global $gPreferences, $gCookiePraefix, $gCurrentSession, $gSessionId, $installedDbVersion, $gL10n;
$invalidLoginCount = $this->getValue('usr_number_invalid');
// if within 15 minutes 3 wrong login took place -> block user account for 15 minutes
if ($invalidLoginCount >= 3 && time() - strtotime($this->getValue('usr_date_invalid', 'Y-m-d H:i:s')) < 60 * 15)
{
$this->clear();
return $gL10n->get('SYS_LOGIN_MAX_INVALID_LOGIN');
}
$currHash = $this->getValue('usr_password');
if (!PasswordHashing::verify($password, $currHash))
{
// Password wrong
// log invalid logins
if ($invalidLoginCount >= 3)
{
$this->setValue('usr_number_invalid', 1);
}
else
{
$this->setValue('usr_number_invalid', $this->getValue('usr_number_invalid') + 1);
}
$this->setValue('usr_date_invalid', DATETIME_NOW);
$this->saveChangesWithoutRights();
$this->save(false); // don't update timestamp // TODO Exception handling
$this->clear();
if ($this->getValue('usr_number_invalid') >= 3)
{
return $gL10n->get('SYS_LOGIN_MAX_INVALID_LOGIN');
}
return $gL10n->get('SYS_LOGIN_USERNAME_PASSWORD_INCORRECT');
}
// Password correct
// if user is not activated/valid return error message
if (!$this->getValue('usr_valid'))
{
return $gL10n->get('SYS_LOGIN_NOT_ACTIVATED');
}
$sqlAdministrator = '';
// only check for administrator role if version > 3.1 because before it was webmaster role
if ($isAdministrator && version_compare($installedDbVersion, '3.2.0') === 1)
{
$sqlAdministrator = ', rol_administrator AS administrator';
}
// only check for webmaster role if version > 2.3 because before we don't have that flag
elseif ($isAdministrator && version_compare($installedDbVersion, '2.4.0') === 1)
{
$sqlAdministrator = ', rol_webmaster AS administrator';
}
// Check if user is currently member of a role of an organisation
$sql = 'SELECT DISTINCT mem_usr_id, org_longname'.$sqlAdministrator.'
FROM '.TBL_MEMBERS.'
INNER JOIN '.TBL_ROLES.'
ON rol_id = mem_rol_id
INNER JOIN '.TBL_CATEGORIES.'
ON cat_id = rol_cat_id
INNER JOIN '.TBL_ORGANIZATIONS.'
ON org_id = cat_org_id
WHERE mem_usr_id = '.$this->getValue('usr_id').'
AND rol_valid = 1
AND mem_begin <= \''.DATE_NOW.'\'
AND mem_end > \''.DATE_NOW.'\'
AND cat_org_id = '.$this->organizationId;
$userStatement = $this->db->query($sql);
$userRow = $userStatement->fetch();
if ($userStatement->rowCount() === 0)
{
return $gL10n->get('SYS_LOGIN_USER_NO_MEMBER_IN_ORGANISATION', $userRow['org_longname']);
}
if ($isAdministrator && version_compare($installedDbVersion, '2.4.0') === 1 && $userRow['administrator'] == 0)
{
return $gL10n->get('SYS_LOGIN_USER_NO_ADMINISTRATOR', $userRow['org_longname']);
}
// Rehash password if the hash is outdated and rehashing is enabled
if ($updateHash && PasswordHashing::needsRehash($currHash))
{
$this->saveChangesWithoutRights();
$this->setPassword($password);
$this->save(); // TODO Exception handling
}
if ($updateSessionCookies)
{
$gCurrentSession->setValue('ses_usr_id', $this->getValue('usr_id'));
$gCurrentSession->save();
}
// should the user stayed logged in automatically, than the cookie would expire in one year
if ($setAutoLogin && $gPreferences['enable_auto_login'] == 1)
{
$gCurrentSession->setAutoLogin();
}
else
{
$this->setValue('usr_last_session_id', null);
}
if ($updateSessionCookies)
{
// set cookie for session id and remove ports from domain
$domain = substr($_SERVER['HTTP_HOST'], 0, strpos($_SERVER['HTTP_HOST'], ':'));
setcookie($gCookiePraefix. '_ID', $gSessionId, 0, '/', $domain, 0);
// count logins and update login dates
$this->saveChangesWithoutRights();
$this->updateLoginData();
}
return true;
}
/**
* Additional to the parent method the user profile fields and all
* user rights and role memberships will be initialized
* @return void
*/
public function clear()
{
parent::clear();
// new user should be valid (except registration)
$this->setValue('usr_valid', 1);
$this->columnsValueChanged = false;
if(is_object($this->mProfileFieldsData))
{
// data of all profile fields will be deleted, the internal structure will not be destroyed
$this->mProfileFieldsData->clearUserData();
}
$this->administrator = false;
// initialize rights arrays
$this->usersEditAllowed = array();
$this->renewRoleData();
$this->saveChangesWithoutRights = false;
}
/**
* returns true if a column of user table or profile fields has changed
* @return bool
*/
public function columnsValueChanged()
{
return $this->columnsValueChanged || $this->mProfileFieldsData->columnsValueChanged;
}
/**
* Deletes the selected user of the table and all the many references in other tables.
* After that the class will be initialize.
* @return true|void @b true if no error occurred
*/
public function delete()
{
global $gCurrentUser;
$this->db->startTransaction();
$usrId = $this->getValue('usr_id');
$currUsrId = $gCurrentUser->getValue('usr_id');
$sql = 'UPDATE '.TBL_ANNOUNCEMENTS.' SET ann_usr_id_create = NULL
WHERE ann_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_ANNOUNCEMENTS.' SET ann_usr_id_change = NULL
WHERE ann_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_DATES.' SET dat_usr_id_create = NULL
WHERE dat_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_DATES.' SET dat_usr_id_change = NULL
WHERE dat_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_FOLDERS.' SET fol_usr_id = NULL
WHERE fol_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_FILES.' SET fil_usr_id = NULL
WHERE fil_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_GUESTBOOK.' SET gbo_usr_id_create = NULL
WHERE gbo_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_GUESTBOOK.' SET gbo_usr_id_change = NULL
WHERE gbo_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_LINKS.' SET lnk_usr_id_create = NULL
WHERE lnk_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_LINKS.' SET lnk_usr_id_change = NULL
WHERE lnk_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_LISTS.' SET lst_usr_id = NULL
WHERE lst_global = 1
AND lst_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_PHOTOS.' SET pho_usr_id_create = NULL
WHERE pho_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_PHOTOS.' SET pho_usr_id_change = NULL
WHERE pho_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_ROLES.' SET rol_usr_id_create = NULL
WHERE rol_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_ROLES.' SET rol_usr_id_change = NULL
WHERE rol_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_ROLE_DEPENDENCIES.' SET rld_usr_id = NULL
WHERE rld_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_USER_LOG.' SET usl_usr_id_create = NULL
WHERE usl_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_USERS.' SET usr_usr_id_create = NULL
WHERE usr_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'UPDATE '.TBL_USERS.' SET usr_usr_id_change = NULL
WHERE usr_usr_id_change = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_LIST_COLUMNS.'
WHERE lsc_lst_id IN (SELECT lst_id
FROM '.TBL_LISTS.'
WHERE lst_usr_id = '.$usrId.'
AND lst_global = 0)';
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_LISTS.'
WHERE lst_global = 0
AND lst_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_GUESTBOOK_COMMENTS.'
WHERE gbc_usr_id_create = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_MEMBERS.'
WHERE mem_usr_id = '.$usrId;
$this->db->query($sql);
// MySQL couldn't create delete statement with same table in subquery.
// Therefore we fill a temporary table with all ids that should be deleted and reference on this table
$sql = 'DELETE FROM '.TBL_IDS.'
WHERE ids_usr_id = '.$currUsrId;
$this->db->query($sql);
$sql = 'INSERT INTO '.TBL_IDS.' (ids_usr_id, ids_reference_id)
SELECT '.$currUsrId.', msc_msg_id
FROM '.TBL_MESSAGES_CONTENT.'
WHERE msc_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_MESSAGES_CONTENT.'
WHERE msc_msg_id IN (SELECT ids_reference_id
FROM '.TBL_IDS.'
WHERE ids_usr_id = '.$currUsrId.')';
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_MESSAGES.'
WHERE msg_id IN (SELECT ids_reference_id
FROM '.TBL_IDS.'
WHERE ids_usr_id = '.$currUsrId.')';
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_IDS.'
WHERE ids_usr_id = '.$currUsrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_MESSAGES_CONTENT.'
WHERE msc_msg_id IN (SELECT msg_id
FROM '.TBL_MESSAGES.'
WHERE msg_usr_id_sender = '.$usrId.')';
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_MESSAGES.'
WHERE msg_usr_id_sender = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_REGISTRATIONS.'
WHERE reg_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_AUTO_LOGIN.'
WHERE atl_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_SESSIONS.'
WHERE ses_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_USER_LOG.'
WHERE usl_usr_id = '.$usrId;
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_USER_DATA.'
WHERE usd_usr_id = '.$usrId;
$this->db->query($sql);
$return = parent::delete();
$this->db->endTransaction();
return $return;
}
/**
* delete all user data of profile fields; user record will not be deleted
* @return void
*/
public function deleteUserFieldData()
{
$this->db->startTransaction();
// delete every entry from adm_users_data
foreach($this->mProfileFieldsData->mUserData as $field)
{
$field->delete();
}
$this->mProfileFieldsData->mUserData = array();
$this->db->endTransaction();
}
/**
* @param bool[] $rightsList
* @return int[]
*/
private function getAllRolesWithRight(array $rightsList)
{
$visibleRoles = array();
$this->checkRolesRight();
foreach($rightsList as $roleId => $hasRight)
{
if($hasRight)
{
$visibleRoles[] = $roleId;
}
}
return $visibleRoles;
}
/**
* Creates an array with all roles where the user has the right to mail them
* @return int[] Array with role ids where user has the right to mail them
*/
public function getAllMailRoles()
{
return $this->getAllRolesWithRight($this->listMailRights);
}
/**
* Creates an array with all roles where the user has the right to view them
* @return int[] Array with role ids where user has the right to view them
*/
public function getAllVisibleRoles()
{
return $this->getAllRolesWithRight($this->listViewRights);
}
/**
* Returns the id of the organization this user object has been assigned.
* This is in the default case the default organization of the config file.
* @return int Returns the id of the organization this user object has been assigned
*/
public function getOrganization()
{
return $this->organizationId;
}
/**
* Returns an array with all role ids where the user is a member.
* @return int[] Returns an array with all role ids where the user is a member.
*/
public function getRoleMemberships()
{
$this->checkRolesRight();
return $this->rolesMembership;
}
/**
* Returns an array with all role ids where the user is a member
* and not a leader of the role.
* @return int[] Returns an array with all role ids where the user is a member
* and not a leader of the role.
*/
public function getRoleMembershipsNoLeader()
{
$this->checkRolesRight();
return $this->rolesMembershipNoLeader;
}
/**
* Get the value of a column of the database table if the column has the praefix @b usr_
* otherwise the value of the profile field of the table adm_user_data will be returned.
* If the value was manipulated before with @b setValue than the manipulated value is returned.
* @param string $columnName The name of the database column whose value should be read or the internal unique profile field name
* @param string $format For date or timestamp columns the format should be the date/time format e.g. @b d.m.Y = '02.04.2011'. @n
* For text columns the format can be @b database that would return the original database value without any transformations
* @return mixed Returns the value of the database column or the value of adm_user_fields
* If the value was manipulated before with @b setValue than the manipulated value is returned.
* @par Examples
* @code // reads data of adm_users column
* $loginname = $gCurrentUser->getValue('usr_login_name');
* // reads data of adm_user_fields
* $email = $gCurrentUser->getValue('EMAIL'); @endcode
*/
public function getValue($columnName, $format = '')
{
global $gPreferences;
if(strpos($columnName, 'usr_') !== 0)
{
return $this->mProfileFieldsData->getValue($columnName, $format);
}
if($columnName === 'usr_photo' && $gPreferences['profile_photo_storage'] == 0
&& is_file(SERVER_PATH.'/adm_my_files/user_profile_photos/'.$this->getValue('usr_id').'.jpg'))
{
return file_get_contents(SERVER_PATH.'/adm_my_files/user_profile_photos/'.$this->getValue('usr_id').'.jpg');
}
return parent::getValue($columnName, $format);
}
/**
* Creates a vcard with all data of this user object @n
* (Windows XP address book can't process utf8, so vcard output is iso-8859-1)
* @param bool $allowedToEditProfile If set to @b true than logged in user is allowed to edit profiles
* so he can see more data in the vcard
* @return string Returns the vcard as a string
*/
public function getVCard($allowedToEditProfile = false)
{
global $gPreferences;
$vCard = 'BEGIN:VCARD'."\r\n";
$vCard .= 'VERSION:2.1'."\r\n";
if ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('FIRST_NAME', 'usf_hidden') == 0))
{
$vCard .= 'N;CHARSET=ISO-8859-1:' . utf8_decode($this->getValue('LAST_NAME', 'database')). ';'. utf8_decode($this->getValue('FIRST_NAME', 'database')) . ";;;\r\n";
}
if ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('LAST_NAME', 'usf_hidden') == 0))
{
$vCard .= 'FN;CHARSET=ISO-8859-1:'. utf8_decode($this->getValue('FIRST_NAME')) . ' '. utf8_decode($this->getValue('LAST_NAME')) . "\r\n";
}
if ($this->getValue('usr_login_name') !== '')
{
$vCard .= 'NICKNAME;CHARSET=ISO-8859-1:' . utf8_decode($this->getValue('usr_login_name')). "\r\n";
}
if ($this->getValue('PHONE') !== ''
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('PHONE', 'usf_hidden') == 0)))
{
$vCard .= 'TEL;HOME;VOICE:' . $this->getValue('PHONE'). "\r\n";
}
if ($this->getValue('MOBILE') !== ''
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('MOBILE', 'usf_hidden') == 0)))
{
$vCard .= 'TEL;CELL;VOICE:' . $this->getValue('MOBILE'). "\r\n";
}
if ($this->getValue('FAX') !== ''
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('FAX', 'usf_hidden') == 0)))
{
$vCard .= 'TEL;HOME;FAX:' . $this->getValue('FAX'). "\r\n";
}
if ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('ADDRESS', 'usf_hidden') == 0 && $this->mProfileFieldsData->getProperty('CITY', 'usf_hidden') == 0
&& $this->mProfileFieldsData->getProperty('POSTCODE', 'usf_hidden') == 0 && $this->mProfileFieldsData->getProperty('COUNTRY', 'usf_hidden') == 0))
{
$vCard .= 'ADR;CHARSET=ISO-8859-1;HOME:;;' . utf8_decode($this->getValue('ADDRESS', 'database')). ';' . utf8_decode($this->getValue('CITY', 'database')). ';;' . utf8_decode($this->getValue('POSTCODE', 'database')). ';' . utf8_decode($this->getValue('COUNTRY', 'database')). "\r\n";
}
if ($this->getValue('WEBSITE') !== ''
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('WEBSITE', 'usf_hidden') == 0)))
{
$vCard .= 'URL;HOME:' . $this->getValue('WEBSITE'). "\r\n";
}
if ($this->getValue('BIRTHDAY') !== ''
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('BIRTHDAY', 'usf_hidden') == 0)))
{
$vCard .= 'BDAY:' . $this->getValue('BIRTHDAY', 'Ymd') . "\r\n";
}
if ($this->getValue('EMAIL') !== ''
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('EMAIL', 'usf_hidden') == 0)))
{
$vCard .= 'EMAIL;PREF;INTERNET:' . $this->getValue('EMAIL'). "\r\n";
}
if (is_file(SERVER_PATH.'/adm_my_files/user_profile_photos/'.$this->getValue('usr_id').'.jpg') && $gPreferences['profile_photo_storage'] == 1)
{
$img_handle = fopen(SERVER_PATH. '/adm_my_files/user_profile_photos/'.$this->getValue('usr_id').'.jpg', 'rb');
$vCard .= 'PHOTO;ENCODING=BASE64;TYPE=JPEG:'.base64_encode(fread($img_handle, filesize(SERVER_PATH. '/adm_my_files/user_profile_photos/'.$this->getValue('usr_id').'.jpg'))). "\r\n";
fclose($img_handle);
}
if ($this->getValue('usr_photo') !== '' && $gPreferences['profile_photo_storage'] == 0)
{
$vCard .= 'PHOTO;ENCODING=BASE64;TYPE=JPEG:'.base64_encode($this->getValue('usr_photo')). "\r\n";
}
// Geschlecht ist nicht in vCard 2.1 enthalten, wird hier fuer das Windows-Adressbuch uebergeben
if ($this->getValue('GENDER') > 0
&& ($allowedToEditProfile || (!$allowedToEditProfile && $this->mProfileFieldsData->getProperty('GENDER', 'usf_hidden') == 0)))
{
if ($this->getValue('GENDER') == 1)
{
$wabGender = 2;
}
else
{
$wabGender = 1;
}
$vCard .= 'X-WAB-GENDER:' . $wabGender . "\r\n";
}
if ($this->getValue('usr_timestamp_change') !== '')
{
$vCard .= 'REV:' . $this->getValue('usr_timestamp_change', 'ymdThis') . "\r\n";
}
$vCard .= 'END:VCARD'."\r\n";
return $vCard;
}
/**
* Checks if the current user is allowed to edit the profile of the user of the parameter.
* If will check if user can generally edit all users or if he is a group leader and can edit users
* of a special role where @b $user is a member or if it's the own profile and he could edit this.
* @param \User $user User object of the user that should be checked if the current user can edit his profile.
* @param bool $checkOwnProfile If set to @b false than this method don't check the role right to edit the own profile.
* @return bool Return @b true if the current user is allowed to edit the profile of the user from @b $user.
*/
public function hasRightEditProfile(&$user, $checkOwnProfile = true)
{
if (!is_object($user))
{
return false;
}
$usrId = (int) $this->getValue('usr_id');
$userId = (int) $user->getValue('usr_id');
// edit own profile ?
if ($usrId > 0 && $usrId === $userId && $checkOwnProfile && $this->checkRolesRight('rol_profile'))
{
return true;
}
// first check if user is in cache
if (array_key_exists($userId, $this->usersEditAllowed))
{
return $this->usersEditAllowed[$userId];
}
$returnValue = false;
if ($this->editUsers())
{
$returnValue = true;
}
else
{
if (count($this->rolesMembershipLeader) > 0)
{
// leaders are not allowed to edit profiles of other leaders but to edit their own profile
if ($usrId === $userId)
{
// check if current user is a group leader of a role where $user is only a member
$rolesMembership = $user->getRoleMemberships();
}
else
{
// check if current user is a group leader of a role where $user is only a member and not a leader
$rolesMembership = $user->getRoleMembershipsNoLeader();
}
foreach ($this->rolesMembershipLeader as $roleId => $leaderRights)
{
// is group leader of role and has the right to edit users ?
if (in_array($roleId, $rolesMembership, true) && $leaderRights > 1)
{
$returnValue = true;
}
}
}
}
// add result into cache
$this->usersEditAllowed[$userId] = $returnValue;
return $returnValue;
}
/**
* @param bool[] $rightsList
* @param string $rightName
* @param int $roleId
* @return bool
*/
private function hasRightRole(array $rightsList, $rightName, $roleId)
{
// if user has right to view all lists then he could also view this role
if($this->checkRolesRight($rightName))
{
return true;
}
// check if user has the right to view this role
if(array_key_exists($roleId, $rightsList) && $rightsList[$roleId])
{
return true;
}
return false;
}
/**
* Checks if the current user has the right to send an email to the role.
* @param int $roleId Id of the role that should be checked.
* @return bool Return @b true if the user has the right to send an email to the role.
*/
public function hasRightSendMailToRole($roleId)
{
return $this->hasRightRole($this->listMailRights, 'rol_mail_to_all', $roleId);
}
/**
* Checks if the current user is allowed to view the profile of the user of the parameter.
* If will check if user has edit rights with method editProfile or if the user is a member
* of a role where the current user has the right to view profiles.
* @param \User $user User object of the user that should be checked if the current user can view his profile.
* @return bool Return @b true if the current user is allowed to view the profile of the user from @b $user.
*/
public function hasRightViewProfile(User $user)
{
// if user is allowed to edit the profile then he can also view it
if($this->hasRightEditProfile($user))
{
return true;
}
// every user is allowed to view his own profile
if((int) $user->getValue('usr_id') === (int) $this->getValue('usr_id'))
{
return true;
}
// Benutzer, die alle Listen einsehen duerfen, koennen auch alle Profile sehen
if($this->checkRolesRight('rol_all_lists_view'))
{
return true;
}
$sql = 'SELECT rol_id, rol_this_list_view
FROM '.TBL_MEMBERS.'
INNER JOIN '.TBL_ROLES.'
ON rol_id = mem_rol_id
INNER JOIN '.TBL_CATEGORIES.'
ON cat_id = rol_cat_id
WHERE rol_valid = 1
AND mem_begin <= \''.DATE_NOW.'\'
AND mem_end > \''.DATE_NOW.'\'
AND mem_usr_id = '.$user->getValue('usr_id').'
AND ( cat_org_id = '.$this->organizationId.'
OR cat_org_id IS NULL ) ';
$listViewStatement = $this->db->query($sql);
if($listViewStatement->rowCount() > 0)
{
while($row = $listViewStatement->fetch())
{
if($row['rol_this_list_view'] == 2)
{
// alle angemeldeten Benutzer duerfen Rollenlisten/-profile sehen
return true;
}
if($row['rol_this_list_view'] == 1
&& array_key_exists($row['rol_id'], $this->listViewRights) && $this->listViewRights[$row['rol_id']])
{
// nur Rollenmitglieder duerfen Rollenlisten/-profile sehen
return true;
}
}
}
return false;
}
/**
* Check if the user of this object has the right to view the role that is set in the parameter.
* @param int $roleId The id of the role that should be checked.
* @return bool Return @b true if the user has the right to view the role otherwise @b false.
*/
public function hasRightViewRole($roleId)
{
return $this->hasRightRole($this->listMailRights, 'rol_all_lists_view', $roleId);
}
/**
* Checks if the user is assigned to the role @b Administrator
* @return bool Returns @b true if the user is a member of the role @b Administrator
*/
public function isAdministrator()
{
$this->checkRolesRight();
return $this->administrator;
}
/**
* check if user is leader of a role
* @param int $roleId
* @return bool
*/
public function isLeaderOfRole($roleId)
{
return array_key_exists($roleId, $this->rolesMembershipLeader);
}
/**
* check if user is member of a role
* @param int $roleId
* @return bool
*/
public function isMemberOfRole($roleId)
{
return in_array((int) $roleId, $this->rolesMembership, true);
}
/**
* Checks if the user is assigned to the role @b Administrator
* @deprecated 3.2.0:4.0.0 Use Method isAdministrator() instead
* @return bool Returns @b true if the user is a member of the role @b Administrator
* @see User#isAdministrator
*/
public function isWebmaster()
{
return $this->isAdministrator();
}
/**
* If this method is called than all further calls of method @b setValue will not check the values.
* The values will be stored in database without any inspections!
* @return void
*/
public function noValueCheck()
{
$this->mProfileFieldsData->noValueCheck();
}
/**
* Reads a user record out of the table adm_users in database selected by the unique user id.
* Also all profile fields of the object @b mProfileFieldsData will be read.
* @param int $userId Unique id of the user that should be read
* @return bool Returns @b true if one record is found
*/
public function readDataById($userId)
{
if(parent::readDataById($userId))
{
// read data of all user fields from current user
$this->mProfileFieldsData->readUserData($userId, $this->organizationId);
return true;
}
return false;
}
/**
* Initialize all rights and role membership arrays so that all rights and
* role memberships will be read from database if another method needs them
* @return void
*/
public function renewRoleData()
{
// initialize rights arrays
$this->roles_rights = array();
$this->listViewRights = array();
$this->listMailRights = array();
$this->rolesMembership = array();
$this->rolesMembershipLeader = array();
$this->rolesMembershipNoLeader = array();
}
/**
* Save all changed columns of the recordset in table of database. Therefore the class remembers if it's a new
* record or if only an update is necessary. The update statement will only update the changed columns.
* If the table has columns for creator or editor than these column with their timestamp will be updated.
* First save recordset and then save all user fields. After that the session of this got a renew for the user object.
* If the user doesn't have the right to save data of this user than an exception will be thrown.
* @param bool $updateFingerPrint Default @b true. Will update the creator or editor of the recordset
* if table has columns like @b usr_id_create or @b usr_id_changed
* @throws AdmException
* @return bool
*/
public function save($updateFingerPrint = true)
{
global $gCurrentSession, $gCurrentUser;
// if current user is not new and is not allowed to edit this user
// and saveChangesWithoutRights isn't true than throw exception
if ($this->getValue('usr_id') > 0 && !$gCurrentUser->hasRightEditProfile($this) && !$this->saveChangesWithoutRights) {
throw new AdmException('The profile data of user ' . $this->getValue('FIRST_NAME') . ' '
. $this->getValue('LAST_NAME') . ' could not be saved because you don\'t have the right to do this.');
}
$this->db->startTransaction();
// if new user then set create id
$updateCreateUserId = false;
if ((int) $this->getValue('usr_id') === 0 && (int) $gCurrentUser->getValue('usr_id') === 0)
{
$updateCreateUserId = true;
$updateFingerPrint = false;
}
// if value of a field changed then update timestamp of user object
if (is_object($this->mProfileFieldsData) && $this->mProfileFieldsData->columnsValueChanged)
{
$this->columnsValueChanged = true;
}
$returnValue = parent::save($updateFingerPrint);
// if this was an registration then set this user id to create user id
if ($updateCreateUserId)
{
$this->setValue('usr_timestamp_create', DATETIME_NOW);
$this->setValue('usr_usr_id_create', $this->getValue('usr_id'));
$returnValue = $returnValue && parent::save($updateFingerPrint);
}
if (is_object($this->mProfileFieldsData))
{
// save data of all user fields
$this->mProfileFieldsData->saveUserData((int) $this->getValue('usr_id'));
}
if ($this->columnsValueChanged && is_object($gCurrentSession))
{
// now set user object in session of that user to invalid,
// because he has new data and maybe new rights
$gCurrentSession->renewUserObject($this->getValue('usr_id'));
}
$this->db->endTransaction();
return $returnValue;
}
/**
* If this method is set then a user can save changes to the user if he hasn't the necessary rights
* @return void
*/
public function saveChangesWithoutRights()
{
$this->saveChangesWithoutRights = true;
}
/**
* Set the id of the organization which should be used in this user object.
* The organization is used to read the rights of the user. If @b setOrganization isn't called
* than the default organization @b gCurrentOrganization is set for the current user object.
* @param int $organizationId Id of the organization
* @return void
*/
public function setOrganization($organizationId)
{
$this->organizationId = (int) $organizationId;
$this->roles_rights = array();
}
/**
* Set a new value for a password column of the database table.
* The value is only saved in the object. You must call the method @b save to store the new value to the database
* @param string $newPassword The new value that should be stored in the database field
* @param bool $isNewPassword Should the column password or new_password be set
* @param bool $doHashing Should the password get hashed before inserted. Default is true
* @return bool Returns @b true if the value is stored in the current object and @b false if a check failed
*/
public function setPassword($newPassword, $isNewPassword = false, $doHashing = true)
{
global $gPreferences, $gPasswordHashAlgorithm;
$columnName = 'usr_password';
if($isNewPassword)
{
$columnName = 'usr_new_password';
}
if($doHashing)
{
// get the saved cost value that fits your server performance best and rehash your password
$cost = 10;
if(isset($gPreferences) && array_key_exists('system_hashing_cost', $gPreferences))
{
$cost = (int) $gPreferences['system_hashing_cost'];
}
$newPasswordHash = PasswordHashing::hash($newPassword, $gPasswordHashAlgorithm, array('cost' => $cost));
if ($newPasswordHash === false)
{
return false;
}
}
return parent::setValue($columnName, $newPassword, false);
}
/**
* @param string $mode 'set' or 'edit'
* @param int $id Id of the role for which the membership should be set,
* or id of the current membership that should be edited.
* @param string $startDate New start date of the membership. Default will be @b DATE_NOW.
* @param string $endDate New end date of the membership. Default will be @b 31.12.9999
* @param bool $leader If set to @b 1 then the member will be leader of the role and
* might get more rights for this role.
* @return bool Return @b true if the membership was successfully added/edited.
*/
private function changeRoleMembership($mode, $id, $startDate, $endDate, $leader)
{
if ($startDate === '' || $endDate === '')
{
return false;
}
$minStartDate = $startDate;
$maxEndDate = $endDate;
$this->db->startTransaction();
if ($mode === 'set')
{
// subtract 1 day from start date so that we find memberships that ends yesterday
// these memberships can be continued with new date
$oneDayOffset = new DateInterval('P1D');
$startDate = DateTime::createFromFormat('Y-m-d', $startDate)->sub($oneDayOffset)->format('Y-m-d');
// add 1 to max date because we subtract one day if a membership ends
if ($endDate !== '9999-12-31')
{
$endDate = DateTime::createFromFormat('Y-m-d', $endDate)->add($oneDayOffset)->format('Y-m-d');
}
}
// search for membership with same role and user and overlapping dates
if ($mode === 'set')
{
$member = new TableMembers($this->db);
$sql = 'SELECT *
FROM '.TBL_MEMBERS.'
WHERE mem_rol_id = '.$id.'
AND mem_usr_id = '.$this->getValue('usr_id').'
AND mem_begin <= \''.$endDate.'\'
AND mem_end >= \''.$startDate.'\'
ORDER BY mem_begin ASC';
}
else
{
$member = new TableMembers($this->db, $id);
$sql = 'SELECT *
FROM '.TBL_MEMBERS.'
WHERE mem_id <> '.$id.'
AND mem_rol_id = '.$member->getValue('mem_rol_id').'
AND mem_usr_id = '.$this->getValue('usr_id').'
AND mem_begin <= \''.$endDate.'\'
AND mem_end >= \''.$startDate.'\'
ORDER BY mem_begin ASC';
}
$membershipStatement = $this->db->query($sql);
if ($membershipStatement->rowCount() === 1)
{
// one record found than update this record
$row = $membershipStatement->fetch();
$member->setArray($row);
// save new start date if an earlier date exists
if (strcmp($minStartDate, $member->getValue('mem_begin', 'Y-m-d')) > 0)
{
$minStartDate = $member->getValue('mem_begin', 'Y-m-d');
}
if ($mode === 'set')
{
// save new end date if an later date exists
// but only if end date is greater than the begin date otherwise the membership should be deleted
if (strcmp($member->getValue('mem_end', 'Y-m-d'), $maxEndDate) > 0
&& strcmp($member->getValue('mem_begin', 'Y-m-d'), $maxEndDate) < 0)
{
$maxEndDate = $member->getValue('mem_end', 'Y-m-d');
}
}
else
{
// save new end date if an later date exists
if (strcmp($member->getValue('mem_end', 'Y-m-d'), $maxEndDate) > 0)
{
$maxEndDate = $member->getValue('mem_end', 'Y-m-d');
}
}
}
elseif ($membershipStatement->rowCount() > 1)
{
// several records found then read min and max date and delete all records
while ($row = $membershipStatement->fetch())
{
$member->clear();
$member->setArray($row);
// save new start date if an earlier date exists
if (strcmp($minStartDate, $member->getValue('mem_begin', 'Y-m-d')) > 0)
{
$minStartDate = $member->getValue('mem_begin', 'Y-m-d');
}
// save new end date if an later date exists
if (strcmp($member->getValue('mem_end', 'Y-m-d'), $maxEndDate) > 0)
{
$maxEndDate = $member->getValue('mem_end', 'Y-m-d');
}
// delete existing entry because a new overlapping entry will be created
$member->delete();
}
$member->clear();
}
if (strcmp($minStartDate, $maxEndDate) > 0)
{
// if start date is greater than end date than delete membership
if ($member->getValue('mem_id') > 0)
{
$member->delete();
}
$returnStatus = true;
}
else
{
// save membership to database
if ($mode === 'set')
{
$member->setValue('mem_rol_id', $id);
$member->setValue('mem_usr_id', $this->getValue('usr_id'));
}
$member->setValue('mem_begin', $minStartDate);
$member->setValue('mem_end', $maxEndDate);
if ($leader !== null)
{
$member->setValue('mem_leader', $leader);
}
$returnStatus = $member->save();
}
$this->db->endTransaction();
$this->renewRoleData();
return $returnStatus;
}
/**
* Create a new membership to a role for the current user. If the date range contains
* a future or past membership of the same role then the two memberships will be merged.
* In opposite to setRoleMembership this method can't be used to end a membership earlier!
* @param int $roleId Id of the role for which the membership should be set.
* @param string $startDate Start date of the membership. Default will be @b DATE_NOW.
* @param string $endDate End date of the membership. Default will be @b 31.12.9999
* @param bool $leader If set to @b 1 then the member will be leader of the role and
* might get more rights for this role.
* @return bool Return @b true if the membership was successfully added.
*/
public function setRoleMembership($roleId, $startDate = DATE_NOW, $endDate = '9999-12-31', $leader = null)
{
return $this->changeRoleMembership('set', $roleId, $startDate, $endDate, $leader);
}
/**
* Edit an existing role membership of the current user. If the new date range contains
* a future or past membership of the same role then the two memberships will be merged.
* In opposite to setRoleMembership this method is useful to end a membership earlier.
* @param int $memberId Id of the current membership that should be edited.
* @param string $startDate New start date of the membership. Default will be @b DATE_NOW.
* @param string $endDate New end date of the membership. Default will be @b 9999-12-31
* @param bool $leader If set to @b 1 then the member will be leader of the role and
* might get more rights for this role.
* @return bool Return @b true if the membership was successfully edited.
*/
public function editRoleMembership($memberId, $startDate = DATE_NOW, $endDate = '9999-12-31', $leader = null)
{
return $this->changeRoleMembership('edit', $memberId, $startDate, $endDate, $leader);
}
/**
* Set a new value for a column of the database table if the column has the prefix @b usr_
* otherwise the value of the profile field of the table adm_user_data will set.
* If the user log is activated than the change of the value will be logged in @b adm_user_log.
* The value is only saved in the object. You must call the method @b save to store the new value to the database
* @param string $columnName The name of the database column whose value should get a new value or the
* internal unique profile field name
* @param mixed $newValue The new value that should be stored in the database field
* @param bool $checkValue The value will be checked if it's valid. If set to @b false than the value will
* not be checked.
* @return bool Returns @b true if the value is stored in the current object and @b false if a check failed
* @par Examples
* @code
* // set data of adm_users column
* $gCurrentUser->getValue('usr_login_name', 'Admidio');
* // reads data of adm_user_fields
* $gCurrentUser->getValue('EMAIL', 'webmaster@admidio.org');
* @endcode
*/
public function setValue($columnName, $newValue, $checkValue = true)
{
global $gCurrentUser, $gPreferences;
// users data from adm_users table
if (strpos($columnName, 'usr_') === 0)
{
// don't change user password; use $user->setPassword()
if ($columnName === 'usr_password' || $columnName === 'usr_new_password')
{
return false;
}
// username should not contain special characters
if ($columnName === 'usr_login_name' && $newValue !== '' && !strValidCharacters($newValue, 'noSpecialChar'))
{
return false;
}
return parent::setValue($columnName, $newValue, $checkValue);
}
// user data from adm_user_fields table
$oldFieldValue = $this->mProfileFieldsData->getValue($columnName, 'database');
$newValue = (string) $newValue;
// only to a update if value has changed
if (strcmp($oldFieldValue, $newValue) === 0) // https://secure.php.net/manual/en/function.strcmp.php#108563
{
return true;
}
$usrId = (int) $this->getValue('usr_id');
$returnCode = false;
// Disabled fields can only be edited by users with the right "edit_users" except on registration.
// Here is no need to check hidden fields because we check on save() method that only users who
// can edit the profile are allowed to save and change data.
if ($this->mProfileFieldsData->getProperty($columnName, 'usf_disabled') == 0
|| ($this->mProfileFieldsData->getProperty($columnName, 'usf_disabled') == 1
&& $gCurrentUser->hasRightEditProfile($this, false))
|| ($usrId === 0 && (int) $gCurrentUser->getValue('usr_id') === 0))
{
$returnCode = $this->mProfileFieldsData->setValue($columnName, $newValue);
}
// Nicht alle Aenderungen werden geloggt. Ausnahmen:
// Felder, die mit usr_ beginnen
// Felder, die sich nicht geändert haben
// Wenn usr_id ist 0 (der User neu angelegt wird; Das wird bereits dokumentiert)
if ($returnCode && $usrId > 0 && $gPreferences['profile_log_edit_fields'] == 1)
{
$logEntry = new TableAccess($this->db, TBL_USER_LOG, 'usl');
$logEntry->setValue('usl_usr_id', $usrId);
$logEntry->setValue('usl_usf_id', $this->mProfileFieldsData->getProperty($columnName, 'usf_id'));
$logEntry->setValue('usl_value_old', $oldFieldValue);
$logEntry->setValue('usl_value_new', $newValue);
$logEntry->setValue('usl_comm', '');
$logEntry->save();
}
return $returnCode;
}
/**
* Update login data for this user. These are timestamps of last login and reset count
* and timestamp of invalid logins.
* @return void
*/
public function updateLoginData()
{
$this->saveChangesWithoutRights();
$this->setValue('usr_last_login', $this->getValue('usr_actual_login', 'Y-m-d H:i:s'));
$this->setValue('usr_number_login', $this->getValue('usr_number_login') + 1);
$this->setValue('usr_actual_login', DATETIME_NOW);
$this->setValue('usr_date_invalid', null);
$this->setValue('usr_number_invalid', 0);
$this->save(false); // Zeitstempel nicht aktualisieren // TODO Exception handling
}
/**
* Funktion prueft, ob der angemeldete User Ankuendigungen anlegen und bearbeiten darf
* @return bool
*/
public function editAnnouncements()
{
return $this->checkRolesRight('rol_announcements');
}
/**
* Funktion prueft, ob der angemeldete User Registrierungen bearbeiten und zuordnen darf
* @return bool
*/
public function approveUsers()
{
return $this->checkRolesRight('rol_approve_users');
}
/**
* Checks if the user has the right to assign members to at least one role.
* @return bool Return @b true if the user can assign members to at least one role.
*/
public function assignRoles()
{
$this->checkRolesRight();
return $this->assignRoles;
}
/**
* Checks if the user has the right to manage roles. Therefore he must be a member
* of a role with the right @b rol_manage_roles.
* @return bool Return @b true if the user can manage roles.
*/
public function manageRoles()
{
return $this->checkRolesRight('rol_assign_roles');
}
/**
* Funktion prueft, ob der angemeldete User Termine anlegen und bearbeiten darf
* @return bool
*/
public function editDates()
{
return $this->checkRolesRight('rol_dates');
}
/**
* Funktion prueft, ob der angemeldete User Downloads hochladen und verwalten darf
* @return bool
*/
public function editDownloadRight()
{
return $this->checkRolesRight('rol_download');
}
/**
* Funktion prueft, ob der angemeldete User fremde Benutzerdaten bearbeiten darf
* @return bool
*/
public function editUsers()
{
return $this->checkRolesRight('rol_edit_user');
}
/**
* Funktion prueft, ob der angemeldete User Gaestebucheintraege loeschen und editieren darf
* @return bool
*/
public function editGuestbookRight()
{
return $this->checkRolesRight('rol_guestbook');
}
/**
* Funktion prueft, ob der angemeldete User Gaestebucheintraege kommentieren darf
* @return bool
*/
public function commentGuestbookRight()
{
return $this->checkRolesRight('rol_guestbook_comments');
}
/**
* Funktion prueft, ob der angemeldete User Fotos hochladen und verwalten darf
* @return bool
*/
public function editPhotoRight()
{
return $this->checkRolesRight('rol_photo');
}
/**
* Funktion prueft, ob der angemeldete User Weblinks anlegen und editieren darf
* @return bool
*/
public function editWeblinksRight()
{
return $this->checkRolesRight('rol_weblinks');
}
/**
* Funktion prueft, ob der angemeldete User das Inventory verwalten darf
* @return bool
*/
public function editInventory()
{
return $this->checkRolesRight('rol_inventory');
}
}