Compare commits

..

183 Commits

Author SHA1 Message Date
jf-cbd
e1bd815094 WIP Tom Select options 2025-11-25 17:46:18 +01:00
Eric Espie
a19472cfd1 🎨 N°8772 - CS Fixer 2025-11-20 10:55:10 +01:00
Eric Espie
7b29d562c8 N°8772 - wip 2025-11-20 10:31:18 +01:00
Eric Espie
3e471edefd 🎨 N°8772 - Moved DI under Service 2025-11-19 15:27:18 +01:00
Eric Espie
bd44f971e4 🎨 N°8772 - CS Fixer 2025-11-19 14:49:20 +01:00
Eric Espie
65bd6d9fd0 Add ModelReflection Service as dependency injection + tests 2025-11-19 14:42:32 +01:00
jf-cbd
6678689b77 Fix wrong path for turbo 2025-11-19 11:04:36 +01:00
jf-cbd
8f05c2bcba Fix CI error (cf. 2651) 2025-11-19 10:52:33 +01:00
jf-cbd
4169e10eec Fix wrong path for turbo 2025-11-19 10:49:01 +01:00
Eric Espie
e95ce21188 Add sAPPROOTURL to the data of the twig 2025-11-19 10:06:16 +01:00
Eric Espie
24d78df21d 🎨 N°8772 - CS Fixer 2025-11-19 09:21:34 +01:00
Eric Espie
546912ad77 N°8772 - 2025-11-18 18:08:50 +01:00
jf-cbd
f93926528f Add Tom-Select lib 2025-11-18 17:18:46 +01:00
Eric Espie
0cb7c7359f N°8772 - AbstractFormIO tests 2025-11-18 16:45:11 +01:00
Eric Espie
7c0f454936 Runtime Model Reflection & namespace 2025-11-18 15:36:22 +01:00
Eric Espie
11973d61ec 🎨 CS Fixer 2025-11-18 14:52:10 +01:00
Eric Espie
e08835c1a2 N°8772 - AbstractFormIO tests 2025-11-18 14:00:41 +01:00
Eric Espie
8ecb36b1fe N°8772 - FormBinding tests 2025-11-18 11:24:05 +01:00
Eric Espie
6a4ed98299 Merge remote-tracking branch 'origin/develop' into feature/8772_form_dependencies_manager 2025-11-18 09:54:29 +01:00
Eric Espie
2a8ed931e9 N°8772 - AbstractFormIO and FormBinding tests 2025-11-18 09:25:37 +01:00
Eric Espie
07a61d5f0d N°8772 - AbstractFormIO and FormBinding tests 2025-11-17 17:26:47 +01:00
Eric Espie
047c820466 N°8772 - AbstractFormIO and FormBinding tests 2025-11-17 17:26:12 +01:00
jf-cbd
bc4d50dd0b ✏️ fix a typo 2025-11-17 17:14:15 +01:00
Vincent Dumas
e21a541b70 N°8533 - Impact Analysis, add icons and tooltips in shortcut_actions (#767)
* N°8533 - Impact Analysis, add icons and tooltips in shortcut_actions
2025-11-17 15:55:05 +01:00
v-dumas
ed360edb83 Fix PHP CS 2025-11-17 15:04:19 +01:00
Benjamin Dalsass
753d0acce4 N°8772 - dynamic form 2025-11-17 14:51:11 +01:00
Vincent Dumas
53de040934 N°8534 - Prevent Admin, SuperUser from loose of rights (#774)
* N°8534 - Prevent Admin & SuperUser from suicide
Prevent creation/modification of Administrator, SuperUser, REST User, combined with a Profile denying access to the backoffice
2025-11-17 14:17:18 +01:00
odain
b8345de553 Merge branch 'support/3.2' into develop 2025-11-16 08:15:29 +01:00
odain
fd10887849 N°8306 - ci fixes
php code style
2025-11-16 08:15:03 +01:00
odain
e09987e442 Merge branch 'support/3.2' into develop 2025-11-15 21:29:52 +01:00
odain
6d5660ca67 fix code style 2025-11-15 21:28:38 +01:00
odain
0013b8cfee Merge branch 'designer-3.2.1' into support/3.2 2025-11-15 21:27:37 +01:00
odain
7fb0ae48f9 Fix deprecated warning
<b>Deprecated</b>:  Return type of Combodo\iTop\DesignDocument::loadXML(string $source, int $options = 0) should either be compatible with DOMDocument::loadXML(string $source, int $options = 0): bool, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in <b>/var/www/html/iTop/core/designdocument.class.inc.php</b> on line <b>73</b><br />
2025-11-15 21:26:36 +01:00
odain
e89a8edae0 N°8306 - fix MFEException use 2025-11-15 21:19:01 +01:00
Vincent Dumas
262cc3c206 N°5882 - AuditRule: Add Owner and Process (#775)
* N°5882 - Audit Rule: Add "Owner" and "Correction Process" fields
* Fix PHP CS
2025-11-14 17:04:25 +01:00
Eric Espie
51ebbc4274 N°8772 - Refactor 2025-11-14 16:42:42 +01:00
Eric Espie
3085023267 N°8772 - Error message 2025-11-14 16:24:18 +01:00
Eric Espie
e02fc9cb44 Merge dicos... 2025-11-14 16:14:34 +01:00
Eric Espie
ea95ae60a6 Merge remote-tracking branch 'origin/develop' into feature/8772_form_dependencies_manager 2025-11-14 16:08:37 +01:00
Eric Espie
b9d905ad1b N°8772 - refactor 2025-11-14 15:57:17 +01:00
Eric Espie
5b114285cc N°8772 - Error message 2025-11-14 15:39:16 +01:00
Eric Espie
b34566076e N°8772 - Form Expressions using iTop Expressions 2025-11-14 15:33:47 +01:00
odain
b5fe12ca3c Merge branch 'issue/fix-deprecated-aftermerge' into develop 2025-11-14 14:34:22 +01:00
odain
6d279647f1 fix deprecated warnings
fix call to MFException constr
2025-11-14 14:33:52 +01:00
Benjamin Dalsass
750b2b9cfa Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager 2025-11-14 14:32:56 +01:00
Benjamin Dalsass
bdde63a39c N°8772 - dynamic form 2025-11-14 14:30:50 +01:00
Eric Espie
891df6ab1c N°8772 - Expressions inputs are now :input instead of [[input]] (and quotes are added automatically) 2025-11-14 14:05:22 +01:00
odain
299c468eaa fix code style - remaining itop-portal-base/portal/config/bootstrap.php 2025-11-14 10:54:02 +01:00
Benjamin Dalsass
dc1ce2dc64 Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager
# Conflicts:
#	lib/composer/autoload_classmap.php
#	lib/composer/autoload_static.php
#	sources/Forms/Block/Base/ChoiceFormBlock.php
#	sources/Forms/IO/Format/StringIOFormat.php
2025-11-14 10:53:42 +01:00
odain
7bbcc388ea Merge branch 'support/3.2' into develop 2025-11-14 10:52:27 +01:00
Benjamin Dalsass
e5058fb8f7 N°8772 - dynamic form 2025-11-14 10:50:57 +01:00
odain
5b7a5e14a3 code style fix 2025-11-14 10:41:47 +01:00
odain
2b1ecf15b4 Merge branch 'support/3.2.1' into support/3.2 2025-11-14 10:39:04 +01:00
odain
f6366057c9 Merge branch 'designer-3.2.1' into support/3.2.1 2025-11-14 10:18:46 +01:00
jf-cbd
41a90b5033 Update datamodel.itop-request-mgmt.xml 2025-11-14 10:11:45 +01:00
v-dumas
67018b9b17 N°8768 - Fix PHP CS in dictionnaries 2025-11-14 09:40:17 +01:00
Vincent Dumas
fa8ecb956e N°8776, N°8623, N°8496, N°8445, N°8378, N°8040 & N°7755 (#769)
* N°8776 - Move Attachemnt above caselog in the UR form in the portal
* N°8623 - French dictionaries, fix missing entries
* N°8496 - Add tooltips on Known Error class
* N°8445 - Color "Priority" on Userrequest & Incident in ITIL
* N°8378 - Missing rights on incident for SuperUser
* N°8040 - FR dico replacing left "Statut" by "Etat"
* N°7755 - Add tto_time_spent and ttr_time_spent on standard datamodel
2025-11-14 09:33:48 +01:00
Vincent Dumas
58eae4dde3 N°7472 - Team Tickets tab replaced by a Dashboard (#776)
* N°640 - No 'Tickets' tab on FunctionalCIs when no Ticket sub-classes exists

* N°7472 - Team Tickets tab replaced by a Dashboard

* N°7472 - Team Tickets tab replaced by a Dashboard (2)

* N°7472 - Team Tickets tab replaced by a Dashboard (3)
2025-11-14 09:08:16 +01:00
Vincent Dumas
d098a5eb87 N°8845 - Set request_type regardless of User rights (#777)
* N°8845 - Set request_type regardless of User rights

* Update datamodels/2.x/itop-request-mgmt/datamodel.itop-request-mgmt.xml

Co-authored-by: Thomas Casteleyn <thomas.casteleyn@super-visions.com>

---------

Co-authored-by: Thomas Casteleyn <thomas.casteleyn@super-visions.com>
2025-11-14 09:05:54 +01:00
v-dumas
8597dea398 N°8768 - Fix PHP CS in dictionnaries 2025-11-14 09:02:54 +01:00
v-dumas
a6972af266 N°8768 - Missing lnkActionNotificationToContact translation 2025-11-13 17:36:18 +01:00
Eric Espie
f68082da96 N°8772 - Dashlet group by 2025-11-13 17:10:39 +01:00
jf-cbd
7733f13d14 Add Tom-Select lib 2025-11-13 16:43:49 +01:00
Eric Espie
cef8fbc859 N°8772 - Dashlet group by 2025-11-13 16:42:04 +01:00
Fabrice VINCENT
066b27c982 fix testing MySQLBinDir (#770) 2025-11-13 16:37:50 +01:00
v-dumas
283de1ef7c N°8768 - Fix code style & duplicated dico entries 2025-11-13 16:27:10 +01:00
Eric Espie
36d49d3550 N°8772 - wip 2025-11-13 15:02:09 +01:00
Vincent Dumas
8b00016115 N°8768 - Fix deletion of Person notified (#779)
* N°8768 - Fix deletion of Person notified
2025-11-13 14:53:23 +01:00
odain
b5c79e1d75 N°8912 - Cannot work on a licence with legacy extensions including modules without explicit version 2025-11-13 11:13:33 +01:00
Eric Espie
c2ec3a9f02 N°8772 - remove unused class 2025-11-13 09:36:36 +01:00
Benjamin Dalsass
4d159ea3f1 Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager 2025-11-12 17:11:29 +01:00
Benjamin Dalsass
5cacfcb754 N°8772 - dynamic form 2025-11-12 17:09:40 +01:00
Eric Espie
101b1b217e N°8772 - remove debug if not wanted like in config edition 2025-11-12 14:23:19 +01:00
Eric Espie
5af8adf7ce N°8772 - fix debug display 2025-11-12 13:07:37 +01:00
Benjamin Dalsass
3d2485a004 N°8772 - dynamic form 2025-11-12 09:33:29 +01:00
Benjamin Dalsass
cbb0e2ef7e N°8772 - dynamic form 2025-11-12 08:33:28 +01:00
Benjamin Dalsass
7095e5e959 Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager 2025-11-12 08:24:04 +01:00
Benjamin Dalsass
7fd27913f4 N°8772 - dynamic form 2025-11-12 08:20:17 +01:00
v-dumas
dd82950eee N°8832 - Fix typo in FR translation 2025-11-10 16:48:37 +01:00
Stephen Abello
2e8b48ce47 Merge branch 'support/3.2' into develop 2025-11-10 10:56:38 +01:00
Stephen Abello
80d4e65a81 N°8006 - Make CKEditor dropdowns visible when colliding with an input in the backoffice 2025-11-10 10:53:38 +01:00
odain
b0a792afab N°8796 - Add PHP code style validation in iTop and extensions - format whole code base 2025-11-07 20:39:38 +01:00
odain
7681c157ec Merge branch 'support/3.2' into develop 2025-11-07 20:33:14 +01:00
odain
4a9a85458d N°8796 - fix ci jo regression due to code style formatting 2025-11-07 16:04:23 +01:00
odain
890a2568c8 N°8796 - Add PHP code style validation in iTop and extensions - format whole code base 2025-11-07 15:39:53 +01:00
odain-cbd
12f23113f5 N°8796 - Add PHP code style validation in iTop and extensions (#757)
* poc php-cs-fixer

* PSR2 for now

* PSR12 + array short

* move php-cs-fixer stuff in tests/php-code-style

* add README

* fix php-cs-fixer move into php-code-style

* illustrate code reformatting on webservices folder

* phpstan: change composer php requirements

* indent with tabs + inception style applied everywhere even php-cs-fixer itself

* use tabs for code style indentation

* format concat with spaces

* finalize included/excluded folders to formatting tool

* add trailing_comma_in_multiline option

* adapt composer.json requirements

* Revert changes on webservices folder
2025-11-07 15:12:03 +01:00
Eric Espie
cfdf4121d3 N°8772 - Dynamic debug and error 2025-11-07 11:24:31 +01:00
Benjamin Dalsass
a448f668bc N°8772 - dynamic form 2025-11-07 11:00:15 +01:00
Eric Espie
b6ec29c6ec N°8772 - ExpressionFormBlock WIP 2025-11-06 17:12:25 +01:00
Stephen Abello
6cf6e7dd8d Merge branch 'support/3.2' into develop
# Conflicts:
#	core/simplecrypt.class.inc.php
#	tests/php-unit-tests/unitary-tests/core/SympleCryptTest.php
2025-11-06 10:27:03 +01:00
Eric Espie
03c37f2021 N°8772 - Fix IO tests 2025-11-05 16:54:18 +01:00
Benjamin Dalsass
5b7a1ee44f N°8772 - dynamic form 2025-11-05 15:52:23 +01:00
Timmy38
d4183acfde N°8762 - Allow extensions uninstallation at setup 2025-11-05 15:52:03 +01:00
Eric Espie
9ea546ebf6 N°8772 - Turbo + Collections WIP 2025-11-05 11:19:03 +01:00
Eric Espie
8fdad7997e N°8772 - Turbo Ok 2025-11-05 10:15:58 +01:00
Eric Espie
b3ed7f4f5b N°8772 - UIBlocks 2025-11-04 17:36:44 +01:00
jf-cbd
4f4ba7167d WIP 2025-11-04 17:02:56 +01:00
Anne-Cath
26f21ee6eb N°4250 - Problem with unencryption when the attribute is empty
N°4058 - Setup failed when added an encrypted field due to default value NULL non SODIUM compatible
2025-11-04 15:25:53 +01:00
Eric Espie
a092b65be7 N°8772 - WIP dependencies - Does not work yet 2025-11-04 15:22:14 +01:00
Eric Espie
5a1f6ffde9 N°8772 - WIP dependencies - Does not work yet 2025-11-04 09:05:29 +01:00
jf-cbd
c5fb116052 📝 Update CONTRIBUTING.md after Hacktoberfest 2025-11-03 17:46:43 +01:00
Benjamin Dalsass
0909ddfb3a N°8772 - dynamic form 2025-11-03 14:01:32 +01:00
Benjamin Dalsass
20da9664c2 N°8772 - dynamic form 2025-11-03 13:50:07 +01:00
Benjamin Dalsass
68d2038488 N°8772 - dynamic form 2025-11-03 13:47:07 +01:00
Eric Espie
4c9373d034 N°8772 - Fix error 2025-11-03 10:07:49 +01:00
odain
bdc8fdd02f N°4720 - fix Deprecation warnings with ormLinkSet->UpdateFromCompleteList API 2025-11-03 08:37:35 +01:00
Eric Espie
0d7ccd7d82 N°8772 - Moved debug forms 2025-10-31 16:48:06 +01:00
jf-cbd
077c48870f Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager 2025-10-31 16:44:03 +01:00
jf-cbd
5df44b8a18 Remove .compilation-symlinks 2025-10-31 16:42:30 +01:00
Eric Espie
d4415d6c3a N°8772 - some tests 2025-10-31 14:35:44 +01:00
Eric Espie
0196765eb6 N°8772 - automatic dependency in controller WIP 2025-10-31 08:58:50 +01:00
Eric Espie
45e4d9239c N°8772 - automatic dependency in controller WIP 2025-10-31 08:55:45 +01:00
Stephen Abello
adfa800063 N°7939 - Improve activity panel tab togglers when there's more than 2 log attributes (#766) 2025-10-30 16:38:38 +01:00
Eric Espie
0df54413b3 N°8772 - cleanup code 2025-10-30 14:24:09 +01:00
Eric Espie
601cde0e2d N°8772 - Traditional parameters declaration 2025-10-30 14:16:36 +01:00
Eric Espie
4c10cfee60 N°8772 - Errors & turbo 2025-10-30 11:53:29 +01:00
Eric Espie
7a6f36b395 N°8772 - Debug & turbo 2025-10-30 10:00:12 +01:00
Eric Espie
06dbdcb5cd N°8772 - Turbo WIP 2025-10-29 16:52:19 +01:00
Benjamin Dalsass
c00bcbcd81 Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager 2025-10-29 14:00:08 +01:00
Eric Espie
1394edc111 N°8772 - Turbo WIP
N°8772 - Twig factorization
2025-10-29 13:59:35 +01:00
Benjamin Dalsass
8582e89b8c Merge remote-tracking branch 'origin/feature/8772_form_dependencies_manager' into feature/8772_form_dependencies_manager
# Conflicts:
#	sources/Forms/Block/AbstractFormBlock.php
#	sources/Forms/Block/DataModel/AttributeValueChoiceFormBlock.php
#	templates/application/forms/itop_console_layout.html.twig
2025-10-29 13:31:02 +01:00
Benjamin Dalsass
6952bfa978 N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-29 13:14:15 +01:00
Eric Espie
98048219e7 N°8772 - Twig factorization 2025-10-29 09:31:40 +01:00
Eric Espie
8134d9a592 N°8772 - Form turbo stream WIP 2025-10-28 16:41:59 +01:00
Eric Espie
2a3de68652 N°8772 - Form turbo stream WIP 2025-10-28 15:34:19 +01:00
Stephen Abello
5df936c587 N°7982 - Allow select drop-down height to be customized through SCSS variable 2025-10-28 15:24:30 +01:00
Benjamin Dalsass
5d335b39d2 N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-28 15:22:29 +01:00
Stephen Abello
8056a63e82 N°8748 - Implement horizontal scroll for LongText attributes 2025-10-28 09:34:44 +01:00
Anne-Cath
775ac3df77 N°3815 - Remove "DisplayTemplate" PHP classes - TemplateMenuNode::GetHyperlink() must return '' 2025-10-27 17:26:37 +01:00
Stephen Abello
83927af8ed Merge branch 'support/3.2' into develop
# Conflicts:
#	addons/userrights/userrightsprofile.db.class.inc.php
#	addons/userrights/userrightsprojection.class.inc.php
#	datamodels/2.x/combodo-backoffice-darkmoon-theme/scss/scss-variables.scss
2025-10-27 16:00:08 +01:00
Stephen Abello
f1609168b7 N°8715 - Revert first fix attempt 2025-10-27 15:57:54 +01:00
Stephen Abello
4f845c63cf N°8715 - Missing name for SetUIBlock when initialized in twig 2025-10-27 15:57:11 +01:00
Timothee
d029039d22 N°6759 - Fix shortcut & dictionary entry name 2025-10-27 15:17:08 +01:00
odain
10a7fafe59 N°4720 - EOL restored 2025-10-27 10:25:44 +01:00
Eric Espie
c2fcf4144b N°8772 - Sub-forms WIP 2025-10-24 16:56:45 +02:00
Eric Espie
675db85131 N°8772 - log for exception 2025-10-24 15:44:41 +02:00
Benjamin Dalsass
212309e938 N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-24 15:42:33 +02:00
Benjamin Dalsass
a4fbe90579 N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-24 15:36:51 +02:00
odain
700b95e8c6 N°4720 - ease applystimuli support due to API deprecation removals 2025-10-24 15:14:30 +02:00
Benjamin Dalsass
eb3c5e4eee N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-24 14:46:59 +02:00
Benjamin Dalsass
33c03f9493 N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-24 09:29:53 +02:00
Benjamin Dalsass
243a525e15 N°8771 - Add Symfony form component to iTop core
- IO debug
2025-10-24 08:56:04 +02:00
Benjamin Dalsass
a1025ac837 N°8771 - Add Symfony form component to iTop core
- IO
2025-10-24 08:35:10 +02:00
Benjamin Dalsass
7708f8e00e N°8771 - Add Symfony form component to iTop core
- IO
2025-10-24 07:54:51 +02:00
Benjamin Dalsass
a51272f107 N°8771 - Add Symfony form component to iTop core
- IO
2025-10-24 07:15:35 +02:00
Benjamin Dalsass
5582afe5ae N°8771 - Add Symfony form component to iTop core
- add licence info
2025-10-24 06:37:22 +02:00
Eric Espie
21b786e0fa N°8772 - Form dependencies manager implementation - WIP 2025-10-23 16:57:35 +02:00
Eric Espie
fd449d195d N°8772 - Form dependencies manager implementation - WIP 2025-10-23 15:11:14 +02:00
Eric Espie
98c0b11db7 N°8772 - Form dependencies manager implementation - WIP 2025-10-23 13:51:24 +02:00
Benjamin Dalsass
8c3543363e N°8771 - Add Symfony form component to iTop core
- WIP
2025-10-23 13:29:04 +02:00
Benjamin Dalsass
5dea3f5299 N°8771 - Add Symfony form component to iTop core
- WIP
2025-10-23 12:11:02 +02:00
Benjamin Dalsass
239814a38c N°8771 - Add Symfony form component to iTop core
- restore branch
2025-10-23 11:28:01 +02:00
Benjamin Dalsass
c4e2cc6c1c Merge remote-tracking branch 'origin/develop' into feature/8772_form_dependencies_manager
# Conflicts:
#	sources/Application/TwigBase/Controller/Controller.php
2025-10-23 11:14:24 +02:00
Benjamin Dalsass
ee745f8be9 N°8772 - Form dependencies manager implementation
- turbo implementation
2025-10-23 11:11:51 +02:00
Benjamin Dalsass
1a4a64cec1 N°8772 - Form dependencies manager implementation 2025-10-23 11:11:39 +02:00
Benjamin Dalsass
834d4d461b N°8771 - Add Symfony form component to iTop core
- restore $aAdditionalPaths missing parameter
2025-10-23 11:10:59 +02:00
Eric Espie
5df73f5820 N°8781 - Improve twig base controller render error report 2025-10-23 11:10:54 +02:00
odain
c83d998924 N°4058 - fix PHP Deprecated base64_decodestrlen : Passing nul 2025-10-23 11:10:17 +02:00
Stephen Abello
ccdfbbe0bf N°8701 - Fix class icon alt text displaying in portal tile when there's no icon defined 2025-10-23 11:10:17 +02:00
Stephen Abello
6226ac8746 N°5228 - Make darkmoon and accessibility themes colors overloadable 2025-10-16 11:04:06 +02:00
Stephen Abello
e661e0bdbb N°8524 - Make grant matrix display correctly in darkmoon and make it accessible for color vision impaired 2025-10-16 10:36:53 +02:00
Stephen Abello
1d52665012 N°4460 - Make input error messages a bit more red in darkmoon 2025-10-15 16:33:32 +02:00
Stephen Abello
4aa0c19183 N°4460 - Add css rule to fix poor contrast in tagset add action when using darkmoon 2025-10-15 16:27:29 +02:00
Stephen Abello
809d4cd665 N°4460 - Add css rule to fix poor contrast in tagset placeholder when using darkmoon 2025-10-15 16:04:06 +02:00
Stephen Abello
0c3bc7f35b N°8392 - Fix poor contrast in autocompletes when using darkmoon 2025-10-15 15:49:16 +02:00
Anne-Cath
778c16da86 N°8663 - DoCheckToWrite fonction implode() 2025-09-29 14:33:52 +02:00
Eric Espie
5045ec4afa N°7722 - Fatal error on xml injection if xml entry "redefine" doesn't exist 2025-09-25 09:43:19 +02:00
Eric Espie
88e0f17164 N°8306 - Wrong line number error if XML is over 65535 lines 2025-08-26 11:56:44 +02:00
Eric Espie
de54676b9f N°7938 - Cant' create OnInsert/OnUpdate/Afterxxx methods from Designer with iTop 3.2 2025-07-21 16:53:13 +02:00
Eric Espie
e5129c9618 N°7938 - tooltip error style 2025-07-16 15:22:10 +02:00
Eric Espie
d0f816109b N°7938 - Cant' create OnInsert/OnUpdate/Afterxxx methods from Designer with iTop 3.2 2025-07-16 13:22:50 +02:00
Eric Espie
05642cdf84 N°8306 - Wrong line number error if XML is over 65535 lines 2025-07-10 16:53:36 +02:00
Eric Espie
031305cfbf Add stack trace to SQL errors
Reload object on modify error to display the real unmodified object
2025-07-07 13:44:45 +02:00
odain
471422b274 N°8306 : enhance MFEException constructor and remove boilerplate throw method 2025-06-20 08:08:42 +02:00
odain
5573a222c8 N°8286 - fix call to CompleteSessionData in case of no proper session content 2025-06-19 11:32:23 +02:00
odain
83eb2b81e3 N°8306 : fix ModelFactoryEx class not found 2025-06-18 16:25:53 +02:00
odain
86d2a3424d N°8306 - Wrong line number error if XML is over 65535 lines 2025-06-18 15:45:39 +02:00
Eric Espie
cd1c6f5ec5 N°8404 - Error when upgrading composant version on Designer (Migration status on licence) 2025-06-16 08:59:43 +02:00
Eric Espie
2ee30692ff Change deprecated calls 2025-05-22 15:02:29 +02:00
odain
9aa13f57d8 N°8413 - Make data synchro work on DBObject 2025-05-21 10:12:11 +02:00
odain
f9d9fcc440 N°7398-log level with invalid json 2025-05-07 11:03:13 +02:00
odain
a4a05a2579 N°7398 - be able to add custom data in session files generated by SessionHandler 2025-05-07 11:03:05 +02:00
Benjamin Dalsass
f44468b7a1 N°8245 - External key not saved in n-n link in edition (#703)
* N°8245 - External key not saved in n-n link in edition

* Remove the listener from the input element itself, put it on the body with a selector that matches our input

* Revert "N°8245 - External key not saved in n-n link in edition"

This reverts commit a756f9b159.

---------

Co-authored-by: Stephen Abello <stephen.abello@combodo.com>
2025-03-24 14:05:30 +01:00
2674 changed files with 115448 additions and 62967 deletions

View File

@@ -9,7 +9,7 @@ Any PRs not following the guidelines or with missing information will not be con
## Base information ## Base information
| Question | Answer | Question | Answer
|---------------------------------------------------------------|-------- |---------------------------------------------------------------|--------
| Related to a SourceForge thead / Another PR / Combodo ticket? | <!-- Put the URL --> | Related to a SourceForge thread / Another PR / Combodo ticket? | <!-- Put the URL -->
| Type of change? | Bug fix / Enhancement / Translations | Type of change? | Bug fix / Enhancement / Translations

View File

@@ -199,7 +199,7 @@ class DatamodelsXmlFiles extends AbstractGlobFileVersionUpdater
libxml_clear_errors(); libxml_clear_errors();
$oFileXml->formatOutput = true; $oFileXml->formatOutput = true;
$oFileXml->preserveWhiteSpace = false; $oFileXml->preserveWhiteSpace = false;
$oFileXml->loadXML($sFileContent); $oFileXml->loadXML($sFileContent, LIBXML_BIGLINES);
$oFileItopFormat = new iTopDesignFormat($oFileXml); $oFileItopFormat = new iTopDesignFormat($oFileXml);

View File

@@ -5,17 +5,6 @@ You want to contribute to iTop? Many thanks to you! 🎉 👍
Here are some guidelines that will help us integrate your work! Here are some guidelines that will help us integrate your work!
## Contributions
```
_ _ _ _ _ __ _
| | | | __ _ ___| | _| |_ ___ | |__ ___ _ __ / _| ___ ___| |_
| |_| |/ _` |/ __| |/ / __/ _ \| '_ \ / _ \ '__| |_ / _ \/ __| __|
| _ | (_| | (__| <| || (_) | |_) | __/ | | _| __/\__ \ |_
|_| |_|\__,_|\___|_|\_\\__\___/|_.__/ \___|_| |_| \___||___/\__|
```
This repository is part of Hacktoberfest. Contributions are welcome! Feel free to suggest improvements, add translation, fix bugs, or propose new features. Thank you for contributing !
### Subjects ### Subjects

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -29,56 +30,52 @@ class UserRightsBaseClassGUI extends cmdbAbstractObject
} }
} }
class URP_Profiles extends UserRightsBaseClassGUI class URP_Profiles extends UserRightsBaseClassGUI
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "addon/userrights,grant_by_profile,filter", "category" => "addon/userrights,grant_by_profile,filter",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"complementary_name_attcode" => array('description'), "complementary_name_attcode" => ['description'],
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_urp_profiles", "db_table" => "priv_urp_profiles",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
//MetaModel::Init_InheritAttributes(); //MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["allowed_values" => null, "sql" => "name", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("description", ["allowed_values" => null, "sql" => "description", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect("user_list", array("linked_class"=>"URP_UserProfile", "ext_key_to_me"=>"profileid", "ext_key_to_remote"=>"userid", "allowed_values"=>null, "count_min"=>1, "count_max"=>0, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect("user_list", ["linked_class" => "URP_UserProfile", "ext_key_to_me" => "profileid", "ext_key_to_remote" => "userid", "allowed_values" => null, "count_min" => 1, "count_max" => 0, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('name', 'description', 'user_list')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['name', 'description', 'user_list']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['description']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('name','description')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['name','description']); // Criteria of the std search form
MetaModel::Init_SetZListItems('default_search', array ('name','description')); MetaModel::Init_SetZListItems('default_search', ['name','description']);
} }
protected static $m_aCacheProfiles = null; protected static $m_aCacheProfiles = null;
public static function DoCreateProfile($sName, $sDescription) public static function DoCreateProfile($sName, $sDescription)
{ {
if (is_null(self::$m_aCacheProfiles)) if (is_null(self::$m_aCacheProfiles)) {
{ self::$m_aCacheProfiles = [];
self::$m_aCacheProfiles = array();
$oFilterAll = new DBObjectSearch('URP_Profiles'); $oFilterAll = new DBObjectSearch('URP_Profiles');
$oSet = new DBObjectSet($oFilterAll); $oSet = new DBObjectSet($oFilterAll);
while ($oProfile = $oSet->Fetch()) while ($oProfile = $oSet->Fetch()) {
{
self::$m_aCacheProfiles[$oProfile->Get('name')] = $oProfile->GetKey(); self::$m_aCacheProfiles[$oProfile->Get('name')] = $oProfile->GetKey();
} }
} }
$sCacheKey = $sName; $sCacheKey = $sName;
if (isset(self::$m_aCacheProfiles[$sCacheKey])) if (isset(self::$m_aCacheProfiles[$sCacheKey])) {
{
return self::$m_aCacheProfiles[$sCacheKey]; return self::$m_aCacheProfiles[$sCacheKey];
} }
$oNewObj = MetaModel::NewObject("URP_Profiles"); $oNewObj = MetaModel::NewObject("URP_Profiles");
@@ -89,27 +86,21 @@ class URP_Profiles extends UserRightsBaseClassGUI
return $iId; return $iId;
} }
function GetGrantAsHtml($oUserRights, $sClass, $sAction) public function GetGrantAsHtml($oUserRights, $sClass, $sAction)
{ {
$bGrant = $oUserRights->GetProfileActionGrant($this->GetKey(), $sClass, $sAction); $bGrant = $oUserRights->GetProfileActionGrant($this->GetKey(), $sClass, $sAction);
if (is_null($bGrant)) if (is_null($bGrant)) {
{ return '<span class="ibo-user-rights ibo-is-failure">'.Dict::S('UI:UserManagement:ActionAllowed:No').'</span>';
return '<span style="background-color: #ffdddd;">'.Dict::S('UI:UserManagement:ActionAllowed:No').'</span>'; } elseif ($bGrant) {
} return '<span class="ibo-user-rights ibo-is-success">'.Dict::S('UI:UserManagement:ActionAllowed:Yes').'</span>';
elseif ($bGrant) } else {
{ return '<span class="ibo-user-rights ibo-is-failure">'.Dict::S('UI:UserManagement:ActionAllowed:No').'</span>';
return '<span style="background-color: #ddffdd;">'.Dict::S('UI:UserManagement:ActionAllowed:Yes').'</span>';
}
else
{
return '<span style="background-color: #ffdddd;">'.Dict::S('UI:UserManagement:ActionAllowed:No').'</span>';
} }
} }
function DoShowGrantSumary($oPage) public function DoShowGrantSumary($oPage)
{
if ($this->GetRawName() == "Administrator")
{ {
if ($this->GetRawName() == "Administrator") {
// Looks dirty, but ok that's THE ONE // Looks dirty, but ok that's THE ONE
$oPage->p(Dict::S('UI:UserManagement:AdminProfile+')); $oPage->p(Dict::S('UI:UserManagement:AdminProfile+'));
return; return;
@@ -118,21 +109,18 @@ class URP_Profiles extends UserRightsBaseClassGUI
// Note: for sure, we assume that the instance is derived from UserRightsProfile // Note: for sure, we assume that the instance is derived from UserRightsProfile
$oUserRights = UserRights::GetModuleInstance(); $oUserRights = UserRights::GetModuleInstance();
$aDisplayData = array(); $aDisplayData = [];
foreach (MetaModel::GetClasses('bizmodel,grant_by_profile') as $sClass) foreach (MetaModel::GetClasses('bizmodel,grant_by_profile') as $sClass) {
{ $aStimuli = [];
$aStimuli = array(); foreach (MetaModel::EnumStimuli($sClass) as $sStimulusCode => $oStimulus) {
foreach (MetaModel::EnumStimuli($sClass) as $sStimulusCode => $oStimulus)
{
$bGrant = $oUserRights->GetClassStimulusGrant($this->GetKey(), $sClass, $sStimulusCode); $bGrant = $oUserRights->GetClassStimulusGrant($this->GetKey(), $sClass, $sStimulusCode);
if ($bGrant === true) if ($bGrant === true) {
{
$aStimuli[] = '<span title="'.$sStimulusCode.': '.utils::EscapeHtml($oStimulus->GetDescription()).'">'.utils::EscapeHtml($oStimulus->GetLabel()).'</span>'; $aStimuli[] = '<span title="'.$sStimulusCode.': '.utils::EscapeHtml($oStimulus->GetDescription()).'">'.utils::EscapeHtml($oStimulus->GetLabel()).'</span>';
} }
} }
$sStimuli = implode(', ', $aStimuli); $sStimuli = implode(', ', $aStimuli);
$aDisplayData[] = array( $aDisplayData[] = [
'class' => MetaModel::GetName($sClass), 'class' => MetaModel::GetName($sClass),
'read' => $this->GetGrantAsHtml($oUserRights, $sClass, 'r'), 'read' => $this->GetGrantAsHtml($oUserRights, $sClass, 'r'),
'bulkread' => $this->GetGrantAsHtml($oUserRights, $sClass, 'br'), 'bulkread' => $this->GetGrantAsHtml($oUserRights, $sClass, 'br'),
@@ -141,22 +129,22 @@ class URP_Profiles extends UserRightsBaseClassGUI
'delete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'd'), 'delete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'd'),
'bulkdelete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'bd'), 'bulkdelete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'bd'),
'stimuli' => $sStimuli, 'stimuli' => $sStimuli,
); ];
} }
$aDisplayConfig = array(); $aDisplayConfig = [];
$aDisplayConfig['class'] = array('label' => Dict::S('UI:UserManagement:Class'), 'description' => Dict::S('UI:UserManagement:Class+')); $aDisplayConfig['class'] = ['label' => Dict::S('UI:UserManagement:Class'), 'description' => Dict::S('UI:UserManagement:Class+')];
$aDisplayConfig['read'] = array('label' => Dict::S('UI:UserManagement:Action:Read'), 'description' => Dict::S('UI:UserManagement:Action:Read+')); $aDisplayConfig['read'] = ['label' => Dict::S('UI:UserManagement:Action:Read'), 'description' => Dict::S('UI:UserManagement:Action:Read+')];
$aDisplayConfig['bulkread'] = array('label' => Dict::S('UI:UserManagement:Action:BulkRead'), 'description' => Dict::S('UI:UserManagement:Action:BulkRead+')); $aDisplayConfig['bulkread'] = ['label' => Dict::S('UI:UserManagement:Action:BulkRead'), 'description' => Dict::S('UI:UserManagement:Action:BulkRead+')];
$aDisplayConfig['write'] = array('label' => Dict::S('UI:UserManagement:Action:Modify'), 'description' => Dict::S('UI:UserManagement:Action:Modify+')); $aDisplayConfig['write'] = ['label' => Dict::S('UI:UserManagement:Action:Modify'), 'description' => Dict::S('UI:UserManagement:Action:Modify+')];
$aDisplayConfig['bulkwrite'] = array('label' => Dict::S('UI:UserManagement:Action:BulkModify'), 'description' => Dict::S('UI:UserManagement:Action:BulkModify+')); $aDisplayConfig['bulkwrite'] = ['label' => Dict::S('UI:UserManagement:Action:BulkModify'), 'description' => Dict::S('UI:UserManagement:Action:BulkModify+')];
$aDisplayConfig['delete'] = array('label' => Dict::S('UI:UserManagement:Action:Delete'), 'description' => Dict::S('UI:UserManagement:Action:Delete+')); $aDisplayConfig['delete'] = ['label' => Dict::S('UI:UserManagement:Action:Delete'), 'description' => Dict::S('UI:UserManagement:Action:Delete+')];
$aDisplayConfig['bulkdelete'] = array('label' => Dict::S('UI:UserManagement:Action:BulkDelete'), 'description' => Dict::S('UI:UserManagement:Action:BulkDelete+')); $aDisplayConfig['bulkdelete'] = ['label' => Dict::S('UI:UserManagement:Action:BulkDelete'), 'description' => Dict::S('UI:UserManagement:Action:BulkDelete+')];
$aDisplayConfig['stimuli'] = array('label' => Dict::S('UI:UserManagement:Action:Stimuli'), 'description' => Dict::S('UI:UserManagement:Action:Stimuli+')); $aDisplayConfig['stimuli'] = ['label' => Dict::S('UI:UserManagement:Action:Stimuli'), 'description' => Dict::S('UI:UserManagement:Action:Stimuli+')];
$oPage->table($aDisplayConfig, $aDisplayData); $oPage->table($aDisplayConfig, $aDisplayData);
} }
function DisplayBareRelations(WebPage $oPage, $bEditMode = false) public function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
{ {
parent::DisplayBareRelations($oPage, $bEditMode); parent::DisplayBareRelations($oPage, $bEditMode);
@@ -166,10 +154,9 @@ class URP_Profiles extends UserRightsBaseClassGUI
public static function GetReadOnlyAttributes() public static function GetReadOnlyAttributes()
{ {
return array('name', 'description'); return ['name', 'description'];
} }
// returns an array of id => array of column => php value(so-called "real value") // returns an array of id => array of column => php value(so-called "real value")
public static function GetPredefinedObjects() public static function GetPredefinedObjects()
{ {
@@ -181,15 +168,13 @@ class URP_Profiles extends UserRightsBaseClassGUI
protected function OnDelete() protected function OnDelete()
{ {
// Don't remove admin profile // Don't remove admin profile
if ($this->Get('name') === ADMIN_PROFILE_NAME) if ($this->Get('name') === ADMIN_PROFILE_NAME) {
{
throw new SecurityException(Dict::Format('UI:Login:Error:AccessAdmin')); throw new SecurityException(Dict::Format('UI:Login:Error:AccessAdmin'));
} }
// Note: this may break the rule that says: "a user must have at least ONE profile" ! // Note: this may break the rule that says: "a user must have at least ONE profile" !
$oLnkSet = $this->Get('user_list'); $oLnkSet = $this->Get('user_list');
while($oLnk = $oLnkSet->Fetch()) while ($oLnk = $oLnkSet->Fetch()) {
{
$oLnk->DBDelete(); $oLnk->DBDelete();
} }
} }
@@ -202,11 +187,10 @@ class URP_Profiles extends UserRightsBaseClassGUI
* @param $sTargetState string The target state in which to evalutate the flags, if empty the current state will be used * @param $sTargetState string The target state in which to evalutate the flags, if empty the current state will be used
* @return integer Flags: the binary combination of the flags applicable to this attribute * @return integer Flags: the binary combination of the flags applicable to this attribute
*/ */
public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '') public function GetAttributeFlags($sAttCode, &$aReasons = [], $sTargetState = '')
{ {
$iFlags = parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState); $iFlags = parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState);
if (MetaModel::GetConfig()->Get('demo_mode')) if (MetaModel::GetConfig()->Get('demo_mode')) {
{
$aReasons[] = 'Sorry, profiles are read-only in the demonstration mode!'; $aReasons[] = 'Sorry, profiles are read-only in the demonstration mode!';
$iFlags |= OPT_ATT_READONLY; $iFlags |= OPT_ATT_READONLY;
} }
@@ -214,52 +198,52 @@ class URP_Profiles extends UserRightsBaseClassGUI
} }
} }
class URP_UserProfile extends UserRightsBaseClassGUI class URP_UserProfile extends UserRightsBaseClassGUI
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "addon/userrights,grant_by_profile,filter", "category" => "addon/userrights,grant_by_profile,filter",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => array("userlogin", "profile"), "name_attcode" => ["userlogin", "profile"],
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_urp_userprofile", "db_table" => "priv_urp_userprofile",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
"is_link" => true, /** @since 3.1.0 N°6482 */ "is_link" => true, /** @since 3.1.0 N°6482 */
'uniqueness_rules' => array( 'uniqueness_rules' => [
'no_duplicate' => array( 'no_duplicate' => [
'attributes' => array( 'attributes' => [
0 => 'userid', 0 => 'userid',
1 => 'profileid', 1 => 'profileid',
), ],
'filter' => '', 'filter' => '',
'disabled' => false, 'disabled' => false,
'is_blocking' => true, 'is_blocking' => true,
), ],
), ],
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
//MetaModel::Init_InheritAttributes(); //MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeExternalKey("userid", array("targetclass" => "User", "jointype" => "", "allowed_values" => null, "sql" => "userid", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("userid", ["targetclass" => "User", "jointype" => "", "allowed_values" => null, "sql" => "userid", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("userlogin", array("allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "login"))); MetaModel::Init_AddAttribute(new AttributeExternalField("userlogin", ["allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "login"]));
MetaModel::Init_AddAttribute(new AttributeExternalKey("profileid", MetaModel::Init_AddAttribute(new AttributeExternalKey(
array("targetclass" => "URP_Profiles", "jointype" => "", "allowed_values" => null, "sql" => "profileid", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => array(), "allow_target_creation" => false))); "profileid",
MetaModel::Init_AddAttribute(new AttributeExternalField("profile", array("allowed_values" => null, "extkey_attcode" => 'profileid', "target_attcode" => "name"))); ["targetclass" => "URP_Profiles", "jointype" => "", "allowed_values" => null, "sql" => "profileid", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => [], "allow_target_creation" => false]
));
MetaModel::Init_AddAttribute(new AttributeExternalField("profile", ["allowed_values" => null, "extkey_attcode" => 'profileid', "target_attcode" => "name"]));
MetaModel::Init_AddAttribute(new AttributeString("reason", array("allowed_values" => null, "sql" => "description", "default_value" => null, "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("reason", ["allowed_values" => null, "sql" => "description", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('userid', 'profileid', 'reason')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['userid', 'profileid', 'reason']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('userid', 'profileid', 'reason')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['userid', 'profileid', 'reason']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('userid', 'profileid')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['userid', 'profileid']); // Criteria of the std search form
MetaModel::Init_SetZListItems('advanced_search', array('userid', 'profileid')); // Criteria of the advanced search form MetaModel::Init_SetZListItems('advanced_search', ['userid', 'profileid']); // Criteria of the advanced search form
} }
public function CheckToDelete(&$oDeletionPlan) public function CheckToDelete(&$oDeletionPlan)
@@ -267,15 +251,14 @@ class URP_UserProfile extends UserRightsBaseClassGUI
if (MetaModel::GetConfig()->Get('demo_mode')) { if (MetaModel::GetConfig()->Get('demo_mode')) {
// Users deletion is NOT allowed in demo mode // Users deletion is NOT allowed in demo mode
$oDeletionPlan->AddToDelete($this, null); $oDeletionPlan->AddToDelete($this, null);
$oDeletionPlan->SetDeletionIssues($this, array('deletion not allowed in demo mode.'), true); $oDeletionPlan->SetDeletionIssues($this, ['deletion not allowed in demo mode.'], true);
$oDeletionPlan->ComputeResults(); $oDeletionPlan->ComputeResults();
return false; return false;
} }
try { try {
$this->CheckIfProfileIsAllowed(UR_ACTION_DELETE); $this->CheckIfProfileIsAllowed(UR_ACTION_DELETE);
} } catch (SecurityException $e) {
catch (SecurityException $e) {
// Users deletion is NOT allowed // Users deletion is NOT allowed
$oDeletionPlan->AddToDelete($this, null); $oDeletionPlan->AddToDelete($this, null);
$oDeletionPlan->SetDeletionIssues($this, [$e->getMessage()], true); $oDeletionPlan->SetDeletionIssues($this, [$e->getMessage()], true);
@@ -292,15 +275,14 @@ class URP_UserProfile extends UserRightsBaseClassGUI
if (MetaModel::GetConfig()->Get('demo_mode')) { if (MetaModel::GetConfig()->Get('demo_mode')) {
// Users deletion is NOT allowed in demo mode // Users deletion is NOT allowed in demo mode
$oDeletionPlan->AddToDelete($this, null); $oDeletionPlan->AddToDelete($this, null);
$oDeletionPlan->SetDeletionIssues($this, array('deletion not allowed in demo mode.'), true); $oDeletionPlan->SetDeletionIssues($this, ['deletion not allowed in demo mode.'], true);
$oDeletionPlan->ComputeResults(); $oDeletionPlan->ComputeResults();
return false; return false;
} }
try { try {
$this->CheckIfProfileIsAllowed(UR_ACTION_DELETE); $this->CheckIfProfileIsAllowed(UR_ACTION_DELETE);
} } catch (SecurityException $e) {
catch (SecurityException $e) {
// Users deletion is NOT allowed // Users deletion is NOT allowed
$oDeletionPlan->AddToDelete($this, null); $oDeletionPlan->AddToDelete($this, null);
$oDeletionPlan->SetDeletionIssues($this, [$e->getMessage()], true); $oDeletionPlan->SetDeletionIssues($this, [$e->getMessage()], true);
@@ -336,29 +318,30 @@ class URP_UserProfile extends UserRightsBaseClassGUI
protected function CheckIfProfileIsAllowed($iActionCode) protected function CheckIfProfileIsAllowed($iActionCode)
{ {
// When initializing or admin, we need to let everything pass trough // When initializing or admin, we need to let everything pass trough
if (!UserRights::IsLoggedIn() || UserRights::IsAdministrator()) { return; } if (!UserRights::IsLoggedIn() || UserRights::IsAdministrator()) {
return;
}
// Only administrators can manage administrators // Only administrators can manage administrators
$iOrigUserId = $this->GetOriginal('userid'); $iOrigUserId = $this->GetOriginal('userid');
if (!empty($iOrigUserId)) if (!empty($iOrigUserId)) {
{
$oUser = MetaModel::GetObject('User', $iOrigUserId, true, true); $oUser = MetaModel::GetObject('User', $iOrigUserId, true, true);
if (UserRights::IsAdministrator($oUser) && !UserRights::IsAdministrator()) if (UserRights::IsAdministrator($oUser) && !UserRights::IsAdministrator()) {
{
throw new SecurityException(Dict::Format('UI:Login:Error:AccessRestricted')); throw new SecurityException(Dict::Format('UI:Login:Error:AccessRestricted'));
} }
} }
$oUser = MetaModel::GetObject('User', $this->Get('userid'), true, true); $oUser = MetaModel::GetObject('User', $this->Get('userid'), true, true);
if (UserRights::IsAdministrator($oUser) && !UserRights::IsAdministrator()) if (UserRights::IsAdministrator($oUser) && !UserRights::IsAdministrator()) {
{
throw new SecurityException(Dict::Format('UI:Login:Error:AccessRestricted')); throw new SecurityException(Dict::Format('UI:Login:Error:AccessRestricted'));
} }
if (!UserRights::IsActionAllowed(get_class($this), $iActionCode, DBObjectSet::FromObject($this)))
{ $oSet = new \ormLinkSet(get_class($oUser), 'profile_list', \DBObjectSet::FromScratch(\URP_UserProfile::class));
$oSet->AddItem(MetaModel::NewObject('URP_UserProfile', ['profileid' => $this->GetKey(), 'reason' => 'CheckIfProfileIsAllowed']));
if (!UserRights::IsActionAllowed(get_class($this), $iActionCode, $oSet)) {
throw new SecurityException(Dict::Format('UI:Error:ObjectCannotBeUpdated')); throw new SecurityException(Dict::Format('UI:Error:ObjectCannotBeUpdated'));
} }
if (!UserRights::IsAdministrator() && ($this->Get('profile') === ADMIN_PROFILE_NAME)) if (!UserRights::IsAdministrator() && ($this->Get('profile') === ADMIN_PROFILE_NAME)) {
{
throw new SecurityException(Dict::Format('UI:Login:Error:AccessAdmin')); throw new SecurityException(Dict::Format('UI:Login:Error:AccessAdmin'));
} }
} }
@@ -369,33 +352,33 @@ class URP_UserOrg extends UserRightsBaseClassGUI
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "addon/userrights,grant_by_profile", "category" => "addon/userrights,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => array("userlogin", "allowed_org_name"), "name_attcode" => ["userlogin", "allowed_org_name"],
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_urp_userorg", "db_table" => "priv_urp_userorg",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
//MetaModel::Init_InheritAttributes(); //MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeExternalKey("userid", array("targetclass"=>"User", "jointype"=> "", "allowed_values"=>null, "sql"=>"userid", "is_null_allowed"=>false, "on_target_delete"=>DEL_AUTO, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("userid", ["targetclass" => "User", "jointype" => "", "allowed_values" => null, "sql" => "userid", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("userlogin", array("allowed_values"=>null, "extkey_attcode"=> 'userid', "target_attcode"=>"login"))); MetaModel::Init_AddAttribute(new AttributeExternalField("userlogin", ["allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "login"]));
MetaModel::Init_AddAttribute(new AttributeExternalKey("allowed_org_id", array("targetclass"=>"Organization", "jointype"=> "", "allowed_values"=>null, "sql"=>"allowed_org_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_AUTO, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("allowed_org_id", ["targetclass" => "Organization", "jointype" => "", "allowed_values" => null, "sql" => "allowed_org_id", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("allowed_org_name", array("allowed_values"=>null, "extkey_attcode"=> 'allowed_org_id', "target_attcode"=>"name"))); MetaModel::Init_AddAttribute(new AttributeExternalField("allowed_org_name", ["allowed_values" => null, "extkey_attcode" => 'allowed_org_id', "target_attcode" => "name"]));
MetaModel::Init_AddAttribute(new AttributeString("reason", array("allowed_values"=>null, "sql"=>"reason", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("reason", ["allowed_values" => null, "sql" => "reason", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('userid', 'allowed_org_id', 'reason')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['userid', 'allowed_org_id', 'reason']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('allowed_org_id', 'reason')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['allowed_org_id', 'reason']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('userid', 'allowed_org_id')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['userid', 'allowed_org_id']); // Criteria of the std search form
MetaModel::Init_SetZListItems('advanced_search', array('userid', 'allowed_org_id')); // Criteria of the advanced search form MetaModel::Init_SetZListItems('advanced_search', ['userid', 'allowed_org_id']); // Criteria of the advanced search form
} }
protected function OnInsert() protected function OnInsert()
@@ -418,35 +401,32 @@ class URP_UserOrg extends UserRightsBaseClassGUI
*/ */
protected function CheckIfOrgIsAllowed() protected function CheckIfOrgIsAllowed()
{ {
if (!UserRights::IsLoggedIn() || UserRights::IsAdministrator()) { return; } if (!UserRights::IsLoggedIn() || UserRights::IsAdministrator()) {
return;
}
$oUser = UserRights::GetUserObject(); $oUser = UserRights::GetUserObject();
$oAddon = UserRights::GetModuleInstance(); $oAddon = UserRights::GetModuleInstance();
$aOrgs = $oAddon->GetUserOrgs($oUser, ''); $aOrgs = $oAddon->GetUserOrgs($oUser, '');
if (count($aOrgs) > 0) if (count($aOrgs) > 0) {
{
$iOrigOrgId = $this->GetOriginal('allowed_org_id'); $iOrigOrgId = $this->GetOriginal('allowed_org_id');
if ((!empty($iOrigOrgId) && !in_array($iOrigOrgId, $aOrgs)) || !in_array($this->Get('allowed_org_id'), $aOrgs)) if ((!empty($iOrigOrgId) && !in_array($iOrigOrgId, $aOrgs)) || !in_array($this->Get('allowed_org_id'), $aOrgs)) {
{
throw new SecurityException(Dict::Format('Class:User/Error:OrganizationNotAllowed')); throw new SecurityException(Dict::Format('Class:User/Error:OrganizationNotAllowed'));
} }
} }
} }
} }
class UserRightsProfile extends UserRightsAddOnAPI class UserRightsProfile extends UserRightsAddOnAPI
{ {
static public $m_aActionCodes = array( public static $m_aActionCodes = [
UR_ACTION_READ => 'r', UR_ACTION_READ => 'r',
UR_ACTION_MODIFY => 'w', UR_ACTION_MODIFY => 'w',
UR_ACTION_DELETE => 'd', UR_ACTION_DELETE => 'd',
UR_ACTION_BULK_READ => 'br', UR_ACTION_BULK_READ => 'br',
UR_ACTION_BULK_MODIFY => 'bw', UR_ACTION_BULK_MODIFY => 'bw',
UR_ACTION_BULK_DELETE => 'bd', UR_ACTION_BULK_DELETE => 'bd',
); ];
/** /**
* @var array $aUsersProfilesList Cache of users' profiles. Hash array of user ID => [profile ID => profile friendlyname, profile ID => profile friendlyname, ...] * @var array $aUsersProfilesList Cache of users' profiles. Hash array of user ID => [profile ID => profile friendlyname, profile ID => profile friendlyname, ...]
@@ -472,8 +452,7 @@ class UserRightsProfile extends UserRightsAddOnAPI
$oContact = MetaModel::NewObject('Person'); $oContact = MetaModel::NewObject('Person');
$oContact->Set('name', 'My last name'); $oContact->Set('name', 'My last name');
$oContact->Set('first_name', 'My first name'); $oContact->Set('first_name', 'My first name');
if (MetaModel::IsValidAttCode('Person', 'org_id')) if (MetaModel::IsValidAttCode('Person', 'org_id')) {
{
$oContact->Set('org_id', $iOrgId); $oContact->Set('org_id', $iOrgId);
} }
$oContact->Set('email', 'my.email@foo.org'); $oContact->Set('email', 'my.email@foo.org');
@@ -481,24 +460,19 @@ class UserRightsProfile extends UserRightsAddOnAPI
} }
} }
$oUser = new UserLocal(); $oUser = new UserLocal();
$oUser->Set('login', $sAdminUser); $oUser->Set('login', $sAdminUser);
$oUser->Set('password', $sAdminPwd); $oUser->Set('password', $sAdminPwd);
if (MetaModel::IsValidAttCode('UserLocal', 'contactid') && ($iContactId != 0)) if (MetaModel::IsValidAttCode('UserLocal', 'contactid') && ($iContactId != 0)) {
{
$oUser->Set('contactid', $iContactId); $oUser->Set('contactid', $iContactId);
} }
$oUser->Set('language', $sLanguage); // Language was chosen during the installation $oUser->Set('language', $sLanguage); // Language was chosen during the installation
// Add this user to the very specific 'admin' profile // Add this user to the very specific 'admin' profile
$oAdminProfile = MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => ADMIN_PROFILE_NAME), true /*all data*/); $oAdminProfile = MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", ['name' => ADMIN_PROFILE_NAME], true /*all data*/);
if (is_object($oAdminProfile)) if (is_object($oAdminProfile)) {
{ $oSet = new \ormLinkSet(UserLocal::class, 'profile_list', \DBObjectSet::FromScratch(\URP_UserProfile::class));
$oUserProfile = new URP_UserProfile(); $oSet->AddItem(MetaModel::NewObject('URP_UserProfile', ['profileid' => $oAdminProfile->GetKey(), 'reason' => 'CreateAdministrator']));
$oUserProfile->Set('profileid', $oAdminProfile->GetKey());
$oUserProfile->Set('reason', 'By definition, the administrator must have the administrator profile');
$oSet = DBObjectSet::FromObject($oUserProfile);
$oUser->Set('profile_list', $oSet); $oUser->Set('profile_list', $oSet);
} }
$iUserId = $oUser->DBInsertNoReload(); $iUserId = $oUser->DBInsertNoReload();
@@ -509,11 +483,11 @@ class UserRightsProfile extends UserRightsAddOnAPI
{ {
} }
protected $m_aUserOrgs = array(); // userid -> array of orgid protected $m_aUserOrgs = []; // userid -> array of orgid
protected $m_aAdministrators = null; // [user id] protected $m_aAdministrators = null; // [user id]
// Built on demand, could be optimized if necessary (doing a query for each attribute that needs to be read) // Built on demand, could be optimized if necessary (doing a query for each attribute that needs to be read)
protected $m_aObjectActionGrants = array(); protected $m_aObjectActionGrants = [];
/** /**
* Read and cache organizations allowed to the given user * Read and cache organizations allowed to the given user
@@ -528,31 +502,25 @@ class UserRightsProfile extends UserRightsAddOnAPI
public function GetUserOrgs($oUser, $sClass) public function GetUserOrgs($oUser, $sClass)
{ {
$iUser = $oUser->GetKey(); $iUser = $oUser->GetKey();
if (!array_key_exists($iUser, $this->m_aUserOrgs)) if (!array_key_exists($iUser, $this->m_aUserOrgs)) {
{ $this->m_aUserOrgs[$iUser] = [];
$this->m_aUserOrgs[$iUser] = array();
$sHierarchicalKeyCode = MetaModel::IsHierarchicalClass('Organization'); $sHierarchicalKeyCode = MetaModel::IsHierarchicalClass('Organization');
if ($sHierarchicalKeyCode !== false) if ($sHierarchicalKeyCode !== false) {
{
$sUserOrgQuery = 'SELECT UserOrg, Org FROM Organization AS Org JOIN Organization AS Root ON Org.'.$sHierarchicalKeyCode.' BELOW Root.id JOIN URP_UserOrg AS UserOrg ON UserOrg.allowed_org_id = Root.id WHERE UserOrg.userid = :userid'; $sUserOrgQuery = 'SELECT UserOrg, Org FROM Organization AS Org JOIN Organization AS Root ON Org.'.$sHierarchicalKeyCode.' BELOW Root.id JOIN URP_UserOrg AS UserOrg ON UserOrg.allowed_org_id = Root.id WHERE UserOrg.userid = :userid';
$oUserOrgSet = new DBObjectSet(DBObjectSearch::FromOQL_AllData($sUserOrgQuery), array(), array('userid' => $iUser)); $oUserOrgSet = new DBObjectSet(DBObjectSearch::FromOQL_AllData($sUserOrgQuery), [], ['userid' => $iUser]);
while ($aRow = $oUserOrgSet->FetchAssoc()) while ($aRow = $oUserOrgSet->FetchAssoc()) {
{
$oOrg = $aRow['Org']; $oOrg = $aRow['Org'];
$this->m_aUserOrgs[$iUser][] = $oOrg->GetKey(); $this->m_aUserOrgs[$iUser][] = $oOrg->GetKey();
} }
} } else {
else
{
$oSearch = new DBObjectSearch('URP_UserOrg'); $oSearch = new DBObjectSearch('URP_UserOrg');
$oSearch->AllowAllData(); $oSearch->AllowAllData();
$oCondition = new BinaryExpression(new FieldExpression('userid'), '=', new VariableExpression('userid')); $oCondition = new BinaryExpression(new FieldExpression('userid'), '=', new VariableExpression('userid'));
$oSearch->AddConditionExpression($oCondition); $oSearch->AddConditionExpression($oCondition);
$oUserOrgSet = new DBObjectSet($oSearch, array(), array('userid' => $iUser)); $oUserOrgSet = new DBObjectSet($oSearch, [], ['userid' => $iUser]);
while ($oUserOrg = $oUserOrgSet->Fetch()) while ($oUserOrg = $oUserOrgSet->Fetch()) {
{
$this->m_aUserOrgs[$iUser][] = $oUserOrg->Get('allowed_org_id'); $this->m_aUserOrgs[$iUser][] = $oUserOrg->Get('allowed_org_id');
} }
} }
@@ -563,21 +531,20 @@ class UserRightsProfile extends UserRightsAddOnAPI
public function ResetCache() public function ResetCache()
{ {
// Loaded by Load cache // Loaded by Load cache
$this->m_aUserOrgs = array(); $this->m_aUserOrgs = [];
// Cache // Cache
$this->m_aObjectActionGrants = array(); $this->m_aObjectActionGrants = [];
$this->m_aAdministrators = null; $this->m_aAdministrators = null;
$this->aUsersProfilesList = [];
} }
public function LoadCache() public function LoadCache()
{ {
static $bSharedObjectInitialized = false; static $bSharedObjectInitialized = false;
if (!$bSharedObjectInitialized) if (!$bSharedObjectInitialized) {
{
$bSharedObjectInitialized = true; $bSharedObjectInitialized = true;
if (self::HasSharing()) if (self::HasSharing()) {
{
SharedObject::InitSharedClassProperties(); SharedObject::InitSharedClassProperties();
} }
} }
@@ -615,45 +582,40 @@ class UserRightsProfile extends UserRightsAddOnAPI
*/ */
public function ListProfiles($oUser) public function ListProfiles($oUser)
{ {
$aRet = array(); $aRet = [];
$oSearch = new DBObjectSearch('URP_UserProfile'); $oSearch = new DBObjectSearch('URP_UserProfile');
$oSearch->AllowAllData(); $oSearch->AllowAllData();
$oSearch->NoContextParameters(); $oSearch->NoContextParameters();
$oSearch->Addcondition('userid', $oUser->GetKey(), '='); $oSearch->Addcondition('userid', $oUser->GetKey(), '=');
$oProfiles = new DBObjectSet($oSearch); $oProfiles = new DBObjectSet($oSearch);
while ($oUserProfile = $oProfiles->Fetch()) while ($oUserProfile = $oProfiles->Fetch()) {
{
$aRet[$oUserProfile->Get('profileid')] = $oUserProfile->Get('profileid_friendlyname'); $aRet[$oUserProfile->Get('profileid')] = $oUserProfile->Get('profileid_friendlyname');
} }
return $aRet; return $aRet;
} }
public function GetSelectFilter($oUser, $sClass, $aSettings = array()) public function GetSelectFilter($oUser, $sClass, $aSettings = [])
{ {
$this->LoadCache(); $this->LoadCache();
// Let us pass an administrator for bypassing the grant matrix check in order to test this method without the need to set up a complex profile // Let us pass an administrator for bypassing the grant matrix check in order to test this method without the need to set up a complex profile
// In the nominal case Administrators never end up here (since they completely bypass GetSelectFilter) // In the nominal case Administrators never end up here (since they completely bypass GetSelectFilter)
if (!static::IsAdministrator($oUser) && (MetaModel::HasCategory($sClass, 'silo') || MetaModel::HasCategory($sClass, 'bizmodel'))) if (!static::IsAdministrator($oUser) && (MetaModel::HasCategory($sClass, 'silo') || MetaModel::HasCategory($sClass, 'bizmodel'))) {
{
// N°4354 - Categories 'silo' and 'bizmodel' do check the grant matrix. Whereas 'filter' always allows to read (but the result can be filtered) // N°4354 - Categories 'silo' and 'bizmodel' do check the grant matrix. Whereas 'filter' always allows to read (but the result can be filtered)
$aObjectPermissions = $this->GetUserActionGrant($oUser, $sClass, UR_ACTION_READ); $aObjectPermissions = $this->GetUserActionGrant($oUser, $sClass, UR_ACTION_READ);
if ($aObjectPermissions['permission'] == UR_ALLOWED_NO) if ($aObjectPermissions['permission'] == UR_ALLOWED_NO) {
{
return false; return false;
} }
} }
$oFilter = true; $oFilter = true;
$aConditions = array(); $aConditions = [];
// Determine if this class is part of a silo and build the filter for it // Determine if this class is part of a silo and build the filter for it
$sAttCode = self::GetOwnerOrganizationAttCode($sClass); $sAttCode = self::GetOwnerOrganizationAttCode($sClass);
if (!is_null($sAttCode)) if (!is_null($sAttCode)) {
{
$aUserOrgs = $this->GetUserOrgs($oUser, $sClass); $aUserOrgs = $this->GetUserOrgs($oUser, $sClass);
if (count($aUserOrgs) > 0) if (count($aUserOrgs) > 0) {
{
$oFilter = $this->MakeSelectFilter($sClass, $aUserOrgs, $aSettings, $sAttCode); $oFilter = $this->MakeSelectFilter($sClass, $aUserOrgs, $aSettings, $sAttCode);
} }
// else: No org means 'any org' // else: No org means 'any org'
@@ -662,20 +624,15 @@ class UserRightsProfile extends UserRightsAddOnAPI
// Specific conditions to hide, for non-administrators, the Administrator Users, the Administrator Profile and related links // Specific conditions to hide, for non-administrators, the Administrator Users, the Administrator Profile and related links
// Note: when logged as an administrator, GetSelectFilter is completely bypassed. // Note: when logged as an administrator, GetSelectFilter is completely bypassed.
if ($this->AdministratorsAreHidden()) if ($this->AdministratorsAreHidden()) {
{ if ($sClass == 'URP_Profiles') {
if ($sClass == 'URP_Profiles')
{
$oExpression = new FieldExpression('id', $sClass); $oExpression = new FieldExpression('id', $sClass);
$oScalarExpr = new ScalarExpression(1); $oScalarExpr = new ScalarExpression(1);
$aConditions[] = new BinaryExpression($oExpression, '!=', $oScalarExpr); $aConditions[] = new BinaryExpression($oExpression, '!=', $oScalarExpr);
} } elseif (($sClass == 'URP_UserProfile') || ($sClass == 'User') || (is_subclass_of($sClass, 'User'))) {
else if (($sClass == 'URP_UserProfile') || ($sClass == 'User') || (is_subclass_of($sClass, 'User')))
{
$aAdministrators = $this->GetAdministrators(); $aAdministrators = $this->GetAdministrators();
if (count($aAdministrators) > 0) if (count($aAdministrators) > 0) {
{
$sAttCode = ($sClass == 'URP_UserProfile') ? 'userid' : 'id'; $sAttCode = ($sClass == 'URP_UserProfile') ? 'userid' : 'id';
$oExpression = new FieldExpression($sAttCode, $sClass); $oExpression = new FieldExpression($sAttCode, $sClass);
$oListExpr = ListExpression::FromScalars($aAdministrators); $oListExpr = ListExpression::FromScalars($aAdministrators);
@@ -685,17 +642,14 @@ class UserRightsProfile extends UserRightsAddOnAPI
} }
// Handling of the added conditions // Handling of the added conditions
if (count($aConditions) > 0) if (count($aConditions) > 0) {
{ if ($oFilter === true) {
if($oFilter === true)
{
// No 'silo' filter, let's build a clean one // No 'silo' filter, let's build a clean one
$oFilter = new DBObjectSearch($sClass); $oFilter = new DBObjectSearch($sClass);
} }
// Add the conditions to the filter // Add the conditions to the filter
foreach($aConditions as $oCondition) foreach ($aConditions as $oCondition) {
{
$oFilter->AddConditionExpression($oCondition); $oFilter->AddConditionExpression($oCondition);
} }
} }
@@ -710,10 +664,9 @@ class UserRightsProfile extends UserRightsAddOnAPI
*/ */
private function GetAdministrators() private function GetAdministrators()
{ {
if ($this->m_aAdministrators === null) if ($this->m_aAdministrators === null) {
{
// Find all administrators // Find all administrators
$this->m_aAdministrators = array(); $this->m_aAdministrators = [];
$oAdministratorsFilter = new DBObjectSearch('User'); $oAdministratorsFilter = new DBObjectSearch('User');
$oLnkFilter = new DBObjectSearch('URP_UserProfile'); $oLnkFilter = new DBObjectSearch('URP_UserProfile');
$oExpression = new FieldExpression('profileid', 'URP_UserProfile'); $oExpression = new FieldExpression('profileid', 'URP_UserProfile');
@@ -723,9 +676,8 @@ class UserRightsProfile extends UserRightsAddOnAPI
$oAdministratorsFilter->AddCondition_ReferencedBy($oLnkFilter, 'userid'); $oAdministratorsFilter->AddCondition_ReferencedBy($oLnkFilter, 'userid');
$oAdministratorsFilter->AllowAllData(true); // Mandatory to prevent infinite recursion !! $oAdministratorsFilter->AllowAllData(true); // Mandatory to prevent infinite recursion !!
$oSet = new DBObjectSet($oAdministratorsFilter); $oSet = new DBObjectSet($oAdministratorsFilter);
$oSet->OptimizeColumnLoad(array('User' => array('login'))); $oSet->OptimizeColumnLoad(['User' => ['login']]);
while($oUser = $oSet->Fetch()) while ($oUser = $oSet->Fetch()) {
{
$this->m_aAdministrators[] = $oUser->GetKey(); $this->m_aAdministrators[] = $oUser->GetKey();
} }
} }
@@ -741,7 +693,6 @@ class UserRightsProfile extends UserRightsAddOnAPI
return ((bool)MetaModel::GetConfig()->Get('security.hide_administrators')); return ((bool)MetaModel::GetConfig()->Get('security.hide_administrators'));
} }
// This verb has been made public to allow the development of an accurate feedback for the current configuration // This verb has been made public to allow the development of an accurate feedback for the current configuration
public function GetProfileActionGrant($iProfile, $sClass, $sAction) public function GetProfileActionGrant($iProfile, $sClass, $sAction)
{ {
@@ -760,7 +711,9 @@ class UserRightsProfile extends UserRightsAddOnAPI
$iUser = $oUser->GetKey(); $iUser = $oUser->GetKey();
if (isset($this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode])) { if (isset($this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode])) {
$aTest = $this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode]; $aTest = $this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode];
if (is_array($aTest)) return $aTest; if (is_array($aTest)) {
return $aTest;
}
} }
$sAction = self::$m_aActionCodes[$iActionCode]; $sAction = self::$m_aActionCodes[$iActionCode];
@@ -771,20 +724,14 @@ class UserRightsProfile extends UserRightsAddOnAPI
$this->aUsersProfilesList[$iUser] = UserRights::ListProfiles($oUser); $this->aUsersProfilesList[$iUser] = UserRights::ListProfiles($oUser);
} }
// Call the API of UserRights because it caches the list for us // Call the API of UserRights because it caches the list for us
foreach($this->aUsersProfilesList[$iUser] as $iProfile => $oProfile) foreach ($this->aUsersProfilesList[$iUser] as $iProfile => $oProfile) {
{
$bGrant = $this->GetProfileActionGrant($iProfile, $sClass, $sAction); $bGrant = $this->GetProfileActionGrant($iProfile, $sClass, $sAction);
if (!is_null($bGrant)) if (!is_null($bGrant)) {
{ if ($bGrant) {
if ($bGrant) if (is_null($bStatus)) {
{
if (is_null($bStatus))
{
$bStatus = true; $bStatus = true;
} }
} } else {
else
{
$bStatus = false; $bStatus = false;
} }
} }
@@ -792,9 +739,9 @@ class UserRightsProfile extends UserRightsAddOnAPI
$iPermission = $bStatus ? UR_ALLOWED_YES : UR_ALLOWED_NO; $iPermission = $bStatus ? UR_ALLOWED_YES : UR_ALLOWED_NO;
$aRes = array( $aRes = [
'permission' => $iPermission, 'permission' => $iPermission,
); ];
$this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode] = $aRes; $this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode] = $aRes;
return $aRes; return $aRes;
} }
@@ -809,20 +756,13 @@ class UserRightsProfile extends UserRightsAddOnAPI
// Note: In most cases the object set is ignored because it was interesting to optimize for huge data sets // Note: In most cases the object set is ignored because it was interesting to optimize for huge data sets
// and acceptable to consider only the root class of the object set // and acceptable to consider only the root class of the object set
if ($iPermission != UR_ALLOWED_YES) if ($iPermission != UR_ALLOWED_YES) {
{
// It is already NO for everyone... that's the final word! // It is already NO for everyone... that's the final word!
} } elseif ($iActionCode == UR_ACTION_READ) {
elseif ($iActionCode == UR_ACTION_READ)
{
// We are protected by GetSelectFilter: the object set contains objects allowed or shared for reading // We are protected by GetSelectFilter: the object set contains objects allowed or shared for reading
} } elseif ($iActionCode == UR_ACTION_BULK_READ) {
elseif ($iActionCode == UR_ACTION_BULK_READ)
{
// We are protected by GetSelectFilter: the object set contains objects allowed or shared for reading // We are protected by GetSelectFilter: the object set contains objects allowed or shared for reading
} } elseif ($oInstanceSet) {
elseif ($oInstanceSet)
{
// We are protected by GetSelectFilter: the object set contains objects allowed or shared for reading // We are protected by GetSelectFilter: the object set contains objects allowed or shared for reading
// We have to answer NO for objects shared for reading purposes // We have to answer NO for objects shared for reading purposes
if (self::HasSharing() && SharedObject::GetSharedClassProperties($sClass)) { if (self::HasSharing() && SharedObject::GetSharedClassProperties($sClass)) {
@@ -895,20 +835,14 @@ class UserRightsProfile extends UserRightsAddOnAPI
// and acceptable to consider only the root class of the object set // and acceptable to consider only the root class of the object set
$bStatus = null; $bStatus = null;
// Call the API of UserRights because it caches the list for us // Call the API of UserRights because it caches the list for us
foreach($this->aUsersProfilesList[$iUser] as $iProfile => $oProfile) foreach ($this->aUsersProfilesList[$iUser] as $iProfile => $oProfile) {
{
$bGrant = $this->GetClassStimulusGrant($iProfile, $sClass, $sStimulusCode); $bGrant = $this->GetClassStimulusGrant($iProfile, $sClass, $sStimulusCode);
if (!is_null($bGrant)) if (!is_null($bGrant)) {
{ if ($bGrant) {
if ($bGrant) if (is_null($bStatus)) {
{
if (is_null($bStatus))
{
$bStatus = true; $bStatus = true;
} }
} } else {
else
{
$bStatus = false; $bStatus = false;
} }
} }
@@ -932,22 +866,16 @@ class UserRightsProfile extends UserRightsAddOnAPI
{ {
$sAttCode = null; $sAttCode = null;
$aCallSpec = array($sClass, 'MapContextParam'); $aCallSpec = [$sClass, 'MapContextParam'];
if (($sClass == 'Organization') || is_subclass_of($sClass, 'Organization')) if (($sClass == 'Organization') || is_subclass_of($sClass, 'Organization')) {
{
$sAttCode = 'id'; $sAttCode = 'id';
} } elseif (is_callable($aCallSpec)) {
elseif (is_callable($aCallSpec))
{
$sAttCode = call_user_func($aCallSpec, 'org_id'); // Returns null when there is no mapping for this parameter $sAttCode = call_user_func($aCallSpec, 'org_id'); // Returns null when there is no mapping for this parameter
if (!MetaModel::IsValidAttCode($sClass, $sAttCode)) if (!MetaModel::IsValidAttCode($sClass, $sAttCode)) {
{
// Skip silently. The data model checker will tell you something about this... // Skip silently. The data model checker will tell you something about this...
$sAttCode = null; $sAttCode = null;
} }
} } elseif (MetaModel::IsValidAttCode($sClass, 'org_id')) {
elseif(MetaModel::IsValidAttCode($sClass, 'org_id'))
{
$sAttCode = 'org_id'; $sAttCode = 'org_id';
} }
@@ -960,14 +888,11 @@ class UserRightsProfile extends UserRightsAddOnAPI
protected static function HasSharing() protected static function HasSharing()
{ {
static $bHasSharing; static $bHasSharing;
if (!isset($bHasSharing)) if (!isset($bHasSharing)) {
{
$bHasSharing = class_exists('SharedObject'); $bHasSharing = class_exists('SharedObject');
} }
return $bHasSharing; return $bHasSharing;
} }
} }
UserRights::SelectModule('UserRightsProfile'); UserRights::SelectModule('UserRightsProfile');

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -48,8 +49,7 @@ class DBSearchHelper
$oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW); $oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW);
$oSearch->AddCondition_PointingTo($oHKFilter, $sAttCode); $oSearch->AddCondition_PointingTo($oHKFilter, $sAttCode);
} }
} } catch (Exception $e) {
catch (Exception $e) {
// If filtering fails just ignore it // If filtering fails just ignore it
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* Class ApplicationContext * Class ApplicationContext
* *
@@ -86,7 +86,6 @@ class PortalURLMaker implements iDBObjectURLMaker
} }
} }
/** /**
* Helper class to store and manipulate the parameters that make the application's context * Helper class to store and manipulate the parameters that make the application's context
* *
@@ -115,11 +114,10 @@ class ApplicationContext
*/ */
public function __construct($bReadContext = true) public function __construct($bReadContext = true)
{ {
$this->aNames = array( $this->aNames = [
'org_id', 'menu' 'org_id', 'menu',
); ];
if ($bReadContext) if ($bReadContext) {
{
$this->ReadContext(); $this->ReadContext();
} }
@@ -133,36 +131,29 @@ class ApplicationContext
*/ */
protected function ReadContext() protected function ReadContext()
{ {
if (!isset(self::$aDefaultValues)) if (!isset(self::$aDefaultValues)) {
{ self::$aDefaultValues = [];
self::$aDefaultValues = array(); $aContext = utils::ReadParam('c', [], false, 'context_param');
$aContext = utils::ReadParam('c', array(), false, 'context_param'); foreach ($this->aNames as $sName) {
foreach($this->aNames as $sName)
{
$sValue = isset($aContext[$sName]) ? $aContext[$sName] : ''; $sValue = isset($aContext[$sName]) ? $aContext[$sName] : '';
// TO DO: check if some of the context parameters are mandatory (or have default values) // TO DO: check if some of the context parameters are mandatory (or have default values)
if (!empty($sValue)) if (!empty($sValue)) {
{
self::$aDefaultValues[$sName] = $sValue; self::$aDefaultValues[$sName] = $sValue;
} }
// Hmm, there must be a better (more generic) way to handle the case below: // Hmm, there must be a better (more generic) way to handle the case below:
// When there is only one possible (allowed) organization, the context must be // When there is only one possible (allowed) organization, the context must be
// fixed to this org unless there is only one organization in the system then // fixed to this org unless there is only one organization in the system then
// no filter is applied // no filter is applied
if ($sName == 'org_id') if ($sName == 'org_id') {
{ if (MetaModel::IsValidClass('Organization')) {
if (MetaModel::IsValidClass('Organization'))
{
$oSearchFilter = new DBObjectSearch('Organization'); $oSearchFilter = new DBObjectSearch('Organization');
$oSet = new CMDBObjectSet($oSearchFilter); $oSet = new CMDBObjectSet($oSearchFilter);
$iCount = $oSet->CountWithLimit(2); $iCount = $oSet->CountWithLimit(2);
if ($iCount > 1) if ($iCount > 1) {
{
$oSearchFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true); $oSearchFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true);
$oSet = new CMDBObjectSet($oSearchFilter); $oSet = new CMDBObjectSet($oSearchFilter);
$iCount = $oSet->CountWithLimit(2); $iCount = $oSet->CountWithLimit(2);
if ($iCount == 1) if ($iCount == 1) {
{
// Only one possible value for org_id, set it in the context // Only one possible value for org_id, set it in the context
$oOrg = $oSet->Fetch(); $oOrg = $oSet->Fetch();
self::$aDefaultValues[$sName] = $oOrg->GetKey(); self::$aDefaultValues[$sName] = $oOrg->GetKey();
@@ -185,8 +176,7 @@ class ApplicationContext
*/ */
public function GetCurrentValue($sParamName, $defaultValue = '') public function GetCurrentValue($sParamName, $defaultValue = '')
{ {
if (isset($this->aValues[$sParamName])) if (isset($this->aValues[$sParamName])) {
{
return $this->aValues[$sParamName]; return $this->aValues[$sParamName];
} }
return $defaultValue; return $defaultValue;
@@ -205,9 +195,8 @@ class ApplicationContext
} }
// Build the query string with ampersand separated parameters // Build the query string with ampersand separated parameters
$aParams = array(); $aParams = [];
foreach($this->aValues as $sName => $sValue) foreach ($this->aValues as $sName => $sValue) {
{
$aParams[] = "c[$sName]".'='.urlencode($sValue); $aParams[] = "c[$sName]".'='.urlencode($sValue);
} }
$sReturnValue = implode('&', $aParams); $sReturnValue = implode('&', $aParams);
@@ -278,9 +267,8 @@ class ApplicationContext
*/ */
public function GetAsHash() public function GetAsHash()
{ {
$aReturn = array(); $aReturn = [];
foreach($this->aValues as $sName => $sValue) foreach ($this->aValues as $sName => $sValue) {
{
$aReturn["c[$sName]"] = $sValue; $aReturn["c[$sName]"] = $sValue;
} }
return $aReturn; return $aReturn;
@@ -301,8 +289,7 @@ class ApplicationContext
*/ */
public function Reset($sParamName) public function Reset($sParamName)
{ {
if (isset($this->aValues[$sParamName])) if (isset($this->aValues[$sParamName])) {
{
unset($this->aValues[$sParamName]); unset($this->aValues[$sParamName]);
} }
} }
@@ -318,21 +305,16 @@ class ApplicationContext
public function InitObjectFromContext(DBObject &$oObj) public function InitObjectFromContext(DBObject &$oObj)
{ {
$sClass = get_class($oObj); $sClass = get_class($oObj);
foreach($this->GetNames() as $key) foreach ($this->GetNames() as $key) {
{ $aCallSpec = [$sClass, 'MapContextParam'];
$aCallSpec = array($sClass, 'MapContextParam'); if (is_callable($aCallSpec)) {
if (is_callable($aCallSpec))
{
$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter $sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter
if (MetaModel::IsValidAttCode($sClass, $sAttCode)) if (MetaModel::IsValidAttCode($sClass, $sAttCode)) {
{
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
if ($oAttDef->IsWritable()) if ($oAttDef->IsWritable()) {
{
$value = $this->GetCurrentValue($key, null); $value = $this->GetCurrentValue($key, null);
if (!is_null($value)) if (!is_null($value)) {
{
$oObj->Set($sAttCode, $value); $oObj->Set($sAttCode, $value);
} }
} }
@@ -362,14 +344,10 @@ class ApplicationContext
*/ */
public static function GetUrlMakerClass() public static function GetUrlMakerClass()
{ {
if (is_null(self::$m_sUrlMakerClass)) if (is_null(self::$m_sUrlMakerClass)) {
{ if (Session::IsSet('UrlMakerClass')) {
if (Session::IsSet('UrlMakerClass'))
{
self::$m_sUrlMakerClass = Session::Get('UrlMakerClass'); self::$m_sUrlMakerClass = Session::Get('UrlMakerClass');
} } else {
else
{
self::$m_sUrlMakerClass = 'iTopStandardURLMaker'; self::$m_sUrlMakerClass = 'iTopStandardURLMaker';
} }
} }
@@ -394,7 +372,7 @@ class ApplicationContext
if (is_null($sUrlMakerClass)) { if (is_null($sUrlMakerClass)) {
$sUrlMakerClass = self::GetUrlMakerClass(); $sUrlMakerClass = self::GetUrlMakerClass();
} }
$sUrl = call_user_func(array($sUrlMakerClass, 'MakeObjectUrl'), $sObjClass, $sObjKey); $sUrl = call_user_func([$sUrlMakerClass, 'MakeObjectUrl'], $sObjClass, $sObjKey);
if (utils::StrLen($sUrl) > 0) { if (utils::StrLen($sUrl) > 0) {
if ($bWithNavigationContext) { if ($bWithNavigationContext) {
return $sUrl.$oAppContext->GetForLink(true); return $sUrl.$oAppContext->GetForLink(true);
@@ -412,13 +390,10 @@ class ApplicationContext
*/ */
protected static function LoadPluginProperties() protected static function LoadPluginProperties()
{ {
if (Session::IsSet('PluginProperties')) if (Session::IsSet('PluginProperties')) {
{
self::$m_aPluginProperties = Session::Get('PluginProperties'); self::$m_aPluginProperties = Session::Get('PluginProperties');
} } else {
else self::$m_aPluginProperties = [];
{
self::$m_aPluginProperties = array();
} }
} }
@@ -431,7 +406,9 @@ class ApplicationContext
*/ */
public static function SetPluginProperty($sPluginClass, $sProperty, $value) public static function SetPluginProperty($sPluginClass, $sProperty, $value)
{ {
if (is_null(self::$m_aPluginProperties)) self::LoadPluginProperties(); if (is_null(self::$m_aPluginProperties)) {
self::LoadPluginProperties();
}
self::$m_aPluginProperties[$sPluginClass][$sProperty] = $value; self::$m_aPluginProperties[$sPluginClass][$sProperty] = $value;
Session::Set(['PluginProperties', $sPluginClass, $sProperty], $value); Session::Set(['PluginProperties', $sPluginClass, $sProperty], $value);
@@ -444,15 +421,14 @@ class ApplicationContext
*/ */
public static function GetPluginProperties($sPluginClass) public static function GetPluginProperties($sPluginClass)
{ {
if (is_null(self::$m_aPluginProperties)) self::LoadPluginProperties(); if (is_null(self::$m_aPluginProperties)) {
self::LoadPluginProperties();
}
if (array_key_exists($sPluginClass, self::$m_aPluginProperties)) if (array_key_exists($sPluginClass, self::$m_aPluginProperties)) {
{
return self::$m_aPluginProperties[$sPluginClass]; return self::$m_aPluginProperties[$sPluginClass];
} } else {
else return [];
{
return array();
} }
} }

View File

@@ -74,7 +74,3 @@ require_once(APPROOT.'application/applicationextension/rest/iRestInputSanitizer.
require_once(APPROOT.'application/applicationextension/rest/iRestServiceProvider.php'); require_once(APPROOT.'application/applicationextension/rest/iRestServiceProvider.php');
require_once(APPROOT.'application/applicationextension/rest/RestResult.php'); require_once(APPROOT.'application/applicationextension/rest/RestResult.php');
require_once(APPROOT.'application/applicationextension/rest/RestUtils.php'); require_once(APPROOT.'application/applicationextension/rest/RestUtils.php');

View File

@@ -42,7 +42,7 @@ abstract class AbstractApplicationUIExtension implements iApplicationUIExtension
*/ */
public function EnumUsedAttributes($oObject) public function EnumUsedAttributes($oObject)
{ {
return array(); return [];
} }
/** /**
@@ -66,7 +66,7 @@ abstract class AbstractApplicationUIExtension implements iApplicationUIExtension
*/ */
public function EnumAllowedActions(DBObjectSet $oSet) public function EnumAllowedActions(DBObjectSet $oSet)
{ {
return array(); return [];
} }
} }

View File

@@ -33,7 +33,7 @@ abstract class ApplicationPopupMenuItem
$this->sLabel = $sLabel; $this->sLabel = $sLabel;
$this->sTooltip = ''; $this->sTooltip = '';
$this->sIconClass = ''; $this->sIconClass = '';
$this->aCssClasses = array(); $this->aCssClasses = [];
} }
/** /**
@@ -89,7 +89,6 @@ abstract class ApplicationPopupMenuItem
$this->aCssClasses[] = $sCssClass; $this->aCssClasses[] = $sCssClass;
} }
/** /**
* @param $sTooltip * @param $sTooltip
* *
@@ -145,6 +144,6 @@ abstract class ApplicationPopupMenuItem
/** @ignore */ /** @ignore */
public function GetLinkedScripts() public function GetLinkedScripts()
{ {
return array(); return [];
} }
} }

View File

@@ -9,5 +9,4 @@
*/ */
class JSButtonItem extends JSPopupMenuItem class JSButtonItem extends JSPopupMenuItem
{ {
} }

View File

@@ -28,7 +28,7 @@ class JSPopupMenuItem extends ApplicationPopupMenuItem
* @param array $aIncludeJSFiles An array of file URLs to be included (once) to provide some JS libraries for the page. * @param array $aIncludeJSFiles An array of file URLs to be included (once) to provide some JS libraries for the page.
* @api * @api
*/ */
public function __construct($sUID, $sLabel, $sJSCode, $aIncludeJSFiles = array()) public function __construct($sUID, $sLabel, $sJSCode, $aIncludeJSFiles = [])
{ {
parent::__construct($sUID, $sLabel); parent::__construct($sUID, $sLabel);
$this->sJsCode = $sJSCode; $this->sJsCode = $sJSCode;
@@ -40,14 +40,14 @@ class JSPopupMenuItem extends ApplicationPopupMenuItem
public function GetMenuItem() public function GetMenuItem()
{ {
// Note: the semicolumn is a must here! // Note: the semicolumn is a must here!
return array( return [
'label' => $this->GetLabel(), 'label' => $this->GetLabel(),
'onclick' => $this->GetJsCode().'; return false;', 'onclick' => $this->GetJsCode().'; return false;',
'url' => $this->GetUrl(), 'url' => $this->GetUrl(),
'css_classes' => $this->GetCssClasses(), 'css_classes' => $this->GetCssClasses(),
'icon_class' => $this->sIconClass, 'icon_class' => $this->sIconClass,
'tooltip' => $this->sTooltip 'tooltip' => $this->sTooltip,
); ];
} }
/** @ignore */ /** @ignore */

View File

@@ -10,7 +10,7 @@
*/ */
class SeparatorPopupMenuItem extends ApplicationPopupMenuItem class SeparatorPopupMenuItem extends ApplicationPopupMenuItem
{ {
static $idx = 0; public static $idx = 0;
/** /**
* Constructor * Constructor
@@ -24,6 +24,6 @@ class SeparatorPopupMenuItem extends ApplicationPopupMenuItem
/** @ignore */ /** @ignore */
public function GetMenuItem() public function GetMenuItem()
{ {
return array('label' => '<hr class="menu-separator">', 'url' => '', 'css_classes' => $this->aCssClasses); return ['label' => '<hr class="menu-separator">', 'url' => '', 'css_classes' => $this->aCssClasses];
} }
} }

View File

@@ -9,5 +9,4 @@
*/ */
class URLButtonItem extends URLPopupMenuItem class URLButtonItem extends URLPopupMenuItem
{ {
} }

View File

@@ -35,13 +35,13 @@ class URLPopupMenuItem extends ApplicationPopupMenuItem
/** @ignore */ /** @ignore */
public function GetMenuItem() public function GetMenuItem()
{ {
return array('label' => $this->GetLabel(), return ['label' => $this->GetLabel(),
'url' => $this->GetUrl(), 'url' => $this->GetUrl(),
'target' => $this->GetTarget(), 'target' => $this->GetTarget(),
'css_classes' => $this->aCssClasses, 'css_classes' => $this->aCssClasses,
'icon_class' => $this->sIconClass, 'icon_class' => $this->sIconClass,
'tooltip' => $this->sTooltip 'tooltip' => $this->sTooltip,
); ];
} }
/** @ignore */ /** @ignore */

View File

@@ -19,21 +19,21 @@ interface iPopupMenuExtension
* $param is a DBObjectSet containing the list of objects * $param is a DBObjectSet containing the list of objects
* @api * @api
*/ */
const MENU_OBJLIST_ACTIONS = 1; public const MENU_OBJLIST_ACTIONS = 1;
/** /**
* Insert an item into the Toolkit menu of a list * Insert an item into the Toolkit menu of a list
* *
* $param is a DBObjectSet containing the list of objects * $param is a DBObjectSet containing the list of objects
* @api * @api
*/ */
const MENU_OBJLIST_TOOLKIT = 2; public const MENU_OBJLIST_TOOLKIT = 2;
/** /**
* Insert an item into the Actions menu on an object details page * Insert an item into the Actions menu on an object details page
* *
* $param is a DBObject instance: the object currently displayed * $param is a DBObject instance: the object currently displayed
* @api * @api
*/ */
const MENU_OBJDETAILS_ACTIONS = 3; public const MENU_OBJDETAILS_ACTIONS = 3;
/** /**
* Insert an item into the Dashboard menu * Insert an item into the Dashboard menu
* *
@@ -43,14 +43,14 @@ interface iPopupMenuExtension
* $param is a Dashboard instance: the dashboard currently displayed * $param is a Dashboard instance: the dashboard currently displayed
* @api * @api
*/ */
const MENU_DASHBOARD_ACTIONS = 4; public const MENU_DASHBOARD_ACTIONS = 4;
/** /**
* Insert an item into the User menu (upper right corner) * Insert an item into the User menu (upper right corner)
* *
* $param is null * $param is null
* @api * @api
*/ */
const MENU_USER_ACTIONS = 5; public const MENU_USER_ACTIONS = 5;
/** /**
* Insert an item into the Action menu on an object item in an objects list in the portal * Insert an item into the Action menu on an object item in an objects list in the portal
* *
@@ -58,7 +58,7 @@ interface iPopupMenuExtension
* the current line) * the current line)
* @api * @api
*/ */
const PORTAL_OBJLISTITEM_ACTIONS = 7; public const PORTAL_OBJLISTITEM_ACTIONS = 7;
/** /**
* Insert an item into the Action menu on an object details page in the portal * Insert an item into the Action menu on an object details page in the portal
* *
@@ -66,7 +66,7 @@ interface iPopupMenuExtension
* currently displayed) * currently displayed)
* @api * @api
*/ */
const PORTAL_OBJDETAILS_ACTIONS = 8; public const PORTAL_OBJDETAILS_ACTIONS = 8;
/** /**
* Insert an item into the Actions menu of a list in the portal * Insert an item into the Actions menu of a list in the portal
@@ -76,7 +76,7 @@ interface iPopupMenuExtension
* *
* @todo * @todo
*/ */
const PORTAL_OBJLIST_ACTIONS = 6; public const PORTAL_OBJLIST_ACTIONS = 6;
/** /**
* Insert an item into the user menu of the portal * Insert an item into the user menu of the portal
* Note: This is not implemented yet ! * Note: This is not implemented yet !
@@ -85,7 +85,7 @@ interface iPopupMenuExtension
* *
* @todo * @todo
*/ */
const PORTAL_USER_ACTIONS = 9; public const PORTAL_USER_ACTIONS = 9;
/** /**
* Insert an item into the navigation menu of the portal * Insert an item into the navigation menu of the portal
* Note: This is not implemented yet ! * Note: This is not implemented yet !
@@ -94,7 +94,7 @@ interface iPopupMenuExtension
* *
* @todo * @todo
*/ */
const PORTAL_MENU_ACTIONS = 10; public const PORTAL_MENU_ACTIONS = 10;
/** /**
* Get the list of items to be added to a menu. * Get the list of items to be added to a menu.

View File

@@ -14,7 +14,7 @@ abstract class AbstractPortalUIExtension implements iPortalUIExtension
*/ */
public function GetCSSFiles(\Symfony\Component\DependencyInjection\Container $oContainer) public function GetCSSFiles(\Symfony\Component\DependencyInjection\Container $oContainer)
{ {
return array(); return [];
} }
/** /**
@@ -30,7 +30,7 @@ abstract class AbstractPortalUIExtension implements iPortalUIExtension
*/ */
public function GetJSFiles(\Symfony\Component\DependencyInjection\Container $oContainer) public function GetJSFiles(\Symfony\Component\DependencyInjection\Container $oContainer)
{ {
return array(); return [];
} }
/** /**

View File

@@ -11,9 +11,9 @@
*/ */
interface iPortalUIExtension interface iPortalUIExtension
{ {
const ENUM_PORTAL_EXT_UI_BODY = 'Body'; public const ENUM_PORTAL_EXT_UI_BODY = 'Body';
const ENUM_PORTAL_EXT_UI_NAVIGATION_MENU = 'NavigationMenu'; public const ENUM_PORTAL_EXT_UI_NAVIGATION_MENU = 'NavigationMenu';
const ENUM_PORTAL_EXT_UI_MAIN_CONTENT = 'MainContent'; public const ENUM_PORTAL_EXT_UI_MAIN_CONTENT = 'MainContent';
/** /**
* Returns an array of CSS file urls * Returns an array of CSS file urls

View File

@@ -13,62 +13,62 @@ class RestResult
* Result: no issue has been encountered * Result: no issue has been encountered
* @api * @api
*/ */
const OK = 0; public const OK = 0;
/** /**
* Result: missing/wrong credentials or the user does not have enough rights to perform the requested operation * Result: missing/wrong credentials or the user does not have enough rights to perform the requested operation
* @api * @api
*/ */
const UNAUTHORIZED = 1; public const UNAUTHORIZED = 1;
/** /**
* Result: the parameter 'version' is missing * Result: the parameter 'version' is missing
* @api * @api
*/ */
const MISSING_VERSION = 2; public const MISSING_VERSION = 2;
/** /**
* Result: the parameter 'json_data' is missing * Result: the parameter 'json_data' is missing
* @api * @api
*/ */
const MISSING_JSON = 3; public const MISSING_JSON = 3;
/** /**
* Result: the input structure is not a valid JSON string * Result: the input structure is not a valid JSON string
* @api * @api
*/ */
const INVALID_JSON = 4; public const INVALID_JSON = 4;
/** /**
* Result: the parameter 'auth_user' is missing, authentication aborted * Result: the parameter 'auth_user' is missing, authentication aborted
* @api * @api
*/ */
const MISSING_AUTH_USER = 5; public const MISSING_AUTH_USER = 5;
/** /**
* Result: the parameter 'auth_pwd' is missing, authentication aborted * Result: the parameter 'auth_pwd' is missing, authentication aborted
* @api * @api
*/ */
const MISSING_AUTH_PWD = 6; public const MISSING_AUTH_PWD = 6;
/** /**
* Result: no operation is available for the specified version * Result: no operation is available for the specified version
* @api * @api
*/ */
const UNSUPPORTED_VERSION = 10; public const UNSUPPORTED_VERSION = 10;
/** /**
* Result: the requested operation is not valid for the specified version * Result: the requested operation is not valid for the specified version
* @api * @api
*/ */
const UNKNOWN_OPERATION = 11; public const UNKNOWN_OPERATION = 11;
/** /**
* Result: the requested operation cannot be performed because it can cause data (integrity) loss * Result: the requested operation cannot be performed because it can cause data (integrity) loss
* @api * @api
*/ */
const UNSAFE = 12; public const UNSAFE = 12;
/** /**
* Result: the request page number is not valid. It must be an integer greater than 0 * Result: the request page number is not valid. It must be an integer greater than 0
* @api * @api
*/ */
const INVALID_PAGE = 13; public const INVALID_PAGE = 13;
/** /**
* Result: the operation could not be performed, see the message for troubleshooting * Result: the operation could not be performed, see the message for troubleshooting
* @api * @api
*/ */
const INTERNAL_ERROR = 100; public const INTERNAL_ERROR = 100;
/** /**
* Default constructor - ok! * Default constructor - ok!

View File

@@ -44,7 +44,6 @@ class RestUtils
} }
} }
/** /**
* Read an optional parameter from a Rest/Json structure. * Read an optional parameter from a Rest/Json structure.
* *
@@ -66,7 +65,6 @@ class RestUtils
} }
} }
/** /**
* Read a class from a Rest/Json structure. * Read a class from a Rest/Json structure.
* *
@@ -87,7 +85,6 @@ class RestUtils
return $sClass; return $sClass;
} }
/** /**
* Read a list of attribute codes from a Rest/Json structure. * Read a list of attribute codes from a Rest/Json structure.
* *
@@ -103,7 +100,7 @@ class RestUtils
public static function GetFieldList($sClass, $oData, $sParamName) public static function GetFieldList($sClass, $oData, $sParamName)
{ {
$sFields = self::GetOptionalParam($oData, $sParamName, '*'); $sFields = self::GetOptionalParam($oData, $sParamName, '*');
$aShowFields = array(); $aShowFields = [];
if ($sFields == '*') { if ($sFields == '*') {
foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) { foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) {
$aShowFields[$sClass][] = $sAttCode; $aShowFields[$sClass][] = $sAttCode;
@@ -140,7 +137,7 @@ class RestUtils
*/ */
protected static function FindObjectFromCriteria($sClass, $oCriteria) protected static function FindObjectFromCriteria($sClass, $oCriteria)
{ {
$aCriteriaReport = array(); $aCriteriaReport = [];
if (isset($oCriteria->finalclass)) { if (isset($oCriteria->finalclass)) {
if (!MetaModel::IsValidClass($oCriteria->finalclass)) { if (!MetaModel::IsValidClass($oCriteria->finalclass)) {
throw new Exception("finalclass: Unknown class '".$oCriteria->finalclass."'"); throw new Exception("finalclass: Unknown class '".$oCriteria->finalclass."'");
@@ -171,7 +168,6 @@ class RestUtils
return $res; return $res;
} }
/** /**
* Find an object from a polymorph search specification (Rest/Json) * Find an object from a polymorph search specification (Rest/Json)
* *
@@ -260,7 +256,7 @@ class RestUtils
} else { } else {
throw new Exception("Wrong format for key"); throw new Exception("Wrong format for key");
} }
$oObjectSet = new DBObjectSet($oSearch, array(), array(), null, $iLimit, $iOffset); $oObjectSet = new DBObjectSet($oSearch, [], [], null, $iLimit, $iOffset);
return $oObjectSet; return $oObjectSet;
} }
@@ -291,7 +287,7 @@ class RestUtils
throw new Exception("A link set must be defined by an array of objects"); throw new Exception("A link set must be defined by an array of objects");
} }
$sLnkClass = $oAttDef->GetLinkedClass(); $sLnkClass = $oAttDef->GetLinkedClass();
$aLinks = array(); $aLinks = [];
foreach ($value as $oValues) { foreach ($value as $oValues) {
$oLnk = static::MakeObjectFromFields($sLnkClass, $oValues); $oLnk = static::MakeObjectFromFields($sLnkClass, $oValues);
// Fix for N°1939 // Fix for N°1939

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* This class manages the audit "categories". Each category defines a set of objects * This class manages the audit "categories". Each category defines a set of objects
* to check and is linked to a set of rules that determine the valid or invalid objects * to check and is linked to a set of rules that determine the valid or invalid objects
@@ -32,34 +32,36 @@ class AuditCategory extends cmdbAbstractObject
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "application,grant_by_profile", "category" => "application,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array('name'), "reconc_keys" => ['name'],
"db_table" => "priv_auditcategory", "db_table" => "priv_auditcategory",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-audit-folder.svg'), 'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-audit-folder.svg'),
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeString("name", array("description"=>"Short name for this category", "allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["description" => "Short name for this category", "allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("description", ["allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeOQL("definition_set", array("allowed_values"=>null, "sql"=>"definition_set", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeOQL("definition_set", ["allowed_values" => null, "sql" => "definition_set", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeLinkedSet("rules_list", array("linked_class"=>"AuditRule", "ext_key_to_me"=>"category_id", "allowed_values"=>null, "count_min"=>0, "count_max"=>0, "depends_on"=>array(), "edit_mode" => LINKSET_EDITMODE_INPLACE, "tracking_level" => LINKSET_TRACKING_ALL))); MetaModel::Init_AddAttribute(new AttributeLinkedSet("rules_list", ["linked_class" => "AuditRule", "ext_key_to_me" => "category_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => [], "edit_mode" => LINKSET_EDITMODE_INPLACE, "edit_when" => LINKSET_EDITWHEN_ALWAYS, "tracking_level" => LINKSET_TRACKING_ALL]));
MetaModel::Init_AddAttribute(new AttributeInteger("ok_error_tolerance", array("allowed_values"=>null, "sql"=>"ok_error_tolerance", "default_value"=>5, "is_null_allowed"=>true, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeInteger("ok_error_tolerance", ["allowed_values" => null, "sql" => "ok_error_tolerance", "default_value" => 5, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeInteger("warning_error_tolerance", array("allowed_values" => null, "sql" => "warning_error_tolerance", "default_value" => 25, "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeInteger("warning_error_tolerance", ["allowed_values" => null, "sql" => "warning_error_tolerance", "default_value" => 25, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect("domains_list", MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect(
array("linked_class" => "lnkAuditCategoryToAuditDomain", "ext_key_to_me" => "category_id", "ext_key_to_remote" => "domain_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => array(), "display_style" => 'property'))); "domains_list",
["linked_class" => "lnkAuditCategoryToAuditDomain", "ext_key_to_me" => "category_id", "ext_key_to_remote" => "domain_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => [], "display_style" => 'property']
));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('name', 'description', 'definition_set', 'ok_error_tolerance', 'warning_error_tolerance', 'rules_list', 'domains_list')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['name', 'description', 'definition_set', 'ok_error_tolerance', 'warning_error_tolerance', 'rules_list', 'domains_list']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('description', )); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['description', ]); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('description', 'definition_set')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['description', 'definition_set']); // Criteria of the std search form
MetaModel::Init_SetZListItems('default_search', array('name', 'description')); // Criteria of the default search form MetaModel::Init_SetZListItems('default_search', ['name', 'description']); // Criteria of the default search form
} }
/** /**
@@ -93,4 +95,3 @@ class AuditCategory extends cmdbAbstractObject
return $aShortcutActions; return $aShortcutActions;
} }
} }
?>

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* This class manages the audit "categories". Each category defines a set of objects * This class manages the audit "categories". Each category defines a set of objects
* to check and is linked to a set of rules that determine the valid or invalid objects * to check and is linked to a set of rules that determine the valid or invalid objects
@@ -33,32 +33,34 @@ class AuditDomain extends cmdbAbstractObject
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "application,grant_by_profile", "category" => "application,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"complementary_name_attcode" => array('description'), "complementary_name_attcode" => ['description'],
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array('name'), "reconc_keys" => ['name'],
"db_table" => "priv_auditdomain", "db_table" => "priv_auditdomain",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-audit-album.svg'), 'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-audit-album.svg'),
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeString("name", array("description" => "Short name for this category", "allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["description" => "Short name for this category", "allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("description", ["allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeImage("icon", array("is_null_allowed" => true, "depends_on" => array(), "display_max_width" => 96, "display_max_height" => 96, "storage_max_width" => 256, "storage_max_height" => 256, "default_image" => null, "always_load_in_tables" => false))); MetaModel::Init_AddAttribute(new AttributeImage("icon", ["is_null_allowed" => true, "depends_on" => [], "display_max_width" => 96, "display_max_height" => 96, "storage_max_width" => 256, "storage_max_height" => 256, "default_image" => null, "always_load_in_tables" => false]));
MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect("categories_list", MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect(
array("linked_class" => "lnkAuditCategoryToAuditDomain", "ext_key_to_me" => "domain_id", "ext_key_to_remote" => "category_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => array()))); "categories_list",
["linked_class" => "lnkAuditCategoryToAuditDomain", "ext_key_to_me" => "domain_id", "ext_key_to_remote" => "category_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => []]
));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('name', 'description', 'icon', 'categories_list')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['name', 'description', 'icon', 'categories_list']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('description',)); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['description',]); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('description')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['description']); // Criteria of the std search form
MetaModel::Init_SetZListItems('default_search', array('name', 'description')); // Criteria of the default search form MetaModel::Init_SetZListItems('default_search', ['name', 'description']); // Criteria of the default search form
} }
public static function GetShortcutActions($sFinalClass) public static function GetShortcutActions($sFinalClass)
@@ -84,40 +86,39 @@ class lnkAuditCategoryToAuditDomain extends cmdbAbstractObject
*/ */
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "application,grant_by_profile", "category" => "application,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "", "name_attcode" => "",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array('category_id', 'domain_id'), "reconc_keys" => ['category_id', 'domain_id'],
"db_table" => "priv_link_audit_category_domain", "db_table" => "priv_link_audit_category_domain",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
"is_link" => true, "is_link" => true,
'uniqueness_rules' => array( 'uniqueness_rules' => [
'no_duplicate' => array( 'no_duplicate' => [
'attributes' => array( 'attributes' => [
0 => 'category_id', 0 => 'category_id',
1 => 'domain_id', 1 => 'domain_id',
), ],
'filter' => '', 'filter' => '',
'disabled' => false, 'disabled' => false,
'is_blocking' => true, 'is_blocking' => true,
), ],
), ],
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeExternalKey("category_id", array("targetclass" => "AuditCategory", "jointype" => '', "allowed_values" => null, "sql" => "category_id", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("category_id", ["targetclass" => "AuditCategory", "jointype" => '', "allowed_values" => null, "sql" => "category_id", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("category_name", array("allowed_values" => null, "extkey_attcode" => 'category_id', "target_attcode" => "name"))); MetaModel::Init_AddAttribute(new AttributeExternalField("category_name", ["allowed_values" => null, "extkey_attcode" => 'category_id', "target_attcode" => "name"]));
MetaModel::Init_AddAttribute(new AttributeExternalKey("domain_id", array("targetclass" => "AuditDomain", "jointype" => '', "allowed_values" => null, "sql" => "domain_id", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("domain_id", ["targetclass" => "AuditDomain", "jointype" => '', "allowed_values" => null, "sql" => "domain_id", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("domain_name", array("allowed_values" => null, "extkey_attcode" => 'domain_id', "target_attcode" => "name"))); MetaModel::Init_AddAttribute(new AttributeExternalField("domain_name", ["allowed_values" => null, "extkey_attcode" => 'domain_id', "target_attcode" => "name"]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('category_id', 'domain_id')); MetaModel::Init_SetZListItems('details', ['category_id', 'domain_id']);
MetaModel::Init_SetZListItems('list', array('category_id', 'domain_id')); MetaModel::Init_SetZListItems('list', ['category_id', 'domain_id']);
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('category_id', 'domain_id')); MetaModel::Init_SetZListItems('standard_search', ['category_id', 'domain_id']);
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* This class manages the audit "rule" linked to a given audit category. * This class manages the audit "rule" linked to a given audit category.
* Each rule is based on an OQL expression that returns either the "good" objects * Each rule is based on an OQL expression that returns either the "good" objects
@@ -33,35 +33,35 @@ class AuditRule extends cmdbAbstractObject
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "application,grant_by_profile", "category" => "application,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array('name'), "reconc_keys" => ['name'],
"db_table" => "priv_auditrule", "db_table" => "priv_auditrule",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-audit.svg'), 'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-audit.svg'),
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("description", ["allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeOQL("query", array("allowed_values" => null, "sql" => "query", "default_value" => "", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeOQL("query", ["allowed_values" => null, "sql" => "query", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("valid_flag", array("allowed_values" => new ValueSetEnum('true,false'), "sql" => "valid_flag", "default_value" => "true", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeEnum("valid_flag", ["allowed_values" => new ValueSetEnum('true,false'), "sql" => "valid_flag", "default_value" => "true", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalKey("category_id", array("allowed_values" => null, "sql" => "category_id", "targetclass" => "AuditCategory", "is_null_allowed" => false, "on_target_delete" => DEL_MANUAL, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("category_id", ["allowed_values" => null, "sql" => "category_id", "targetclass" => "AuditCategory", "is_null_allowed" => false, "on_target_delete" => DEL_MANUAL, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("category_name", array("allowed_values" => null, "extkey_attcode" => 'category_id', "target_attcode" => "name"))); MetaModel::Init_AddAttribute(new AttributeExternalField("category_name", ["allowed_values" => null, "extkey_attcode" => 'category_id', "target_attcode" => "name"]));
MetaModel::Init_AddAttribute(new AttributeExternalKey("contact_id", ["allowed_values" => null, "sql" => "contact_id", "targetclass" => "Contact", "is_null_allowed" => true, "on_target_delete" => DEL_MANUAL, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeHTML("process", ["allowed_values" => null, "sql" => "process", "default_value" => "", "is_null_allowed" => true, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('category_id', 'name', 'description', 'query', 'valid_flag')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['category_id', 'name', 'description', 'query', 'valid_flag', 'process', 'contact_id']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('category_id', 'description', 'valid_flag')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['category_id', 'description', 'query']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('category_id', 'name', 'description', 'valid_flag', 'query')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['category_id', 'name', 'description', 'valid_flag', 'query']); // Criteria of the std search form
MetaModel::Init_SetZListItems('default_search', array('name', 'description', 'category_id')); // Criteria of the advanced search form MetaModel::Init_SetZListItems('default_search', ['name', 'description', 'category_id', 'contact_id', 'query']); // Criteria of the advanced search form
} }
public static function GetShortcutActions($sFinalClass) public static function GetShortcutActions($sFinalClass)
{ {
$aShortcutActions = parent::GetShortcutActions($sFinalClass); $aShortcutActions = parent::GetShortcutActions($sFinalClass);
@@ -72,4 +72,3 @@ class AuditRule extends cmdbAbstractObject
return $aShortcutActions; return $aShortcutActions;
} }
} }
?>

File diff suppressed because it is too large Load Diff

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* Copyright (C) 2013-2024 Combodo SAS * Copyright (C) 2013-2024 Combodo SAS
* *
@@ -32,7 +33,8 @@ class CompileCSSService
{ {
} }
public function CompileCSSFromSASS($sSassContent, $aImportPaths = [], $aVariables = []){ public function CompileCSSFromSASS($sSassContent, $aImportPaths = [], $aVariables = [])
{
return utils::CompileCSSFromSASS($sSassContent, $aImportPaths, $aVariables); return utils::CompileCSSFromSASS($sSassContent, $aImportPaths, $aVariables);
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -53,7 +54,7 @@ abstract class Dashboard
$this->sLayoutClass = 'DashboardLayoutOneCol'; $this->sLayoutClass = 'DashboardLayoutOneCol';
$this->bAutoReload = false; $this->bAutoReload = false;
$this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval(); $this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval();
$this->aCells = array(); $this->aCells = [];
$this->oDOMNode = null; $this->oDOMNode = null;
$this->sId = $sId; $this->sId = $sId;
} }
@@ -65,8 +66,8 @@ abstract class Dashboard
*/ */
public function FromXml($sXml) public function FromXml($sXml)
{ {
$this->aCells = array(); // reset the content of the dashboard $this->aCells = []; // reset the content of the dashboard
set_error_handler(array('Dashboard', 'ErrorHandler')); set_error_handler(['Dashboard', 'ErrorHandler']);
$oDoc = new DOMDocument(); $oDoc = new DOMDocument();
$oDoc->loadXML($sXml); $oDoc->loadXML($sXml);
restore_error_handler(); restore_error_handler();
@@ -80,86 +81,68 @@ abstract class Dashboard
{ {
$this->oDOMNode = $oDoc->getElementsByTagName('dashboard')->item(0); $this->oDOMNode = $oDoc->getElementsByTagName('dashboard')->item(0);
if ($oLayoutNode = $this->oDOMNode->getElementsByTagName('layout')->item(0)) if ($oLayoutNode = $this->oDOMNode->getElementsByTagName('layout')->item(0)) {
{
$this->sLayoutClass = $oLayoutNode->textContent; $this->sLayoutClass = $oLayoutNode->textContent;
} } else {
else
{
$this->sLayoutClass = 'DashboardLayoutOneCol'; $this->sLayoutClass = 'DashboardLayoutOneCol';
} }
if ($oTitleNode = $this->oDOMNode->getElementsByTagName('title')->item(0)) if ($oTitleNode = $this->oDOMNode->getElementsByTagName('title')->item(0)) {
{
$this->sTitle = $oTitleNode->textContent; $this->sTitle = $oTitleNode->textContent;
} } else {
else
{
$this->sTitle = ''; $this->sTitle = '';
} }
$this->bAutoReload = false; $this->bAutoReload = false;
$this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval(); $this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval();
if ($oAutoReloadNode = $this->oDOMNode->getElementsByTagName('auto_reload')->item(0)) if ($oAutoReloadNode = $this->oDOMNode->getElementsByTagName('auto_reload')->item(0)) {
{ if ($oAutoReloadEnabled = $oAutoReloadNode->getElementsByTagName('enabled')->item(0)) {
if ($oAutoReloadEnabled = $oAutoReloadNode->getElementsByTagName('enabled')->item(0))
{
$this->bAutoReload = ($oAutoReloadEnabled->textContent == 'true'); $this->bAutoReload = ($oAutoReloadEnabled->textContent == 'true');
} }
if ($oAutoReloadInterval = $oAutoReloadNode->getElementsByTagName('interval')->item(0)) if ($oAutoReloadInterval = $oAutoReloadNode->getElementsByTagName('interval')->item(0)) {
{
$this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int)$oAutoReloadInterval->textContent); $this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int)$oAutoReloadInterval->textContent);
} }
} }
if ($oCellsNode = $this->oDOMNode->getElementsByTagName('cells')->item(0)) if ($oCellsNode = $this->oDOMNode->getElementsByTagName('cells')->item(0)) {
{
$oCellsList = $oCellsNode->getElementsByTagName('cell'); $oCellsList = $oCellsNode->getElementsByTagName('cell');
$aCellOrder = array(); $aCellOrder = [];
$iCellRank = 0; $iCellRank = 0;
/** @var \DOMElement $oCellNode */ /** @var \DOMElement $oCellNode */
foreach($oCellsList as $oCellNode) foreach ($oCellsList as $oCellNode) {
{
$oCellRank = $oCellNode->getElementsByTagName('rank')->item(0); $oCellRank = $oCellNode->getElementsByTagName('rank')->item(0);
if ($oCellRank) if ($oCellRank) {
{
$iCellRank = (float)$oCellRank->textContent; $iCellRank = (float)$oCellRank->textContent;
} }
$oDashletsNode = $oCellNode->getElementsByTagName('dashlets')->item(0); $oDashletsNode = $oCellNode->getElementsByTagName('dashlets')->item(0);
{ {
$oDashletList = $oDashletsNode->getElementsByTagName('dashlet'); $oDashletList = $oDashletsNode->getElementsByTagName('dashlet');
$iRank = 0; $iRank = 0;
$aDashletOrder = array(); $aDashletOrder = [];
/** @var \DOMElement $oDomNode */ /** @var \DOMElement $oDomNode */
foreach($oDashletList as $oDomNode) foreach ($oDashletList as $oDomNode) {
{
$oRank = $oDomNode->getElementsByTagName('rank')->item(0); $oRank = $oDomNode->getElementsByTagName('rank')->item(0);
if ($oRank) if ($oRank) {
{
$iRank = (float)$oRank->textContent; $iRank = (float)$oRank->textContent;
} }
$oNewDashlet = $this->InitDashletFromDOMNode($oDomNode); $oNewDashlet = $this->InitDashletFromDOMNode($oDomNode);
$aDashletOrder[] = array('rank' => $iRank, 'dashlet' => $oNewDashlet); $aDashletOrder[] = ['rank' => $iRank, 'dashlet' => $oNewDashlet];
} }
usort($aDashletOrder, array(get_class($this), 'SortOnRank')); usort($aDashletOrder, [get_class($this), 'SortOnRank']);
$aDashletList = array(); $aDashletList = [];
foreach($aDashletOrder as $aItem) foreach ($aDashletOrder as $aItem) {
{
$aDashletList[] = $aItem['dashlet']; $aDashletList[] = $aItem['dashlet'];
} }
$aCellOrder[] = array('rank' => $iCellRank, 'dashlets' => $aDashletList); $aCellOrder[] = ['rank' => $iCellRank, 'dashlets' => $aDashletList];
} }
} }
usort($aCellOrder, array(get_class($this), 'SortOnRank')); usort($aCellOrder, [get_class($this), 'SortOnRank']);
foreach($aCellOrder as $aItem) foreach ($aCellOrder as $aItem) {
{
$this->aCells[] = $aItem['dashlets']; $this->aCells[] = $aItem['dashlets'];
} }
} } else {
else $this->aCells = [];
{
$this->aCells = array();
} }
} }
@@ -208,12 +191,9 @@ abstract class Dashboard
*/ */
public static function ErrorHandler($errno, $errstr, $errfile, $errline) public static function ErrorHandler($errno, $errstr, $errfile, $errline)
{ {
if ($errno == E_WARNING && (substr_count($errstr,"DOMDocument::loadXML()")>0)) if ($errno == E_WARNING && (substr_count($errstr, "DOMDocument::loadXML()") > 0)) {
{
throw new DOMException($errstr); throw new DOMException($errstr);
} } else {
else
{
return false; return false;
} }
} }
@@ -263,8 +243,7 @@ abstract class Dashboard
$oDefinition->appendChild($oCellsNode); $oDefinition->appendChild($oCellsNode);
$iCellRank = 0; $iCellRank = 0;
foreach ($this->aCells as $aCell) foreach ($this->aCells as $aCell) {
{
$oCellNode = $oDoc->createElement('cell'); $oCellNode = $oDoc->createElement('cell');
$oCellNode->setAttribute('id', $iCellRank); $oCellNode->setAttribute('id', $iCellRank);
$oCellsNode->appendChild($oCellNode); $oCellsNode->appendChild($oCellNode);
@@ -276,8 +255,7 @@ abstract class Dashboard
$oDashletsNode = $oDoc->createElement('dashlets'); $oDashletsNode = $oDoc->createElement('dashlets');
$oCellNode->appendChild($oDashletsNode); $oCellNode->appendChild($oDashletsNode);
/** @var \Dashlet $oDashlet */ /** @var \Dashlet $oDashlet */
foreach ($aCell as $oDashlet) foreach ($aCell as $oDashlet) {
{
$oNode = $oDoc->createElement('dashlet'); $oNode = $oDoc->createElement('dashlet');
$oDashletsNode->appendChild($oNode); $oDashletsNode->appendChild($oNode);
$oNode->setAttribute('id', $oDashlet->GetID()); $oNode->setAttribute('id', $oDashlet->GetID());
@@ -304,7 +282,7 @@ abstract class Dashboard
$this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int) $aParams['auto_reload_sec']); $this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int) $aParams['auto_reload_sec']);
foreach ($aParams['cells'] as $aCell) { foreach ($aParams['cells'] as $aCell) {
$aCellDashlets = array(); $aCellDashlets = [];
foreach ($aCell as $aDashletParams) { foreach ($aCell as $aDashletParams) {
$sDashletClass = $aDashletParams['dashlet_class']; $sDashletClass = $aDashletParams['dashlet_class'];
$sId = $aDashletParams['dashlet_id']; $sId = $aDashletParams['dashlet_id'];
@@ -420,7 +398,7 @@ abstract class Dashboard
{ {
$sId = $this->GetNewDashletId(); $sId = $this->GetNewDashletId();
$oDashlet->SetId($sId); $oDashlet->SetId($sId);
$this->aCells[] = array($oDashlet); $this->aCells[] = [$oDashlet];
} }
/** /**
@@ -430,7 +408,7 @@ abstract class Dashboard
* @throws \ReflectionException * @throws \ReflectionException
* @throws \Exception * @throws \Exception
*/ */
public function RenderProperties($oPage, $aExtraParams = array()) public function RenderProperties($oPage, $aExtraParams = [])
{ {
// menu to pick a layout and edit other properties of the dashboard // menu to pick a layout and edit other properties of the dashboard
$oPage->add('<div class="ui-widget-content ui-corner-all ibo-dashboard-editor--properties"><div class="ui-widget-header ui-corner-all ibo-dashboard-editor--properties-title">'.Dict::S('UI:DashboardEdit:Properties').'</div>'); $oPage->add('<div class="ui-widget-content ui-corner-all ibo-dashboard-editor--properties"><div class="ui-widget-header ui-corner-all ibo-dashboard-editor--properties-title">'.Dict::S('UI:DashboardEdit:Properties').'</div>');
@@ -442,7 +420,7 @@ abstract class Dashboard
if (is_subclass_of($sLayoutClass, 'DashboardLayout')) { if (is_subclass_of($sLayoutClass, 'DashboardLayout')) {
$oReflection = new ReflectionClass($sLayoutClass); $oReflection = new ReflectionClass($sLayoutClass);
if (!$oReflection->isAbstract()) { if (!$oReflection->isAbstract()) {
$aCallSpec = array($sLayoutClass, 'GetInfo'); $aCallSpec = [$sLayoutClass, 'GetInfo'];
$aInfo = call_user_func($aCallSpec); $aInfo = call_user_func($aCallSpec);
$sChecked = ($this->sLayoutClass == $sLayoutClass) ? 'checked' : ''; $sChecked = ($this->sLayoutClass == $sLayoutClass) ? 'checked' : '';
$oPage->add('<input type="radio" name="layout_class" '.$sChecked.' value="'.$sLayoutClass.'" id="layout_'.$sLayoutClass.'"><label for="layout_'.$sLayoutClass.'"><img src="'.$sUrl.$aInfo['icon'].'" class="ibo-dashboard--properties--icon" data-role="ibo-dashboard--properties--icon"/></label>'); // title="" on either the img or the label does nothing ! $oPage->add('<input type="radio" name="layout_class" '.$sChecked.' value="'.$sLayoutClass.'" id="layout_'.$sLayoutClass.'"><label for="layout_'.$sLayoutClass.'"><img src="'.$sUrl.$aInfo['icon'].'" class="ibo-dashboard--properties--icon" data-role="ibo-dashboard--properties--icon"/></label>'); // title="" on either the img or the label does nothing !
@@ -466,7 +444,6 @@ abstract class Dashboard
$oField->SetBoundaries(MetaModel::GetConfig()->Get('min_reload_interval'), null); // no upper limit $oField->SetBoundaries(MetaModel::GetConfig()->Get('min_reload_interval'), null); // no upper limit
$oForm->AddField($oField); $oForm->AddField($oField);
$this->SetFormParams($oForm, $aExtraParams); $this->SetFormParams($oForm, $aExtraParams);
$oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard'); $oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard');
@@ -522,7 +499,7 @@ EOF
* *
* @return \Combodo\iTop\Application\UI\Base\Layout\Dashboard\DashboardLayout * @return \Combodo\iTop\Application\UI\Base\Layout\Dashboard\DashboardLayout
*/ */
public function Render($oPage, $bEditMode = false, $aExtraParams = array(), $bCanEdit = true) public function Render($oPage, $bEditMode = false, $aExtraParams = [], $bCanEdit = true)
{ {
$aExtraParams['dashboard_div_id'] = utils::Sanitize($aExtraParams['dashboard_div_id'] ?? null, $this->GetId(), utils::ENUM_SANITIZATION_FILTER_ELEMENT_IDENTIFIER); $aExtraParams['dashboard_div_id'] = utils::Sanitize($aExtraParams['dashboard_div_id'] ?? null, $this->GetId(), utils::ENUM_SANITIZATION_FILTER_ELEMENT_IDENTIFIER);
@@ -551,7 +528,8 @@ EOF
$oToolbar->AddHtml($sHtml); $oToolbar->AddHtml($sHtml);
} else { } else {
$oPage->add_script(<<<JS $oPage->add_script(
<<<JS
$(".ibo-top-bar--toolbar-dashboard-title").html("$sTitleForHTML").attr("title", $('<div>').html("$sTitleForHTML").text()); $(".ibo-top-bar--toolbar-dashboard-title").html("$sTitleForHTML").attr("title", $('<div>').html("$sTitleForHTML").text());
JS JS
); );
@@ -595,7 +573,7 @@ JS
* @param WebPage $oPage * @param WebPage $oPage
* @param array $aExtraParams * @param array $aExtraParams
*/ */
public function RenderDashletsProperties(WebPage $oPage, $aExtraParams = array()) public function RenderDashletsProperties(WebPage $oPage, $aExtraParams = [])
{ {
// Toolbox/palette to edit the properties of each dashlet // Toolbox/palette to edit the properties of each dashlet
$oPage->add('<div class="ui-widget-content ui-corner-all ibo-dashlet--properties"><div class="ui-widget-header ui-corner-all ibo-dashlet--properties--title">'.Dict::S('UI:DashboardEdit:DashletProperties').'</div>'); $oPage->add('<div class="ui-widget-content ui-corner-all ibo-dashlet--properties"><div class="ui-widget-header ui-corner-all ibo-dashlet--properties--title">'.Dict::S('UI:DashboardEdit:DashletProperties').'</div>');
@@ -604,13 +582,10 @@ JS
$oLayout = new $this->sLayoutClass(); $oLayout = new $this->sLayoutClass();
$oPage->add('<div id="dashlet_properties">'); $oPage->add('<div id="dashlet_properties">');
foreach($this->aCells as $iCellIdx => $aCell) foreach ($this->aCells as $iCellIdx => $aCell) {
{
/** @var \Dashlet $oDashlet */ /** @var \Dashlet $oDashlet */
foreach($aCell as $oDashlet) foreach ($aCell as $oDashlet) {
{ if ($oDashlet->IsVisible()) {
if ($oDashlet->IsVisible())
{
$oPage->add('<div class="dashlet_properties" id="dashlet_properties_'.$oDashlet->GetID().'" style="display:none">'); $oPage->add('<div class="dashlet_properties" id="dashlet_properties_'.$oDashlet->GetID().'" style="display:none">');
$oForm = $oDashlet->GetForm(); $oForm = $oDashlet->GetForm();
$this->SetFormParams($oForm, $aExtraParams); $this->SetFormParams($oForm, $aExtraParams);
@@ -632,18 +607,17 @@ JS
*/ */
protected function GetAvailableDashlets() protected function GetAvailableDashlets()
{ {
$aDashlets = array(); $aDashlets = [];
foreach( get_declared_classes() as $sDashletClass) foreach (get_declared_classes() as $sDashletClass) {
{
// DashletUnknown is not among the selection as it is just a fallback for dashlets that can't instantiated. // DashletUnknown is not among the selection as it is just a fallback for dashlets that can't instantiated.
if (is_subclass_of($sDashletClass, 'Dashlet') && !in_array($sDashletClass, array('DashletUnknown', 'DashletProxy'))) { if (is_subclass_of($sDashletClass, 'Dashlet') && !in_array($sDashletClass, ['DashletUnknown', 'DashletProxy'])) {
$oReflection = new ReflectionClass($sDashletClass); $oReflection = new ReflectionClass($sDashletClass);
if (!$oReflection->isAbstract()) { if (!$oReflection->isAbstract()) {
$aCallSpec = array($sDashletClass, 'IsVisible'); $aCallSpec = [$sDashletClass, 'IsVisible'];
$bVisible = call_user_func($aCallSpec); $bVisible = call_user_func($aCallSpec);
if ($bVisible) { if ($bVisible) {
$aCallSpec = array($sDashletClass, 'GetInfo'); $aCallSpec = [$sDashletClass, 'GetInfo'];
$aInfo = call_user_func($aCallSpec); $aInfo = call_user_func($aCallSpec);
$aDashlets[$sDashletClass] = $aInfo; $aDashlets[$sDashletClass] = $aInfo;
} }
@@ -660,11 +634,9 @@ JS
protected function GetNewDashletId() protected function GetNewDashletId()
{ {
$iNewId = 0; $iNewId = 0;
foreach($this->aCells as $aDashlets) foreach ($this->aCells as $aDashlets) {
{
/** @var \Dashlet $oDashlet */ /** @var \Dashlet $oDashlet */
foreach($aDashlets as $oDashlet) foreach ($aDashlets as $oDashlet) {
{
$iNewId = max($iNewId, (int)$oDashlet->GetID()); $iNewId = max($iNewId, (int)$oDashlet->GetID());
} }
} }
@@ -681,7 +653,7 @@ JS
* *
* @return void * @return void
*/ */
abstract protected function PrepareDashletForRendering(Dashlet $oDashlet, $aCoordinates, $aExtraParams = array()); abstract protected function PrepareDashletForRendering(Dashlet $oDashlet, $aCoordinates, $aExtraParams = []);
/** /**
* @param \DesignerForm $oForm * @param \DesignerForm $oForm
@@ -689,7 +661,7 @@ JS
* *
* @return mixed * @return mixed
*/ */
abstract protected function SetFormParams($oForm, $aExtraParams = array()); abstract protected function SetFormParams($oForm, $aExtraParams = []);
/** /**
* @param string $sType * @param string $sType
@@ -699,8 +671,7 @@ JS
*/ */
public static function GetDashletClassFromType($sType, $oFactory = null) public static function GetDashletClassFromType($sType, $oFactory = null)
{ {
if (is_subclass_of($sType, 'Dashlet')) if (is_subclass_of($sType, 'Dashlet')) {
{
return $sType; return $sType;
} }
return 'DashletUnknown'; return 'DashletUnknown';
@@ -723,14 +694,12 @@ JS
*/ */
public static function GetDashletUniqueId($bIsCustomized, $sDashboardDivId, $iRow, $iCol, $sDashletOrigId) public static function GetDashletUniqueId($bIsCustomized, $sDashboardDivId, $iRow, $iCol, $sDashletOrigId)
{ {
if(strpos($sDashletOrigId, '_ID_row') !== false) if (strpos($sDashletOrigId, '_ID_row') !== false) {
{
return $sDashletOrigId; return $sDashletOrigId;
} }
$sDashletId = $sDashboardDivId."_ID_row".$iRow."_col".$iCol."_".$sDashletOrigId; $sDashletId = $sDashboardDivId."_ID_row".$iRow."_col".$iCol."_".$sDashletOrigId;
if ($bIsCustomized) if ($bIsCustomized) {
{
$sDashletId = 'CUSTOM_'.$sDashletId; $sDashletId = 'CUSTOM_'.$sDashletId;
} }
@@ -782,9 +751,9 @@ class RuntimeDashboard extends Dashboard
* @inheritDoc * @inheritDoc
* @throws \Exception * @throws \Exception
*/ */
protected function SetFormParams($oForm, $aExtraParams = array()) protected function SetFormParams($oForm, $aExtraParams = [])
{ {
$oForm->SetSubmitParams(utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php', array('operation' => 'update_dashlet_property', 'extra_params' => $aExtraParams)); $oForm->SetSubmitParams(utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php', ['operation' => 'update_dashlet_property', 'extra_params' => $aExtraParams]);
} }
/** /**
@@ -800,14 +769,11 @@ class RuntimeDashboard extends Dashboard
$oUDSearch->AddCondition('menu_code', $this->sId, '='); $oUDSearch->AddCondition('menu_code', $this->sId, '=');
$oUDSet = new DBObjectSet($oUDSearch); $oUDSet = new DBObjectSet($oUDSearch);
$bIsNew = false; $bIsNew = false;
if ($oUDSet->Count() > 0) if ($oUDSet->Count() > 0) {
{
// Assuming there is at most one couple {user, menu}! // Assuming there is at most one couple {user, menu}!
$oUserDashboard = $oUDSet->Fetch(); $oUserDashboard = $oUDSet->Fetch();
$oUserDashboard->Set('contents', $sXml); $oUserDashboard->Set('contents', $sXml);
} } else {
else
{
// No such customized dashboard for the current user, let's create a new record // No such customized dashboard for the current user, let's create a new record
$oUserDashboard = new UserDashboard(); $oUserDashboard = new UserDashboard();
$oUserDashboard->Set('user_id', UserRights::GetUserId()); $oUserDashboard->Set('user_id', UserRights::GetUserId());
@@ -838,8 +804,7 @@ class RuntimeDashboard extends Dashboard
$oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '='); $oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
$oUDSearch->AddCondition('menu_code', $this->sId, '='); $oUDSearch->AddCondition('menu_code', $this->sId, '=');
$oUDSet = new DBObjectSet($oUDSearch); $oUDSet = new DBObjectSet($oUDSearch);
if ($oUDSet->Count() > 0) if ($oUDSet->Count() > 0) {
{
// Assuming there is at most one couple {user, menu}! // Assuming there is at most one couple {user, menu}!
$oUserDashboard = $oUDSet->Fetch(); $oUserDashboard = $oUDSet->Fetch();
utils::PushArchiveMode(false); utils::PushArchiveMode(false);
@@ -883,14 +848,11 @@ class RuntimeDashboard extends Dashboard
} else { } else {
$sDashboardDefinition = @file_get_contents($sDashboardFileSanitized); $sDashboardDefinition = @file_get_contents($sDashboardFileSanitized);
} }
} } else {
else
{
$sDashboardDefinition = @file_get_contents($sDashboardFileSanitized); $sDashboardDefinition = @file_get_contents($sDashboardFileSanitized);
} }
if ($sDashboardDefinition !== false) if ($sDashboardDefinition !== false) {
{
$oDashboard = new RuntimeDashboard($sDashBoardId); $oDashboard = new RuntimeDashboard($sDashBoardId);
$oDashboard->FromXml($sDashboardDefinition); $oDashboard->FromXml($sDashboardDefinition);
$oDashboard->SetCustomFlag($bCustomized); $oDashboard->SetCustomFlag($bCustomized);
@@ -937,7 +899,6 @@ class RuntimeDashboard extends Dashboard
$sDashboardDefinition = @file_get_contents($sDashboardFileSanitized); $sDashboardDefinition = @file_get_contents($sDashboardFileSanitized);
} }
if ($sDashboardDefinition !== false) { if ($sDashboardDefinition !== false) {
$oDashboard = new RuntimeDashboard($sDashBoardId); $oDashboard = new RuntimeDashboard($sDashBoardId);
$oDashboard->FromXml($sDashboardDefinition); $oDashboard->FromXml($sDashboardDefinition);
@@ -954,11 +915,11 @@ class RuntimeDashboard extends Dashboard
* @inheritDoc * @inheritDoc
* @throws \Exception * @throws \Exception
*/ */
public function Render($oPage, $bEditMode = false, $aExtraParams = array(), $bCanEdit = true) public function Render($oPage, $bEditMode = false, $aExtraParams = [], $bCanEdit = true)
{ {
if (!isset($aExtraParams['query_params']) && isset($aExtraParams['this->class'])) { if (!isset($aExtraParams['query_params']) && isset($aExtraParams['this->class'])) {
$oObj = MetaModel::GetObject($aExtraParams['this->class'], $aExtraParams['this->id']); $oObj = MetaModel::GetObject($aExtraParams['this->class'], $aExtraParams['this->id']);
$aRenderParams = array('query_params' => $oObj->ToArgsForQuery()); $aRenderParams = ['query_params' => $oObj->ToArgsForQuery()];
} else { } else {
$aRenderParams = $aExtraParams; $aRenderParams = $aExtraParams;
} }
@@ -968,7 +929,7 @@ class RuntimeDashboard extends Dashboard
if (isset($aExtraParams['query_params']['this->object()'])) { if (isset($aExtraParams['query_params']['this->object()'])) {
/** @var \DBObject $oObj */ /** @var \DBObject $oObj */
$oObj = $aExtraParams['query_params']['this->object()']; $oObj = $aExtraParams['query_params']['this->object()'];
$aAjaxParams = array('this->class' => get_class($oObj), 'this->id' => $oObj->GetKey()); $aAjaxParams = ['this->class' => get_class($oObj), 'this->id' => $oObj->GetKey()];
if (isset($aExtraParams['from_dashboard_page'])) { if (isset($aExtraParams['from_dashboard_page'])) {
$aAjaxParams['from_dashboard_page'] = $aExtraParams['from_dashboard_page']; $aAjaxParams['from_dashboard_page'] = $aExtraParams['from_dashboard_page'];
} }
@@ -1001,9 +962,7 @@ class RuntimeDashboard extends Dashboard
} }
JS JS
); );
} } else {
else
{
$oPage->add_script( $oPage->add_script(
<<<EOF <<<EOF
if (typeof(AutoReloadDashboardId$sDivId) !== 'undefined') if (typeof(AutoReloadDashboardId$sDivId) !== 'undefined')
@@ -1032,7 +991,7 @@ EOF
* @throws \CoreUnexpectedValue * @throws \CoreUnexpectedValue
* @throws \MySQLException * @throws \MySQLException
*/ */
protected function RenderSelector(WebPage $oPage, DashboardLayoutUIBlock $oDashboard, $aAjaxParams = array()) protected function RenderSelector(WebPage $oPage, DashboardLayoutUIBlock $oDashboard, $aAjaxParams = [])
{ {
if (!$this->HasCustomDashboard()) { if (!$this->HasCustomDashboard()) {
return; return;
@@ -1092,8 +1051,7 @@ JS
*/ */
protected function HasCustomDashboard() protected function HasCustomDashboard()
{ {
try try {
{
// Search for an eventual user defined dashboard // Search for an eventual user defined dashboard
$oUDSearch = new DBObjectSearch('UserDashboard'); $oUDSearch = new DBObjectSearch('UserDashboard');
$oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '='); $oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
@@ -1101,9 +1059,7 @@ JS
$oUDSet = new DBObjectSet($oUDSearch); $oUDSet = new DBObjectSet($oUDSearch);
return ($oUDSet->Count() > 0); return ($oUDSet->Count() > 0);
} } catch (Exception $e) {
catch (Exception $e)
{
return false; return false;
} }
} }
@@ -1139,21 +1095,23 @@ JS
->AddCSSClass('ibo-action-button'); ->AddCSSClass('ibo-action-button');
$oToolbar->AddSubBlock($oActionButton); $oToolbar->AddSubBlock($oActionButton);
$aActions = array(); $aActions = [];
$sFile = addslashes(utils::LocalPath($this->sDefinitionFile)); $sFile = addslashes(utils::LocalPath($this->sDefinitionFile));
$sJSExtraParams = json_encode($aExtraParams); $sJSExtraParams = json_encode($aExtraParams);
if ($this->HasCustomDashboard()) { if ($this->HasCustomDashboard()) {
$oEdit = new JSPopupMenuItem('UI:Dashboard:Edit', Dict::S('UI:Dashboard:EditCustom'), "return EditDashboard('{$this->sId}', '$sFile', $sJSExtraParams)"); $oEdit = new JSPopupMenuItem('UI:Dashboard:Edit', Dict::S('UI:Dashboard:EditCustom'), "return EditDashboard('{$this->sId}', '$sFile', $sJSExtraParams)");
$aActions[$oEdit->GetUID()] = $oEdit->GetMenuItem(); $aActions[$oEdit->GetUID()] = $oEdit->GetMenuItem();
$oRevert = new JSPopupMenuItem('UI:Dashboard:RevertConfirm', Dict::S('UI:Dashboard:DeleteCustom'), $oRevert = new JSPopupMenuItem(
"if (confirm('".addslashes(Dict::S('UI:Dashboard:RevertConfirm'))."')) return RevertDashboard('{$this->sId}', $sJSExtraParams); else return false"); 'UI:Dashboard:RevertConfirm',
Dict::S('UI:Dashboard:DeleteCustom'),
"if (confirm('".addslashes(Dict::S('UI:Dashboard:RevertConfirm'))."')) return RevertDashboard('{$this->sId}', $sJSExtraParams); else return false"
);
$aActions[$oRevert->GetUID()] = $oRevert->GetMenuItem(); $aActions[$oRevert->GetUID()] = $oRevert->GetMenuItem();
} else { } else {
$oEdit = new JSPopupMenuItem('UI:Dashboard:Edit', Dict::S('UI:Dashboard:CreateCustom'), "return EditDashboard('{$this->sId}', '$sFile', $sJSExtraParams)"); $oEdit = new JSPopupMenuItem('UI:Dashboard:Edit', Dict::S('UI:Dashboard:CreateCustom'), "return EditDashboard('{$this->sId}', '$sFile', $sJSExtraParams)");
$aActions[$oEdit->GetUID()] = $oEdit->GetMenuItem(); $aActions[$oEdit->GetUID()] = $oEdit->GetMenuItem();
} }
utils::GetPopupMenuItems($oPage, iPopupMenuExtension::MENU_DASHBOARD_ACTIONS, $this, $aActions); utils::GetPopupMenuItems($oPage, iPopupMenuExtension::MENU_DASHBOARD_ACTIONS, $this, $aActions);
$oActionsMenu = $oPage->GetPopoverMenu($sPopoverMenuId, $aActions) $oActionsMenu = $oPage->GetPopoverMenu($sPopoverMenuId, $aActions)
@@ -1193,7 +1151,7 @@ EOF
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function RenderProperties($oPage, $aExtraParams = array()) public function RenderProperties($oPage, $aExtraParams = [])
{ {
parent::RenderProperties($oPage, $aExtraParams); parent::RenderProperties($oPage, $aExtraParams);
@@ -1225,7 +1183,6 @@ EOF
); );
} }
/** /**
* @param WebPage $oPage * @param WebPage $oPage
* *
@@ -1236,11 +1193,11 @@ EOF
* @throws \ReflectionException * @throws \ReflectionException
* @throws \Exception * @throws \Exception
*/ */
public function RenderEditor($oPage, $aExtraParams = array()) public function RenderEditor($oPage, $aExtraParams = [])
{ {
if (isset($aExtraParams['this->class'])) { if (isset($aExtraParams['this->class'])) {
$oObj = MetaModel::GetObject($aExtraParams['this->class'], $aExtraParams['this->id']); $oObj = MetaModel::GetObject($aExtraParams['this->class'], $aExtraParams['this->id']);
$aRenderParams = array('query_params' => $oObj->ToArgsForQuery()); $aRenderParams = ['query_params' => $oObj->ToArgsForQuery()];
} else { } else {
$aRenderParams = $aExtraParams; $aRenderParams = $aExtraParams;
} }
@@ -1389,51 +1346,41 @@ JS
// Get the list of all 'dashboard' menus in which we can insert a dashlet // Get the list of all 'dashboard' menus in which we can insert a dashlet
$aAllMenus = ApplicationMenu::ReflectionMenuNodes(); $aAllMenus = ApplicationMenu::ReflectionMenuNodes();
$sRootMenuId = ApplicationMenu::GetRootMenuId($sContextMenuId); $sRootMenuId = ApplicationMenu::GetRootMenuId($sContextMenuId);
$aAllowedDashboards = array(); $aAllowedDashboards = [];
$sDefaultDashboard = null; $sDefaultDashboard = null;
// Store the parent menus for acces check // Store the parent menus for acces check
$aParentMenus = array(); $aParentMenus = [];
foreach($aAllMenus as $idx => $aMenu) foreach ($aAllMenus as $idx => $aMenu) {
{
/** @var MenuNode $oMenu */ /** @var MenuNode $oMenu */
$oMenu = $aMenu['node']; $oMenu = $aMenu['node'];
if (count(ApplicationMenu::GetChildren($oMenu->GetIndex())) > 0) if (count(ApplicationMenu::GetChildren($oMenu->GetIndex())) > 0) {
{
$aParentMenus[$oMenu->GetMenuId()] = $aMenu; $aParentMenus[$oMenu->GetMenuId()] = $aMenu;
} }
} }
foreach($aAllMenus as $idx => $aMenu) foreach ($aAllMenus as $idx => $aMenu) {
{
$oMenu = $aMenu['node']; $oMenu = $aMenu['node'];
if ($oMenu instanceof DashboardMenuNode) if ($oMenu instanceof DashboardMenuNode) {
{
// Get the root parent for access check // Get the root parent for access check
$sParentId = $aMenu['parent']; $sParentId = $aMenu['parent'];
$aParentMenu = $aParentMenus[$sParentId]; $aParentMenu = $aParentMenus[$sParentId];
while (isset($aParentMenus[$aParentMenu['parent']])) while (isset($aParentMenus[$aParentMenu['parent']])) {
{
// grand parent exists // grand parent exists
$sParentId = $aParentMenu['parent']; $sParentId = $aParentMenu['parent'];
$aParentMenu = $aParentMenus[$sParentId]; $aParentMenu = $aParentMenus[$sParentId];
} }
/** @var \MenuNode $oParentMenu */ /** @var \MenuNode $oParentMenu */
$oParentMenu = $aParentMenu['node']; $oParentMenu = $aParentMenu['node'];
if ($oMenu->IsEnabled() && $oParentMenu->IsEnabled()) if ($oMenu->IsEnabled() && $oParentMenu->IsEnabled()) {
{
$sMenuLabel = $oMenu->GetTitle(); $sMenuLabel = $oMenu->GetTitle();
$sParentLabel = Dict::S('Menu:'.$sParentId); $sParentLabel = Dict::S('Menu:'.$sParentId);
if ($sParentLabel != $sMenuLabel) if ($sParentLabel != $sMenuLabel) {
{
$aAllowedDashboards[$oMenu->GetMenuId()] = $sParentLabel.' - '.$sMenuLabel; $aAllowedDashboards[$oMenu->GetMenuId()] = $sParentLabel.' - '.$sMenuLabel;
} } else {
else
{
$aAllowedDashboards[$oMenu->GetMenuId()] = $sMenuLabel; $aAllowedDashboards[$oMenu->GetMenuId()] = $sMenuLabel;
} }
if (empty($sDefaultDashboard) && ($sRootMenuId == ApplicationMenu::GetRootMenuId($oMenu->GetMenuId()))) if (empty($sDefaultDashboard) && ($sRootMenuId == ApplicationMenu::GetRootMenuId($oMenu->GetMenuId()))) {
{
$sDefaultDashboard = $oMenu->GetMenuId(); $sDefaultDashboard = $oMenu->GetMenuId();
} }
} }
@@ -1448,21 +1395,17 @@ JS
// Get the list of possible dashlets that support a creation from // Get the list of possible dashlets that support a creation from
// an OQL // an OQL
$aDashlets = array(); $aDashlets = [];
foreach(get_declared_classes() as $sDashletClass) foreach (get_declared_classes() as $sDashletClass) {
{ if (is_subclass_of($sDashletClass, 'Dashlet')) {
if (is_subclass_of($sDashletClass, 'Dashlet'))
{
$oReflection = new ReflectionClass($sDashletClass); $oReflection = new ReflectionClass($sDashletClass);
if (!$oReflection->isAbstract()) if (!$oReflection->isAbstract()) {
{ $aCallSpec = [$sDashletClass, 'CanCreateFromOQL'];
$aCallSpec = array($sDashletClass, 'CanCreateFromOQL');
$bShorcutMode = call_user_func($aCallSpec); $bShorcutMode = call_user_func($aCallSpec);
if ($bShorcutMode) if ($bShorcutMode) {
{ $aCallSpec = [$sDashletClass, 'GetInfo'];
$aCallSpec = array($sDashletClass, 'GetInfo');
$aInfo = call_user_func($aCallSpec); $aInfo = call_user_func($aCallSpec);
$aDashlets[$sDashletClass] = array('label' => $aInfo['label'], 'class' => $sDashletClass, 'icon' => $aInfo['icon']); $aDashlets[$sDashletClass] = ['label' => $aInfo['label'], 'class' => $sDashletClass, 'icon' => $aInfo['icon']];
} }
} }
} }
@@ -1470,8 +1413,7 @@ JS
$oSelectorField = new DesignerFormSelectorField('dashlet_class', Dict::S('UI:DashletCreation:DashletType'), ''); $oSelectorField = new DesignerFormSelectorField('dashlet_class', Dict::S('UI:DashletCreation:DashletType'), '');
$oForm->AddField($oSelectorField); $oForm->AddField($oSelectorField);
foreach($aDashlets as $sDashletClass => $aDashletInfo) foreach ($aDashlets as $sDashletClass => $aDashletInfo) {
{
$oSubForm = new DesignerForm(); $oSubForm = new DesignerForm();
$oMetaModel = new ModelReflectionRuntime(); $oMetaModel = new ModelReflectionRuntime();
/** @var \Dashlet $oDashlet */ /** @var \Dashlet $oDashlet */
@@ -1603,7 +1545,7 @@ JS
/** /**
* @inheritDoc * @inheritDoc
*/ */
protected function PrepareDashletForRendering(Dashlet $oDashlet, $aCoordinates, $aExtraParams = array()) protected function PrepareDashletForRendering(Dashlet $oDashlet, $aCoordinates, $aExtraParams = [])
{ {
$sDashletIdOrig = $oDashlet->GetID(); $sDashletIdOrig = $oDashlet->GetID();
$sDashboardSanitizedId = $this->GetSanitizedId(); $sDashboardSanitizedId = $this->GetSanitizedId();
@@ -1630,31 +1572,27 @@ JS
private function UpdateDashletUserPrefs(Dashlet $oDashlet, $sDashletIdOrig, array $aExtraParams) private function UpdateDashletUserPrefs(Dashlet $oDashlet, $sDashletIdOrig, array $aExtraParams)
{ {
$bIsDashletWithListPref = ($oDashlet instanceof DashletObjectList); $bIsDashletWithListPref = ($oDashlet instanceof DashletObjectList);
if (!$bIsDashletWithListPref) if (!$bIsDashletWithListPref) {
{
return; return;
} }
/** @var \DashletObjectList $oDashlet */ /** @var \DashletObjectList $oDashlet */
$bDashletIdInNewFormat = ($sDashletIdOrig === $oDashlet->GetID()); $bDashletIdInNewFormat = ($sDashletIdOrig === $oDashlet->GetID());
if ($bDashletIdInNewFormat) if ($bDashletIdInNewFormat) {
{
return; return;
} }
$sNewPrefKey = $this->GetDashletObjectListAppUserPreferencesPrefix($oDashlet, $aExtraParams, $oDashlet->GetID()); $sNewPrefKey = $this->GetDashletObjectListAppUserPreferencesPrefix($oDashlet, $aExtraParams, $oDashlet->GetID());
$sPrefValueForNewKey = appUserPreferences::GetPref($sNewPrefKey, null); $sPrefValueForNewKey = appUserPreferences::GetPref($sNewPrefKey, null);
$bHasPrefInNewFormat = ($sPrefValueForNewKey !== null); $bHasPrefInNewFormat = ($sPrefValueForNewKey !== null);
if ($bHasPrefInNewFormat) if ($bHasPrefInNewFormat) {
{
return; return;
} }
$sOldPrefKey = $this->GetDashletObjectListAppUserPreferencesPrefix($oDashlet, $aExtraParams, $sDashletIdOrig); $sOldPrefKey = $this->GetDashletObjectListAppUserPreferencesPrefix($oDashlet, $aExtraParams, $sDashletIdOrig);
$sPrefValueForOldKey = appUserPreferences::GetPref($sOldPrefKey, null); $sPrefValueForOldKey = appUserPreferences::GetPref($sOldPrefKey, null);
$bHasPrefInOldFormat = ($sPrefValueForOldKey !== null); $bHasPrefInOldFormat = ($sPrefValueForOldKey !== null);
if (!$bHasPrefInOldFormat) if (!$bHasPrefInOldFormat) {
{
return; return;
} }
@@ -1673,7 +1611,7 @@ JS
private function GetDashletObjectListAppUserPreferencesPrefix(DashletObjectList $oDashlet, $aExtraParams, $sDashletId) private function GetDashletObjectListAppUserPreferencesPrefix(DashletObjectList $oDashlet, $aExtraParams, $sDashletId)
{ {
$sDataTableId = Dashlet::APPUSERPREFERENCES_PREFIX.$sDashletId; $sDataTableId = Dashlet::APPUSERPREFERENCES_PREFIX.$sDashletId;
$aClassAliases = array(); $aClassAliases = [];
try { try {
$oFilter = $oDashlet->GetDBSearch($aExtraParams); $oFilter = $oDashlet->GetDBSearch($aExtraParams);
$aClassAliases = $oFilter->GetSelectedClasses(); $aClassAliases = $oFilter->GetSelectedClasses();

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -41,11 +42,11 @@ abstract class DashboardLayout
public static function GetInfo() public static function GetInfo()
{ {
return array( return [
'label' => '', 'label' => '',
'icon' => '', 'icon' => '',
'description' => '', 'description' => '',
); ];
} }
} }
@@ -63,16 +64,12 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
$aKeys = array_reverse(array_keys($aDashlets)); $aKeys = array_reverse(array_keys($aDashlets));
$idx = 0; $idx = 0;
$bNoVisibleFound = true; $bNoVisibleFound = true;
while($idx < count($aKeys) && $bNoVisibleFound) while ($idx < count($aKeys) && $bNoVisibleFound) {
{
/** @var \Dashlet $oDashlet */ /** @var \Dashlet $oDashlet */
$oDashlet = $aDashlets[$aKeys[$idx]]; $oDashlet = $aDashlets[$aKeys[$idx]];
if ($oDashlet::IsVisible()) if ($oDashlet::IsVisible()) {
{
$bNoVisibleFound = false; $bNoVisibleFound = false;
} } else {
else
{
unset($aDashlets[$aKeys[$idx]]); unset($aDashlets[$aKeys[$idx]]);
} }
$idx++; $idx++;
@@ -82,22 +79,17 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
protected function TrimCellsArray($aCells) protected function TrimCellsArray($aCells)
{ {
foreach($aCells as $key => $aDashlets) foreach ($aCells as $key => $aDashlets) {
{
$aCells[$key] = $this->TrimCell($aDashlets); $aCells[$key] = $this->TrimCell($aDashlets);
} }
$aKeys = array_reverse(array_keys($aCells)); $aKeys = array_reverse(array_keys($aCells));
$idx = 0; $idx = 0;
$bNoVisibleFound = true; $bNoVisibleFound = true;
while($idx < count($aKeys) && $bNoVisibleFound) while ($idx < count($aKeys) && $bNoVisibleFound) {
{
$aDashlets = $aCells[$aKeys[$idx]]; $aDashlets = $aCells[$aKeys[$idx]];
if (count($aDashlets) > 0) if (count($aDashlets) > 0) {
{
$bNoVisibleFound = false; $bNoVisibleFound = false;
} } else {
else
{
unset($aCells[$aKeys[$idx]]); unset($aCells[$aKeys[$idx]]);
} }
$idx++; $idx++;
@@ -112,7 +104,7 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
* @param bool $bEditMode * @param bool $bEditMode
* @param array $aExtraParams * @param array $aExtraParams
*/ */
public function Render($oPage, $aCells, $bEditMode = false, $aExtraParams = array()) public function Render($oPage, $aCells, $bEditMode = false, $aExtraParams = [])
{ {
// Trim the list of cells to remove the invisible/empty ones at the end of the array // Trim the list of cells to remove the invisible/empty ones at the end of the array
$aCells = $this->TrimCellsArray($aCells); $aCells = $this->TrimCellsArray($aCells);
@@ -157,8 +149,7 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
$oPage->add_script("function updateDashboard".$aExtraParams['dashboard_div_id']."(){".$sJSReload."}"); $oPage->add_script("function updateDashboard".$aExtraParams['dashboard_div_id']."(){".$sJSReload."}");
if ($bEditMode) // Add one row for extensibility if ($bEditMode) { // Add one row for extensibility
{
$oDashboardRow = new DashboardRow(); $oDashboardRow = new DashboardRow();
$oDashboardLayout->AddDashboardRow($oDashboardRow); $oDashboardLayout->AddDashboardRow($oDashboardRow);
@@ -180,7 +171,7 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
$iColNumber = (int) $iCellIdx % $this->iNbCols; $iColNumber = (int) $iCellIdx % $this->iNbCols;
$iRowNumber = (int) floor($iCellIdx / $this->iNbCols); $iRowNumber = (int) floor($iCellIdx / $this->iNbCols);
return array($iColNumber, $iRowNumber); return [$iColNumber, $iRowNumber];
} }
} }
@@ -191,13 +182,13 @@ class DashboardLayoutOneCol extends DashboardLayoutMultiCol
parent::__construct(); parent::__construct();
$this->iNbCols = 1; $this->iNbCols = 1;
} }
static public function GetInfo() public static function GetInfo()
{ {
return array( return [
'label' => 'One Column', 'label' => 'One Column',
'icon' => 'images/layout_1col.png', 'icon' => 'images/layout_1col.png',
'description' => '', 'description' => '',
); ];
} }
} }
@@ -208,13 +199,13 @@ class DashboardLayoutTwoCols extends DashboardLayoutMultiCol
parent::__construct(); parent::__construct();
$this->iNbCols = 2; $this->iNbCols = 2;
} }
static public function GetInfo() public static function GetInfo()
{ {
return array( return [
'label' => 'Two Columns', 'label' => 'Two Columns',
'icon' => 'images/layout_2col.png', 'icon' => 'images/layout_2col.png',
'description' => '', 'description' => '',
); ];
} }
} }
@@ -225,12 +216,12 @@ class DashboardLayoutThreeCols extends DashboardLayoutMultiCol
parent::__construct(); parent::__construct();
$this->iNbCols = 3; $this->iNbCols = 3;
} }
static public function GetInfo() public static function GetInfo()
{ {
return array( return [
'label' => 'Two Columns', 'label' => 'Two Columns',
'icon' => 'images/layout_3col.png', 'icon' => 'images/layout_3col.png',
'description' => '', 'description' => '',
); ];
} }
} }

File diff suppressed because it is too large Load Diff

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -104,7 +105,7 @@ class DisplayBlock
*/ */
public const ENUM_STYLE_CHART_AJAX = 'chart_ajax'; public const ENUM_STYLE_CHART_AJAX = 'chart_ajax';
const TAG_BLOCK = 'itopblock'; public const TAG_BLOCK = 'itopblock';
/** @var \DBSearch */ /** @var \DBSearch */
protected $m_oFilter; protected $m_oFilter;
protected $m_aConditions; // Conditions added to the filter -> avoid duplicate conditions protected $m_aConditions; // Conditions added to the filter -> avoid duplicate conditions
@@ -137,20 +138,18 @@ class DisplayBlock
* *
* @throws \ApplicationException * @throws \ApplicationException
*/ */
public function __construct(DBSearch $oFilter, $sStyle = self::ENUM_STYLE_LIST, $bAsynchronous = false, $aParams = array(), $oSet = null) public function __construct(DBSearch $oFilter, $sStyle = self::ENUM_STYLE_LIST, $bAsynchronous = false, $aParams = [], $oSet = null)
{ {
$this->m_oFilter = $oFilter->DeepClone(); $this->m_oFilter = $oFilter->DeepClone();
$this->m_aConditions = array(); $this->m_aConditions = [];
$this->m_sStyle = $sStyle; $this->m_sStyle = $sStyle;
$this->m_bAsynchronous = $bAsynchronous; $this->m_bAsynchronous = $bAsynchronous;
$this->m_aParams = $aParams; $this->m_aParams = $aParams;
$this->m_oSet = $oSet; $this->m_oSet = $oSet;
if (array_key_exists('show_obsolete_data', $aParams)) if (array_key_exists('show_obsolete_data', $aParams)) {
{
$this->m_bShowObsoleteData = $aParams['show_obsolete_data']; $this->m_bShowObsoleteData = $aParams['show_obsolete_data'];
} }
if ($this->m_bShowObsoleteData === null) if ($this->m_bShowObsoleteData === null) {
{
// User defined // User defined
$this->m_bShowObsoleteData = utils::ShowObsoleteData(); $this->m_bShowObsoleteData = utils::ShowObsoleteData();
} }
@@ -412,22 +411,18 @@ class DisplayBlock
* @throws \CoreException * @throws \CoreException
* @throws \Exception * @throws \Exception
*/ */
public static function FromObjectSet(DBObjectSet $oSet, $sStyle, $aParams = array()) public static function FromObjectSet(DBObjectSet $oSet, $sStyle, $aParams = [])
{ {
$oDummyFilter = new DBObjectSearch($oSet->GetClass()); $oDummyFilter = new DBObjectSearch($oSet->GetClass());
$aKeys = array(); $aKeys = [];
$oSet->OptimizeColumnLoad(array($oSet->GetClassAlias() => array())); // No need to load all the columns just to get the id $oSet->OptimizeColumnLoad([$oSet->GetClassAlias() => []]); // No need to load all the columns just to get the id
while($oObject = $oSet->Fetch()) while ($oObject = $oSet->Fetch()) {
{
$aKeys[] = $oObject->GetKey(); $aKeys[] = $oObject->GetKey();
} }
$oSet->Rewind(); $oSet->Rewind();
if (count($aKeys) > 0) if (count($aKeys) > 0) {
{
$oDummyFilter->AddCondition('id', $aKeys, 'IN'); $oDummyFilter->AddCondition('id', $aKeys, 'IN');
} } else {
else
{
$oDummyFilter->AddCondition('id', 0, '='); $oDummyFilter->AddCondition('id', 0, '=');
} }
$oBlock = new DisplayBlock($oDummyFilter, $sStyle, false, $aParams); // DisplayBlocks built this way are synchronous $oBlock = new DisplayBlock($oDummyFilter, $sStyle, false, $aParams); // DisplayBlocks built this way are synchronous
@@ -448,7 +443,7 @@ class DisplayBlock
$iStartPos = stripos($sTemplate, '<'.self::TAG_BLOCK.' ', 0); $iStartPos = stripos($sTemplate, '<'.self::TAG_BLOCK.' ', 0);
$iEndPos = stripos($sTemplate, '</'.self::TAG_BLOCK.'>', $iStartPos); $iEndPos = stripos($sTemplate, '</'.self::TAG_BLOCK.'>', $iStartPos);
$iEndTag = stripos($sTemplate, '>', $iStartPos); $iEndTag = stripos($sTemplate, '>', $iStartPos);
$aParams = array(); $aParams = [];
if (($iStartPos === false) || ($iEndPos === false)) { if (($iStartPos === false) || ($iEndPos === false)) {
return null; return null;
@@ -456,7 +451,7 @@ class DisplayBlock
$sITopData = substr($sTemplate, 1 + $iEndTag, $iEndPos - $iEndTag - 1); $sITopData = substr($sTemplate, 1 + $iEndTag, $iEndPos - $iEndTag - 1);
$sITopTag = substr($sTemplate, $iStartPos + strlen('<'.self::TAG_BLOCK), $iEndTag - $iStartPos - strlen('<'.self::TAG_BLOCK)); $sITopTag = substr($sTemplate, $iStartPos + strlen('<'.self::TAG_BLOCK), $iEndTag - $iStartPos - strlen('<'.self::TAG_BLOCK));
$aMatches = array(); $aMatches = [];
$sBlockClass = "DisplayBlock"; $sBlockClass = "DisplayBlock";
$bAsynchronous = false; $bAsynchronous = false;
$sBlockType = 'list'; $sBlockType = 'list';
@@ -522,25 +517,28 @@ class DisplayBlock
return new $sBlockClass($oFilter, $sBlockType, $bAsynchronous, $aParams); return new $sBlockClass($oFilter, $sBlockType, $bAsynchronous, $aParams);
} }
public function DisplayIntoContentBlock(UIContentBlock $oContentBlock, WebPage $oPage, $sId, $aExtraParams = array()) public function DisplayIntoContentBlock(UIContentBlock $oContentBlock, WebPage $oPage, $sId, $aExtraParams = [])
{ {
$oContentBlock->AddSubBlock($this->GetDisplay($oPage, $sId, $aExtraParams)); $oContentBlock->AddSubBlock($this->GetDisplay($oPage, $sId, $aExtraParams));
} }
public function Display(WebPage $oPage, $sId, $aExtraParams = array()) public function Display(WebPage $oPage, $sId, $aExtraParams = [])
{ {
$oPage->AddUiBlock($this->GetDisplay($oPage, $sId, $aExtraParams)); $oPage->AddUiBlock($this->GetDisplay($oPage, $sId, $aExtraParams));
} }
public function GetDisplay(WebPage $oPage, $sId, $aExtraParams = array()): UIContentBlock public function GetDisplay(WebPage $oPage, $sId, $aExtraParams = []): UIContentBlock
{ {
$oHtml = new UIContentBlock($sId); $oHtml = new UIContentBlock($sId);
$oHtml->AddCSSClass("display_block"); $oHtml->AddCSSClass("display_block");
$aExtraParams = array_merge($aExtraParams, $this->m_aParams); $aExtraParams = array_merge($aExtraParams, $this->m_aParams);
$aExtraParams['currentId'] = $sId; $aExtraParams['currentId'] = $sId;
$sExtraParams = addslashes(str_replace('"', "'", $sExtraParams = addslashes(str_replace(
json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them '"',
"'",
json_encode($aExtraParams)
)); // JSON encode, change the style of the quotes and escape them
if (isset($aExtraParams['query_params'])) { if (isset($aExtraParams['query_params'])) {
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
@@ -549,9 +547,9 @@ class DisplayBlock
$sClass = $aExtraParams['this->class']; $sClass = $aExtraParams['this->class'];
$iKey = $aExtraParams['this->id']; $iKey = $aExtraParams['this->id'];
$oObj = MetaModel::GetObject($sClass, $iKey); $oObj = MetaModel::GetObject($sClass, $iKey);
$aQueryParams = array('this->object()' => $oObj); $aQueryParams = ['this->object()' => $oObj];
} else { } else {
$aQueryParams = array(); $aQueryParams = [];
} }
} }
@@ -587,8 +585,7 @@ class DisplayBlock
'); ');
} }
if ($this->m_sStyle == static::ENUM_STYLE_LIST) // Search form need to extract result list extra data, the simplest way is to expose this configuration if ($this->m_sStyle == static::ENUM_STYLE_LIST) { // Search form need to extract result list extra data, the simplest way is to expose this configuration
{
$listJsonExtraParams = json_encode(json_encode($aExtraParams)); $listJsonExtraParams = json_encode(json_encode($aExtraParams));
$oPage->add_ready_script(" $oPage->add_ready_script("
$('#$sId').data('sExtraParams', ".$listJsonExtraParams."); $('#$sId').data('sExtraParams', ".$listJsonExtraParams.");
@@ -608,7 +605,7 @@ class DisplayBlock
* @throws \DictExceptionMissingString * @throws \DictExceptionMissingString
* @throws \MySQLException * @throws \MySQLException
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
if (!isset($aExtraParams['currentId'])) { if (!isset($aExtraParams['currentId'])) {
$sId = utils::GetUniqueId(); // Works only if the page is not an Ajax one ! $sId = utils::GetUniqueId(); // Works only if the page is not an Ajax one !
@@ -640,7 +637,7 @@ class DisplayBlock
$this->CheckParams($this->m_sStyle, $aExtraParams); $this->CheckParams($this->m_sStyle, $aExtraParams);
// Add the extra params into the filter if they make sense for such a filter // Add the extra params into the filter if they make sense for such a filter
$bDoSearch = utils::ReadParam('dosearch', false); $bDoSearch = utils::ReadParam('dosearch', false);
$aQueryParams = array(); $aQueryParams = [];
if (isset($aExtraParams['query_params'])) { if (isset($aExtraParams['query_params'])) {
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
} else { } else {
@@ -648,7 +645,7 @@ class DisplayBlock
$sClass = $aExtraParams['this->class']; $sClass = $aExtraParams['this->class'];
$iKey = $aExtraParams['this->id']; $iKey = $aExtraParams['this->id'];
$oObj = MetaModel::GetObject($sClass, $iKey); $oObj = MetaModel::GetObject($sClass, $iKey);
$aQueryParams = array('this->object()' => $oObj); $aQueryParams = ['this->object()' => $oObj];
} }
} }
if ($this->m_oSet == null) { if ($this->m_oSet == null) {
@@ -658,7 +655,7 @@ class DisplayBlock
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$sClass = $this->m_oFilter->GetClass(); $sClass = $this->m_oFilter->GetClass();
$aFilterCodes = MetaModel::GetFiltersList($sClass); $aFilterCodes = MetaModel::GetFiltersList($sClass);
$aCallSpec = array($sClass, 'MapContextParam'); $aCallSpec = [$sClass, 'MapContextParam'];
if (is_callable($aCallSpec)) { if (is_callable($aCallSpec)) {
foreach ($oAppContext->GetNames() as $sContextParam) { foreach ($oAppContext->GetNames() as $sContextParam) {
$sParamCode = call_user_func($aCallSpec, $sContextParam); //Map context parameter to the value/filter code depending on the class $sParamCode = call_user_func($aCallSpec, $sContextParam); //Map context parameter to the value/filter code depending on the class
@@ -693,11 +690,9 @@ class DisplayBlock
} }
} }
if (!is_null($condition)) if (!is_null($condition)) {
{
$sOpCode = null; // default operator $sOpCode = null; // default operator
if (is_array($condition)) if (is_array($condition)) {
{
// Multiple values, add them as AND X IN (v1, v2, v3...) // Multiple values, add them as AND X IN (v1, v2, v3...)
$sOpCode = 'IN'; $sOpCode = 'IN';
} }
@@ -705,26 +700,22 @@ class DisplayBlock
$this->AddCondition($sFilterCode, $condition, $sOpCode, $bParseSearchString); $this->AddCondition($sFilterCode, $condition, $sOpCode, $bParseSearchString);
} }
} }
if ($bDoSearch) if ($bDoSearch) {
{
// Keep the table_id identifying this table if we're performing a search // Keep the table_id identifying this table if we're performing a search
$sTableId = utils::ReadParam('_table_id_', null, false, utils::ENUM_SANITIZATION_FILTER_ELEMENT_IDENTIFIER); $sTableId = utils::ReadParam('_table_id_', null, false, utils::ENUM_SANITIZATION_FILTER_ELEMENT_IDENTIFIER);
if ($sTableId != null) if ($sTableId != null) {
{
$aExtraParams['table_id'] = $sTableId; $aExtraParams['table_id'] = $sTableId;
} }
} }
} }
$aOrderBy = array(); $aOrderBy = [];
if (isset($aExtraParams['order_by'])) if (isset($aExtraParams['order_by'])) {
{
// Convert the string describing the order_by parameter into an array // Convert the string describing the order_by parameter into an array
// The syntax is +attCode1,-attCode2 // The syntax is +attCode1,-attCode2
// attCode1 => ascending, attCode2 => descending // attCode1 => ascending, attCode2 => descending
$aTemp = explode(',', $aExtraParams['order_by']); $aTemp = explode(',', $aExtraParams['order_by']);
foreach($aTemp as $sTemp) foreach ($aTemp as $sTemp) {
{ $aMatches = [];
$aMatches = array();
if (preg_match('/^([+-])?(.+)$/', $sTemp, $aMatches)) { if (preg_match('/^([+-])?(.+)$/', $sTemp, $aMatches)) {
$bAscending = true; $bAscending = true;
if ($aMatches[1] == '-') { if ($aMatches[1] == '-') {
@@ -801,17 +792,13 @@ class DisplayBlock
$sHtml .= Dict::format('UI:Error:UnsupportedStyleOfBlock', $this->m_sStyle); $sHtml .= Dict::format('UI:Error:UnsupportedStyleOfBlock', $this->m_sStyle);
} }
$bAutoReload = false; $bAutoReload = false;
if (isset($aExtraParams['auto_reload'])) if (isset($aExtraParams['auto_reload'])) {
{ if ($aExtraParams['auto_reload'] === true) {
if ($aExtraParams['auto_reload'] === true)
{
// Note: does not work in the switch (case true) because a positive number evaluates to true!!! // Note: does not work in the switch (case true) because a positive number evaluates to true!!!
$aExtraParams['auto_reload'] = 'standard'; $aExtraParams['auto_reload'] = 'standard';
} }
switch($aExtraParams['auto_reload']) switch ($aExtraParams['auto_reload']) {
{
case 'fast': case 'fast':
$bAutoReload = true; $bAutoReload = true;
$iReloadInterval = MetaModel::GetConfig()->GetFastReloadInterval() * 1000; $iReloadInterval = MetaModel::GetConfig()->GetFastReloadInterval() * 1000;
@@ -824,20 +811,16 @@ class DisplayBlock
break; break;
default: default:
if (is_numeric($aExtraParams['auto_reload']) && ($aExtraParams['auto_reload'] > 0)) if (is_numeric($aExtraParams['auto_reload']) && ($aExtraParams['auto_reload'] > 0)) {
{
$bAutoReload = true; $bAutoReload = true;
$iReloadInterval = max(MetaModel::GetConfig()->Get('min_reload_interval'), $aExtraParams['auto_reload']) * 1000; $iReloadInterval = max(MetaModel::GetConfig()->Get('min_reload_interval'), $aExtraParams['auto_reload']) * 1000;
} } else {
else
{
// incorrect config, ignore it // incorrect config, ignore it
$bAutoReload = false; $bAutoReload = false;
} }
} }
} }
if (($bAutoReload) && ($this->m_sStyle != static::ENUM_STYLE_SEARCH)) // Search form do NOT auto-reload if (($bAutoReload) && ($this->m_sStyle != static::ENUM_STYLE_SEARCH)) { // Search form do NOT auto-reload
{
// Used either for asynchronous or auto_reload // Used either for asynchronous or auto_reload
// does a json_encode twice to get a string usable as function parameter // does a json_encode twice to get a string usable as function parameter
$sFilterBefore = $this->m_oFilter->serialize(); $sFilterBefore = $this->m_oFilter->serialize();
@@ -884,8 +867,7 @@ JS
{ {
// Workaround to an issue revealed whenever a condition on org_id is applied twice (with a hierarchy of organizations) // Workaround to an issue revealed whenever a condition on org_id is applied twice (with a hierarchy of organizations)
// Moreover, it keeps the query as simple as possible // Moreover, it keeps the query as simple as possible
if (isset($this->m_aConditions[$sFilterCode]) && $condition == $this->m_aConditions[$sFilterCode]) if (isset($this->m_aConditions[$sFilterCode]) && $condition == $this->m_aConditions[$sFilterCode]) {
{
// Skip // Skip
return; return;
} }
@@ -895,51 +877,40 @@ JS
$bConditionAdded = false; $bConditionAdded = false;
// If the condition is an external key with a class having a hierarchy, use a "below" criteria // If the condition is an external key with a class having a hierarchy, use a "below" criteria
if (MetaModel::IsValidAttCode($sClass, $sFilterCode)) if (MetaModel::IsValidAttCode($sClass, $sFilterCode)) {
{
$oAttDef = MetaModel::GetAttributeDef($sClass, $sFilterCode); $oAttDef = MetaModel::GetAttributeDef($sClass, $sFilterCode);
if ($oAttDef->IsExternalKey()) if ($oAttDef->IsExternalKey()) {
{
$sHierarchicalKeyCode = MetaModel::IsHierarchicalClass($oAttDef->GetTargetClass()); $sHierarchicalKeyCode = MetaModel::IsHierarchicalClass($oAttDef->GetTargetClass());
if ($sHierarchicalKeyCode !== false) if ($sHierarchicalKeyCode !== false) {
{
$oFilter = new DBObjectSearch($oAttDef->GetTargetClass()); $oFilter = new DBObjectSearch($oAttDef->GetTargetClass());
if (($sOpCode == 'IN') && is_array($condition)) if (($sOpCode == 'IN') && is_array($condition)) {
{
$oFilter->AddConditionExpression(self::GetConditionIN($oFilter, 'id', $condition)); $oFilter->AddConditionExpression(self::GetConditionIN($oFilter, 'id', $condition));
} } else {
else
{
$oFilter->AddCondition('id', $condition); $oFilter->AddCondition('id', $condition);
} }
$oHKFilter = new DBObjectSearch($oAttDef->GetTargetClass()); $oHKFilter = new DBObjectSearch($oAttDef->GetTargetClass());
$oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW); // Use the 'below' operator by default $oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW); // Use the 'below' operator by default
$this->m_oFilter->AddCondition_PointingTo($oHKFilter, $sFilterCode); $this->m_oFilter->AddCondition_PointingTo($oHKFilter, $sFilterCode);
$bConditionAdded = true; $bConditionAdded = true;
} } elseif (($sOpCode == 'IN') && is_array($condition)) {
else if (($sOpCode == 'IN') && is_array($condition))
{
$this->m_oFilter->AddConditionExpression(self::GetConditionIN($this->m_oFilter, $sFilterCode, $condition)); $this->m_oFilter->AddConditionExpression(self::GetConditionIN($this->m_oFilter, $sFilterCode, $condition));
$bConditionAdded = true; $bConditionAdded = true;
} }
} } elseif (($sOpCode == 'IN') && is_array($condition)) {
else if (($sOpCode == 'IN') && is_array($condition))
{
$this->m_oFilter->AddConditionExpression(self::GetConditionIN($this->m_oFilter, $sFilterCode, $condition)); $this->m_oFilter->AddConditionExpression(self::GetConditionIN($this->m_oFilter, $sFilterCode, $condition));
$bConditionAdded = true; $bConditionAdded = true;
} }
} }
// In all other cases, just add the condition directly // In all other cases, just add the condition directly
if (!$bConditionAdded) if (!$bConditionAdded) {
{
$this->m_oFilter->AddCondition($sFilterCode, $condition, null); // Use the default 'loose' operator $this->m_oFilter->AddCondition($sFilterCode, $condition, null); // Use the default 'loose' operator
} }
} }
static protected function GetConditionIN($oFilter, $sFilterCode, $condition) protected static function GetConditionIN($oFilter, $sFilterCode, $condition)
{ {
$oField = new FieldExpression($sFilterCode, $oFilter->GetClassAlias()); $oField = new FieldExpression($sFilterCode, $oFilter->GetClassAlias());
$sListExpr = '('.implode(', ', CMDBSource::Quote($condition)).')'; $sListExpr = '('.implode(', ', CMDBSource::Quote($condition)).')';
@@ -972,13 +943,10 @@ JS
protected function MakeGroupByQuery(&$aExtraParams, &$oGroupByExp, &$sGroupByLabel, &$aGroupBy, &$sAggregationFunction, &$sFctVar, &$sAggregationAttr, &$sSql) protected function MakeGroupByQuery(&$aExtraParams, &$oGroupByExp, &$sGroupByLabel, &$aGroupBy, &$sAggregationFunction, &$sFctVar, &$sAggregationAttr, &$sSql)
{ {
$sAlias = $this->m_oFilter->GetClassAlias(); $sAlias = $this->m_oFilter->GetClassAlias();
if (isset($aExtraParams['group_by_label'])) if (isset($aExtraParams['group_by_label'])) {
{
$oGroupByExp = Expression::FromOQL($aExtraParams['group_by']); $oGroupByExp = Expression::FromOQL($aExtraParams['group_by']);
$sGroupByLabel = $aExtraParams['group_by_label']; $sGroupByLabel = $aExtraParams['group_by_label'];
} } else {
else
{
// Backward compatibility: group_by is simply a field id // Backward compatibility: group_by is simply a field id
$oGroupByExp = new FieldExpression($aExtraParams['group_by'], $sAlias); $oGroupByExp = new FieldExpression($aExtraParams['group_by'], $sAlias);
$sGroupByLabel = MetaModel::GetLabel($this->m_oFilter->GetClass(), $aExtraParams['group_by']); $sGroupByLabel = MetaModel::GetLabel($this->m_oFilter->GetClass(), $aExtraParams['group_by']);
@@ -986,61 +954,52 @@ JS
// Security filtering // Security filtering
$aFields = $oGroupByExp->ListRequiredFields(); $aFields = $oGroupByExp->ListRequiredFields();
foreach($aFields as $sFieldAlias) foreach ($aFields as $sFieldAlias) {
{ $aMatches = [];
$aMatches = array(); if (preg_match('/^([^.]+)\\.([^.]+)$/', $sFieldAlias, $aMatches)) {
if (preg_match('/^([^.]+)\\.([^.]+)$/', $sFieldAlias, $aMatches))
{
$sFieldClass = $this->m_oFilter->GetClassName($aMatches[1]); $sFieldClass = $this->m_oFilter->GetClassName($aMatches[1]);
$oAttDef = MetaModel::GetAttributeDef($sFieldClass, $aMatches[2]); $oAttDef = MetaModel::GetAttributeDef($sFieldClass, $aMatches[2]);
if ($oAttDef instanceof AttributeOneWayPassword) if ($oAttDef instanceof AttributeOneWayPassword) {
{
throw new Exception('Grouping on password fields is not supported.'); throw new Exception('Grouping on password fields is not supported.');
} }
} }
} }
$aGroupBy = array(); $aGroupBy = [];
$aGroupBy['grouped_by_1'] = $oGroupByExp; $aGroupBy['grouped_by_1'] = $oGroupByExp;
$aQueryParams = array(); $aQueryParams = [];
if (isset($aExtraParams['query_params'])) if (isset($aExtraParams['query_params'])) {
{
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
} }
$aFunctions = array(); $aFunctions = [];
$sAggregationFunction = 'count'; $sAggregationFunction = 'count';
$sFctVar = '_itop_count_'; $sFctVar = '_itop_count_';
$sAggregationAttr = ''; $sAggregationAttr = '';
if (isset($aExtraParams['aggregation_function']) && !empty($aExtraParams['aggregation_attribute'])) if (isset($aExtraParams['aggregation_function']) && !empty($aExtraParams['aggregation_attribute'])) {
{
$sAggregationFunction = $aExtraParams['aggregation_function']; $sAggregationFunction = $aExtraParams['aggregation_function'];
$sAggregationAttr = $aExtraParams['aggregation_attribute']; $sAggregationAttr = $aExtraParams['aggregation_attribute'];
$oAttrExpr = Expression::FromOQL('`'.$sAlias.'`.`'.$sAggregationAttr.'`'); $oAttrExpr = Expression::FromOQL('`'.$sAlias.'`.`'.$sAggregationAttr.'`');
$oFctExpr = new FunctionExpression(strtoupper($sAggregationFunction), array($oAttrExpr)); $oFctExpr = new FunctionExpression(strtoupper($sAggregationFunction), [$oAttrExpr]);
$sFctVar = '_itop_'.$sAggregationFunction.'_'; $sFctVar = '_itop_'.$sAggregationFunction.'_';
$aFunctions = array($sFctVar => $oFctExpr); $aFunctions = [$sFctVar => $oFctExpr];
} }
if (!empty($sAggregationAttr)) if (!empty($sAggregationAttr)) {
{
$sClass = $this->m_oFilter->GetClass(); $sClass = $this->m_oFilter->GetClass();
$sAggregationAttr = MetaModel::GetLabel($sClass, $sAggregationAttr); $sAggregationAttr = MetaModel::GetLabel($sClass, $sAggregationAttr);
} }
$iLimit = 0; $iLimit = 0;
if (isset($aExtraParams['limit'])) if (isset($aExtraParams['limit'])) {
{
$iLimit = intval($aExtraParams['limit']); $iLimit = intval($aExtraParams['limit']);
} }
$aOrderBy = array(); $aOrderBy = [];
if (isset($aExtraParams['order_direction']) && isset($aExtraParams['order_by'])) if (isset($aExtraParams['order_direction']) && isset($aExtraParams['order_by'])) {
{ switch ($aExtraParams['order_by']) {
switch ($aExtraParams['order_by'])
{
case 'attribute': case 'attribute':
$aOrderBy = array('grouped_by_1' => ($aExtraParams['order_direction'] === 'asc')); $aOrderBy = ['grouped_by_1' => ($aExtraParams['order_direction'] === 'asc')];
break; break;
case 'function': case 'function':
$aOrderBy = array($sFctVar => ($aExtraParams['order_direction'] === 'asc')); $aOrderBy = [$sFctVar => ($aExtraParams['order_direction'] === 'asc')];
break; break;
} }
} }
@@ -1076,31 +1035,31 @@ JS
$this->AddCondition($sFilterCode, $sContextParamValue); $this->AddCondition($sFilterCode, $sContextParamValue);
} }
} }
$aQueryParams = array(); $aQueryParams = [];
if (isset($aExtraParams['query_params'])) { if (isset($aExtraParams['query_params'])) {
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
} }
$this->m_oSet = new CMDBObjectSet($this->m_oFilter, array(), $aQueryParams); $this->m_oSet = new CMDBObjectSet($this->m_oFilter, [], $aQueryParams);
$this->m_oSet->SetShowObsoleteData($this->m_bShowObsoleteData); $this->m_oSet->SetShowObsoleteData($this->m_bShowObsoleteData);
} }
// Summary details // Summary details
$aCounts = array(); $aCounts = [];
$aStateLabels = array(); $aStateLabels = [];
if (!empty($sStateAttrCode) && !empty($sStatesList)) { if (!empty($sStateAttrCode) && !empty($sStatesList)) {
$aStates = explode(',', $sStatesList); $aStates = explode(',', $sStatesList);
// Generate one count + group by query [#1330] // Generate one count + group by query [#1330]
$sClassAlias = $this->m_oFilter->GetClassAlias(); $sClassAlias = $this->m_oFilter->GetClassAlias();
$oGroupByExpr = Expression::FromOQL($sClassAlias.'.'.$sStateAttrCode); $oGroupByExpr = Expression::FromOQL($sClassAlias.'.'.$sStateAttrCode);
$aGroupBy = array('group1' => $oGroupByExpr); $aGroupBy = ['group1' => $oGroupByExpr];
$oGroupBySearch = $this->m_oFilter->DeepClone(); $oGroupBySearch = $this->m_oFilter->DeepClone();
if (isset($this->m_bShowObsoleteData)) { if (isset($this->m_bShowObsoleteData)) {
$oGroupBySearch->SetShowObsoleteData($this->m_bShowObsoleteData); $oGroupBySearch->SetShowObsoleteData($this->m_bShowObsoleteData);
} }
$sCountGroupByQuery = $oGroupBySearch->MakeGroupByQuery($aQueryParams, $aGroupBy, false); $sCountGroupByQuery = $oGroupBySearch->MakeGroupByQuery($aQueryParams, $aGroupBy, false);
$aCountGroupByResults = CMDBSource::QueryToArray($sCountGroupByQuery); $aCountGroupByResults = CMDBSource::QueryToArray($sCountGroupByQuery);
$aCountsQueryResults = array(); $aCountsQueryResults = [];
foreach ($aCountGroupByResults as $aCountGroupBySingleResult) { foreach ($aCountGroupByResults as $aCountGroupBySingleResult) {
$aCountsQueryResults[$aCountGroupBySingleResult[0]] = $aCountGroupBySingleResult[1]; $aCountsQueryResults[$aCountGroupBySingleResult[0]] = $aCountGroupBySingleResult[1];
} }
@@ -1114,7 +1073,8 @@ JS
: 0; : 0;
if ($aCounts[$sStateValue] == 0) { if ($aCounts[$sStateValue] == 0) {
$aCounts[$sStateValue] = ['link' => '-', 'label' => $aCounts[$sStateValue]];; $aCounts[$sStateValue] = ['link' => '-', 'label' => $aCounts[$sStateValue]];
;
} else { } else {
$oSingleGroupByValueFilter = $this->m_oFilter->DeepClone(); $oSingleGroupByValueFilter = $this->m_oFilter->DeepClone();
$oSingleGroupByValueFilter->AddCondition($sStateAttrCode, $sStateValue, '='); $oSingleGroupByValueFilter->AddCondition($sStateAttrCode, $sStateValue, '=');
@@ -1178,7 +1138,8 @@ JS
$('#".$oBlock->GetId()."').html(data); $('#".$oBlock->GetId()."').html(data);
$('#".$oBlock->GetId()."').unblock(); $('#".$oBlock->GetId()."').unblock();
}); });
$('#".$oBlock->GetId()."').unblock();"); $('#".$oBlock->GetId()."').unblock();"
);
return $oBlock; return $oBlock;
} }
@@ -1220,11 +1181,11 @@ JS
$this->AddCondition($sFilterCode, $sContextParamValue); $this->AddCondition($sFilterCode, $sContextParamValue);
} }
} }
$aQueryParams = array(); $aQueryParams = [];
if (isset($aExtraParams['query_params'])) { if (isset($aExtraParams['query_params'])) {
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
} }
$this->m_oSet = new CMDBObjectSet($this->m_oFilter, array(), $aQueryParams); $this->m_oSet = new CMDBObjectSet($this->m_oFilter, [], $aQueryParams);
$this->m_oSet->SetShowObsoleteData($this->m_bShowObsoleteData); $this->m_oSet->SetShowObsoleteData($this->m_bShowObsoleteData);
} }
$iCount = $this->m_oSet->Count(); $iCount = $this->m_oSet->Count();
@@ -1241,8 +1202,15 @@ JS
if (UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY)) { if (UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY)) {
$sCreateActionUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=new&class='.$sClass.$oAppContext->GetForLink(true); $sCreateActionUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=new&class='.$sClass.$oAppContext->GetForLink(true);
$sCreateActionLabel = Dict::Format('UI:Button:Create'); $sCreateActionLabel = Dict::Format('UI:Button:Create');
$oBlock = DashletFactory::MakeForDashletBadge($sClassIconUrl, $sHyperlink, $iCount, $sClassLabel, $sCreateActionUrl, $oBlock = DashletFactory::MakeForDashletBadge(
$sCreateActionLabel, $aRefreshParams); $sClassIconUrl,
$sHyperlink,
$iCount,
$sClassLabel,
$sCreateActionUrl,
$sCreateActionLabel,
$aRefreshParams
);
} else { } else {
$oBlock = DashletFactory::MakeForDashletBadge($sClassIconUrl, $sHyperlink, $iCount, $sClassLabel, null, null, $aRefreshParams); $oBlock = DashletFactory::MakeForDashletBadge($sClassIconUrl, $sHyperlink, $iCount, $sClassLabel, null, null, $aRefreshParams);
} }
@@ -1272,9 +1240,9 @@ JS
$aRes = CMDBSource::QueryToArray($sSql); $aRes = CMDBSource::QueryToArray($sSql);
$aGroupBy = array(); $aGroupBy = [];
$aLabels = array(); $aLabels = [];
$aValues = array(); $aValues = [];
$iTotalCount = 0; $iTotalCount = 0;
foreach ($aRes as $iRow => $aRow) { foreach ($aRes as $iRow => $aRow) {
$sValue = $aRow['grouped_by_1']; $sValue = $aRow['grouped_by_1'];
@@ -1285,7 +1253,7 @@ JS
$iTotalCount += $aRow['_itop_count_']; $iTotalCount += $aRow['_itop_count_'];
} }
$aData = array(); $aData = [];
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$sParams = $oAppContext->GetForLink(true); $sParams = $oAppContext->GetForLink(true);
foreach ($aGroupBy as $iRow => $iCount) { foreach ($aGroupBy as $iRow => $iCount) {
@@ -1296,22 +1264,22 @@ JS
if (isset($aExtraParams['query_params'])) { if (isset($aExtraParams['query_params'])) {
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
} else { } else {
$aQueryParams = array(); $aQueryParams = [];
} }
$sFilter = rawurlencode($oSubsetSearch->serialize(false, $aQueryParams)); $sFilter = rawurlencode($oSubsetSearch->serialize(false, $aQueryParams));
$aData[] = array( $aData[] = [
'group' => $aLabels[$iRow], 'group' => $aLabels[$iRow],
'value' => "<a href=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php?operation=search&dosearch=1$sParams&filter=$sFilter\">$iCount</a>" 'value' => "<a href=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php?operation=search&dosearch=1$sParams&filter=$sFilter\">$iCount</a>",
); // TO DO: add the context information ]; // TO DO: add the context information
} }
$aAttribs = array( $aAttribs = [
'group' => array('label' => $sGroupByLabel, 'description' => ''), 'group' => ['label' => $sGroupByLabel, 'description' => ''],
'value' => array( 'value' => [
'label' => Dict::S('UI:GroupBy:'.$sAggregationFunction), 'label' => Dict::S('UI:GroupBy:'.$sAggregationFunction),
'description' => Dict::Format('UI:GroupBy:'.$sAggregationFunction.'+', $sAggregationAttr), 'description' => Dict::Format('UI:GroupBy:'.$sAggregationFunction.'+', $sAggregationAttr),
), ],
); ];
$sFormat = isset($aExtraParams['format']) ? $aExtraParams['format'] : 'UI:Pagination:HeaderNoSelection'; $sFormat = isset($aExtraParams['format']) ? $aExtraParams['format'] : 'UI:Pagination:HeaderNoSelection';
$aExtraParams['query_params'] = $this->m_oFilter->GetInternalParams(); $aExtraParams['query_params'] = $this->m_oFilter->GetInternalParams();
@@ -1409,7 +1377,6 @@ JS
$oBlock->aExtraParams = $aExtraParams; $oBlock->aExtraParams = $aExtraParams;
$oBlock->sFilter = $this->m_oFilter->ToOQL(); $oBlock->sFilter = $this->m_oFilter->ToOQL();
// Check the classes that can be read (i.e authorized) by this user... // Check the classes that can be read (i.e authorized) by this user...
foreach ($aClasses as $sAlias => $sClassName) { foreach ($aClasses as $sAlias => $sClassName) {
if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $this->m_oSet) != UR_ALLOWED_NO) { if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $this->m_oSet) != UR_ALLOWED_NO) {
@@ -1431,7 +1398,7 @@ JS
$sSearchFilter = $this->m_oSet->GetFilter()->serialize(); $sSearchFilter = $this->m_oSet->GetFilter()->serialize();
// Limit the size of the URL (N°1585 - request uri too long) // Limit the size of the URL (N°1585 - request uri too long)
if (strlen($sSearchFilter) < SERVER_MAX_URL_LENGTH) { if (strlen($sSearchFilter) < SERVER_MAX_URL_LENGTH) {
$oBlock->sEventAttachedData = json_encode(array( $oBlock->sEventAttachedData = json_encode([
'filter' => $sSearchFilter, 'filter' => $sSearchFilter,
'breadcrumb_id' => "ui-search-".$this->m_oSet->GetClass(), 'breadcrumb_id' => "ui-search-".$this->m_oSet->GetClass(),
'breadcrumb_label' => MetaModel::GetName($this->m_oSet->GetClass()), 'breadcrumb_label' => MetaModel::GetName($this->m_oSet->GetClass()),
@@ -1439,7 +1406,7 @@ JS
'breadcrumb_instance_id' => MetaModel::GetConfig()->GetItopInstanceid(), 'breadcrumb_instance_id' => MetaModel::GetConfig()->GetItopInstanceid(),
'breadcrumb_icon' => 'fas fa-search', 'breadcrumb_icon' => 'fas fa-search',
'breadcrumb_icon_type' => iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES, 'breadcrumb_icon_type' => iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES,
)); ]);
} }
} }
@@ -1472,25 +1439,25 @@ JS
$oContentBlock = new UIContentBlock(); $oContentBlock = new UIContentBlock();
$oHtml = new Html(); $oHtml = new Html();
$oContentBlock->AddSubBlock($oHtml); $oContentBlock->AddSubBlock($oHtml);
$aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array(); $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : [];
if (!isset($aExtraParams['group_by'])) { if (!isset($aExtraParams['group_by'])) {
$oHtml->AddHtml('<p>'.Dict::S('UI:Error:MandatoryTemplateParameter_group_by').'</p>'); $oHtml->AddHtml('<p>'.Dict::S('UI:Error:MandatoryTemplateParameter_group_by').'</p>');
} else { } else {
$aGroupByFields = array(); $aGroupByFields = [];
$aGroupBy = explode(',', $aExtraParams['group_by']); $aGroupBy = explode(',', $aExtraParams['group_by']);
foreach ($aGroupBy as $sGroupBy) { foreach ($aGroupBy as $sGroupBy) {
$aMatches = array(); $aMatches = [];
if (preg_match('/^(.+)\.(.+)$/', $sGroupBy, $aMatches) > 0) { if (preg_match('/^(.+)\.(.+)$/', $sGroupBy, $aMatches) > 0) {
$aGroupByFields[] = array('alias' => $aMatches[1], 'att_code' => $aMatches[2]); $aGroupByFields[] = ['alias' => $aMatches[1], 'att_code' => $aMatches[2]];
} }
} }
if (count($aGroupByFields) == 0) { if (count($aGroupByFields) == 0) {
$oHtml->AddHtml('<p>'.Dict::Format('UI:Error:InvalidGroupByFields', $aExtraParams['group_by']).'</p>'); $oHtml->AddHtml('<p>'.Dict::Format('UI:Error:InvalidGroupByFields', $aExtraParams['group_by']).'</p>');
} else { } else {
$aResults = array(); $aResults = [];
$aCriteria = array(); $aCriteria = [];
while ($aObjects = $this->m_oSet->FetchAssoc()) { while ($aObjects = $this->m_oSet->FetchAssoc()) {
$aKeys = array(); $aKeys = [];
foreach ($aGroupByFields as $aField) { foreach ($aGroupByFields as $aField) {
$sAlias = $aField['alias']; $sAlias = $aField['alias'];
if (is_null($aObjects[$sAlias])) { if (is_null($aObjects[$sAlias])) {
@@ -1507,7 +1474,7 @@ JS
$oHtml->AddHtml("<table>\n"); $oHtml->AddHtml("<table>\n");
// Construct a new (parametric) query that will return the content of this block // Construct a new (parametric) query that will return the content of this block
$oBlockFilter = $this->m_oFilter->DeepClone(); $oBlockFilter = $this->m_oFilter->DeepClone();
$aExpressions = array(); $aExpressions = [];
$index = 0; $index = 0;
foreach ($aGroupByFields as $aField) { foreach ($aGroupByFields as $aField) {
$aExpressions[] = '`'.$aField['alias'].'`.`'.$aField['att_code'].'` = :param'.$index++; $aExpressions[] = '`'.$aField['alias'].'`.`'.$aField['att_code'].'` = :param'.$index++;
@@ -1519,7 +1486,7 @@ JS
foreach ($aResults as $sCategory => $aObjects) { foreach ($aResults as $sCategory => $aObjects) {
$oHtml->AddHtml("<tr><td><h1>$sCategory</h1></td></tr>\n"); $oHtml->AddHtml("<tr><td><h1>$sCategory</h1></td></tr>\n");
if (count($aDisplayAliases) == 1) { if (count($aDisplayAliases) == 1) {
$aSimpleArray = array(); $aSimpleArray = [];
foreach ($aObjects as $aRow) { foreach ($aObjects as $aRow) {
$oObj = $aRow[$aDisplayAliases[0]]; $oObj = $aRow[$aDisplayAliases[0]];
if (!is_null($oObj)) { if (!is_null($oObj)) {
@@ -1535,12 +1502,12 @@ JS
$oHtml->AddHtml("</td></tr>\n"); $oHtml->AddHtml("</td></tr>\n");
} else { } else {
$index = 0; $index = 0;
$aArgs = array(); $aArgs = [];
foreach ($aGroupByFields as $aField) { foreach ($aGroupByFields as $aField) {
$aArgs['param'.$index] = $aCriteria[$sCategory][$aField['alias'].'.'.$aField['att_code']]; $aArgs['param'.$index] = $aCriteria[$sCategory][$aField['alias'].'.'.$aField['att_code']];
$index++; $index++;
} }
$oSet = new CMDBObjectSet($oBlockFilter, array(), $aArgs); $oSet = new CMDBObjectSet($oBlockFilter, [], $aArgs);
if (empty($aExtraParams['currentId'])) { if (empty($aExtraParams['currentId'])) {
$iListId = utils::GetUniqueId(); // Works only if not in an Ajax page !! $iListId = utils::GetUniqueId(); // Works only if not in an Ajax page !!
} else { } else {
@@ -1627,7 +1594,7 @@ JS
{ {
$sChartType = isset($aExtraParams['chart_type']) ? $aExtraParams['chart_type'] : 'pie'; $sChartType = isset($aExtraParams['chart_type']) ? $aExtraParams['chart_type'] : 'pie';
$sId = utils::ReadParam('id', ''); $sId = utils::ReadParam('id', '');
$aValues = array(); $aValues = [];
$oBlock = null; $oBlock = null;
$sJSURLs = ''; $sJSURLs = '';
@@ -1638,21 +1605,18 @@ JS
$this->MakeGroupByQuery($aExtraParams, $oGroupByExp, $sGroupByLabel, $aGroupBy, $sAggregationFunction, $sFctVar, $sAggregationAttr, $sSql); $this->MakeGroupByQuery($aExtraParams, $oGroupByExp, $sGroupByLabel, $aGroupBy, $sAggregationFunction, $sFctVar, $sAggregationAttr, $sSql);
$aRes = CMDBSource::QueryToArray($sSql); $aRes = CMDBSource::QueryToArray($sSql);
$iTotalCount = 0; $iTotalCount = 0;
$aURLs = array(); $aURLs = [];
foreach ($aRes as $iRow => $aRow) { foreach ($aRes as $iRow => $aRow) {
$sValue = $aRow['grouped_by_1']; $sValue = $aRow['grouped_by_1'];
$sHtmlValue = $oGroupByExp->MakeValueLabel($this->m_oFilter, $sValue, $sValue); $sHtmlValue = $oGroupByExp->MakeValueLabel($this->m_oFilter, $sValue, $sValue);
$iTotalCount += $aRow['_itop_count_']; $iTotalCount += $aRow['_itop_count_'];
$aValues[] = array( $aValues[] = [
'label' => html_entity_decode(strip_tags($sHtmlValue), ENT_QUOTES, 'UTF-8'), 'label' => html_entity_decode(strip_tags($sHtmlValue), ENT_QUOTES, 'UTF-8'),
'label_html' => $sHtmlValue, 'label_html' => $sHtmlValue,
'value' => (float)$aRow[$sFctVar], 'value' => (float)$aRow[$sFctVar],
); ];
// Build the search for this subset // Build the search for this subset
$oSubsetSearch = $this->m_oFilter->DeepClone(); $oSubsetSearch = $this->m_oFilter->DeepClone();
@@ -1691,7 +1655,7 @@ JS
$aColumns = []; $aColumns = [];
$aNames = []; $aNames = [];
foreach ($aValues as $idx => $aValue) { foreach ($aValues as $idx => $aValue) {
$aColumns[] = array('series_'.$idx, (float)$aValue['value']); $aColumns[] = ['series_'.$idx, (float)$aValue['value']];
$aNames['series_'.$idx] = $aValue['label']; $aNames['series_'.$idx] = $aValue['label'];
} }
@@ -1740,12 +1704,12 @@ JS
$oBlock->sDownloadLink = utils::GetAbsoluteUrlAppRoot().'webservices/export.php?expression='.urlencode($this->m_oFilter->ToOQL(true)).'&format=csv&filename='.urlencode($oBlock->sCsvFile); $oBlock->sDownloadLink = utils::GetAbsoluteUrlAppRoot().'webservices/export.php?expression='.urlencode($this->m_oFilter->ToOQL(true)).'&format=csv&filename='.urlencode($oBlock->sCsvFile);
$oBlock->sLinkToToggle = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=search'.$oAppContext->GetForLink(true).'&filter='.rawurlencode($this->m_oFilter->serialize()).'&format=csv'; $oBlock->sLinkToToggle = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=search'.$oAppContext->GetForLink(true).'&filter='.rawurlencode($this->m_oFilter->serialize()).'&format=csv';
// Pass the parameters via POST, since expression may be very long // Pass the parameters via POST, since expression may be very long
$aParamsToPost = array( $aParamsToPost = [
'expression' => $this->m_oFilter->ToOQL(true), 'expression' => $this->m_oFilter->ToOQL(true),
'format' => 'csv', 'format' => 'csv',
'filename' => $oBlock->sCsvFile, 'filename' => $oBlock->sCsvFile,
'charset' => 'UTF-8', 'charset' => 'UTF-8',
); ];
if ($oBlock->bAdvancedMode) { if ($oBlock->bAdvancedMode) {
$oBlock->sDownloadLink .= '&fields_advanced=1'; $oBlock->sDownloadLink .= '&fields_advanced=1';
$aParamsToPost['fields_advanced'] = 1; $aParamsToPost['fields_advanced'] = 1;
@@ -1804,8 +1768,7 @@ class MenuBlock extends DisplayBlock
$oRouter = Router::GetInstance(); $oRouter = Router::GetInstance();
$oRenderBlock = new UIContentBlock(); $oRenderBlock = new UIContentBlock();
if ($this->m_sStyle == 'popup') // popup is a synonym of 'list' for backward compatibility if ($this->m_sStyle == 'popup') { // popup is a synonym of 'list' for backward compatibility
{
$this->m_sStyle = static::ENUM_STYLE_LIST; $this->m_sStyle = static::ENUM_STYLE_LIST;
} }
@@ -1844,7 +1807,6 @@ class MenuBlock extends DisplayBlock
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$sContext = $oAppContext->GetForLink(true); $sContext = $oAppContext->GetForLink(true);
$sFilter = $this->GetFilter()->serialize(); $sFilter = $this->GetFilter()->serialize();
$sUIPage = cmdbAbstractObject::ComputeStandardUIPage($sClass); $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($sClass);
$sRootUrl = utils::GetAbsoluteUrlAppRoot(); $sRootUrl = utils::GetAbsoluteUrlAppRoot();
@@ -1922,8 +1884,8 @@ class MenuBlock extends DisplayBlock
// Life cycle actions may be available... if all objects are in the same state // Life cycle actions may be available... if all objects are in the same state
// Group by <state> // Group by <state>
$oGroupByExp = new FieldExpression(MetaModel::GetStateAttributeCode($sClass), $this->m_oFilter->GetClassAlias()); $oGroupByExp = new FieldExpression(MetaModel::GetStateAttributeCode($sClass), $this->m_oFilter->GetClassAlias());
$aGroupBy = array('__state__' => $oGroupByExp); $aGroupBy = ['__state__' => $oGroupByExp];
$aQueryParams = array(); $aQueryParams = [];
if (isset($aExtraParams['query_params'])) { if (isset($aExtraParams['query_params'])) {
$aQueryParams = $aExtraParams['query_params']; $aQueryParams = $aExtraParams['query_params'];
} }
@@ -1955,10 +1917,10 @@ class MenuBlock extends DisplayBlock
switch ($iActionAllowed) { switch ($iActionAllowed) {
case UR_ALLOWED_YES: case UR_ALLOWED_YES:
case UR_ALLOWED_DEPENDS: case UR_ALLOWED_DEPENDS:
$aTransitionActions[$sStimulusCode] = array( $aTransitionActions[$sStimulusCode] = [
'label' => $aStimuli[$sStimulusCode]->GetLabel(), 'label' => $aStimuli[$sStimulusCode]->GetLabel(),
'url' => "{$sRootUrl}pages/UI.php?stimulus=$sStimulusCode&class=$sLifecycleClass&{$sUrlQueryString}", 'url' => "{$sRootUrl}pages/UI.php?stimulus=$sStimulusCode&class=$sLifecycleClass&{$sUrlQueryString}",
) + $aActionParams; ] + $aActionParams;
break; break;
default: default:
@@ -2020,16 +1982,16 @@ class MenuBlock extends DisplayBlock
// Just one object in the set, possible actions are "new / clone / modify and delete" // Just one object in the set, possible actions are "new / clone / modify and delete"
if (!isset($aExtraParams['link_attr'])) { if (!isset($aExtraParams['link_attr'])) {
if ($bIsModifyAllowed) { if ($bIsModifyAllowed) {
$aRegularActions['UI:Menu:Modify'] = array( $aRegularActions['UI:Menu:Modify'] = [
'label' => Dict::S('UI:Menu:Modify'), 'label' => Dict::S('UI:Menu:Modify'),
'url' => $oRouter->GenerateUrl('object.modify', ['class' => $sClass, 'id' => $id])."{$sContext}#", 'url' => $oRouter->GenerateUrl('object.modify', ['class' => $sClass, 'id' => $id])."{$sContext}#",
) + $aActionParams; ] + $aActionParams;
} }
if ($bIsDeleteAllowed) { if ($bIsDeleteAllowed) {
$aRegularActions['UI:Menu:Delete'] = array( $aRegularActions['UI:Menu:Delete'] = [
'label' => Dict::S('UI:Menu:Delete'), 'label' => Dict::S('UI:Menu:Delete'),
'url' => "{$sRootUrl}pages/$sUIPage?operation=delete&class=$sClass&id=$id{$sContext}", 'url' => "{$sRootUrl}pages/$sUIPage?operation=delete&class=$sClass&id=$id{$sContext}",
) + $aActionParams; ] + $aActionParams;
} }
// Relations... // Relations...
@@ -2038,16 +2000,16 @@ class MenuBlock extends DisplayBlock
$this->AddMenuSeparator($aRegularActions); $this->AddMenuSeparator($aRegularActions);
foreach ($aRelations as $sRelationCode => $aRelationInfo) { foreach ($aRelations as $sRelationCode => $aRelationInfo) {
if (array_key_exists('down', $aRelationInfo)) { if (array_key_exists('down', $aRelationInfo)) {
$aRegularActions[$sRelationCode.'_down'] = array( $aRegularActions['UI:Menu:'.$sRelationCode.'_down'] = [
'label' => $aRelationInfo['down'], 'label' => $aRelationInfo['down'],
'url' => "{$sRootUrl}pages/$sUIPage?operation=view_relations&relation=$sRelationCode&direction=down&class=$sClass&id=$id{$sContext}", 'url' => "{$sRootUrl}pages/$sUIPage?operation=view_relations&relation=$sRelationCode&direction=down&class=$sClass&id=$id{$sContext}",
) + $aActionParams; ] + $aActionParams;
} }
if (array_key_exists('up', $aRelationInfo)) { if (array_key_exists('up', $aRelationInfo)) {
$aRegularActions[$sRelationCode.'_up'] = array( $aRegularActions['UI:Menu:'.$sRelationCode.'_up'] = [
'label' => $aRelationInfo['up'], 'label' => $aRelationInfo['up'],
'url' => "{$sRootUrl}pages/$sUIPage?operation=view_relations&relation=$sRelationCode&direction=up&class=$sClass&id=$id{$sContext}", 'url' => "{$sRootUrl}pages/$sUIPage?operation=view_relations&relation=$sRelationCode&direction=up&class=$sClass&id=$id{$sContext}",
) + $aActionParams; ] + $aActionParams;
} }
} }
} }
@@ -2059,7 +2021,7 @@ class MenuBlock extends DisplayBlock
$bCanKill = false; $bCanKill = false;
$oUser = UserRights::GetUserObject(); $oUser = UserRights::GetUserObject();
$aUserProfiles = array(); $aUserProfiles = [];
if (!is_null($oUser)) { if (!is_null($oUser)) {
$oProfileSet = $oUser->Get('profile_list'); $oProfileSet = $oUser->Get('profile_list');
while ($oProfile = $oProfileSet->Fetch()) { while ($oProfile = $oProfileSet->Fetch()) {
@@ -2081,10 +2043,10 @@ class MenuBlock extends DisplayBlock
if ($bCanKill) { if ($bCanKill) {
$this->AddMenuSeparator($aRegularActions); $this->AddMenuSeparator($aRegularActions);
$aRegularActions['concurrent_lock_unlock'] = array( $aRegularActions['concurrent_lock_unlock'] = [
'label' => Dict::S('UI:Menu:KillConcurrentLock'), 'label' => Dict::S('UI:Menu:KillConcurrentLock'),
'url' => "{$sRootUrl}pages/$sUIPage?operation=kill_lock&class=$sClass&id=$id{$sContext}", 'url' => "{$sRootUrl}pages/$sUIPage?operation=kill_lock&class=$sClass&id=$id{$sContext}",
); ];
} }
} }
} }
@@ -2092,7 +2054,7 @@ class MenuBlock extends DisplayBlock
$this->AddMenuSeparator($aRegularActions); $this->AddMenuSeparator($aRegularActions);
$this->GetEnumAllowedActions($oSet, function ($sLabel, $data) use (&$aRegularActions, $aActionParams) { $this->GetEnumAllowedActions($oSet, function ($sLabel, $data) use (&$aRegularActions, $aActionParams) {
$aRegularActions[$sLabel] = array('label' => $sLabel, 'url' => $data) + $aActionParams; $aRegularActions[$sLabel] = ['label' => $sLabel, 'url' => $data] + $aActionParams;
}); });
} }
break; break;
@@ -2289,6 +2251,16 @@ class MenuBlock extends DisplayBlock
$sIconClass = 'fas fa-file-pdf fa-lg'; $sIconClass = 'fas fa-file-pdf fa-lg';
$sLabel = ''; $sLabel = '';
break; break;
case 'UI:Menu:impacts_up':
$sIconClass = 'fas fa-sitemap fa-rotate-180';
$sLabel = '';
$aAction['tooltip'] = Dict::S('Relation:impacts/UpStream');
break;
case 'UI:Menu:impacts_down':
$sIconClass = 'fas fa-sitemap';
$sLabel = '';
$aAction['tooltip'] = Dict::S('Relation:impacts/DownStream');
break;
default: default:
if (isset($aAction['icon_class']) && (strlen($aAction['icon_class']) > 0)) { if (isset($aAction['icon_class']) && (strlen($aAction['icon_class']) > 0)) {
@@ -2458,13 +2430,11 @@ class MenuBlock extends DisplayBlock
protected function AddMenuSeparator(&$aActions) protected function AddMenuSeparator(&$aActions)
{ {
$sSeparator = '<hr class="menu-separator"/>'; $sSeparator = '<hr class="menu-separator"/>';
if (count($aActions) > 0) // Make sure that the separator is not the first item in the menu if (count($aActions) > 0) { // Make sure that the separator is not the first item in the menu
{
$aKeys = array_keys($aActions); $aKeys = array_keys($aActions);
$sLastKey = array_pop($aKeys); $sLastKey = array_pop($aKeys);
if ($aActions[$sLastKey]['label'] != $sSeparator) // Make sure there are no 2 consecutive separators if ($aActions[$sLastKey]['label'] != $sSeparator) { // Make sure there are no 2 consecutive separators
{ $aActions['sep_'.(count($aActions) - 1)] = ['label' => $sSeparator, 'url' => ''];
$aActions['sep_'.(count($aActions)-1)] = array('label' => $sSeparator, 'url' => '');
} }
} }
} }
@@ -2524,10 +2494,10 @@ class MenuBlock extends DisplayBlock
*/ */
protected function AddBulkDeleteObjectsMenuAction(array &$aActions, string $sClass, string $sFilter, string $sActionIdentifier = 'UI:Menu:BulkDelete', $sActionLabel = 'UI:Menu:BulkDelete') protected function AddBulkDeleteObjectsMenuAction(array &$aActions, string $sClass, string $sFilter, string $sActionIdentifier = 'UI:Menu:BulkDelete', $sActionLabel = 'UI:Menu:BulkDelete')
{ {
$aActions[$sActionIdentifier] = array( $aActions[$sActionIdentifier] = [
'label' => Dict::S($sActionLabel), 'label' => Dict::S($sActionLabel),
'url' => $this->PrepareUrlForStandardMenuAction($sClass, "operation=select_for_deletion&filter=".urlencode($sFilter)), 'url' => $this->PrepareUrlForStandardMenuAction($sClass, "operation=select_for_deletion&filter=".urlencode($sFilter)),
) + $this->GetDefaultParamsForMenuAction(); ] + $this->GetDefaultParamsForMenuAction();
} }
/** /**

View File

@@ -22,31 +22,28 @@ class ExcelExporter
public function __construct($sToken = null) public function __construct($sToken = null)
{ {
$this->aStatistics = array( $this->aStatistics = [
'objects_count' => 0, 'objects_count' => 0,
'total_duration' => 0, 'total_duration' => 0,
'data_retrieval_duration' => 0, 'data_retrieval_duration' => 0,
'excel_build_duration' => 0, 'excel_build_duration' => 0,
'excel_write_duration' => 0, 'excel_write_duration' => 0,
'peak_memory_usage' => 0, 'peak_memory_usage' => 0,
); ];
$this->fStartTime = microtime(true); $this->fStartTime = microtime(true);
$this->oSearch = null; $this->oSearch = null;
$this->sState = 'new'; $this->sState = 'new';
$this->aObjectsIDs = array(); $this->aObjectsIDs = [];
$this->iPosition = 0; $this->iPosition = 0;
$this->aAuthorizedClasses = null; $this->aAuthorizedClasses = null;
$this->aTableHeaders = null; $this->aTableHeaders = null;
$this->sOutputFilePath = null; $this->sOutputFilePath = null;
$this->bAdvancedMode = false; $this->bAdvancedMode = false;
$this->CheckDataDir(); $this->CheckDataDir();
if ($sToken == null) if ($sToken == null) {
{
$this->sToken = $this->GetNewToken(); $this->sToken = $this->GetNewToken();
} } else {
else
{
$this->sToken = $sToken; $this->sToken = $sToken;
$this->ReloadState(); $this->ReloadState();
} }
@@ -54,13 +51,10 @@ class ExcelExporter
public function __destruct() public function __destruct()
{ {
if (($this->sState != 'done') && ($this->sState != 'error') && ($this->sToken != null)) if (($this->sState != 'done') && ($this->sState != 'error') && ($this->sToken != null)) {
{
// Operation in progress, save the state // Operation in progress, save the state
$this->SaveState(); $this->SaveState();
} } else {
else
{
// Operation completed, cleanup the temp files // Operation completed, cleanup the temp files
@unlink($this->GetStateFile()); @unlink($this->GetStateFile());
@unlink($this->GetDataFile()); @unlink($this->GetDataFile());
@@ -85,7 +79,7 @@ class ExcelExporter
public function SaveState() public function SaveState()
{ {
$aState = array( $aState = [
'state' => $this->sState, 'state' => $this->sState,
'statistics' => $this->aStatistics, 'statistics' => $this->aStatistics,
'filter' => $this->oSearch->serialize(), 'filter' => $this->oSearch->serialize(),
@@ -94,7 +88,7 @@ class ExcelExporter
'object_ids' => $this->aObjectsIDs, 'object_ids' => $this->aObjectsIDs,
'output_file_path' => $this->sOutputFilePath, 'output_file_path' => $this->sOutputFilePath,
'advanced_mode' => $this->bAdvancedMode, 'advanced_mode' => $this->bAdvancedMode,
); ];
file_put_contents($this->GetStateFile(), json_encode($aState)); file_put_contents($this->GetStateFile(), json_encode($aState));
@@ -103,19 +97,16 @@ class ExcelExporter
public function ReloadState() public function ReloadState()
{ {
if ($this->sToken == null) if ($this->sToken == null) {
{
throw new Exception('ExcelExporter not initialized with a token, cannot reload state'); throw new Exception('ExcelExporter not initialized with a token, cannot reload state');
} }
if (!file_exists($this->GetStateFile())) if (!file_exists($this->GetStateFile())) {
{
throw new Exception("ExcelExporter: missing status file '".$this->GetStateFile()."', cannot reload state."); throw new Exception("ExcelExporter: missing status file '".$this->GetStateFile()."', cannot reload state.");
} }
$sJson = file_get_contents($this->GetStateFile()); $sJson = file_get_contents($this->GetStateFile());
$aState = json_decode($sJson, true); $aState = json_decode($sJson, true);
if ($aState === null) if ($aState === null) {
{
throw new Exception("ExcelExporter:corrupted status file '".$this->GetStateFile()."', not a JSON, cannot reload state."); throw new Exception("ExcelExporter:corrupted status file '".$this->GetStateFile()."', not a JSON, cannot reload state.");
} }
@@ -141,16 +132,13 @@ class ExcelExporter
$sMessage = Dict::Format('ExcelExporter:ErrorUnexpected_State', $this->sState); $sMessage = Dict::Format('ExcelExporter:ErrorUnexpected_State', $this->sState);
$fTime = microtime(true); $fTime = microtime(true);
try try {
{ switch ($this->sState) {
switch($this->sState)
{
case 'new': case 'new':
$oIDSet = new DBObjectSet($this->oSearch); $oIDSet = new DBObjectSet($this->oSearch);
$oIDSet->OptimizeColumnLoad(array('id')); $oIDSet->OptimizeColumnLoad(['id']);
$this->aObjectsIDs = array(); $this->aObjectsIDs = [];
while($oObj = $oIDSet->Fetch()) while ($oObj = $oIDSet->Fetch()) {
{
$this->aObjectsIDs[] = $oObj->GetKey(); $this->aObjectsIDs[] = $oObj->GetKey();
} }
$sCode = 'retrieving-data'; $sCode = 'retrieving-data';
@@ -164,8 +152,7 @@ class ExcelExporter
$this->GetFieldsList($oIDSet, $this->bAdvancedMode); $this->GetFieldsList($oIDSet, $this->bAdvancedMode);
$sRow = json_encode($this->aTableHeaders); $sRow = json_encode($this->aTableHeaders);
$hFile = @fopen($this->GetDataFile(), 'ab'); $hFile = @fopen($this->GetDataFile(), 'ab');
if ($hFile === false) if ($hFile === false) {
{
throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.'); throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.');
} }
fwrite($hFile, $sRow."\n"); fwrite($hFile, $sRow."\n");
@@ -181,32 +168,24 @@ class ExcelExporter
$oCurrentSearch->AddCondition('id', $aIDs, 'IN'); $oCurrentSearch->AddCondition('id', $aIDs, 'IN');
$hFile = @fopen($this->GetDataFile(), 'ab'); $hFile = @fopen($this->GetDataFile(), 'ab');
if ($hFile === false) if ($hFile === false) {
{
throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.'); throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.');
} }
$oSet = new DBObjectSet($oCurrentSearch); $oSet = new DBObjectSet($oCurrentSearch);
$this->GetFieldsList($oSet, $this->bAdvancedMode); $this->GetFieldsList($oSet, $this->bAdvancedMode);
while($aObjects = $oSet->FetchAssoc()) while ($aObjects = $oSet->FetchAssoc()) {
{ $aRow = [];
$aRow = array(); foreach ($this->aAuthorizedClasses as $sAlias => $sClassName) {
foreach($this->aAuthorizedClasses as $sAlias => $sClassName)
{
$oObj = $aObjects[$sAlias]; $oObj = $aObjects[$sAlias];
if ($this->bAdvancedMode) if ($this->bAdvancedMode) {
{
$aRow[] = $oObj->GetKey(); $aRow[] = $oObj->GetKey();
} }
foreach($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef) foreach ($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef) {
{
$value = $oObj->Get($sAttCodeEx); $value = $oObj->Get($sAttCodeEx);
if ($value instanceOf ormCaseLog) if ($value instanceof ormCaseLog) {
{
// Extract the case log as text and remove the "===" which make Excel think that the cell contains a formula the next time you edit it! // Extract the case log as text and remove the "===" which make Excel think that the cell contains a formula the next time you edit it!
$sExcelVal = trim(preg_replace('/========== ([^=]+) ============/', '********** $1 ************', $value->GetText())); $sExcelVal = trim(preg_replace('/========== ([^=]+) ============/', '********** $1 ************', $value->GetText()));
} } else {
else
{
$sExcelVal = $oAttDef->GetEditValue($value, $oObj); $sExcelVal = $oAttDef->GetEditValue($value, $oObj);
} }
$aRow[] = $sExcelVal; $aRow[] = $sExcelVal;
@@ -217,16 +196,13 @@ class ExcelExporter
} }
fclose($hFile); fclose($hFile);
if (($this->iPosition + $this->iChunkSize) > count($this->aObjectsIDs)) if (($this->iPosition + $this->iChunkSize) > count($this->aObjectsIDs)) {
{
// Next state // Next state
$this->sState = 'building-excel'; $this->sState = 'building-excel';
$sCode = 'building-excel'; $sCode = 'building-excel';
$iPercentage = 80; $iPercentage = 80;
$sMessage = Dict::S('ExcelExporter:BuildingExcelFile'); $sMessage = Dict::S('ExcelExporter:BuildingExcelFile');
} } else {
else
{
$sCode = 'retrieving-data'; $sCode = 'retrieving-data';
$this->iPosition += $this->iChunkSize; $this->iPosition += $this->iChunkSize;
$iPercentage = 5 + round(75 * ($this->iPosition / count($this->aObjectsIDs))); $iPercentage = 5 + round(75 * ($this->iPosition / count($this->aObjectsIDs)));
@@ -236,16 +212,14 @@ class ExcelExporter
case 'building-excel': case 'building-excel':
$hFile = @fopen($this->GetDataFile(), 'rb'); $hFile = @fopen($this->GetDataFile(), 'rb');
if ($hFile === false) if ($hFile === false) {
{
throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for reading.'); throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for reading.');
} }
$sHeaders = fgets($hFile); $sHeaders = fgets($hFile);
$aHeaders = json_decode($sHeaders, true); $aHeaders = json_decode($sHeaders, true);
$aData = array(); $aData = [];
while($sLine = fgets($hFile)) while ($sLine = fgets($hFile)) {
{
$aRow = json_decode($sLine); $aRow = json_decode($sLine);
$aData[] = $aRow; $aData[] = $aRow;
} }
@@ -278,35 +252,29 @@ class ExcelExporter
$sMessage = Dict::S('ExcelExporter:Done'); $sMessage = Dict::S('ExcelExporter:Done');
break; break;
} }
} } catch (Exception $e) {
catch(Exception $e)
{
$sCode = 'error'; $sCode = 'error';
$sMessage = $e->getMessage(); $sMessage = $e->getMessage();
} }
$this->aStatistics['total_duration'] += microtime(true) - $fTime; $this->aStatistics['total_duration'] += microtime(true) - $fTime;
$peak_memory = memory_get_peak_usage(true); $peak_memory = memory_get_peak_usage(true);
if ($peak_memory > $this->aStatistics['peak_memory_usage']) if ($peak_memory > $this->aStatistics['peak_memory_usage']) {
{
$this->aStatistics['peak_memory_usage'] = $peak_memory; $this->aStatistics['peak_memory_usage'] = $peak_memory;
} }
return array( return [
'code' => $sCode, 'code' => $sCode,
'message' => $sMessage, 'message' => $sMessage,
'percentage' => $iPercentage, 'percentage' => $iPercentage,
); ];
} }
public function GetExcelFilePath() public function GetExcelFilePath()
{ {
if ($this->sOutputFilePath == null) if ($this->sOutputFilePath == null) {
{
return utils::GetDataPath().'bulk_export/'.$this->sToken.'.xlsx'; return utils::GetDataPath().'bulk_export/'.$this->sToken.'.xlsx';
} } else {
else
{
return $this->sOutputFilePath; return $this->sOutputFilePath;
} }
} }
@@ -337,14 +305,11 @@ class ExcelExporter
$aFiles = glob(utils::GetDataPath().'bulk_export/*.*'); $aFiles = glob(utils::GetDataPath().'bulk_export/*.*');
$iDelay = MetaModel::GetConfig()->Get('xlsx_exporter_cleanup_old_files_delay'); $iDelay = MetaModel::GetConfig()->Get('xlsx_exporter_cleanup_old_files_delay');
if($iDelay > 0) if ($iDelay > 0) {
{ foreach ($aFiles as $sFile) {
foreach($aFiles as $sFile)
{
$iModificationTime = filemtime($sFile); $iModificationTime = filemtime($sFile);
if($iModificationTime < (time() - $iDelay)) if ($iModificationTime < (time() - $iDelay)) {
{
// Temporary files older than one day are deleted // Temporary files older than one day are deleted
//echo "Supposed to delete: '".$sFile." (Unix Modification Time: $iModificationTime)'\n"; //echo "Supposed to delete: '".$sFile." (Unix Modification Time: $iModificationTime)'\n";
@unlink($sFile); @unlink($sFile);
@@ -355,21 +320,18 @@ class ExcelExporter
public function DisplayStatistics(Page $oPage) public function DisplayStatistics(Page $oPage)
{ {
$aStats = array( $aStats = [
'Number of objects exported' => $this->aStatistics['objects_count'], 'Number of objects exported' => $this->aStatistics['objects_count'],
'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']), 'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']),
'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']), 'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']),
'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']), 'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']),
'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']), 'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']),
'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']), 'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']),
); ];
if ($oPage instanceof CLIPage) if ($oPage instanceof CLIPage) {
{
$oPage->add($this->GetStatistics('text')); $oPage->add($this->GetStatistics('text'));
} } else {
else
{
$oPage->add($this->GetStatistics('html')); $oPage->add($this->GetStatistics('html'));
} }
} }
@@ -377,29 +339,24 @@ class ExcelExporter
public function GetStatistics($sFormat = 'html') public function GetStatistics($sFormat = 'html')
{ {
$sStats = ''; $sStats = '';
$aStats = array( $aStats = [
'Number of objects exported' => $this->aStatistics['objects_count'], 'Number of objects exported' => $this->aStatistics['objects_count'],
'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']), 'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']),
'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']), 'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']),
'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']), 'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']),
'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']), 'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']),
'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']), 'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']),
); ];
if ($sFormat == 'text') if ($sFormat == 'text') {
{ foreach ($aStats as $sLabel => $sValue) {
foreach($aStats as $sLabel => $sValue)
{
$sStats .= "+------------------------------+----------+\n"; $sStats .= "+------------------------------+----------+\n";
$sStats .= sprintf("|%-30s|%10s|\n", $sLabel, $sValue); $sStats .= sprintf("|%-30s|%10s|\n", $sLabel, $sValue);
} }
$sStats .= "+------------------------------+----------+"; $sStats .= "+------------------------------+----------+";
} } else {
else
{
$sStats .= '<table><tbody>'; $sStats .= '<table><tbody>';
foreach($aStats as $sLabel => $sValue) foreach ($aStats as $sLabel => $sValue) {
{
$sStats .= "<tr><td>$sLabel</td><td>$sValue</td></tr>"; $sStats .= "<tr><td>$sLabel</td><td>$sValue</td></tr>";
} }
$sStats .= '</tbody></table>'; $sStats .= '</tbody></table>';
@@ -410,27 +367,24 @@ class ExcelExporter
public static function HumanDisplay($iSize) public static function HumanDisplay($iSize)
{ {
$aUnits = array('B','KB','MB','GB','TB','PB'); $aUnits = ['B','KB','MB','GB','TB','PB'];
return @round($iSize / pow(1024, ($i = floor(log($iSize, 1024)))), 2).' '.$aUnits[$i]; return @round($iSize / pow(1024, ($i = floor(log($iSize, 1024)))), 2).' '.$aUnits[$i];
} }
protected function CheckDataDir() protected function CheckDataDir()
{ {
if(!is_dir(utils::GetDataPath()."bulk_export")) if (!is_dir(utils::GetDataPath()."bulk_export")) {
{
@mkdir(utils::GetDataPath()."bulk_export", 0777, true /* recursive */); @mkdir(utils::GetDataPath()."bulk_export", 0777, true /* recursive */);
clearstatcache(); clearstatcache();
} }
if (!is_writable(utils::GetDataPath()."bulk_export")) if (!is_writable(utils::GetDataPath()."bulk_export")) {
{
throw new Exception('Data directory "'.utils::GetDataPath().'bulk_export" could not be written.'); throw new Exception('Data directory "'.utils::GetDataPath().'bulk_export" could not be written.');
} }
} }
protected function GetStateFile($sToken = null) protected function GetStateFile($sToken = null)
{ {
if ($sToken == null) if ($sToken == null) {
{
$sToken = $this->sToken; $sToken = $this->sToken;
} }
return utils::GetDataPath()."bulk_export/$sToken.status"; return utils::GetDataPath()."bulk_export/$sToken.status";
@@ -444,14 +398,12 @@ class ExcelExporter
protected function GetNewToken() protected function GetNewToken()
{ {
$iNum = rand(); $iNum = rand();
do do {
{
$iNum++; $iNum++;
$sToken = sprintf("%08x", $iNum); $sToken = sprintf("%08x", $iNum);
$sFileName = $this->GetStateFile($sToken); $sFileName = $this->GetStateFile($sToken);
$hFile = @fopen($sFileName, 'x'); $hFile = @fopen($sFileName, 'x');
} } while ($hFile === false);
while($hFile === false);
fclose($hFile); fclose($hFile);
return $sToken; return $sToken;
@@ -459,82 +411,61 @@ class ExcelExporter
protected function GetFieldsList($oSet, $bFieldsAdvanced = false, $bLocalize = true, $aFields = null) protected function GetFieldsList($oSet, $bFieldsAdvanced = false, $bLocalize = true, $aFields = null)
{ {
$this->aFieldsList = array(); $this->aFieldsList = [];
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$aClasses = $oSet->GetFilter()->GetSelectedClasses(); $aClasses = $oSet->GetFilter()->GetSelectedClasses();
$this->aAuthorizedClasses = array(); $this->aAuthorizedClasses = [];
foreach($aClasses as $sAlias => $sClassName) foreach ($aClasses as $sAlias => $sClassName) {
{ if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) != UR_ALLOWED_NO) {
if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) != UR_ALLOWED_NO)
{
$this->aAuthorizedClasses[$sAlias] = $sClassName; $this->aAuthorizedClasses[$sAlias] = $sClassName;
} }
} }
$aAttribs = array(); $aAttribs = [];
$this->aTableHeaders = array(); $this->aTableHeaders = [];
foreach($this->aAuthorizedClasses as $sAlias => $sClassName) foreach ($this->aAuthorizedClasses as $sAlias => $sClassName) {
{ $aList[$sAlias] = [];
$aList[$sAlias] = array();
foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef) foreach (MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef) {
{ if (is_null($aFields) || (count($aFields) == 0)) {
if (is_null($aFields) || (count($aFields) == 0))
{
// Standard list of attributes (no link sets) // Standard list of attributes (no link sets)
if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField())) if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField())) {
{
$sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode; $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE)) if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE)) {
{ if ($bFieldsAdvanced) {
if ($bFieldsAdvanced)
{
$aList[$sAlias][$sAttCodeEx] = $oAttDef; $aList[$sAlias][$sAttCodeEx] = $oAttDef;
if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE)) if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE)) {
{
$sRemoteClass = $oAttDef->GetTargetClass(); $sRemoteClass = $oAttDef->GetTargetClass();
foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode) foreach (MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode) {
{
$this->aFieldsList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode); $this->aFieldsList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
} }
} }
} }
} } else {
else
{
// Any other attribute // Any other attribute
$this->aFieldsList[$sAlias][$sAttCodeEx] = $oAttDef; $this->aFieldsList[$sAlias][$sAttCodeEx] = $oAttDef;
} }
} }
} } else {
else
{
// User defined list of attributes // User defined list of attributes
if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields)) if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields)) {
{
$this->aFieldsList[$sAlias][$sAttCode] = $oAttDef; $this->aFieldsList[$sAlias][$sAttCode] = $oAttDef;
} }
} }
} }
if ($bFieldsAdvanced) if ($bFieldsAdvanced) {
{
$this->aTableHeaders['id'] = '0'; $this->aTableHeaders['id'] = '0';
} }
foreach($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef) foreach ($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef) {
{
$sLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx, isset($aParams['showMandatoryFields'])) : $sAttCodeEx; $sLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx, isset($aParams['showMandatoryFields'])) : $sAttCodeEx;
if($oAttDef instanceof AttributeDateTime) if ($oAttDef instanceof AttributeDateTime) {
{
$this->aTableHeaders[$sLabel] = 'datetime'; $this->aTableHeaders[$sLabel] = 'datetime';
} } else {
else
{
$this->aTableHeaders[$sLabel] = 'string'; $this->aTableHeaders[$sLabel] = 'string';
} }
} }
} }
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -77,7 +78,6 @@ class CoreCannotSaveObjectException extends CoreException
return $sContent; return $sContent;
} }
public function getIssues() public function getIssues()
{ {
return $this->aIssues; return $this->aIssues;

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -35,10 +36,10 @@ class CoreException extends Exception
} }
if (count($this->m_aContextData) > 0) { if (count($this->m_aContextData) > 0) {
$sMessage .= ": "; $sMessage .= ": ";
$aContextItems = array(); $aContextItems = [];
foreach ($this->m_aContextData as $sKey => $value) { foreach ($this->m_aContextData as $sKey => $value) {
if (is_array($value)) { if (is_array($value)) {
$aPairs = array(); $aPairs = [];
foreach ($value as $key => $val) { foreach ($value as $key => $val) {
if (is_array($val)) { if (is_array($val)) {
$aPairs[] = $key.'=>('.implode(', ', $val).')'; $aPairs[] = $key.'=>('.implode(', ', $val).')';

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -9,5 +10,4 @@
*/ */
class CorePortalInvalidActionRuleException extends CoreException class CorePortalInvalidActionRuleException extends CoreException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -8,7 +9,7 @@ class DictExceptionMissingString extends DictException
{ {
public function __construct($sLanguageCode, $sStringCode) public function __construct($sLanguageCode, $sStringCode)
{ {
$aContext = array(); $aContext = [];
$aContext['language_code'] = $sLanguageCode; $aContext['language_code'] = $sLanguageCode;
$aContext['string_code'] = $sStringCode; $aContext['string_code'] = $sStringCode;
parent::__construct('Missing localized string', $aContext); parent::__construct('Missing localized string', $aContext);

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -8,7 +9,7 @@ class DictExceptionUnknownLanguage extends DictException
{ {
public function __construct($sLanguageCode) public function __construct($sLanguageCode)
{ {
$aContext = array(); $aContext = [];
$aContext['language_code'] = $sLanguageCode; $aContext['language_code'] = $sLanguageCode;
parent::__construct('Unknown localization language', $aContext); parent::__construct('Unknown localization language', $aContext);
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -6,5 +7,4 @@
class iTopXmlException extends CoreException class iTopXmlException extends CoreException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -19,10 +20,10 @@ class MySQLHasGoneAwayException extends MySQLException
*/ */
public static function getErrorCodes() public static function getErrorCodes()
{ {
return array( return [
2006, 2006,
2013, 2013,
); ];
} }
public function __construct($sIssue, $aContext) public function __construct($sIssue, $aContext)

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -9,5 +10,4 @@
*/ */
class MySQLNoTransactionException extends MySQLException class MySQLNoTransactionException extends MySQLException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -11,5 +12,4 @@
*/ */
class MySQLQueryHasNoResultException extends MySQLException class MySQLQueryHasNoResultException extends MySQLException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -9,5 +10,4 @@
*/ */
class MySQLTransactionNotClosedException extends MySQLException class MySQLTransactionNotClosedException extends MySQLException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -9,5 +10,4 @@
*/ */
class CoreOqlException extends CoreException class CoreOqlException extends CoreException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -9,5 +10,4 @@
*/ */
class CoreOqlMultipleResultsForbiddenException extends CoreOqlException class CoreOqlMultipleResultsForbiddenException extends CoreOqlException
{ {
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* Copyright (C) 2013-2024 Combodo SAS * Copyright (C) 2013-2024 Combodo SAS
* *
@@ -22,8 +23,8 @@
* @author Olivier DAIN <olivier.dain@combodo.com> * @author Olivier DAIN <olivier.dain@combodo.com>
* @since 3.0.0 N°3588 * @since 3.0.0 N°3588
*/ */
class FindStylesheetObject{ class FindStylesheetObject
{
//file URIs //file URIs
private $aStylesheetFileURIs; private $aStylesheetFileURIs;
@@ -92,7 +93,8 @@ class FindStylesheetObject{
$this->sLastStyleSheetPath = $sStylesheetFilePath; $this->sLastStyleSheetPath = $sStylesheetFilePath;
} }
public function AlreadyFetched(string $sStylesheetFilePath) : bool { public function AlreadyFetched(string $sStylesheetFilePath): bool
{
return in_array($sStylesheetFilePath, $this->aAllStylesheetFilePaths); return in_array($sStylesheetFilePath, $this->aAllStylesheetFilePaths);
} }

File diff suppressed because it is too large Load Diff

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* Persistent class InputOutputTask * Persistent class InputOutputTask
* *
@@ -34,36 +34,37 @@ class InputOutputTask extends cmdbAbstractObject
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "application", "category" => "application",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_iotask", "db_table" => "priv_iotask",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["allowed_values" => null, "sql" => "name", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("description", ["allowed_values" => null, "sql" => "description", "default_value" => "", "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("category", array("allowed_values" => new ValueSetEnum('Input, Ouput'), "sql" => "category", "default_value" => "Input", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeEnum("category", ["allowed_values" => new ValueSetEnum('Input, Ouput'), "sql" => "category", "default_value" => "Input", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("source_type", array("allowed_values" => new ValueSetEnum('File, Database, Web Service'), "sql" => "source_type", "default_value" => "File", "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeEnum("source_type", ["allowed_values" => new ValueSetEnum('File, Database, Web Service'), "sql" => "source_type", "default_value" => "File", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("source_subtype", MetaModel::Init_AddAttribute(new AttributeEnum(
array("allowed_values" => new ValueSetEnum('Oracle, MySQL, Postgress, MSSQL, SOAP, HTTP-Get, HTTP-Post, XML/RPC, CSV, XML, Excel'), "sql" => "source_subtype", "default_value" => "CSV", "is_null_allowed" => false, "depends_on" => array()))); "source_subtype",
MetaModel::Init_AddAttribute(new AttributeString("source_path", array("allowed_values" => null, "sql" => "source_path", "default_value" => "", "is_null_allowed" => false, "depends_on" => array()))); ["allowed_values" => new ValueSetEnum('Oracle, MySQL, Postgress, MSSQL, SOAP, HTTP-Get, HTTP-Post, XML/RPC, CSV, XML, Excel'), "sql" => "source_subtype", "default_value" => "CSV", "is_null_allowed" => false, "depends_on" => []]
MetaModel::Init_AddAttribute(new AttributeClass("objects_class", array("class_category" => "", "more_values" => "", "sql" => "objects_class", "default_value" => null, "is_null_allowed" => true, "depends_on" => array(), "class_exclusion_list" => null))); ));
MetaModel::Init_AddAttribute(new AttributeEnum("test_mode", array("allowed_values" => new ValueSetEnum('Yes,No'), "sql" => "test_mode", "default_value" => 'No', "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("source_path", ["allowed_values" => null, "sql" => "source_path", "default_value" => "", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("verbose_mode", array("allowed_values" => new ValueSetEnum('Yes,No'), "sql" => "verbose_mode", "default_value" => 'No', "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeClass("objects_class", ["class_category" => "", "more_values" => "", "sql" => "objects_class", "default_value" => null, "is_null_allowed" => true, "depends_on" => [], "class_exclusion_list" => null]));
MetaModel::Init_AddAttribute(new AttributeEnum("options", array("allowed_values" => new ValueSetEnum('Full, Update Only, Creation Only'), "sql" => "options", "default_value" => 'Full', "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeEnum("test_mode", ["allowed_values" => new ValueSetEnum('Yes,No'), "sql" => "test_mode", "default_value" => 'No', "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("verbose_mode", ["allowed_values" => new ValueSetEnum('Yes,No'), "sql" => "verbose_mode", "default_value" => 'No', "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("options", ["allowed_values" => new ValueSetEnum('Full, Update Only, Creation Only'), "sql" => "options", "default_value" => 'Full', "is_null_allowed" => true, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype', 'source_path', 'options', 'test_mode', 'verbose_mode')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype', 'source_path', 'options', 'test_mode', 'verbose_mode']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('description', 'category', 'objects_class', 'source_type', 'source_subtype', 'options')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['description', 'category', 'objects_class', 'source_type', 'source_subtype', 'options']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('name', 'category', 'objects_class', 'source_type', 'source_subtype')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['name', 'category', 'objects_class', 'source_type', 'source_subtype']); // Criteria of the std search form
MetaModel::Init_SetZListItems('advanced_search', array('name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype')); // Criteria of the advanced search form MetaModel::Init_SetZListItems('advanced_search', ['name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype']); // Criteria of the advanced search form
} }
} }
?>

View File

@@ -18,23 +18,17 @@ class LoginBasic extends AbstractLoginFSMExtension
*/ */
public function ListSupportedLoginModes() public function ListSupportedLoginModes()
{ {
return array('basic'); return ['basic'];
} }
protected function OnModeDetection(&$iErrorCode) protected function OnModeDetection(&$iErrorCode)
{ {
if (!Session::IsSet('login_mode')) if (!Session::IsSet('login_mode')) {
{ if (isset($_SERVER['HTTP_AUTHORIZATION']) && !empty($_SERVER['HTTP_AUTHORIZATION'])) {
if (isset($_SERVER['HTTP_AUTHORIZATION']) && !empty($_SERVER['HTTP_AUTHORIZATION']))
{
Session::Set('login_mode', 'basic'); Session::Set('login_mode', 'basic');
} } elseif (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION'])) {
elseif (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']))
{
Session::Set('login_mode', 'basic'); Session::Set('login_mode', 'basic');
} } elseif (isset($_SERVER['PHP_AUTH_USER'])) {
elseif (isset($_SERVER['PHP_AUTH_USER']))
{
Session::Set('login_mode', 'basic'); Session::Set('login_mode', 'basic');
} }
} }
@@ -43,22 +37,18 @@ class LoginBasic extends AbstractLoginFSMExtension
protected function OnReadCredentials(&$iErrorCode) protected function OnReadCredentials(&$iErrorCode)
{ {
if (!Session::IsSet('login_mode') || Session::Get('login_mode') == 'basic') if (!Session::IsSet('login_mode') || Session::Get('login_mode') == 'basic') {
{
list($sAuthUser) = $this->GetAuthUserAndPassword(); list($sAuthUser) = $this->GetAuthUserAndPassword();
Session::Set('login_temp_auth_user', $sAuthUser); Session::Set('login_temp_auth_user', $sAuthUser);
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
} }
protected function OnCheckCredentials(&$iErrorCode) protected function OnCheckCredentials(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'basic') if (Session::Get('login_mode') == 'basic') {
{
list($sAuthUser, $sAuthPwd) = $this->GetAuthUserAndPassword(); list($sAuthUser, $sAuthPwd) = $this->GetAuthUserAndPassword();
if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, Session::Get('login_mode'), 'internal')) if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, Session::Get('login_mode'), 'internal')) {
{
$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS; $iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
return LoginWebPage::LOGIN_FSM_ERROR; return LoginWebPage::LOGIN_FSM_ERROR;
} }
@@ -69,8 +59,7 @@ class LoginBasic extends AbstractLoginFSMExtension
protected function OnCredentialsOK(&$iErrorCode) protected function OnCredentialsOK(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'basic') if (Session::Get('login_mode') == 'basic') {
{
LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'internal', Session::Get('login_mode')); LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'internal', Session::Get('login_mode'));
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -78,11 +67,9 @@ class LoginBasic extends AbstractLoginFSMExtension
protected function OnError(&$iErrorCode) protected function OnError(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'basic') if (Session::Get('login_mode') == 'basic') {
{
$iOnExit = LoginWebPage::getIOnExit(); $iOnExit = LoginWebPage::getIOnExit();
if ($iOnExit === LoginWebPage::EXIT_RETURN) if ($iOnExit === LoginWebPage::EXIT_RETURN) {
{
return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM
} }
LoginWebPage::HTTP401Error(); LoginWebPage::HTTP401Error();
@@ -92,8 +79,7 @@ class LoginBasic extends AbstractLoginFSMExtension
protected function OnConnected(&$iErrorCode) protected function OnConnected(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'basic') if (Session::Get('login_mode') == 'basic') {
{
Session::Set('can_logoff', true); Session::Set('can_logoff', true);
return LoginWebPage::CheckLoggedUser($iErrorCode); return LoginWebPage::CheckLoggedUser($iErrorCode);
} }
@@ -105,42 +91,33 @@ class LoginBasic extends AbstractLoginFSMExtension
$sAuthUser = ''; $sAuthUser = '';
$sAuthPwd = null; $sAuthPwd = null;
$sAuthorization = ''; $sAuthorization = '';
if (isset($_SERVER['HTTP_AUTHORIZATION']) && !empty($_SERVER['HTTP_AUTHORIZATION'])) if (isset($_SERVER['HTTP_AUTHORIZATION']) && !empty($_SERVER['HTTP_AUTHORIZATION'])) {
{
$sAuthorization = $_SERVER['HTTP_AUTHORIZATION']; $sAuthorization = $_SERVER['HTTP_AUTHORIZATION'];
} } elseif (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION'])) {
elseif (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']))
{
$sAuthorization = $_SERVER['REDIRECT_HTTP_AUTHORIZATION']; $sAuthorization = $_SERVER['REDIRECT_HTTP_AUTHORIZATION'];
} }
if (!empty($sAuthorization)) if (!empty($sAuthorization)) {
{
list($sAuthUser, $sAuthPwd) = explode(':', base64_decode(substr($sAuthorization, 6))); list($sAuthUser, $sAuthPwd) = explode(':', base64_decode(substr($sAuthorization, 6)));
} } else {
else if (isset($_SERVER['PHP_AUTH_USER'])) {
{
if (isset($_SERVER['PHP_AUTH_USER']))
{
$sAuthUser = $_SERVER['PHP_AUTH_USER']; $sAuthUser = $_SERVER['PHP_AUTH_USER'];
// Unfortunately, the RFC is not clear about the encoding... // Unfortunately, the RFC is not clear about the encoding...
// IE and FF supply the user and password encoded in ISO-8859-1 whereas Chrome provides them encoded in UTF-8 // IE and FF supply the user and password encoded in ISO-8859-1 whereas Chrome provides them encoded in UTF-8
// So let's try to guess if it's an UTF-8 string or not... fortunately all encodings share the same ASCII base // So let's try to guess if it's an UTF-8 string or not... fortunately all encodings share the same ASCII base
if (!LoginWebPage::LooksLikeUTF8($sAuthUser)) if (!LoginWebPage::LooksLikeUTF8($sAuthUser)) {
{
// Does not look like and UTF-8 string, try to convert it from iso-8859-1 to UTF-8 // Does not look like and UTF-8 string, try to convert it from iso-8859-1 to UTF-8
// Supposed to be harmless in case of a plain ASCII string... // Supposed to be harmless in case of a plain ASCII string...
$sAuthUser = iconv('iso-8859-1', 'utf-8', $sAuthUser); $sAuthUser = iconv('iso-8859-1', 'utf-8', $sAuthUser);
} }
$sAuthPwd = $_SERVER['PHP_AUTH_PW']; $sAuthPwd = $_SERVER['PHP_AUTH_PW'];
if (!LoginWebPage::LooksLikeUTF8($sAuthPwd)) if (!LoginWebPage::LooksLikeUTF8($sAuthPwd)) {
{
// Does not look like and UTF-8 string, try to convert it from iso-8859-1 to UTF-8 // Does not look like and UTF-8 string, try to convert it from iso-8859-1 to UTF-8
// Supposed to be harmless in case of a plain ASCII string... // Supposed to be harmless in case of a plain ASCII string...
$sAuthPwd = iconv('iso-8859-1', 'utf-8', $sAuthPwd); $sAuthPwd = iconv('iso-8859-1', 'utf-8', $sAuthPwd);
} }
} }
} }
return array($sAuthUser, $sAuthPwd); return [$sAuthUser, $sAuthPwd];
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -18,7 +19,7 @@ class LoginDefaultBefore extends AbstractLoginFSMExtension
*/ */
public function ListSupportedLoginModes() public function ListSupportedLoginModes()
{ {
return array('before'); return ['before'];
} }
protected function OnStart(&$iErrorCode) protected function OnStart(&$iErrorCode)
@@ -31,13 +32,10 @@ class LoginDefaultBefore extends AbstractLoginFSMExtension
$aAllowedLoginTypes = MetaModel::GetConfig()->GetAllowedLoginTypes(); $aAllowedLoginTypes = MetaModel::GetConfig()->GetAllowedLoginTypes();
$sProposedLoginMode = utils::ReadParam('login_mode', ''); $sProposedLoginMode = utils::ReadParam('login_mode', '');
$index = array_search($sProposedLoginMode, $aAllowedLoginTypes); $index = array_search($sProposedLoginMode, $aAllowedLoginTypes);
if ($index !== false) if ($index !== false) {
{
// Force login mode // Force login mode
Session::Set('login_mode', $sProposedLoginMode); Session::Set('login_mode', $sProposedLoginMode);
} } else {
else
{
Session::Unset('login_mode'); Session::Unset('login_mode');
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -49,8 +47,7 @@ class LoginDefaultBefore extends AbstractLoginFSMExtension
$aAllowedLoginTypes = MetaModel::GetConfig()->GetAllowedLoginTypes(); $aAllowedLoginTypes = MetaModel::GetConfig()->GetAllowedLoginTypes();
$sProposedLoginMode = utils::ReadParam('login_mode', ''); $sProposedLoginMode = utils::ReadParam('login_mode', '');
$index = array_search($sProposedLoginMode, $aAllowedLoginTypes); $index = array_search($sProposedLoginMode, $aAllowedLoginTypes);
if ($index !== false) if ($index !== false) {
{
// Force login mode // Force login mode
LoginWebPage::SetLoginModeAndReload($sProposedLoginMode); LoginWebPage::SetLoginModeAndReload($sProposedLoginMode);
} else { } else {
@@ -69,8 +66,6 @@ class LoginDefaultBefore extends AbstractLoginFSMExtension
*/ */
class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExtension class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExtension
{ {
/** /**
* Must be executed after the other login plugins * Must be executed after the other login plugins
* *
@@ -78,19 +73,16 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
*/ */
public function ListSupportedLoginModes() public function ListSupportedLoginModes()
{ {
return array('after'); return ['after'];
} }
protected function OnError(&$iErrorCode) protected function OnError(&$iErrorCode)
{ {
self::ResetLoginSession(); self::ResetLoginSession();
$iOnExit = LoginWebPage::getIOnExit(); $iOnExit = LoginWebPage::getIOnExit();
if ($iOnExit === LoginWebPage::EXIT_RETURN) if ($iOnExit === LoginWebPage::EXIT_RETURN) {
{
return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM
} } elseif ($iOnExit == LoginWebPage::EXIT_HTTP_401) {
elseif ($iOnExit == LoginWebPage::EXIT_HTTP_401)
{
LoginWebPage::HTTP401Error(); // Error, exit LoginWebPage::HTTP401Error(); // Error, exit
} }
// LoginWebPage::EXIT_PROMPT // LoginWebPage::EXIT_PROMPT
@@ -99,8 +91,7 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
protected function OnCredentialsOk(&$iErrorCode) protected function OnCredentialsOk(&$iErrorCode)
{ {
if (!Session::IsSet('login_mode')) if (!Session::IsSet('login_mode')) {
{
// N°6358 - if EXIT_RETURN was asked, send an error // N°6358 - if EXIT_RETURN was asked, send an error
if (LoginWebPage::getIOnExit() === LoginWebPage::EXIT_RETURN) { if (LoginWebPage::getIOnExit() === LoginWebPage::EXIT_RETURN) {
$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS; $iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
@@ -137,10 +128,8 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
private static function ResetLoginSession() private static function ResetLoginSession()
{ {
LoginWebPage::ResetSession(); LoginWebPage::ResetSession();
foreach (Session::ListVariables() as $sKey) foreach (Session::ListVariables() as $sKey) {
{ if (utils::StartsWith($sKey, 'login_')) {
if (utils::StartsWith($sKey, 'login_'))
{
Session::Unset($sKey); Session::Unset($sKey);
} }
} }

View File

@@ -11,7 +11,6 @@ use Combodo\iTop\Application\Helper\Session;
class LoginExternal extends AbstractLoginFSMExtension class LoginExternal extends AbstractLoginFSMExtension
{ {
/** /**
* Return the list of supported login modes for this plugin * Return the list of supported login modes for this plugin
* *
@@ -19,16 +18,14 @@ class LoginExternal extends AbstractLoginFSMExtension
*/ */
public function ListSupportedLoginModes() public function ListSupportedLoginModes()
{ {
return array('external'); return ['external'];
} }
protected function OnModeDetection(&$iErrorCode) protected function OnModeDetection(&$iErrorCode)
{ {
if (!Session::IsSet('login_mode')) if (!Session::IsSet('login_mode')) {
{
$sAuthUser = $this->GetAuthUser(); $sAuthUser = $this->GetAuthUser();
if ($sAuthUser && (strlen($sAuthUser) > 0)) if ($sAuthUser && (strlen($sAuthUser) > 0)) {
{
Session::Set('login_mode', 'external'); Session::Set('login_mode', 'external');
} }
} }
@@ -37,11 +34,9 @@ class LoginExternal extends AbstractLoginFSMExtension
protected function OnCheckCredentials(&$iErrorCode) protected function OnCheckCredentials(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'external') if (Session::Get('login_mode') == 'external') {
{
$sAuthUser = $this->GetAuthUser(); $sAuthUser = $this->GetAuthUser();
if (!UserRights::CheckCredentials($sAuthUser, '', Session::Get('login_mode'), 'external')) if (!UserRights::CheckCredentials($sAuthUser, '', Session::Get('login_mode'), 'external')) {
{
$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS; $iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
return LoginWebPage::LOGIN_FSM_ERROR; return LoginWebPage::LOGIN_FSM_ERROR;
} }
@@ -52,8 +47,7 @@ class LoginExternal extends AbstractLoginFSMExtension
protected function OnCredentialsOK(&$iErrorCode) protected function OnCredentialsOK(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'external') if (Session::Get('login_mode') == 'external') {
{
LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'external', Session::Get('login_mode')); LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'external', Session::Get('login_mode'));
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -61,8 +55,7 @@ class LoginExternal extends AbstractLoginFSMExtension
protected function OnConnected(&$iErrorCode) protected function OnConnected(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'external') if (Session::Get('login_mode') == 'external') {
{
Session::Set('can_logoff', false); Session::Set('can_logoff', false);
return LoginWebPage::CheckLoggedUser($iErrorCode); return LoginWebPage::CheckLoggedUser($iErrorCode);
} }
@@ -71,11 +64,9 @@ class LoginExternal extends AbstractLoginFSMExtension
protected function OnError(&$iErrorCode) protected function OnError(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'external') if (Session::Get('login_mode') == 'external') {
{
$iOnExit = LoginWebPage::getIOnExit(); $iOnExit = LoginWebPage::getIOnExit();
if ($iOnExit === LoginWebPage::EXIT_RETURN) if ($iOnExit === LoginWebPage::EXIT_RETURN) {
{
return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM
} }
LoginWebPage::HTTP401Error(); LoginWebPage::HTTP401Error();

View File

@@ -23,7 +23,7 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
*/ */
public function ListSupportedLoginModes() public function ListSupportedLoginModes()
{ {
return array('form'); return ['form'];
} }
/** /**
@@ -34,10 +34,8 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
if (!Session::IsSet('login_mode') || Session::Get('login_mode') == 'form') { if (!Session::IsSet('login_mode') || Session::Get('login_mode') == 'form') {
$sAuthUser = utils::ReadPostedParam('auth_user', '', 'raw_data'); $sAuthUser = utils::ReadPostedParam('auth_user', '', 'raw_data');
$sAuthPwd = utils::ReadPostedParam('auth_pwd', null, 'raw_data'); $sAuthPwd = utils::ReadPostedParam('auth_pwd', null, 'raw_data');
if ($this->bForceFormOnError || empty($sAuthUser) || empty($sAuthPwd)) if ($this->bForceFormOnError || empty($sAuthUser) || empty($sAuthPwd)) {
{ if (array_key_exists('HTTP_X_COMBODO_AJAX', $_SERVER)) {
if (array_key_exists('HTTP_X_COMBODO_AJAX', $_SERVER))
{
// X-Combodo-Ajax is a special header automatically added to all ajax requests // X-Combodo-Ajax is a special header automatically added to all ajax requests
// Let's reply that we're currently logged-out // Let's reply that we're currently logged-out
header('HTTP/1.0 401 Unauthorized'); header('HTTP/1.0 401 Unauthorized');
@@ -66,12 +64,10 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
*/ */
protected function OnCheckCredentials(&$iErrorCode) protected function OnCheckCredentials(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'form') if (Session::Get('login_mode') == 'form') {
{
$sAuthUser = utils::ReadPostedParam('auth_user', '', 'raw_data'); $sAuthUser = utils::ReadPostedParam('auth_user', '', 'raw_data');
$sAuthPwd = utils::ReadPostedParam('auth_pwd', null, 'raw_data'); $sAuthPwd = utils::ReadPostedParam('auth_pwd', null, 'raw_data');
if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, Session::Get('login_mode'), 'internal')) if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, Session::Get('login_mode'), 'internal')) {
{
$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS; $iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
return LoginWebPage::LOGIN_FSM_ERROR; return LoginWebPage::LOGIN_FSM_ERROR;
} }
@@ -85,8 +81,7 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
*/ */
protected function OnCredentialsOK(&$iErrorCode) protected function OnCredentialsOK(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'form') if (Session::Get('login_mode') == 'form') {
{
// Store 'auth_user' in session for further use // Store 'auth_user' in session for further use
LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'internal', Session::Get('login_mode')); LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'internal', Session::Get('login_mode'));
} }
@@ -98,8 +93,7 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
*/ */
protected function OnError(&$iErrorCode) protected function OnError(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'form') if (Session::Get('login_mode') == 'form') {
{
$this->bForceFormOnError = true; $this->bForceFormOnError = true;
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -110,8 +104,7 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
*/ */
protected function OnConnected(&$iErrorCode) protected function OnConnected(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'form') if (Session::Get('login_mode') == 'form') {
{
Session::Set('can_logoff', true); Session::Set('can_logoff', true);
return LoginWebPage::CheckLoggedUser($iErrorCode); return LoginWebPage::CheckLoggedUser($iErrorCode);
} }
@@ -131,24 +124,23 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
$sAuthUser = utils::ReadParam('auth_user', '', true, 'raw_data'); $sAuthUser = utils::ReadParam('auth_user', '', true, 'raw_data');
$sAuthPwd = utils::ReadParam('suggest_pwd', '', true, 'raw_data'); $sAuthPwd = utils::ReadParam('suggest_pwd', '', true, 'raw_data');
$aData = array( $aData = [
'sAuthUser' => $sAuthUser, 'sAuthUser' => $sAuthUser,
'sAuthPwd' => $sAuthPwd, 'sAuthPwd' => $sAuthPwd,
); ];
$oLoginContext->AddBlockExtension('login_input', new LoginBlockExtension('extensionblock/loginforminput.html.twig', $aData)); $oLoginContext->AddBlockExtension('login_input', new LoginBlockExtension('extensionblock/loginforminput.html.twig', $aData));
$oLoginContext->AddBlockExtension('login_submit', new LoginBlockExtension('extensionblock/loginformsubmit.html.twig')); $oLoginContext->AddBlockExtension('login_submit', new LoginBlockExtension('extensionblock/loginformsubmit.html.twig'));
$oLoginContext->AddBlockExtension('login_form_footer', new LoginBlockExtension('extensionblock/loginformfooter.html.twig')); $oLoginContext->AddBlockExtension('login_form_footer', new LoginBlockExtension('extensionblock/loginformfooter.html.twig'));
$bEnableResetPassword = MetaModel::GetConfig()->Get('forgot_password'); $bEnableResetPassword = MetaModel::GetConfig()->Get('forgot_password');
$sResetPasswordUrl = MetaModel::GetConfig()->Get('forgot_password.url'); $sResetPasswordUrl = MetaModel::GetConfig()->Get('forgot_password.url');
if ($sResetPasswordUrl == '') if ($sResetPasswordUrl == '') {
{
$sResetPasswordUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?loginop=forgot_pwd'; $sResetPasswordUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?loginop=forgot_pwd';
} }
$aData = array( $aData = [
'bEnableResetPassword' => $bEnableResetPassword, 'bEnableResetPassword' => $bEnableResetPassword,
'sResetPasswordUrl' => $sResetPasswordUrl, 'sResetPasswordUrl' => $sResetPasswordUrl,
); ];
$oLoginContext->AddBlockExtension('login_links', new LoginBlockExtension('extensionblock/loginformlinks.html.twig', $aData)); $oLoginContext->AddBlockExtension('login_links', new LoginBlockExtension('extensionblock/loginformlinks.html.twig', $aData));
return $oLoginContext; return $oLoginContext;

View File

@@ -6,7 +6,6 @@
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
*/ */
use Combodo\iTop\Application\Branding; use Combodo\iTop\Application\Branding;
use Combodo\iTop\Application\TwigBase\Twig\Extension; use Combodo\iTop\Application\TwigBase\Twig\Extension;
use Combodo\iTop\Application\WebPage\NiceWebPage; use Combodo\iTop\Application\WebPage\NiceWebPage;
@@ -41,11 +40,11 @@ class LoginTwigContext
*/ */
public function __construct() public function __construct()
{ {
$this->aBlockExtension = array(); $this->aBlockExtension = [];
$this->aPostedVars = array(); $this->aPostedVars = [];
$this->sTwigLoaderPath = null; $this->sTwigLoaderPath = null;
$this->aCSSFiles = array(); $this->aCSSFiles = [];
$this->aJsFiles = array(); $this->aJsFiles = [];
$this->sTwigNameSpace = null; $this->sTwigNameSpace = null;
} }
@@ -179,7 +178,7 @@ class LoginBlockExtension
* @param array $aData Data given to the twig template (into the variable {{ aData }}) * @param array $aData Data given to the twig template (into the variable {{ aData }})
* @api * @api
*/ */
public function __construct($sTwig, $aData = array()) public function __construct($sTwig, $aData = [])
{ {
$this->sTwig = $sTwig; $this->sTwig = $sTwig;
$this->aData = $aData; $this->aData = $aData;
@@ -210,21 +209,18 @@ class LoginTwigRenderer
public function __construct() public function __construct()
{ {
$this->aLoginPluginList = LoginWebPage::GetLoginPluginList('iLoginUIExtension', false); $this->aLoginPluginList = LoginWebPage::GetLoginPluginList('iLoginUIExtension', false);
$this->aPluginFormData = array(); $this->aPluginFormData = [];
$aTwigLoaders = array(); $aTwigLoaders = [];
$this->aPostedVars = array(); $this->aPostedVars = [];
foreach ($this->aLoginPluginList as $oLoginPlugin) foreach ($this->aLoginPluginList as $oLoginPlugin) {
{
/** @var \iLoginUIExtension $oLoginPlugin */ /** @var \iLoginUIExtension $oLoginPlugin */
$oLoginContext = $oLoginPlugin->GetTwigContext(); $oLoginContext = $oLoginPlugin->GetTwigContext();
if (is_null($oLoginContext)) if (is_null($oLoginContext)) {
{
continue; continue;
} }
$this->aPluginFormData[] = $oLoginContext; $this->aPluginFormData[] = $oLoginContext;
$sTwigLoaderPath = $oLoginContext->GetTwigLoaderPath(); $sTwigLoaderPath = $oLoginContext->GetTwigLoaderPath();
if ($sTwigLoaderPath != null) if ($sTwigLoaderPath != null) {
{
$oExtensionLoader = new FilesystemLoader(); $oExtensionLoader = new FilesystemLoader();
$oExtensionLoader->setPaths($sTwigLoaderPath); $oExtensionLoader->setPaths($sTwigLoaderPath);
$aTwigLoaders[] = $oExtensionLoader; $aTwigLoaders[] = $oExtensionLoader;
@@ -232,8 +228,8 @@ class LoginTwigRenderer
$this->aPostedVars = array_merge($this->aPostedVars, $oLoginContext->GetPostedVars()); $this->aPostedVars = array_merge($this->aPostedVars, $oLoginContext->GetPostedVars());
} }
$oCoreLoader = new FilesystemLoader(array(), APPROOT.'templates'); $oCoreLoader = new FilesystemLoader([], APPROOT.'templates');
$aCoreTemplatesPaths = array('pages/login', 'pages/login/password'); $aCoreTemplatesPaths = ['pages/login', 'pages/login/password'];
// Having this path declared after the plugins let the plugins replace the core templates // Having this path declared after the plugins let the plugins replace the core templates
$oCoreLoader->setPaths($aCoreTemplatesPaths); $oCoreLoader->setPaths($aCoreTemplatesPaths);
// Having the core templates accessible within a different namespace offer the possibility to extend them while replacing them // Having the core templates accessible within a different namespace offer the possibility to extend them while replacing them
@@ -251,19 +247,19 @@ class LoginTwigRenderer
$sIconUrl = Utils::GetConfig()->Get('app_icon_url'); $sIconUrl = Utils::GetConfig()->Get('app_icon_url');
$sDisplayIcon = Branding::GetLoginLogoAbsoluteUrl(); $sDisplayIcon = Branding::GetLoginLogoAbsoluteUrl();
$aVars = array( $aVars = [
'sAppRootUrl' => utils::GetAbsoluteUrlAppRoot(), 'sAppRootUrl' => utils::GetAbsoluteUrlAppRoot(),
'aPluginFormData' => $this->GetPluginFormData(), 'aPluginFormData' => $this->GetPluginFormData(),
'sItopVersion' => ITOP_VERSION, 'sItopVersion' => ITOP_VERSION,
'sVersionShort' => $sVersionShort, 'sVersionShort' => $sVersionShort,
'sIconUrl' => $sIconUrl, 'sIconUrl' => $sIconUrl,
'sDisplayIcon' => $sDisplayIcon, 'sDisplayIcon' => $sDisplayIcon,
); ];
return $aVars; return $aVars;
} }
public function Render(NiceWebPage $oPage, $sTwigFile, $aVars = array()) public function Render(NiceWebPage $oPage, $sTwigFile, $aVars = [])
{ {
$oTemplate = $this->GetTwig()->load($sTwigFile); $oTemplate = $this->GetTwig()->load($sTwigFile);
$oPage->add($oTemplate->renderBlock('body', $aVars)); $oPage->add($oTemplate->renderBlock('body', $aVars));
@@ -272,17 +268,14 @@ class LoginTwigRenderer
$oPage->add_style($oTemplate->renderBlock('css', $aVars)); $oPage->add_style($oTemplate->renderBlock('css', $aVars));
// Render CSS links // Render CSS links
foreach ($this->aPluginFormData as $oFormData) foreach ($this->aPluginFormData as $oFormData) {
{
/** @var \LoginTwigContext $oFormData */ /** @var \LoginTwigContext $oFormData */
$aCSSFiles = $oFormData->GetCSSFiles(); $aCSSFiles = $oFormData->GetCSSFiles();
foreach ($aCSSFiles as $sCSSFile) foreach ($aCSSFiles as $sCSSFile) {
{
$oPage->LinkStylesheetFromURI($sCSSFile); $oPage->LinkStylesheetFromURI($sCSSFile);
} }
$aJsFiles = $oFormData->GetJsFiles(); $aJsFiles = $oFormData->GetJsFiles();
foreach ($aJsFiles as $sJsFile) foreach ($aJsFiles as $sJsFile) {
{
$oPage->LinkScriptFromURI($sJsFile); $oPage->LinkScriptFromURI($sJsFile);
} }

View File

@@ -23,17 +23,15 @@ class LoginURL extends AbstractLoginFSMExtension
*/ */
public function ListSupportedLoginModes() public function ListSupportedLoginModes()
{ {
return array('url'); return ['url'];
} }
protected function OnModeDetection(&$iErrorCode) protected function OnModeDetection(&$iErrorCode)
{ {
if (!Session::IsSet('login_mode') && !$this->bErrorOccurred) if (!Session::IsSet('login_mode') && !$this->bErrorOccurred) {
{
$sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data'); $sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data');
$sAuthPwd = utils::ReadParam('auth_pwd', null, false, 'raw_data'); $sAuthPwd = utils::ReadParam('auth_pwd', null, false, 'raw_data');
if (!empty($sAuthUser) && !empty($sAuthPwd)) if (!empty($sAuthUser) && !empty($sAuthPwd)) {
{
Session::Set('login_mode', 'url'); Session::Set('login_mode', 'url');
} }
} }
@@ -42,8 +40,7 @@ class LoginURL extends AbstractLoginFSMExtension
protected function OnReadCredentials(&$iErrorCode) protected function OnReadCredentials(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'url') if (Session::Get('login_mode') == 'url') {
{
Session::Set('login_temp_auth_user', utils::ReadParam('auth_user', '', false, 'raw_data')); Session::Set('login_temp_auth_user', utils::ReadParam('auth_user', '', false, 'raw_data'));
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -51,12 +48,10 @@ class LoginURL extends AbstractLoginFSMExtension
protected function OnCheckCredentials(&$iErrorCode) protected function OnCheckCredentials(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'url') if (Session::Get('login_mode') == 'url') {
{
$sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data'); $sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data');
$sAuthPwd = utils::ReadParam('auth_pwd', null, false, 'raw_data'); $sAuthPwd = utils::ReadParam('auth_pwd', null, false, 'raw_data');
if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, Session::Get('login_mode'), 'internal')) if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, Session::Get('login_mode'), 'internal')) {
{
$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS; $iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
return LoginWebPage::LOGIN_FSM_ERROR; return LoginWebPage::LOGIN_FSM_ERROR;
} }
@@ -67,8 +62,7 @@ class LoginURL extends AbstractLoginFSMExtension
protected function OnCredentialsOK(&$iErrorCode) protected function OnCredentialsOK(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'url') if (Session::Get('login_mode') == 'url') {
{
LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'internal', Session::Get('login_mode')); LoginWebPage::OnLoginSuccess(Session::Get('auth_user'), 'internal', Session::Get('login_mode'));
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -76,8 +70,7 @@ class LoginURL extends AbstractLoginFSMExtension
protected function OnError(&$iErrorCode) protected function OnError(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'url') if (Session::Get('login_mode') == 'url') {
{
$this->bErrorOccurred = true; $this->bErrorOccurred = true;
} }
return LoginWebPage::LOGIN_FSM_CONTINUE; return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -85,8 +78,7 @@ class LoginURL extends AbstractLoginFSMExtension
protected function OnConnected(&$iErrorCode) protected function OnConnected(&$iErrorCode)
{ {
if (Session::Get('login_mode') == 'url') if (Session::Get('login_mode') == 'url') {
{
Session::Set('can_logoff', true); Session::Set('can_logoff', true);
return LoginWebPage::CheckLoggedUser($iErrorCode); return LoginWebPage::CheckLoggedUser($iErrorCode);
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* Class LoginWebPage * Class LoginWebPage
* *
@@ -37,33 +37,33 @@ use Combodo\iTop\Service\Events\EventService;
class LoginWebPage extends NiceWebPage class LoginWebPage extends NiceWebPage
{ {
const EXIT_PROMPT = 0; public const EXIT_PROMPT = 0;
const EXIT_HTTP_401 = 1; public const EXIT_HTTP_401 = 1;
const EXIT_RETURN = 2; public const EXIT_RETURN = 2;
const EXIT_CODE_OK = 0; public const EXIT_CODE_OK = 0;
const EXIT_CODE_MISSINGLOGIN = 1; public const EXIT_CODE_MISSINGLOGIN = 1;
const EXIT_CODE_MISSINGPASSWORD = 2; public const EXIT_CODE_MISSINGPASSWORD = 2;
const EXIT_CODE_WRONGCREDENTIALS = 3; public const EXIT_CODE_WRONGCREDENTIALS = 3;
const EXIT_CODE_MUSTBEADMIN = 4; public const EXIT_CODE_MUSTBEADMIN = 4;
const EXIT_CODE_PORTALUSERNOTAUTHORIZED = 5; public const EXIT_CODE_PORTALUSERNOTAUTHORIZED = 5;
const EXIT_CODE_NOTAUTHORIZED = 6; public const EXIT_CODE_NOTAUTHORIZED = 6;
// Login FSM States // Login FSM States
const LOGIN_STATE_START = 'start'; // Entry state public const LOGIN_STATE_START = 'start'; // Entry state
const LOGIN_STATE_MODE_DETECTION = 'login mode detection'; // Detect which login plugin to use public const LOGIN_STATE_MODE_DETECTION = 'login mode detection'; // Detect which login plugin to use
const LOGIN_STATE_READ_CREDENTIALS = 'read credentials'; // Read the credentials public const LOGIN_STATE_READ_CREDENTIALS = 'read credentials'; // Read the credentials
const LOGIN_STATE_CHECK_CREDENTIALS = 'check credentials'; // Check if the credentials are valid public const LOGIN_STATE_CHECK_CREDENTIALS = 'check credentials'; // Check if the credentials are valid
const LOGIN_STATE_CREDENTIALS_OK = 'credentials ok'; // User provisioning public const LOGIN_STATE_CREDENTIALS_OK = 'credentials ok'; // User provisioning
const LOGIN_STATE_USER_OK = 'user ok'; // Additional check (2FA) public const LOGIN_STATE_USER_OK = 'user ok'; // Additional check (2FA)
const LOGIN_STATE_CONNECTED = 'connected'; // User connected public const LOGIN_STATE_CONNECTED = 'connected'; // User connected
const LOGIN_STATE_SET_ERROR = 'prepare for error'; // Internal state to trigger ERROR state public const LOGIN_STATE_SET_ERROR = 'prepare for error'; // Internal state to trigger ERROR state
const LOGIN_STATE_ERROR = 'error'; // An error occurred, next state will be NONE public const LOGIN_STATE_ERROR = 'error'; // An error occurred, next state will be NONE
// Login FSM Returns // Login FSM Returns
const LOGIN_FSM_RETURN = 0; // End the FSM OK (connected) public const LOGIN_FSM_RETURN = 0; // End the FSM OK (connected)
const LOGIN_FSM_ERROR = 1; // Error signaled public const LOGIN_FSM_ERROR = 1; // Error signaled
const LOGIN_FSM_CONTINUE = 2; // Continue FSM public const LOGIN_FSM_CONTINUE = 2; // Continue FSM
protected static $sHandlerClass = __class__; protected static $sHandlerClass = __class__;
private static $iOnExit; private static $iOnExit;
@@ -78,7 +78,7 @@ class LoginWebPage extends NiceWebPage
*/ */
public static function NewLoginWebPage() public static function NewLoginWebPage()
{ {
return new self::$sHandlerClass; return new self::$sHandlerClass();
} }
protected static $m_sLoginFailedMessage = ''; protected static $m_sLoginFailedMessage = '';
@@ -128,23 +128,18 @@ class LoginWebPage extends NiceWebPage
$oProfilesSet = $oUser->Get('profile_list'); $oProfilesSet = $oUser->Get('profile_list');
//delete old profiles //delete old profiles
$aExistingProfiles = []; $aExistingProfiles = [];
while ($oProfile = $oProfilesSet->Fetch()) while ($oProfile = $oProfilesSet->Fetch()) {
{
array_push($aExistingProfiles, $oProfile->Get('profileid')); array_push($aExistingProfiles, $oProfile->Get('profileid'));
$iArrayKey = array_search($oProfile->Get('profileid'), $aProfiles); $iArrayKey = array_search($oProfile->Get('profileid'), $aProfiles);
if (!$iArrayKey) if (!$iArrayKey) {
{
$oProfilesSet->RemoveItem($oProfile->Get('profileid')); $oProfilesSet->RemoveItem($oProfile->Get('profileid'));
} } else {
else
{
unset($aProfiles[$iArrayKey]); unset($aProfiles[$iArrayKey]);
} }
} }
//add profiles not already linked with user //add profiles not already linked with user
foreach ($aProfiles as $iProfileId) foreach ($aProfiles as $iProfileId) {
{ $oProfilesSet->AddItem(MetaModel::NewObject('URP_UserProfile', ['profileid' => $iProfileId, 'reason' => $sOrigin]));
$oProfilesSet->AddItem(MetaModel::NewObject('URP_UserProfile', array('profileid' => $iProfileId, 'reason' => $sOrigin)));
} }
$oUser->Set('profile_list', $oProfilesSet); $oUser->Set('profile_list', $oProfilesSet);
} }
@@ -154,56 +149,49 @@ class LoginWebPage extends NiceWebPage
$sVersionShort = Dict::Format('UI:iTopVersion:Short', ITOP_APPLICATION, ITOP_VERSION); $sVersionShort = Dict::Format('UI:iTopVersion:Short', ITOP_APPLICATION, ITOP_VERSION);
$sIconUrl = Utils::GetConfig()->Get('app_icon_url'); $sIconUrl = Utils::GetConfig()->Get('app_icon_url');
$sDisplayIcon = Branding::GetLoginLogoAbsoluteUrl(); $sDisplayIcon = Branding::GetLoginLogoAbsoluteUrl();
$this->add("<div id=\"login-logo\"><a href=\"".htmlentities($sIconUrl, ENT_QUOTES, $this->add("<div id=\"login-logo\"><a href=\"".htmlentities(
self::PAGES_CHARSET)."\"><img title=\"$sVersionShort\" src=\"$sDisplayIcon\"></a></div>\n"); $sIconUrl,
ENT_QUOTES,
self::PAGES_CHARSET
)."\"><img title=\"$sVersionShort\" src=\"$sDisplayIcon\"></a></div>\n");
} }
public function DisplayLoginForm($bFailedLogin = false) public function DisplayLoginForm($bFailedLogin = false)
{ {
$oTwigContext = new LoginTwigRenderer(); $oTwigContext = new LoginTwigRenderer();
$aPostedVars = array_merge(array('login_mode', 'loginop'), $oTwigContext->GetPostedVars()); $aPostedVars = array_merge(['login_mode', 'loginop'], $oTwigContext->GetPostedVars());
$sMessage = Dict::S('UI:Login:IdentifyYourself'); $sMessage = Dict::S('UI:Login:IdentifyYourself');
// Error message // Error message
if ($bFailedLogin) if ($bFailedLogin) {
{ if (self::$m_sLoginFailedMessage != '') {
if (self::$m_sLoginFailedMessage != '')
{
$sMessage = self::$m_sLoginFailedMessage; $sMessage = self::$m_sLoginFailedMessage;
} } else {
else
{
$sMessage = Dict::S('UI:Login:IncorrectLoginPassword'); $sMessage = Dict::S('UI:Login:IncorrectLoginPassword');
} }
} }
// Keep the OTHER parameters posted // Keep the OTHER parameters posted
$aPreviousPostedVars = array(); $aPreviousPostedVars = [];
foreach($_POST as $sPostedKey => $postedValue) foreach ($_POST as $sPostedKey => $postedValue) {
{ if (!in_array($sPostedKey, $aPostedVars)) {
if (!in_array($sPostedKey, $aPostedVars)) if (is_array($postedValue)) {
{ foreach ($postedValue as $sKey => $sValue) {
if (is_array($postedValue))
{
foreach($postedValue as $sKey => $sValue)
{
$sName = "{$sPostedKey}[{$sKey}]"; $sName = "{$sPostedKey}[{$sKey}]";
$aPreviousPostedVars[$sName] = $sValue; $aPreviousPostedVars[$sName] = $sValue;
} }
} } else {
else
{
$aPreviousPostedVars[$sPostedKey] = $postedValue; $aPreviousPostedVars[$sPostedKey] = $postedValue;
} }
} }
} }
$aVars = array( $aVars = [
'bFailedLogin' => $bFailedLogin, 'bFailedLogin' => $bFailedLogin,
'sMessage' => $sMessage, 'sMessage' => $sMessage,
'aPreviousPostedVars' => $aPreviousPostedVars, 'aPreviousPostedVars' => $aPreviousPostedVars,
); ];
$aVars = array_merge($aVars, $oTwigContext->GetDefaultVars()); $aVars = array_merge($aVars, $oTwigContext->GetDefaultVars());
$oTwigContext->Render($this, 'login.html.twig', $aVars); $oTwigContext->Render($this, 'login.html.twig', $aVars);
@@ -226,26 +214,21 @@ class LoginWebPage extends NiceWebPage
{ {
$sAuthUser = utils::ReadParam('auth_user', '', true, 'raw_data'); $sAuthUser = utils::ReadParam('auth_user', '', true, 'raw_data');
try try {
{
UserRights::Login($sAuthUser); // Set the user's language (if possible!) UserRights::Login($sAuthUser); // Set the user's language (if possible!)
/** @var UserInternal $oUser */ /** @var UserInternal $oUser */
$oUser = UserRights::GetUserObject(); $oUser = UserRights::GetUserObject();
if ($oUser != null) if ($oUser != null) {
{ if (!MetaModel::IsValidAttCode(get_class($oUser), 'reset_pwd_token')) {
if (!MetaModel::IsValidAttCode(get_class($oUser), 'reset_pwd_token'))
{
throw new Exception(Dict::S('UI:ResetPwd-Error-NotPossible')); throw new Exception(Dict::S('UI:ResetPwd-Error-NotPossible'));
} }
if (!$oUser->CanChangePassword()) if (!$oUser->CanChangePassword()) {
{
throw new Exception(Dict::S('UI:ResetPwd-Error-FixedPwd')); throw new Exception(Dict::S('UI:ResetPwd-Error-FixedPwd'));
} }
$sTo = $oUser->GetResetPasswordEmail(); // throws Exceptions if not allowed $sTo = $oUser->GetResetPasswordEmail(); // throws Exceptions if not allowed
if ($sTo == '') if ($sTo == '') {
{
throw new Exception(Dict::S('UI:ResetPwd-Error-NoEmail')); throw new Exception(Dict::S('UI:ResetPwd-Error-NoEmail'));
} }
@@ -265,8 +248,7 @@ class LoginWebPage extends NiceWebPage
$sResetUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?loginop=reset_pwd&auth_user='.urlencode($oUser->Get('login')).'&token='.urlencode($sToken); $sResetUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?loginop=reset_pwd&auth_user='.urlencode($oUser->Get('login')).'&token='.urlencode($sToken);
$oEmail->SetBody(Dict::Format('UI:ResetPwd-EmailBody', $sResetUrl, $oUser->Get('login'))); $oEmail->SetBody(Dict::Format('UI:ResetPwd-EmailBody', $sResetUrl, $oUser->Get('login')));
$iRes = $oEmail->Send($aIssues, true /* force synchronous exec */); $iRes = $oEmail->Send($aIssues, true /* force synchronous exec */);
switch ($iRes) switch ($iRes) {
{
//case EMAIL_SEND_PENDING: //case EMAIL_SEND_PENDING:
case EMAIL_SEND_OK: case EMAIL_SEND_OK:
break; break;
@@ -278,13 +260,10 @@ class LoginWebPage extends NiceWebPage
} }
} }
$oTwigContext = new LoginTwigRenderer(); $oTwigContext = new LoginTwigRenderer();
$aVars = $oTwigContext->GetDefaultVars(); $aVars = $oTwigContext->GetDefaultVars();
$oTwigContext->Render($this, 'forgotpwdsent.html.twig', $aVars); $oTwigContext->Render($this, 'forgotpwdsent.html.twig', $aVars);
} } catch (Exception $e) {
catch(Exception $e)
{
$this->DisplayForgotPwdForm(true, $e->getMessage()); $this->DisplayForgotPwdForm(true, $e->getMessage());
} }
} }
@@ -304,22 +283,16 @@ class LoginWebPage extends NiceWebPage
$aVars['sToken'] = $sToken; $aVars['sToken'] = $sToken;
$aVars['sErrorMessage'] = $sErrorMessage; $aVars['sErrorMessage'] = $sErrorMessage;
if (($oUser == null)) if (($oUser == null)) {
{
$aVars['bNoUser'] = true; $aVars['bNoUser'] = true;
} } else {
else
{
$aVars['bNoUser'] = false; $aVars['bNoUser'] = false;
$aVars['sUserName'] = $oUser->GetFriendlyName(); $aVars['sUserName'] = $oUser->GetFriendlyName();
$oEncryptedToken = $oUser->Get('reset_pwd_token'); $oEncryptedToken = $oUser->Get('reset_pwd_token');
if (!$oEncryptedToken->CheckPassword($sToken)) if (!$oEncryptedToken->CheckPassword($sToken)) {
{
$aVars['bBadToken'] = true; $aVars['bBadToken'] = true;
} } else {
else
{
$aVars['bBadToken'] = false; $aVars['bBadToken'] = false;
} }
} }
@@ -342,21 +315,15 @@ class LoginWebPage extends NiceWebPage
$aVars['sAuthUser'] = $sAuthUser; $aVars['sAuthUser'] = $sAuthUser;
$aVars['sToken'] = $sToken; $aVars['sToken'] = $sToken;
if (($oUser == null)) if (($oUser == null)) {
{
$aVars['bNoUser'] = true; $aVars['bNoUser'] = true;
} } else {
else
{
$aVars['bNoUser'] = false; $aVars['bNoUser'] = false;
$oEncryptedToken = $oUser->Get('reset_pwd_token'); $oEncryptedToken = $oUser->Get('reset_pwd_token');
if (!$oEncryptedToken->CheckPassword($sToken)) if (!$oEncryptedToken->CheckPassword($sToken)) {
{
$aVars['bBadToken'] = true; $aVars['bBadToken'] = true;
} } else {
else
{
$aVars['bBadToken'] = false; $aVars['bBadToken'] = false;
// Trash the token and change the password // Trash the token and change the password
$oUser->Set('reset_pwd_token', new ormPassword()); $oUser->Set('reset_pwd_token', new ormPassword());
@@ -413,7 +380,7 @@ class LoginWebPage extends NiceWebPage
// Note: This will destroy the session, and not just the session data! // Note: This will destroy the session, and not just the session data!
} }
static function SecureConnectionRequired() public static function SecureConnectionRequired()
{ {
return MetaModel::GetConfig()->GetSecureConnectionRequired(); return MetaModel::GetConfig()->GetSecureConnectionRequired();
} }
@@ -423,7 +390,7 @@ class LoginWebPage extends NiceWebPage
* @param string $sString * @param string $sString
* @return bool True if the string contains some typical UTF-8 multi-byte sequences * @return bool True if the string contains some typical UTF-8 multi-byte sequences
*/ */
static function LooksLikeUTF8($sString) public static function LooksLikeUTF8($sString)
{ {
return preg_match('%(?: return preg_match('%(?:
[\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
@@ -446,22 +413,19 @@ class LoginWebPage extends NiceWebPage
protected static function Login($iOnExit) protected static function Login($iOnExit)
{ {
self::$iOnExit = $iOnExit; self::$iOnExit = $iOnExit;
if (self::SecureConnectionRequired() && !utils::IsConnectionSecure()) if (self::SecureConnectionRequired() && !utils::IsConnectionSecure()) {
{
// Non secured URL... request for a secure connection // Non secured URL... request for a secure connection
throw new Exception('Secure connection required!'); throw new Exception('Secure connection required!');
} }
$bLoginDebug = MetaModel::GetConfig()->Get('login_debug'); $bLoginDebug = MetaModel::GetConfig()->Get('login_debug');
if (Session::Get('login_state') == self::LOGIN_STATE_ERROR) if (Session::Get('login_state') == self::LOGIN_STATE_ERROR) {
{
Session::Set('login_state', self::LOGIN_STATE_START); Session::Set('login_state', self::LOGIN_STATE_START);
} }
$sLoginState = Session::Get('login_state'); $sLoginState = Session::Get('login_state');
$sSessionLog = ''; $sSessionLog = '';
if ($bLoginDebug) if ($bLoginDebug) {
{
IssueLog::Info("---------------------------------"); IssueLog::Info("---------------------------------");
IssueLog::Info($_SERVER['REQUEST_URI']); IssueLog::Info($_SERVER['REQUEST_URI']);
IssueLog::Info("--> Entering Login FSM with state: [$sLoginState]"); IssueLog::Info("--> Entering Login FSM with state: [$sLoginState]");
@@ -472,38 +436,30 @@ class LoginWebPage extends NiceWebPage
$iErrorCode = self::EXIT_CODE_OK; $iErrorCode = self::EXIT_CODE_OK;
// Finite state machine loop // Finite state machine loop
while (true) while (true) {
{ try {
try
{
$aLoginPlugins = self::GetLoginPluginList(); $aLoginPlugins = self::GetLoginPluginList();
if (empty($aLoginPlugins)) if (empty($aLoginPlugins)) {
{
throw new Exception("Missing login classes"); throw new Exception("Missing login classes");
} }
/** @var iLoginFSMExtension $oLoginFSMExtensionInstance */ /** @var iLoginFSMExtension $oLoginFSMExtensionInstance */
foreach ($aLoginPlugins as $oLoginFSMExtensionInstance) foreach ($aLoginPlugins as $oLoginFSMExtensionInstance) {
{ if ($bLoginDebug) {
if ($bLoginDebug)
{
$sCurrSessionLog = session_id().' '.utils::GetSessionLog(); $sCurrSessionLog = session_id().' '.utils::GetSessionLog();
if ($sCurrSessionLog != $sSessionLog) if ($sCurrSessionLog != $sSessionLog) {
{
$sSessionLog = $sCurrSessionLog; $sSessionLog = $sCurrSessionLog;
IssueLog::Info("SESSION: $sSessionLog"); IssueLog::Info("SESSION: $sSessionLog");
} }
IssueLog::Info("Login: state: [$sLoginState] call: ".get_class($oLoginFSMExtensionInstance)); IssueLog::Info("Login: state: [$sLoginState] call: ".get_class($oLoginFSMExtensionInstance));
} }
$iResponse = $oLoginFSMExtensionInstance->LoginAction($sLoginState, $iErrorCode); $iResponse = $oLoginFSMExtensionInstance->LoginAction($sLoginState, $iErrorCode);
if ($iResponse == self::LOGIN_FSM_RETURN) if ($iResponse == self::LOGIN_FSM_RETURN) {
{
EventService::FireEvent(new EventData(EVENT_LOGIN, null, ['code' => $iErrorCode, 'state' => $sLoginState])); EventService::FireEvent(new EventData(EVENT_LOGIN, null, ['code' => $iErrorCode, 'state' => $sLoginState]));
Session::WriteClose(); Session::WriteClose();
return $iErrorCode; // Asked to exit FSM, generally login OK return $iErrorCode; // Asked to exit FSM, generally login OK
} }
if ($iResponse == self::LOGIN_FSM_ERROR) if ($iResponse == self::LOGIN_FSM_ERROR) {
{
EventService::FireEvent(new EventData(EVENT_LOGIN, null, ['code' => $iErrorCode, 'state' => $sLoginState])); EventService::FireEvent(new EventData(EVENT_LOGIN, null, ['code' => $iErrorCode, 'state' => $sLoginState]));
$sLoginState = self::LOGIN_STATE_SET_ERROR; // Next state will be error $sLoginState = self::LOGIN_STATE_SET_ERROR; // Next state will be error
// An error was detected, skip the other plugins turn // An error was detected, skip the other plugins turn
@@ -515,9 +471,7 @@ class LoginWebPage extends NiceWebPage
// Every plugin has nothing else to do in this state, go forward // Every plugin has nothing else to do in this state, go forward
$sLoginState = self::AdvanceLoginFSMState($sLoginState); $sLoginState = self::AdvanceLoginFSMState($sLoginState);
Session::Set('login_state', $sLoginState); Session::Set('login_state', $sLoginState);
} } catch (Exception $e) {
catch (Exception $e)
{
EventService::FireEvent(new EventData(EVENT_LOGIN, null, ['state' => $_SESSION['login_state']])); EventService::FireEvent(new EventData(EVENT_LOGIN, null, ['state' => $_SESSION['login_state']]));
IssueLog::Error($e->getTraceAsString()); IssueLog::Error($e->getTraceAsString());
static::ResetSession(); static::ResetSession();
@@ -537,30 +491,23 @@ class LoginWebPage extends NiceWebPage
*/ */
public static function GetLoginPluginList($sInterface = 'iLoginFSMExtension', $bFilterWithMode = true) public static function GetLoginPluginList($sInterface = 'iLoginFSMExtension', $bFilterWithMode = true)
{ {
$aAllPlugins = array(); $aAllPlugins = [];
if ($bFilterWithMode) if ($bFilterWithMode) {
{
$sCurrentLoginMode = Session::Get('login_mode', ''); $sCurrentLoginMode = Session::Get('login_mode', '');
} } else {
else
{
$sCurrentLoginMode = ''; $sCurrentLoginMode = '';
} }
/** @var iLoginExtension $oLoginExtensionInstance */ /** @var iLoginExtension $oLoginExtensionInstance */
foreach (MetaModel::EnumPlugins($sInterface) as $oLoginExtensionInstance) foreach (MetaModel::EnumPlugins($sInterface) as $oLoginExtensionInstance) {
{
$aLoginModes = $oLoginExtensionInstance->ListSupportedLoginModes(); $aLoginModes = $oLoginExtensionInstance->ListSupportedLoginModes();
$aLoginModes = (is_array($aLoginModes) ? $aLoginModes : array()); $aLoginModes = (is_array($aLoginModes) ? $aLoginModes : []);
foreach ($aLoginModes as $sLoginMode) foreach ($aLoginModes as $sLoginMode) {
{
// Keep only the plugins for the current login mode + before + after // Keep only the plugins for the current login mode + before + after
if (empty($sCurrentLoginMode) || ($sLoginMode == $sCurrentLoginMode) || ($sLoginMode == 'before') || ($sLoginMode == 'after')) if (empty($sCurrentLoginMode) || ($sLoginMode == $sCurrentLoginMode) || ($sLoginMode == 'before') || ($sLoginMode == 'after')) {
{ if (!isset($aAllPlugins[$sLoginMode])) {
if (!isset($aAllPlugins[$sLoginMode])) $aAllPlugins[$sLoginMode] = [];
{
$aAllPlugins[$sLoginMode] = array();
} }
$aAllPlugins[$sLoginMode][] = $oLoginExtensionInstance; $aAllPlugins[$sLoginMode][] = $oLoginExtensionInstance;
break; // Stop here to avoid registering a plugin twice break; // Stop here to avoid registering a plugin twice
@@ -569,12 +516,10 @@ class LoginWebPage extends NiceWebPage
} }
// Order and filter by the config list of allowed types (allowed_login_types) // Order and filter by the config list of allowed types (allowed_login_types)
$aAllowedLoginModes = array_merge(array('before'), MetaModel::GetConfig()->GetAllowedLoginTypes(), array('after')); $aAllowedLoginModes = array_merge(['before'], MetaModel::GetConfig()->GetAllowedLoginTypes(), ['after']);
$aPlugins = array(); $aPlugins = [];
foreach ($aAllowedLoginModes as $sAllowedMode) foreach ($aAllowedLoginModes as $sAllowedMode) {
{ if (isset($aAllPlugins[$sAllowedMode])) {
if (isset($aAllPlugins[$sAllowedMode]))
{
$aPlugins = array_merge($aPlugins, $aAllPlugins[$sAllowedMode]); $aPlugins = array_merge($aPlugins, $aAllPlugins[$sAllowedMode]);
} }
} }
@@ -590,8 +535,7 @@ class LoginWebPage extends NiceWebPage
*/ */
private static function AdvanceLoginFSMState($sLoginState) private static function AdvanceLoginFSMState($sLoginState)
{ {
switch ($sLoginState) switch ($sLoginState) {
{
case self::LOGIN_STATE_START: case self::LOGIN_STATE_START:
return self::LOGIN_STATE_MODE_DETECTION; return self::LOGIN_STATE_MODE_DETECTION;
@@ -638,8 +582,7 @@ class LoginWebPage extends NiceWebPage
public static function CheckUser($sAuthUser, $sAuthPassword = '', $sAuthentication = 'external') public static function CheckUser($sAuthUser, $sAuthPassword = '', $sAuthentication = 'external')
{ {
$oUser = self::FindUser($sAuthUser, true, ucfirst(strtolower($sAuthentication))); $oUser = self::FindUser($sAuthUser, true, ucfirst(strtolower($sAuthentication)));
if (is_null($oUser)) if (is_null($oUser)) {
{
return false; return false;
} }
@@ -668,8 +611,7 @@ class LoginWebPage extends NiceWebPage
{ {
// User is Ok, let's save it in the session and proceed with normal login // User is Ok, let's save it in the session and proceed with normal login
$bLoginSuccess = UserRights::Login($sAuthUser, $sAuthentication); // Login & set the user's language $bLoginSuccess = UserRights::Login($sAuthUser, $sAuthentication); // Login & set the user's language
if (!$bLoginSuccess) if (!$bLoginSuccess) {
{
throw new Exception("Bad user"); throw new Exception("Bad user");
} }
if (MetaModel::GetConfig()->Get('log_usage')) { if (MetaModel::GetConfig()->Get('log_usage')) {
@@ -696,12 +638,10 @@ class LoginWebPage extends NiceWebPage
*/ */
public static function CheckLoggedUser(&$iErrorCode) public static function CheckLoggedUser(&$iErrorCode)
{ {
if (Session::IsSet('auth_user')) if (Session::IsSet('auth_user')) {
{
// Already authenticated // Already authenticated
$bRet = UserRights::Login(Session::Get('auth_user')); // Login & set the user's language $bRet = UserRights::Login(Session::Get('auth_user')); // Login & set the user's language
if ($bRet) if ($bRet) {
{
$iErrorCode = self::EXIT_CODE_OK; $iErrorCode = self::EXIT_CODE_OK;
return self::LOGIN_FSM_RETURN; return self::LOGIN_FSM_RETURN;
} }
@@ -727,8 +667,7 @@ class LoginWebPage extends NiceWebPage
public static function SetLoginModeAndReload($sNewLoginMode) public static function SetLoginModeAndReload($sNewLoginMode)
{ {
if (Session::Get('login_mode') == $sNewLoginMode) if (Session::Get('login_mode') == $sNewLoginMode) {
{
return; return;
} }
Session::Set('login_mode', $sNewLoginMode); Session::Set('login_mode', $sNewLoginMode);
@@ -738,8 +677,7 @@ class LoginWebPage extends NiceWebPage
public static function HTTPReload() public static function HTTPReload()
{ {
$sOriginURL = utils::GetCurrentAbsoluteUrl(); $sOriginURL = utils::GetCurrentAbsoluteUrl();
if (!utils::StartsWith($sOriginURL, utils::GetAbsoluteUrlAppRoot())) if (!utils::StartsWith($sOriginURL, utils::GetAbsoluteUrlAppRoot())) {
{
// If the found URL does not start with the configured AppRoot URL // If the found URL does not start with the configured AppRoot URL
$sOriginURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php'; $sOriginURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php';
} }
@@ -753,7 +691,6 @@ class LoginWebPage extends NiceWebPage
exit; exit;
} }
/** /**
* Provisioning API: Find a User * Provisioning API: Find a User
* *
@@ -767,26 +704,21 @@ class LoginWebPage extends NiceWebPage
*/ */
public static function FindUser($sAuthUser, $bMustBeValid = true, $sType = 'External') public static function FindUser($sAuthUser, $bMustBeValid = true, $sType = 'External')
{ {
try try {
{ $aArgs = ['login' => $sAuthUser];
$aArgs = array('login' => $sAuthUser);
$sUserClass = "User$sType"; $sUserClass = "User$sType";
$oSearch = DBObjectSearch::FromOQL("SELECT $sUserClass WHERE login = :login"); $oSearch = DBObjectSearch::FromOQL("SELECT $sUserClass WHERE login = :login");
if ($bMustBeValid) if ($bMustBeValid) {
{
$oSearch->AddCondition('status', 'enabled'); $oSearch->AddCondition('status', 'enabled');
} }
$oSet = new DBObjectSet($oSearch, array(), $aArgs); $oSet = new DBObjectSet($oSearch, [], $aArgs);
if ($oSet->CountExceeds(0)) if ($oSet->CountExceeds(0)) {
{
/** @var User $oUser */ /** @var User $oUser */
$oUser = $oSet->Fetch(); $oUser = $oSet->Fetch();
return $oUser; return $oUser;
} }
} } catch (Exception $e) {
catch (Exception $e)
{
IssueLog::Error($e->getMessage()); IssueLog::Error($e->getMessage());
} }
return null; return null;
@@ -805,19 +737,15 @@ class LoginWebPage extends NiceWebPage
{ {
/** @var \Person $oPerson */ /** @var \Person $oPerson */
$oPerson = null; $oPerson = null;
try try {
{
$oSearch = new DBObjectSearch('Person'); $oSearch = new DBObjectSearch('Person');
$oSearch->AddCondition('email', $sEmail); $oSearch->AddCondition('email', $sEmail);
$oSet = new DBObjectSet($oSearch); $oSet = new DBObjectSet($oSearch);
if ($oSet->CountExceeds(1)) if ($oSet->CountExceeds(1)) {
{
throw new Exception(Dict::S('UI:Login:Error:MultipleContactsHaveSameEmail')); throw new Exception(Dict::S('UI:Login:Error:MultipleContactsHaveSameEmail'));
} }
$oPerson = $oSet->Fetch(); $oPerson = $oSet->Fetch();
} } catch (Exception $e) {
catch (Exception $e)
{
IssueLog::Error($e->getMessage()); IssueLog::Error($e->getMessage());
} }
return $oPerson; return $oPerson;
@@ -836,16 +764,14 @@ class LoginWebPage extends NiceWebPage
* *
* @return \Person * @return \Person
*/ */
public static function ProvisionPerson($sFirstName, $sLastName, $sEmail, $sOrganization, $aAdditionalParams = array()) public static function ProvisionPerson($sFirstName, $sLastName, $sEmail, $sOrganization, $aAdditionalParams = [])
{ {
/** @var Person $oPerson */ /** @var Person $oPerson */
$oPerson = null; $oPerson = null;
try try {
{
CMDBObject::SetTrackOrigin('custom-extension'); CMDBObject::SetTrackOrigin('custom-extension');
$sInfo = 'External User provisioning'; $sInfo = 'External User provisioning';
if (Session::IsSet('login_mode')) if (Session::IsSet('login_mode')) {
{
$sInfo .= " (".Session::Get('login_mode').")"; $sInfo .= " (".Session::Get('login_mode').")";
} }
CMDBObject::SetTrackInfo($sInfo); CMDBObject::SetTrackInfo($sInfo);
@@ -855,19 +781,15 @@ class LoginWebPage extends NiceWebPage
$oPerson->Set('name', $sLastName); $oPerson->Set('name', $sLastName);
$oPerson->Set('email', $sEmail); $oPerson->Set('email', $sEmail);
$oOrg = MetaModel::GetObjectByName('Organization', $sOrganization, false); $oOrg = MetaModel::GetObjectByName('Organization', $sOrganization, false);
if (is_null($oOrg)) if (is_null($oOrg)) {
{
throw new Exception(Dict::S('UI:Login:Error:WrongOrganizationName')); throw new Exception(Dict::S('UI:Login:Error:WrongOrganizationName'));
} }
$oPerson->Set('org_id', $oOrg->GetKey()); $oPerson->Set('org_id', $oOrg->GetKey());
foreach ($aAdditionalParams as $sAttCode => $sValue) foreach ($aAdditionalParams as $sAttCode => $sValue) {
{
$oPerson->Set($sAttCode, $sValue); $oPerson->Set($sAttCode, $sValue);
} }
$oPerson->DBInsert(); $oPerson->DBInsert();
} } catch (Exception $e) {
catch (Exception $e)
{
IssueLog::Error($e->getMessage()); IssueLog::Error($e->getMessage());
} }
return $oPerson; return $oPerson;
@@ -886,27 +808,23 @@ class LoginWebPage extends NiceWebPage
*/ */
public static function ProvisionUser($sAuthUser, $oPerson, $aRequestedProfiles) public static function ProvisionUser($sAuthUser, $oPerson, $aRequestedProfiles)
{ {
if (!MetaModel::IsValidClass('URP_Profiles')) if (!MetaModel::IsValidClass('URP_Profiles')) {
{
IssueLog::Error("URP_Profiles is not a valid class. Automatic creation of Users is not supported in this context, sorry."); IssueLog::Error("URP_Profiles is not a valid class. Automatic creation of Users is not supported in this context, sorry.");
return null; return null;
} }
/** @var UserExternal $oUser */ /** @var UserExternal $oUser */
$oUser = null; $oUser = null;
try try {
{
CMDBObject::SetTrackOrigin('custom-extension'); CMDBObject::SetTrackOrigin('custom-extension');
$sInfo = 'External User provisioning'; $sInfo = 'External User provisioning';
if (Session::IsSet('login_mode')) if (Session::IsSet('login_mode')) {
{
$sInfo .= " (".Session::Get('login_mode').")"; $sInfo .= " (".Session::Get('login_mode').")";
} }
CMDBObject::SetTrackInfo($sInfo); CMDBObject::SetTrackInfo($sInfo);
$oUser = MetaModel::GetObjectByName('UserExternal', $sAuthUser, false); $oUser = MetaModel::GetObjectByName('UserExternal', $sAuthUser, false);
if (is_null($oUser)) if (is_null($oUser)) {
{
$oUser = MetaModel::NewObject('UserExternal'); $oUser = MetaModel::NewObject('UserExternal');
$oUser->Set('login', $sAuthUser); $oUser->Set('login', $sAuthUser);
$oUser->Set('contactid', $oPerson->GetKey()); $oUser->Set('contactid', $oPerson->GetKey());
@@ -916,41 +834,33 @@ class LoginWebPage extends NiceWebPage
// read all the existing profiles // read all the existing profiles
$oProfilesSearch = new DBObjectSearch('URP_Profiles'); $oProfilesSearch = new DBObjectSearch('URP_Profiles');
$oProfilesSet = new DBObjectSet($oProfilesSearch); $oProfilesSet = new DBObjectSet($oProfilesSearch);
$aAllProfiles = array(); $aAllProfiles = [];
while ($oProfile = $oProfilesSet->Fetch()) while ($oProfile = $oProfilesSet->Fetch()) {
{
$aAllProfiles[mb_strtolower($oProfile->GetName())] = $oProfile->GetKey(); $aAllProfiles[mb_strtolower($oProfile->GetName())] = $oProfile->GetKey();
} }
$aProfiles = array(); $aProfiles = [];
foreach ($aRequestedProfiles as $sRequestedProfile) foreach ($aRequestedProfiles as $sRequestedProfile) {
{
$sRequestedProfile = mb_strtolower($sRequestedProfile); $sRequestedProfile = mb_strtolower($sRequestedProfile);
if (isset($aAllProfiles[$sRequestedProfile])) if (isset($aAllProfiles[$sRequestedProfile])) {
{
$aProfiles[] = $aAllProfiles[$sRequestedProfile]; $aProfiles[] = $aAllProfiles[$sRequestedProfile];
} }
} }
if (empty($aProfiles)) if (empty($aProfiles)) {
{
throw new Exception(Dict::S('UI:Login:Error:NoValidProfiles')); throw new Exception(Dict::S('UI:Login:Error:NoValidProfiles'));
} }
// Now synchronize the profiles // Now synchronize the profiles
$sOrigin = 'External User provisioning'; $sOrigin = 'External User provisioning';
if (Session::IsSet('login_mode')) if (Session::IsSet('login_mode')) {
{
$sOrigin .= " (".Session::Get('login_mode').")"; $sOrigin .= " (".Session::Get('login_mode').")";
} }
$aExistingProfiles = self::SynchronizeProfiles($oUser, $aProfiles, $sOrigin); $aExistingProfiles = self::SynchronizeProfiles($oUser, $aProfiles, $sOrigin);
if ($oUser->IsModified()) if ($oUser->IsModified()) {
{
$oUser->DBWrite(); $oUser->DBWrite();
} }
} } catch (Exception $e) {
catch (Exception $e)
{
IssueLog::Error($e->getMessage()); IssueLog::Error($e->getMessage());
} }
@@ -964,23 +874,15 @@ class LoginWebPage extends NiceWebPage
*/ */
protected static function ChangeLocation($sRequestedPortalId = null, $iOnExit = self::EXIT_PROMPT) protected static function ChangeLocation($sRequestedPortalId = null, $iOnExit = self::EXIT_PROMPT)
{ {
$ret = call_user_func(array(self::$sHandlerClass, 'Dispatch'), $sRequestedPortalId); $ret = call_user_func([self::$sHandlerClass, 'Dispatch'], $sRequestedPortalId);
if ($ret === true) if ($ret === true) {
{
return self::EXIT_CODE_OK; return self::EXIT_CODE_OK;
} } elseif ($ret === false) {
else if($ret === false)
{
throw new Exception('Nowhere to go: Your combination of user Profiles denies you access to any '.ITOP_APPLICATION_SHORT.' portal. Please contact your administrator'); throw new Exception('Nowhere to go: Your combination of user Profiles denies you access to any '.ITOP_APPLICATION_SHORT.' portal. Please contact your administrator');
} } else {
else if ($iOnExit == self::EXIT_RETURN) {
{
if ($iOnExit == self::EXIT_RETURN)
{
return self::EXIT_CODE_PORTALUSERNOTAUTHORIZED; return self::EXIT_CODE_PORTALUSERNOTAUTHORIZED;
} } else {
else
{
// No rights to be here, redirect to the portal // No rights to be here, redirect to the portal
header('Location: '.$ret); header('Location: '.$ret);
die(); die();
@@ -1002,7 +904,7 @@ class LoginWebPage extends NiceWebPage
* @return int|mixed|string * @return int|mixed|string
* @throws \Exception * @throws \Exception
*/ */
static function DoLogin($bMustBeAdmin = false, $bIsAllowedToPortalUsers = false, $iOnExit = self::EXIT_PROMPT) public static function DoLogin($bMustBeAdmin = false, $bIsAllowedToPortalUsers = false, $iOnExit = self::EXIT_PROMPT)
{ {
$sRequestedPortalId = $bIsAllowedToPortalUsers ? 'legacy_portal' : 'backoffice'; $sRequestedPortalId = $bIsAllowedToPortalUsers ? 'legacy_portal' : 'backoffice';
return self::DoLoginEx($sRequestedPortalId, $bMustBeAdmin, $iOnExit); return self::DoLoginEx($sRequestedPortalId, $bMustBeAdmin, $iOnExit);
@@ -1019,23 +921,18 @@ class LoginWebPage extends NiceWebPage
* @return int|mixed|string * @return int|mixed|string
* @throws \Exception * @throws \Exception
*/ */
static function DoLoginEx($sRequestedPortalId = null, $bMustBeAdmin = false, $iOnExit = self::EXIT_PROMPT) public static function DoLoginEx($sRequestedPortalId = null, $bMustBeAdmin = false, $iOnExit = self::EXIT_PROMPT)
{ {
$operation = utils::ReadParam('loginop', ''); $operation = utils::ReadParam('loginop', '');
$sMessage = self::HandleOperations($operation); // May exit directly $sMessage = self::HandleOperations($operation); // May exit directly
$iRet = self::Login($iOnExit); $iRet = self::Login($iOnExit);
if ($iRet == self::EXIT_CODE_OK) if ($iRet == self::EXIT_CODE_OK) {
{ if ($bMustBeAdmin && !UserRights::IsAdministrator()) {
if ($bMustBeAdmin && !UserRights::IsAdministrator()) if ($iOnExit == self::EXIT_RETURN) {
{
if ($iOnExit == self::EXIT_RETURN)
{
return self::EXIT_CODE_MUSTBEADMIN; return self::EXIT_CODE_MUSTBEADMIN;
} } else {
else
{
require_once(APPROOT.'/setup/setuppage.class.inc.php'); require_once(APPROOT.'/setup/setuppage.class.inc.php');
$oP = new ErrorPage(Dict::S('UI:PageTitle:FatalError')); $oP = new ErrorPage(Dict::S('UI:PageTitle:FatalError'));
$oP->add("<h1>".Dict::S('UI:Login:Error:AccessAdmin')."</h1>\n"); $oP->add("<h1>".Dict::S('UI:Login:Error:AccessAdmin')."</h1>\n");
@@ -1044,69 +941,52 @@ class LoginWebPage extends NiceWebPage
exit; exit;
} }
} }
$iRet = call_user_func(array(self::$sHandlerClass, 'ChangeLocation'), $sRequestedPortalId, $iOnExit); $iRet = call_user_func([self::$sHandlerClass, 'ChangeLocation'], $sRequestedPortalId, $iOnExit);
} }
if ($iOnExit == self::EXIT_RETURN) if ($iOnExit == self::EXIT_RETURN) {
{
return $iRet; return $iRet;
} } else {
else
{
return $sMessage; return $sMessage;
} }
} }
protected static function HandleOperations($operation) protected static function HandleOperations($operation)
{ {
$sMessage = ''; // most of the operations never return, but some can return a message to be displayed $sMessage = ''; // most of the operations never return, but some can return a message to be displayed
if ($operation == 'logoff') if ($operation == 'logoff') {
{
self::ResetSession(); self::ResetSession();
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DisplayLoginForm(false /* not a failed attempt */); $oPage->DisplayLoginForm(false /* not a failed attempt */);
$oPage->output(); $oPage->output();
exit; exit;
} } elseif ($operation == 'forgot_pwd') {
else if ($operation == 'forgot_pwd')
{
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DisplayForgotPwdForm(); $oPage->DisplayForgotPwdForm();
$oPage->output(); $oPage->output();
exit; exit;
} } elseif ($operation == 'forgot_pwd_go') {
else if ($operation == 'forgot_pwd_go')
{
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->ForgotPwdGo(); $oPage->ForgotPwdGo();
$oPage->output(); $oPage->output();
exit; exit;
} } elseif ($operation == 'reset_pwd') {
else if ($operation == 'reset_pwd')
{
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DisplayResetPwdForm(); $oPage->DisplayResetPwdForm();
$oPage->output(); $oPage->output();
exit; exit;
} } elseif ($operation == 'do_reset_pwd') {
else if ($operation == 'do_reset_pwd')
{
try { try {
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DoResetPassword(); $oPage->DoResetPassword();
} } catch (CoreCannotSaveObjectException $e) {
catch (CoreCannotSaveObjectException $e)
{
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DisplayResetPwdForm($e->getIssue()); $oPage->DisplayResetPwdForm($e->getIssue());
} }
$oPage->output(); $oPage->output();
exit; exit;
} } elseif ($operation == 'change_pwd') {
else if ($operation == 'change_pwd') if (Session::IsSet('auth_user')) {
{
if (Session::IsSet('auth_user'))
{
$sAuthUser = Session::Get('auth_user'); $sAuthUser = Session::Get('auth_user');
$sIssue = Session::Get('pwd_issue'); $sIssue = Session::Get('pwd_issue');
Session::Unset('pwd_issue'); Session::Unset('pwd_issue');
@@ -1118,16 +998,13 @@ class LoginWebPage extends NiceWebPage
$oPage->output(); $oPage->output();
exit; exit;
} }
} } elseif ($operation == 'check_pwd_policy') {
else if ($operation == 'check_pwd_policy')
{
$sAuthUser = Session::Get('auth_user'); $sAuthUser = Session::Get('auth_user');
UserRights::Login($sAuthUser); // Set the user's language UserRights::Login($sAuthUser); // Set the user's language
$aPwdMap = array(); $aPwdMap = [];
foreach (array('new_pwd', 'retype_new_pwd') as $postedPwd) foreach (['new_pwd', 'retype_new_pwd'] as $postedPwd) {
{
$oUser = new UserLocal(); $oUser = new UserLocal();
$oUser->ValidatePassword($_POST[$postedPwd]); $oUser->ValidatePassword($_POST[$postedPwd]);
@@ -1137,27 +1014,21 @@ class LoginWebPage extends NiceWebPage
echo json_encode($aPwdMap); echo json_encode($aPwdMap);
die(); die();
} }
if ($operation == 'do_change_pwd') if ($operation == 'do_change_pwd') {
{ if (Session::IsSet('auth_user')) {
if (Session::IsSet('auth_user'))
{
$sAuthUser = Session::Get('auth_user'); $sAuthUser = Session::Get('auth_user');
UserRights::Login($sAuthUser); // Set the user's language UserRights::Login($sAuthUser); // Set the user's language
$sOldPwd = utils::ReadPostedParam('old_pwd', '', 'raw_data'); $sOldPwd = utils::ReadPostedParam('old_pwd', '', 'raw_data');
$sNewPwd = utils::ReadPostedParam('new_pwd', '', 'raw_data'); $sNewPwd = utils::ReadPostedParam('new_pwd', '', 'raw_data');
try try {
{ if (UserRights::CanChangePassword() && ((!UserRights::CheckCredentials($sAuthUser, $sOldPwd)) || (!UserRights::ChangePassword($sOldPwd, $sNewPwd)))) {
if (UserRights::CanChangePassword() && ((!UserRights::CheckCredentials($sAuthUser, $sOldPwd)) || (!UserRights::ChangePassword($sOldPwd, $sNewPwd))))
{
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DisplayChangePwdForm(true); // old pwd was wrong $oPage->DisplayChangePwdForm(true); // old pwd was wrong
$oPage->output(); $oPage->output();
exit; exit;
} }
} } catch (CoreCannotSaveObjectException $e) {
catch (CoreCannotSaveObjectException $e)
{
$oPage = self::NewLoginWebPage(); $oPage = self::NewLoginWebPage();
$oPage->DisplayChangePwdForm(true, $e->getIssue()); // password policy was not met. $oPage->DisplayChangePwdForm(true, $e->getIssue()); // password policy was not met.
$oPage->output(); $oPage->output();
@@ -1171,23 +1042,24 @@ class LoginWebPage extends NiceWebPage
protected static function Dispatch($sRequestedPortalId) protected static function Dispatch($sRequestedPortalId)
{ {
if ($sRequestedPortalId === null) return true; // allowed to any portal => return true if ($sRequestedPortalId === null) {
return true;
} // allowed to any portal => return true
$aPortalsConf = PortalDispatcherData::GetData(); $aPortalsConf = PortalDispatcherData::GetData();
$aDispatchers = array(); $aDispatchers = [];
foreach($aPortalsConf as $sPortalId => $aConf) foreach ($aPortalsConf as $sPortalId => $aConf) {
{
$sHandlerClass = $aConf['handler']; $sHandlerClass = $aConf['handler'];
$aDispatchers[$sPortalId] = new $sHandlerClass($sPortalId); $aDispatchers[$sPortalId] = new $sHandlerClass($sPortalId);
} }
if (array_key_exists($sRequestedPortalId, $aDispatchers) && $aDispatchers[$sRequestedPortalId]->IsUserAllowed()) if (array_key_exists($sRequestedPortalId, $aDispatchers) && $aDispatchers[$sRequestedPortalId]->IsUserAllowed()) {
{
return true; return true;
} }
foreach($aDispatchers as $sPortalId => $oDispatcher) foreach ($aDispatchers as $sPortalId => $oDispatcher) {
{ if ($oDispatcher->IsUserAllowed()) {
if ($oDispatcher->IsUserAllowed()) return $oDispatcher->GetUrl(); return $oDispatcher->GetUrl();
}
} }
return false; // nothing matched !! return false; // nothing matched !!
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* Copyright (C) 2013-2024 Combodo SAS * Copyright (C) 2013-2024 Combodo SAS
* *
@@ -17,7 +18,6 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
*/ */
// //
// Maintenance message display functions // Maintenance message display functions
// Only included by approot.inc.php // Only included by approot.inc.php
@@ -33,8 +33,7 @@ function _MaintenanceSetupPageMessage($sTitle, $sMessage)
{ {
// Web Page // Web Page
@include_once(APPROOT.'setup/setuppage.class.inc.php'); @include_once(APPROOT.'setup/setuppage.class.inc.php');
if (class_exists('SetupPage')) if (class_exists('SetupPage')) {
{
$oP = new ErrorPage($sTitle); $oP = new ErrorPage($sTitle);
$oP->p("<h2 class=\"center\">$sMessage</h2>"); $oP->p("<h2 class=\"center\">$sMessage</h2>");
$oP->add_ready_script( $oP->add_ready_script(
@@ -42,12 +41,9 @@ function _MaintenanceSetupPageMessage($sTitle, $sMessage)
// Reload in 30s to check if maintenance is over // Reload in 30s to check if maintenance is over
setTimeout(function(){ window.location.reload(); }, 30000); setTimeout(function(){ window.location.reload(); }, 30000);
JS JS
); );
$oP->output(); $oP->output();
} } else {
else
{
_MaintenanceTextMessage($sMessage); _MaintenanceTextMessage($sMessage);
} }
} }
@@ -78,14 +74,13 @@ function _MaintenanceHtmlMessage($sMessage)
*/ */
function _MaintenanceJsonMessage($sTitle, $sMessage) function _MaintenanceJsonMessage($sTitle, $sMessage)
{ {
if (class_exists('JsonPage')) if (class_exists('JsonPage')) {
{
$oP = new JsonPage($sTitle); $oP = new JsonPage($sTitle);
$oP->add_header('Access-Control-Allow-Origin: *'); $oP->add_header('Access-Control-Allow-Origin: *');
$aMessage = [ $aMessage = [
'code' => 100, 'code' => 100,
'message' =>$sMessage 'message' => $sMessage,
]; ];
$oP->AddData($aMessage); $oP->AddData($aMessage);

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -12,7 +13,6 @@ use Combodo\iTop\Application\WebPage\WebPage;
require_once(APPROOT.'/application/utils.inc.php'); require_once(APPROOT.'/application/utils.inc.php');
require_once(APPROOT."/application/user.dashboard.class.inc.php"); require_once(APPROOT."/application/user.dashboard.class.inc.php");
/** /**
* This class manipulates, stores and displays the navigation menu used in the application * This class manipulates, stores and displays the navigation menu used in the application
* In order to improve the modularity of the data model and to ease the update/migration * In order to improve the modularity of the data model and to ease the update/migration
@@ -51,43 +51,40 @@ class ApplicationMenu
/** /**
* @var bool * @var bool
*/ */
static $bAdditionalMenusLoaded = false; public static $bAdditionalMenusLoaded = false;
/** /**
* @var array * @var array
*/ */
static $aRootMenus = array(); public static $aRootMenus = [];
/** /**
* @var array * @var array
*/ */
static $aMenusIndex = array(); public static $aMenusIndex = [];
/** /**
* @var array * @var array
*/ */
static $aMenusById = []; public static $aMenusById = [];
/** /**
* @var string * @var string
*/ */
static $sFavoriteSiloQuery = 'SELECT Organization'; public static $sFavoriteSiloQuery = 'SELECT Organization';
/** /**
* @return void * @return void
*/ */
public static function LoadAdditionalMenus() public static function LoadAdditionalMenus()
{ {
if (!self::$bAdditionalMenusLoaded) if (!self::$bAdditionalMenusLoaded) {
{
// Build menus from module handlers // Build menus from module handlers
// //
/** @var \ModuleHandlerApiInterface $oPHPClass */ /** @var \ModuleHandlerApiInterface $oPHPClass */
foreach(MetaModel::EnumPlugins('ModuleHandlerApiInterface') as $oPHPClass) foreach (MetaModel::EnumPlugins('ModuleHandlerApiInterface') as $oPHPClass) {
{
$oPHPClass::OnMenuCreation(); $oPHPClass::OnMenuCreation();
} }
// Build menus from the menus themselves (e.g. the ShortcutContainerMenuNode will do that) // Build menus from the menus themselves (e.g. the ShortcutContainerMenuNode will do that)
// //
foreach(self::$aRootMenus as $aMenu) foreach (self::$aRootMenus as $aMenu) {
{
$oMenuNode = self::GetMenuNode($aMenu['index']); $oMenuNode = self::GetMenuNode($aMenu['index']);
$oMenuNode->PopulateChildMenus(); $oMenuNode->PopulateChildMenus();
} }
@@ -124,8 +121,7 @@ class ApplicationMenu
*/ */
public static function CheckMenuIdEnabled($sMenuId) public static function CheckMenuIdEnabled($sMenuId)
{ {
if (self::IsMenuIdEnabled($sMenuId) === false) if (self::IsMenuIdEnabled($sMenuId) === false) {
{
require_once(APPROOT.'/setup/setuppage.class.inc.php'); require_once(APPROOT.'/setup/setuppage.class.inc.php');
$oP = new ErrorPage(Dict::S('UI:PageTitle:FatalError')); $oP = new ErrorPage(Dict::S('UI:PageTitle:FatalError'));
$oP->add("<h1>".Dict::S('UI:Login:Error:AccessRestricted')."</h1>\n"); $oP->add("<h1>".Dict::S('UI:Login:Error:AccessRestricted')."</h1>\n");
@@ -159,22 +155,18 @@ class ApplicationMenu
public static function InsertMenu(MenuNode $oMenuNode, $iParentIndex, $fRank) public static function InsertMenu(MenuNode $oMenuNode, $iParentIndex, $fRank)
{ {
$index = self::GetMenuIndexById($oMenuNode->GetMenuId()); $index = self::GetMenuIndexById($oMenuNode->GetMenuId());
if ($index == -1) if ($index == -1) {
{
// The menu does not already exist, insert it // The menu does not already exist, insert it
$index = count(self::$aMenusIndex); $index = count(self::$aMenusIndex);
if ($iParentIndex == -1) if ($iParentIndex == -1) {
{
$sParentId = ''; $sParentId = '';
self::$aRootMenus[] = array ('rank' => $fRank, 'index' => $index); self::$aRootMenus[] = ['rank' => $fRank, 'index' => $index];
} } else {
else
{
/** @var \MenuNode $oNode */ /** @var \MenuNode $oNode */
$oNode = self::$aMenusIndex[$iParentIndex]['node']; $oNode = self::$aMenusIndex[$iParentIndex]['node'];
$sParentId = $oNode->GetMenuId(); $sParentId = $oNode->GetMenuId();
self::$aMenusIndex[$iParentIndex]['children'][] = array ('rank' => $fRank, 'index' => $index); self::$aMenusIndex[$iParentIndex]['children'][] = ['rank' => $fRank, 'index' => $index];
} }
// Note: At the time when 'parent', 'rank' and 'source_file' have been added for the reflection API, // Note: At the time when 'parent', 'rank' and 'source_file' have been added for the reflection API,
@@ -182,11 +174,9 @@ class ApplicationMenu
// //
$aBacktrace = debug_backtrace(); $aBacktrace = debug_backtrace();
$sFile = isset($aBacktrace[2]["file"]) ? $aBacktrace[2]["file"] : $aBacktrace[1]["file"]; $sFile = isset($aBacktrace[2]["file"]) ? $aBacktrace[2]["file"] : $aBacktrace[1]["file"];
self::$aMenusIndex[$index] = array('node' => $oMenuNode, 'children' => array(), 'parent' => $sParentId, 'rank' => $fRank, 'source_file' => $sFile); self::$aMenusIndex[$index] = ['node' => $oMenuNode, 'children' => [], 'parent' => $sParentId, 'rank' => $fRank, 'source_file' => $sFile];
self::$aMenusById[$oMenuNode->GetMenuId()] = $index; self::$aMenusById[$oMenuNode->GetMenuId()] = $index;
} } else {
else
{
// the menu already exists, let's combine the conditions that make it visible // the menu already exists, let's combine the conditions that make it visible
/** @var \MenuNode $oNode */ /** @var \MenuNode $oNode */
$oNode = self::$aMenusIndex[$index]['node']; $oNode = self::$aMenusIndex[$index]['node'];
@@ -216,7 +206,7 @@ class ApplicationMenu
* @throws \DictExceptionMissingString * @throws \DictExceptionMissingString
* @since 3.0.0 * @since 3.0.0
*/ */
public static function GetMenusCount($aExtraParams = array()) public static function GetMenusCount($aExtraParams = [])
{ {
$aMenuGroups = static::GetMenuGroups($aExtraParams); $aMenuGroups = static::GetMenuGroups($aExtraParams);
@@ -259,18 +249,16 @@ class ApplicationMenu
* @throws \DictExceptionMissingString * @throws \DictExceptionMissingString
* @since 3.0.0 * @since 3.0.0
*/ */
public static function GetMenuGroups($aExtraParams = array()) public static function GetMenuGroups($aExtraParams = [])
{ {
self::LoadAdditionalMenus(); self::LoadAdditionalMenus();
// Sort the root menu based on the rank // Sort the root menu based on the rank
usort(self::$aRootMenus, array('ApplicationMenu', 'CompareOnRank')); usort(self::$aRootMenus, ['ApplicationMenu', 'CompareOnRank']);
$aMenuGroups = []; $aMenuGroups = [];
foreach(static::$aRootMenus as $aMenuGroup) foreach (static::$aRootMenus as $aMenuGroup) {
{ if (!static::CanDisplayMenu($aMenuGroup)) {
if(!static::CanDisplayMenu($aMenuGroup))
{
continue; continue;
} }
@@ -321,26 +309,23 @@ class ApplicationMenu
* @throws \Exception * @throws \Exception
* @since 3.0.0 * @since 3.0.0
*/ */
public static function GetSubMenuNodes($sMenuGroupIdx, $aExtraParams = array()) public static function GetSubMenuNodes($sMenuGroupIdx, $aExtraParams = [])
{ {
$aSubMenuItems = self::GetChildren($sMenuGroupIdx); $aSubMenuItems = self::GetChildren($sMenuGroupIdx);
// Sort the children based on the rank // Sort the children based on the rank
usort($aSubMenuItems, array('ApplicationMenu', 'CompareOnRank')); usort($aSubMenuItems, ['ApplicationMenu', 'CompareOnRank']);
$aSubMenuNodes = []; $aSubMenuNodes = [];
foreach($aSubMenuItems as $aSubMenuItem) foreach ($aSubMenuItems as $aSubMenuItem) {
{ if (!static::CanDisplayMenu($aSubMenuItem)) {
if(!static::CanDisplayMenu($aSubMenuItem))
{
continue; continue;
} }
$sSubMenuItemIdx = $aSubMenuItem['index']; $sSubMenuItemIdx = $aSubMenuItem['index'];
$oSubMenuNode = static::GetMenuNode($sSubMenuItemIdx); $oSubMenuNode = static::GetMenuNode($sSubMenuItemIdx);
if(!$oSubMenuNode->IsEnabled()) if (!$oSubMenuNode->IsEnabled()) {
{
continue; continue;
} }
@@ -366,21 +351,15 @@ class ApplicationMenu
private static function CanDisplayMenu($aMenu) private static function CanDisplayMenu($aMenu)
{ {
$oMenuNode = self::GetMenuNode($aMenu['index']); $oMenuNode = self::GetMenuNode($aMenu['index']);
if ($oMenuNode->IsEnabled()) if ($oMenuNode->IsEnabled()) {
{
$aChildren = self::GetChildren($aMenu['index']); $aChildren = self::GetChildren($aMenu['index']);
if (count($aChildren) > 0) if (count($aChildren) > 0) {
{ foreach ($aChildren as $aSubMenu) {
foreach($aChildren as $aSubMenu) if (self::CanDisplayMenu($aSubMenu)) {
{
if (self::CanDisplayMenu($aSubMenu))
{
return true; return true;
} }
} }
} } else {
else
{
return true; return true;
} }
} }
@@ -396,12 +375,10 @@ class ApplicationMenu
public static function CompareOnRank($a, $b) public static function CompareOnRank($a, $b)
{ {
$result = 1; $result = 1;
if ($a['rank'] == $b['rank']) if ($a['rank'] == $b['rank']) {
{
$result = 0; $result = 0;
} }
if ($a['rank'] < $b['rank']) if ($a['rank'] < $b['rank']) {
{
$result = -1; $result = -1;
} }
return $result; return $result;
@@ -449,8 +426,7 @@ class ApplicationMenu
{ {
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$sMenuId = $oAppContext->GetCurrentValue('menu', null); $sMenuId = $oAppContext->GetCurrentValue('menu', null);
if ($sMenuId === null) if ($sMenuId === null) {
{
$sMenuId = self::GetDefaultMenuId(); $sMenuId = self::GetDefaultMenuId();
} }
return $sMenuId; return $sMenuId;
@@ -462,13 +438,12 @@ class ApplicationMenu
public static function GetDefaultMenuId() public static function GetDefaultMenuId()
{ {
static $sDefaultMenuId = null; static $sDefaultMenuId = null;
if (is_null($sDefaultMenuId)) if (is_null($sDefaultMenuId)) {
{
// Make sure the root menu is sorted on 'rank' // Make sure the root menu is sorted on 'rank'
usort(self::$aRootMenus, array('ApplicationMenu', 'CompareOnRank')); usort(self::$aRootMenus, ['ApplicationMenu', 'CompareOnRank']);
$oFirstGroup = self::GetMenuNode(self::$aRootMenus[0]['index']); $oFirstGroup = self::GetMenuNode(self::$aRootMenus[0]['index']);
$aChildren = self::$aMenusIndex[$oFirstGroup->GetIndex()]['children']; $aChildren = self::$aMenusIndex[$oFirstGroup->GetIndex()]['children'];
usort($aChildren, array('ApplicationMenu', 'CompareOnRank')); usort($aChildren, ['ApplicationMenu', 'CompareOnRank']);
$oMenuNode = self::GetMenuNode($aChildren[0]['index']); $oMenuNode = self::GetMenuNode($aChildren[0]['index']);
$sDefaultMenuId = $oMenuNode->GetMenuId(); $sDefaultMenuId = $oMenuNode->GetMenuId();
} }
@@ -482,13 +457,11 @@ class ApplicationMenu
public static function GetRootMenuId($sMenuId) public static function GetRootMenuId($sMenuId)
{ {
$iMenuIndex = self::GetMenuIndexById($sMenuId); $iMenuIndex = self::GetMenuIndexById($sMenuId);
if ($iMenuIndex == -1) if ($iMenuIndex == -1) {
{
return ''; return '';
} }
$oMenu = ApplicationMenu::GetMenuNode($iMenuIndex); $oMenu = ApplicationMenu::GetMenuNode($iMenuIndex);
while ($oMenu->GetParentIndex() != -1) while ($oMenu->GetParentIndex() != -1) {
{
$oMenu = ApplicationMenu::GetMenuNode($oMenu->GetParentIndex()); $oMenu = ApplicationMenu::GetMenuNode($oMenu->GetParentIndex());
} }
return $oMenu->GetMenuId(); return $oMenu->GetMenuId();
@@ -575,17 +548,17 @@ abstract class MenuNode
{ {
$this->sMenuId = $sMenuId; $this->sMenuId = $sMenuId;
$this->iParentIndex = $iParentIndex; $this->iParentIndex = $iParentIndex;
$this->aReflectionProperties = array(); $this->aReflectionProperties = [];
if (utils::IsNotNullOrEmptyString($sEnableClass)) { if (utils::IsNotNullOrEmptyString($sEnableClass)) {
$this->aReflectionProperties['enable_class'] = $sEnableClass; $this->aReflectionProperties['enable_class'] = $sEnableClass;
$this->aReflectionProperties['enable_action'] = $iActionCode; $this->aReflectionProperties['enable_action'] = $iActionCode;
$this->aReflectionProperties['enable_permission'] = $iAllowedResults; $this->aReflectionProperties['enable_permission'] = $iAllowedResults;
$this->aReflectionProperties['enable_stimulus'] = $sEnableStimulus; $this->aReflectionProperties['enable_stimulus'] = $sEnableStimulus;
} }
$this->m_aEnableClasses = array($sEnableClass); $this->m_aEnableClasses = [$sEnableClass];
$this->m_aEnableActions = array($iActionCode); $this->m_aEnableActions = [$iActionCode];
$this->m_aEnableActionResults = array($iAllowedResults); $this->m_aEnableActionResults = [$iAllowedResults];
$this->m_aEnableStimuli = array($sEnableStimulus); $this->m_aEnableStimuli = [$sEnableStimulus];
$this->index = ApplicationMenu::InsertMenu($this, $iParentIndex, $fRank); $this->index = ApplicationMenu::InsertMenu($this, $iParentIndex, $fRank);
} }
@@ -639,7 +612,6 @@ abstract class MenuNode
$oSearch->SetShowObsoleteData(utils::ShowObsoleteData()); $oSearch->SetShowObsoleteData(utils::ShowObsoleteData());
DBSearchHelper::AddContextFilter($oSearch); DBSearchHelper::AddContextFilter($oSearch);
$oSet = new DBObjectSet($oSearch); $oSet = new DBObjectSet($oSearch);
$iCount = $oSet->CountWithLimit(99); $iCount = $oSet->CountWithLimit(99);
if ($iCount > 99) { if ($iCount > 99) {
@@ -690,8 +662,7 @@ abstract class MenuNode
*/ */
public function PopulateChildMenus() public function PopulateChildMenus()
{ {
foreach (ApplicationMenu::GetChildren($this->GetIndex()) as $aMenu) foreach (ApplicationMenu::GetChildren($this->GetIndex()) as $aMenu) {
{
$index = $aMenu['index']; $index = $aMenu['index'];
$oMenu = ApplicationMenu::GetMenuNode($index); $oMenu = ApplicationMenu::GetMenuNode($index);
$oMenu->PopulateChildMenus(); $oMenu->PopulateChildMenus();
@@ -726,8 +697,7 @@ abstract class MenuNode
*/ */
public function AddCondition(MenuNode $oMenuNode) public function AddCondition(MenuNode $oMenuNode)
{ {
foreach($oMenuNode->m_aEnableClasses as $index => $sClass ) foreach ($oMenuNode->m_aEnableClasses as $index => $sClass) {
{
$this->m_aEnableClasses[] = $sClass; $this->m_aEnableClasses[] = $sClass;
$this->m_aEnableActions[] = $oMenuNode->m_aEnableActions[$index]; $this->m_aEnableActions[] = $oMenuNode->m_aEnableActions[$index];
$this->m_aEnableActionResults[] = $oMenuNode->m_aEnableActionResults[$index]; $this->m_aEnableActionResults[] = $oMenuNode->m_aEnableActionResults[$index];
@@ -740,33 +710,24 @@ abstract class MenuNode
*/ */
public function IsEnabled() public function IsEnabled()
{ {
foreach($this->m_aEnableClasses as $index => $sClass) foreach ($this->m_aEnableClasses as $index => $sClass) {
{ if ($sClass != null) {
if ($sClass != null) if (MetaModel::IsValidClass($sClass)) {
{ if ($this->m_aEnableStimuli[$index] != null) {
if (MetaModel::IsValidClass($sClass)) if (!UserRights::IsStimulusAllowed($sClass, $this->m_aEnableStimuli[$index])) {
{
if ($this->m_aEnableStimuli[$index] != null)
{
if (!UserRights::IsStimulusAllowed($sClass, $this->m_aEnableStimuli[$index]))
{
return false; return false;
} }
} }
if ($this->m_aEnableActions[$index] != null) if ($this->m_aEnableActions[$index] != null) {
{
// Menus access rights ignore the archive mode // Menus access rights ignore the archive mode
utils::PushArchiveMode(false); utils::PushArchiveMode(false);
$iResult = UserRights::IsActionAllowed($sClass, $this->m_aEnableActions[$index]); $iResult = UserRights::IsActionAllowed($sClass, $this->m_aEnableActions[$index]);
utils::PopArchiveMode(); utils::PopArchiveMode();
if (!($iResult & $this->m_aEnableActionResults[$index])) if (!($iResult & $this->m_aEnableActionResults[$index])) {
{
return false; return false;
} }
} }
} } else {
else
{
return false; return false;
} }
} }
@@ -779,7 +740,7 @@ abstract class MenuNode
* @param array $aExtraParams * @param array $aExtraParams
* @return mixed * @return mixed
*/ */
public abstract function RenderContent(WebPage $oPage, $aExtraParams = array()); abstract public function RenderContent(WebPage $oPage, $aExtraParams = []);
/** /**
* @param string $sHyperlink * @param string $sHyperlink
@@ -788,16 +749,13 @@ abstract class MenuNode
*/ */
protected function AddParams($sHyperlink, $aExtraParams) protected function AddParams($sHyperlink, $aExtraParams)
{ {
if (count($aExtraParams) > 0) if (count($aExtraParams) > 0) {
{ $aQuery = [];
$aQuery = array();
$sSeparator = '?'; $sSeparator = '?';
if (strpos($sHyperlink, '?') !== false) if (strpos($sHyperlink, '?') !== false) {
{
$sSeparator = '&'; $sSeparator = '&';
} }
foreach($aExtraParams as $sName => $sValue) foreach ($aExtraParams as $sName => $sValue) {
{
$aQuery[] = urlencode($sName).'='.urlencode($sValue); $aQuery[] = urlencode($sName).'='.urlencode($sValue);
} }
$sHyperlink .= $sSeparator.implode('&', $aQuery); $sHyperlink .= $sSeparator.implode('&', $aQuery);
@@ -813,7 +771,7 @@ abstract class MenuNode
class MenuGroup extends MenuNode class MenuGroup extends MenuNode
{ {
/** @var string DEFAULT_DECORATION_CLASSES Set to null by default so it is replaced by initials when none is specified */ /** @var string DEFAULT_DECORATION_CLASSES Set to null by default so it is replaced by initials when none is specified */
const DEFAULT_DECORATION_CLASSES = null; public const DEFAULT_DECORATION_CLASSES = null;
/** @var string The CSS classes used to display the menu group's icon */ /** @var string The CSS classes used to display the menu group's icon */
protected $sDecorationClasses = self::DEFAULT_DECORATION_CLASSES; protected $sDecorationClasses = self::DEFAULT_DECORATION_CLASSES;
@@ -833,8 +791,7 @@ class MenuGroup extends MenuNode
{ {
parent::__construct($sMenuId, -1 /* no parent, groups are at root level */, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus); parent::__construct($sMenuId, -1 /* no parent, groups are at root level */, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
if(!empty($sDecorationClasses)) if (!empty($sDecorationClasses)) {
{
$this->sDecorationClasses = $sDecorationClasses; $this->sDecorationClasses = $sDecorationClasses;
} }
} }
@@ -875,7 +832,7 @@ class MenuGroup extends MenuNode
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
assert(false); // Shall never be called, groups do not display any content assert(false); // Shall never be called, groups do not display any content
} }
@@ -887,7 +844,6 @@ class MenuGroup extends MenuNode
*/ */
class TemplateMenuNode extends MenuNode class TemplateMenuNode extends MenuNode
{ {
/** /**
* Create a menu item based on a custom template and inserts it into the application's main menu * Create a menu item based on a custom template and inserts it into the application's main menu
* @param string $sMenuId Unique identifier of the menu (used to identify the menu for bookmarking, and for getting the labels from the dictionary) * @param string $sMenuId Unique identifier of the menu (used to identify the menu for bookmarking, and for getting the labels from the dictionary)
@@ -903,12 +859,18 @@ class TemplateMenuNode extends MenuNode
{ {
parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus); parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
} }
/**
* @inheritDoc
*/
public function GetHyperlink($aExtraParams)
{
return '';
}
/** /**
* @inheritDoc * @inheritDoc
* @throws \Exception * @throws \Exception
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
//DO NOTHING this type of menu is only used for title not clickable //DO NOTHING this type of menu is only used for title not clickable
} }
@@ -942,7 +904,6 @@ class OQLMenuNode extends MenuNode
*/ */
protected $m_aParams; protected $m_aParams;
/** /**
* Create a menu item based on an OQL query and inserts it into the application's main menu * Create a menu item based on an OQL query and inserts it into the application's main menu
* @param string $sMenuId Unique identifier of the menu (used to identify the menu for bookmarking, and for getting the labels from the dictionary) * @param string $sMenuId Unique identifier of the menu (used to identify the menu for bookmarking, and for getting the labels from the dictionary)
@@ -963,7 +924,7 @@ class OQLMenuNode extends MenuNode
$this->sOQL = $sOQL; $this->sOQL = $sOQL;
$this->bSearch = $bSearch; $this->bSearch = $bSearch;
$this->bSearchFormOpen = $bSearchFormOpen; $this->bSearchFormOpen = $bSearchFormOpen;
$this->m_aParams = array(); $this->m_aParams = [];
$this->aReflectionProperties['oql'] = $sOQL; $this->aReflectionProperties['oql'] = $sOQL;
$this->aReflectionProperties['do_search'] = $bSearch; $this->aReflectionProperties['do_search'] = $bSearch;
// Enhancement: we could set as the "enable" condition that the user has enough rights to "read" the objects // Enhancement: we could set as the "enable" condition that the user has enough rights to "read" the objects
@@ -977,8 +938,7 @@ class OQLMenuNode extends MenuNode
public function SetParameters($aParams) public function SetParameters($aParams)
{ {
$this->m_aParams = $aParams; $this->m_aParams = $aParams;
foreach($aParams as $sKey => $value) foreach ($aParams as $sKey => $value) {
{
$this->aReflectionProperties[$sKey] = $value; $this->aReflectionProperties[$sKey] = $value;
} }
} }
@@ -987,12 +947,11 @@ class OQLMenuNode extends MenuNode
* @inheritDoc * @inheritDoc
* @throws \Exception * @throws \Exception
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
$oTag = new ContextTag(ContextTag::TAG_OBJECT_SEARCH); $oTag = new ContextTag(ContextTag::TAG_OBJECT_SEARCH);
ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId()); ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId());
OQLMenuNode::RenderOQLSearch OQLMenuNode::RenderOQLSearch(
(
$this->sOQL, $this->sOQL,
Dict::S($this->sPageTitle), Dict::S($this->sPageTitle),
'Menu_'.$this->GetMenuId(), 'Menu_'.$this->GetMenuId(),
@@ -1017,7 +976,7 @@ class OQLMenuNode extends MenuNode
* @throws DictExceptionMissingString * @throws DictExceptionMissingString
* @throws OQLException * @throws OQLException
*/ */
public static function RenderOQLSearch($sOql, $sTitle, $sUsageId, $bSearchPane, $bSearchOpen, WebPage $oPage, $aExtraParams = array(), $bEnableBreadcrumb = false) public static function RenderOQLSearch($sOql, $sTitle, $sUsageId, $bSearchPane, $bSearchOpen, WebPage $oPage, $aExtraParams = [], $bEnableBreadcrumb = false)
{ {
$sUsageId = utils::GetSafeId($sUsageId); $sUsageId = utils::GetSafeId($sUsageId);
$oSearch = DBObjectSearch::FromOQL($sOql); $oSearch = DBObjectSearch::FromOQL($sOql);
@@ -1028,15 +987,14 @@ class OQLMenuNode extends MenuNode
$oBlock = new DisplayBlock($oSearch, DisplayBlock::ENUM_STYLE_SEARCH, false /* Asynchronous */, $aParams); $oBlock = new DisplayBlock($oSearch, DisplayBlock::ENUM_STYLE_SEARCH, false /* Asynchronous */, $aParams);
$oBlock->Display($oPage, 0); $oBlock->Display($oPage, 0);
$oPage->add("<div class='sf_results_area ibo-add-margin-top-250' data-target='search_results'>"); $oPage->add("<div class='sf_results_area ibo-add-margin-top-250' data-target='search_results'>");
} } else {
else {
$oPage->add("<div class='sf_results_area' data-target='search_results'>"); $oPage->add("<div class='sf_results_area' data-target='search_results'>");
} }
$aExtraParams['panel_class'] = $sClass; $aExtraParams['panel_class'] = $sClass;
$aExtraParams['panel_title'] = $sTitle; $aExtraParams['panel_title'] = $sTitle;
$aExtraParams['panel_icon'] = $sIcon; $aExtraParams['panel_icon'] = $sIcon;
$aParams = array_merge(array('table_id' => $sUsageId), $aExtraParams); $aParams = array_merge(['table_id' => $sUsageId], $aExtraParams);
$oBlock = new DisplayBlock($oSearch, 'list', false /* Asynchronous */, $aParams); $oBlock = new DisplayBlock($oSearch, 'list', false /* Asynchronous */, $aParams);
$oBlock->Display($oPage, $sUsageId); $oBlock->Display($oPage, $sUsageId);
@@ -1101,14 +1059,14 @@ class SearchMenuNode extends MenuNode
* @throws \DictExceptionMissingString * @throws \DictExceptionMissingString
* @throws \Exception * @throws \Exception
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId()); ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId());
$oPage->SetBreadCrumbEntry("menu-".$this->sMenuId, $this->GetTitle(), '', '', 'fas fa-search', iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES); $oPage->SetBreadCrumbEntry("menu-".$this->sMenuId, $this->GetTitle(), '', '', 'fas fa-search', iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES);
$oSearch = new DBObjectSearch($this->sClass); $oSearch = new DBObjectSearch($this->sClass);
$sUsageId = 'Menu_'.utils::GetSafeId($this->GetMenuId()); $sUsageId = 'Menu_'.utils::GetSafeId($this->GetMenuId());
$aParams = array_merge(array('table_id' =>$sUsageId), $aExtraParams); $aParams = array_merge(['table_id' => $sUsageId], $aExtraParams);
$oBlock = new DisplayBlock($oSearch, 'search', false /* Asynchronous */, $aParams); $oBlock = new DisplayBlock($oSearch, 'search', false /* Asynchronous */, $aParams);
$oBlock->Display($oPage, 0); $oBlock->Display($oPage, 0);
} }
@@ -1145,10 +1103,16 @@ class WebPageMenuNode extends MenuNode
* @param bool $bIsLinkInNewWindow for the {@link WebPageMenuNode::IsHyperLinkInNewWindow} method * @param bool $bIsLinkInNewWindow for the {@link WebPageMenuNode::IsHyperLinkInNewWindow} method
*/ */
public function __construct( public function __construct(
$sMenuId, $sHyperlink, $iParentIndex, $fRank = 0.0, $sEnableClass = null, $iActionCode = null, $sMenuId,
$iAllowedResults = UR_ALLOWED_YES, $sEnableStimulus = null, $bIsLinkInNewWindow = false $sHyperlink,
) $iParentIndex,
{ $fRank = 0.0,
$sEnableClass = null,
$iActionCode = null,
$iAllowedResults = UR_ALLOWED_YES,
$sEnableStimulus = null,
$bIsLinkInNewWindow = false
) {
parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus); parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
$this->sHyperlink = $sHyperlink; $this->sHyperlink = $sHyperlink;
$this->aReflectionProperties['url'] = $sHyperlink; $this->aReflectionProperties['url'] = $sHyperlink;
@@ -1175,7 +1139,7 @@ class WebPageMenuNode extends MenuNode
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
assert(false); // Shall never be called, the external web page will handle the display by itself assert(false); // Shall never be called, the external web page will handle the display by itself
} }
@@ -1236,10 +1200,8 @@ class NewObjectMenuNode extends MenuNode
$aSubClasses = MetaModel::EnumChildClasses($this->sClass, ENUM_CHILD_CLASSES_ALL); // Including the specified class itself $aSubClasses = MetaModel::EnumChildClasses($this->sClass, ENUM_CHILD_CLASSES_ALL); // Including the specified class itself
$bActionIsAllowed = false; $bActionIsAllowed = false;
foreach($aSubClasses as $sCandidateClass) foreach ($aSubClasses as $sCandidateClass) {
{ if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES)) {
if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
{
$bActionIsAllowed = true; $bActionIsAllowed = true;
break; // Enough for now break; // Enough for now
} }
@@ -1250,7 +1212,7 @@ class NewObjectMenuNode extends MenuNode
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
assert(false); // Shall never be called, the external web page will handle the display by itself assert(false); // Shall never be called, the external web page will handle the display by itself
} }
@@ -1290,7 +1252,9 @@ class DashboardMenuNode extends MenuNode
*/ */
public function GetHyperlink($aExtraParams) public function GetHyperlink($aExtraParams)
{ {
if ($this->sDashboardFile == '') return ''; if ($this->sDashboardFile == '') {
return '';
}
return parent::GetHyperlink($aExtraParams); return parent::GetHyperlink($aExtraParams);
} }
@@ -1308,12 +1272,11 @@ class DashboardMenuNode extends MenuNode
* @inheritDoc * @inheritDoc
* @throws \Exception * @throws \Exception
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId()); ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId());
$oDashboard = $this->GetDashboard(); $oDashboard = $this->GetDashboard();
if ($oDashboard != null) if ($oDashboard != null) {
{
WebResourcesHelper::EnableC3JSToWebPage($oPage); WebResourcesHelper::EnableC3JSToWebPage($oPage);
$sDivId = utils::Sanitize($this->sMenuId, '', 'element_identifier'); $sDivId = utils::Sanitize($this->sMenuId, '', 'element_identifier');
@@ -1344,9 +1307,7 @@ class DashboardMenuNode extends MenuNode
} }
$oPage->SetBreadCrumbEntry("ui-dashboard-".$this->sMenuId, $this->GetTitle(), $sDescription, '', $sIcon, iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES); $oPage->SetBreadCrumbEntry("ui-dashboard-".$this->sMenuId, $this->GetTitle(), $sDescription, '', $sIcon, iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES);
} }
} } else {
else
{
$oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'"); $oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'");
} }
} }
@@ -1359,12 +1320,9 @@ class DashboardMenuNode extends MenuNode
public function RenderEditor(WebPage $oPage) public function RenderEditor(WebPage $oPage)
{ {
$oDashboard = $this->GetDashboard(); $oDashboard = $this->GetDashboard();
if ($oDashboard != null) if ($oDashboard != null) {
{
$oDashboard->RenderEditor($oPage); $oDashboard->RenderEditor($oPage);
} } else {
else
{
$oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'"); $oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'");
} }
} }
@@ -1376,13 +1334,10 @@ class DashboardMenuNode extends MenuNode
public function AddDashlet($oDashlet) public function AddDashlet($oDashlet)
{ {
$oDashboard = $this->GetDashboard(); $oDashboard = $this->GetDashboard();
if ($oDashboard != null) if ($oDashboard != null) {
{
$oDashboard->AddDashlet($oDashlet); $oDashboard->AddDashlet($oDashlet);
$oDashboard->Save(); $oDashboard->Save();
} } else {
else
{
throw new Exception("Error: failed to load dashboard file: '{$this->sDashboardFile}'"); throw new Exception("Error: failed to load dashboard file: '{$this->sDashboardFile}'");
} }
} }
@@ -1405,7 +1360,7 @@ class ShortcutContainerMenuNode extends MenuNode
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
} }
@@ -1420,10 +1375,9 @@ class ShortcutContainerMenuNode extends MenuNode
// //
$oBMSearch = new DBObjectSearch('Shortcut'); $oBMSearch = new DBObjectSearch('Shortcut');
$oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '='); $oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
$oBMSet = new DBObjectSet($oBMSearch, array('friendlyname' => true)); // ascending on friendlyname $oBMSet = new DBObjectSet($oBMSearch, ['friendlyname' => true]); // ascending on friendlyname
$fRank = 1; $fRank = 1;
while ($oShortcut = $oBMSet->Fetch()) while ($oShortcut = $oBMSet->Fetch()) {
{
$sName = $this->GetMenuId().'_'.$oShortcut->GetKey(); $sName = $this->GetMenuId().'_'.$oShortcut->GetKey();
new ShortcutMenuNode($sName, $oShortcut, $this->GetIndex(), $fRank++); new ShortcutMenuNode($sName, $oShortcut, $this->GetIndex(), $fRank++);
} }
@@ -1434,7 +1388,6 @@ class ShortcutContainerMenuNode extends MenuNode
} }
} }
require_once(APPROOT.'application/shortcut.class.inc.php'); require_once(APPROOT.'application/shortcut.class.inc.php');
/** /**
* This class defines a menu item which content is a shortcut. * This class defines a menu item which content is a shortcut.
@@ -1471,12 +1424,10 @@ class ShortcutMenuNode extends MenuNode
{ {
$sContext = $this->oShortcut->Get('context'); $sContext = $this->oShortcut->Get('context');
$aContext = unserialize($sContext); $aContext = unserialize($sContext);
if (isset($aContext['menu'])) if (isset($aContext['menu'])) {
{
unset($aContext['menu']); unset($aContext['menu']);
} }
foreach ($aContext as $sArgName => $sArgValue) foreach ($aContext as $sArgName => $sArgValue) {
{
$aExtraParams[$sArgName] = $sArgValue; $aExtraParams[$sArgName] = $sArgValue;
} }
return parent::GetHyperlink($aExtraParams); return parent::GetHyperlink($aExtraParams);
@@ -1486,7 +1437,7 @@ class ShortcutMenuNode extends MenuNode
* @inheritDoc * @inheritDoc
* @throws \Exception * @throws \Exception
*/ */
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId()); ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId());
$this->oShortcut->RenderContent($oPage, $aExtraParams); $this->oShortcut->RenderContent($oPage, $aExtraParams);
@@ -1523,11 +1474,9 @@ class ShortcutMenuNode extends MenuNode
return true; return true;
} }
public function GetEntriesCount() public function GetEntriesCount()
{ {
return $this->GetEntriesCountFromOQL($this->oShortcut->Get('oql')); return $this->GetEntriesCountFromOQL($this->oShortcut->Get('oql'));
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -118,25 +119,25 @@ abstract class NewsroomProviderBase implements iNewsroomProvider
* {@inheritDoc} * {@inheritDoc}
* @see iNewsroomProvider::GetLabel() * @see iNewsroomProvider::GetLabel()
*/ */
public abstract function GetLabel(); abstract public function GetLabel();
/** /**
* {@inheritDoc} * {@inheritDoc}
* @see iNewsroomProvider::GetFetchURL() * @see iNewsroomProvider::GetFetchURL()
*/ */
public abstract function GetFetchURL(); abstract public function GetFetchURL();
/** /**
* {@inheritDoc} * {@inheritDoc}
* @see iNewsroomProvider::GetMarkAllURL() * @see iNewsroomProvider::GetMarkAllURL()
*/ */
public abstract function GetMarkAllAsReadURL(); abstract public function GetMarkAllAsReadURL();
/** /**
* {@inheritDoc} * {@inheritDoc}
* @see iNewsroomProvider::GetViewAllURL() * @see iNewsroomProvider::GetViewAllURL()
*/ */
public abstract function GetViewAllURL(); abstract public function GetViewAllURL();
public function IsApplicable(User $oUser = null) public function IsApplicable(User $oUser = null)
{ {
@@ -149,7 +150,7 @@ abstract class NewsroomProviderBase implements iNewsroomProvider
*/ */
public function GetPlaceholders() public function GetPlaceholders()
{ {
return array(); // By default, empty set of placeholders return []; // By default, empty set of placeholders
} }
public function GetTTL() public function GetTTL()

View File

@@ -1,4 +1,5 @@
<?php <?php
class PortalDispatcher class PortalDispatcher
{ {
protected $sPortalid; protected $sPortalid;
@@ -21,25 +22,20 @@ class PortalDispatcher
$bRet = true; $bRet = true;
$aProfiles = UserRights::ListProfiles($oUser); $aProfiles = UserRights::ListProfiles($oUser);
foreach($this->aData['deny'] as $sDeniedProfile) foreach ($this->aData['deny'] as $sDeniedProfile) {
{
// If one denied profile is present, it's enough => return false // If one denied profile is present, it's enough => return false
if (in_array($sDeniedProfile, $aProfiles)) if (in_array($sDeniedProfile, $aProfiles)) {
{
return false; return false;
} }
} }
// If there are some "allow" profiles, then by default the result is false // If there are some "allow" profiles, then by default the result is false
// since the user must have at least one of the profiles to be allowed // since the user must have at least one of the profiles to be allowed
if (count($this->aData['allow']) > 0) if (count($this->aData['allow']) > 0) {
{
$bRet = false; $bRet = false;
} }
foreach($this->aData['allow'] as $sAllowProfile) foreach ($this->aData['allow'] as $sAllowProfile) {
{
// If one "allow" profile is present, it's enough => return true // If one "allow" profile is present, it's enough => return true
if (in_array($sAllowProfile, $aProfiles)) if (in_array($sAllowProfile, $aProfiles)) {
{
return true; return true;
} }
} }
@@ -49,12 +45,9 @@ class PortalDispatcher
public function GetURL() public function GetURL()
{ {
$aOverloads = MetaModel::GetConfig()->Get('portal_dispatch_urls'); $aOverloads = MetaModel::GetConfig()->Get('portal_dispatch_urls');
if (array_key_exists($this->sPortalid, $aOverloads)) if (array_key_exists($this->sPortalid, $aOverloads)) {
{
$sRet = $aOverloads[$this->sPortalid]; $sRet = $aOverloads[$this->sPortalid];
} } else {
else
{
$sRet = utils::GetAbsoluteUrlAppRoot().$this->aData['url']; $sRet = utils::GetAbsoluteUrlAppRoot().$this->aData['url'];
} }
return $sRet; return $sRet;

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* Copyright (C) 2010-2024 Combodo SAS * Copyright (C) 2010-2024 Combodo SAS
* *
@@ -31,101 +32,108 @@ abstract class Query extends cmdbAbstractObject
*/ */
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "core/cmdb,view_in_gui,application,grant_by_profile", "category" => "core/cmdb,view_in_gui,application,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_query", "db_table" => "priv_query",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "realclass", "db_finalclass_field" => "realclass",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeString("name", array( MetaModel::Init_AddAttribute(new AttributeString("name", [
"allowed_values" => null, "allowed_values" => null,
"sql" => "name", "sql" => "name",
"default_value" => null, "default_value" => null,
"is_null_allowed" => false, "is_null_allowed" => false,
"depends_on" => array(), "depends_on" => [],
))); ]));
MetaModel::Init_AddAttribute(new AttributeText("description", array( MetaModel::Init_AddAttribute(new AttributeText("description", [
"allowed_values" => null, "allowed_values" => null,
"sql" => "description", "sql" => "description",
"default_value" => null, "default_value" => null,
"is_null_allowed" => false, "is_null_allowed" => false,
"depends_on" => array(), "depends_on" => [],
))); ]));
MetaModel::Init_AddAttribute(new AttributeEnum("is_template", array( MetaModel::Init_AddAttribute(new AttributeEnum("is_template", [
'allowed_values' => new ValueSetEnum('yes,no'), 'allowed_values' => new ValueSetEnum('yes,no'),
'sql' => 'is_template', 'sql' => 'is_template',
'default_value' => 'no', 'default_value' => 'no',
'is_null_allowed' => false, 'is_null_allowed' => false,
'depends_on' => [], 'depends_on' => [],
'display_style' => 'radio_horizontal', 'display_style' => 'radio_horizontal',
))); ]));
MetaModel::Init_AddAttribute(new AttributeInteger("export_count", array( MetaModel::Init_AddAttribute(new AttributeInteger("export_count", [
"allowed_values" => null, "allowed_values" => null,
"sql" => "export_count", "sql" => "export_count",
"default_value" => 0, "default_value" => 0,
"is_null_allowed" => false, "is_null_allowed" => false,
"depends_on" => array(), "depends_on" => [],
"tracking_level" => ATTRIBUTE_TRACKING_NONE, "tracking_level" => ATTRIBUTE_TRACKING_NONE,
))); ]));
MetaModel::Init_AddAttribute(new AttributeDateTime("export_last_date", array( MetaModel::Init_AddAttribute(new AttributeDateTime("export_last_date", [
"allowed_values" => null, "allowed_values" => null,
"sql" => "export_last_date", "sql" => "export_last_date",
"default_value" => null, "default_value" => null,
"is_null_allowed" => true, "is_null_allowed" => true,
"depends_on" => array(), "depends_on" => [],
"tracking_level" => ATTRIBUTE_TRACKING_NONE, "tracking_level" => ATTRIBUTE_TRACKING_NONE,
))); ]));
MetaModel::Init_AddAttribute(new AttributeExternalKey("export_last_user_id", MetaModel::Init_AddAttribute(new AttributeExternalKey(
array( "export_last_user_id",
[
"targetclass" => 'User', "targetclass" => 'User',
"allowed_values" => null, "allowed_values" => null,
"sql" => 'user_id', "sql" => 'user_id',
"is_null_allowed" => true, "is_null_allowed" => true,
"depends_on"=>array(), "depends_on" => [],
"display_style" => 'select', "display_style" => 'select',
"always_load_in_tables" => false, "always_load_in_tables" => false,
"on_target_delete" => DEL_SILENT, "on_target_delete" => DEL_SILENT,
"tracking_level" => ATTRIBUTE_TRACKING_NONE, "tracking_level" => ATTRIBUTE_TRACKING_NONE,
))); ]
));
MetaModel::Init_AddAttribute(new AttributeExternalField("export_last_user_contact", MetaModel::Init_AddAttribute(new AttributeExternalField(
array( "export_last_user_contact",
[
"allowed_values" => null, "allowed_values" => null,
"extkey_attcode" => "export_last_user_id", "extkey_attcode" => "export_last_user_id",
"target_attcode" => "contactid", "target_attcode" => "contactid",
"tracking_level" => ATTRIBUTE_TRACKING_NONE, "tracking_level" => ATTRIBUTE_TRACKING_NONE,
))); ]
));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', MetaModel::Init_SetZListItems(
array('name', 'is_template', 'description')); // Attributes to be displayed for the complete details 'details',
MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list ['name', 'is_template', 'description']
); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', ['description']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', array('name', 'description', 'is_template')); // Criteria of the std search form MetaModel::Init_SetZListItems('standard_search', ['name', 'description', 'is_template']); // Criteria of the std search form
MetaModel::Init_SetZListItems('default_search', MetaModel::Init_SetZListItems(
array('name', 'description', 'is_template')); // Criteria of the default search form 'default_search',
['name', 'description', 'is_template']
); // Criteria of the default search form
// MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
} }
/** /**
* @inheritdoc * @inheritdoc
* *
* @since 3.1.0 * @since 3.1.0
*/ */
public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '') public function GetAttributeFlags($sAttCode, &$aReasons = [], $sTargetState = '')
{ {
// read only attribute // read only attribute
if (in_array($sAttCode, ['export_count', 'export_last_date', 'export_last_user_id'])) { if (in_array($sAttCode, ['export_count', 'export_last_date', 'export_last_user_id'])) {
@@ -135,7 +143,6 @@ abstract class Query extends cmdbAbstractObject
return parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState); return parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState);
} }
/** /**
* Return export url. * Return export url.
* *
@@ -173,47 +180,50 @@ class QueryOQL extends Query
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "core/cmdb,view_in_gui,application,grant_by_profile", "category" => "core/cmdb,view_in_gui,application,grant_by_profile",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array('oql', 'is_template'), "reconc_keys" => ['oql', 'is_template'],
"db_table" => "priv_query_oql", "db_table" => "priv_query_oql",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_InheritAttributes(); MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeOQL("oql", array( MetaModel::Init_AddAttribute(new AttributeOQL("oql", [
"allowed_values" => null, "allowed_values" => null,
"sql" => "oql", "sql" => "oql",
"default_value" => null, "default_value" => null,
"is_null_allowed" => false, "is_null_allowed" => false,
"depends_on" => array(), "depends_on" => [],
))); ]));
MetaModel::Init_AddAttribute(new AttributeText("fields", array( MetaModel::Init_AddAttribute(new AttributeText("fields", [
"allowed_values" => null, "allowed_values" => null,
"sql" => "fields", "sql" => "fields",
"default_value" => null, "default_value" => null,
"is_null_allowed" => true, "is_null_allowed" => true,
"depends_on" => array(), "depends_on" => [],
))); ]));
// Rolled back to AttributeText until AttributeQueryAttCodeSet can manage fields order correctly // Rolled back to AttributeText until AttributeQueryAttCodeSet can manage fields order correctly
//MetaModel::Init_AddAttribute(new AttributeQueryAttCodeSet("fields", array("allowed_values"=>null,"max_items" => 1000, "query_field" => "oql", "sql"=>"fields", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array('oql')))); //MetaModel::Init_AddAttribute(new AttributeQueryAttCodeSet("fields", array("allowed_values"=>null,"max_items" => 1000, "query_field" => "oql", "sql"=>"fields", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array('oql'))));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', MetaModel::Init_SetZListItems(
array( 'details',
'col:col1' => array('fieldset:Query:baseinfo' => array('name', 'is_template', 'description', 'oql', 'fields')), [
'col:col2' => array('fieldset:Query:exportInfo' => array('export_count', 'export_last_date', 'export_last_user_id', 'export_last_user_contact')) 'col:col1' => ['fieldset:Query:baseinfo' => ['name', 'is_template', 'description', 'oql', 'fields']],
) 'col:col2' => ['fieldset:Query:exportInfo' => ['export_count', 'export_last_date', 'export_last_user_id', 'export_last_user_contact']],
]
); // Attributes to be displayed for the complete details ); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['description']); // Attributes to be displayed for a list
// Search criteria // Search criteria
MetaModel::Init_SetZListItems('standard_search', MetaModel::Init_SetZListItems(
array('name', 'description', 'is_template', 'fields', 'oql')); // Criteria of the std search form 'standard_search',
['name', 'description', 'is_template', 'fields', 'oql']
); // Criteria of the std search form
} }
/** @inheritdoc */ /** @inheritdoc */
@@ -237,13 +247,12 @@ class QueryOQL extends Query
} }
return $sUrl; return $sUrl;
} } catch (Exception $e) {
catch(Exception $e){
return null; return null;
} }
} }
function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array()) public function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = [])
{ {
$aFieldsMap = parent::DisplayBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams); $aFieldsMap = parent::DisplayBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
$oPage->add_script("$('[name=\"attr_oql\"]').addClass('ibo-query-oql ibo-is-code'); $('[data-attribute-code=\"oql\"]').addClass('ibo-query-oql ibo-is-code');"); $oPage->add_script("$('[name=\"attr_oql\"]').addClass('ibo-query-oql ibo-is-code'); $('[data-attribute-code=\"oql\"]').addClass('ibo-query-oql ibo-is-code');");
@@ -267,16 +276,14 @@ class QueryOQL extends Query
if (count($aParameters) == 0) { if (count($aParameters) == 0) {
$oBlock = new DisplayBlock($oSearch, 'list'); $oBlock = new DisplayBlock($oSearch, 'list');
$aExtraParams = array( $aExtraParams = [
//'menu' => $sShowMenu, //'menu' => $sShowMenu,
'table_id' => 'query_preview_'.$this->getKey(), 'table_id' => 'query_preview_'.$this->getKey(),
); ];
$sBlockId = 'block_query_preview_'.$this->GetKey(); // make a unique id (edition occuring in the same DOM) $sBlockId = 'block_query_preview_'.$this->GetKey(); // make a unique id (edition occuring in the same DOM)
$oBlock->Display($oPage, $sBlockId, $aExtraParams); $oBlock->Display($oPage, $sBlockId, $aExtraParams);
} }
} } catch (OQLException $e) {
catch
(OQLException $e) {
$oAlert = AlertUIBlockFactory::MakeForFailure(Dict::S('UI:RunQuery:Error'), $e->getHtmlDesc()) $oAlert = AlertUIBlockFactory::MakeForFailure(Dict::S('UI:RunQuery:Error'), $e->getHtmlDesc())
->SetIsClosable(false) ->SetIsClosable(false)
->SetIsCollapsible(false); ->SetIsCollapsible(false);
@@ -287,7 +294,6 @@ class QueryOQL extends Query
return $aFieldsMap; return $aFieldsMap;
} }
// Rolled back until 'fields' can be properly managed by AttributeQueryAttCodeSet // Rolled back until 'fields' can be properly managed by AttributeQueryAttCodeSet
// //
// public function ComputeValues() // public function ComputeValues()
@@ -323,5 +329,3 @@ class QueryOQL extends Query
// } // }
} }
?>

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -18,7 +19,6 @@
use Combodo\iTop\Application\UI\Base\Component\DataTable\DataTableSettings; use Combodo\iTop\Application\UI\Base\Component\DataTable\DataTableSettings;
use Combodo\iTop\Application\WebPage\WebPage; use Combodo\iTop\Application\WebPage\WebPage;
/** /**
* Persistent class Shortcut and derived * Persistent class Shortcut and derived
* Shortcuts of any kind * Shortcuts of any kind
@@ -31,32 +31,32 @@ abstract class Shortcut extends DBObject implements iDisplay
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "gui,view_in_gui", "category" => "gui,view_in_gui",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_shortcut", "db_table" => "priv_shortcut",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "realclass", "db_finalclass_field" => "realclass",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
//MetaModel::Init_InheritAttributes(); //MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>true, "on_target_delete"=>DEL_AUTO, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", ["targetclass" => "User", "allowed_values" => null, "sql" => "user_id", "is_null_allowed" => true, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["allowed_values" => null, "sql" => "name", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeText("context", array("allowed_values"=>null, "sql"=>"context", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeText("context", ["allowed_values" => null, "sql" => "context", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('name', 'context')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['name', 'context']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('name')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['name']); // Attributes to be displayed for a list
// Search criteria // Search criteria
// MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form // MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
// MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
} }
abstract public function RenderContent(WebPage $oPage, $aExtraParams = array()); abstract public function RenderContent(WebPage $oPage, $aExtraParams = []);
protected function OnInsert() protected function OnInsert()
{ {
@@ -137,13 +137,13 @@ EOF
return ''; return '';
} }
function DisplayDetails(WebPage $oPage, $bEditMode = false) public function DisplayDetails(WebPage $oPage, $bEditMode = false)
{ {
} }
function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array()) public function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = [])
{ {
return array(); return [];
} }
// End of the minimal implementation of iDisplay // End of the minimal implementation of iDisplay
} }
@@ -152,41 +152,39 @@ class ShortcutOQL extends Shortcut
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "gui,view_in_gui", "category" => "gui,view_in_gui",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_shortcut_oql", "db_table" => "priv_shortcut_oql",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_InheritAttributes(); MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeOQL("oql", array("allowed_values"=>null, "sql"=>"oql", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeOQL("oql", ["allowed_values" => null, "sql" => "oql", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("auto_reload", array("allowed_values"=>new ValueSetEnum('none,custom'), "sql"=>"auto_reload", "default_value"=>"none", "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeEnum("auto_reload", ["allowed_values" => new ValueSetEnum('none,custom'), "sql" => "auto_reload", "default_value" => "none", "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeInteger("auto_reload_sec", array("allowed_values"=>null, "sql"=>"auto_reload_sec", "default_value"=>60, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeInteger("auto_reload_sec", ["allowed_values" => null, "sql" => "auto_reload_sec", "default_value" => 60, "is_null_allowed" => false, "depends_on" => []]));
// Display lists // Display lists
MetaModel::Init_SetZListItems('details', array('name', 'context', 'oql')); // Attributes to be displayed for the complete details MetaModel::Init_SetZListItems('details', ['name', 'context', 'oql']); // Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('list', array('name')); // Attributes to be displayed for a list MetaModel::Init_SetZListItems('list', ['name']); // Attributes to be displayed for a list
// Search criteria // Search criteria
// MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form // MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
// MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
} }
public function RenderContent(WebPage $oPage, $aExtraParams = array()) public function RenderContent(WebPage $oPage, $aExtraParams = [])
{ {
$oPage->set_title($this->Get('name')); $oPage->set_title($this->Get('name'));
switch($this->Get('auto_reload')) switch ($this->Get('auto_reload')) {
{
case 'custom': case 'custom':
$iRate = (int)$this->Get('auto_reload_sec'); $iRate = (int)$this->Get('auto_reload_sec');
if ($iRate > 0) if ($iRate > 0) {
{
// Must a string otherwise it can be evaluated to 'true' and defaults to "standard" refresh rate! // Must a string otherwise it can be evaluated to 'true' and defaults to "standard" refresh rate!
$aExtraParams['auto_reload'] = (string)$iRate; $aExtraParams['auto_reload'] = (string)$iRate;
} }
@@ -198,12 +196,9 @@ class ShortcutOQL extends Shortcut
$bSearchPane = true; $bSearchPane = true;
$bSearchOpen = true; $bSearchOpen = true;
try try {
{
OQLMenuNode::RenderOQLSearch($this->Get('oql'), $this->Get('name'), 'shortcut_'.$this->GetKey(), $bSearchPane, $bSearchOpen, $oPage, $aExtraParams, true); OQLMenuNode::RenderOQLSearch($this->Get('oql'), $this->Get('name'), 'shortcut_'.$this->GetKey(), $bSearchPane, $bSearchOpen, $oPage, $aExtraParams, true);
} } catch (Exception $e) {
catch (Exception $e)
{
throw new Exception("The OQL shortcut '".$this->Get('name')."' (id: ".$this->GetKey().") could not be displayed: ".$e->getMessage()); throw new Exception("The OQL shortcut '".$this->Get('name')."' (id: ".$this->GetKey().") could not be displayed: ".$e->getMessage());
} }
@@ -226,12 +221,9 @@ class ShortcutOQL extends Shortcut
// Find a unique default name // Find a unique default name
// -> The class of the query + an index if necessary // -> The class of the query + an index if necessary
if ($sOQL == null) if ($sOQL == null) {
{
$sDefault = ''; $sDefault = '';
} } else {
else
{
$oBMSearch = new DBObjectSearch('Shortcut'); $oBMSearch = new DBObjectSearch('Shortcut');
$oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '='); $oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
$oBMSet = new DBObjectSet($oBMSearch); $oBMSet = new DBObjectSet($oBMSearch);

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -23,7 +24,6 @@ require_once(APPROOT.'core/contexttag.class.inc.php');
require_once(APPROOT.'core/kpi.class.inc.php'); require_once(APPROOT.'core/kpi.class.inc.php');
require_once(APPROOT.'setup/setuputils.class.inc.php'); require_once(APPROOT.'setup/setuputils.class.inc.php');
/** /**
* File to include to initialize the datamodel in memory * File to include to initialize the datamodel in memory
* *
@@ -36,12 +36,10 @@ ExecutionKPI::EnableMemory(1);
// This storage is freed on error (case of allowed memory exhausted) // This storage is freed on error (case of allowed memory exhausted)
$sReservedMemory = str_repeat('*', 1024 * 1024); $sReservedMemory = str_repeat('*', 1024 * 1024);
register_shutdown_function(function() register_shutdown_function(function () {
{
global $sReservedMemory; global $sReservedMemory;
$sReservedMemory = null; $sReservedMemory = null;
if (!is_null($err = error_get_last()) && ($err['type'] == E_ERROR)) if (!is_null($err = error_get_last()) && ($err['type'] == E_ERROR)) {
{
// Remove stack trace from MySQLException (since 2.7.2 see N°3174) // Remove stack trace from MySQLException (since 2.7.2 see N°3174)
$sMessage = $err['message']; $sMessage = $err['message'];
if (strpos($sMessage, 'MySQLException') !== false) { if (strpos($sMessage, 'MySQLException') !== false) {
@@ -71,38 +69,30 @@ $oKPI->ComputeAndReport("Session Start");
$sSwitchEnv = utils::ReadParam('switch_env', null); $sSwitchEnv = utils::ReadParam('switch_env', null);
$bAllowCache = true; $bAllowCache = true;
if (($sSwitchEnv != null) && file_exists(APPCONF.$sSwitchEnv.'/'.ITOP_CONFIG_FILE) &&( Session::Get('itop_env') !== $sSwitchEnv)) if (($sSwitchEnv != null) && file_exists(APPCONF.$sSwitchEnv.'/'.ITOP_CONFIG_FILE) && (Session::Get('itop_env') !== $sSwitchEnv)) {
{
Session::Set('itop_env', $sSwitchEnv); Session::Set('itop_env', $sSwitchEnv);
$sEnv = $sSwitchEnv; $sEnv = $sSwitchEnv;
$bAllowCache = false; $bAllowCache = false;
// Reset the opcache since otherwise the PHP "model" files may still be cached !! // Reset the opcache since otherwise the PHP "model" files may still be cached !!
if (function_exists('opcache_reset')) if (function_exists('opcache_reset')) {
{
// Zend opcode cache // Zend opcode cache
opcache_reset(); opcache_reset();
} }
if (function_exists('apc_clear_cache')) if (function_exists('apc_clear_cache')) {
{
// APC(u) cache // APC(u) cache
apc_clear_cache(); apc_clear_cache();
} }
// TODO: reset the credentials as well ?? // TODO: reset the credentials as well ??
} } elseif (Session::IsSet('itop_env')) {
else if (Session::IsSet('itop_env'))
{
$sEnv = Session::Get('itop_env'); $sEnv = Session::Get('itop_env');
} } else {
else
{
$sEnv = ITOP_DEFAULT_ENV; $sEnv = ITOP_DEFAULT_ENV;
Session::Set('itop_env', ITOP_DEFAULT_ENV); Session::Set('itop_env', ITOP_DEFAULT_ENV);
} }
$sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE; $sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE;
try { try {
MetaModel::Startup($sConfigFile, false /* $bModelOnly */, $bAllowCache, false /* $bTraceSourceFiles */, $sEnv); MetaModel::Startup($sConfigFile, false /* $bModelOnly */, $bAllowCache, false /* $bTraceSourceFiles */, $sEnv);
} } catch (MySQLException $e) {
catch (MySQLException $e) {
IssueLog::Debug($e->getMessage()); IssueLog::Debug($e->getMessage());
throw new MySQLException('Could not connect to the DB server', []); throw new MySQLException('Could not connect to the DB server', []);
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* Copyright (C) 2013-2024 Combodo SAS * Copyright (C) 2013-2024 Combodo SAS
* *
@@ -25,7 +26,7 @@
*/ */
class ThemeHandler class ThemeHandler
{ {
const IMAGE_EXTENSIONS = ['png', 'gif', 'jpg', 'jpeg']; public const IMAGE_EXTENSIONS = ['png', 'gif', 'jpg', 'jpeg'];
/** @var \CompileCSSService */ /** @var \CompileCSSService */
private static $oCompileCSSService; private static $oCompileCSSService;
@@ -50,7 +51,7 @@ class ThemeHandler
'imports' => [], 'imports' => [],
'stylesheets' => [ 'stylesheets' => [
'main' => '../css/backoffice/main.scss', 'main' => '../css/backoffice/main.scss',
] ],
], ],
]; ];
} }
@@ -63,8 +64,7 @@ class ThemeHandler
{ {
try { try {
$sThemeId = utils::GetConfig()->Get('backoffice_default_theme'); $sThemeId = utils::GetConfig()->Get('backoffice_default_theme');
} } catch (CoreException $oCompileException) {
catch (CoreException $oCompileException) {
// Fallback on our default theme in case the config. is not available yet // Fallback on our default theme in case the config. is not available yet
$aDefaultTheme = ThemeHandler::GetDefaultThemeInformation(); $aDefaultTheme = ThemeHandler::GetDefaultThemeInformation();
$sThemeId = $aDefaultTheme['name']; $sThemeId = $aDefaultTheme['name'];
@@ -85,8 +85,7 @@ class ThemeHandler
if (true === utils::GetConfig()->Get('user_preferences.allow_backoffice_theme_override')) { if (true === utils::GetConfig()->Get('user_preferences.allow_backoffice_theme_override')) {
$sThemeId = appUserPreferences::GetPref('backoffice_theme', null); $sThemeId = appUserPreferences::GetPref('backoffice_theme', null);
} }
} } catch (Exception $oException) {
catch (Exception $oException) {
// Do nothing, already handled by $sThemeId null by default // Do nothing, already handled by $sThemeId null by default
} }
@@ -201,8 +200,7 @@ class ThemeHandler
if (static::ShouldThemeSignatureCheckBeForced($sThemeId)) { if (static::ShouldThemeSignatureCheckBeForced($sThemeId)) {
static::CompileTheme($sThemeId); static::CompileTheme($sThemeId);
} }
} } catch (CoreException $oCompileException) {
catch (CoreException $oCompileException) {
// Fallback on our default theme (should always be compilable) in case the previous theme doesn't exists // Fallback on our default theme (should always be compilable) in case the previous theme doesn't exists
$aDefaultTheme = ThemeHandler::GetDefaultThemeInformation(); $aDefaultTheme = ThemeHandler::GetDefaultThemeInformation();
$sThemeId = $aDefaultTheme['name']; $sThemeId = $aDefaultTheme['name'];
@@ -258,13 +256,16 @@ class ThemeHandler
* @throws \CoreException * @throws \CoreException
* @return boolean: indicate whether theme compilation occured * @return boolean: indicate whether theme compilation occured
*/ */
public static function CompileTheme($sThemeId, $bSetup=false, $sSetupCompilationTimestamp="", $aThemeParameters = null, $aImportsPaths = null, $sWorkingPath = null) { public static function CompileTheme($sThemeId, $bSetup = false, $sSetupCompilationTimestamp = "", $aThemeParameters = null, $aImportsPaths = null, $sWorkingPath = null)
{
if ($sSetupCompilationTimestamp === "") { if ($sSetupCompilationTimestamp === "") {
$sSetupCompilationTimestamp = microtime(true); $sSetupCompilationTimestamp = microtime(true);
} }
$sSetupCompilationTimestampInSecunds = (strpos($sSetupCompilationTimestamp, '.') !== false) ? explode('.', $sSetupCompilationTimestampInSecunds = (strpos($sSetupCompilationTimestamp, '.') !== false) ? explode(
$sSetupCompilationTimestamp)[0] : $sSetupCompilationTimestamp; '.',
$sSetupCompilationTimestamp
)[0] : $sSetupCompilationTimestamp;
$sEnv = APPROOT.'env-'.utils::GetCurrentEnvironment().'/'; $sEnv = APPROOT.'env-'.utils::GetCurrentEnvironment().'/';
@@ -330,10 +331,8 @@ class ThemeHandler
$iStyleLastModified = $oFindStylesheetObject->GetLastModified(); $iStyleLastModified = $oFindStylesheetObject->GetLastModified();
$aIncludedImages = static::GetIncludedImages($aThemeParametersWithVersion, $oFindStylesheetObject->GetAllStylesheetPaths(), $sThemeId); $aIncludedImages = static::GetIncludedImages($aThemeParametersWithVersion, $oFindStylesheetObject->GetAllStylesheetPaths(), $sThemeId);
foreach ($aIncludedImages as $sImage) foreach ($aIncludedImages as $sImage) {
{ if (is_file($sImage)) {
if (is_file($sImage))
{
$iStylesheetLastModified = @filemtime($sImage); $iStylesheetLastModified = @filemtime($sImage);
$iStyleLastModified = $iStyleLastModified < $iStylesheetLastModified ? $iStylesheetLastModified : $iStyleLastModified; $iStyleLastModified = $iStyleLastModified < $iStylesheetLastModified ? $iStylesheetLastModified : $iStyleLastModified;
} }
@@ -343,8 +342,7 @@ class ThemeHandler
$iFilemetime = @filemtime($sThemeCssPath); $iFilemetime = @filemtime($sThemeCssPath);
$bFileExists = file_exists($sThemeCssPath); $bFileExists = file_exists($sThemeCssPath);
$bVarSignatureChanged = false; $bVarSignatureChanged = false;
if ($bFileExists && $bSetup) if ($bFileExists && $bSetup) {
{
$sPrecompiledSignature = static::GetSignature($sThemeCssPath); $sPrecompiledSignature = static::GetSignature($sThemeCssPath);
//check variable signature has changed which is independant from any file modification //check variable signature has changed which is independant from any file modification
if (!empty($sPrecompiledSignature)) { if (!empty($sPrecompiledSignature)) {
@@ -354,22 +352,17 @@ class ThemeHandler
} }
} }
if (!$bFileExists || $bVarSignatureChanged || (is_writable($sThemeFolderPath) && ($iFilemetime < $iStyleLastModified))) if (!$bFileExists || $bVarSignatureChanged || (is_writable($sThemeFolderPath) && ($iFilemetime < $iStyleLastModified))) {
{
// Dates don't match. Second chance: check if the already compiled stylesheet exists and is consistent based on its signature // Dates don't match. Second chance: check if the already compiled stylesheet exists and is consistent based on its signature
$sActualSignature = static::ComputeSignature($aThemeParameters, $aImportsPaths, $aIncludedImages); $sActualSignature = static::ComputeSignature($aThemeParameters, $aImportsPaths, $aIncludedImages);
if ($bFileExists && !$bSetup) if ($bFileExists && !$bSetup) {
{
$sPrecompiledSignature = static::GetSignature($sThemeCssPath); $sPrecompiledSignature = static::GetSignature($sThemeCssPath);
} }
if (!empty($sPrecompiledSignature) && $sActualSignature == $sPrecompiledSignature) if (!empty($sPrecompiledSignature) && $sActualSignature == $sPrecompiledSignature) {
{
touch($sThemeCssPath); // Stylesheet is up to date, mark it as more recent to speedup next time touch($sThemeCssPath); // Stylesheet is up to date, mark it as more recent to speedup next time
} } else {
else
{
// Alas, we really need to recompile // Alas, we really need to recompile
// Add the signature to the generated CSS file so that the file can be used as a precompiled stylesheet if needed // Add the signature to the generated CSS file so that the file can be used as a precompiled stylesheet if needed
$sSignatureComment = $sSignatureComment =
@@ -381,14 +374,16 @@ $sActualSignature
*/ */
CSS; CSS;
if (!static::$oCompileCSSService) if (!static::$oCompileCSSService) {
{
static::$oCompileCSSService = new CompileCSSService(); static::$oCompileCSSService = new CompileCSSService();
} }
//store it again to change $version with latest compiled time //store it again to change $version with latest compiled time
SetupLog::Info("Compiling theme $sThemeId..."); SetupLog::Info("Compiling theme $sThemeId...");
$sTmpThemeCssContent = static::$oCompileCSSService->CompileCSSFromSASS($sTmpThemeScssContent, $aImportsPaths, $sTmpThemeCssContent = static::$oCompileCSSService->CompileCSSFromSASS(
$aThemeParametersWithVersion); $sTmpThemeScssContent,
$aImportsPaths,
$aThemeParametersWithVersion
);
SetupLog::Info("$sThemeId theme compilation done."); SetupLog::Info("$sThemeId theme compilation done.");
file_put_contents($sThemeFolderPath.'/theme-parameters.json', json_encode($aThemeParameters)); file_put_contents($sThemeFolderPath.'/theme-parameters.json', json_encode($aThemeParameters));
file_put_contents($sThemeCssPath, $sSignatureComment.$sTmpThemeCssContent); file_put_contents($sThemeCssPath, $sSignatureComment.$sTmpThemeCssContent);
@@ -413,13 +408,14 @@ CSS;
* @return string * @return string
* @throws \Exception * @throws \Exception
*/ */
public static function ComputeSignature($aThemeParameters, $aImportsPaths, $aIncludedImages) { public static function ComputeSignature($aThemeParameters, $aImportsPaths, $aIncludedImages)
{
$aSignature = [ $aSignature = [
'variables' => md5(json_encode($aThemeParameters['variables'])), 'variables' => md5(json_encode($aThemeParameters['variables'])),
'stylesheets' => [], 'stylesheets' => [],
'variable_imports' => [], 'variable_imports' => [],
'images' => [], 'images' => [],
'utility_imports' => [] 'utility_imports' => [],
]; ];
$oFindStylesheetObject = new FindStylesheetObject(); $oFindStylesheetObject = new FindStylesheetObject();
@@ -461,8 +457,7 @@ CSS;
} }
} }
foreach ($aIncludedImages as $sImage) foreach ($aIncludedImages as $sImage) {
{
if (is_file($sImage)) { if (is_file($sImage)) {
$sUri = str_replace(self::GetAppRootWithSlashes(), '', $sImage); $sUri = str_replace(self::GetAppRootWithSlashes(), '', $sImage);
$aSignature['images'][$sUri] = md5_file($sImage); $aSignature['images'][$sUri] = md5_file($sImage);
@@ -497,14 +492,11 @@ CSS;
'aFoundVariables' => $aFoundVariables, 'aFoundVariables' => $aFoundVariables,
]; ];
foreach ($aStylesheetFiles as $sStylesheetFile) foreach ($aStylesheetFiles as $sStylesheetFile) {
{
$aRes = static::GetAllUrlFromScss($aThemeParametersVariables, $sStylesheetFile); $aRes = static::GetAllUrlFromScss($aThemeParametersVariables, $sStylesheetFile);
/** @var array $aVal */ /** @var array $aVal */
foreach($aMap as $key => $aVal) foreach ($aMap as $key => $aVal) {
{ if (array_key_exists($key, $aMap)) {
if (array_key_exists($key, $aMap))
{
$aMap[$key] = array_merge($aVal, $aRes[$key]); $aMap[$key] = array_merge($aVal, $aRes[$key]);
} }
} }
@@ -513,17 +505,14 @@ CSS;
$aMap = static::ResolveUncompleteUrlsFromScss($aMap, $aThemeParametersVariables, $aStylesheetFiles); $aMap = static::ResolveUncompleteUrlsFromScss($aMap, $aThemeParametersVariables, $aStylesheetFiles);
$aImages = []; $aImages = [];
foreach ($aMap ['aCompleteUrls'] as $sUri => $sUrl) foreach ($aMap ['aCompleteUrls'] as $sUri => $sUrl) {
{
$sImg = $sUrl; $sImg = $sUrl;
if (preg_match("/(.*)\?/", $sUrl, $aMatches)) if (preg_match("/(.*)\?/", $sUrl, $aMatches)) {
{
$sImg = $aMatches[1]; $sImg = $aMatches[1];
} }
if (static::HasImageExtension($sImg) if (static::HasImageExtension($sImg)
&& ! array_key_exists($sImg, $aImages)) && ! array_key_exists($sImg, $aImages)) {
{
$sFilePath = utils::RealPath($sImg, APPROOT); $sFilePath = utils::RealPath($sImg, APPROOT);
if ($sFilePath !== false) { if ($sFilePath !== false) {
$sFilePathWithSlashes = str_replace('\\', '/', $sFilePath); $sFilePathWithSlashes = str_replace('\\', '/', $sFilePath);
@@ -555,7 +544,7 @@ CSS;
public static function CanonicalizePath($path) public static function CanonicalizePath($path)
{ {
$path = explode('/', str_replace('//', '/', $path)); $path = explode('/', str_replace('//', '/', $path));
$stack = array(); $stack = [];
foreach ($path as $seg) { foreach ($path as $seg) {
if ($seg == '..') { if ($seg == '..') {
// Ignore this segment, remove last segment from stack // Ignore this segment, remove last segment from stack
@@ -586,10 +575,8 @@ CSS;
public static function ResolveUncompleteUrlsFromScss($aMap, $aThemeParametersVariables, $aStylesheetFile) public static function ResolveUncompleteUrlsFromScss($aMap, $aThemeParametersVariables, $aStylesheetFile)
{ {
$sContent = ""; $sContent = "";
foreach ($aStylesheetFile as $sStylesheetFile) foreach ($aStylesheetFile as $sStylesheetFile) {
{ if (is_file($sStylesheetFile)) {
if (is_file($sStylesheetFile))
{
$sContent .= '\n'.file_get_contents($sStylesheetFile); $sContent .= '\n'.file_get_contents($sStylesheetFile);
} }
} }
@@ -622,40 +609,26 @@ CSS;
public static function FindMissingVariables($aThemeParametersVariables, $aMissingVariables, $aFoundVariables, $sContent, $bForceEmptyValueWhenNotFound = false) public static function FindMissingVariables($aThemeParametersVariables, $aMissingVariables, $aFoundVariables, $sContent, $bForceEmptyValueWhenNotFound = false)
{ {
$aNewMissingVars = []; $aNewMissingVars = [];
if (!empty($aMissingVariables)) if (!empty($aMissingVariables)) {
{ foreach ($aMissingVariables as $var) {
foreach ($aMissingVariables as $var) if (array_key_exists($var, $aThemeParametersVariables)) {
{
if (array_key_exists($var, $aThemeParametersVariables))
{
$aFoundVariables[$var] = $aThemeParametersVariables[$var]; $aFoundVariables[$var] = $aThemeParametersVariables[$var];
} } else {
else if (preg_match_all("/\\\$$var\s*:\s*[\"']{0,1}(.*)[\"']{0,1};/", $sContent, $aValues)) {
{
if (preg_match_all("/\\\$$var\s*:\s*[\"']{0,1}(.*)[\"']{0,1};/", $sContent, $aValues))
{
$sValue = $aValues[1][0]; $sValue = $aValues[1][0];
if (preg_match_all("/([^!]+)!/", $sValue, $aSubValues)) if (preg_match_all("/([^!]+)!/", $sValue, $aSubValues)) {
{
$sValue = trim($aSubValues[1][0], ' "\''); $sValue = trim($aSubValues[1][0], ' "\'');
} }
if (strpos($sValue, '$') === false) if (strpos($sValue, '$') === false) {
{
$aFoundVariables[$var] = $sValue; $aFoundVariables[$var] = $sValue;
} } else {
else{
$aNewMissingVars[] = $var; $aNewMissingVars[] = $var;
} }
} } else {
else if ($bForceEmptyValueWhenNotFound) {
{
if ($bForceEmptyValueWhenNotFound)
{
$aFoundVariables[$var] = ''; $aFoundVariables[$var] = '';
} } else {
else
{
$aNewMissingVars[] = $var; $aNewMissingVars[] = $var;
} }
} }
@@ -676,32 +649,23 @@ CSS;
*/ */
public static function ResolveUrls($aFoundVariables, array $aToCompleteUrls, array $aCompleteUrls) public static function ResolveUrls($aFoundVariables, array $aToCompleteUrls, array $aCompleteUrls)
{ {
if (!empty($aFoundVariables)) if (!empty($aFoundVariables)) {
{
$aFoundVariablesWithEmptyValue = []; $aFoundVariablesWithEmptyValue = [];
foreach ($aFoundVariables as $aFoundVariable => $sValue) foreach ($aFoundVariables as $aFoundVariable => $sValue) {
{
$aFoundVariablesWithEmptyValue[$aFoundVariable] = ''; $aFoundVariablesWithEmptyValue[$aFoundVariable] = '';
} }
foreach ($aToCompleteUrls as $sUrlTemplate) foreach ($aToCompleteUrls as $sUrlTemplate) {
{
unset($aToCompleteUrls[$sUrlTemplate]); unset($aToCompleteUrls[$sUrlTemplate]);
$sResolvedUrl = static::ResolveUrl($sUrlTemplate, $aFoundVariables); $sResolvedUrl = static::ResolveUrl($sUrlTemplate, $aFoundVariables);
if ($sResolvedUrl == false) if ($sResolvedUrl == false) {
{
$aToCompleteUrls[$sUrlTemplate] = $sUrlTemplate; $aToCompleteUrls[$sUrlTemplate] = $sUrlTemplate;
} } else {
else
{
$sUri = static::ResolveUrl($sUrlTemplate, $aFoundVariablesWithEmptyValue); $sUri = static::ResolveUrl($sUrlTemplate, $aFoundVariablesWithEmptyValue);
$aExplodedUri = explode('?', $sUri); $aExplodedUri = explode('?', $sUri);
if (empty($aExplodedUri)) if (empty($aExplodedUri)) {
{
$aCompleteUrls[$sUri] = $sResolvedUrl; $aCompleteUrls[$sUri] = $sResolvedUrl;
} } else {
else
{
$aCompleteUrls[$aExplodedUri[0]] = $sResolvedUrl; $aCompleteUrls[$aExplodedUri[0]] = $sResolvedUrl;
} }
} }
@@ -726,41 +690,31 @@ CSS;
$aMissingVariables = []; $aMissingVariables = [];
$aFoundVariables = []; $aFoundVariables = [];
if (is_file($sStylesheetFile)) if (is_file($sStylesheetFile)) {
{
$sContent = file_get_contents($sStylesheetFile); $sContent = file_get_contents($sStylesheetFile);
if (preg_match_all("/url\s*\((.*)\)/", $sContent, $aMatches)) if (preg_match_all("/url\s*\((.*)\)/", $sContent, $aMatches)) {
{ foreach ($aMatches[1] as $path) {
foreach ($aMatches[1] as $path)
{
$iRemainingClosingParenthesisPos = strpos($path, ')'); $iRemainingClosingParenthesisPos = strpos($path, ')');
if ($iRemainingClosingParenthesisPos !== false) { if ($iRemainingClosingParenthesisPos !== false) {
$path = substr($path, 0, $iRemainingClosingParenthesisPos); $path = substr($path, 0, $iRemainingClosingParenthesisPos);
} }
if (!array_key_exists($path, $aCompleteUrls) if (!array_key_exists($path, $aCompleteUrls)
&& !array_key_exists($path, $aToCompleteUrls)) && !array_key_exists($path, $aToCompleteUrls)) {
{ if (preg_match_all("/\\$([\w\-_]+)/", $path, $aCurrentVars)) {
if (preg_match_all("/\\$([\w\-_]+)/", $path, $aCurrentVars))
{
/** @var string $aCurrentVars */ /** @var string $aCurrentVars */
foreach ($aCurrentVars[1] as $var) foreach ($aCurrentVars[1] as $var) {
{ if (!array_key_exists($var, $aMissingVariables)) {
if (!array_key_exists($var, $aMissingVariables))
{
$aMissingVariables[$var] = $var; $aMissingVariables[$var] = $var;
} }
} }
$aToCompleteUrls[$path] = $path; $aToCompleteUrls[$path] = $path;
} } else {
else
{
$aCompleteUrls[$path] = trim($path, "\"'"); $aCompleteUrls[$path] = trim($path, "\"'");
} }
} }
} }
} }
if (!empty($aMissingVariables)) if (!empty($aMissingVariables)) {
{
list($aMissingVariables, $aFoundVariables) = static::FindMissingVariables($aThemeParametersVariables, $aMissingVariables, $aFoundVariables, $sContent); list($aMissingVariables, $aFoundVariables) = static::FindMissingVariables($aThemeParametersVariables, $aMissingVariables, $aFoundVariables, $sContent);
list($aToCompleteUrls, $aCompleteUrls) = static::ResolveUrls($aFoundVariables, $aToCompleteUrls, $aCompleteUrls); list($aToCompleteUrls, $aCompleteUrls) = static::ResolveUrls($aFoundVariables, $aToCompleteUrls, $aCompleteUrls);
} }
@@ -770,7 +724,7 @@ CSS;
'aCompleteUrls' => $aCompleteUrls, 'aCompleteUrls' => $aCompleteUrls,
'aToCompleteUrls' => $aToCompleteUrls, 'aToCompleteUrls' => $aToCompleteUrls,
'aMissingVariables' => $aMissingVariables, 'aMissingVariables' => $aMissingVariables,
'aFoundVariables' => $aFoundVariables 'aFoundVariables' => $aFoundVariables,
]; ];
} }
@@ -786,8 +740,7 @@ CSS;
{ {
$aPattern = []; $aPattern = [];
$aReplacement = []; $aReplacement = [];
foreach ($aFoundVariables as $aFoundVariable => $aFoundVariableValue) foreach ($aFoundVariables as $aFoundVariable => $aFoundVariableValue) {
{
//XX + $key + YY //XX + $key + YY
$aPattern[] = "/['\"]\s*\+\s*\\\$".$aFoundVariable."[\s\+]+\s*['\"]/"; $aPattern[] = "/['\"]\s*\+\s*\\\$".$aFoundVariable."[\s\+]+\s*['\"]/";
$aReplacement[] = $aFoundVariableValue; $aReplacement[] = $aFoundVariableValue;
@@ -799,8 +752,7 @@ CSS;
$aReplacement[] = $aFoundVariableValue; $aReplacement[] = $aFoundVariableValue;
} }
$sResolvedUrl = preg_replace($aPattern, $aReplacement, $sUrlTemplate); $sResolvedUrl = preg_replace($aPattern, $aReplacement, $sUrlTemplate);
if (strpos($sResolvedUrl, "+")!==false) if (strpos($sResolvedUrl, "+") !== false) {
{
return false; return false;
} }
return trim($sResolvedUrl, "\"'"); return trim($sResolvedUrl, "\"'");
@@ -814,17 +766,14 @@ CSS;
*/ */
private static function HasImageExtension($path) private static function HasImageExtension($path)
{ {
foreach (static::IMAGE_EXTENSIONS as $sExt) foreach (static::IMAGE_EXTENSIONS as $sExt) {
{ if (endsWith($path, $sExt)) {
if (endsWith($path, $sExt))
{
return true; return true;
} }
} }
return false; return false;
} }
/** /**
* @since 3.0.0 N°2982 * @since 3.0.0 N°2982
* Extract the signature for a generated CSS file. * Extract the signature for a generated CSS file.
@@ -843,16 +792,13 @@ CSS;
$iCount = 0; $iCount = 0;
$sPreviousLine = ''; $sPreviousLine = '';
$hFile = @fopen($sFilepath, "r"); $hFile = @fopen($sFilepath, "r");
if ($hFile !== false) if ($hFile !== false) {
{
$sLine = ''; $sLine = '';
do do {
{
$iCount++; $iCount++;
$sPreviousLine = $sLine; $sPreviousLine = $sLine;
$sLine = rtrim(fgets($hFile)); // Remove the trailing \n $sLine = rtrim(fgets($hFile)); // Remove the trailing \n
} } while (($sLine !== false) && ($sLine != '=== SIGNATURE END ===') && ($iCount <= 100));
while (($sLine !== false) && ($sLine != '=== SIGNATURE END ===') && ($iCount <= 100));
fclose($hFile); fclose($hFile);
} }
return $sPreviousLine; return $sPreviousLine;
@@ -867,8 +813,7 @@ CSS;
public static function GetVarSignature($JsonSignature) public static function GetVarSignature($JsonSignature)
{ {
$aJsonArray = json_decode($JsonSignature, true); $aJsonArray = json_decode($JsonSignature, true);
if (array_key_exists('variables', $aJsonArray)) if (array_key_exists('variables', $aJsonArray)) {
{
return $aJsonArray['variables']; return $aJsonArray['variables'];
} }
return false; return false;
@@ -892,8 +837,7 @@ CSS;
$oFindStylesheetObject->ResetLastStyleSheet(); $oFindStylesheetObject->ResetLastStyleSheet();
} }
foreach($aImportsPaths as $sPath) foreach ($aImportsPaths as $sPath) {
{
$sAlterableFileURI = $sFileURI; $sAlterableFileURI = $sFileURI;
$sFilePath = $sPath.'/'.$sAlterableFileURI; $sFilePath = $sPath.'/'.$sAlterableFileURI;
$sImportedFile = realpath($sFilePath); $sImportedFile = realpath($sFilePath);
@@ -918,8 +862,7 @@ CSS;
} }
if ((file_exists($sImportedFile)) if ((file_exists($sImportedFile))
&& (!$oFindStylesheetObject->AlreadyFetched($sImportedFile))) && (!$oFindStylesheetObject->AlreadyFetched($sImportedFile))) {
{
if ($bImports) { if ($bImports) {
$oFindStylesheetObject->AddImport($sAlterableFileURI, $sImportedFile); $oFindStylesheetObject->AddImport($sAlterableFileURI, $sImportedFile);
} else { } else {
@@ -952,8 +895,7 @@ CSS;
{ {
$iPos = strrpos($sSubject, $sSearch); $iPos = strrpos($sSubject, $sSearch);
if($iPos !== false) if ($iPos !== false) {
{
$sSubject = substr_replace($sSubject, $sReplace, $iPos, strlen($sSearch)); $sSubject = substr_replace($sSubject, $sReplace, $iPos, strlen($sSearch));
} }
@@ -982,18 +924,14 @@ CSS;
public static function CloneThemeParameterAndIncludeVersion($aThemeParameters, $bSetupCompilationTimestamp, $aImportsPaths) public static function CloneThemeParameterAndIncludeVersion($aThemeParameters, $bSetupCompilationTimestamp, $aImportsPaths)
{ {
$aThemeParametersVariable = []; $aThemeParametersVariable = [];
if (array_key_exists('variables', $aThemeParameters)) if (array_key_exists('variables', $aThemeParameters)) {
{ if (is_array($aThemeParameters['variables'])) {
if (is_array($aThemeParameters['variables']))
{
$aThemeParametersVariable = array_merge([], $aThemeParameters['variables']); $aThemeParametersVariable = array_merge([], $aThemeParameters['variables']);
} }
} }
if (array_key_exists('variable_imports', $aThemeParameters)) if (array_key_exists('variable_imports', $aThemeParameters)) {
{ if (is_array($aThemeParameters['variable_imports'])) {
if (is_array($aThemeParameters['variable_imports']))
{
$aThemeParametersVariable = array_merge($aThemeParametersVariable, static::GetVariablesFromFile($aThemeParameters['variable_imports'], $aImportsPaths)); $aThemeParametersVariable = array_merge($aThemeParametersVariable, static::GetVariablesFromFile($aThemeParameters['variable_imports'], $aImportsPaths));
} }
} }
@@ -1009,10 +947,10 @@ CSS;
* @return array * @return array
* @since 3.0.0 N°3593 * @since 3.0.0 N°3593
*/ */
public static function GetVariablesFromFile($aVariableFiles, $aImportsPaths){ public static function GetVariablesFromFile($aVariableFiles, $aImportsPaths)
$aVariablesResults = [];
foreach ($aVariableFiles as $sVariableFile)
{ {
$aVariablesResults = [];
foreach ($aVariableFiles as $sVariableFile) {
foreach ($aImportsPaths as $sPath) { foreach ($aImportsPaths as $sPath) {
$sFilePath = $sPath.'/'.$sVariableFile; $sFilePath = $sPath.'/'.$sVariableFile;
$sImportedFile = realpath($sFilePath); $sImportedFile = realpath($sFilePath);
@@ -1034,4 +972,3 @@ CSS;
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* Copyright (C) 2013-2024 Combodo SAS * Copyright (C) 2013-2024 Combodo SAS
* *
@@ -29,7 +30,8 @@ class ThemeHandlerService
{ {
} }
public function CompileTheme($sThemeId, $bSetup = false, $sSetupCompilationTimestamp = "", $aThemeParameters = null, $aImportsPaths = null, $sWorkingPath = null){ public function CompileTheme($sThemeId, $bSetup = false, $sSetupCompilationTimestamp = "", $aThemeParameters = null, $aImportsPaths = null, $sWorkingPath = null)
{
return ThemeHandler::CompileTheme($sThemeId, $bSetup, $sSetupCompilationTimestamp, $aThemeParameters, $aImportsPaths, $sWorkingPath); return ThemeHandler::CompileTheme($sThemeId, $bSetup, $sSetupCompilationTimestamp, $aThemeParameters, $aImportsPaths, $sWorkingPath);
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -37,13 +38,11 @@ class privUITransaction
public static function GetNewTransactionId() public static function GetNewTransactionId()
{ {
$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled'); $bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
if (!$bTransactionsEnabled) if (!$bTransactionsEnabled) {
{
return 'notransactions'; // Any value will do return 'notransactions'; // Any value will do
} }
$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage'); $sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
if (!class_exists($sClass, false)) if (!class_exists($sClass, false)) {
{
IssueLog::Error("Incorrect value '".MetaModel::GetConfig()->Get('transaction_storage')."' for 'transaction_storage', the class '$sClass' does not exists. Using privUITransactionSession instead for storing sessions."); IssueLog::Error("Incorrect value '".MetaModel::GetConfig()->Get('transaction_storage')."' for 'transaction_storage', the class '$sClass' does not exists. Using privUITransactionSession instead for storing sessions.");
$sClass = 'privUITransactionSession'; $sClass = 'privUITransactionSession';
} }
@@ -62,13 +61,11 @@ class privUITransaction
public static function IsTransactionValid($id, $bRemoveTransaction = true) public static function IsTransactionValid($id, $bRemoveTransaction = true)
{ {
$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled'); $bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
if (!$bTransactionsEnabled) if (!$bTransactionsEnabled) {
{
return true; // All values are valid return true; // All values are valid
} }
$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage'); $sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
if (!class_exists($sClass, false)) if (!class_exists($sClass, false)) {
{
$sClass = 'privUITransactionSession'; $sClass = 'privUITransactionSession';
} }
@@ -83,13 +80,11 @@ class privUITransaction
public static function RemoveTransaction($id) public static function RemoveTransaction($id)
{ {
$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled'); $bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
if (!$bTransactionsEnabled) if (!$bTransactionsEnabled) {
{
return; // Nothing to do return; // Nothing to do
} }
$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage'); $sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
if (!class_exists($sClass, false)) if (!class_exists($sClass, false)) {
{
$sClass = 'privUITransactionSession'; $sClass = 'privUITransactionSession';
} }
@@ -114,14 +109,13 @@ class privUITransactionSession
*/ */
public static function GetNewTransactionId() public static function GetNewTransactionId()
{ {
if (!Session::IsSet('transactions')) if (!Session::IsSet('transactions')) {
{
Session::Set('transactions', []); Session::Set('transactions', []);
} }
// Strictly speaking, the two lines below should be grouped together // Strictly speaking, the two lines below should be grouped together
// by a critical section // by a critical section
// sem_acquire($rSemIdentified); // sem_acquire($rSemIdentified);
$id = static::GetUserPrefix() . str_replace(array('.', ' '), '', microtime()); $id = static::GetUserPrefix().str_replace(['.', ' '], '', microtime());
Session::Set(['transactions', $id], true); Session::Set(['transactions', $id], true);
// sem_release($rSemIdentified); // sem_release($rSemIdentified);
@@ -139,16 +133,13 @@ class privUITransactionSession
public static function IsTransactionValid($id, $bRemoveTransaction = true) public static function IsTransactionValid($id, $bRemoveTransaction = true)
{ {
$bResult = false; $bResult = false;
if (Session::IsSet('transactions')) if (Session::IsSet('transactions')) {
{
// Strictly speaking, the eight lines below should be grouped together // Strictly speaking, the eight lines below should be grouped together
// inside the same critical section as above // inside the same critical section as above
// sem_acquire($rSemIdentified); // sem_acquire($rSemIdentified);
if (Session::IsSet(['transactions', $id])) if (Session::IsSet(['transactions', $id])) {
{
$bResult = true; $bResult = true;
if ($bRemoveTransaction) if ($bRemoveTransaction) {
{
Session::Unset(['transactions', $id]); Session::Unset(['transactions', $id]);
} }
} }
@@ -164,13 +155,11 @@ class privUITransactionSession
*/ */
public static function RemoveTransaction($id) public static function RemoveTransaction($id)
{ {
if (Session::IsSet('transactions')) if (Session::IsSet('transactions')) {
{
// Strictly speaking, the three lines below should be grouped together // Strictly speaking, the three lines below should be grouped together
// inside the same critical section as above // inside the same critical section as above
// sem_acquire($rSemIdentified); // sem_acquire($rSemIdentified);
if (Session::IsSet(['transactions', $id])) if (Session::IsSet(['transactions', $id])) {
{
Session::Unset(['transactions', $id]); Session::Unset(['transactions', $id]);
} }
// sem_release($rSemIdentified); // sem_release($rSemIdentified);
@@ -197,7 +186,7 @@ class privUITransactionSession
class privUITransactionFile class privUITransactionFile
{ {
/** @var int Value to use when no user logged */ /** @var int Value to use when no user logged */
const UNAUTHENTICATED_USER_ID = -666; public const UNAUTHENTICATED_USER_ID = -666;
/** /**
* @return int current user id, or {@see self::UNAUTHENTICATED_USER_ID} if no user logged * @return int current user id, or {@see self::UNAUTHENTICATED_USER_ID} if no user logged
@@ -228,22 +217,18 @@ class privUITransactionFile
*/ */
public static function GetNewTransactionId() public static function GetNewTransactionId()
{ {
if (!is_dir(utils::GetDataPath().'transactions')) if (!is_dir(utils::GetDataPath().'transactions')) {
{ if (!is_writable(APPROOT.'data')) {
if (!is_writable(APPROOT.'data'))
{
throw new Exception('The directory "'.APPROOT.'data" must be writable to the application.'); throw new Exception('The directory "'.APPROOT.'data" must be writable to the application.');
} }
// condition avoids race condition N°2345 // condition avoids race condition N°2345
// See https://github.com/kalessil/phpinspectionsea/blob/master/docs/probable-bugs.md#mkdir-race-condition // See https://github.com/kalessil/phpinspectionsea/blob/master/docs/probable-bugs.md#mkdir-race-condition
if (!mkdir($concurrentDirectory = utils::GetDataPath().'transactions') && !is_dir($concurrentDirectory)) if (!mkdir($concurrentDirectory = utils::GetDataPath().'transactions') && !is_dir($concurrentDirectory)) {
{
throw new Exception('Failed to create the directory "'.utils::GetDataPath().'transactions". Ajust the rights on the parent directory or let an administrator create the transactions directory and give the web sever enough rights to write into it.'); throw new Exception('Failed to create the directory "'.utils::GetDataPath().'transactions". Ajust the rights on the parent directory or let an administrator create the transactions directory and give the web sever enough rights to write into it.');
} }
} }
if (!is_writable(utils::GetDataPath().'transactions')) if (!is_writable(utils::GetDataPath().'transactions')) {
{
throw new Exception('The directory "'.utils::GetDataPath().'transactions" must be writable to the application.'); throw new Exception('The directory "'.utils::GetDataPath().'transactions" must be writable to the application.');
} }
@@ -277,8 +262,7 @@ class privUITransactionFile
// Constraint the transaction file within utils::GetDataPath().'transactions' // Constraint the transaction file within utils::GetDataPath().'transactions'
$sTransactionDir = realpath(utils::GetDataPath().'transactions'); $sTransactionDir = realpath(utils::GetDataPath().'transactions');
$sFilepath = utils::RealPath($sTransactionDir.'/'.$id, $sTransactionDir); $sFilepath = utils::RealPath($sTransactionDir.'/'.$id, $sTransactionDir);
if (($sFilepath === false) || (strlen($sTransactionDir) == strlen($sFilepath))) if (($sFilepath === false) || (strlen($sTransactionDir) == strlen($sFilepath))) {
{
return false; return false;
} }
@@ -297,15 +281,11 @@ class privUITransactionFile
return false; return false;
} }
if ($bRemoveTransaction) if ($bRemoveTransaction) {
{
$bResult = @unlink($sFilepath); $bResult = @unlink($sFilepath);
if (!$bResult) if (!$bResult) {
{
self::Error('IsTransactionValid: FAILED to remove transaction '.$id); self::Error('IsTransactionValid: FAILED to remove transaction '.$id);
} } else {
else
{
self::Info('IsTransactionValid: OK. Removed transaction: '.$id); self::Info('IsTransactionValid: OK. Removed transaction: '.$id);
} }
} }
@@ -350,10 +330,8 @@ class privUITransactionFile
$iLimit = time() - 24 * 3600; $iLimit = time() - 24 * 3600;
$sPattern = $sTransactionDir ? "$sTransactionDir/*" : utils::GetDataPath().'transactions/*'; $sPattern = $sTransactionDir ? "$sTransactionDir/*" : utils::GetDataPath().'transactions/*';
$aTransactions = glob($sPattern); $aTransactions = glob($sPattern);
foreach($aTransactions as $sFileName) foreach ($aTransactions as $sFileName) {
{ if (filemtime($sFileName) < $iLimit) {
if (filemtime($sFileName) < $iLimit)
{
@unlink($sFileName); @unlink($sFileName);
self::Info('CleanupOldTransactions: Deleted transaction: '.$sFileName); self::Info('CleanupOldTransactions: Deleted transaction: '.$sFileName);
} }
@@ -367,10 +345,9 @@ class privUITransactionFile
protected static function GetPendingTransactions() protected static function GetPendingTransactions()
{ {
clearstatcache(); clearstatcache();
$aResult = array(); $aResult = [];
$aTransactions = glob(utils::GetDataPath().'transactions/'.self::GetUserPrefix().'*'); $aTransactions = glob(utils::GetDataPath().'transactions/'.self::GetUserPrefix().'*');
foreach($aTransactions as $sFileName) foreach ($aTransactions as $sFileName) {
{
$aResult[] = date('Y-m-d H:i:s', filemtime($sFileName)).' - '.basename($sFileName); $aResult[] = date('Y-m-d H:i:s', filemtime($sFileName)).' - '.basename($sFileName);
} }
sort($aResult); sort($aResult);
@@ -404,7 +381,8 @@ class privUITransactionFile
self::Write('Error | '.$sText); self::Write('Error | '.$sText);
} }
protected static function IsLogEnabled() { protected static function IsLogEnabled()
{
$oConfig = MetaModel::GetConfig(); $oConfig = MetaModel::GetConfig();
if (is_null($oConfig)) { if (is_null($oConfig)) {
return false; return false;

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -54,8 +55,8 @@ require_once(APPROOT.'/application/displayblock.class.inc.php');
*/ */
class UIExtKeyWidget class UIExtKeyWidget
{ {
const ENUM_OUTPUT_FORMAT_CSV = 'csv'; public const ENUM_OUTPUT_FORMAT_CSV = 'csv';
const ENUM_OUTPUT_FORMAT_JSON = 'json'; public const ENUM_OUTPUT_FORMAT_JSON = 'json';
protected $iId; protected $iId;
protected $sTargetClass; protected $sTargetClass;
@@ -87,10 +88,20 @@ class UIExtKeyWidget
* @since 2.7.7 3.0.1 3.1.0 N°3129 Add default value for $aArgs for PHP 8.0 compat * @since 2.7.7 3.0.1 3.1.0 N°3129 Add default value for $aArgs for PHP 8.0 compat
*/ */
public static function DisplayFromAttCode( public static function DisplayFromAttCode(
$oPage, $sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName = '', $sFormPrefix = '', $oPage,
$aArgs = [], $bSearchMode = false, &$sInputType = '' $sAttCode,
) $sClass,
{ $sTitle,
$oAllowedValues,
$value,
$iInputId,
$bMandatory,
$sFieldName = '',
$sFormPrefix = '',
$aArgs = [],
$bSearchMode = false,
&$sInputType = ''
) {
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
$sTargetClass = $oAttDef->GetTargetClass(); $sTargetClass = $oAttDef->GetTargetClass();
$iMaxComboLength = $oAttDef->GetMaximumComboLength(); $iMaxComboLength = $oAttDef->GetMaximumComboLength();
@@ -102,8 +113,7 @@ class UIExtKeyWidget
} }
$oWidget = new UIExtKeyWidget($sTargetClass, $iInputId, $sAttCode, $bSearchMode); $oWidget = new UIExtKeyWidget($sTargetClass, $iInputId, $sAttCode, $bSearchMode);
if (!$bSearchMode) { if (!$bSearchMode) {
switch ($sDisplayStyle) switch ($sDisplayStyle) {
{
case 'radio': case 'radio':
case 'radio_horizontal': case 'radio_horizontal':
case 'radio_vertical': case 'radio_vertical':
@@ -114,12 +124,38 @@ class UIExtKeyWidget
case 'select': case 'select':
case 'list': case 'list':
default: default:
return $oWidget->DisplaySelect($oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, return $oWidget->DisplaySelect(
$bMandatory, $sFieldName, $sFormPrefix, $aArgs, $sInputType); $oPage,
$iMaxComboLength,
$bAllowTargetCreation,
$sTitle,
$oAllowedValues,
$value,
$bMandatory,
$sFieldName,
$sFormPrefix,
$aArgs,
$sInputType
);
} }
} else { } else {
return $oWidget->Display($oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, return $oWidget->Display(
$bMandatory, $sFieldName, $sFormPrefix, $aArgs, null, $sDisplayStyle, true, $sInputType); $oPage,
$iMaxComboLength,
$bAllowTargetCreation,
$sTitle,
$oAllowedValues,
$value,
$iInputId,
$bMandatory,
$sFieldName,
$sFormPrefix,
$aArgs,
null,
$sDisplayStyle,
true,
$sInputType
);
} }
} }
@@ -158,7 +194,7 @@ class UIExtKeyWidget
* @since 3.0.0 N°2508 - Include Obsolescence icon within list and autocomplete * @since 3.0.0 N°2508 - Include Obsolescence icon within list and autocomplete
* @since 3.0.0 N°3750 new $sInputType parameter * @since 3.0.0 N°3750 new $sInputType parameter
*/ */
public function DisplaySelect(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, DBObjectset $oAllowedValues, $value, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), &$sInputType = '') public function DisplaySelect(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, DBObjectset $oAllowedValues, $value, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = [], &$sInputType = '')
{ {
$sTitle = addslashes($sTitle); $sTitle = addslashes($sTitle);
$oPage->LinkScriptFromAppRoot('js/extkeywidget.js'); $oPage->LinkScriptFromAppRoot('js/extkeywidget.js');
@@ -281,21 +317,17 @@ EOF
$oPage->add_ready_script("$('#$this->iId').one('validate', function() { $(this).trigger('change'); } );"); $oPage->add_ready_script("$('#$this->iId').one('validate', function() { $(this).trigger('change'); } );");
} }
$sHTMLValue .= "<div class=\"ibo-input-select--action-buttons\">"; $sHTMLValue .= "<div class=\"ibo-input-select--action-buttons\">";
} } else {
else
{
// Too many choices, use an autocomplete // Too many choices, use an autocomplete
// Check that the given value is allowed // Check that the given value is allowed
$oSearch = $oAllowedValues->GetFilter(); $oSearch = $oAllowedValues->GetFilter();
$oSearch->AddCondition('id', $value); $oSearch->AddCondition('id', $value);
$oSet = new DBObjectSet($oSearch); $oSet = new DBObjectSet($oSearch);
if ($oSet->Count() == 0) if ($oSet->Count() == 0) {
{
$value = null; $value = null;
} }
if (is_null($value) || ($value == 0)) // Null values are displayed as '' if (is_null($value) || ($value == 0)) { // Null values are displayed as ''
{
$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : ''; $sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : '';
} else { } else {
$sDisplayValue = $this->GetObjectName($value); $sDisplayValue = $this->GetObjectName($value);
@@ -376,36 +408,30 @@ JS
$sHTMLValue = "<div class=\"field_input_zone field_input_extkey\">"; $sHTMLValue = "<div class=\"field_input_zone field_input_extkey\">";
if (is_null($oAllowedValues)) if (is_null($oAllowedValues)) {
{
throw new Exception('Implementation: null value for allowed values definition'); throw new Exception('Implementation: null value for allowed values definition');
} }
$oAllowedValues->SetShowObsoleteData(utils::ShowObsoleteData()); $oAllowedValues->SetShowObsoleteData(utils::ShowObsoleteData());
// We just need to compare the number of entries with MaxComboLength, so no need to get the real count. // We just need to compare the number of entries with MaxComboLength, so no need to get the real count.
if (!$oAllowedValues->CountExceeds($iMaxComboLength)) if (!$oAllowedValues->CountExceeds($iMaxComboLength)) {
{
// Discrete list of values, use a SELECT or RADIO buttons depending on the config // Discrete list of values, use a SELECT or RADIO buttons depending on the config
$sValidationField = null; $sValidationField = null;
$bVertical = ($sDisplayStyle != 'radio_horizontal'); $bVertical = ($sDisplayStyle != 'radio_horizontal');
$bExtensions = false; $bExtensions = false;
$oAllowedValues->Rewind(); $oAllowedValues->Rewind();
$aAllowedValues = array(); $aAllowedValues = [];
while($oObj = $oAllowedValues->Fetch()) while ($oObj = $oAllowedValues->Fetch()) {
{
$aAllowedValues[$oObj->GetKey()] = $oObj->GetName(); $aAllowedValues[$oObj->GetKey()] = $oObj->GetName();
} }
$sHTMLValue .= $oPage->GetRadioButtons($aAllowedValues, $value, $this->iId, "{$sAttrFieldPrefix}{$sFieldName}", false /* $bMandatory will be placed manually */, $bVertical, $sValidationField); $sHTMLValue .= $oPage->GetRadioButtons($aAllowedValues, $value, $this->iId, "{$sAttrFieldPrefix}{$sFieldName}", false /* $bMandatory will be placed manually */, $bVertical, $sValidationField);
$aEventsList[] = 'change'; $aEventsList[] = 'change';
} } else {
else
{
$sHTMLValue .= "unable to display. Too much values"; $sHTMLValue .= "unable to display. Too much values";
} }
$sHTMLValue .= '<div class="ibo-input-select--action-buttons">'; $sHTMLValue .= '<div class="ibo-input-select--action-buttons">';
if ($bExtensions && MetaModel::IsHierarchicalClass($this->sTargetClass) !== false) if ($bExtensions && MetaModel::IsHierarchicalClass($this->sTargetClass) !== false) {
{
$sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\" id=\"mini_tree_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"><i class=\"fas fa-sitemap\"></i></div></span>"; $sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\" id=\"mini_tree_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"><i class=\"fas fa-sitemap\"></i></div></span>";
$oPage->add_ready_script( $oPage->add_ready_script(
<<<JS <<<JS
@@ -416,8 +442,7 @@ JS
JS JS
); );
} }
if ($bCreate && $bExtensions) if ($bCreate && $bExtensions) {
{
$sCallbackName = (MetaModel::IsAbstract($this->sTargetClass)) ? 'SelectObjectClass' : 'CreateObject'; $sCallbackName = (MetaModel::IsAbstract($this->sTargetClass)) ? 'SelectObjectClass' : 'CreateObject';
$sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\" id=\"mini_add_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.{$sCallbackName}();\"><i class=\"fas fa-plus\"></i></div></span>"; $sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\" id=\"mini_add_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.{$sCallbackName}();\"><i class=\"fas fa-plus\"></i></div></span>";
@@ -471,7 +496,7 @@ JS
* *
* @since 3.0.0 N°3750 new $sInputType parameter * @since 3.0.0 N°3750 new $sInputType parameter
*/ */
public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, DBObjectset $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), $bSearchMode = null, $sDisplayStyle = 'select', $bSearchMultiple = true, &$sInputType = '') public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, DBObjectset $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = [], $bSearchMode = null, $sDisplayStyle = 'select', $bSearchMultiple = true, &$sInputType = '')
{ {
if (!is_null($bSearchMode)) { if (!is_null($bSearchMode)) {
$this->bSearchMode = $bSearchMode; $this->bSearchMode = $bSearchMode;
@@ -521,7 +546,7 @@ JS
$bVertical = ($sDisplayStyle != 'radio_horizontal'); $bVertical = ($sDisplayStyle != 'radio_horizontal');
$bExtensions = false; $bExtensions = false;
$oAllowedValues->Rewind(); $oAllowedValues->Rewind();
$aAllowedValues = array(); $aAllowedValues = [];
while ($oObj = $oAllowedValues->Fetch()) { while ($oObj = $oAllowedValues->Fetch()) {
$aAllowedValues[$oObj->GetKey()] = $oObj->GetName(); $aAllowedValues[$oObj->GetKey()] = $oObj->GetName();
} }
@@ -574,14 +599,14 @@ EOF
$sInputType = CmdbAbstractObject::ENUM_INPUT_TYPE_DROPDOWN_RAW; $sInputType = CmdbAbstractObject::ENUM_INPUT_TYPE_DROPDOWN_RAW;
if (($this->bSearchMode) && $bSearchMultiple) { if (($this->bSearchMode) && $bSearchMultiple) {
$sInputType = CmdbAbstractObject::ENUM_INPUT_TYPE_DROPDOWN_MULTIPLE_CHOICES; $sInputType = CmdbAbstractObject::ENUM_INPUT_TYPE_DROPDOWN_MULTIPLE_CHOICES;
$aOptions = array( $aOptions = [
'header' => true, 'header' => true,
'checkAllText' => Dict::S('UI:SearchValue:CheckAll'), 'checkAllText' => Dict::S('UI:SearchValue:CheckAll'),
'uncheckAllText' => Dict::S('UI:SearchValue:UncheckAll'), 'uncheckAllText' => Dict::S('UI:SearchValue:UncheckAll'),
'noneSelectedText' => Dict::S('UI:SearchValue:Any'), 'noneSelectedText' => Dict::S('UI:SearchValue:Any'),
'selectedText' => Dict::S('UI:SearchValue:NbSelected'), 'selectedText' => Dict::S('UI:SearchValue:NbSelected'),
'selectedList' => 1, 'selectedList' => 1,
); ];
$sJSOptions = json_encode($aOptions); $sJSOptions = json_encode($aOptions);
$oPage->add_ready_script("$('.multiselect').multiselect($sJSOptions);"); $oPage->add_ready_script("$('.multiselect').multiselect($sJSOptions);");
} }
@@ -606,8 +631,7 @@ EOF
$value = null; $value = null;
} }
if (is_null($value) || ($value == 0)) // Null values are displayed as '' if (is_null($value) || ($value == 0)) { // Null values are displayed as ''
{
$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : ''; $sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : '';
} else { } else {
$sDisplayValue = $this->GetObjectName($value); $sDisplayValue = $this->GetObjectName($value);
@@ -673,20 +697,22 @@ JS
$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode); $oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
/** @var \DBObject $oCurrObject */ /** @var \DBObject $oCurrObject */
$aArgs = $oCurrObject->ToArgsForQuery(); $aArgs = $oCurrObject->ToArgsForQuery();
$aParams = array('query_params' => $aArgs); $aParams = ['query_params' => $aArgs];
$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aArgs); $oSet = $oAttDef->GetAllowedValuesAsObjectSet($aArgs);
$oFilter = $oSet->GetFilter(); $oFilter = $oSet->GetFilter();
} elseif (!empty($this->sFilter)) { } elseif (!empty($this->sFilter)) {
$aParams = array(); $aParams = [];
$oFilter = DBObjectSearch::FromOQL($this->sFilter); $oFilter = DBObjectSearch::FromOQL($this->sFilter);
} else { } else {
$aParams = array(); $aParams = [];
$oFilter = new DBObjectSearch($this->sTargetClass); $oFilter = new DBObjectSearch($this->sTargetClass);
} }
$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode); $oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
$oBlock = new DisplayBlock($oFilter, 'search', false, $aParams); $oBlock = new DisplayBlock($oFilter, 'search', false, $aParams);
$oPage->AddUiBlock($oBlock->GetDisplay($oPage, 'dtc_'.$this->iId, $oPage->AddUiBlock($oBlock->GetDisplay(
array( $oPage,
'dtc_'.$this->iId,
[
'menu' => false, 'menu' => false,
'currentId' => $this->iId, 'currentId' => $this->iId,
'table_id' => "dr_{$this->iId}", 'table_id' => "dr_{$this->iId}",
@@ -694,12 +720,13 @@ JS
'selection_mode' => true, 'selection_mode' => true,
'selection_type' => 'single', 'selection_type' => 'single',
'cssCount' => '#count_'.$this->iId.'_results', 'cssCount' => '#count_'.$this->iId.'_results',
) ]
)); ));
$sCancel = Dict::S('UI:Button:Cancel'); $sCancel = Dict::S('UI:Button:Cancel');
$sOK = Dict::S('UI:Button:Ok'); $sOK = Dict::S('UI:Button:Ok');
$sEmptyList = Dict::S('UI:Message:EmptyList:UseSearchForm'); $sEmptyList = Dict::S('UI:Message:EmptyList:UseSearchForm');
$oPage->add(<<<HTML $oPage->add(
<<<HTML
<form id="fr_{$this->iId}" OnSubmit="return oACWidget_{$this->iId}.DoOk();"> <form id="fr_{$this->iId}" OnSubmit="return oACWidget_{$this->iId}.DoOk();">
<div id="dr_{$this->iId}"> <div id="dr_{$this->iId}">
<div><p>{$sEmptyList}</p></div> <div><p>{$sEmptyList}</p></div>
@@ -711,7 +738,8 @@ HTML
); );
$sDialogTitleSanitized = addslashes(utils::HtmlToText($sTitle)); $sDialogTitleSanitized = addslashes(utils::HtmlToText($sTitle));
$oPage->add_ready_script(<<<JS $oPage->add_ready_script(
<<<JS
$('#ac_dlg_{$this->iId}').dialog({ $('#ac_dlg_{$this->iId}').dialog({
width: $(window).width()*0.8, width: $(window).width()*0.8,
height: $(window).height()*0.8, height: $(window).height()*0.8,
@@ -751,14 +779,12 @@ JS
*/ */
public function SearchObjectsToSelect(WebPage $oP, $sFilter, $sRemoteClass = '', $oObj = null) public function SearchObjectsToSelect(WebPage $oP, $sFilter, $sRemoteClass = '', $oObj = null)
{ {
if (is_null($sFilter)) if (is_null($sFilter)) {
{
throw new Exception('Implementation: null value for allowed values definition'); throw new Exception('Implementation: null value for allowed values definition');
} }
$oFilter = DBObjectSearch::FromOQL($sFilter); $oFilter = DBObjectSearch::FromOQL($sFilter);
if (strlen($sRemoteClass) > 0) if (strlen($sRemoteClass) > 0) {
{
$oFilter->ChangeClass($sRemoteClass); $oFilter->ChangeClass($sRemoteClass);
} }
$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode); $oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
@@ -766,8 +792,8 @@ JS
// Current extkey value, so we can display event if it is not available anymore (eg. archived). // Current extkey value, so we can display event if it is not available anymore (eg. archived).
$iCurrentExtKeyId = (is_null($oObj)) ? 0 : $oObj->Get($this->sAttCode); $iCurrentExtKeyId = (is_null($oObj)) ? 0 : $oObj->Get($this->sAttCode);
$oBlock = new DisplayBlock($oFilter, 'list_search', false, array('query_params' => array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId))); $oBlock = new DisplayBlock($oFilter, 'list_search', false, ['query_params' => ['this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId]]);
$oBlock->Display($oP, $this->iId.'_results', array('this' => $oObj, 'cssCount'=> '#count_'.$this->iId.'_results', 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single', 'table_id' => 'select_'.$this->sAttCode)); // Don't display the 'Actions' menu on the results $oBlock->Display($oP, $this->iId.'_results', ['this' => $oObj, 'cssCount' => '#count_'.$this->iId.'_results', 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single', 'table_id' => 'select_'.$this->sAttCode]); // Don't display the 'Actions' menu on the results
} }
/** /**
@@ -799,38 +825,32 @@ JS
$oValuesSet->SetSort(false); $oValuesSet->SetSort(false);
$oValuesSet->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode); $oValuesSet->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
$oValuesSet->SetLimit($iMax); $oValuesSet->SetLimit($iMax);
$aValuesStartWith = $oValuesSet->GetValuesForAutocomplete(array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId), $sContains, 'start_with'); $aValuesStartWith = $oValuesSet->GetValuesForAutocomplete(['this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId], $sContains, 'start_with');
asort($aValuesStartWith); asort($aValuesStartWith);
$aValues = $aValuesStartWith; $aValues = $aValuesStartWith;
if (sizeof($aValues) < $iMax) { if (sizeof($aValues) < $iMax) {
$aValuesContains = $oValuesSet->GetValuesForAutocomplete(array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId), $sContains, 'contains'); $aValuesContains = $oValuesSet->GetValuesForAutocomplete(['this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId], $sContains, 'contains');
asort($aValuesContains); asort($aValuesContains);
$iSize = sizeof($aValues); $iSize = sizeof($aValues);
foreach ($aValuesContains as $sKey => $sFriendlyName) foreach ($aValuesContains as $sKey => $sFriendlyName) {
{ if (!isset($aValues[$sKey])) {
if (!isset($aValues[$sKey]))
{
$aValues[$sKey] = $sFriendlyName; $aValues[$sKey] = $sFriendlyName;
if (++$iSize >= $iMax) if (++$iSize >= $iMax) {
{
break; break;
} }
} }
} }
} } elseif (!in_array($sContains, $aValues)) {
elseif (!in_array($sContains, $aValues)) $aValuesEquals = $oValuesSet->GetValuesForAutocomplete(['this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId], $sContains, 'equals');
{
$aValuesEquals = $oValuesSet->GetValuesForAutocomplete(array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId), $sContains, 'equals');
// Note: Here we cannot use array_merge as it would reindex the numeric keys starting from 0 when keys are actually the objects ID. // Note: Here we cannot use array_merge as it would reindex the numeric keys starting from 0 when keys are actually the objects ID.
// As a workaround we use array_replace as it does preserve numeric keys. It's ok if some values from $aValuesEquals are replaced with values from $aValues as they contain the same data. // As a workaround we use array_replace as it does preserve numeric keys. It's ok if some values from $aValuesEquals are replaced with values from $aValues as they contain the same data.
$aValues = array_replace($aValuesEquals, $aValues); $aValues = array_replace($aValuesEquals, $aValues);
} }
switch($sOutputFormat) switch ($sOutputFormat) {
{
case static::ENUM_OUTPUT_FORMAT_JSON: case static::ENUM_OUTPUT_FORMAT_JSON:
$aJsonMap = array(); $aJsonMap = [];
foreach ($aValues as $sKey => $aValue) { foreach ($aValues as $sKey => $aValue) {
$aElt = ['value' => $sKey, 'label' => utils::EscapeHtml($aValue['label']), 'obsolescence_flag' => $aValue['obsolescence_flag']]; $aElt = ['value' => $sKey, 'label' => utils::EscapeHtml($aValue['label']), 'obsolescence_flag' => $aValue['obsolescence_flag']];
if ($aValue['additional_field'] != '') { if ($aValue['additional_field'] != '') {
@@ -851,8 +871,7 @@ JS
break; break;
case static::ENUM_OUTPUT_FORMAT_CSV: case static::ENUM_OUTPUT_FORMAT_CSV:
foreach($aValues as $sKey => $aValue) foreach ($aValues as $sKey => $aValue) {
{
$oP->add(trim($aValue['label'])."\t".$sKey."\n"); $oP->add(trim($aValue['label'])."\t".$sKey."\n");
} }
break; break;
@@ -874,7 +893,7 @@ JS
*/ */
public function GetObjectName($iObjId, $sFormAttCode = null) public function GetObjectName($iObjId, $sFormAttCode = null)
{ {
$aModifierProps = array(); $aModifierProps = [];
$aModifierProps['UserRightsGetSelectFilter']['bSearchMode'] = $this->bSearchMode; $aModifierProps['UserRightsGetSelectFilter']['bSearchMode'] = $this->bSearchMode;
$oObj = MetaModel::GetObject($this->sTargetClass, $iObjId, false, false, $aModifierProps); $oObj = MetaModel::GetObject($this->sTargetClass, $iObjId, false, false, $aModifierProps);
@@ -884,9 +903,7 @@ JS
} else { } else {
return $oObj->Get($sFormAttCode); return $oObj->Get($sFormAttCode);
} }
} } else {
else
{
return ''; return '';
} }
} }
@@ -905,17 +922,16 @@ JS
// For security reasons: check that the "proposed" class is actually a subclass of the linked class // For security reasons: check that the "proposed" class is actually a subclass of the linked class
// and that the current user is allowed to create objects of this class // and that the current user is allowed to create objects of this class
$aSubClasses = MetaModel::EnumChildClasses($this->sTargetClass, ENUM_CHILD_CLASSES_ALL); $aSubClasses = MetaModel::EnumChildClasses($this->sTargetClass, ENUM_CHILD_CLASSES_ALL);
$aPossibleClasses = array(); $aPossibleClasses = [];
foreach($aSubClasses as $sCandidateClass) foreach ($aSubClasses as $sCandidateClass) {
{ if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES)) {
if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
{
$aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass); $aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass);
} }
} }
$sClassLabel = MetaModel::GetName($this->sTargetClass); $sClassLabel = MetaModel::GetName($this->sTargetClass);
$sDialogTitle = Dict::Format('UI:CreationTitle_Class', $sClassLabel);; $sDialogTitle = Dict::Format('UI:CreationTitle_Class', $sClassLabel);
;
$oBlock = UIContentBlockUIBlockFactory::MakeStandard('ac_create_'.$this->iId, ['ibo-is-visible']); $oBlock = UIContentBlockUIBlockFactory::MakeStandard('ac_create_'.$this->iId, ['ibo-is-visible']);
$oPage->AddSubBlock($oBlock); $oPage->AddSubBlock($oBlock);
$oClassForm = FormUIBlockFactory::MakeStandard(); $oClassForm = FormUIBlockFactory::MakeStandard();
@@ -941,15 +957,13 @@ JS
$oAppContext->InitObjectFromContext($oNewObj); $oAppContext->InitObjectFromContext($oNewObj);
$oNewObj->PrefillForm('creation_from_extkey', $aPrefillFormParam); $oNewObj->PrefillForm('creation_from_extkey', $aPrefillFormParam);
// 2nd set the default values from the constraint on the external key... if any // 2nd set the default values from the constraint on the external key... if any
if ( ($oCurrObject != null) && ($this->sAttCode != '')) if (($oCurrObject != null) && ($this->sAttCode != '')) {
{
$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode); $oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
$aParams = array('this' => $oCurrObject); $aParams = ['this' => $oCurrObject];
$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aParams); $oSet = $oAttDef->GetAllowedValuesAsObjectSet($aParams);
$aConsts = $oSet->ListConstantFields(); $aConsts = $oSet->ListConstantFields();
$sClassAlias = $oSet->GetFilter()->GetClassAlias(); $sClassAlias = $oSet->GetFilter()->GetClassAlias();
if (isset($aConsts[$sClassAlias])) if (isset($aConsts[$sClassAlias])) {
{
foreach ($aConsts[$sClassAlias] as $sAttCode => $value) { foreach ($aConsts[$sClassAlias] as $sAttCode => $value) {
$oNewObj->Set($sAttCode, $value); $oNewObj->Set($sAttCode, $value);
} }
@@ -962,16 +976,17 @@ JS
$sClassLabel = MetaModel::GetName($this->sTargetClass); $sClassLabel = MetaModel::GetName($this->sTargetClass);
$sHeaderTitleEscaped = utils::EscapeHtml(Dict::Format('UI:CreationTitle_Class', $sClassLabel)); $sHeaderTitleEscaped = utils::EscapeHtml(Dict::Format('UI:CreationTitle_Class', $sClassLabel));
$oPage->add(<<<HTML $oPage->add(
<<<HTML
<div id="ac_create_{$this->iId}" title="{$sHeaderTitleEscaped}"> <div id="ac_create_{$this->iId}" title="{$sHeaderTitleEscaped}">
<div id="dcr_{$this->iId}"> <div id="dcr_{$this->iId}">
HTML HTML
); );
$aFormExtraParams = array( $aFormExtraParams = [
'formPrefix' => $this->iId, 'formPrefix' => $this->iId,
'noRelations' => true, 'noRelations' => true,
); ];
// Remove blob edition from creation form @see N°5863 to allow blob edition in modal context // Remove blob edition from creation form @see N°5863 to allow blob edition in modal context
FormHelper::DisableAttributeBlobInputs($this->sTargetClass, $aFormExtraParams); FormHelper::DisableAttributeBlobInputs($this->sTargetClass, $aFormExtraParams);
@@ -980,14 +995,16 @@ HTML
$oPage->AddUiBlock(FormHelper::GetAlertForMandatoryAttributeBlobInputsInModal(FormHelper::ENUM_MANDATORY_BLOB_MODE_CREATE)); $oPage->AddUiBlock(FormHelper::GetAlertForMandatoryAttributeBlobInputsInModal(FormHelper::ENUM_MANDATORY_BLOB_MODE_CREATE));
} }
cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, array(), $aFormExtraParams); cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, [], $aFormExtraParams);
$oPage->add(<<<HTML $oPage->add(
<<<HTML
</div> </div>
</div> </div>
HTML HTML
); );
$oPage->add_ready_script(<<<JS $oPage->add_ready_script(
<<<JS
$('#ac_create_{$this->iId}').dialog({ width: $(window).width() * 0.6, height: 'auto', maxHeight: $(window).height() - 50, autoOpen: false, modal: true}); $('#ac_create_{$this->iId}').dialog({ width: $(window).width() * 0.6, height: 'auto', maxHeight: $(window).height() - 50, autoOpen: false, modal: true});
$('#dcr_{$this->iId} form').removeAttr('onsubmit'); $('#dcr_{$this->iId} form').removeAttr('onsubmit');
$('#dcr_{$this->iId} form').find('button[type="submit"]').on('click', oACWidget_{$this->iId}.DoCreateObject); $('#dcr_{$this->iId} form').find('button[type="submit"]').on('click', oACWidget_{$this->iId}.DoCreateObject);
@@ -1003,14 +1020,13 @@ JS
$sDialogTitle = addslashes(Dict::Format('UI:HierarchyOf_Class', MetaModel::GetName($this->sTargetClass))); $sDialogTitle = addslashes(Dict::Format('UI:HierarchyOf_Class', MetaModel::GetName($this->sTargetClass)));
$oPage->add('<div id="dlg_tree_'.$this->iId.'"><div class="wizContainer" style="vertical-align:top;"><div style="margin-bottom:5px;" id="tree_'.$this->iId.'">'); $oPage->add('<div id="dlg_tree_'.$this->iId.'"><div class="wizContainer" style="vertical-align:top;"><div style="margin-bottom:5px;" id="tree_'.$this->iId.'">');
$oPage->add('<table style="width:100%"><tr><td>'); $oPage->add('<table style="width:100%"><tr><td>');
if (is_null($sFilter)) if (is_null($sFilter)) {
{
throw new Exception('Implementation: null value for allowed values definition'); throw new Exception('Implementation: null value for allowed values definition');
} }
$oFilter = DBObjectSearch::FromOQL($sFilter); $oFilter = DBObjectSearch::FromOQL($sFilter);
$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode); $oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
$oSet = new DBObjectSet($oFilter, array(), array('this' => $oObj, 'current_extkey_id' => $currValue)); $oSet = new DBObjectSet($oFilter, [], ['this' => $oObj, 'current_extkey_id' => $currValue]);
$oSet->SetShowObsoleteData(utils::ShowObsoleteData()); $oSet->SetShowObsoleteData(utils::ShowObsoleteData());
@@ -1020,8 +1036,7 @@ JS
$oPage->add('</td></tr></table>'); $oPage->add('</td></tr></table>');
$oPage->add('</div>'); $oPage->add('</div>');
if ($bHasChildLeafs) if ($bHasChildLeafs) {
{
$oPage->add('<span class="treecontrol ibo-button-group" id="treecontrolid"><a class="ibo-button ibo-is-regular ibo-is-neutral" href="?#">'.Dict::S("UI:Treeview:CollapseAll").'</a><a class="ibo-button ibo-is-regular ibo-is-neutral" href="?#">'.Dict::S("UI:Treeview:ExpandAll").'</a></span>'); $oPage->add('<span class="treecontrol ibo-button-group" id="treecontrolid"><a class="ibo-button ibo-is-regular ibo-is-neutral" href="?#">'.Dict::S("UI:Treeview:CollapseAll").'</a><a class="ibo-button ibo-is-regular ibo-is-neutral" href="?#">'.Dict::S("UI:Treeview:ExpandAll").'</a></span>');
} }
@@ -1030,7 +1045,8 @@ JS
$sOkButtonLabel = Dict::S('UI:Button:Ok'); $sOkButtonLabel = Dict::S('UI:Button:Ok');
$sCancelButtonLabel = Dict::S('UI:Button:Cancel'); $sCancelButtonLabel = Dict::S('UI:Button:Cancel');
$oPage->add_ready_script("\$('#tree_$this->iId ul').treeview({ control: '#treecontrolid', persist: 'false'});\n"); $oPage->add_ready_script("\$('#tree_$this->iId ul').treeview({ control: '#treecontrolid', persist: 'false'});\n");
$oPage->add_ready_script(<<<JS $oPage->add_ready_script(
<<<JS
$('#dlg_tree_$this->iId').dialog({ $('#dlg_tree_$this->iId').dialog({
width: 'auto', width: 'auto',
height: 'auto', height: 'auto',
@@ -1069,8 +1085,7 @@ JS
*/ */
public function DoCreateObject($oPage) public function DoCreateObject($oPage)
{ {
try try {
{
$oObj = MetaModel::NewObject($this->sTargetClass); $oObj = MetaModel::NewObject($this->sTargetClass);
$aErrors = $oObj->UpdateObjectFromPostedForm($this->iId); $aErrors = $oObj->UpdateObjectFromPostedForm($this->iId);
if (count($aErrors) == 0) { if (count($aErrors) == 0) {
@@ -1088,13 +1103,12 @@ JS
]); ]);
$oObj->DBInsertNoReload(); $oObj->DBInsertNoReload();
return array('name' => $oObj->GetName(), 'id' => $oObj->GetKey()); return ['name' => $oObj->GetName(), 'id' => $oObj->GetKey()];
} else { } else {
return array('error' => implode(' ', $aErrors), 'id' => 0); return ['error' => implode(' ', $aErrors), 'id' => 0];
} }
} } catch (Exception $e) {
catch (Exception $e) { return ['error' => $e->getMessage(), 'id' => 0];
return array('error' => $e->getMessage(), 'id' => 0);
} }
} }
@@ -1110,32 +1124,27 @@ JS
* @throws \CoreUnexpectedValue * @throws \CoreUnexpectedValue
* @throws \MySQLException * @throws \MySQLException
*/ */
function DumpTree($oP, $oSet, $sParentAttCode, $currValue) public function DumpTree($oP, $oSet, $sParentAttCode, $currValue)
{
$aTree = array();
$aNodes = array();
while($oObj = $oSet->Fetch())
{ {
$aTree = [];
$aNodes = [];
while ($oObj = $oSet->Fetch()) {
$iParentId = $oObj->Get($sParentAttCode); $iParentId = $oObj->Get($sParentAttCode);
if (!isset($aTree[$iParentId])) if (!isset($aTree[$iParentId])) {
{ $aTree[$iParentId] = [];
$aTree[$iParentId] = array();
} }
$aTree[$iParentId][$oObj->GetKey()] = $oObj->GetName(); $aTree[$iParentId][$oObj->GetKey()] = $oObj->GetName();
$aNodes[$oObj->GetKey()] = $oObj; $aNodes[$oObj->GetKey()] = $oObj;
} }
$aParents = array_keys($aTree); $aParents = array_keys($aTree);
$aRoots = array(); $aRoots = [];
foreach($aParents as $id) foreach ($aParents as $id) {
{ if (!array_key_exists($id, $aNodes)) {
if (!array_key_exists($id, $aNodes))
{
$aRoots[] = $id; $aRoots[] = $id;
} }
} }
foreach($aRoots as $iRootId) foreach ($aRoots as $iRootId) {
{
$this->DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue); $this->DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue);
} }
@@ -1143,28 +1152,22 @@ JS
return !$bHasOnlyRootNodes; return !$bHasOnlyRootNodes;
} }
function DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue) public function DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue)
{ {
$bSelect = true; $bSelect = true;
$bMultiple = false; $bMultiple = false;
$sSelect = ''; $sSelect = '';
if (array_key_exists($iRootId, $aTree)) if (array_key_exists($iRootId, $aTree)) {
{
$aSortedRoots = $aTree[$iRootId]; $aSortedRoots = $aTree[$iRootId];
asort($aSortedRoots); asort($aSortedRoots);
$oP->add("<ul>\n"); $oP->add("<ul>\n");
$fUniqueId = microtime(true); $fUniqueId = microtime(true);
foreach($aSortedRoots as $id => $sName) foreach ($aSortedRoots as $id => $sName) {
{ if ($bSelect) {
if ($bSelect)
{
$sChecked = ($aNodes[$id]->GetKey() == $currValue) ? 'checked' : ''; $sChecked = ($aNodes[$id]->GetKey() == $currValue) ? 'checked' : '';
if ($bMultiple) if ($bMultiple) {
{
$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="checkbox" value="'.$aNodes[$id]->GetKey().'" name="selectObject[]" '.$sChecked.'>&nbsp;'; $sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="checkbox" value="'.$aNodes[$id]->GetKey().'" name="selectObject[]" '.$sChecked.'>&nbsp;';
} } else {
else
{
$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;'; $sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;';
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -63,7 +64,7 @@ class UIHTMLEditorWidget
* *
* @return string The HTML fragment to be inserted into the page * @return string The HTML fragment to be inserted into the page
*/ */
public function Display(WebPage $oPage, array $aArgs = array()) : string public function Display(WebPage $oPage, array $aArgs = []): string
{ {
$iId = $this->m_iId; $iId = $this->m_iId;
$sCode = $this->m_sAttCode.$this->m_sNameSuffix; $sCode = $this->m_sAttCode.$this->m_sNameSuffix;

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -38,7 +39,7 @@ class UILinksWidgetDirect
$this->sAttCode = $sAttCode; $this->sAttCode = $sAttCode;
$this->sInputid = $sInputId; $this->sInputid = $sInputId;
$this->sNameSuffix = $sNameSuffix; $this->sNameSuffix = $sNameSuffix;
$this->aZlist = array(); $this->aZlist = [];
$this->sLinkedClass = ''; $this->sLinkedClass = '';
// Compute the list of attributes visible from the given objet: // Compute the list of attributes visible from the given objet:
@@ -47,8 +48,7 @@ class UILinksWidgetDirect
$oLinksetDef = MetaModel::GetAttributeDef($sClass, $sAttCode); $oLinksetDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
$this->sLinkedClass = $oLinksetDef->GetLinkedClass(); $this->sLinkedClass = $oLinksetDef->GetLinkedClass();
$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe(); $sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
switch($oLinksetDef->GetEditMode()) switch ($oLinksetDef->GetEditMode()) {
{
case LINKSET_EDITMODE_INPLACE: // The whole linkset can be edited 'in-place' case LINKSET_EDITMODE_INPLACE: // The whole linkset can be edited 'in-place'
$aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'details')); $aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'details'));
break; break;
@@ -57,15 +57,12 @@ class UILinksWidgetDirect
$aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'list')); $aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'list'));
array_unshift($aZList, 'friendlyname'); array_unshift($aZList, 'friendlyname');
} }
foreach($aZList as $sLinkedAttCode) foreach ($aZList as $sLinkedAttCode) {
{ if ($sLinkedAttCode != $sExtKeyToMe) {
if ($sLinkedAttCode != $sExtKeyToMe)
{
$oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode); $oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode);
if ((!$oAttDef->IsExternalField() || ($oAttDef->GetKeyAttCode() != $sExtKeyToMe)) && if ((!$oAttDef->IsExternalField() || ($oAttDef->GetKeyAttCode() != $sExtKeyToMe)) &&
(!$oAttDef->IsLinkSet()) ) (!$oAttDef->IsLinkSet())) {
{
$this->aZlist[] = $sLinkedAttCode; $this->aZlist[] = $sLinkedAttCode;
} }
} }
@@ -101,21 +98,17 @@ class UILinksWidgetDirect
$sRealClass = ''; $sRealClass = '';
//$oPage->add('<div class="wizContainer" style="vertical-align:top;"><div>'); //$oPage->add('<div class="wizContainer" style="vertical-align:top;"><div>');
$aSubClasses = MetaModel::EnumChildClasses($this->sLinkedClass, ENUM_CHILD_CLASSES_ALL); // Including the specified class itself $aSubClasses = MetaModel::EnumChildClasses($this->sLinkedClass, ENUM_CHILD_CLASSES_ALL); // Including the specified class itself
$aPossibleClasses = array(); $aPossibleClasses = [];
foreach($aSubClasses as $sCandidateClass) foreach ($aSubClasses as $sCandidateClass) {
{ if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES)) {
if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES)) if ($sCandidateClass == $sProposedRealClass) {
{
if ($sCandidateClass == $sProposedRealClass)
{
$sRealClass = $sProposedRealClass; $sRealClass = $sProposedRealClass;
} }
$aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass); $aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass);
} }
} }
// Only one of the subclasses can be instantiated... // Only one of the subclasses can be instantiated...
if (count($aPossibleClasses) == 1) if (count($aPossibleClasses) == 1) {
{
$aKeys = array_keys($aPossibleClasses); $aKeys = array_keys($aPossibleClasses);
$sRealClass = $aKeys[0]; $sRealClass = $aKeys[0];
} }
@@ -123,11 +116,11 @@ class UILinksWidgetDirect
if ($sRealClass != '') { if ($sRealClass != '') {
$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode); $oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe(); $sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
$aFieldsFlags = array($sExtKeyToMe => OPT_ATT_HIDDEN); $aFieldsFlags = [$sExtKeyToMe => OPT_ATT_HIDDEN];
$oObj = DBObject::MakeDefaultInstance($sRealClass); $oObj = DBObject::MakeDefaultInstance($sRealClass);
$aPrefillParam = array('source_obj' => $oSourceObj); $aPrefillParam = ['source_obj' => $oSourceObj];
$oObj->PrefillForm('creation_from_editinplace', $aPrefillParam); $oObj->PrefillForm('creation_from_editinplace', $aPrefillParam);
$aFormExtraParams = array( $aFormExtraParams = [
'formPrefix' => $this->sInputid, 'formPrefix' => $this->sInputid,
'noRelations' => true, 'noRelations' => true,
'fieldsFlags' => $aFieldsFlags, 'fieldsFlags' => $aFieldsFlags,
@@ -140,7 +133,7 @@ class UILinksWidgetDirect
JS JS
, ,
], ],
); ];
// Remove blob edition from creation form @see N°5863 to allow blob edition in modal context // Remove blob edition from creation form @see N°5863 to allow blob edition in modal context
FormHelper::DisableAttributeBlobInputs($sRealClass, $aFormExtraParams); FormHelper::DisableAttributeBlobInputs($sRealClass, $aFormExtraParams);
@@ -149,16 +142,13 @@ JS
$oPage->AddUiBlock(FormHelper::GetAlertForMandatoryAttributeBlobInputsInModal(FormHelper::ENUM_MANDATORY_BLOB_MODE_CREATE)); $oPage->AddUiBlock(FormHelper::GetAlertForMandatoryAttributeBlobInputsInModal(FormHelper::ENUM_MANDATORY_BLOB_MODE_CREATE));
} }
cmdbAbstractObject::DisplayCreationForm($oPage, $sRealClass, $oObj, array(), $aFormExtraParams); cmdbAbstractObject::DisplayCreationForm($oPage, $sRealClass, $oObj, [], $aFormExtraParams);
} } else {
else
{
$sClassLabel = MetaModel::GetName($this->sLinkedClass); $sClassLabel = MetaModel::GetName($this->sLinkedClass);
$oPage->add('<p>'.Dict::Format('UI:SelectTheTypeOf_Class_ToCreate', $sClassLabel)); $oPage->add('<p>'.Dict::Format('UI:SelectTheTypeOf_Class_ToCreate', $sClassLabel));
$oPage->add('<nobr><select name="class">'); $oPage->add('<nobr><select name="class">');
asort($aPossibleClasses); asort($aPossibleClasses);
foreach($aPossibleClasses as $sClassName => $sClassLabel) foreach ($aPossibleClasses as $sClassName => $sClassLabel) {
{
$oPage->add("<option value=\"$sClassName\">$sClassLabel</option>"); $oPage->add("<option value=\"$sClassName\">$sClassLabel</option>");
} }
$oPage->add('</select>'); $oPage->add('</select>');
@@ -178,7 +168,7 @@ JS
* @throws \MissingQueryArgument * @throws \MissingQueryArgument
* @throws \OQLException * @throws \OQLException
*/ */
public function GetObjectsSelectionDlg($oPage, $oCurrentObj, $aAlreadyLinked, $aPrefillFormParam = array()) public function GetObjectsSelectionDlg($oPage, $oCurrentObj, $aAlreadyLinked, $aPrefillFormParam = [])
{ {
//$oPage->add("<div class=\"wizContainer\" style=\"vertical-align:top;\">\n"); //$oPage->add("<div class=\"wizContainer\" style=\"vertical-align:top;\">\n");
@@ -199,8 +189,7 @@ JS
$oLinkSetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode); $oLinkSetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
$valuesDef = $oLinkSetDef->GetValuesDef(); $valuesDef = $oLinkSetDef->GetValuesDef();
if ($valuesDef === null) if ($valuesDef === null) {
{
$oFilter = new DBObjectSearch($this->sLinkedClass); $oFilter = new DBObjectSearch($this->sLinkedClass);
} else { } else {
if (!$valuesDef instanceof ValueSetObjects) { if (!$valuesDef instanceof ValueSetObjects) {
@@ -218,8 +207,10 @@ JS
$oCurrentObj->PrefillForm('search', $aPrefillFormParam); $oCurrentObj->PrefillForm('search', $aPrefillFormParam);
} }
$oBlock = new DisplayBlock($oFilter, 'search', false); $oBlock = new DisplayBlock($oFilter, 'search', false);
$oPage->AddUiBlock($oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->sInputid}", $oPage->AddUiBlock($oBlock->GetDisplay(
array( $oPage,
"SearchFormToAdd_{$this->sInputid}",
[
'result_list_outer_selector' => "SearchResultsToAdd_{$this->sInputid}", 'result_list_outer_selector' => "SearchResultsToAdd_{$this->sInputid}",
'table_id' => "add_{$this->sInputid}", 'table_id' => "add_{$this->sInputid}",
'table_inner_id' => "ResultsToAdd_{$this->sInputid}", 'table_inner_id' => "ResultsToAdd_{$this->sInputid}",
@@ -227,13 +218,14 @@ JS
'cssCount' => "#count_{$this->sInputid}", 'cssCount' => "#count_{$this->sInputid}",
'query_params' => $oFilter->GetInternalParams(), 'query_params' => $oFilter->GetInternalParams(),
'hidden_criteria' => $sHiddenCriteria, 'hidden_criteria' => $sHiddenCriteria,
) ]
)); ));
$sEmptyList = Dict::S('UI:Message:EmptyList:UseSearchForm'); $sEmptyList = Dict::S('UI:Message:EmptyList:UseSearchForm');
$sCancel = Dict::S('UI:Button:Cancel'); $sCancel = Dict::S('UI:Button:Cancel');
$sAdd = Dict::S('UI:Button:Add'); $sAdd = Dict::S('UI:Button:Add');
$oPage->add(<<<HTML $oPage->add(
<<<HTML
<form id="ObjectsAddForm_{$this->sInputid}"> <form id="ObjectsAddForm_{$this->sInputid}">
<div id="SearchResultsToAdd_{$this->sInputid}"> <div id="SearchResultsToAdd_{$this->sInputid}">
<div style="background: #fff; border:0; text-align:center; vertical-align:middle;"><p>{$sEmptyList}</p></div> <div style="background: #fff; border:0; text-align:center; vertical-align:middle;"><p>{$sEmptyList}</p></div>
@@ -256,38 +248,30 @@ HTML
* @throws \CoreException * @throws \CoreException
* @throws \OQLException * @throws \OQLException
*/ */
public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinked = array(), $oCurrentObj = null, $aPrefillFormParam = array()) public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinked = [], $oCurrentObj = null, $aPrefillFormParam = [])
{
if ($sRemoteClass == '')
{ {
if ($sRemoteClass == '') {
$sRemoteClass = $this->sLinkedClass; $sRemoteClass = $this->sLinkedClass;
} }
$oLinkSetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode); $oLinkSetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
$valuesDef = $oLinkSetDef->GetValuesDef(); $valuesDef = $oLinkSetDef->GetValuesDef();
if ($valuesDef === null) if ($valuesDef === null) {
{
$oFilter = new DBObjectSearch($sRemoteClass); $oFilter = new DBObjectSearch($sRemoteClass);
} } else {
else if (!$valuesDef instanceof ValueSetObjects) {
{
if (!$valuesDef instanceof ValueSetObjects)
{
throw new Exception('Error: only ValueSetObjects are supported for "allowed_values" in AttributeLinkedSet ('.$this->sClass.'/'.$this->sAttCode.').'); throw new Exception('Error: only ValueSetObjects are supported for "allowed_values" in AttributeLinkedSet ('.$this->sClass.'/'.$this->sAttCode.').');
} }
$oFilter = DBObjectSearch::FromOQL($valuesDef->GetFilterExpression()); $oFilter = DBObjectSearch::FromOQL($valuesDef->GetFilterExpression());
} }
if (($oCurrentObj != null) && MetaModel::IsSameFamilyBranch($sRemoteClass, $this->sClass)) if (($oCurrentObj != null) && MetaModel::IsSameFamilyBranch($sRemoteClass, $this->sClass)) {
{
// Prevent linking to self if the linked object is of the same family // Prevent linking to self if the linked object is of the same family
// and already present in the database // and already present in the database
if (!$oCurrentObj->IsNew()) if (!$oCurrentObj->IsNew()) {
{
$oFilter->AddCondition('id', $oCurrentObj->GetKey(), '!='); $oFilter->AddCondition('id', $oCurrentObj->GetKey(), '!=');
} }
} }
if ($oCurrentObj != null) if ($oCurrentObj != null) {
{
$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter); $this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
$aArgs = array_merge($oCurrentObj->ToArgs('this'), $oFilter->GetInternalParams()); $aArgs = array_merge($oCurrentObj->ToArgs('this'), $oFilter->GetInternalParams());
@@ -296,12 +280,11 @@ HTML
$aPrefillFormParam['filter'] = $oFilter; $aPrefillFormParam['filter'] = $oFilter;
$oCurrentObj->PrefillForm('search', $aPrefillFormParam); $oCurrentObj->PrefillForm('search', $aPrefillFormParam);
} }
if (count($aAlreadyLinked) > 0) if (count($aAlreadyLinked) > 0) {
{
$oFilter->AddCondition('id', $aAlreadyLinked, 'NOTIN'); $oFilter->AddCondition('id', $aAlreadyLinked, 'NOTIN');
} }
$oBlock = new DisplayBlock($oFilter, 'list', false); $oBlock = new DisplayBlock($oFilter, 'list', false);
$oBlock->Display($oP, "ResultsToAdd_{$this->sInputid}", array('menu' => false, 'cssCount'=> '#count_'.$this->sInputid , 'selection_mode' => true, 'table_id' => 'add_'.$this->sInputid)); // Don't display the 'Actions' menu on the results $oBlock->Display($oP, "ResultsToAdd_{$this->sInputid}", ['menu' => false, 'cssCount' => '#count_'.$this->sInputid , 'selection_mode' => true, 'table_id' => 'add_'.$this->sInputid]); // Don't display the 'Actions' menu on the results
} }
/** /**
@@ -311,8 +294,7 @@ HTML
public function DoAddObjects(WebPage $oP, $oFullSetFilter) public function DoAddObjects(WebPage $oP, $oFullSetFilter)
{ {
$aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter); $aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter);
foreach($aLinkedObjectIds as $iObjectId) foreach ($aLinkedObjectIds as $iObjectId) {
{
$oLinkObj = MetaModel::GetObject($this->sLinkedClass, $iObjectId); $oLinkObj = MetaModel::GetObject($this->sLinkedClass, $iObjectId);
$oP->add($this->GetObjectRow($oP, $oLinkObj, $oLinkObj->GetKey())); $oP->add($this->GetObjectRow($oP, $oLinkObj, $oLinkObj->GetKey()));
} }
@@ -325,15 +307,15 @@ HTML
public function GetTableConfig() public function GetTableConfig()
{ {
$aAttribs = array(); $aAttribs = [];
$aAttribs['form::select'] = array( $aAttribs['form::select'] = [
'label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$this->sInputid}:not(:disabled)', this.checked);oWidget".$this->sInputid.".directlinks('instance')._onSelectChange();\" class=\"checkAll\"></input>", 'label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$this->sInputid}:not(:disabled)', this.checked);oWidget".$this->sInputid.".directlinks('instance')._onSelectChange();\" class=\"checkAll\"></input>",
'description' => Dict::S('UI:SelectAllToggle+'), 'description' => Dict::S('UI:SelectAllToggle+'),
); ];
foreach ($this->aZlist as $sLinkedAttCode) { foreach ($this->aZlist as $sLinkedAttCode) {
$oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode); $oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode);
$aAttribs[$sLinkedAttCode] = array('label' => MetaModel::GetLabel($this->sLinkedClass, $sLinkedAttCode), 'description' => $oAttDef->GetOrderByHint()); $aAttribs[$sLinkedAttCode] = ['label' => MetaModel::GetLabel($this->sLinkedClass, $sLinkedAttCode), 'description' => $oAttDef->GetOrderByHint()];
} }
return $aAttribs; return $aAttribs;
@@ -348,8 +330,7 @@ HTML
*/ */
public function GetRow($oPage, $sRealClass, $aValues, $iTempId) public function GetRow($oPage, $sRealClass, $aValues, $iTempId)
{ {
if ($sRealClass == '') if ($sRealClass == '') {
{
$sRealClass = $this->sLinkedClass; $sRealClass = $this->sLinkedClass;
} }
$oLinkObj = new $sRealClass(); $oLinkObj = new $sRealClass();
@@ -367,10 +348,9 @@ HTML
protected function GetObjectRow($oPage, $oLinkObj, $iTempId) protected function GetObjectRow($oPage, $oLinkObj, $iTempId)
{ {
$aAttribs = $this->GetTableConfig(); $aAttribs = $this->GetTableConfig();
$aRow = array(); $aRow = [];
$aRow['form::select'] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.($iTempId).'"/>'; $aRow['form::select'] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.($iTempId).'"/>';
foreach($this->aZlist as $sLinkedAttCode) foreach ($this->aZlist as $sLinkedAttCode) {
{
$aRow[$sLinkedAttCode] = $oLinkObj->GetAsHTML($sLinkedAttCode); $aRow[$sLinkedAttCode] = $oLinkObj->GetAsHTML($sLinkedAttCode);
} }
return $oPage->GetTableRow($aRow, $aAttribs); return $oPage->GetTableRow($aRow, $aAttribs);
@@ -386,18 +366,16 @@ HTML
*/ */
public function GetFormRow($oPage, $sRealClass, $aValues, $iTempId) public function GetFormRow($oPage, $sRealClass, $aValues, $iTempId)
{ {
if ($sRealClass == '') if ($sRealClass == '') {
{
$sRealClass = $this->sLinkedClass; $sRealClass = $this->sLinkedClass;
} }
$oLinkObj = new $sRealClass(); $oLinkObj = new $sRealClass();
$oLinkObj->UpdateObjectFromPostedForm($this->sInputid); $oLinkObj->UpdateObjectFromPostedForm($this->sInputid);
$aAttribs = $this->GetTableConfig(); $aAttribs = $this->GetTableConfig();
$aRow = array(); $aRow = [];
$aRow[] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.($iTempId).'"/>'; $aRow[] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.($iTempId).'"/>';
foreach($this->aZlist as $sLinkedAttCode) foreach ($this->aZlist as $sLinkedAttCode) {
{
$aRow[] = $oLinkObj->GetAsHTML($sLinkedAttCode); $aRow[] = $oLinkObj->GetAsHTML($sLinkedAttCode);
} }
return $aRow; return $aRow;
@@ -413,26 +391,22 @@ HTML
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$sSrcClass = get_class($oSourceObj); $sSrcClass = get_class($oSourceObj);
$sDestClass = $oSearch->GetClass(); $sDestClass = $oSearch->GetClass();
foreach($oAppContext->GetNames() as $key) foreach ($oAppContext->GetNames() as $key) {
{
// Find the value of the object corresponding to each 'context' parameter // Find the value of the object corresponding to each 'context' parameter
$aCallSpec = array($sSrcClass, 'MapContextParam'); $aCallSpec = [$sSrcClass, 'MapContextParam'];
$sAttCode = ''; $sAttCode = '';
if (is_callable($aCallSpec)) if (is_callable($aCallSpec)) {
{
$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter $sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter
} }
if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode)) if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode)) {
{
$defaultValue = $oSourceObj->Get($sAttCode); $defaultValue = $oSourceObj->Get($sAttCode);
// Find the attcode for the same 'context' parameter in the destination class // Find the attcode for the same 'context' parameter in the destination class
// and sets its value as the default value for the search condition // and sets its value as the default value for the search condition
$aCallSpec = array($sDestClass, 'MapContextParam'); $aCallSpec = [$sDestClass, 'MapContextParam'];
$sAttCode = ''; $sAttCode = '';
if (is_callable($aCallSpec)) if (is_callable($aCallSpec)) {
{
$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter $sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter
} }
@@ -443,7 +417,6 @@ HTML
} }
} }
public function GetClass(): string public function GetClass(): string
{ {
return $this->sClass; return $this->sClass;

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -54,7 +55,7 @@ class UILinksWidget
$this->m_sNameSuffix = $sNameSuffix; $this->m_sNameSuffix = $sNameSuffix;
$this->m_bDuplicatesAllowed = $bDuplicatesAllowed; $this->m_bDuplicatesAllowed = $bDuplicatesAllowed;
$this->m_aEditableFields = array(); $this->m_aEditableFields = [];
/** @var AttributeLinkedSetIndirect $oAttDef */ /** @var AttributeLinkedSetIndirect $oAttDef */
$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sAttCode);
@@ -67,34 +68,33 @@ class UILinksWidget
$oLinkingAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $this->m_sExtKeyToRemote); $oLinkingAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $this->m_sExtKeyToRemote);
$this->m_sRemoteClass = $oLinkingAttDef->GetTargetClass(); $this->m_sRemoteClass = $oLinkingAttDef->GetTargetClass();
$this->m_aEditableFields = array(); $this->m_aEditableFields = [];
$this->m_aTableConfig = array(); $this->m_aTableConfig = [];
$this->m_aTableConfig['form::checkbox'] = array( $this->m_aTableConfig['form::checkbox'] = [
'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onClick=\"CheckAll('#linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix} .selection', this.checked); oWidget".$this->m_sInputId.".OnSelectChange();\">", 'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onClick=\"CheckAll('#linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix} .selection', this.checked); oWidget".$this->m_sInputId.".OnSelectChange();\">",
'description' => Dict::S('UI:SelectAllToggle+'), 'description' => Dict::S('UI:SelectAllToggle+'),
); ];
$aLnkAttDefsToDisplay = MetaModel::GetZListAttDefsFilteredForIndirectLinkClass($sClass, $sAttCode); $aLnkAttDefsToDisplay = MetaModel::GetZListAttDefsFilteredForIndirectLinkClass($sClass, $sAttCode);
foreach ($aLnkAttDefsToDisplay as $oLnkAttDef) foreach ($aLnkAttDefsToDisplay as $oLnkAttDef) {
{
$sLnkAttCode = $oLnkAttDef->GetCode(); $sLnkAttCode = $oLnkAttDef->GetCode();
$this->m_aEditableFields[] = $sLnkAttCode; $this->m_aEditableFields[] = $sLnkAttCode;
$this->m_aTableConfig[$sLnkAttCode] = array('label' => $oLnkAttDef->GetLabel(), 'description' => $oLnkAttDef->GetDescription()); $this->m_aTableConfig[$sLnkAttCode] = ['label' => $oLnkAttDef->GetLabel(), 'description' => $oLnkAttDef->GetDescription()];
} }
$this->m_aTableConfig['static::key'] = array( $this->m_aTableConfig['static::key'] = [
'label' => MetaModel::GetName($this->m_sRemoteClass), 'label' => MetaModel::GetName($this->m_sRemoteClass),
'description' => MetaModel::GetClassDescription($this->m_sRemoteClass), 'description' => MetaModel::GetClassDescription($this->m_sRemoteClass),
); ];
$this->m_aEditableFields[] = $this->m_sExtKeyToRemote; $this->m_aEditableFields[] = $this->m_sExtKeyToRemote;
$aRemoteAttDefsToDisplay = MetaModel::GetZListAttDefsFilteredForIndirectRemoteClass($this->m_sRemoteClass); $aRemoteAttDefsToDisplay = MetaModel::GetZListAttDefsFilteredForIndirectRemoteClass($this->m_sRemoteClass);
foreach ($aRemoteAttDefsToDisplay as $oRemoteAttDef) { foreach ($aRemoteAttDefsToDisplay as $oRemoteAttDef) {
$sRemoteAttCode = $oRemoteAttDef->GetCode(); $sRemoteAttCode = $oRemoteAttDef->GetCode();
$this->m_aTableConfig['static::'.$sRemoteAttCode] = array( $this->m_aTableConfig['static::'.$sRemoteAttCode] = [
'label' => $oRemoteAttDef->GetLabel(), 'label' => $oRemoteAttDef->GetLabel(),
'description' => $oRemoteAttDef->GetDescription(), 'description' => $oRemoteAttDef->GetDescription(),
); ];
} }
} }
@@ -105,7 +105,6 @@ class UILinksWidget
return ($bSafe) ? utils::GetSafeId($sFieldId) : $sFieldId; return ($bSafe) ? utils::GetSafeId($sFieldId) : $sFieldId;
} }
/** /**
* Display the table with the form for editing all the links at once * Display the table with the form for editing all the links at once
* *
@@ -119,7 +118,6 @@ class UILinksWidget
return DataTableUIBlockFactory::MakeForForm("{$this->m_sAttCode}{$this->m_sNameSuffix}", $aConfig, $aData); return DataTableUIBlockFactory::MakeForForm("{$this->m_sAttCode}{$this->m_sNameSuffix}", $aConfig, $aData);
} }
/** /**
* Get the HTML fragment corresponding to the linkset editing widget * Get the HTML fragment corresponding to the linkset editing widget
* *
@@ -157,7 +155,7 @@ class UILinksWidget
* @throws DictExceptionMissingString * @throws DictExceptionMissingString
* @throws Exception * @throws Exception
*/ */
public function GetObjectPickerDialog($oPage, $oCurrentObj, $sJson, $aAlreadyLinkedIds = array(), $aPrefillFormParam = array()) public function GetObjectPickerDialog($oPage, $oCurrentObj, $sJson, $aAlreadyLinkedIds = [], $aPrefillFormParam = [])
{ {
$oAlreadyLinkedFilter = new DBObjectSearch($this->m_sRemoteClass); $oAlreadyLinkedFilter = new DBObjectSearch($this->m_sRemoteClass);
if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0) { if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0) {
@@ -183,7 +181,9 @@ class UILinksWidget
$sLinkedSetId = $oBlock->oUILinksWidget->GetLinkedSetId(); $sLinkedSetId = $oBlock->oUILinksWidget->GetLinkedSetId();
$oDisplayBlock = new DisplayBlock($oFilter, 'search', false); $oDisplayBlock = new DisplayBlock($oFilter, 'search', false);
$oBlock->AddSubBlock($oDisplayBlock->GetDisplay($oPage, "SearchFormToAdd_{$sLinkedSetId}", $oBlock->AddSubBlock($oDisplayBlock->GetDisplay(
$oPage,
"SearchFormToAdd_{$sLinkedSetId}",
[ [
'menu' => false, 'menu' => false,
'result_list_outer_selector' => "SearchResultsToAdd_{$sLinkedSetId}", 'result_list_outer_selector' => "SearchResultsToAdd_{$sLinkedSetId}",
@@ -195,7 +195,8 @@ class UILinksWidget
'query_params' => $oFilter->GetInternalParams(), 'query_params' => $oFilter->GetInternalParams(),
'hidden_criteria' => $sAlreadyLinkedExpression, 'hidden_criteria' => $sAlreadyLinkedExpression,
'submit_on_load' => false, 'submit_on_load' => false,
])); ]
));
$oBlock->AddForm(); $oBlock->AddForm();
} }
@@ -212,25 +213,21 @@ class UILinksWidget
* @throws \CoreException * @throws \CoreException
* @throws \Exception * @throws \Exception
*/ */
public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinkedIds = array(), $oCurrentObj = null) public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinkedIds = [], $oCurrentObj = null)
{
if ($sRemoteClass != '')
{ {
if ($sRemoteClass != '') {
// assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass)); // assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass));
$oFilter = new DBObjectSearch($sRemoteClass); $oFilter = new DBObjectSearch($sRemoteClass);
} } else {
else
{
// No remote class specified use the one defined in the linkedset // No remote class specified use the one defined in the linkedset
$oFilter = new DBObjectSearch($this->m_sRemoteClass); $oFilter = new DBObjectSearch($this->m_sRemoteClass);
} }
if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0) if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0) {
{
$oFilter->AddCondition('id', $aAlreadyLinkedIds, 'NOTIN'); $oFilter->AddCondition('id', $aAlreadyLinkedIds, 'NOTIN');
} }
$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter); $this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
$oBlock = new DisplayBlock($oFilter, 'list', false); $oBlock = new DisplayBlock($oFilter, 'list', false);
$oBlock->Display($oP, "ResultsToAdd_{$this->m_sAttCode}", array('menu' => false, 'cssCount'=> '#count_'.$this->m_sAttCode.$this->m_sNameSuffix , 'selection_mode' => true, 'table_id' => 'add_'.$this->m_sAttCode)); // Don't display the 'Actions' menu on the results $oBlock->Display($oP, "ResultsToAdd_{$this->m_sAttCode}", ['menu' => false, 'cssCount' => '#count_'.$this->m_sAttCode.$this->m_sNameSuffix , 'selection_mode' => true, 'table_id' => 'add_'.$this->m_sAttCode]); // Don't display the 'Actions' menu on the results
} }
/** /**
@@ -251,7 +248,7 @@ class UILinksWidget
$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId, false); $oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId, false);
if (is_object($oLinkedObj)) { if (is_object($oLinkedObj)) {
$oBlock = new BlockIndirectLinkSetEditTable($this); $oBlock = new BlockIndirectLinkSetEditTable($this);
$aRow = $oBlock->GetFormRow($oP, $oLinkedObj, $iObjectId, array(), $oCurrentObj, $iAdditionId); // Not yet created link get negative Ids $aRow = $oBlock->GetFormRow($oP, $oLinkedObj, $iObjectId, [], $oCurrentObj, $iAdditionId); // Not yet created link get negative Ids
$oRow = new FormTableRow("{$this->m_sAttCode}{$this->m_sNameSuffix}", $this->m_aTableConfig, $aRow, -$iAdditionId); $oRow = new FormTableRow("{$this->m_sAttCode}{$this->m_sNameSuffix}", $this->m_aTableConfig, $aRow, -$iAdditionId);
$oP->AddUiBlock($oRow); $oP->AddUiBlock($oRow);
$iAdditionId++; $iAdditionId++;
@@ -280,7 +277,7 @@ class UILinksWidget
$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId, false); $oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId, false);
if (is_object($oLinkedObj)) { if (is_object($oLinkedObj)) {
$oBlock = new BlockIndirectLinkSetEditTable($this); $oBlock = new BlockIndirectLinkSetEditTable($this);
$aRow = $oBlock->GetFormRow($oP, $oLinkedObj, $iObjectId, array(), $oCurrentObj, $iAdditionId, false /* Default value */, $bAllowRemoteExtKeyEdit); // Not yet created link get negative Ids $aRow = $oBlock->GetFormRow($oP, $oLinkedObj, $iObjectId, [], $oCurrentObj, $iAdditionId, false /* Default value */, $bAllowRemoteExtKeyEdit); // Not yet created link get negative Ids
$aData = []; $aData = [];
foreach ($aRow as $item) { foreach ($aRow as $item) {
$aData[] = $item; $aData[] = $item;
@@ -307,37 +304,30 @@ class UILinksWidget
$oAppContext = new ApplicationContext(); $oAppContext = new ApplicationContext();
$sSrcClass = get_class($oSourceObj); $sSrcClass = get_class($oSourceObj);
$sDestClass = $oSearch->GetClass(); $sDestClass = $oSearch->GetClass();
foreach($oAppContext->GetNames() as $key) foreach ($oAppContext->GetNames() as $key) {
{
// Find the value of the object corresponding to each 'context' parameter // Find the value of the object corresponding to each 'context' parameter
$aCallSpec = array($sSrcClass, 'MapContextParam'); $aCallSpec = [$sSrcClass, 'MapContextParam'];
$sAttCode = ''; $sAttCode = '';
if (is_callable($aCallSpec)) if (is_callable($aCallSpec)) {
{
$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter $sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter
} }
if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode)) if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode)) {
{
$defaultValue = $oSourceObj->Get($sAttCode); $defaultValue = $oSourceObj->Get($sAttCode);
// Find the attcode for the same 'context' parameter in the destination class // Find the attcode for the same 'context' parameter in the destination class
// and sets its value as the default value for the search condition // and sets its value as the default value for the search condition
$aCallSpec = array($sDestClass, 'MapContextParam'); $aCallSpec = [$sDestClass, 'MapContextParam'];
$sAttCode = ''; $sAttCode = '';
if (is_callable($aCallSpec)) if (is_callable($aCallSpec)) {
{
$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter $sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter
} }
if (MetaModel::IsValidAttCode($sDestClass, $sAttCode) && !empty($defaultValue)) if (MetaModel::IsValidAttCode($sDestClass, $sAttCode) && !empty($defaultValue)) {
{
// Add Hierarchical condition if hierarchical key // Add Hierarchical condition if hierarchical key
$oAttDef = MetaModel::GetAttributeDef($sDestClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($sDestClass, $sAttCode);
if (isset($oAttDef) && ($oAttDef->IsExternalKey())) if (isset($oAttDef) && ($oAttDef->IsExternalKey())) {
{ try {
try
{
/** @var AttributeExternalKey $oAttDef */ /** @var AttributeExternalKey $oAttDef */
$sTargetClass = $oAttDef->GetTargetClass(); $sTargetClass = $oAttDef->GetTargetClass();
$sHierarchicalKeyCode = MetaModel::IsHierarchicalClass($sTargetClass); $sHierarchicalKeyCode = MetaModel::IsHierarchicalClass($sTargetClass);
@@ -348,8 +338,7 @@ class UILinksWidget
$oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW); $oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW);
$oSearch->AddCondition_PointingTo($oHKFilter, $sAttCode); $oSearch->AddCondition_PointingTo($oHKFilter, $sAttCode);
} }
} } catch (Exception $e) {
catch (Exception $e) {
} }
} else { } else {
$oSearch->AddCondition($sAttCode, $defaultValue); $oSearch->AddCondition($sAttCode, $defaultValue);

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -49,7 +50,7 @@ class UIPasswordWidget
* @param Hash $aArgs Extra context arguments * @param Hash $aArgs Extra context arguments
* @return string The HTML fragment to be inserted into the page * @return string The HTML fragment to be inserted into the page
*/ */
public function Display(WebPage $oPage, $aArgs = array()) public function Display(WebPage $oPage, $aArgs = [])
{ {
$oPage->add_dict_entry('UI:Component:Input:Password:DoesNotMatch'); $oPage->add_dict_entry('UI:Component:Input:Password:DoesNotMatch');
@@ -94,4 +95,3 @@ class UIPasswordWidget
return $sHtmlValue; return $sHtmlValue;
} }
} }
?>

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* *
* Copyright (C) 2010-2024 Combodo SAS * Copyright (C) 2010-2024 Combodo SAS
@@ -20,7 +21,6 @@
* *
*/ */
use Combodo\iTop\Application\WebPage\WebPage; use Combodo\iTop\Application\WebPage\WebPage;
require_once(APPROOT.'/application/displayblock.class.inc.php'); require_once(APPROOT.'/application/displayblock.class.inc.php');
@@ -46,8 +46,10 @@ class UISearchFormForeignKeys
$oFilter = new DBObjectSearch($this->m_sRemoteClass); $oFilter = new DBObjectSearch($this->m_sRemoteClass);
$oBlock = new DisplayBlock($oFilter, 'search', false); $oBlock = new DisplayBlock($oFilter, 'search', false);
$oPage->AddUiBlock($oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->m_iInputId}", $oPage->AddUiBlock($oBlock->GetDisplay(
array( $oPage,
"SearchFormToAdd_{$this->m_iInputId}",
[
'menu' => false, 'menu' => false,
'result_list_outer_selector' => "SearchResultsToAdd_{$this->m_iInputId}", 'result_list_outer_selector' => "SearchResultsToAdd_{$this->m_iInputId}",
'table_id' => "add_{$this->m_iInputId}", 'table_id' => "add_{$this->m_iInputId}",
@@ -55,12 +57,14 @@ class UISearchFormForeignKeys
'selection_mode' => true, 'selection_mode' => true,
'cssCount' => "#count_{$this->m_iInputId}", 'cssCount' => "#count_{$this->m_iInputId}",
'query_params' => $oFilter->GetInternalParams(), 'query_params' => $oFilter->GetInternalParams(),
))); ]
));
$sEmptyList = Dict::S('UI:Message:EmptyList:UseSearchForm'); $sEmptyList = Dict::S('UI:Message:EmptyList:UseSearchForm');
$sCancel = Dict::S('UI:Button:Cancel'); $sCancel = Dict::S('UI:Button:Cancel');
$sAdd = Dict::S('UI:Button:Add'); $sAdd = Dict::S('UI:Button:Add');
$oPage->add(<<<HTML $oPage->add(
<<<HTML
<form id="ObjectsAddForm_{$this->m_iInputId}"> <form id="ObjectsAddForm_{$this->m_iInputId}">
<div id="SearchResultsToAdd_{$this->m_iInputId}" style="vertical-align:top;height:100%;overflow:auto;padding:0;border:0;"> <div id="SearchResultsToAdd_{$this->m_iInputId}" style="vertical-align:top;height:100%;overflow:auto;padding:0;border:0;">
<div style="background: #fff; border:0; text-align:center; vertical-align:middle;"><p>{$sEmptyList}</p></div> <div style="background: #fff; border:0; text-align:center; vertical-align:middle;"><p>{$sEmptyList}</p></div>
@@ -106,15 +110,12 @@ JS
public function GetFullListForeignKeysFromSelection($oPage, $oFullSetFilter) public function GetFullListForeignKeysFromSelection($oPage, $oFullSetFilter)
{ {
try try {
{
$aLinkedObjects = utils::ReadMultipleSelectionWithFriendlyname($oFullSetFilter); $aLinkedObjects = utils::ReadMultipleSelectionWithFriendlyname($oFullSetFilter);
$oPage->add(json_encode($aLinkedObjects)); $oPage->add(json_encode($aLinkedObjects));
} } catch (CoreException $e) {
catch (CoreException $e)
{
http_response_code(500); http_response_code(500);
$oPage->add(json_encode(array('error' => $e->GetMessage()))); $oPage->add(json_encode(['error' => $e->GetMessage()]));
IssueLog::Error($e->getMessage()."\nDebug trace:\n".$e->getTraceAsString()); IssueLog::Error($e->getMessage()."\nDebug trace:\n".$e->getTraceAsString());
} }
} }
@@ -129,20 +130,20 @@ JS
*/ */
public function ListResultsSearchForeignKeys(WebPage $oP, $sRemoteClass = '') public function ListResultsSearchForeignKeys(WebPage $oP, $sRemoteClass = '')
{ {
if ($sRemoteClass != '') if ($sRemoteClass != '') {
{
// assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass)); // assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass));
$oFilter = new DBObjectSearch($sRemoteClass); $oFilter = new DBObjectSearch($sRemoteClass);
} } else {
else
{
// No remote class specified use the one defined in the linkedset // No remote class specified use the one defined in the linkedset
$oFilter = new DBObjectSearch($this->m_sRemoteClass); $oFilter = new DBObjectSearch($this->m_sRemoteClass);
} }
$oBlock = new DisplayBlock($oFilter, 'list', false); $oBlock = new DisplayBlock($oFilter, 'list', false);
$oBlock->Display($oP, "ResultsToAdd_{$this->m_iInputId}", $oBlock->Display(
array('menu' => false, 'cssCount' => "#count_{$this->m_iInputId}", 'selection_mode' => true, 'table_id' => "add_{$this->m_iInputId}")); $oP,
"ResultsToAdd_{$this->m_iInputId}",
['menu' => false, 'cssCount' => "#count_{$this->m_iInputId}", 'selection_mode' => true, 'table_id' => "add_{$this->m_iInputId}"]
);
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -17,7 +18,6 @@
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
use Combodo\iTop\Application\WebPage\iTopWebPage; use Combodo\iTop\Application\WebPage\iTopWebPage;
/** /**
* Class UIWizard * Class UIWizard
* *
@@ -36,51 +36,53 @@ class UIWizard
{ {
$this->m_oPage = $oPage; $this->m_oPage = $oPage;
$this->m_sClass = $sClass; $this->m_sClass = $sClass;
if (empty($sTargetState)) if (empty($sTargetState)) {
{
$sTargetState = MetaModel::GetDefaultState($sClass); $sTargetState = MetaModel::GetDefaultState($sClass);
} }
$this->m_sTargetState = $sTargetState; $this->m_sTargetState = $sTargetState;
$this->m_aWizardSteps = $this->ComputeWizardStructure(); $this->m_aWizardSteps = $this->ComputeWizardStructure();
} }
public function GetObjectClass() { return $this->m_sClass; } public function GetObjectClass()
public function GetTargetState() { return $this->m_sTargetState; } {
public function GetWizardStructure() { return $this->m_aWizardSteps; } return $this->m_sClass;
}
public function GetTargetState()
{
return $this->m_sTargetState;
}
public function GetWizardStructure()
{
return $this->m_aWizardSteps;
}
/** /**
* Displays one step of the wizard * Displays one step of the wizard
*/ */
public function DisplayWizardStep($aStep, $iStepIndex, &$iMaxInputId, &$aFieldsMap, $bFinishEnabled = false, $aArgs = array()) public function DisplayWizardStep($aStep, $iStepIndex, &$iMaxInputId, &$aFieldsMap, $bFinishEnabled = false, $aArgs = [])
{
if ($iStepIndex == 1) // one big form that contains everything, to make sure that the uploaded files are posted too
{ {
if ($iStepIndex == 1) { // one big form that contains everything, to make sure that the uploaded files are posted too
$this->m_oPage->add("<form method=\"post\" enctype=\"multipart/form-data\" action=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php\">\n"); $this->m_oPage->add("<form method=\"post\" enctype=\"multipart/form-data\" action=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php\">\n");
} }
$this->m_oPage->add("<div class=\"wizContainer\" id=\"wizStep$iStepIndex\" style=\"display:none;\">\n"); $this->m_oPage->add("<div class=\"wizContainer\" id=\"wizStep$iStepIndex\" style=\"display:none;\">\n");
$this->m_oPage->add("<a name=\"step$iStepIndex\" />\n"); $this->m_oPage->add("<a name=\"step$iStepIndex\" />\n");
$aStates = MetaModel::EnumStates($this->m_sClass); $aStates = MetaModel::EnumStates($this->m_sClass);
$aDetails = array(); $aDetails = [];
$sJSHandlerCode = ''; // Javascript code to be executed each time this step of the wizard is entered $sJSHandlerCode = ''; // Javascript code to be executed each time this step of the wizard is entered
foreach($aStep as $sAttCode) foreach ($aStep as $sAttCode) {
{
$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
if ($oAttDef->IsWritable()) if ($oAttDef->IsWritable()) {
{
$sAttLabel = $oAttDef->GetLabel(); $sAttLabel = $oAttDef->GetLabel();
$iOptions = isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode]) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0; $iOptions = isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode]) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0;
$aPrerequisites = $oAttDef->GetPrerequisiteAttributes(); $aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
if ($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) if ($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) {
{ $aFields[$sAttCode] = [];
$aFields[$sAttCode] = array(); foreach ($aPrerequisites as $sCode) {
foreach($aPrerequisites as $sCode)
{
$aFields[$sAttCode][$sCode] = ''; $aFields[$sAttCode][$sCode] = '';
} }
} }
if (count($aPrerequisites) > 0) if (count($aPrerequisites) > 0) {
{
$aOptions[] = 'Prerequisites: '.implode(', ', $aPrerequisites); $aOptions[] = 'Prerequisites: '.implode(', ', $aPrerequisites);
} }
@@ -88,17 +90,14 @@ class UIWizard
$oDefaultValuesSet = $oAttDef->GetDefaultValue(/* $oObject->ToArgs() */); // @@@ TO DO: get the object's current value if the object exists $oDefaultValuesSet = $oAttDef->GetDefaultValue(/* $oObject->ToArgs() */); // @@@ TO DO: get the object's current value if the object exists
$sHTMLValue = cmdbAbstractObject::GetFormElementForField($this->m_oPage, $this->m_sClass, $sAttCode, $oAttDef, $oDefaultValuesSet, '', "att_$iMaxInputId", '', $iOptions, $aArgs); $sHTMLValue = cmdbAbstractObject::GetFormElementForField($this->m_oPage, $this->m_sClass, $sAttCode, $oAttDef, $oDefaultValuesSet, '', "att_$iMaxInputId", '', $iOptions, $aArgs);
$aFieldsMap["att_$iMaxInputId"] = $sAttCode; $aFieldsMap["att_$iMaxInputId"] = $sAttCode;
$aDetails[] = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().$sFieldFlag.'</span>', 'value' => "<span id=\"field_att_$iMaxInputId\">$sHTMLValue</span>"); $aDetails[] = ['label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().$sFieldFlag.'</span>', 'value' => "<span id=\"field_att_$iMaxInputId\">$sHTMLValue</span>"];
if ($oAttDef->GetValuesDef() != null) if ($oAttDef->GetValuesDef() != null) {
{
$sJSHandlerCode .= "\toWizardHelper.RequestAllowedValues('$sAttCode');\n"; $sJSHandlerCode .= "\toWizardHelper.RequestAllowedValues('$sAttCode');\n";
} }
if ($oAttDef->GetDefaultValue() != null) if ($oAttDef->GetDefaultValue() != null) {
{
$sJSHandlerCode .= "\toWizardHelper.RequestDefaultValue('$sAttCode');\n"; $sJSHandlerCode .= "\toWizardHelper.RequestDefaultValue('$sAttCode');\n";
} }
if ($oAttDef->IsLinkSet()) if ($oAttDef->IsLinkSet()) {
{
$sJSHandlerCode .= "\toLinkWidgetatt_$iMaxInputId.Init();"; $sJSHandlerCode .= "\toLinkWidgetatt_$iMaxInputId.Init();";
} }
$iMaxInputId++; $iMaxInputId++;
@@ -141,8 +140,7 @@ $sJSHandlerCode
$this->m_oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\" />\n"); $this->m_oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\" />\n");
$this->m_oPage->add("<input type=\"hidden\" id=\"wizard_json_obj\" name=\"json_obj\" value=\"\" />\n"); $this->m_oPage->add("<input type=\"hidden\" id=\"wizard_json_obj\" name=\"json_obj\" value=\"\" />\n");
$sScript = "function OnEnterStep$iStepIndex() {\n"; $sScript = "function OnEnterStep$iStepIndex() {\n";
foreach($aFieldsMap as $iInputId => $sAttCode) foreach ($aFieldsMap as $iInputId => $sAttCode) {
{
$sScript .= "\toWizardHelper.UpdateCurrentValue('$sAttCode');\n"; $sScript .= "\toWizardHelper.UpdateCurrentValue('$sAttCode');\n";
} }
$sScript .= "\toWizardHelper.Preview('object_preview');\n"; $sScript .= "\toWizardHelper.Preview('object_preview');\n";
@@ -166,39 +164,32 @@ $sJSHandlerCode
*/ */
protected function ComputeWizardStructure() protected function ComputeWizardStructure()
{ {
$aWizardSteps = array( 'mandatory' => array(), 'optional' => array()); $aWizardSteps = [ 'mandatory' => [], 'optional' => []];
$aFieldsDone = array(); // Store all the fields that are already covered by a previous step of the wizard $aFieldsDone = []; // Store all the fields that are already covered by a previous step of the wizard
$aStates = MetaModel::EnumStates($this->m_sClass); $aStates = MetaModel::EnumStates($this->m_sClass);
$sStateAttCode = MetaModel::GetStateAttributeCode($this->m_sClass); $sStateAttCode = MetaModel::GetStateAttributeCode($this->m_sClass);
$aMandatoryAttributes = array(); $aMandatoryAttributes = [];
// Some attributes are always mandatory independently of the state machine (if any) // Some attributes are always mandatory independently of the state machine (if any)
foreach(MetaModel::GetAttributesList($this->m_sClass) as $sAttCode) foreach (MetaModel::GetAttributesList($this->m_sClass) as $sAttCode) {
{
$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
if (!$oAttDef->IsExternalField() && !$oAttDef->IsNullAllowed() && if (!$oAttDef->IsExternalField() && !$oAttDef->IsNullAllowed() &&
$oAttDef->IsWritable() && ($sAttCode != $sStateAttCode) ) $oAttDef->IsWritable() && ($sAttCode != $sStateAttCode)) {
{
$aMandatoryAttributes[$sAttCode] = OPT_ATT_MANDATORY; $aMandatoryAttributes[$sAttCode] = OPT_ATT_MANDATORY;
} }
} }
// Now check the attributes that are mandatory in the specified state // Now check the attributes that are mandatory in the specified state
if ( (!empty($this->m_sTargetState)) && (count($aStates[$this->m_sTargetState]['attribute_list']) > 0) ) if ((!empty($this->m_sTargetState)) && (count($aStates[$this->m_sTargetState]['attribute_list']) > 0)) {
{
// Check all the fields that *must* be included in the wizard for this // Check all the fields that *must* be included in the wizard for this
// particular target state // particular target state
$aFields = array(); $aFields = [];
foreach($aStates[$this->m_sTargetState]['attribute_list'] as $sAttCode => $iOptions) foreach ($aStates[$this->m_sTargetState]['attribute_list'] as $sAttCode => $iOptions) {
{
if ((isset($aMandatoryAttributes[$sAttCode])) && if ((isset($aMandatoryAttributes[$sAttCode])) &&
($aMandatoryAttributes[$sAttCode] & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) ) ($aMandatoryAttributes[$sAttCode] & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT))) {
{
$aMandatoryAttributes[$sAttCode] |= $iOptions; $aMandatoryAttributes[$sAttCode] |= $iOptions;
} } else {
else
{
$aMandatoryAttributes[$sAttCode] = $iOptions; $aMandatoryAttributes[$sAttCode] = $iOptions;
} }
} }
@@ -209,17 +200,14 @@ $sJSHandlerCode
// not also read-only or hidden. // not also read-only or hidden.
// Some fields may be required (null not allowed) from the database // Some fields may be required (null not allowed) from the database
// perspective, but hidden or read-only from the user interface perspective // perspective, but hidden or read-only from the user interface perspective
$aFields = array(); $aFields = [];
foreach($aMandatoryAttributes as $sAttCode => $iOptions) foreach ($aMandatoryAttributes as $sAttCode => $iOptions) {
{
if (($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) && if (($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) &&
!($iOptions & (OPT_ATT_READONLY | OPT_ATT_HIDDEN)) ) !($iOptions & (OPT_ATT_READONLY | OPT_ATT_HIDDEN))) {
{
$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
$aPrerequisites = $oAttDef->GetPrerequisiteAttributes(); $aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
$aFields[$sAttCode] = array(); $aFields[$sAttCode] = [];
foreach($aPrerequisites as $sCode) foreach ($aPrerequisites as $sCode) {
{
$aFields[$sAttCode][$sCode] = ''; $aFields[$sAttCode][$sCode] = '';
} }
} }
@@ -229,48 +217,39 @@ $sJSHandlerCode
// Start from the order of the 'details' // Start from the order of the 'details'
$aList = MetaModel::FlattenZlist(MetaModel::GetZListItems($this->m_sClass, 'details')); $aList = MetaModel::FlattenZlist(MetaModel::GetZListItems($this->m_sClass, 'details'));
$index = 0; $index = 0;
$aOrder = array(); $aOrder = [];
foreach($aFields as $sAttCode => $void) foreach ($aFields as $sAttCode => $void) {
{
$aOrder[$sAttCode] = 999; // At the end of the list... $aOrder[$sAttCode] = 999; // At the end of the list...
} }
foreach($aList as $sAttCode) foreach ($aList as $sAttCode) {
{ if (array_key_exists($sAttCode, $aFields)) {
if (array_key_exists($sAttCode, $aFields))
{
$aOrder[$sAttCode] = $index; $aOrder[$sAttCode] = $index;
} }
$index++; $index++;
} }
foreach($aFields as $sAttCode => $aDependencies) foreach ($aFields as $sAttCode => $aDependencies) {
{
// All fields with no remaining dependencies can be entered at this // All fields with no remaining dependencies can be entered at this
// step of the wizard // step of the wizard
if (count($aDependencies) > 0) if (count($aDependencies) > 0) {
{
$iMaxPos = 0; $iMaxPos = 0;
// Remove this field from the dependencies of the other fields // Remove this field from the dependencies of the other fields
foreach($aDependencies as $sDependentAttCode => $void) foreach ($aDependencies as $sDependentAttCode => $void) {
{
// position the current field after the ones it depends on // position the current field after the ones it depends on
$iMaxPos = max($iMaxPos, 1 + $aOrder[$sDependentAttCode]); $iMaxPos = max($iMaxPos, 1 + $aOrder[$sDependentAttCode]);
} }
} }
} }
asort($aOrder); asort($aOrder);
$aCurrentStep = array(); $aCurrentStep = [];
foreach($aOrder as $sAttCode => $rank) foreach ($aOrder as $sAttCode => $rank) {
{
$aCurrentStep[] = $sAttCode; $aCurrentStep[] = $sAttCode;
$aFieldsDone[$sAttCode] = ''; $aFieldsDone[$sAttCode] = '';
} }
$aWizardSteps['mandatory'][] = $aCurrentStep; $aWizardSteps['mandatory'][] = $aCurrentStep;
// Now computes the steps to fill the optional fields // Now computes the steps to fill the optional fields
$aFields = array(); // reset $aFields = []; // reset
foreach(MetaModel::ListAttributeDefs($this->m_sClass) as $sAttCode=>$oAttDef) foreach (MetaModel::ListAttributeDefs($this->m_sClass) as $sAttCode => $oAttDef) {
{
$iOptions = (isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode])) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0; $iOptions = (isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode])) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0;
if (($sStateAttCode != $sAttCode) && if (($sStateAttCode != $sAttCode) &&
(!$oAttDef->IsExternalField()) && (!$oAttDef->IsExternalField()) &&
@@ -282,7 +261,7 @@ $sJSHandlerCode
// are removed from the 'optional' part of the wizard // are removed from the 'optional' part of the wizard
$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
$aPrerequisites = $oAttDef->GetPrerequisiteAttributes(); $aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
$aFields[$sAttCode] = array(); $aFields[$sAttCode] = [];
foreach ($aPrerequisites as $sCode) { foreach ($aPrerequisites as $sCode) {
if (!isset($aFieldsDone[$sCode])) { if (!isset($aFieldsDone[$sCode])) {
// retain only the dependencies that were not covered // retain only the dependencies that were not covered
@@ -293,28 +272,23 @@ $sJSHandlerCode
} }
} }
// Now use the dependencies between the fields to order them // Now use the dependencies between the fields to order them
while(count($aFields) > 0) while (count($aFields) > 0) {
{ $aCurrentStep = [];
$aCurrentStep = array(); foreach ($aFields as $sAttCode => $aDependencies) {
foreach($aFields as $sAttCode => $aDependencies)
{
// All fields with no remaining dependencies can be entered at this // All fields with no remaining dependencies can be entered at this
// step of the wizard // step of the wizard
if (count($aDependencies) == 0) if (count($aDependencies) == 0) {
{
$aCurrentStep[] = $sAttCode; $aCurrentStep[] = $sAttCode;
$aFieldsDone[$sAttCode] = ''; $aFieldsDone[$sAttCode] = '';
unset($aFields[$sAttCode]); unset($aFields[$sAttCode]);
// Remove this field from the dependencies of the other fields // Remove this field from the dependencies of the other fields
foreach($aFields as $sUpdatedCode => $aDummy) foreach ($aFields as $sUpdatedCode => $aDummy) {
{
// remove the dependency // remove the dependency
unset($aFields[$sUpdatedCode][$sAttCode]); unset($aFields[$sUpdatedCode][$sAttCode]);
} }
} }
} }
if (count($aCurrentStep) == 0) if (count($aCurrentStep) == 0) {
{
// This step of the wizard would contain NO field ! // This step of the wizard would contain NO field !
$this->m_oPage->add(Dict::S('UI:Error:WizardCircularReferenceInDependencies')); $this->m_oPage->add(Dict::S('UI:Error:WizardCircularReferenceInDependencies'));
print_r($aFields); print_r($aFields);
@@ -326,4 +300,3 @@ $sJSHandlerCode
} }
} }
?>

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -31,31 +32,31 @@ class UserDashboard extends DBObject
{ {
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "gui", "category" => "gui",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => array('user_id', 'menu_code'), "name_attcode" => ['user_id', 'menu_code'],
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array(), "reconc_keys" => [],
"db_table" => "priv_app_dashboards", "db_table" => "priv_app_dashboards",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_AUTO, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", ["targetclass" => "User", "allowed_values" => null, "sql" => "user_id", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("menu_code", array("allowed_values"=>null, "sql"=>"menu_code", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeString("menu_code", ["allowed_values" => null, "sql" => "menu_code", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeText("contents", array("allowed_values"=>null, "sql"=>"contents", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeText("contents", ["allowed_values" => null, "sql" => "contents", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_SetZListItems('default_search', array ( MetaModel::Init_SetZListItems('default_search', [
0 => 'user_id', 0 => 'user_id',
1 => 'menu_code', 1 => 'menu_code',
)); ]);
MetaModel::Init_SetZListItems('list', array ( MetaModel::Init_SetZListItems('list', [
0 => 'user_id', 0 => 'user_id',
1 => 'menu_code', 1 => 'menu_code',
)); ]);
} }
/** /**
@@ -67,4 +68,3 @@ class UserDashboard extends DBObject
$this->DBDelete($oDeletionPlan); $this->DBDelete($oDeletionPlan);
} }
} }
?>

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -227,13 +228,12 @@ class appUserPreferences extends DBObject
// No prefs (yet) for this user, create the object // No prefs (yet) for this user, create the object
$oObj = new appUserPreferences(); $oObj = new appUserPreferences();
$oObj->Set('userid', $sUserId); $oObj->Set('userid', $sUserId);
$oObj->Set('preferences', array()); // Default preferences: an empty array $oObj->Set('preferences', []); // Default preferences: an empty array
try { try {
utils::PushArchiveMode(false); utils::PushArchiveMode(false);
$oObj->DBInsert(); $oObj->DBInsert();
utils::PopArchiveMode(); utils::PopArchiveMode();
} } catch (Exception $e) {
catch (Exception $e) {
// Ignore errors // Ignore errors
} }
} }
@@ -245,25 +245,25 @@ class appUserPreferences extends DBObject
*/ */
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "gui", "category" => "gui",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "login", "name_attcode" => "login",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array("userid","login"), "reconc_keys" => ["userid","login"],
"db_table" => "priv_app_preferences", "db_table" => "priv_app_preferences",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_AddAttribute(new AttributeExternalKey("userid", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"userid", "is_null_allowed"=>false, "on_target_delete"=>DEL_AUTO, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeExternalKey("userid", ["targetclass" => "User", "allowed_values" => null, "sql" => "userid", "is_null_allowed" => false, "on_target_delete" => DEL_AUTO, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributePropertySet("preferences", array("allowed_values"=>null, "sql"=>"preferences", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributePropertySet("preferences", ["allowed_values" => null, "sql" => "preferences", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeExternalField("org_id", array("allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "org_id"))); MetaModel::Init_AddAttribute(new AttributeExternalField("org_id", ["allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "org_id"]));
MetaModel::Init_AddAttribute(new AttributeExternalField("login", array("allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "login"))); MetaModel::Init_AddAttribute(new AttributeExternalField("login", ["allowed_values" => null, "extkey_attcode" => 'userid', "target_attcode" => "login"]));
MetaModel::Init_SetZListItems('list', array('org_id','preferences')); MetaModel::Init_SetZListItems('list', ['org_id','preferences']);
MetaModel::Init_SetZListItems('default_search', array('userid','login','org_id')); MetaModel::Init_SetZListItems('default_search', ['userid','login','org_id']);
} }
/** /**

View File

@@ -1,4 +1,5 @@
<?php <?php
/** /**
* Copyright (C) 2013-2024 Combodo SAS * Copyright (C) 2013-2024 Combodo SAS
* *
@@ -29,7 +30,6 @@ use ScssPhp\ScssPhp\OutputStyle;
use ScssPhp\ScssPhp\ValueConverter; use ScssPhp\ScssPhp\ValueConverter;
use Soundasleep\Html2Text; use Soundasleep\Html2Text;
/** /**
* Static class utils * Static class utils
* *
@@ -47,7 +47,6 @@ class FileUploadException extends Exception
{ {
} }
/** /**
* Helper functions to interact with forms: read parameters, upload files... * Helper functions to interact with forms: read parameters, upload files...
* @package iTop * @package iTop
@@ -170,7 +169,7 @@ class utils
// Parameters loaded from a file, parameters of the page/command line still have precedence // Parameters loaded from a file, parameters of the page/command line still have precedence
private static $m_aParamsFromFile = null; private static $m_aParamsFromFile = null;
private static $m_aParamSource = array(); private static $m_aParamSource = [];
private static $iNextId = 0; private static $iNextId = 0;
@@ -180,7 +179,6 @@ class utils
*/ */
private static $sAbsoluteUrlAppRootCache = null; private static $sAbsoluteUrlAppRootCache = null;
protected static function LoadParamFile($sParamFile) protected static function LoadParamFile($sParamFile)
{ {
if (!file_exists($sParamFile)) { if (!file_exists($sParamFile)) {
@@ -192,24 +190,21 @@ class utils
$sParams = file_get_contents($sParamFile); $sParams = file_get_contents($sParamFile);
if (is_null(self::$m_aParamsFromFile)) { if (is_null(self::$m_aParamsFromFile)) {
self::$m_aParamsFromFile = array(); self::$m_aParamsFromFile = [];
} }
$aParamLines = explode("\n", $sParams ?? ''); $aParamLines = explode("\n", $sParams ?? '');
foreach ($aParamLines as $sLine) foreach ($aParamLines as $sLine) {
{
$sLine = trim($sLine); $sLine = trim($sLine);
// Ignore the line after a '#' // Ignore the line after a '#'
if (($iCommentPos = strpos($sLine, '#')) !== false) if (($iCommentPos = strpos($sLine, '#')) !== false) {
{
$sLine = substr($sLine, 0, $iCommentPos); $sLine = substr($sLine, 0, $iCommentPos);
$sLine = trim($sLine); $sLine = trim($sLine);
} }
// Note: the line is supposed to be already trimmed // Note: the line is supposed to be already trimmed
if (preg_match('/^(\S*)\s*=(.*)$/', $sLine, $aMatches)) if (preg_match('/^(\S*)\s*=(.*)$/', $sLine, $aMatches)) {
{
$sParam = $aMatches[1]; $sParam = $aMatches[1];
$value = trim($aMatches[2]); $value = trim($aMatches[2]);
self::$m_aParamsFromFile[$sParam] = $value; self::$m_aParamsFromFile[$sParam] = $value;
@@ -221,11 +216,9 @@ class utils
public static function UseParamFile($sParamFileArgName = 'param_file', $bAllowCLI = true) public static function UseParamFile($sParamFileArgName = 'param_file', $bAllowCLI = true)
{ {
$sFileSpec = self::ReadParam($sParamFileArgName, '', $bAllowCLI, 'raw_data'); $sFileSpec = self::ReadParam($sParamFileArgName, '', $bAllowCLI, 'raw_data');
foreach(explode(',', $sFileSpec) as $sFile) foreach (explode(',', $sFileSpec) as $sFile) {
{
$sFile = trim($sFile); $sFile = trim($sFile);
if (!empty($sFile)) if (!empty($sFile)) {
{
self::LoadParamFile($sFile); self::LoadParamFile($sFile);
} }
} }
@@ -240,12 +233,9 @@ class utils
*/ */
public static function GetParamSourceFile($sName) public static function GetParamSourceFile($sName)
{ {
if (array_key_exists($sName, self::$m_aParamSource)) if (array_key_exists($sName, self::$m_aParamSource)) {
{
return self::$m_aParamSource[$sName]; return self::$m_aParamSource[$sName];
} } else {
else
{
return null; return null;
} }
} }
@@ -275,22 +265,18 @@ class utils
/** /**
* @var boolean[] * @var boolean[]
*/ */
protected static $aModes = array(); protected static $aModes = [];
public static function InitArchiveMode() public static function InitArchiveMode()
{ {
if (Session::IsSet('archive_mode')) if (Session::IsSet('archive_mode')) {
{
$iDefault = Session::Get('archive_mode'); $iDefault = Session::Get('archive_mode');
} } else {
else
{
$iDefault = 0; $iDefault = 0;
} }
// Read and record the value for switching the archive mode // Read and record the value for switching the archive mode
$iCurrent = self::ReadParam('with-archive', $iDefault); $iCurrent = self::ReadParam('with-archive', $iDefault);
if (Session::IsInitialized()) if (Session::IsInitialized()) {
{
Session::Set('archive_mode', $iCurrent); Session::Set('archive_mode', $iCurrent);
} }
// Read and use the value for the current page (web services) // Read and use the value for the current page (web services)
@@ -317,14 +303,10 @@ class utils
*/ */
public static function IsArchiveMode() public static function IsArchiveMode()
{ {
if (count(self::$aModes) > 0) if (count(self::$aModes) > 0) {
{
$bRet = end(self::$aModes); $bRet = end(self::$aModes);
} } else {
else if (self::$bPageMode === null) {
{
if (self::$bPageMode === null)
{
self::InitArchiveMode(); self::InitArchiveMode();
} }
$bRet = self::$bPageMode; $bRet = self::$bPageMode;
@@ -340,8 +322,7 @@ class utils
{ {
$bDefault = MetaModel::GetConfig()->Get('obsolescence.show_obsolete_data'); // default is false $bDefault = MetaModel::GetConfig()->Get('obsolescence.show_obsolete_data'); // default is false
$bShow = appUserPreferences::GetPref('show_obsolete_data', $bDefault); $bShow = appUserPreferences::GetPref('show_obsolete_data', $bDefault);
if (static::IsArchiveMode()) if (static::IsArchiveMode()) {
{
$bShow = true; $bShow = true;
} }
return $bShow; return $bShow;
@@ -352,24 +333,17 @@ class utils
global $argv; global $argv;
$retValue = $defaultValue; $retValue = $defaultValue;
if (!is_null(self::$m_aParamsFromFile)) if (!is_null(self::$m_aParamsFromFile)) {
{ if (isset(self::$m_aParamsFromFile[$sName])) {
if (isset(self::$m_aParamsFromFile[$sName]))
{
$retValue = self::$m_aParamsFromFile[$sName]; $retValue = self::$m_aParamsFromFile[$sName];
} }
} }
if (isset($_REQUEST[$sName])) if (isset($_REQUEST[$sName])) {
{
$retValue = $_REQUEST[$sName]; $retValue = $_REQUEST[$sName];
} } elseif ($bAllowCLI && isset($argv)) {
elseif ($bAllowCLI && isset($argv)) foreach ($argv as $iArg => $sArg) {
{ if (preg_match('/^--'.$sName.'=(.*)$/', $sArg, $aMatches)) {
foreach($argv as $iArg => $sArg)
{
if (preg_match('/^--'.$sName.'=(.*)$/', $sArg, $aMatches))
{
$retValue = $aMatches[1]; $retValue = $aMatches[1];
} }
} }
@@ -385,16 +359,12 @@ class utils
public static function Sanitize($value, $defaultValue, $sSanitizationFilter) public static function Sanitize($value, $defaultValue, $sSanitizationFilter)
{ {
if ($value === $defaultValue) if ($value === $defaultValue) {
{
// Preserve the real default value (can be used to detect missing mandatory parameters) // Preserve the real default value (can be used to detect missing mandatory parameters)
$retValue = $value; $retValue = $value;
} } else {
else
{
$retValue = self::Sanitize_Internal($value, $sSanitizationFilter); $retValue = self::Sanitize_Internal($value, $sSanitizationFilter);
if ($retValue === false) if ($retValue === false) {
{
$retValue = $defaultValue; $retValue = $defaultValue;
} }
} }
@@ -425,22 +395,18 @@ class utils
*/ */
protected static function Sanitize_Internal($value, $sSanitizationFilter) protected static function Sanitize_Internal($value, $sSanitizationFilter)
{ {
if (is_array($value)) if (is_array($value)) {
{ $retValue = [];
$retValue = array(); foreach ($value as $key => $val) {
foreach ($value as $key => $val)
{
$retValue[$key] = self::Sanitize_Internal($val, $sSanitizationFilter); // recursively check arrays $retValue[$key] = self::Sanitize_Internal($val, $sSanitizationFilter); // recursively check arrays
if ($retValue[$key] === false) if ($retValue[$key] === false) {
{
return false; return false;
} }
} }
return $retValue; return $retValue;
} }
switch ($sSanitizationFilter) switch ($sSanitizationFilter) {
{
case static::ENUM_SANITIZATION_FILTER_INTEGER: case static::ENUM_SANITIZATION_FILTER_INTEGER:
$retValue = filter_var($value, FILTER_SANITIZE_NUMBER_INT); $retValue = filter_var($value, FILTER_SANITIZE_NUMBER_INT);
break; break;
@@ -469,34 +435,33 @@ class utils
case static::ENUM_SANITIZATION_FILTER_PARAMETER: case static::ENUM_SANITIZATION_FILTER_PARAMETER:
case static::ENUM_SANITIZATION_FILTER_FIELD_NAME: case static::ENUM_SANITIZATION_FILTER_FIELD_NAME:
case static::ENUM_SANITIZATION_FILTER_TRANSACTION_ID: case static::ENUM_SANITIZATION_FILTER_TRANSACTION_ID:
switch ($sSanitizationFilter) switch ($sSanitizationFilter) {
{
case static::ENUM_SANITIZATION_FILTER_TRANSACTION_ID: case static::ENUM_SANITIZATION_FILTER_TRANSACTION_ID:
// Same as parameter type but keep the dot character // Same as parameter type but keep the dot character
// transaction_id, the dot is mostly for Windows servers when using file storage as the tokens are named *.tmp // transaction_id, the dot is mostly for Windows servers when using file storage as the tokens are named *.tmp
// - See N°1835 // - See N°1835
// - Note: It must be included at the regexp beginning otherwise you'll get an invalid character error // - Note: It must be included at the regexp beginning otherwise you'll get an invalid character error
$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options" => array("regexp" => '/^[\. A-Za-z0-9_=-]*$/'))); $retValue = filter_var($value, FILTER_VALIDATE_REGEXP, ["options" => ["regexp" => '/^[\. A-Za-z0-9_=-]*$/']]);
break; break;
case static::ENUM_SANITIZATION_FILTER_ROUTE: case static::ENUM_SANITIZATION_FILTER_ROUTE:
case static::ENUM_SANITIZATION_FILTER_OPERATION: case static::ENUM_SANITIZATION_FILTER_OPERATION:
// - Routes should be of the "controller_namespace_code.controller_method_name" form // - Routes should be of the "controller_namespace_code.controller_method_name" form
// - Operations should be allowed to be namespaced as well even though then don't have dedicated controller yet // - Operations should be allowed to be namespaced as well even though then don't have dedicated controller yet
$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options" => array("regexp" => '/^[\.A-Za-z0-9_-]*$/'))); $retValue = filter_var($value, FILTER_VALIDATE_REGEXP, ["options" => ["regexp" => '/^[\.A-Za-z0-9_-]*$/']]);
break; break;
case static::ENUM_SANITIZATION_FILTER_PARAMETER: case static::ENUM_SANITIZATION_FILTER_PARAMETER:
$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options" => array("regexp" => '/^[ A-Za-z0-9_=-]*$/'))); // the '=', '%3D, '%2B', '%2F' $retValue = filter_var($value, FILTER_VALIDATE_REGEXP, ["options" => ["regexp" => '/^[ A-Za-z0-9_=-]*$/']]); // the '=', '%3D, '%2B', '%2F'
// Characters are used in serialized filters (starting 2.5, only the url encoded versions are presents, but the "=" is kept for BC) // Characters are used in serialized filters (starting 2.5, only the url encoded versions are presents, but the "=" is kept for BC)
break; break;
case static::ENUM_SANITIZATION_FILTER_FIELD_NAME: case static::ENUM_SANITIZATION_FILTER_FIELD_NAME:
$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options" => array("regexp" => '/^[A-Za-z0-9_]+(->[A-Za-z0-9_]+)*$/'))); // att_code or att_code->name or AttCode->Name or AttCode->Key2->Name $retValue = filter_var($value, FILTER_VALIDATE_REGEXP, ["options" => ["regexp" => '/^[A-Za-z0-9_]+(->[A-Za-z0-9_]+)*$/']]); // att_code or att_code->name or AttCode->Name or AttCode->Key2->Name
break; break;
case static::ENUM_SANITIZATION_FILTER_CONTEXT_PARAM: case static::ENUM_SANITIZATION_FILTER_CONTEXT_PARAM:
$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options" => array("regexp" => '/^[ A-Za-z0-9_=%:+-]*$/'))); $retValue = filter_var($value, FILTER_VALIDATE_REGEXP, ["options" => ["regexp" => '/^[ A-Za-z0-9_=%:+-]*$/']]);
break; break;
} }
@@ -505,14 +470,20 @@ class utils
// For XML / HTML node identifiers // For XML / HTML node identifiers
case static::ENUM_SANITIZATION_FILTER_ELEMENT_IDENTIFIER: case static::ENUM_SANITIZATION_FILTER_ELEMENT_IDENTIFIER:
$retValue = preg_replace('/[^a-zA-Z0-9_-]/', '', $value); $retValue = preg_replace('/[^a-zA-Z0-9_-]/', '', $value);
$retValue = filter_var($retValue, FILTER_VALIDATE_REGEXP, $retValue = filter_var(
['options' => ['regexp' => '/^[A-Za-z0-9][A-Za-z0-9_-]*$/']]); $retValue,
FILTER_VALIDATE_REGEXP,
['options' => ['regexp' => '/^[A-Za-z0-9][A-Za-z0-9_-]*$/']]
);
break; break;
// For XML / HTML node id selector // For XML / HTML node id selector
case static::ENUM_SANITIZATION_FILTER_ELEMENT_SELECTOR: case static::ENUM_SANITIZATION_FILTER_ELEMENT_SELECTOR:
$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, $retValue = filter_var(
['options' => ['regexp' => '/^[#\.][A-Za-z0-9][A-Za-z0-9_-]*$/']]); $value,
FILTER_VALIDATE_REGEXP,
['options' => ['regexp' => '/^[#\.][A-Za-z0-9][A-Za-z0-9_-]*$/']]
);
break; break;
case static::ENUM_SANITIZATION_FILTER_VARIABLE_NAME: case static::ENUM_SANITIZATION_FILTER_VARIABLE_NAME:
@@ -546,13 +517,11 @@ class utils
public static function ReadPostedDocument($sName, $sIndex = null) public static function ReadPostedDocument($sName, $sIndex = null)
{ {
$oDocument = new ormDocument(); // an empty document $oDocument = new ormDocument(); // an empty document
if(isset($_FILES[$sName])) if (isset($_FILES[$sName])) {
{
$aFileInfo = $_FILES[$sName]; $aFileInfo = $_FILES[$sName];
$sError = is_null($sIndex) ? $aFileInfo['error'] : $aFileInfo['error'][$sIndex]; $sError = is_null($sIndex) ? $aFileInfo['error'] : $aFileInfo['error'][$sIndex];
switch($sError) switch ($sError) {
{
case UPLOAD_ERR_OK: case UPLOAD_ERR_OK:
$sTmpName = is_null($sIndex) ? $aFileInfo['tmp_name'] : $aFileInfo['tmp_name'][$sIndex]; $sTmpName = is_null($sIndex) ? $aFileInfo['tmp_name'] : $aFileInfo['tmp_name'][$sIndex];
$sMimeType = is_null($sIndex) ? $aFileInfo['type'] : $aFileInfo['type'][$sIndex]; $sMimeType = is_null($sIndex) ? $aFileInfo['type'] : $aFileInfo['type'][$sIndex];
@@ -610,26 +579,22 @@ class utils
*/ */
public static function ReadMultipleSelection($oFullSetFilter) public static function ReadMultipleSelection($oFullSetFilter)
{ {
$aSelectedObj = utils::ReadParam('selectObject', array()); $aSelectedObj = utils::ReadParam('selectObject', []);
$sSelectionMode = utils::ReadParam('selectionMode', ''); $sSelectionMode = utils::ReadParam('selectionMode', '');
if ($sSelectionMode != '') { if ($sSelectionMode != '') {
// Paginated selection // Paginated selection
$aExceptions = utils::ReadParam('storedSelection', array()); $aExceptions = utils::ReadParam('storedSelection', []);
if ($sSelectionMode == 'positive') { if ($sSelectionMode == 'positive') {
// Only the explicitely listed items are selected // Only the explicitely listed items are selected
$aSelectedObj = $aExceptions; $aSelectedObj = $aExceptions;
} } else {
else
{
// All items of the set are selected, except the one explicitely listed // All items of the set are selected, except the one explicitely listed
$aSelectedObj = array(); $aSelectedObj = [];
$oFullSet = new DBObjectSet($oFullSetFilter); $oFullSet = new DBObjectSet($oFullSetFilter);
$sClassAlias = $oFullSetFilter->GetClassAlias(); $sClassAlias = $oFullSetFilter->GetClassAlias();
$oFullSet->OptimizeColumnLoad(array($sClassAlias => array('friendlyname'))); // We really need only the IDs but it does not work since id is not a real field $oFullSet->OptimizeColumnLoad([$sClassAlias => ['friendlyname']]); // We really need only the IDs but it does not work since id is not a real field
while($oObj = $oFullSet->Fetch()) while ($oObj = $oFullSet->Fetch()) {
{ if (!in_array($oObj->GetKey(), $aExceptions)) {
if (!in_array($oObj->GetKey(), $aExceptions))
{
$aSelectedObj[] = $oObj->GetKey(); $aSelectedObj[] = $oObj->GetKey();
} }
} }
@@ -650,45 +615,37 @@ class utils
{ {
$sSelectionMode = utils::ReadParam('selectionMode', ''); $sSelectionMode = utils::ReadParam('selectionMode', '');
if ($sSelectionMode != 'positive' && $sSelectionMode != 'negative') if ($sSelectionMode != 'positive' && $sSelectionMode != 'negative') {
{
throw new CoreException('selectionMode must be either positive or negative'); throw new CoreException('selectionMode must be either positive or negative');
} }
// Paginated selection // Paginated selection
$aSelectedIds = utils::ReadParam('storedSelection', array()); $aSelectedIds = utils::ReadParam('storedSelection', []);
$aSelectedObjIds = utils::ReadParam('selectObject', array()); $aSelectedObjIds = utils::ReadParam('selectObject', []);
//it means that the user has selected all the results of the search query //it means that the user has selected all the results of the search query
if (count($aSelectedObjIds) > 0 ) if (count($aSelectedObjIds) > 0) {
{
$sFilter = utils::ReadParam("sFilter", '', false, 'raw_data'); $sFilter = utils::ReadParam("sFilter", '', false, 'raw_data');
if ($sFilter!='') if ($sFilter != '') {
{
$oFullSetFilter = DBSearch::unserialize($sFilter); $oFullSetFilter = DBSearch::unserialize($sFilter);
} }
} }
if (count($aSelectedIds) > 0 ) if (count($aSelectedIds) > 0) {
{ if ($sSelectionMode == 'positive') {
if ($sSelectionMode == 'positive')
{
// Only the explicitly listed items are selected // Only the explicitly listed items are selected
$oFullSetFilter->AddCondition('id', $aSelectedIds, 'IN'); $oFullSetFilter->AddCondition('id', $aSelectedIds, 'IN');
} } else {
else
{
// All items of the set are selected, except the one explicitly listed // All items of the set are selected, except the one explicitly listed
$oFullSetFilter->AddCondition('id', $aSelectedIds, 'NOTIN'); $oFullSetFilter->AddCondition('id', $aSelectedIds, 'NOTIN');
} }
} }
$aSelectedObj = array(); $aSelectedObj = [];
$oFullSet = new DBObjectSet($oFullSetFilter); $oFullSet = new DBObjectSet($oFullSetFilter);
$sClassAlias = $oFullSetFilter->GetClassAlias(); $sClassAlias = $oFullSetFilter->GetClassAlias();
$oFullSet->OptimizeColumnLoad(array($sClassAlias => array('friendlyname'))); // We really need only the IDs but it does not work since id is not a real field $oFullSet->OptimizeColumnLoad([$sClassAlias => ['friendlyname']]); // We really need only the IDs but it does not work since id is not a real field
while ($oObj = $oFullSet->Fetch()) while ($oObj = $oFullSet->Fetch()) {
{
$aSelectedObj[$oObj->GetKey()] = $oObj->Get('friendlyname'); $aSelectedObj[$oObj->GetKey()] = $oObj->Get('friendlyname');
} }
@@ -719,8 +676,7 @@ class utils
*/ */
public static function GetUploadTempId($sTransactionId = null) public static function GetUploadTempId($sTransactionId = null)
{ {
if ($sTransactionId === null) if ($sTransactionId === null) {
{
$sTransactionId = static::GetNewTransactionId(); $sTransactionId = static::GetNewTransactionId();
} }
return $sTransactionId; return $sTransactionId;
@@ -753,8 +709,10 @@ class utils
switch ($sUnit) { switch ($sUnit) {
case 'G': case 'G':
$iReturn *= 1024; $iReturn *= 1024;
// no break
case 'M': case 'M':
$iReturn *= 1024; $iReturn *= 1024;
// no break
case 'K': case 'K':
$iReturn *= 1024; $iReturn *= 1024;
} }
@@ -828,8 +786,7 @@ class utils
{ {
$sReturn = ''; $sReturn = '';
// Kilobytes // Kilobytes
if ($value >= 1024) if ($value >= 1024) {
{
$sReturn = 'K'; $sReturn = 'K';
$value = $value / 1024; $value = $value / 1024;
if ($iPrecision === 0) { if ($iPrecision === 0) {
@@ -837,20 +794,17 @@ class utils
} }
} }
// Megabytes // Megabytes
if ($value >= 1024) if ($value >= 1024) {
{
$sReturn = 'M'; $sReturn = 'M';
$value = $value / 1024; $value = $value / 1024;
} }
// Gigabytes // Gigabytes
if ($value >= 1024) if ($value >= 1024) {
{
$sReturn = 'G'; $sReturn = 'G';
$value = $value / 1024; $value = $value / 1024;
} }
// Terabytes // Terabytes
if ($value >= 1024) if ($value >= 1024) {
{
$sReturn = 'T'; $sReturn = 'T';
$value = $value / 1024; $value = $value / 1024;
} }
@@ -876,7 +830,7 @@ class utils
static $aDateTokens = null; static $aDateTokens = null;
static $aDateRegexps = null; static $aDateRegexps = null;
if (is_null($aDateTokens)) { if (is_null($aDateTokens)) {
$aSpec = array( $aSpec = [
'%d' => '(?<day>[0-9]{2})', '%d' => '(?<day>[0-9]{2})',
'%m' => '(?<month>[0-9]{2})', '%m' => '(?<month>[0-9]{2})',
'%y' => '(?<year>[0-9]{2})', '%y' => '(?<year>[0-9]{2})',
@@ -884,15 +838,14 @@ class utils
'%H' => '(?<hour>[0-2][0-9])', '%H' => '(?<hour>[0-2][0-9])',
'%i' => '(?<minute>[0-5][0-9])', '%i' => '(?<minute>[0-5][0-9])',
'%s' => '(?<second>[0-5][0-9])', '%s' => '(?<second>[0-5][0-9])',
); ];
$aDateTokens = array_keys($aSpec); $aDateTokens = array_keys($aSpec);
$aDateRegexps = array_values($aSpec); $aDateRegexps = array_values($aSpec);
} }
$sDateRegexp = str_replace($aDateTokens, $aDateRegexps, $sFormat); $sDateRegexp = str_replace($aDateTokens, $aDateRegexps, $sFormat);
if (preg_match('!^(?<head>)'.$sDateRegexp.'(?<tail>)$!', $sDate, $aMatches)) if (preg_match('!^(?<head>)'.$sDateRegexp.'(?<tail>)$!', $sDate, $aMatches)) {
{
$sYear = isset($aMatches['year']) ? $aMatches['year'] : 0; $sYear = isset($aMatches['year']) ? $aMatches['year'] : 0;
$sMonth = isset($aMatches['month']) ? $aMatches['month'] : 1; $sMonth = isset($aMatches['month']) ? $aMatches['month'] : 1;
$sDay = isset($aMatches['day']) ? $aMatches['day'] : 1; $sDay = isset($aMatches['day']) ? $aMatches['day'] : 1;
@@ -900,9 +853,7 @@ class utils
$sMinute = isset($aMatches['minute']) ? $aMatches['minute'] : 0; $sMinute = isset($aMatches['minute']) ? $aMatches['minute'] : 0;
$sSecond = isset($aMatches['second']) ? $aMatches['second'] : 0; $sSecond = isset($aMatches['second']) ? $aMatches['second'] : 0;
return strtotime("$sYear-$sMonth-$sDay $sHour:$sMinute:$sSecond"); return strtotime("$sYear-$sMonth-$sDay $sHour:$sMinute:$sSecond");
} } else {
else
{
return false; return false;
} }
// http://www.spaweditor.com/scripts/regex/index.php // http://www.spaweditor.com/scripts/regex/index.php
@@ -1008,8 +959,7 @@ class utils
} }
$sProductionEnvConfigPath = self::GetConfigFilePath('production'); $sProductionEnvConfigPath = self::GetConfigFilePath('production');
if (file_exists($sProductionEnvConfigPath)) if (file_exists($sProductionEnvConfigPath)) {
{
$oProductionEnvDiskConfig = new Config($sProductionEnvConfigPath); $oProductionEnvDiskConfig = new Config($sProductionEnvConfigPath);
self::SetConfig($oProductionEnvDiskConfig); self::SetConfig($oProductionEnvDiskConfig);
return self::$oConfig; return self::$oConfig;
@@ -1020,13 +970,11 @@ class utils
public static function InitTimeZone($oConfig = null) public static function InitTimeZone($oConfig = null)
{ {
if (is_null($oConfig)) if (is_null($oConfig)) {
{
$oConfig = self::GetConfig(); $oConfig = self::GetConfig();
} }
$sItopTimeZone = $oConfig->Get('timezone'); $sItopTimeZone = $oConfig->Get('timezone');
if (!empty($sItopTimeZone)) if (!empty($sItopTimeZone)) {
{
date_default_timezone_set($sItopTimeZone); date_default_timezone_set($sItopTimeZone);
} }
// else // else
@@ -1065,21 +1013,14 @@ class utils
*/ */
public static function GetAbsoluteUrlAppRoot($bForceTrustProxy = false) public static function GetAbsoluteUrlAppRoot($bForceTrustProxy = false)
{ {
if (static::$sAbsoluteUrlAppRootCache === null || $bForceTrustProxy) if (static::$sAbsoluteUrlAppRootCache === null || $bForceTrustProxy) {
{
static::$sAbsoluteUrlAppRootCache = self::GetConfig()->Get('app_root_url'); static::$sAbsoluteUrlAppRootCache = self::GetConfig()->Get('app_root_url');
if (static::$sAbsoluteUrlAppRootCache == '') if (static::$sAbsoluteUrlAppRootCache == '') {
{
static::$sAbsoluteUrlAppRootCache = self::GetDefaultUrlAppRoot($bForceTrustProxy); static::$sAbsoluteUrlAppRootCache = self::GetDefaultUrlAppRoot($bForceTrustProxy);
} } elseif (strpos(static::$sAbsoluteUrlAppRootCache, SERVER_NAME_PLACEHOLDER) > -1) {
elseif (strpos(static::$sAbsoluteUrlAppRootCache, SERVER_NAME_PLACEHOLDER) > -1) if (isset($_SERVER['SERVER_NAME'])) {
{
if (isset($_SERVER['SERVER_NAME']))
{
$sServerName = $_SERVER['SERVER_NAME']; $sServerName = $_SERVER['SERVER_NAME'];
} } else {
else
{
// CLI mode ? // CLI mode ?
$sServerName = php_uname('n'); $sServerName = php_uname('n');
} }
@@ -1112,7 +1053,6 @@ class utils
return self::GetAppRootUrl($sCurrentScript, $sAppRoot, $sAbsoluteUrl); return self::GetAppRootUrl($sCurrentScript, $sAppRoot, $sAbsoluteUrl);
} }
/** /**
* Build the current absolute URL from the server's variables. * Build the current absolute URL from the server's variables.
* *
@@ -1203,11 +1143,9 @@ class utils
{ {
// $_SERVER['REQUEST_URI'] is empty when running on IIS // $_SERVER['REQUEST_URI'] is empty when running on IIS
// Let's use Ivan Tcholakov's fix (found on www.dokeos.com) // Let's use Ivan Tcholakov's fix (found on www.dokeos.com)
if (empty($_SERVER['REQUEST_URI'])) if (empty($_SERVER['REQUEST_URI'])) {
{
$sPath = $_SERVER['SCRIPT_NAME']; $sPath = $_SERVER['SCRIPT_NAME'];
if (!empty($_SERVER['QUERY_STRING'])) if (!empty($_SERVER['QUERY_STRING'])) {
{
$sPath .= '?'.$_SERVER['QUERY_STRING']; $sPath .= '?'.$_SERVER['QUERY_STRING'];
} }
$_SERVER['REQUEST_URI'] = $sPath; $_SERVER['REQUEST_URI'] = $sPath;
@@ -1232,21 +1170,15 @@ class utils
$sCurrentRelativePath = str_ireplace($sAppRoot, '', $sCurrentScript); $sCurrentRelativePath = str_ireplace($sAppRoot, '', $sCurrentScript);
$sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath); $sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath);
if ($sAppRootPos !== false) if ($sAppRootPos !== false) {
{
$sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path $sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path
} } else {
else
{
// Second attempt without index.php at the end... // Second attempt without index.php at the end...
$sCurrentRelativePath = str_ireplace('index.php', '', $sCurrentRelativePath); $sCurrentRelativePath = str_ireplace('index.php', '', $sCurrentRelativePath);
$sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath); $sAppRootPos = strpos($sAbsoluteUrl, $sCurrentRelativePath);
if ($sAppRootPos !== false) if ($sAppRootPos !== false) {
{
$sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path $sAppRootUrl = substr($sAbsoluteUrl, 0, $sAppRootPos); // remove the current page and path
} } else {
else
{
// No luck... // No luck...
throw new Exception("Failed to determine application root path $sAbsoluteUrl ($sCurrentRelativePath) APPROOT:'$sAppRoot'"); throw new Exception("Failed to determine application root path $sAbsoluteUrl ($sCurrentRelativePath) APPROOT:'$sAppRoot'");
} }
@@ -1263,13 +1195,10 @@ class utils
*/ */
public static function GetAppRevisionNumber() public static function GetAppRevisionNumber()
{ {
if (ITOP_REVISION == 'svn') if (ITOP_REVISION == 'svn') {
{
// This is NOT a version built using the build system, just display the main version // This is NOT a version built using the build system, just display the main version
$sRevisionNumber = Dict::Format('UI:iTopVersion:Short', ITOP_APPLICATION, ITOP_VERSION); $sRevisionNumber = Dict::Format('UI:iTopVersion:Short', ITOP_APPLICATION, ITOP_VERSION);
} } else {
else
{
// This is a build made from SVN, let display the full information // This is a build made from SVN, let display the full information
$sRevisionNumber = Dict::Format('UI:iTopVersion:Long', ITOP_APPLICATION, ITOP_VERSION, ITOP_REVISION, ITOP_BUILD_DATE); $sRevisionNumber = Dict::Format('UI:iTopVersion:Long', ITOP_APPLICATION, ITOP_VERSION, ITOP_REVISION, ITOP_BUILD_DATE);
} }
@@ -1297,16 +1226,11 @@ class utils
$bTrustProxy = $bForceTrustProxy || self::IsProxyTrusted(); $bTrustProxy = $bForceTrustProxy || self::IsProxyTrusted();
if ($bTrustProxy && !empty($_SERVER['HTTP_X_FORWARDED_PROTO'])) if ($bTrustProxy && !empty($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
{
$bSecured = ($_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https'); $bSecured = ($_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https');
} } elseif ($bTrustProxy && !empty($_SERVER['HTTP_X_FORWARDED_PROTOCOL'])) {
elseif ($bTrustProxy && !empty($_SERVER['HTTP_X_FORWARDED_PROTOCOL']))
{
$bSecured = ($_SERVER['HTTP_X_FORWARDED_PROTOCOL'] === 'https'); $bSecured = ($_SERVER['HTTP_X_FORWARDED_PROTOCOL'] === 'https');
} } elseif ((!empty($_SERVER['HTTPS'])) && (strtolower($_SERVER['HTTPS']) != 'off')) {
elseif ((!empty($_SERVER['HTTPS'])) && (strtolower($_SERVER['HTTPS']) != 'off'))
{
$bSecured = (strcasecmp($_SERVER['HTTPS'], 'off') !== 0); $bSecured = (strcasecmp($_SERVER['HTTPS'], 'off') !== 0);
} }
@@ -1320,7 +1244,7 @@ class utils
* 2) the user did not log-in using the "basic" mode (i.e basic authentication) or by passing credentials in the URL * 2) the user did not log-in using the "basic" mode (i.e basic authentication) or by passing credentials in the URL
* @return boolean True if logoff is supported, false otherwise * @return boolean True if logoff is supported, false otherwise
*/ */
static function CanLogOff() public static function CanLogOff()
{ {
return Session::Get('can_logoff', false); return Session::Get('can_logoff', false);
} }
@@ -1334,12 +1258,11 @@ class utils
return Session::GetLog(); return Session::GetLog();
} }
static function DebugBacktrace($iLimit = 5) public static function DebugBacktrace($iLimit = 5)
{ {
$aFullTrace = debug_backtrace(); $aFullTrace = debug_backtrace();
$aLightTrace = array(); $aLightTrace = [];
for($i=1; ($i<=$iLimit && $i < count($aFullTrace)); $i++) // Skip the last function call... which is the call to this function ! for ($i = 1; ($i <= $iLimit && $i < count($aFullTrace)); $i++) { // Skip the last function call... which is the call to this function !
{
$aLightTrace[$i] = $aFullTrace[$i]['function'].'(), called from line '.$aFullTrace[$i]['line'].' in '.$aFullTrace[$i]['file']; $aLightTrace[$i] = $aFullTrace[$i]['function'].'(), called from line '.$aFullTrace[$i]['line'].' in '.$aFullTrace[$i]['file'];
} }
echo "<p><pre>".print_r($aLightTrace, true)."</pre></p>\n"; echo "<p><pre>".print_r($aLightTrace, true)."</pre></p>\n";
@@ -1385,7 +1308,7 @@ class utils
$aArguments['param_file'] = $sParamFile; $aArguments['param_file'] = $sParamFile;
} }
$aArgs = array(); $aArgs = [];
foreach ($aArguments as $sName => $value) { foreach ($aArguments as $sName => $value) {
// Note: See comment from the 23-Apr-2004 03:30 in the PHP documentation // Note: See comment from the 23-Apr-2004 03:30 in the PHP documentation
// It suggests to rely on pctnl_* function instead of using escapeshellargs // It suggests to rely on pctnl_* function instead of using escapeshellargs
@@ -1416,7 +1339,7 @@ class utils
throw new Exception(Dict::S('Core:ExecProcess:Code255')." - ".$sCommand.":\n".$sErrors); throw new Exception(Dict::S('Core:ExecProcess:Code255')." - ".$sCommand.":\n".$sErrors);
} }
return array($iRes, $aOutput); return [$iRes, $aOutput];
} }
/** /**
@@ -1507,8 +1430,7 @@ class utils
// 1st - add standard built-in menu items // 1st - add standard built-in menu items
// //
switch($iMenuId) switch ($iMenuId) {
{
case iPopupMenuExtension::MENU_OBJLIST_ACTIONS: case iPopupMenuExtension::MENU_OBJLIST_ACTIONS:
// No native action there yet // No native action there yet
break; break;
@@ -1538,7 +1460,9 @@ class utils
if (strlen($sUrl) < SERVER_MAX_URL_LENGTH) { if (strlen($sUrl) < SERVER_MAX_URL_LENGTH) {
// Static menus: Email this page, CSV Export & Add to Dashboard // Static menus: Email this page, CSV Export & Add to Dashboard
$aResult[] = new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), $aResult[] = new URLPopupMenuItem(
'UI:Menu:EMail',
Dict::S('UI:Menu:EMail'),
"mailto:?body=".urlencode($sUrl).' ' // Add an extra space to make it work in Outlook "mailto:?body=".urlencode($sUrl).' ' // Add an extra space to make it work in Outlook
); );
} }
@@ -1547,8 +1471,7 @@ class utils
// Bulk export actions // Bulk export actions
$aResult[] = new JSPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), "ExportListDlg('$sOQL', '$sDataTableId', 'csv', ".json_encode(Dict::S('UI:Menu:CSVExport')).")"); $aResult[] = new JSPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), "ExportListDlg('$sOQL', '$sDataTableId', 'csv', ".json_encode(Dict::S('UI:Menu:CSVExport')).")");
$aResult[] = new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '$sDataTableId', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"); $aResult[] = new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '$sDataTableId', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")");
if (extension_loaded('gd')) if (extension_loaded('gd')) {
{
// PDF export requires GD // PDF export requires GD
$aResult[] = new JSPopupMenuItem('UI:Menu:ExportPDF', Dict::S('UI:Menu:ExportPDF'), "ExportListDlg('$sOQL', '$sDataTableId', 'pdf', ".json_encode(Dict::S('UI:Menu:ExportPDF')).")"); $aResult[] = new JSPopupMenuItem('UI:Menu:ExportPDF', Dict::S('UI:Menu:ExportPDF'), "ExportListDlg('$sOQL', '$sDataTableId', 'pdf', ".json_encode(Dict::S('UI:Menu:ExportPDF')).")");
} }
@@ -1571,7 +1494,7 @@ class utils
$oContainerBlock->AddJsFileRelPath('js/jquery.dragtable.js'); $oContainerBlock->AddJsFileRelPath('js/jquery.dragtable.js');
$oContainerBlock->AddCssFileRelPath('css/dragtable.css'); $oContainerBlock->AddCssFileRelPath('css/dragtable.css');
$aResult = array( $aResult = [
new SeparatorPopupMenuItem(), new SeparatorPopupMenuItem(),
// Static menus: Email this page & CSV Export // Static menus: Email this page & CSV Export
new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?subject=".urlencode($oObj->GetRawName())."&body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?subject=".urlencode($oObj->GetRawName())."&body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook
@@ -1579,7 +1502,7 @@ class utils
new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"), new JSPopupMenuItem('UI:Menu:ExportXLSX', Dict::S('ExcelExporter:ExportMenu'), "ExportListDlg('$sOQL', '', 'xlsx', ".json_encode(Dict::S('ExcelExporter:ExportMenu')).")"),
new SeparatorPopupMenuItem(), new SeparatorPopupMenuItem(),
new URLPopupMenuItem('UI:Menu:PrintableVersion', Dict::S('UI:Menu:PrintableVersion'), $sUrl.'&printable=1', '_blank'), new URLPopupMenuItem('UI:Menu:PrintableVersion', Dict::S('UI:Menu:PrintableVersion'), $sUrl.'&printable=1', '_blank'),
); ];
break; break;
case iPopupMenuExtension::MENU_DASHBOARD_ACTIONS: case iPopupMenuExtension::MENU_DASHBOARD_ACTIONS:
@@ -1595,11 +1518,11 @@ class utils
$sDashboardFileJS = addslashes($sDashboardFileRelative); $sDashboardFileJS = addslashes($sDashboardFileRelative);
$sDashboardFileURL = urlencode($sDashboardFileRelative); $sDashboardFileURL = urlencode($sDashboardFileRelative);
$sUploadDashboardTransactId = utils::GetNewTransactionId(); $sUploadDashboardTransactId = utils::GetNewTransactionId();
$aResult = array( $aResult = [
new SeparatorPopupMenuItem(), new SeparatorPopupMenuItem(),
new URLPopupMenuItem('UI:ExportDashboard', Dict::S('UI:ExportDashBoard'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=export_dashboard&id='.$sDashboardId.'&file='.$sDashboardFileURL), new URLPopupMenuItem('UI:ExportDashboard', Dict::S('UI:ExportDashBoard'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=export_dashboard&id='.$sDashboardId.'&file='.$sDashboardFileURL),
new JSPopupMenuItem('UI:ImportDashboard', Dict::S('UI:ImportDashBoard'), "UploadDashboard({dashboard_id: '$sDashboardId', file: '$sDashboardFileJS', title: '$sDlgTitle', text: '$sDlgText', close_btn: '$sCloseBtn', transaction: '$sUploadDashboardTransactId' })"), new JSPopupMenuItem('UI:ImportDashboard', Dict::S('UI:ImportDashBoard'), "UploadDashboard({dashboard_id: '$sDashboardId', file: '$sDashboardFileJS', title: '$sDlgTitle', text: '$sDlgText', close_btn: '$sCloseBtn', transaction: '$sUploadDashboardTransactId' })"),
); ];
if ($oDashboard->GetReloadURL()) { if ($oDashboard->GetReloadURL()) {
$aResult[] = new SeparatorPopupMenuItem(); $aResult[] = new SeparatorPopupMenuItem();
$aResult[] = new URLPopupMenuItem('UI:Menu:PrintableVersion', Dict::S('UI:Menu:PrintableVersion'), $oDashboard->GetReloadURL().'&printable=1', '_blank'); $aResult[] = new URLPopupMenuItem('UI:Menu:PrintableVersion', Dict::S('UI:Menu:PrintableVersion'), $oDashboard->GetReloadURL().'&printable=1', '_blank');
@@ -1786,8 +1709,7 @@ SQL;
*/ */
public static function GetConfigFilePathRelative($sEnvironment = null) public static function GetConfigFilePathRelative($sEnvironment = null)
{ {
if (is_null($sEnvironment)) if (is_null($sEnvironment)) {
{
$sEnvironment = self::GetCurrentEnvironment(); $sEnvironment = self::GetCurrentEnvironment();
} }
return "conf/".$sEnvironment.'/'.ITOP_CONFIG_FILE; return "conf/".$sEnvironment.'/'.ITOP_CONFIG_FILE;
@@ -1824,7 +1746,7 @@ SQL;
* *
* @throws \Exception * @throws \Exception
*/ */
public static function GetAbsoluteUrlModulePage($sModule, $sPage, $aArguments = array(), $sEnvironment = null) public static function GetAbsoluteUrlModulePage($sModule, $sPage, $aArguments = [], $sEnvironment = null)
{ {
$aArgs = self::GetExecPageArguments($sModule, $sPage, $aArguments, $sEnvironment); $aArgs = self::GetExecPageArguments($sModule, $sPage, $aArguments, $sEnvironment);
$sArgs = http_build_query($aArgs); $sArgs = http_build_query($aArgs);
@@ -1841,17 +1763,15 @@ SQL;
* @return string[] key/value pair for the exec page query string. <b>Warning</b> : values are not url encoded ! * @return string[] key/value pair for the exec page query string. <b>Warning</b> : values are not url encoded !
* @throws \Exception if one of the argument has a reserved name * @throws \Exception if one of the argument has a reserved name
*/ */
public static function GetExecPageArguments($sModule, $sPage, $aArguments = array(), $sEnvironment = null) public static function GetExecPageArguments($sModule, $sPage, $aArguments = [], $sEnvironment = null)
{ {
$sEnvironment = is_null($sEnvironment) ? self::GetCurrentEnvironment() : $sEnvironment; $sEnvironment = is_null($sEnvironment) ? self::GetCurrentEnvironment() : $sEnvironment;
$aArgs = array(); $aArgs = [];
$aArgs['exec_module'] = $sModule; $aArgs['exec_module'] = $sModule;
$aArgs['exec_page'] = $sPage; $aArgs['exec_page'] = $sPage;
$aArgs['exec_env'] = $sEnvironment; $aArgs['exec_env'] = $sEnvironment;
foreach($aArguments as $sName => $sValue) foreach ($aArguments as $sName => $sValue) {
{ if (($sName == 'exec_module') || ($sName == 'exec_page') || ($sName == 'exec_env')) {
if (($sName == 'exec_module') || ($sName == 'exec_page') || ($sName == 'exec_env'))
{
throw new Exception("Module page: $sName is a reserved page argument name"); throw new Exception("Module page: $sName is a reserved page argument name");
} }
$aArgs[$sName] = $sValue; $aArgs[$sName] = $sValue;
@@ -1877,17 +1797,13 @@ SQL;
*/ */
public static function MakeUniqueName($sProposed, $aExisting) public static function MakeUniqueName($sProposed, $aExisting)
{ {
if (in_array($sProposed, $aExisting)) if (in_array($sProposed, $aExisting)) {
{
$i = 1; $i = 1;
while (in_array($sProposed.$i, $aExisting) && ($i < 50)) while (in_array($sProposed.$i, $aExisting) && ($i < 50)) {
{
$i++; $i++;
} }
return $sProposed.$i; return $sProposed.$i;
} } else {
else
{
return $sProposed; return $sProposed;
} }
} }
@@ -1899,7 +1815,7 @@ SQL;
*/ */
public static function GetSafeId($sId) public static function GetSafeId($sId)
{ {
return str_replace(array(':', '[', ']', '+', '-', ' '), '_', $sId); return str_replace([':', '[', ']', '+', '-', ' '], '_', $sId);
} }
/** /**
@@ -1925,7 +1841,7 @@ SQL;
* *
* @since 3.1.0 N°6172 as curl ext is now mandatory, method will crash with a ApplicationException if this PHP extension isn't available * @since 3.1.0 N°6172 as curl ext is now mandatory, method will crash with a ApplicationException if this PHP extension isn't available
*/ */
public static function DoPostRequest($sUrl, $aData, $sOptionnalHeaders = null, &$aResponseHeaders = null, $aCurlOptions = array()) public static function DoPostRequest($sUrl, $aData, $sOptionnalHeaders = null, &$aResponseHeaders = null, $aCurlOptions = [])
{ {
if (false === function_exists('curl_init')) { if (false === function_exists('curl_init')) {
throw new ApplicationException('\utils::DoPostRequest method called whereas the CURL PHP extension isn\'t available !'); throw new ApplicationException('\utils::DoPostRequest method called whereas the CURL PHP extension isn\'t available !');
@@ -1938,12 +1854,12 @@ SQL;
$aHeaders = explode("\n", $sOptionnalHeaders ?? ''); $aHeaders = explode("\n", $sOptionnalHeaders ?? '');
// N°3267 - Webservices: Fix optional headers not being taken into account // N°3267 - Webservices: Fix optional headers not being taken into account
// See https://www.php.net/curl_setopt CURLOPT_HTTPHEADER // See https://www.php.net/curl_setopt CURLOPT_HTTPHEADER
$aHTTPHeaders = array(); $aHTTPHeaders = [];
foreach ($aHeaders as $sHeaderString) { foreach ($aHeaders as $sHeaderString) {
$aHTTPHeaders[] = trim($sHeaderString); $aHTTPHeaders[] = trim($sHeaderString);
} }
// Default options, can be overloaded/extended with the 4th parameter of this method, see above $aCurlOptions // Default options, can be overloaded/extended with the 4th parameter of this method, see above $aCurlOptions
$aOptions = array( $aOptions = [
CURLOPT_RETURNTRANSFER => true, // return the content of the request CURLOPT_RETURNTRANSFER => true, // return the content of the request
CURLOPT_HEADER => false, // don't return the headers in the output CURLOPT_HEADER => false, // don't return the headers in the output
CURLOPT_FOLLOWLOCATION => true, // follow redirects CURLOPT_FOLLOWLOCATION => true, // follow redirects
@@ -1960,7 +1876,7 @@ SQL;
CURLOPT_POST => count($aData), CURLOPT_POST => count($aData),
CURLOPT_POSTFIELDS => http_build_query($aData), CURLOPT_POSTFIELDS => http_build_query($aData),
CURLOPT_HTTPHEADER => $aHTTPHeaders, CURLOPT_HTTPHEADER => $aHTTPHeaders,
); ];
$aAllOptions = $aCurlOptions + $aOptions; $aAllOptions = $aCurlOptions + $aOptions;
$ch = curl_init($sUrl); $ch = curl_init($sUrl);
@@ -1990,19 +1906,19 @@ SQL;
* @param array $aAdditionalEncodings Additional values * @param array $aAdditionalEncodings Additional values
* @return array of iconv code => english label, sorted by label * @return array of iconv code => english label, sorted by label
*/ */
public static function GetPossibleEncodings($aAdditionalEncodings = array()) public static function GetPossibleEncodings($aAdditionalEncodings = [])
{ {
// Encodings supported: // Encodings supported:
// ICONV_CODE => Display Name // ICONV_CODE => Display Name
// Each iconv installation supports different encodings // Each iconv installation supports different encodings
// Some reasonably common and useful encodings are listed here // Some reasonably common and useful encodings are listed here
$aPossibleEncodings = array( $aPossibleEncodings = [
'UTF-8' => 'Unicode (UTF-8)', 'UTF-8' => 'Unicode (UTF-8)',
'ISO-8859-1' => 'Western (ISO-8859-1)', 'ISO-8859-1' => 'Western (ISO-8859-1)',
'WINDOWS-1251' => 'Cyrilic (Windows 1251)', 'WINDOWS-1251' => 'Cyrilic (Windows 1251)',
'WINDOWS-1252' => 'Western (Windows 1252)', 'WINDOWS-1252' => 'Western (Windows 1252)',
'ISO-8859-15' => 'Western (ISO-8859-15)', 'ISO-8859-15' => 'Western (ISO-8859-15)',
); ];
$aPossibleEncodings = array_merge($aPossibleEncodings, $aAdditionalEncodings); $aPossibleEncodings = array_merge($aPossibleEncodings, $aAdditionalEncodings);
asort($aPossibleEncodings); asort($aPossibleEncodings);
return $aPossibleEncodings; return $aPossibleEncodings;
@@ -2209,8 +2125,7 @@ SQL;
try { try {
//return '<?xml encoding="UTF-8">'.$sHtml; //return '<?xml encoding="UTF-8">'.$sHtml;
return Html2Text::convert('<?xml encoding="UTF-8">'.$sHtml, ['ignore_errors' => true]); return Html2Text::convert('<?xml encoding="UTF-8">'.$sHtml, ['ignore_errors' => true]);
} } catch (Exception $e) {
catch (Exception $e) {
return $e->getMessage(); return $e->getMessage();
} }
} }
@@ -2242,15 +2157,13 @@ SQL;
public static function GetCSSFromSASS($sSassRelPath, $aImportPaths = null) public static function GetCSSFromSASS($sSassRelPath, $aImportPaths = null)
{ {
// Avoiding compilation if file is already a css file. // Avoiding compilation if file is already a css file.
if (preg_match('/\.css(\?.*)?$/', $sSassRelPath)) if (preg_match('/\.css(\?.*)?$/', $sSassRelPath)) {
{
return $sSassRelPath; return $sSassRelPath;
} }
// Setting import paths // Setting import paths
if ($aImportPaths === null) if ($aImportPaths === null) {
{ $aImportPaths = [];
$aImportPaths = array();
} }
$aImportPaths[] = APPROOT.'/css'; $aImportPaths[] = APPROOT.'/css';
@@ -2258,8 +2171,7 @@ SQL;
$sCssRelPath = preg_replace('/\.scss$/', '.css', $sSassRelPath); $sCssRelPath = preg_replace('/\.scss$/', '.css', $sSassRelPath);
$sCssPath = APPROOT.$sCssRelPath; $sCssPath = APPROOT.$sCssRelPath;
clearstatcache(); clearstatcache();
if (!file_exists($sCssPath) || (is_writable($sCssPath) && (filemtime($sCssPath) < filemtime($sSassPath)))) if (!file_exists($sCssPath) || (is_writable($sCssPath) && (filemtime($sCssPath) < filemtime($sSassPath)))) {
{
$sCss = static::CompileCSSFromSASS(file_get_contents($sSassPath), $aImportPaths); $sCss = static::CompileCSSFromSASS(file_get_contents($sSassPath), $aImportPaths);
file_put_contents($sCssPath, $sCss); file_put_contents($sCssPath, $sCss);
} }
@@ -2277,7 +2189,7 @@ SQL;
* *
* @since 2.7.0 * @since 2.7.0
*/ */
public static function CompileCSSFromSASS($sSassContent, $aImportPaths = array(), $aVariables = array()) public static function CompileCSSFromSASS($sSassContent, $aImportPaths = [], $aVariables = [])
{ {
$oSass = new Compiler(); $oSass = new Compiler();
$oSass->setOutputStyle(OutputStyle::COMPRESSED); $oSass->setOutputStyle(OutputStyle::COMPRESSED);
@@ -2417,8 +2329,7 @@ SQL;
public static function IsURL($sPath) public static function IsURL($sPath)
{ {
$bRet = false; $bRet = false;
if ((substr($sPath, 0, 7) == 'http://') || (substr($sPath, 0, 8) == 'https://') || (substr($sPath, 0, 8) == 'ftp://')) if ((substr($sPath, 0, 7) == 'http://') || (substr($sPath, 0, 8) == 'https://') || (substr($sPath, 0, 8) == 'ftp://')) {
{
$bRet = true; $bRet = true;
} }
return $bRet; return $bRet;
@@ -2442,7 +2353,7 @@ SQL;
// extract the "query" part of the URL and analyze it // extract the "query" part of the URL and analyze it
$sQuery = parse_url($sPath, PHP_URL_QUERY); $sQuery = parse_url($sPath, PHP_URL_QUERY);
if ($sQuery !== null) { if ($sQuery !== null) {
$aParams = array(); $aParams = [];
foreach (explode('&', $sQuery) as $sChunk) { foreach (explode('&', $sQuery) as $sChunk) {
$aParts = explode('=', $sChunk ?? ''); $aParts = explode('=', $sChunk ?? '');
if (count($aParts) != 2) { if (count($aParts) != 2) {
@@ -2555,22 +2466,17 @@ TXT
protected static function ParseHeaders($aHeaders) protected static function ParseHeaders($aHeaders)
{ {
$aCleanHeaders = array(); $aCleanHeaders = [];
foreach( $aHeaders as $sKey => $sValue ) foreach ($aHeaders as $sKey => $sValue) {
{
$aTokens = explode(':', $sValue ?? '', 2); $aTokens = explode(':', $sValue ?? '', 2);
if(isset($aTokens[1])) if (isset($aTokens[1])) {
{
$aCleanHeaders[trim($aTokens[0])] = trim($aTokens[1]); $aCleanHeaders[trim($aTokens[0])] = trim($aTokens[1]);
} } else {
else
{
// The header is not in the form Header-Code: Value // The header is not in the form Header-Code: Value
$aCleanHeaders[] = $sValue; // Store the value as-is $aCleanHeaders[] = $sValue; // Store the value as-is
$aMatches = array(); $aMatches = [];
// Check if it's not the HTTP response code // Check if it's not the HTTP response code
if( preg_match("|HTTP/[0-9\.]+\s+([0-9]+)|", $sValue, $aMatches) ) if (preg_match("|HTTP/[0-9\.]+\s+([0-9]+)|", $sValue, $aMatches)) {
{
$aCleanHeaders['reponse_code'] = intval($aMatches[1]); $aCleanHeaders['reponse_code'] = intval($aMatches[1]);
} }
} }
@@ -2619,8 +2525,7 @@ TXT
*/ */
public static function IsHighCardinality($sClass) public static function IsHighCardinality($sClass)
{ {
if (utils::GetConfig()->Get('search_manual_submit')) if (utils::GetConfig()->Get('search_manual_submit')) {
{
return true; return true;
} }
$aHugeClasses = MetaModel::GetConfig()->Get('high_cardinality_classes'); $aHugeClasses = MetaModel::GetConfig()->Get('high_cardinality_classes');
@@ -2639,20 +2544,17 @@ TXT
*/ */
public static function GetFileMimeType($sFilePath, $sDefaultMimeType = 'application/octet-stream') public static function GetFileMimeType($sFilePath, $sDefaultMimeType = 'application/octet-stream')
{ {
if (!function_exists('finfo_file')) if (!function_exists('finfo_file')) {
{
return $sDefaultMimeType; return $sDefaultMimeType;
} }
$sMimeType = $sDefaultMimeType; $sMimeType = $sDefaultMimeType;
$rInfo = @finfo_open(FILEINFO_MIME_TYPE); $rInfo = @finfo_open(FILEINFO_MIME_TYPE);
if ($rInfo !== false) if ($rInfo !== false) {
{
$sType = @finfo_file($rInfo, $sFilePath); $sType = @finfo_file($rInfo, $sFilePath);
if (($sType !== false) if (($sType !== false)
&& is_string($sType) && is_string($sType)
&& ($sType !== '')) && ($sType !== '')) {
{
$sMimeType = $sType; $sMimeType = $sType;
} }
} }
@@ -2682,14 +2584,12 @@ TXT
final public static function RealPath($sPath, $sBasePath) final public static function RealPath($sPath, $sBasePath)
{ {
$sFileRealPath = realpath($sPath); $sFileRealPath = realpath($sPath);
if ($sFileRealPath === false) if ($sFileRealPath === false) {
{
return false; return false;
} }
$sRealBasePath = realpath($sBasePath); // avoid problems when having '/' on Windows for example $sRealBasePath = realpath($sBasePath); // avoid problems when having '/' on Windows for example
if (!self::StartsWith($sFileRealPath, $sRealBasePath)) if (!self::StartsWith($sFileRealPath, $sRealBasePath)) {
{
return false; return false;
} }
@@ -2710,8 +2610,7 @@ TXT
{ {
$sRootPath = realpath($sBasePath); $sRootPath = realpath($sBasePath);
$sFullPath = realpath($sAbsolutePath); $sFullPath = realpath($sAbsolutePath);
if (($sFullPath === false) || !self::StartsWith($sFullPath, $sRootPath)) if (($sFullPath === false) || !self::StartsWith($sFullPath, $sRootPath)) {
{
return false; return false;
} }
$sLocalPath = substr($sFullPath, strlen($sRootPath.DIRECTORY_SEPARATOR)); $sLocalPath = substr($sFullPath, strlen($sRootPath.DIRECTORY_SEPARATOR));
@@ -2730,8 +2629,7 @@ TXT
{ {
$sRootPath = realpath(APPROOT); $sRootPath = realpath(APPROOT);
$sFullPath = realpath($sRootPath.DIRECTORY_SEPARATOR.$sPath); $sFullPath = realpath($sRootPath.DIRECTORY_SEPARATOR.$sPath);
if (($sFullPath === false) || !self::StartsWith($sFullPath, $sRootPath)) if (($sFullPath === false) || !self::StartsWith($sFullPath, $sRootPath)) {
{
return false; return false;
} }
return $sFullPath; return $sFullPath;
@@ -2744,8 +2642,7 @@ TXT
public static function GetCurrentUserName() public static function GetCurrentUserName()
{ {
if (function_exists('posix_getpwuid')) if (function_exists('posix_getpwuid')) {
{
return posix_getpwuid(posix_geteuid())['name']; return posix_getpwuid(posix_geteuid())['name'];
} }
@@ -2767,8 +2664,7 @@ TXT
public static function EnrichRaisedException($oCmdbAbstract, $oException) public static function EnrichRaisedException($oCmdbAbstract, $oException)
{ {
if (is_null($oCmdbAbstract) || if (is_null($oCmdbAbstract) ||
! is_a($oCmdbAbstract, \cmdbAbstractObject::class)) ! is_a($oCmdbAbstract, \cmdbAbstractObject::class)) {
{
throw $oException; throw $oException;
} }
@@ -3119,7 +3015,7 @@ TXT
// Prepare array for matched class if not already present // Prepare array for matched class if not already present
if (!array_key_exists($sMatchedClass, $aMentionedObjects)) { if (!array_key_exists($sMatchedClass, $aMentionedObjects)) {
$aMentionedObjects[$sMatchedClass] = array(); $aMentionedObjects[$sMatchedClass] = [];
} }
// Add matched ID if not already there // Add matched ID if not already there
if (!in_array($sMatchedId, $aMentionedObjects[$sMatchedClass])) { if (!in_array($sMatchedId, $aMentionedObjects[$sMatchedClass])) {

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* Class WizardHelper * Class WizardHelper
* *
@@ -42,23 +42,17 @@ class WizardHelper
*/ */
public function GetTargetObject($bReadUploadedFiles = false) public function GetTargetObject($bReadUploadedFiles = false)
{ {
if (isset($this->m_aData['m_oCurrentValues']['id'])) if (isset($this->m_aData['m_oCurrentValues']['id'])) {
{
$oObj = MetaModel::GetObject($this->m_aData['m_sClass'], $this->m_aData['m_oCurrentValues']['id']); $oObj = MetaModel::GetObject($this->m_aData['m_sClass'], $this->m_aData['m_oCurrentValues']['id']);
} } else {
else
{
$oObj = MetaModel::NewObject($this->m_aData['m_sClass']); $oObj = MetaModel::NewObject($this->m_aData['m_sClass']);
} }
foreach($this->m_aData['m_oCurrentValues'] as $sAttCode => $value) foreach ($this->m_aData['m_oCurrentValues'] as $sAttCode => $value) {
{
// Because this is stored in a Javascript array, unused indexes // Because this is stored in a Javascript array, unused indexes
// are filled with null values and unused keys (stored as strings) contain $$NULL$$ // are filled with null values and unused keys (stored as strings) contain $$NULL$$
if ( ($sAttCode !='id') && ($value !== '$$NULL$$')) if (($sAttCode != 'id') && ($value !== '$$NULL$$')) {
{
$oAttDef = MetaModel::GetAttributeDef($this->m_aData['m_sClass'], $sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_aData['m_sClass'], $sAttCode);
if (($oAttDef->IsLinkSet()) && ($value != '') ) if (($oAttDef->IsLinkSet()) && ($value != '')) {
{
// special handling for lists // special handling for lists
// assumes this is handled as an array of objects // assumes this is handled as an array of objects
// thus encoded in json like: [ { name:'link1', 'id': 123}, { name:'link2', 'id': 124}...] // thus encoded in json like: [ { name:'link1', 'id': 123}, { name:'link2', 'id': 124}...]
@@ -71,47 +65,35 @@ class WizardHelper
// Check what are the meaningful attributes // Check what are the meaningful attributes
$aFields = $this->GetLinkedWizardStructure($oAttDef); $aFields = $this->GetLinkedWizardStructure($oAttDef);
$sLinkedClass = $oAttDef->GetLinkedClass(); $sLinkedClass = $oAttDef->GetLinkedClass();
$aLinkedObjectsArray = array(); $aLinkedObjectsArray = [];
if (!is_array($aData)) { if (!is_array($aData)) {
echo("aData: '$aData' (value: '$value')\n"); echo("aData: '$aData' (value: '$value')\n");
} }
foreach ($aData as $aLinkedObject) foreach ($aData as $aLinkedObject) {
{
$oLinkedObj = MetaModel::NewObject($sLinkedClass); $oLinkedObj = MetaModel::NewObject($sLinkedClass);
foreach($aFields as $sLinkedAttCode) foreach ($aFields as $sLinkedAttCode) {
{ if (isset($aLinkedObject[$sLinkedAttCode]) && ($aLinkedObject[$sLinkedAttCode] !== null)) {
if ( isset($aLinkedObject[$sLinkedAttCode]) && ($aLinkedObject[$sLinkedAttCode] !== null) )
{
$sLinkedAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sLinkedAttCode); $sLinkedAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sLinkedAttCode);
if (($sLinkedAttDef->IsExternalKey()) && ($aLinkedObject[$sLinkedAttCode] != '') && ($aLinkedObject[$sLinkedAttCode] > 0) ) if (($sLinkedAttDef->IsExternalKey()) && ($aLinkedObject[$sLinkedAttCode] != '') && ($aLinkedObject[$sLinkedAttCode] > 0)) {
{
// For external keys: load the target object so that external fields // For external keys: load the target object so that external fields
// get filled too // get filled too
$oTargetObj = MetaModel::GetObject($sLinkedAttDef->GetTargetClass(), $aLinkedObject[$sLinkedAttCode]); $oTargetObj = MetaModel::GetObject($sLinkedAttDef->GetTargetClass(), $aLinkedObject[$sLinkedAttCode]);
$oLinkedObj->Set($sLinkedAttCode, $oTargetObj); $oLinkedObj->Set($sLinkedAttCode, $oTargetObj);
} } elseif ($sLinkedAttDef instanceof AttributeDateTime) {
elseif($sLinkedAttDef instanceof AttributeDateTime)
{
$sDateClass = get_class($sLinkedAttDef); $sDateClass = get_class($sLinkedAttDef);
$sDate = $aLinkedObject[$sLinkedAttCode]; $sDate = $aLinkedObject[$sLinkedAttCode];
if($sDate !== null && $sDate !== '') if ($sDate !== null && $sDate !== '') {
{
$oDateTimeFormat = $sDateClass::GetFormat(); $oDateTimeFormat = $sDateClass::GetFormat();
$oDate = $oDateTimeFormat->Parse($sDate); $oDate = $oDateTimeFormat->Parse($sDate);
if ($sDateClass == "AttributeDate") if ($sDateClass == "AttributeDate") {
{
$sDate = $oDate->format('Y-m-d'); $sDate = $oDate->format('Y-m-d');
} } else {
else
{
$sDate = $oDate->format('Y-m-d H:i:s'); $sDate = $oDate->format('Y-m-d H:i:s');
} }
} }
$oLinkedObj->Set($sLinkedAttCode, $sDate); $oLinkedObj->Set($sLinkedAttCode, $sDate);
} } else {
else
{
$oLinkedObj->Set($sLinkedAttCode, $aLinkedObject[$sLinkedAttCode]); $oLinkedObj->Set($sLinkedAttCode, $aLinkedObject[$sLinkedAttCode]);
} }
} }
@@ -120,98 +102,67 @@ class WizardHelper
} }
$oSet = DBObjectSet::FromArray($sLinkedClass, $aLinkedObjectsArray); $oSet = DBObjectSet::FromArray($sLinkedClass, $aLinkedObjectsArray);
$oObj->Set($sAttCode, $oSet); $oObj->Set($sAttCode, $oSet);
} } elseif ($oAttDef->GetEditClass() == 'Document') {
else if ( $oAttDef->GetEditClass() == 'Document' ) if ($bReadUploadedFiles) {
{
if ($bReadUploadedFiles)
{
$oDocument = utils::ReadPostedDocument('attr_'.$sAttCode, 'fcontents'); $oDocument = utils::ReadPostedDocument('attr_'.$sAttCode, 'fcontents');
$oObj->Set($sAttCode, $oDocument); $oObj->Set($sAttCode, $oDocument);
} } else {
else
{
// Create a new empty document, just for displaying the file name // Create a new empty document, just for displaying the file name
$oDocument = new ormDocument(null, '', $value); $oDocument = new ormDocument(null, '', $value);
$oObj->Set($sAttCode, $oDocument); $oObj->Set($sAttCode, $oDocument);
} }
} } elseif ($oAttDef->GetEditClass() == 'Image') {
else if ( $oAttDef->GetEditClass() == 'Image' ) if ($bReadUploadedFiles) {
{
if ($bReadUploadedFiles)
{
$oDocument = utils::ReadPostedDocument('attr_'.$sAttCode, 'fcontents'); $oDocument = utils::ReadPostedDocument('attr_'.$sAttCode, 'fcontents');
$oObj->Set($sAttCode, $oDocument); $oObj->Set($sAttCode, $oDocument);
} } else {
else
{
// Create a new empty document, just for displaying the file name // Create a new empty document, just for displaying the file name
$oDocument = new ormDocument(null, '', $value); $oDocument = new ormDocument(null, '', $value);
$oObj->Set($sAttCode, $oDocument); $oObj->Set($sAttCode, $oDocument);
} }
} } elseif (($oAttDef->IsExternalKey()) && (!empty($value)) && ($value > 0)) {
else if (($oAttDef->IsExternalKey()) && (!empty($value)) && ($value > 0) )
{
// For external keys: load the target object so that external fields // For external keys: load the target object so that external fields
// get filled too // get filled too
$oTargetObj = MetaModel::GetObject($oAttDef->GetTargetClass(), $value, false); $oTargetObj = MetaModel::GetObject($oAttDef->GetTargetClass(), $value, false);
if ($oTargetObj) if ($oTargetObj) {
{
$oObj->Set($sAttCode, $oTargetObj); $oObj->Set($sAttCode, $oTargetObj);
} } else {
else
{
// May happen for security reasons (portal, see ticket N°1074) // May happen for security reasons (portal, see ticket N°1074)
$oObj->Set($sAttCode, $value); $oObj->Set($sAttCode, $value);
} }
} } elseif ($oAttDef instanceof AttributeDateTime) { // AttributeDate is derived from AttributeDateTime
else if ($oAttDef instanceof AttributeDateTime) // AttributeDate is derived from AttributeDateTime if ($value != null) {
{
if ($value != null)
{
$oDate = $oAttDef->GetFormat()->Parse($value); $oDate = $oAttDef->GetFormat()->Parse($value);
if ($oDate instanceof DateTime) if ($oDate instanceof DateTime) {
{
$value = $oDate->format($oAttDef->GetInternalFormat()); $value = $oDate->format($oAttDef->GetInternalFormat());
} } else {
else
{
$value = null; $value = null;
} }
} }
$oObj->Set($sAttCode, $value); $oObj->Set($sAttCode, $value);
} } elseif ($oAttDef instanceof AttributeTagSet) { // AttributeDate is derived from AttributeDateTime
else if ($oAttDef instanceof AttributeTagSet) // AttributeDate is derived from AttributeDateTime if (is_null($value)) {
{
if (is_null($value))
{
// happens if field is hidden (see N°1827) // happens if field is hidden (see N°1827)
$value = array(); $value = [];
} } else {
else
{
$value = json_decode($value, true); $value = json_decode($value, true);
} }
$oTagSet = new ormTagSet(get_class($oObj), $sAttCode, $oAttDef->GetMaxItems()); $oTagSet = new ormTagSet(get_class($oObj), $sAttCode, $oAttDef->GetMaxItems());
$oTagSet->SetValues($value['orig_value']); $oTagSet->SetValues($value['orig_value']);
$oTagSet->ApplyDelta($value); $oTagSet->ApplyDelta($value);
$oObj->Set($sAttCode, $oTagSet); $oObj->Set($sAttCode, $oTagSet);
} } elseif ($oAttDef instanceof AttributeSet) { // AttributeDate is derived from AttributeDateTime
else if ($oAttDef instanceof AttributeSet) // AttributeDate is derived from AttributeDateTime
{
$value = json_decode($value, true); $value = json_decode($value, true);
$oTagSet = new ormSet(get_class($oObj), $sAttCode, $oAttDef->GetMaxItems()); $oTagSet = new ormSet(get_class($oObj), $sAttCode, $oAttDef->GetMaxItems());
$oTagSet->SetValues($value['orig_value']); $oTagSet->SetValues($value['orig_value']);
$oTagSet->ApplyDelta($value); $oTagSet->ApplyDelta($value);
$oObj->Set($sAttCode, $oTagSet); $oObj->Set($sAttCode, $oTagSet);
} } else {
else
{
$oObj->Set($sAttCode, $value); $oObj->Set($sAttCode, $value);
} }
} }
} }
if (isset($this->m_aData['m_sState']) && !empty($this->m_aData['m_sState'])) if (isset($this->m_aData['m_sState']) && !empty($this->m_aData['m_sState'])) {
{
$oObj->Set(MetaModel::GetStateAttributeCode($this->m_aData['m_sClass']), $this->m_aData['m_sState']); $oObj->Set(MetaModel::GetStateAttributeCode($this->m_aData['m_sClass']), $this->m_aData['m_sState']);
} }
$oObj->DoComputeValues(); $oObj->DoComputeValues();
@@ -226,31 +177,25 @@ class WizardHelper
public function SetDefaultValue($sAttCode, $value) public function SetDefaultValue($sAttCode, $value)
{ {
// Protect against a request for a non existing field // Protect against a request for a non existing field
if (isset($this->m_aData['m_oFieldsMap'][$sAttCode])) if (isset($this->m_aData['m_oFieldsMap'][$sAttCode])) {
{
$oAttDef = MetaModel::GetAttributeDef($this->m_aData['m_sClass'], $sAttCode); $oAttDef = MetaModel::GetAttributeDef($this->m_aData['m_sClass'], $sAttCode);
if ($oAttDef->GetEditClass() == 'List') if ($oAttDef->GetEditClass() == 'List') {
{
// special handling for lists // special handling for lists
// this as to be handled as an array of objects // this as to be handled as an array of objects
// thus encoded in json like: [ { name:'link1', 'id': 123}, { name:'link2', 'id': 124}...] // thus encoded in json like: [ { name:'link1', 'id': 123}, { name:'link2', 'id': 124}...]
// NOT YET IMPLEMENTED !! // NOT YET IMPLEMENTED !!
$oSet = $value; $oSet = $value;
$aData = array(); $aData = [];
$aFields = $this->GetLinkedWizardStructure($oAttDef); $aFields = $this->GetLinkedWizardStructure($oAttDef);
while($oLinkedObj = $oSet->fetch()) while ($oLinkedObj = $oSet->fetch()) {
{ foreach ($aFields as $sLinkedAttCode) {
foreach($aFields as $sLinkedAttCode)
{
$aRow[$sAttCode] = $oLinkedObj->Get($sLinkedAttCode); $aRow[$sAttCode] = $oLinkedObj->Get($sLinkedAttCode);
} }
$aData[] = $aRow; $aData[] = $aRow;
} }
$this->m_aData['m_oDefaultValue'][$sAttCode] = json_encode($aData); $this->m_aData['m_oDefaultValue'][$sAttCode] = json_encode($aData);
} } else {
else
{
// Normal handling for all other scalar attributes // Normal handling for all other scalar attributes
$this->m_aData['m_oDefaultValue'][$sAttCode] = $value; $this->m_aData['m_oDefaultValue'][$sAttCode] = $value;
} }
@@ -265,8 +210,7 @@ class WizardHelper
public function SetAllowedValuesHtml($sAttCode, $sHtml) public function SetAllowedValuesHtml($sAttCode, $sHtml)
{ {
// Protect against a request for a non existing field // Protect against a request for a non existing field
if (isset($this->m_aData['m_oFieldsMap'][$sAttCode])) if (isset($this->m_aData['m_oFieldsMap'][$sAttCode])) {
{
$this->m_aData['m_oAllowedValues'][$sAttCode] = $sHtml; $this->m_aData['m_oAllowedValues'][$sAttCode] = $sHtml;
} }
} }
@@ -276,7 +220,7 @@ class WizardHelper
return json_encode($this->m_aData); return json_encode($this->m_aData);
} }
static public function FromJSON($sJSON) public static function FromJSON($sJSON)
{ {
$oWizHelper = new WizardHelper(); $oWizHelper = new WizardHelper();
$aData = json_decode($sJSON, true); // true means hash array instead of object $aData = json_decode($sJSON, true); // true means hash array instead of object
@@ -288,21 +232,17 @@ class WizardHelper
{ {
$oWizard = new UIWizard(null, $oAttDef->GetLinkedClass()); $oWizard = new UIWizard(null, $oAttDef->GetLinkedClass());
$aWizardSteps = $oWizard->GetWizardStructure(); $aWizardSteps = $oWizard->GetWizardStructure();
$aFields = array(); $aFields = [];
$sExtKeyToMeCode = $oAttDef->GetExtKeyToMe(); $sExtKeyToMeCode = $oAttDef->GetExtKeyToMe();
// Retrieve as a flat list, all the attributes that are needed to create // Retrieve as a flat list, all the attributes that are needed to create
// an object of the linked class and put them into a flat array, except // an object of the linked class and put them into a flat array, except
// the attribute 'ext_key_to_me' which is a constant in our case // the attribute 'ext_key_to_me' which is a constant in our case
foreach($aWizardSteps as $sDummy => $aMainSteps) foreach ($aWizardSteps as $sDummy => $aMainSteps) {
{
// 2 entries: 'mandatory' and 'optional' // 2 entries: 'mandatory' and 'optional'
foreach($aMainSteps as $aSteps) foreach ($aMainSteps as $aSteps) {
{
// One entry for each step of the wizard // One entry for each step of the wizard
foreach($aSteps as $sAttCode) foreach ($aSteps as $sAttCode) {
{ if ($sAttCode != $sExtKeyToMeCode) {
if ($sAttCode != $sExtKeyToMeCode)
{
$aFields[] = $sAttCode; $aFields[] = $sAttCode;
} }
} }
@@ -337,8 +277,7 @@ class WizardHelper
// It may happen that the field we'd like to update does not // It may happen that the field we'd like to update does not
// exist in the form. For example, if the field should be hidden/read-only // exist in the form. For example, if the field should be hidden/read-only
// in the current state of the object // in the current state of the object
if (isset($this->m_aData['m_oFieldsMap'][$sFieldName])) if (isset($this->m_aData['m_oFieldsMap'][$sFieldName])) {
{
$sResult = $this->m_aData['m_oFieldsMap'][$sFieldName]; $sResult = $this->m_aData['m_oFieldsMap'][$sFieldName];
} }
@@ -362,12 +301,14 @@ class WizardHelper
$sWizardHelperJsVar = (!is_null($this->m_aData['m_sWizHelperJsVarName'])) ? utils::Sanitize($this->m_aData['m_sWizHelperJsVarName'], '', utils::ENUM_SANITIZATION_FILTER_PARAMETER) : 'oWizardHelper'.$this->GetFormPrefix(); $sWizardHelperJsVar = (!is_null($this->m_aData['m_sWizHelperJsVarName'])) ? utils::Sanitize($this->m_aData['m_sWizHelperJsVarName'], '', utils::ENUM_SANITIZATION_FILTER_PARAMETER) : 'oWizardHelper'.$this->GetFormPrefix();
$sWizardHelperJson = $this->ToJSON(); $sWizardHelperJson = $this->ToJSON();
$oPage->add_script(<<<JS $oPage->add_script(
<<<JS
{$sWizardHelperJsVar}.m_oData = {$sWizardHelperJson}; {$sWizardHelperJsVar}.m_oData = {$sWizardHelperJson};
{$sWizardHelperJsVar}.UpdateFields(); {$sWizardHelperJsVar}.UpdateFields();
JS JS
); );
$oPage->add_ready_script(<<<JS $oPage->add_ready_script(
<<<JS
if ({$sWizardHelperJsVar}.m_oDependenciesUpdatedPromiseResolve !== null){ if ({$sWizardHelperJsVar}.m_oDependenciesUpdatedPromiseResolve !== null){
{$sWizardHelperJsVar}.m_oDependenciesUpdatedPromiseResolve(); {$sWizardHelperJsVar}.m_oDependenciesUpdatedPromiseResolve();
} }

View File

@@ -1,23 +1,31 @@
<?php <?php
/* @author Mark Jones /* @author Mark Jones
* @license MIT License * @license MIT License
* */ * */
if (!class_exists('ZipArchive')) { throw new Exception('ZipArchive not found'); } if (!class_exists('ZipArchive')) {
throw new Exception('ZipArchive not found');
}
Class XLSXWriter class XLSXWriter
{ {
//------------------------------------------------------------------ //------------------------------------------------------------------
protected $author = 'Doc Author'; protected $author = 'Doc Author';
protected $sheets_meta = array(); protected $sheets_meta = [];
protected $shared_strings = array();//unique set protected $shared_strings = [];//unique set
protected $shared_string_count = 0;//count of non-unique references to the unique set protected $shared_string_count = 0;//count of non-unique references to the unique set
protected $temp_files = array(); protected $temp_files = [];
protected $date_format = 'YYYY-MM-DD'; protected $date_format = 'YYYY-MM-DD';
protected $date_time_format = 'YYYY-MM-DD\ HH:MM:SS'; protected $date_time_format = 'YYYY-MM-DD\ HH:MM:SS';
public function __construct(){} public function __construct()
public function setAuthor($author='') { $this->author=$author; } {
}
public function setAuthor($author = '')
{
$this->author = $author;
}
public function __destruct() public function __destruct()
{ {
@@ -64,8 +72,14 @@ Class XLSXWriter
{ {
@unlink($filename);//if the zip already exists, overwrite it @unlink($filename);//if the zip already exists, overwrite it
$zip = new ZipArchive(); $zip = new ZipArchive();
if (empty($this->sheets_meta)) { self::log("Error in ".__CLASS__."::".__FUNCTION__.", no worksheets defined."); return; } if (empty($this->sheets_meta)) {
if (!$zip->open($filename, ZipArchive::CREATE)) { self::log("Error in ".__CLASS__."::".__FUNCTION__.", unable to create zip."); return; } self::log("Error in ".__CLASS__."::".__FUNCTION__.", no worksheets defined.");
return;
}
if (!$zip->open($filename, ZipArchive::CREATE)) {
self::log("Error in ".__CLASS__."::".__FUNCTION__.", unable to create zip.");
return;
}
$zip->addEmptyDir("docProps/"); $zip->addEmptyDir("docProps/");
$zip->addFromString("docProps/app.xml", self::buildAppXML()); $zip->addFromString("docProps/app.xml", self::buildAppXML());
@@ -90,15 +104,14 @@ Class XLSXWriter
$zip->close(); $zip->close();
} }
public function writeSheet(array $data, $sheet_name = '', array $header_types = [], array $header_row = [])
public function writeSheet(array $data, $sheet_name='', array $header_types=array(), array $header_row=array() )
{ {
$data = empty($data) ? array( array('') ) : $data; $data = empty($data) ? [ [''] ] : $data;
$sheet_filename = $this->tempFilename(); $sheet_filename = $this->tempFilename();
$sheet_default = 'Sheet'.(count($this->sheets_meta) + 1); $sheet_default = 'Sheet'.(count($this->sheets_meta) + 1);
$sheet_name = !empty($sheet_name) ? $sheet_name : $sheet_default; $sheet_name = !empty($sheet_name) ? $sheet_name : $sheet_default;
$this->sheets_meta[] = array('filename'=>$sheet_filename, 'sheetname'=>$sheet_name ,'xmlname'=>strtolower($sheet_default).".xml" ); $this->sheets_meta[] = ['filename' => $sheet_filename, 'sheetname' => $sheet_name ,'xmlname' => strtolower($sheet_default).".xml" ];
$header_offset = empty($header_types) ? 0 : 1; $header_offset = empty($header_types) ? 0 : 1;
$row_count = count($data) + $header_offset; $row_count = count($data) + $header_offset;
@@ -107,13 +120,15 @@ Class XLSXWriter
$tabselected = count($this->sheets_meta) == 1 ? 'true' : 'false';//only first sheet is selected $tabselected = count($this->sheets_meta) == 1 ? 'true' : 'false';//only first sheet is selected
$cell_formats_arr = empty($header_types) ? array_fill(0, $column_count, 'string') : array_values($header_types); $cell_formats_arr = empty($header_types) ? array_fill(0, $column_count, 'string') : array_values($header_types);
if (empty($header_row) && !empty($header_types)) if (empty($header_row) && !empty($header_types)) {
{ $header_row = empty($header_types) ? [] : array_keys($header_types);
$header_row = empty($header_types) ? array() : array_keys($header_types);
} }
$fd = fopen($sheet_filename, "w+"); $fd = fopen($sheet_filename, "w+");
if ($fd===false) { self::log("write failed in ".__CLASS__."::".__FUNCTION__."."); return; } if ($fd === false) {
self::log("write failed in ".__CLASS__."::".__FUNCTION__.".");
return;
}
fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n"); fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n");
fwrite($fd, '<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">'); fwrite($fd, '<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">');
@@ -130,20 +145,16 @@ Class XLSXWriter
fwrite($fd, '<col collapsed="false" hidden="false" max="1025" min="1" style="0" width="19"/>'); fwrite($fd, '<col collapsed="false" hidden="false" max="1025" min="1" style="0" width="19"/>');
fwrite($fd, '</cols>'); fwrite($fd, '</cols>');
fwrite($fd, '<sheetData>'); fwrite($fd, '<sheetData>');
if (!empty($header_row)) if (!empty($header_row)) {
{
fwrite($fd, '<row collapsed="false" customFormat="false" customHeight="false" hidden="false" ht="12.1" outlineLevel="0" r="'.(1).'">'); fwrite($fd, '<row collapsed="false" customFormat="false" customHeight="false" hidden="false" ht="12.1" outlineLevel="0" r="'.(1).'">');
foreach($header_row as $k=>$v) foreach ($header_row as $k => $v) {
{
$this->writeCell($fd, 0, $k, $v, $cell_format = 'string'); $this->writeCell($fd, 0, $k, $v, $cell_format = 'string');
} }
fwrite($fd, '</row>'); fwrite($fd, '</row>');
} }
foreach($data as $i=>$row) foreach ($data as $i => $row) {
{
fwrite($fd, '<row collapsed="false" customFormat="false" customHeight="false" hidden="false" ht="12.1" outlineLevel="0" r="'.($i + $header_offset + 1).'">'); fwrite($fd, '<row collapsed="false" customFormat="false" customHeight="false" hidden="false" ht="12.1" outlineLevel="0" r="'.($i + $header_offset + 1).'">');
foreach($row as $k=>$v) foreach ($row as $k => $v) {
{
$this->writeCell($fd, $i + $header_offset, $k, $v, $cell_formats_arr[$k]); $this->writeCell($fd, $i + $header_offset, $k, $v, $cell_formats_arr[$k]);
} }
fwrite($fd, '</row>'); fwrite($fd, '</row>');
@@ -162,7 +173,7 @@ Class XLSXWriter
protected function writeCell($fd, $row_number, $column_number, $value, $cell_format) protected function writeCell($fd, $row_number, $column_number, $value, $cell_format)
{ {
static $styles = array('money'=>1,'dollar'=>1,'datetime'=>2,'date'=>3,'string'=>0); static $styles = ['money' => 1,'dollar' => 1,'datetime' => 2,'date' => 3,'string' => 0];
$cell = self::xlsCell($row_number, $column_number); $cell = self::xlsCell($row_number, $column_number);
$s = isset($styles[$cell_format]) && ($value !== '') ? $styles[$cell_format] : '0'; $s = isset($styles[$cell_format]) && ($value !== '') ? $styles[$cell_format] : '0';
@@ -185,7 +196,10 @@ Class XLSXWriter
{ {
$tempfile = $this->tempFilename(); $tempfile = $this->tempFilename();
$fd = fopen($tempfile, "w+"); $fd = fopen($tempfile, "w+");
if ($fd===false) { self::log("write failed in ".__CLASS__."::".__FUNCTION__."."); return; } if ($fd === false) {
self::log("write failed in ".__CLASS__."::".__FUNCTION__.".");
return;
}
fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n"); fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n");
fwrite($fd, '<styleSheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">'); fwrite($fd, '<styleSheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">');
fwrite($fd, '<numFmts count="4">'); fwrite($fd, '<numFmts count="4">');
@@ -250,12 +264,9 @@ Class XLSXWriter
{ {
// Strip control characters which Excel does not seem to like... // Strip control characters which Excel does not seem to like...
$v = preg_replace('/[\x00-\x09\x0B\x0C\x0E-\x1F]/u', '', $v); $v = preg_replace('/[\x00-\x09\x0B\x0C\x0E-\x1F]/u', '', $v);
if (isset($this->shared_strings[$v])) if (isset($this->shared_strings[$v])) {
{
$string_value = $this->shared_strings[$v]; $string_value = $this->shared_strings[$v];
} } else {
else
{
$string_value = count($this->shared_strings); $string_value = count($this->shared_strings);
$this->shared_strings[$v] = $string_value; $this->shared_strings[$v] = $string_value;
} }
@@ -267,12 +278,14 @@ Class XLSXWriter
{ {
$tempfile = $this->tempFilename(); $tempfile = $this->tempFilename();
$fd = fopen($tempfile, "w+"); $fd = fopen($tempfile, "w+");
if ($fd===false) { self::log("write failed in ".__CLASS__."::".__FUNCTION__."."); return; } if ($fd === false) {
self::log("write failed in ".__CLASS__."::".__FUNCTION__.".");
return;
}
fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n"); fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n");
fwrite($fd, '<sst count="'.($this->shared_string_count).'" uniqueCount="'.count($this->shared_strings).'" xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">'); fwrite($fd, '<sst count="'.($this->shared_string_count).'" uniqueCount="'.count($this->shared_strings).'" xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">');
foreach($this->shared_strings as $s=>$c) foreach ($this->shared_strings as $s => $c) {
{
fwrite($fd, '<si><t>'.self::xmlspecialchars($s).'</t></si>'); fwrite($fd, '<si><t>'.self::xmlspecialchars($s).'</t></si>');
} }
fwrite($fd, '</sst>'); fwrite($fd, '</sst>');
@@ -408,12 +421,10 @@ Class XLSXWriter
$hour = $min = $sec = 0; $hour = $min = $sec = 0;
$date_time = $date_input; $date_time = $date_input;
if (preg_match("/(\d{4})\-(\d{2})\-(\d{2})/", $date_time, $matches)) if (preg_match("/(\d{4})\-(\d{2})\-(\d{2})/", $date_time, $matches)) {
{
list($junk, $year, $month, $day) = $matches; list($junk, $year, $month, $day) = $matches;
} }
if (preg_match("/(\d{2}):(\d{2}):(\d{2})/", $date_time, $matches)) if (preg_match("/(\d{2}):(\d{2}):(\d{2})/", $date_time, $matches)) {
{
list($junk, $hour, $min, $sec) = $matches; list($junk, $hour, $min, $sec) = $matches;
$seconds = ($hour * 60 * 60 + $min * 60 + $sec) / (24 * 60 * 60); $seconds = ($hour * 60 * 60 + $min * 60 + $sec) / (24 * 60 * 60);
} }
@@ -421,9 +432,15 @@ Class XLSXWriter
//using 1900 as epoch, not 1904, ignoring 1904 special case //using 1900 as epoch, not 1904, ignoring 1904 special case
# Special cases for Excel. # Special cases for Excel.
if ("$year-$month-$day"=='1899-12-31') return $seconds ; # Excel 1900 epoch if ("$year-$month-$day" == '1899-12-31') {
if ("$year-$month-$day"=='1900-01-00') return $seconds ; # Excel 1900 epoch return $seconds ;
if ("$year-$month-$day"=='1900-02-29') return 60 + $seconds ; # Excel false leapday } # Excel 1900 epoch
if ("$year-$month-$day" == '1900-01-00') {
return $seconds ;
} # Excel 1900 epoch
if ("$year-$month-$day" == '1900-02-29') {
return 60 + $seconds ;
} # Excel false leapday
# We calculate the date by calculating the number of days since the epoch # We calculate the date by calculating the number of days since the epoch
# and adjust for the number of leap days. We calculate the number of leap # and adjust for the number of leap days. We calculate the number of leap
@@ -436,12 +453,18 @@ Class XLSXWriter
# Set month days and check for leap year. # Set month days and check for leap year.
$leap = (($year % 400 == 0) || (($year % 4 == 0) && ($year % 100))) ? 1 : 0; $leap = (($year % 400 == 0) || (($year % 4 == 0) && ($year % 100))) ? 1 : 0;
$mdays = array( 31, ($leap ? 29 : 28), 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ); $mdays = [ 31, ($leap ? 29 : 28), 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ];
# Some boundary checks # Some boundary checks
if($year < $epoch || $year > 9999) return 0; if ($year < $epoch || $year > 9999) {
if($month < 1 || $month > 12) return 0; return 0;
if($day < 1 || $day > $mdays[ $month - 1 ]) return 0; }
if ($month < 1 || $month > 12) {
return 0;
}
if ($day < 1 || $day > $mdays[ $month - 1 ]) {
return 0;
}
# Accumulate the number of days since the epoch. # Accumulate the number of days since the epoch.
$days = $day; # Add days for current month $days = $day; # Add days for current month
@@ -453,15 +476,11 @@ Class XLSXWriter
$days -= $leap; # Already counted above $days -= $leap; # Already counted above
# Adjust for Excel erroneously treating 1900 as a leap year. # Adjust for Excel erroneously treating 1900 as a leap year.
if ($days > 59) { $days++;} if ($days > 59) {
$days++;
}
return $days + $seconds; return $days + $seconds;
} }
//------------------------------------------------------------------ //------------------------------------------------------------------
} }

View File

@@ -18,7 +18,6 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
*/ */
/** /**
* Checks PHP version * Checks PHP version
* *
@@ -39,7 +38,6 @@ if (PHP_MAJOR_VERSION >= 7) {
exit(-1); exit(-1);
} }
define('ITOP_DEFAULT_ENV', 'production'); define('ITOP_DEFAULT_ENV', 'production');
define('MAINTENANCE_MODE_FILE', APPROOT.'data/.maintenance'); define('MAINTENANCE_MODE_FILE', APPROOT.'data/.maintenance');
define('READONLY_MODE_FILE', APPROOT.'data/.readonly'); define('READONLY_MODE_FILE', APPROOT.'data/.readonly');
@@ -60,8 +58,7 @@ if (!isset($bBypassMaintenance)) {
$bBypassMaintenance = isset($_REQUEST['maintenance']) ? boolval($_REQUEST['maintenance']) : false; $bBypassMaintenance = isset($_REQUEST['maintenance']) ? boolval($_REQUEST['maintenance']) : false;
} }
if (file_exists(MAINTENANCE_MODE_FILE) && !$bBypassMaintenance) if (file_exists(MAINTENANCE_MODE_FILE) && !$bBypassMaintenance) {
{
$sTitle = 'Maintenance'; $sTitle = 'Maintenance';
$sMessage = 'This application is currently under maintenance.'; $sMessage = 'This application is currently under maintenance.';
@@ -70,8 +67,7 @@ if (file_exists(MAINTENANCE_MODE_FILE) && !$bBypassMaintenance)
include(APPROOT.'application/maintenancemsg.php'); include(APPROOT.'application/maintenancemsg.php');
$sSAPIName = strtoupper(trim(PHP_SAPI)); $sSAPIName = strtoupper(trim(PHP_SAPI));
switch (true) switch (true) {
{
case isset($_SERVER['REQUEST_URI']) && EndsWith($_SERVER['REQUEST_URI'], '/pages/ajax.searchform.php'): case isset($_SERVER['REQUEST_URI']) && EndsWith($_SERVER['REQUEST_URI'], '/pages/ajax.searchform.php'):
_MaintenanceHtmlMessage($sMessage); _MaintenanceHtmlMessage($sMessage);
break; break;
@@ -102,6 +98,7 @@ if (file_exists(MAINTENANCE_MODE_FILE) && !$bBypassMaintenance)
* *
* @return bool * @return bool
*/ */
function EndsWith($haystack, $needle) { function EndsWith($haystack, $needle)
{
return substr_compare($haystack, $needle, -strlen($needle)) === 0; return substr_compare($haystack, $needle, -strlen($needle)) === 0;
} }

View File

@@ -1,2 +1,3 @@
<?php <?php
echo 'Access denied'; echo 'Access denied';

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -67,8 +68,7 @@ class DbConnectionWrapper
if (is_null($oMysqli)) { if (is_null($oMysqli)) {
// Reset to standard connection // Reset to standard connection
static::$oDbCnxMockableForQuery = static::$oDbCnxStandard; static::$oDbCnxMockableForQuery = static::$oDbCnxStandard;
} } else {
else {
static::$oDbCnxMockableForQuery = $oMysqli; static::$oDbCnxMockableForQuery = $oMysqli;
} }
} }

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -16,7 +17,6 @@
// You should have received a copy of the GNU Affero General Public License // You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/> // along with iTop. If not, see <http://www.gnu.org/licenses/>
/** /**
* Various dev/debug helpers * Various dev/debug helpers
* TODO: cleanup or at least re-organize * TODO: cleanup or at least re-organize
@@ -25,7 +25,6 @@
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
*/ */
/** /**
* MyHelpers * MyHelpers
* *
@@ -35,28 +34,23 @@ class MyHelpers
{ {
public static function CheckValueInArray($sDescription, $value, $aData) public static function CheckValueInArray($sDescription, $value, $aData)
{ {
if (!in_array($value, $aData)) if (!in_array($value, $aData)) {
{
self::HandleWrongValue($sDescription, $value, $aData); self::HandleWrongValue($sDescription, $value, $aData);
} }
} }
public static function CheckKeyInArray($sDescription, $key, $aData) public static function CheckKeyInArray($sDescription, $key, $aData)
{ {
if (!array_key_exists($key, $aData)) if (!array_key_exists($key, $aData)) {
{
self::HandleWrongValue($sDescription, $key, array_keys($aData)); self::HandleWrongValue($sDescription, $key, array_keys($aData));
} }
} }
public static function HandleWrongValue($sDescription, $value, $aData) public static function HandleWrongValue($sDescription, $value, $aData)
{ {
if (count($aData) == 0) if (count($aData) == 0) {
{
$sArrayDesc = "{}"; $sArrayDesc = "{}";
} } else {
else
{
$sArrayDesc = "{".implode(", ", $aData)."}"; $sArrayDesc = "{".implode(", ", $aData)."}";
} }
// exit! // exit!
@@ -76,11 +70,12 @@ class MyHelpers
*/ */
public static function MakeSQLComment($aHash) public static function MakeSQLComment($aHash)
{ {
if (empty($aHash)) return ""; if (empty($aHash)) {
return "";
}
$sComment = ""; $sComment = "";
{ {
foreach($aHash as $sKey=>$sValue) foreach ($aHash as $sKey => $sValue) {
{
$sComment .= "\n-- ".$sKey."=>".$sValue; $sComment .= "\n-- ".$sKey."=>".$sValue;
} }
} }
@@ -90,12 +85,9 @@ class MyHelpers
public static function var_dump_html($aWords, $bFullDisplay = false) public static function var_dump_html($aWords, $bFullDisplay = false)
{ {
echo "<pre>\n"; echo "<pre>\n";
if ($bFullDisplay) if ($bFullDisplay) {
{
print_r($aWords); // full dump! print_r($aWords); // full dump!
} } else {
else
{
var_dump($aWords); // truncate things when they are too big var_dump($aWords); // truncate things when they are too big
} }
echo "\n</pre>\n"; echo "\n</pre>\n";
@@ -123,9 +115,10 @@ class MyHelpers
{ {
$aLines1 = explode("\n", $s1); $aLines1 = explode("\n", $s1);
$aLines2 = explode("\n", $s2); $aLines2 = explode("\n", $s2);
for ($i = 0 ; $i < min(count($aLines1), count($aLines2)) ; $i++) for ($i = 0 ; $i < min(count($aLines1), count($aLines2)) ; $i++) {
{ if ($aLines1[$i] != $aLines2[$i]) {
if ($aLines1[$i] != $aLines2[$i]) return $i; return $i;
}
} }
return false; return false;
} }
@@ -142,9 +135,10 @@ class MyHelpers
// do not work fine with multiline strings // do not work fine with multiline strings
$iLen1 = strlen($s1); $iLen1 = strlen($s1);
$iLen2 = strlen($s2); $iLen2 = strlen($s2);
for ($i = 0 ; $i < min($iLen1, $iLen2) ; $i++) for ($i = 0 ; $i < min($iLen1, $iLen2) ; $i++) {
{ if ($s1[$i] !== $s2[$i]) {
if ($s1[$i] !== $s2[$i]) return $i; return $i;
}
} }
return false; return false;
} }
@@ -154,9 +148,10 @@ class MyHelpers
// do not work fine with multiline strings // do not work fine with multiline strings
$iLen1 = strlen($s1); $iLen1 = strlen($s1);
$iLen2 = strlen($s2); $iLen2 = strlen($s2);
for ($i = 0 ; $i < min(strlen($s1), strlen($s2)) ; $i++) for ($i = 0 ; $i < min(strlen($s1), strlen($s2)) ; $i++) {
{ if ($s1[$iLen1 - $i - 1] !== $s2[$iLen2 - $i - 1]) {
if ($s1[$iLen1 - $i - 1] !== $s2[$iLen2 - $i - 1]) return array($iLen1 - $i, $iLen2 - $i); return [$iLen1 - $i, $iLen2 - $i];
}
} }
return false; return false;
} }
@@ -177,8 +172,7 @@ class MyHelpers
protected static function string_cmp_html($s1, $s2, $sHighlight) protected static function string_cmp_html($s1, $s2, $sHighlight)
{ {
$iDiffPos = self::first_diff($s1, $s2); $iDiffPos = self::first_diff($s1, $s2);
if ($iDiffPos === false) if ($iDiffPos === false) {
{
echo "strings are identical"; echo "strings are identical";
return; return;
} }
@@ -203,40 +197,34 @@ class MyHelpers
public static function var_cmp_html($var1, $var2, $sHighlight = 'color:red; font-weight:bold;') public static function var_cmp_html($var1, $var2, $sHighlight = 'color:red; font-weight:bold;')
{ {
if (is_object($var1)) if (is_object($var1)) {
{
return self::object_cmp_html($var1, $var2, $sHighlight); return self::object_cmp_html($var1, $var2, $sHighlight);
} } elseif (count(explode("\n", $var1)) > 1) {
else if (count(explode("\n", $var1)) > 1)
{
// multiline string // multiline string
return self::text_cmp_html($var1, $var2, $sHighlight); return self::text_cmp_html($var1, $var2, $sHighlight);
} } else {
else
{
return self::string_cmp_html($var1, $var2, $sHighlight); return self::string_cmp_html($var1, $var2, $sHighlight);
} }
} }
public static function get_callstack($iLevelsToIgnore = 0, $aCallStack = null) public static function get_callstack($iLevelsToIgnore = 0, $aCallStack = null)
{ {
if ($aCallStack == null) $aCallStack = debug_backtrace(); if ($aCallStack == null) {
$aCallStack = debug_backtrace();
}
$aCallStack = array_slice($aCallStack, $iLevelsToIgnore); $aCallStack = array_slice($aCallStack, $iLevelsToIgnore);
$aDigestCallStack = array(); $aDigestCallStack = [];
$bFirstLine = true; $bFirstLine = true;
foreach ($aCallStack as $aCallInfo) foreach ($aCallStack as $aCallInfo) {
{
$sLine = empty($aCallInfo['line']) ? "" : $aCallInfo['line']; $sLine = empty($aCallInfo['line']) ? "" : $aCallInfo['line'];
$sFile = empty($aCallInfo['file']) ? "" : $aCallInfo['file']; $sFile = empty($aCallInfo['file']) ? "" : $aCallInfo['file'];
if ($sFile != '') if ($sFile != '') {
{
$sFile = str_replace('\\', '/', $sFile); $sFile = str_replace('\\', '/', $sFile);
$sAppRoot = str_replace('\\', '/', APPROOT); $sAppRoot = str_replace('\\', '/', APPROOT);
$iPos = strpos($sFile, $sAppRoot); $iPos = strpos($sFile, $sAppRoot);
if ($iPos !== false) if ($iPos !== false) {
{
$sFile = substr($sFile, strlen($sAppRoot)); $sFile = substr($sFile, strlen($sAppRoot));
} }
} }
@@ -244,25 +232,21 @@ class MyHelpers
$sType = empty($aCallInfo['type']) ? "" : $aCallInfo['type']; $sType = empty($aCallInfo['type']) ? "" : $aCallInfo['type'];
$sFunction = empty($aCallInfo['function']) ? "" : $aCallInfo['function']; $sFunction = empty($aCallInfo['function']) ? "" : $aCallInfo['function'];
if ($bFirstLine) if ($bFirstLine) {
{
$bFirstLine = false; $bFirstLine = false;
// For this line do not display the "function name" because // For this line do not display the "function name" because
// that will be the name of our error handler for sure ! // that will be the name of our error handler for sure !
$sFunctionInfo = "N/A"; $sFunctionInfo = "N/A";
} } else {
else
{
$args = ''; $args = '';
if (empty($aCallInfo['args'])) $aCallInfo['args'] = array(); if (empty($aCallInfo['args'])) {
foreach ($aCallInfo['args'] as $a) $aCallInfo['args'] = [];
{ }
if (!empty($args)) foreach ($aCallInfo['args'] as $a) {
{ if (!empty($args)) {
$args .= ', '; $args .= ', ';
} }
switch (gettype($a)) switch (gettype($a)) {
{
case 'integer': case 'integer':
case 'double': case 'double':
$args .= $a; $args .= $a;
@@ -292,7 +276,7 @@ class MyHelpers
} }
$sFunctionInfo = "$sClass$sType$sFunction($args)"; $sFunctionInfo = "$sClass$sType$sFunction($args)";
} }
$aDigestCallStack[] = array('File'=>$sFile, 'Line'=>$sLine, 'Function'=>$sFunctionInfo); $aDigestCallStack[] = ['File' => $sFile, 'Line' => $sLine, 'Function' => $sFunctionInfo];
} }
return $aDigestCallStack; return $aDigestCallStack;
} }
@@ -311,9 +295,8 @@ class MyHelpers
public static function get_callstack_text($iLevelsToIgnore = 0, $aCallStack = null) public static function get_callstack_text($iLevelsToIgnore = 0, $aCallStack = null)
{ {
$aDigestCallStack = self::get_callstack($iLevelsToIgnore, $aCallStack); $aDigestCallStack = self::get_callstack($iLevelsToIgnore, $aCallStack);
$aRes = array(); $aRes = [];
foreach ($aDigestCallStack as $aCall) foreach ($aDigestCallStack as $aCall) {
{
$aRes[] = $aCall['File'].' at '.$aCall['Line'].', '.$aCall['Function']; $aRes[] = $aCall['File'].' at '.$aCall['Line'].', '.$aCall['Function'];
} }
return implode("\n", $aRes); return implode("\n", $aRes);
@@ -325,10 +308,16 @@ class MyHelpers
/////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////
public static function make_table_from_assoc_array(&$aData) public static function make_table_from_assoc_array(&$aData)
{ {
if (!is_array($aData)) throw new CoreException("make_table_from_assoc_array: Error - the passed argument is not an array"); if (!is_array($aData)) {
throw new CoreException("make_table_from_assoc_array: Error - the passed argument is not an array");
}
$aFirstRow = reset($aData); $aFirstRow = reset($aData);
if (count($aData) == 0) return ''; if (count($aData) == 0) {
if (!is_array($aFirstRow)) throw new CoreException("make_table_from_assoc_array: Error - the passed argument is not a bi-dimensional array"); return '';
}
if (!is_array($aFirstRow)) {
throw new CoreException("make_table_from_assoc_array: Error - the passed argument is not a bi-dimensional array");
}
$sOutput = ""; $sOutput = "";
$sOutput .= "<TABLE WIDTH=\"100%\" BORDER=\"0\" CELLSPACING=\"1\" CELLPADDING=\"1\">\n"; $sOutput .= "<TABLE WIDTH=\"100%\" BORDER=\"0\" CELLSPACING=\"1\" CELLPADDING=\"1\">\n";
@@ -368,7 +357,9 @@ class MyHelpers
} }
public static function debug_breakpoint_notempty($arg) public static function debug_breakpoint_notempty($arg)
{ {
if (empty($arg)) return; if (empty($arg)) {
return;
}
echo "<H1> Debug breakpoint (triggered on non-empty value) </H1>\n"; echo "<H1> Debug breakpoint (triggered on non-empty value) </H1>\n";
MyHelpers::var_dump_html($arg); MyHelpers::var_dump_html($arg);
MyHelpers::dump_callstack(); MyHelpers::dump_callstack();
@@ -381,7 +372,7 @@ class MyHelpers
*/ */
public static function xmlentities($string) public static function xmlentities($string)
{ {
return str_replace( array( '&', '"', "'", '<', '>' ), array ( '&amp;' , '&quot;', '&apos;' , '&lt;' , '&gt;' ), $string ); return str_replace([ '&', '"', "'", '<', '>' ], [ '&amp;' , '&quot;', '&apos;' , '&lt;' , '&gt;' ], $string);
} }
/** /**
@@ -399,10 +390,14 @@ class MyHelpers
/////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////
public static function beautifulstr($sLongString, $iMaxLen, $bShowLen = false, $bShowTooltip = true) public static function beautifulstr($sLongString, $iMaxLen, $bShowLen = false, $bShowTooltip = true)
{ {
if (!is_string($sLongString)) throw new CoreException("beautifulstr: expect a string as 1st argument"); if (!is_string($sLongString)) {
throw new CoreException("beautifulstr: expect a string as 1st argument");
}
// Nothing to do if the string is short // Nothing to do if the string is short
if (strlen($sLongString) <= $iMaxLen) return $sLongString; if (strlen($sLongString) <= $iMaxLen) {
return $sLongString;
}
// Truncate the string // Truncate the string
$sSuffix = "..."; $sSuffix = "...";
@@ -456,8 +451,11 @@ class Str
} }
public static function gpc2pure($gpc) public static function gpc2pure($gpc)
{ {
if (ini_get('magic_quotes_sybase')) $pure = str_replace("''", "'", $gpc); if (ini_get('magic_quotes_sybase')) {
else $pure = $gpc; $pure = str_replace("''", "'", $gpc);
} else {
$pure = $gpc;
}
return $pure; return $pure;
} }
public static function html2pure($html) public static function html2pure($html)
@@ -477,7 +475,9 @@ class Str
} }
public static function pure2sql($pure, $maxLength = false) public static function pure2sql($pure, $maxLength = false)
{ {
if ($maxLength) $pure = substr($pure, 0, $maxLength); if ($maxLength) {
$pure = substr($pure, 0, $maxLength);
}
return (STR_SYBASE) return (STR_SYBASE)
? str_replace("'", "''", $pure) ? str_replace("'", "''", $pure)
: addslashes($pure); : addslashes($pure);
@@ -485,7 +485,9 @@ class Str
public static function sql2html($sql, $maxLength = false) public static function sql2html($sql, $maxLength = false)
{ {
$pure = self::sql2pure($sql); $pure = self::sql2pure($sql);
if ($maxLength) $pure = substr($pure, 0, $maxLength); if ($maxLength) {
$pure = substr($pure, 0, $maxLength);
}
return self::pure2html($pure); return self::pure2html($pure);
} }
public static function sql2pure($sql) public static function sql2pure($sql)
@@ -507,7 +509,7 @@ class Str
protected static function xmlentities($string) protected static function xmlentities($string)
{ {
return str_replace( array( '&', '"', "'", '<', '>' ), array ( '&amp;' , '&quot;', '&apos;' , '&lt;' , '&gt;' ), $string ); return str_replace([ '&', '"', "'", '<', '>' ], [ '&amp;' , '&quot;', '&apos;' , '&lt;' , '&gt;' ], $string);
} }
/** /**

View File

@@ -1,4 +1,5 @@
<?php <?php
/* /*
* @copyright Copyright (C) 2010-2024 Combodo SAS * @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
@@ -17,64 +18,64 @@ class TemporaryObjectDescriptor extends DBObject
{ {
public static function Init() public static function Init()
{ {
$aParams = array( $aParams = [
'category' => 'core', 'category' => 'core',
'key_type' => 'autoincrement', 'key_type' => 'autoincrement',
'name_attcode' => array('item_class', 'temp_id'), 'name_attcode' => ['item_class', 'temp_id'],
'image_attcode' => '', 'image_attcode' => '',
'state_attcode' => '', 'state_attcode' => '',
'reconc_keys' => array(''), 'reconc_keys' => [''],
'db_table' => 'priv_temporary_object_descriptor', 'db_table' => 'priv_temporary_object_descriptor',
'db_key_field' => 'id', 'db_key_field' => 'id',
'db_finalclass_field' => '', 'db_finalclass_field' => '',
'style' => new ormStyle(null, null, null, null, null, null), 'style' => new ormStyle(null, null, null, null, null, null),
'indexes' => array( 'indexes' => [
1 => 1 =>
array( [
0 => 'temp_id', 0 => 'temp_id',
), ],
2 => 2 =>
array( [
0 => 'item_class', 0 => 'item_class',
1 => 'item_id', 1 => 'item_id',
), ],
), ],
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_InheritAttributes(); MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeDateTime('expiration_date', array('sql' => 'expiration_date', 'is_null_allowed' => false, 'default_value' => '', 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeDateTime('expiration_date', ['sql' => 'expiration_date', 'is_null_allowed' => false, 'default_value' => '', 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeString('temp_id', array('sql' => 'temp_id', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeString('temp_id', ['sql' => 'temp_id', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeString('item_class', array('sql' => 'item_class', 'is_null_allowed' => false, 'default_value' => '', 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeString('item_class', ['sql' => 'item_class', 'is_null_allowed' => false, 'default_value' => '', 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeObjectKey('item_id', array('class_attcode' => 'item_class', 'sql' => 'item_id', 'is_null_allowed' => true, 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeObjectKey('item_id', ['class_attcode' => 'item_class', 'sql' => 'item_id', 'is_null_allowed' => true, 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeDateTime('creation_date', array('sql' => 'creation_date', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeDateTime('creation_date', ['sql' => 'creation_date', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeString('host_class', array('sql' => 'host_class', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeString('host_class', ['sql' => 'host_class', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeObjectKey('host_id', array('class_attcode' => 'host_class', 'sql' => 'host_id', 'is_null_allowed' => true, 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeObjectKey('host_id', ['class_attcode' => 'host_class', 'sql' => 'host_id', 'is_null_allowed' => true, 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeString('host_att_code', array('sql' => 'host_att_code', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => array(), 'always_load_in_tables' => false))); MetaModel::Init_AddAttribute(new AttributeString('host_att_code', ['sql' => 'host_att_code', 'is_null_allowed' => true, 'default_value' => '', 'allowed_values' => null, 'depends_on' => [], 'always_load_in_tables' => false]));
MetaModel::Init_AddAttribute(new AttributeEnum("operation", array("allowed_values" => new ValueSetEnum('create,delete'), "sql" => "operation", "default_value" => "create", "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeEnum("operation", ["allowed_values" => new ValueSetEnum('create,delete'), "sql" => "operation", "default_value" => "create", "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_SetZListItems('details', array( MetaModel::Init_SetZListItems('details', [
0 => 'temp_id', 0 => 'temp_id',
1 => 'item_class', 1 => 'item_class',
2 => 'item_id', 2 => 'item_id',
3 => 'creation_date', 3 => 'creation_date',
4 => 'expiration_date', 4 => 'expiration_date',
5 => 'meta', 5 => 'meta',
)); ]);
MetaModel::Init_SetZListItems('standard_search', array( MetaModel::Init_SetZListItems('standard_search', [
0 => 'temp_id', 0 => 'temp_id',
1 => 'item_class', 1 => 'item_class',
2 => 'item_id', 2 => 'item_id',
)); ]);
MetaModel::Init_SetZListItems('list', array( MetaModel::Init_SetZListItems('list', [
0 => 'temp_id', 0 => 'temp_id',
1 => 'item_class', 1 => 'item_class',
2 => 'item_id', 2 => 'item_id',
3 => 'creation_date', 3 => 'creation_date',
4 => 'expiration_date', 4 => 'expiration_date',
));; ]);
;
} }
public function DBInsertNoReload() public function DBInsertNoReload()
{ {
$this->SetCurrentDateIfNull('creation_date'); $this->SetCurrentDateIfNull('creation_date');
@@ -82,7 +83,6 @@ class TemporaryObjectDescriptor extends DBObject
return parent::DBInsertNoReload(); return parent::DBInsertNoReload();
} }
/** /**
* Set/Update all of the '_item' fields * Set/Update all of the '_item' fields
* *

View File

@@ -1,4 +1,5 @@
<?php <?php
// Copyright (C) 2010-2024 Combodo SAS // Copyright (C) 2010-2024 Combodo SAS
// //
// This file is part of iTop. // This file is part of iTop.
@@ -30,7 +31,6 @@ use Combodo\iTop\Service\Router\Router;
* @license http://opensource.org/licenses/AGPL-3.0 * @license http://opensource.org/licenses/AGPL-3.0
*/ */
require_once(APPROOT.'/core/asynctask.class.inc.php'); require_once(APPROOT.'/core/asynctask.class.inc.php');
require_once(APPROOT.'/core/email.class.inc.php'); require_once(APPROOT.'/core/email.class.inc.php');
@@ -47,8 +47,8 @@ abstract class Action extends cmdbAbstractObject
*/ */
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "grant_by_profile,core/cmdb", "category" => "grant_by_profile,core/cmdb",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
@@ -59,14 +59,14 @@ abstract class Action extends cmdbAbstractObject
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "realclass", "db_finalclass_field" => "realclass",
"style" => new ormStyle("ibo-dm-class--Action", "ibo-dm-class-alt--Action", "var(--ibo-dm-class--Action--main-color)", "var(--ibo-dm-class--Action--complementary-color)", null, '../images/icons/icons8-in-transit.svg'), "style" => new ormStyle("ibo-dm-class--Action", "ibo-dm-class-alt--Action", "var(--ibo-dm-class--Action--main-color)", "var(--ibo-dm-class--Action--complementary-color)", null, '../images/icons/icons8-in-transit.svg'),
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
//MetaModel::Init_InheritAttributes(); //MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values" => null, "sql" => "name", "default_value" => null, "is_null_allowed" => false, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("name", ["allowed_values" => null, "sql" => "name", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values" => null, "sql" => "description", "default_value" => null, "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeString("description", ["allowed_values" => null, "sql" => "description", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("status", array( MetaModel::Init_AddAttribute(new AttributeEnum("status", [
"allowed_values" => new ValueSetEnum(array('test' => 'Being tested', 'enabled' => 'In production', 'disabled' => 'Inactive')), "allowed_values" => new ValueSetEnum(['test' => 'Being tested', 'enabled' => 'In production', 'disabled' => 'Inactive']),
"styled_values" => [ "styled_values" => [
'test' => new ormStyle('ibo-dm-enum--Action-status-test', 'ibo-dm-enum-alt--Action-status-test', 'var(--ibo-dm-enum--Action-status-test--main-color)', 'var(--ibo-dm-enum--Action-status-test--complementary-color)', null, null), 'test' => new ormStyle('ibo-dm-enum--Action-status-test', 'ibo-dm-enum-alt--Action-status-test', 'var(--ibo-dm-enum--Action-status-test--main-color)', 'var(--ibo-dm-enum--Action-status-test--complementary-color)', null, null),
'enabled' => new ormStyle('ibo-dm-enum--Action-status-enabled', 'ibo-dm-enum-alt--Action-status-enabled', 'var(--ibo-dm-enum--Action-status-enabled--main-color)', 'var(--ibo-dm-enum--Action-status-enabled--complementary-color)', 'fas fa-check', null), 'enabled' => new ormStyle('ibo-dm-enum--Action-status-enabled', 'ibo-dm-enum-alt--Action-status-enabled', 'var(--ibo-dm-enum--Action-status-enabled--main-color)', 'var(--ibo-dm-enum--Action-status-enabled--complementary-color)', 'fas fa-check', null),
@@ -76,21 +76,23 @@ abstract class Action extends cmdbAbstractObject
"sql" => "status", "sql" => "status",
"default_value" => "test", "default_value" => "test",
"is_null_allowed" => false, "is_null_allowed" => false,
"depends_on" => array(), "depends_on" => [],
))); ]));
MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect("trigger_list", MetaModel::Init_AddAttribute(new AttributeLinkedSetIndirect(
array("linked_class" => "lnkTriggerAction", "ext_key_to_me" => "action_id", "ext_key_to_remote" => "trigger_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => array(), "display_style" => 'property'))); "trigger_list",
MetaModel::Init_AddAttribute(new AttributeEnum("asynchronous", array("allowed_values" => new ValueSetEnum(['use_global_setting' => 'Use global settings','yes' => 'Yes' ,'no' => 'No']), "sql" => "asynchronous", "default_value" => 'use_global_setting', "is_null_allowed" => false, "depends_on" => array()))); ["linked_class" => "lnkTriggerAction", "ext_key_to_me" => "action_id", "ext_key_to_remote" => "trigger_id", "allowed_values" => null, "count_min" => 0, "count_max" => 0, "depends_on" => [], "display_style" => 'property']
));
MetaModel::Init_AddAttribute(new AttributeEnum("asynchronous", ["allowed_values" => new ValueSetEnum(['use_global_setting' => 'Use global settings','yes' => 'Yes' ,'no' => 'No']), "sql" => "asynchronous", "default_value" => 'use_global_setting', "is_null_allowed" => false, "depends_on" => []]));
// Display lists // Display lists
// - Attributes to be displayed for the complete details // - Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('details', array('name', 'description', 'status', 'trigger_list')); MetaModel::Init_SetZListItems('details', ['name', 'description', 'status', 'trigger_list']);
// - Attributes to be displayed for a list // - Attributes to be displayed for a list
MetaModel::Init_SetZListItems('list', array('finalclass', 'name', 'description', 'status')); MetaModel::Init_SetZListItems('list', ['finalclass', 'name', 'description', 'status']);
// Search criteria // Search criteria
// - Default criteria of the search form // - Default criteria of the search form
MetaModel::Init_SetZListItems('default_search', array('name', 'description', 'status')); MetaModel::Init_SetZListItems('default_search', ['name', 'description', 'status']);
} }
@@ -111,8 +113,7 @@ abstract class Action extends cmdbAbstractObject
*/ */
public function IsActive() public function IsActive()
{ {
switch($this->Get('status')) switch ($this->Get('status')) {
{
case 'enabled': case 'enabled':
case 'test': case 'test':
return true; return true;
@@ -131,8 +132,7 @@ abstract class Action extends cmdbAbstractObject
*/ */
public function IsBeingTested() public function IsBeingTested()
{ {
switch($this->Get('status')) switch ($this->Get('status')) {
{
case 'test': case 'test':
return true; return true;
@@ -282,8 +282,8 @@ abstract class ActionNotification extends Action
*/ */
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "grant_by_profile,core/cmdb", "category" => "grant_by_profile,core/cmdb",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
@@ -293,16 +293,16 @@ abstract class ActionNotification extends Action
"db_table" => "priv_action_notification", "db_table" => "priv_action_notification",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_InheritAttributes(); MetaModel::Init_InheritAttributes();
// Display lists // Display lists
// - Attributes to be displayed for the complete details // - Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('details', array('name', 'description', 'status', 'trigger_list')); MetaModel::Init_SetZListItems('details', ['name', 'description', 'status', 'trigger_list']);
// - Attributes to be displayed for a list // - Attributes to be displayed for a list
MetaModel::Init_SetZListItems('list', array('finalclass', 'description', 'status')); MetaModel::Init_SetZListItems('list', ['finalclass', 'description', 'status']);
MetaModel::Init_AddAttribute(new AttributeApplicationLanguage("language", array("sql"=>"language", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array()))); MetaModel::Init_AddAttribute(new AttributeApplicationLanguage("language", ["sql" => "language", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
// Search criteria // Search criteria
// - Criteria of the std search form // - Criteria of the std search form
@@ -321,7 +321,8 @@ abstract class ActionNotification extends Action
* @throws \DictExceptionUnknownLanguage * @throws \DictExceptionUnknownLanguage
* @since 3.2.0 * @since 3.2.0
*/ */
public function SetNotificationLanguage($sLanguage = null, $sLanguageCode = null){ public function SetNotificationLanguage($sLanguage = null, $sLanguageCode = null)
{
$sPreviousLanguage = Dict::GetUserLanguage(); $sPreviousLanguage = Dict::GetUserLanguage();
$aPreviousPluginProperties = ApplicationContext::GetPluginProperties('QueryLocalizerPlugin'); $aPreviousPluginProperties = ApplicationContext::GetPluginProperties('QueryLocalizerPlugin');
$sLanguage = $sLanguage ?? $this->Get('language'); $sLanguage = $sLanguage ?? $this->Get('language');
@@ -348,69 +349,68 @@ class ActionEmail extends ActionNotification
* @var string * @var string
* @since 3.0.1 * @since 3.0.1
*/ */
const ENUM_HEADER_NAME_MESSAGE_ID = 'Message-ID'; public const ENUM_HEADER_NAME_MESSAGE_ID = 'Message-ID';
/** /**
* @var string * @var string
* @since 3.0.1 * @since 3.0.1
*/ */
const ENUM_HEADER_NAME_REFERENCES = 'References'; public const ENUM_HEADER_NAME_REFERENCES = 'References';
/** /**
* @var string * @var string
* @since 3.1.0 * @since 3.1.0
*/ */
const TEMPLATE_BODY_CONTENT = '$content$'; public const TEMPLATE_BODY_CONTENT = '$content$';
/** /**
* Wraps the 'body' of the message for previewing inside an IFRAME -- i.e. without any of the iTop stylesheets being applied * Wraps the 'body' of the message for previewing inside an IFRAME -- i.e. without any of the iTop stylesheets being applied
* @var string * @var string
* @since 3.1.0 * @since 3.1.0
*/ */
const CONTENT_HIGHLIGHT = '<div style="border:2px dashed #6800ff;position:relative;padding:2px;margin-top:14px;"><div style="background-color:#6800ff;color:#fff;font-family:Courier New, sans-serif;font-size:14px;line-height:16px;padding:3px;display:block;position:absolute;top:-22px;right:0;">$content$</div>%s</div>'; public const CONTENT_HIGHLIGHT = '<div style="border:2px dashed #6800ff;position:relative;padding:2px;margin-top:14px;"><div style="background-color:#6800ff;color:#fff;font-family:Courier New, sans-serif;font-size:14px;line-height:16px;padding:3px;display:block;position:absolute;top:-22px;right:0;">$content$</div>%s</div>';
/** /**
* Wraps a placeholder of the email's body for previewing inside an IFRAME -- i.e. without any of the iTop stylesheets being applied * Wraps a placeholder of the email's body for previewing inside an IFRAME -- i.e. without any of the iTop stylesheets being applied
* @var string * @var string
*/ */
const FIELD_HIGHLIGHT = '<span style="background-color:#6800ff;color:#fff;font-size:smaller;font-family:Courier New, sans-serif;padding:2px;">\\$$1\\$</span>'; public const FIELD_HIGHLIGHT = '<span style="background-color:#6800ff;color:#fff;font-size:smaller;font-family:Courier New, sans-serif;padding:2px;">\\$$1\\$</span>';
/** /**
* @inheritDoc * @inheritDoc
*/ */
public static function Init() public static function Init()
{ {
$aParams = array $aParams =
( [
"category" => "grant_by_profile,core/cmdb,application", "category" => "grant_by_profile,core/cmdb,application",
"key_type" => "autoincrement", "key_type" => "autoincrement",
"name_attcode" => "name", "name_attcode" => "name",
"state_attcode" => "", "state_attcode" => "",
"reconc_keys" => array('name'), "reconc_keys" => ['name'],
"db_table" => "priv_action_email", "db_table" => "priv_action_email",
"db_key_field" => "id", "db_key_field" => "id",
"db_finalclass_field" => "", "db_finalclass_field" => "",
'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-mailing.svg'), 'style' => new ormStyle(null, null, null, null, null, '../images/icons/icons8-mailing.svg'),
); ];
MetaModel::Init_Params($aParams); MetaModel::Init_Params($aParams);
MetaModel::Init_InheritAttributes(); MetaModel::Init_InheritAttributes();
MetaModel::Init_AddAttribute(new AttributeEmailAddress("test_recipient", array("allowed_values" => null, "sql" => "test_recipient", "default_value" => "", "is_null_allowed" => true, "depends_on" => array()))); MetaModel::Init_AddAttribute(new AttributeEmailAddress("test_recipient", ["allowed_values" => null, "sql" => "test_recipient", "default_value" => "", "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("from", array("allowed_values" => null, "sql" => "from", "default_value" => null, "is_null_allowed" => false, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeString("from_label", array("allowed_values" => null, "sql" => "from_label", "default_value" => null, "is_null_allowed" => true, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeString("reply_to", array("allowed_values" => null, "sql" => "reply_to", "default_value" => null, "is_null_allowed" => true, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeString("reply_to_label", array("allowed_values" => null, "sql" => "reply_to_label", "default_value" => null, "is_null_allowed" => true, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeOQL("to", array("allowed_values" => null, "sql" => "to", "default_value" => null, "is_null_allowed" => true, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeOQL("cc", array("allowed_values" => null, "sql" => "cc", "default_value" => null, "is_null_allowed" => true, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeOQL("bcc", array("allowed_values" => null, "sql" => "bcc", "default_value" => null, "is_null_allowed" => true, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeTemplateString("subject", array("allowed_values" => null, "sql" => "subject", "default_value" => null, "is_null_allowed" => false, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeTemplateHTML("body", array("allowed_values" => null, "sql" => "body", "default_value" => null, "is_null_allowed" => false, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeEnum("importance", array("allowed_values" => new ValueSetEnum('low,normal,high'), "sql" => "importance", "default_value" => 'normal', "is_null_allowed" => false, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeBlob("html_template", array("is_null_allowed"=>true, "depends_on"=>array(), "always_load_in_tables"=>false)));
MetaModel::Init_AddAttribute(new AttributeEnum("ignore_notify", array("allowed_values" => new ValueSetEnum('yes,no'), "sql" => "ignore_notify", "default_value" => 'yes', "is_null_allowed" => false, "depends_on" => array())));
MetaModel::Init_AddAttribute(new AttributeString("from", ["allowed_values" => null, "sql" => "from", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("from_label", ["allowed_values" => null, "sql" => "from_label", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("reply_to", ["allowed_values" => null, "sql" => "reply_to", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeString("reply_to_label", ["allowed_values" => null, "sql" => "reply_to_label", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeOQL("to", ["allowed_values" => null, "sql" => "to", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeOQL("cc", ["allowed_values" => null, "sql" => "cc", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeOQL("bcc", ["allowed_values" => null, "sql" => "bcc", "default_value" => null, "is_null_allowed" => true, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeTemplateString("subject", ["allowed_values" => null, "sql" => "subject", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeTemplateHTML("body", ["allowed_values" => null, "sql" => "body", "default_value" => null, "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeEnum("importance", ["allowed_values" => new ValueSetEnum('low,normal,high'), "sql" => "importance", "default_value" => 'normal', "is_null_allowed" => false, "depends_on" => []]));
MetaModel::Init_AddAttribute(new AttributeBlob("html_template", ["is_null_allowed" => true, "depends_on" => [], "always_load_in_tables" => false]));
MetaModel::Init_AddAttribute(new AttributeEnum("ignore_notify", ["allowed_values" => new ValueSetEnum('yes,no'), "sql" => "ignore_notify", "default_value" => 'yes', "is_null_allowed" => false, "depends_on" => []]));
// Display lists // Display lists
// - Attributes to be displayed for the complete details // - Attributes to be displayed for the complete details
MetaModel::Init_SetZListItems('details', array( MetaModel::Init_SetZListItems('details', [
'col:col1' => array( 'col:col1' => [
'fieldset:ActionEmail:main' => array( 'fieldset:ActionEmail:main' => [
0 => 'name', 0 => 'name',
1 => 'description', 1 => 'description',
2 => 'status', 2 => 'status',
@@ -419,14 +419,14 @@ class ActionEmail extends ActionNotification
5 => 'subject', 5 => 'subject',
6 => 'body', 6 => 'body',
// 5 => 'importance', not handled when sending the mail, better hide it then // 5 => 'importance', not handled when sending the mail, better hide it then
), ],
'fieldset:ActionEmail:trigger' => array( 'fieldset:ActionEmail:trigger' => [
0 => 'trigger_list', 0 => 'trigger_list',
1 => 'asynchronous' 1 => 'asynchronous',
), ],
), ],
'col:col2' => array( 'col:col2' => [
'fieldset:ActionEmail:recipients' => array( 'fieldset:ActionEmail:recipients' => [
0 => 'from', 0 => 'from',
1 => 'from_label', 1 => 'from_label',
2 => 'reply_to', 2 => 'reply_to',
@@ -436,17 +436,17 @@ class ActionEmail extends ActionNotification
6 => 'to', 6 => 'to',
7 => 'cc', 7 => 'cc',
8 => 'bcc', 8 => 'bcc',
), ],
), ],
)); ]);
// - Attributes to be displayed for a list // - Attributes to be displayed for a list
MetaModel::Init_SetZListItems('list', array('status', 'to', 'subject', 'language')); MetaModel::Init_SetZListItems('list', ['status', 'to', 'subject', 'language']);
// Search criteria // Search criteria
// - Standard criteria of the search // - Standard criteria of the search
MetaModel::Init_SetZListItems('standard_search', array('name', 'description', 'status', 'subject', 'language')); MetaModel::Init_SetZListItems('standard_search', ['name', 'description', 'status', 'subject', 'language']);
// - Default criteria for the search // - Default criteria for the search
MetaModel::Init_SetZListItems('default_search', array('name', 'description', 'status', 'subject', 'language')); MetaModel::Init_SetZListItems('default_search', ['name', 'description', 'status', 'subject', 'language']);
} }
// count the recipients found // count the recipients found
@@ -477,10 +477,11 @@ class ActionEmail extends ActionNotification
{ {
$oTrigger = $aArgs['trigger->object()'] ?? null; $oTrigger = $aArgs['trigger->object()'] ?? null;
$sOQL = $this->Get($sRecipAttCode); $sOQL = $this->Get($sRecipAttCode);
if (utils::IsNullOrEmptyString($sOQL)) return ''; if (utils::IsNullOrEmptyString($sOQL)) {
return '';
}
try try {
{
$oSearch = DBObjectSearch::FromOQL($sOQL); $oSearch = DBObjectSearch::FromOQL($sOQL);
if ($this->Get('ignore_notify') === 'no') { if ($this->Get('ignore_notify') === 'no') {
// In theory, it is possible to notify *any* kind of object, // In theory, it is possible to notify *any* kind of object,
@@ -492,26 +493,21 @@ class ActionEmail extends ActionNotification
} }
} }
$oSearch->AllowAllData(); $oSearch->AllowAllData();
} } catch (OQLException $e) {
catch (OQLException $e)
{
$this->m_aMailErrors[] = "query syntax error for recipient '$sRecipAttCode'"; $this->m_aMailErrors[] = "query syntax error for recipient '$sRecipAttCode'";
return $e->getMessage(); return $e->getMessage();
} }
$sClass = $oSearch->GetClass(); $sClass = $oSearch->GetClass();
// Determine the email attribute (the first one will be our choice) // Determine the email attribute (the first one will be our choice)
foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) {
{ if ($oAttDef instanceof AttributeEmailAddress) {
if ($oAttDef instanceof AttributeEmailAddress)
{
$sEmailAttCode = $sAttCode; $sEmailAttCode = $sAttCode;
// we've got one, exit the loop // we've got one, exit the loop
break; break;
} }
} }
if (!isset($sEmailAttCode)) if (!isset($sEmailAttCode)) {
{
$this->m_aMailErrors[] = "wrong target for recipient '$sRecipAttCode'"; $this->m_aMailErrors[] = "wrong target for recipient '$sRecipAttCode'";
return "The objects of the class '$sClass' do not have any email attribute"; return "The objects of the class '$sClass' do not have any email attribute";
} }
@@ -526,13 +522,11 @@ class ActionEmail extends ActionNotification
$oSearch->AddConditionExpression(Expression::FromOQL("`$sAlias`.id NOT IN ($sSubscribedContactsOQL)")); $oSearch->AddConditionExpression(Expression::FromOQL("`$sAlias`.id NOT IN ($sSubscribedContactsOQL)"));
} }
$oSet = new DBObjectSet($oSearch, array() /* order */, $aArgs); $oSet = new DBObjectSet($oSearch, [] /* order */, $aArgs);
$aRecipients = array(); $aRecipients = [];
while ($oObj = $oSet->Fetch()) while ($oObj = $oSet->Fetch()) {
{
$sAddress = trim($oObj->Get($sEmailAttCode)); $sAddress = trim($oObj->Get($sEmailAttCode));
if (utils::IsNotNullOrEmptyString($sAddress)) if (utils::IsNotNullOrEmptyString($sAddress)) {
{
$aRecipients[] = $sAddress; $aRecipients[] = $sAddress;
$this->m_iRecipients++; $this->m_iRecipients++;
} }
@@ -551,15 +545,11 @@ class ActionEmail extends ActionNotification
*/ */
public function DoExecute($oTrigger, $aContextArgs) public function DoExecute($oTrigger, $aContextArgs)
{ {
if (MetaModel::IsLogEnabledNotification()) if (MetaModel::IsLogEnabledNotification()) {
{
$oLog = new EventNotificationEmail(); $oLog = new EventNotificationEmail();
if ($this->IsBeingTested()) if ($this->IsBeingTested()) {
{
$oLog->Set('message', 'TEST - Notification sent ('.$this->Get('test_recipient').')'); $oLog->Set('message', 'TEST - Notification sent ('.$this->Get('test_recipient').')');
} } else {
else
{
$oLog->Set('message', 'Notification pending'); $oLog->Set('message', 'Notification pending');
} }
$oLog->Set('userinfo', UserRights::GetUser()); $oLog->Set('userinfo', UserRights::GetUser());
@@ -570,44 +560,31 @@ class ActionEmail extends ActionNotification
// Must be inserted now so that it gets a valid id that will make the link // Must be inserted now so that it gets a valid id that will make the link
// between an eventual asynchronous task (queued) and the log // between an eventual asynchronous task (queued) and the log
$oLog->DBInsertNoReload(); $oLog->DBInsertNoReload();
} } else {
else
{
$oLog = null; $oLog = null;
} }
try try {
{
$sRes = $this->_DoExecute($oTrigger, $aContextArgs, $oLog); $sRes = $this->_DoExecute($oTrigger, $aContextArgs, $oLog);
if ($this->IsBeingTested()) if ($this->IsBeingTested()) {
{
$sPrefix = 'TEST ('.$this->Get('test_recipient').') - '; $sPrefix = 'TEST ('.$this->Get('test_recipient').') - ';
} } else {
else
{
$sPrefix = ''; $sPrefix = '';
} }
if ($oLog) if ($oLog) {
{
$oLog->Set('message', $sPrefix.$sRes); $oLog->Set('message', $sPrefix.$sRes);
$oLog->DBUpdate(); $oLog->DBUpdate();
} }
} } catch (Exception $e) {
catch (Exception $e) if ($oLog) {
{
if ($oLog)
{
$oLog->Set('message', 'Error: '.$e->getMessage()); $oLog->Set('message', 'Error: '.$e->getMessage());
try try {
{
$oLog->DBUpdate(); $oLog->DBUpdate();
} } catch (Exception $eSecondTryUpdate) {
catch (Exception $eSecondTryUpdate)
{
IssueLog::Error("Failed to process email ".$oLog->GetKey()." - reason: ".$e->getMessage()."\nTrace:\n".$e->getTraceAsString()); IssueLog::Error("Failed to process email ".$oLog->GetKey()." - reason: ".$e->getMessage()."\nTrace:\n".$e->getTraceAsString());
$oLog->Set('message', 'Error: more details in the log for email "'.$oLog->GetKey().'"'); $oLog->Set('message', 'Error: more details in the log for email "'.$oLog->GetKey().'"');
@@ -650,18 +627,13 @@ class ActionEmail extends ActionNotification
$oEmail->AddAttachment($aAttachment['data'], $aAttachment['filename'], $aAttachment['mime_type']); $oEmail->AddAttachment($aAttachment['data'], $aAttachment['filename'], $aAttachment['mime_type']);
} }
if (empty($this->m_aMailErrors)) if (empty($this->m_aMailErrors)) {
{ if ($this->m_iRecipients == 0) {
if ($this->m_iRecipients == 0)
{
return 'No recipient'; return 'No recipient';
} } else {
else
{
$aErrors = []; $aErrors = [];
$iRes = $oEmail->Send($aErrors, $this->IsAsynchronous() ? Email::ENUM_SEND_FORCE_ASYNCHRONOUS : Email::ENUM_SEND_FORCE_SYNCHRONOUS, $oLog); $iRes = $oEmail->Send($aErrors, $this->IsAsynchronous() ? Email::ENUM_SEND_FORCE_ASYNCHRONOUS : Email::ENUM_SEND_FORCE_SYNCHRONOUS, $oLog);
switch ($iRes) switch ($iRes) {
{
case EMAIL_SEND_OK: case EMAIL_SEND_OK:
return "Sent"; return "Sent";
@@ -721,10 +693,9 @@ class ActionEmail extends ActionNotification
$sPreviousUrlMaker = ApplicationContext::SetUrlMakerClass(); $sPreviousUrlMaker = ApplicationContext::SetUrlMakerClass();
[$sPreviousLanguage, $aPreviousPluginProperties] = $this->SetNotificationLanguage(); [$sPreviousLanguage, $aPreviousPluginProperties] = $this->SetNotificationLanguage();
try try {
{
$this->m_iRecipients = 0; $this->m_iRecipients = 0;
$this->m_aMailErrors = array(); $this->m_aMailErrors = [];
// Determine recipients // Determine recipients
// //
@@ -744,12 +715,10 @@ class ActionEmail extends ActionNotification
$oObj = $aContextArgs['this->object()']; $oObj = $aContextArgs['this->object()'];
$aMessageContent['message_id'] = $this->GenerateIdentifierForHeaders($oObj, static::ENUM_HEADER_NAME_MESSAGE_ID); $aMessageContent['message_id'] = $this->GenerateIdentifierForHeaders($oObj, static::ENUM_HEADER_NAME_MESSAGE_ID);
$aMessageContent['references'] = $this->GenerateIdentifierForHeaders($oObj, static::ENUM_HEADER_NAME_REFERENCES); $aMessageContent['references'] = $this->GenerateIdentifierForHeaders($oObj, static::ENUM_HEADER_NAME_REFERENCES);
} } catch (Exception $e) {
catch (Exception $e) {
/** @noinspection PhpUnhandledExceptionInspection */ /** @noinspection PhpUnhandledExceptionInspection */
throw $e; throw $e;
} } finally {
finally {
ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker); ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker);
$this->SetNotificationLanguage($sPreviousLanguage, $aPreviousPluginProperties['language_code'] ?? null); $this->SetNotificationLanguage($sPreviousLanguage, $aPreviousPluginProperties['language_code'] ?? null);
} }
@@ -803,14 +772,12 @@ class ActionEmail extends ActionNotification
// Note: N°4849 We pass the "References" identifier instead of the "Message-ID" on purpose as we want notifications emails to group around the triggering iTop object, not just the users' replies to the notification // Note: N°4849 We pass the "References" identifier instead of the "Message-ID" on purpose as we want notifications emails to group around the triggering iTop object, not just the users' replies to the notification
$aMessageContent['in_reply_to'] = $aMessageContent['references']; $aMessageContent['in_reply_to'] = $aMessageContent['references'];
if (isset($aContextArgs['attachments'])) if (isset($aContextArgs['attachments'])) {
{ $aAttachmentReport = [];
$aAttachmentReport = array();
/** @var \ormDocument $oDocument */ /** @var \ormDocument $oDocument */
foreach($aContextArgs['attachments'] as $oDocument) foreach ($aContextArgs['attachments'] as $oDocument) {
{
$aMessageContent['attachments'][] = ['data' => $oDocument->GetData(), 'filename' => $oDocument->GetFileName(), 'mime_type' => $oDocument->GetMimeType()]; $aMessageContent['attachments'][] = ['data' => $oDocument->GetData(), 'filename' => $oDocument->GetFileName(), 'mime_type' => $oDocument->GetMimeType()];
$aAttachmentReport[] = array($oDocument->GetFileName(), $oDocument->GetMimeType(), strlen($oDocument->GetData() ?? '')); $aAttachmentReport[] = [$oDocument->GetFileName(), $oDocument->GetMimeType(), strlen($oDocument->GetData() ?? '')];
} }
$oLog->Set('attachments', $aAttachmentReport); $oLog->Set('attachments', $aAttachmentReport);
} }

Some files were not shown because too many files have changed in this diff Show More