N°2364 - API : remove old linkedset persistance (#733) - deprecated message only on console and portal context. Avoid messages during tests, setup and other case

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

.doc/README.md

@@ -1,99 +0,0 @@
-# Phpdoc dokuwiki template
-This directory contains a template for rendering iTop phpdoc as dokuwiki pages.
-
-
-Conventional tags that you should use:
- * `@internal` : exclude from the documentation.
- * `@api` : it means that a method is an api, thus it may be interacted with.
- * `@see` : it points to another documented method
- * `@link` : external url 
-   * if you point to another page of the wiki, please use relative links.
- * `@example` : let you provide example of code
- * `@param`, `@return`, `@throws`, ... 
-
-
-## Special instructions
-
-Some iTop specific tags were added : 
- * `@api-advanced`: it means that a method is an `@api` but mark it also as "complex" to use
- * `@overwritable-hook`: used to mark a method as "designed to be extended"
- * `@extension-hook`: not used for now 
- * `@phpdoc-tuning-exclude-inherited`: once this tag is present on a class, it's inherited methods won't be showed.
-
- 
-### known limitations:
-#### `@see` tags must be very specific: 
-   * always prefix class members (attributes or methods) with `ClassName::` (do not use self) 
-   * for methods always suffix them with `()`, 
-   * do not reference variables since they are not documented. If you have to, always prefix them with `$`
- 
-examples: 
-```
-/** 
- * @see DBObject
- * @see DBObject::Get()
- * @see DBObject::$foo
- */
-```   
-
-#### Do not use inline tags, they do not work properly, example: 
-```
-/** 
- * This is a texts with an inline tag {@see [FQSEN] [<description>]} it must never be used 
- */
-```
-   
-#### The `@example` tag must respect this very precise syntax 
- * the sentence in the first line (next to the tag) is the title, it  must be enclosed by double quotes 
- * the following lines are the sample code. 
- * 💔 since we simply hack the official tag, this syntax must be respected carefully 💔
-example: 
-```
-/** 
-* @example "This is the title of the multiline example"
-* $foo = DBObject::Get('foo');
-* DBObject::Set('foo', ++$foo);
-*/
-```  
-    
-## How content is included into the documentation
-
-**For a class** those requirements have to be respected: 
- - the file containing the class must be listed in `/phpdoc/files/file[]` of  `.doc/phpdoc-objects-manipulation.dist.xml`
- - the class **must not** have the tag `@internal`
- - the class **must** have at least one of: `@api`, `@api-advanced`, `@overwritable-hook`, `@extension-hook` 
-
-Then, **for a method** of an eligible class: 
- - **public** methods **must** have at least one of: `@api`, `@api-advanced`, `@overwritable-hook`, `@extension-hook` 
- - **protected** methods **must** have at least one of: `@overwritable-hook`, `@extension-hook` 
- - **private** methods are **always excluded** 
-
-**Class properties** and **constants** are never documented (this is subject to change).
-
-
-
-
-## A note about the rendering engine
-  
-:notebook: as spaces are used to mark code, the templates (`.doc/phpdoc-templates/combodo-wiki/*`) have very few indentation, thus they are awful to read (sorry).
-
-## Installation
-
-```
-cd .doc
-composer require phpdocumentor/phpdocumentor:~2 --dev
-```
-
-## Generation
-
-1. Switch to this directory : `cd /path/to/itop/.doc`
-2. `composer install`
-3. `./bin/build-doc-object-manipulation`
-3. `./bin/build-doc-extensions`
-4. Get the generated files from `/path/to/itop/data/phpdocumentor/output`
-
-## Dokuwiki requirements
- * the template uses the [wrap plugin](https://www.dokuwiki.org/plugin:wrap).
- * the generated files have to be placed under an arbitrary directory of `[/path/to/dokuwiki]/data/pages`.
- * the html has to be activated [config:htmlok](https://www.dokuwiki.org/config:htmlok)
- * the generated files have to be in lowercase

.doc/bin/build-doc-extensions

@@ -1,6 +0,0 @@
-#!/bin/sh -x
-
-rm -rf /tmp/phpdoc-twig-cache/ && rm -rf data/phpdocumentor/output/extensions/ && rm -rf data/phpdocumentor/temp/extensions/ && ./vendor/bin/phpdoc -c ./phpdoc-extensions.dist.xml -vvv
-
-# now wee need to lowercase every generated file because dokuwiki can't handle uppercase
-cd ../data/phpdocumentor/output/extensions/ && for i in $(ls | grep [A-Z]); do mv -i $i $(echo $i | tr 'A-Z' 'a-z'); done

.doc/bin/build-doc-object-manipulation

@@ -1,7 +0,0 @@
-#!/bin/sh -x
-
-rm -rf /tmp/phpdoc-twig-cache/ &&  rm -rf ../data/phpdocumentor/output/objects-manipulation/ &&  rm -rf ../data/phpdocumentor/temp/objects-manipulation/ && ./vendor/bin/phpdoc -c ./phpdoc-objects-manipulation.dist.xml -vvv
-
-
-# now wee need to lowercase every generated file because dokuwiki can't handle uppercase
-cd ../data/phpdocumentor/output/objects-manipulation/ && for i in $( ls | grep [A-Z] ); do mv -i $i `echo $i | tr 'A-Z' 'a-z'`; done

.doc/composer.json

@@ -1,6 +0,0 @@
-{
-    "require-dev": {
-        "phpdocumentor/phpdocumentor": "~2",
-	"jms/serializer": "1.7.*"
-    }
-}

.doc/itop-version-history.md

@@ -1,7 +1,14 @@
 # iTop version history
 
 ```mermaid
-%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true,'mainBranchName': 'develop','rotateCommitLabel': true}} }%%
+%%{init: { 'logLevel': 'debug', 'theme': 'base', 'themeVariables': {
+              'git0': 'lawngreen',
+              'git3': 'dodgerblue',
+              'git4': 'grey',
+              'git5': 'grey',
+              'git6': 'grey',
+              'git7': 'grey'
+       }, 'gitGraph': {'showBranches': true,'mainBranchName': 'develop','rotateCommitLabel': true}} }%%
 gitGraph
     commit id: "2016-07-06" tag: "2.3.0" type: HIGHLIGHT
     branch support/2.3 order: 900
@@ -68,6 +75,33 @@ gitGraph
     branch support/3.1 order: 840
     checkout support/3.1
     commit id: "2023-08-09" tag: "3.1.0-2"
+    checkout support/2.7
+    commit id: "2023-08-10" tag: "2.7.9"
+    checkout support/3.1
+    commit id: "2023-12-20" tag: "3.1.1"
+    checkout develop
+    commit id: "2024-01-15" tag: "Start 3.2" type: HIGHLIGHT
+    branch support/3.2 order: 830
+    checkout support/2.7
+    commit id: "2024-01-17a" tag: "2.7.10"
+    checkout support/3.0
+    commit id: "2024-01-17b" tag: "3.0.4"
+    checkout support/3.2
+    commit id: "2024-06-25" tag: "3.2.0-beta1" type: REVERSE
+    commit id: "2024-08-07" tag: "3.2.0"
+    commit id: "2024-09-13" tag: "3.2.0-2"
+    checkout support/3.1
+    commit id: "2024-09-27" tag: "3.1.2"
+    checkout support/2.7
+    commit id: "2024-09-28" tag: "2.7.11"
+    checkout support/2.7
+    commit id: "2025-02-25" tag: "2.7.12"
+    checkout support/3.1
+    commit id: "2025-02-25 " tag: "3.1.3"
+    checkout support/3.2
+    commit id: "2025-02-25  " tag: "3.2.1"
+    commit id: "2025-04-08" tag: "3.2.1-1"
+    commit id: "2025-08-19" tag: "3.2.2-1"
 ```
 
 To learn more, check the [iTop community versions history on the official wiki](https://www.itophub.io/wiki/page?id=latest:release:start).

.doc/phpdoc-extensions.dist.xml

@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<phpdoc>
-  <title><![CDATA[iTop extensions]]></title>
-
-  <parser>
-    <target>../data/phpdocumentor/temp/extensions</target>
-  </parser>
-
-  <transformer>
-    <target>../data/phpdocumentor/output/extensions</target>
-  </transformer>
-
-  <transformations>
-    <template name="phpdoc-templates/combodo-wiki"/>
-  </transformations>
-
-  <files>
-    <file>../application/applicationextension.inc.php</file>
-  </files>
-</phpdoc>

.doc/phpdoc-objects-manipulation.dist.xml

@@ -1,58 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<phpdoc>
-
-  <!--
-    /**
-    The documentation of this file can be found here : https://docs.phpdoc.org/references/configuration.html
-    it has to be completed by the CLI parameters documentation which is more comprehensive: https://docs.phpdoc.org/references/commands/project_run.html#usage
-
-    usage:
-    vendor/bin/phpdoc -c phpdoc-objects-manipulation.dist.xml
-
-    */
-  -->
-
-  <title><![CDATA[iTop's objects manipulation API]]></title>
-
-  <parser>
-    <default-package-name>iTopORM</default-package-name>
-    <target>../data/phpdocumentor/temp/objects-manipulation</target>
-    <visibility>public,protected</visibility>
-    <markers>
-      <!--<item>TODO</item>-->
-      <!--<item>FIXME</item>-->
-    </markers>
-      <extensions>
-          <extension>php</extension>
-      </extensions>
-  </parser>
-
-  <transformer>
-    <target>../data/phpdocumentor/output/objects-manipulation</target>
-  </transformer>
-
-  <transformations>
-    <template name="phpdoc-templates/combodo-wiki"/>
-  </transformations>
-
-  <!--<logging>-->
-    <!--<level>warn</level>-->
-    <!--<paths>-->
-      <!--&lt;!&ndash;<default>data/phpdocumentor/log/objects-manipulation/{DATE}.log</default>&ndash;&gt;-->
-      <!--&lt;!&ndash;<errors>data/phpdocumentor/log/objects-manipulation/{DATE}.errors.log</errors>&ndash;&gt;-->
-
-      <!--<default>{APP_ROOT}/data/log/{DATE}.log</default>-->
-      <!--<errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors>-->
-    <!--</paths>-->
-  <!--</logging>-->
-
-  <files>
-    <file>../core/dbobject.class.php</file>
-    <file>../core/dbobjectsearch.class.php</file>
-    <file>../core/metamodel.class.php</file>
-    <file>../core/dbobjectset.class.php</file>
-    <file>../core/dbsearch.class.php</file>
-    <file>../core/dbunionsearch.class.php</file>
-  </files>
-
-</phpdoc>

.doc/phpdoc-templates/combodo-wiki/class.txt.twig

@@ -1,136 +0,0 @@
-{% extends 'layout.txt.twig' %}
-
-{% block content %}
-<wrap button>[[start|🔙 Back]]</wrap>
-
-{% if node.tags['internal'] is defined %}
-====== {{ node.name }} ======
-<WRAP alert>This class is "internal", and thus is not documented!</WRAP>
-{% elseif node.tags['api'] is not defined and node.tags['api-advanced'] is not defined and node.tags['overwritable-hook'] is not defined and node.tags['extension-hook'] is not defined %}
-====== {{ node.name }} ======
-<WRAP alert>This class is neither "api", "api-advanced", "overwritable-hook" or "extension-hook", and thus is not documented!</WRAP>
-{% else %}
-
-====== {{ node.name }} ======
-
-{% if node.deprecated %}<wrap danger>deprecated</wrap>{% endif %}
-{% if node.abstract %}<wrap warning>abstract</wrap>{% endif %}
-{% if node.final %}<wrap notice>final</wrap>{% endif %}
-{% include 'includes/wrap-tags.txt.twig' with {structure:node, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
-
-
-
-{% if node.deprecated %}
-=== **<del>Deprecated</del>**===
-//{{ node.tags.deprecated[0].description }}//
-{% endif %}
-
-
-== {{  node.summary|replace({"\n":""})|raw }} ==
-<html>{{ node.description|markdown|raw }}</html>
-
-
-{% include 'includes/code-examples.txt.twig' with {structure:node, title_level: '====='} %}
-
-
-{% set class = node.parent %}
-{% block hierarchy_element %}
-
-{% if class and class.name is defined and class.name|trim != '' %}
-==== parent ====
-{% set child = class %}
-{% set class = class.parent %}
-{{ block('hierarchy_element') }}
-[[{{ child.name }}|{{ child.name }}]]
-{% endif %}
-{% endblock %}
-
-
-{% for interface in node.interfaces|sort_asc %}
-{% if loop.first %}
-==== Implements ====
-{% endif %}
-{% if loop.length > 1 %}  * {% endif %}{{ interface.fullyQualifiedStructuralElementName ?: interface }}
-{% endfor %}
-
-
-{% for trait in node.usedTraits|sort_asc %}
-{% if loop.first %}
-==== Uses traits ====
-{% endif %}
-{% if loop.length > 1 %}  * {% endif %}{{ trait.fullyQualifiedStructuralElementName ?: trait }}
-{% endfor %}
-
-
-{% include 'includes/see-also.txt.twig' with {structure:node, title_level: '==='} %}
-
-{% include 'includes/tags.txt.twig' with {structure:node, title_level: '=====', blacklist:  ['link', 'see', 'abstract', 'example', 'method', 'property', 'property-read', 'property-write', 'package', 'subpackage', 'phpdoc-tuning-exclude-inherited', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'copyright', 'license', 'code-example']} %}
-
-{% set methods = node.inheritedMethods.merge(node.methods.merge(node.magicMethods)) %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api'} %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api-advanced'} %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'overwritable-hook'} %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'extension-hook'} %}
-
-
-{% include 'includes/code-examples.txt.twig' with {structure:node, title_level: '=====', sub_title_level: '=='} %}
-
-<WRAP clear />
-
-{% for method in methods|sort_asc
-    if method.visibility == 'public'
-    and (
-        method.tags['api'] is defined
-        or method.tags['api-advanced'] is defined
-        or method.tags['overwritable-hook'] is defined
-        or method.tags['extension-hook'] is defined
-    )
-    and (
-        node.tags['phpdoc-tuning-exclude-inherited'] is not defined
-        or method.parent.name == node.name
-    )
-%}
-{%- if loop.first %}
-===== Public methods =====
-{% endif %}
-{{ block('method') }}
-{% endfor %}
-{% for method in methods|sort_asc if method.visibility == 'protected' and (method.tags['overwritable-hook'] is defined or method.tags['extension-hook'] is defined) %}
-{%- if loop.first %}
-===== Protected methods =====
-{% endif %}
-{{ block('method') }}
-{% endfor %}
-
-
-
-
-
-{% set constants = node.inheritedConstants.merge(node.constants) %}
-{% if constants|length > 0 %}
-===== Constants =====
-{% for constant in constants|sort_asc %}
-{{ block('constant') }}
-{% endfor %}
-{% endif %}
-
-
-{#{% set properties = node.inheritedProperties.merge(node.properties.merge(node.magicProperties)) %}#}
-{#{% for property in properties|sort_asc if property.visibility == 'public' %}#}
-{#{%- if loop.first %}#}
-{#===== Public properties =====#}
-{#{% endif %}#}
-{#{{ block('property') }}#}
-{#{% endfor %}#}
-{#{% for property in properties|sort_asc if property.visibility == 'protected' %}#}
-{#{%- if loop.first %}#}
-{#===== Protected properties =====#}
-{#{% endif %}#}
-{#{{ block('property') }}#}
-{#{% endfor %}#}
-
-
-{%- endif %} {#{% elseif node.tags['xxx'] is not defined and ... #}
-
-<wrap button>[[start|🔙 Back]]</wrap>
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/elements/constant.txt.twig

@@ -1,31 +0,0 @@
-{% block constant %}
-
-<WRAP group box >
-<WRAP twothirds column >
-==== {{ constant.name }} ====
-</WRAP>{# twothirds column#}
-
-<WRAP third column>
-{% if constant.deprecated %}<wrap danger>deprecated</wrap> {% endif %}
-{% if (node.parent is not null and constant.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
-</WRAP>{# third column#}
-
-== {{ constant.summary|replace({"\n":""})|raw }} ==
-<html>{{ constant.description|markdown|raw }}</html>
-
-{% if constant.deprecated %}
-=== Deprecated ===
-{{ constant.tags.deprecated[0].description|raw }}
-{% endif %}
-
-{% include 'includes/inherited-from.txt.twig' with {structure:constant} %}
-
-{% include 'includes/see-also.txt.twig' with {structure:constant, title_level: '=='} %}
-
-{% include 'includes/uses.txt.twig' with {structure:constant, title_level: '=='} %}
-
-{% include 'includes/tags.txt.twig' with {structure:constant, title_level: '==', blacklist:  ['link', 'see', 'var', 'deprecated', 'uses', 'package', 'subpackage', 'todo', 'code-example']} %}
-
-</WRAP>{# group #}
-
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/elements/method.txt.twig

@@ -1,95 +0,0 @@
-{% block method %}
-
-
-<WRAP group box >
-<WRAP twothirds column >
-==== {{ method.name }} ====
-</WRAP>{# twothirds column#}
-<WRAP third column >
-{% include 'includes/wrap-tags.txt.twig' with {structure:method, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
-{% if method.deprecated %}<wrap danger>deprecated</wrap> {% endif %}
-{% if (node.parent is not null and method.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
-{% if method.abstract %}<wrap warning>abstract</wrap> {% endif %}
-{% if method.final %}<wrap notice>final</wrap> {% endif %}
-<wrap notice>{{ method.visibility }}</wrap>
-{% if method.static %}<wrap warning>static</wrap> {% endif %}
-</WRAP>{# third column#}
-
-
-== {{  method.summary|replace({"\n":""})|raw }} ==
-<html>{{ method.description|markdown|raw }}</html>
-
-<code php>{% if method.abstract %}abstract {% endif %}{% if method.final %}final {% endif %}{{ method.visibility }} {% if method.static %}static {% endif %}{{ method.name }}({% for argument in method.arguments %}{{ argument.isVariadic ? '...' }}{{ argument.name }}{{ argument.default ? (' = '~argument.default)|raw }}{% if not loop.last %}, {% endif %}{% endfor %})</code>
-
-<WRAP twothirds column >
-
-
-=== Parameters ===
-{% if method.arguments|length > 0 -%}
-^ types ^ name ^ default ^ description ^
-{% for argument in method.arguments -%}
-| **<nowiki>{{ argument.types|join('|')|raw }}</nowiki>** | {{ argument.name }} {{ argument.isVariadic ? '<small style="color: gray">variadic</small>' }}  |   <nowiki>{{ argument.default|raw }}</nowiki>   | {{ argument.description|trim|replace("\n", ' ')|raw }} |{{ "\r\n" }}
-{%- endfor %}
-{% else %}
-//none//
-{% endif %}
-
-
-{#=== Parameters ===#}
-{#{% if method.arguments|length > 0 -%}#}
-{#{% for argument in method.arguments -%}#}
-{#== {{ argument.name }} ==#}
-
-
-{#{% set varDesc %}#}
-    {#<span style="margin:0 10px; 0 20px; font-weight: bold;">{{ argument.types|join('|') }}</span>#}
-    {#{{ argument.isVariadic ? '<small style="color: gray">variadic</small>' }}#}
-    {#{{ argument.description|raw }}#}
-{#{% endset %}#}
-{#<html>{{ varDesc|markdown|raw }}</html>#}
-{#{%- endfor %}#}
-{#{% else %}#}
-{#<wrap tip>This method has no parameter</wrap>#}
-{#{% endif %}#}
-
-
-{% if method.response and method.response.types|join() != 'void' %}
-=== Returns ===
-<html>{{ ('**' ~ method.response.types|join('|')|trim ~ '** ' ~ method.response.description)|markdown|raw }}</html>
-{% endif %}
-
-</WRAP>{# twothirds column#}
-
-<WRAP third column >
-
-{% if method.tags.throws|length > 0 or method.tags.throw|length > 0 %}
-=== Throws ===
-{% for exception in method.tags.throws -%}
-{% if loop.length > 1 %}  * {% endif %}''{{ exception.types|join('|')|raw }}'' <nowiki>{{ exception.description|raw }}</nowiki>
-{% endfor %}
-{% endif %}
-
-{% include 'includes/inherited-from.txt.twig' with {structure:method} %}
-
-{% include 'includes/see-also.txt.twig' with {structure:method, title_level: '==='} %}
-
-{% include 'includes/uses.txt.twig' with {structure:method, title_level: '==='} %}
-
-{% include 'includes/used-by.txt.twig' with {structure:method, title_level: '==='} %}
-
-{% include 'includes/tags-with-description.txt.twig' with {structure:method, title_level: '===', WRAP: 'info', tagsWithDescription: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
-
-{% include 'includes/tags.txt.twig' with {structure:method, title_level: '===', blacklist:  ['todo', 'link', 'see', 'abstract', 'example', 'param', 'return', 'access', 'deprecated', 'throws', 'throw', 'uses', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'used-by', 'inheritdoc', 'code-example']} %}
-
-</WRAP>{# third column#}
-
-
-
-{% include 'includes/code-examples.txt.twig' with {structure:method, title_level: '==='} %}
-
-</WRAP>{# group #}
-
-
-
-
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/elements/property.txt.twig

@@ -1,49 +0,0 @@
-{% block property %}
-
-<WRAP group box>
-<WRAP twothirds column >
-==== ${{ property.name }} ====
-</WRAP>{# twothirds column#}
-
-<WRAP third column>
-{% if property.deprecated %}<wrap danger>deprecated</wrap> {% endif %}
-{% if (node.parent is not null and property.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
-</WRAP>{# third column#}
-
-
-
-
-== {{ property.summary|replace({"\n":""})|raw }} ==
-<html>{{ property.description|markdown|raw }}</html>
-{% if property.var.0.description %}<html>{{ property.var.0.description|markdown|raw }}</html>{% endif %}
-
-
-
-{#{% if property.types %}#}
-{#== Type ==#}
-{#{% for type in property.types  %}#}
-{#{% if loop.length > 1 %}  * {% endif %}{{ type|raw }} : {{ type.description|raw }}#}
-{#{% endfor %}#}
-{#{{ property.types|join('|')|raw }}#}
-{#{% endif %}#}
-
-
-{% if property.deprecated %}
-== Deprecated ==
-  {{ property.tags.deprecated[0].description }}
-{% endif %}
-
-{% include 'includes/inherited-from.txt.twig' with {structure:property} %}
-
-{% include 'includes/see-also.txt.twig' with {structure:property, title_level: '=='} %}
-
-{% include 'includes/uses.txt.twig' with {structure:property, title_level: ''} %}
-
-{% include 'includes/tags.txt.twig' with {structure:property, title_level: '==', blacklist:  ['link', 'see', 'access', 'var', 'deprecated', 'uses', 'todo', 'code-example']} %}
-
-
-<code php>{{ property.visibility }}  ${{ property.name }}{% if property.types %} : {{ property.types|join('|')|raw }}{% endif %}</code>
-
-</WRAP>{# group #}
-
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/file.source.txt.twig

@@ -1 +0,0 @@
-{{ node.source|raw }}

.doc/phpdoc-templates/combodo-wiki/file.txt.twig

@@ -1,122 +0,0 @@
-{% extends 'layout.txt.twig' %}
-
-{% block javascripts %}
-
-{% endblock %}
-
-{% block content %}
-    {#<section class="row-fluid">#}
-        {#<div class="span2 sidebar">#}
-            {#{% set namespace = project.namespace %}#}
-            {#{{ block('sidebarNamespaces') }}#}
-        {#</div>#}
-    {#</section>#}
-    {#<section class="row-fluid">#}
-====== {{ node.path|split('/')|slice(0,-1)|join('/') }}{{ node.name }} ======
-{{ node.summary }}
-<html>{{ node.description|markdown|raw }}</html>
-
-{% if node.traits|length > 0 %}
-
-===== Traits =====
-{% for trait in node.traits %}
-    <tr>
-        <td>{{ trait|raw }}</td>
-        <td><em>{{ trait.summary }}</em></td>
-    </tr>
-{% endfor %}
-{% endif %}
-
-
-{% if node.interfaces|length > 0 %}
-===== Interfaces =====
-    {% for interface in node.interfaces %}
-        <tr>
-            <td>{{ interface|raw }}</td>
-            <td><em>{{ interface.summary }}</em></td>
-        </tr>
-    {% endfor %}
-{% endif %}
-
-{% if node.classes|length > 0 %}
-===== Classes =====
-{% for class in node.classes %}
-{{ class|raw }}
-<em>{{ class.summary }}</em>
-{% endfor %}
-{% endif %}
-
-{% if node.package is not empty and node.package != '\\' %}
-    ===== Package =====
-    {{ node.subpackage ? (node.package ~ '\\' ~ node.subpackage) : node.package }}
-{% endif %}
-
-{% for tagName,tags in node.tags if tagName in ['link', 'see'] %}
-    {% if loop.first %}
-        ===== See also =====
-    {% endif %}
-    {% for tag in tags %}
-        <dd><a href="{{ tag.reference ?: tag.link }}"><div class="namespace-wrapper">{{ tag.description ?: tag.reference }}</div></a></dd>
-    {% endfor %}
-{% endfor %}
-
-                    <h2>Tags</h2>
-                    <table class="table table-condensed">
-                        {% for tagName,tags in node.tags if tagName not in ['link', 'see', 'package', 'subpackage'] %}
-                            <tr>
-                                <th>
-                                    {{ tagName }}
-                                </th>
-                                <td>
-                                    {% for tag in tags %}
-                                        {{ tag.description|markdown|raw }}
-                                    {% endfor %}
-                                </td>
-                            </tr>
-                        {% else %}
-                            <tr><td colspan="2"><em>None found</em></td></tr>
-                        {% endfor %}
-                    </table>
-
-                </aside>
-            </div>
-
-            {% if node.constants|length > 0 %}
-            <div class="row-fluid">
-                <section class="span8 content file">
-                    <h2>Constants</h2>
-                </section>
-                <aside class="span4 detailsbar"></aside>
-            </div>
-
-                {% for constant in node.constants %}
-                    {{ block('constant') }}
-                {% endfor %}
-            {% endif %}
-
-            {% if node.functions|length > 0 %}
-            <div class="row-fluid">
-                <section class="span8 content file">
-                    <h2>Functions</h2>
-                </section>
-                <aside class="span4 detailsbar"></aside>
-            </div>
-
-                {% for method in node.functions %}
-                    {{ block('method') }}
-                {% endfor %}
-            {% endif %}
-
-        </div>
-    </section>
-
-    <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
-        <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
-            <h3 id="source-view-label">{{ node.file.name }}</h3>
-        </div>
-        <div class="modal-body">
-            <pre data-src="{{ path('files/' ~ node.path ~ '.txt')|raw }}" class="language-php line-numbers"></pre>
-        </div>
-    </div>
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/graphs/class.html.twig

@@ -1,42 +0,0 @@
-{% extends 'layout.html.twig' %}
-
-{% block stylesheets %}
-    <link href="{{ path('css/jquery.iviewer.css') }}" rel="stylesheet" media="all"/>
-    <style>
-        #viewer {
-            position: relative;
-            width: 100%;
-        }
-        .wrapper {
-            overflow: hidden;
-        }
-    </style>
-{% endblock %}
-
-{% block javascripts %}
-    <script src="{{ path('js/jquery.mousewheel.js') }}" type="text/javascript"></script>
-    <script src="{{ path('js/jquery.iviewer.js') }}" type="text/javascript"></script>
-    <script type="text/javascript">
-        $(window).resize(function(){
-            $("#viewer").height($(window).height() - 100);
-        });
-
-        $(document).ready(function() {
-            $("#viewer").iviewer({src: '{{ path('graphs/classes.svg') }}', zoom_animation: false});
-            $('#viewer img').bind('dragstart', function(event){
-                event.preventDefault();
-            });
-            $(window).resize();
-        });
-    </script>
-{% endblock %}
-
-{% block content %}
-    <div class="row-fluid">
-        <div class="span12">
-            <div class="wrapper">
-                <div id="viewer" class="viewer"></div>
-            </div>
-        </div>
-    </div>
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/htaccess.dist

@@ -1,5 +0,0 @@
-# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt
-<FilesMatch \.php\.txt$>
-    RemoveHandler .php
-    ForceType text/plain
-</FilesMatch>

.doc/phpdoc-templates/combodo-wiki/includes/code-examples.txt.twig

@@ -1,34 +0,0 @@
-{% if title_level is not defined %}
-    {%- set title_level = '==' -%}
-{% endif %}
-
-{% if sub_title_level is not defined %}
-    {%- set sub_title_level = title_level|slice(1) -%}
-{% endif %}
-{% if sub_title_level == '=' %}
-    {%- set sub_title_level = '' -%}
-{% endif %}
-
-{#{% for tagName,tags in structure.tags if tagName in ['code-example'] %}#}
-{#{% if loop.first %}#}
-{#{{title_level}} Examples {{title_level}}#}
-{#{% endif %}#}
-{#{% for tag in tags %}#}
-{#{%- set descToken = tag.description|split("\n", 2) -%}#}
-{#{%- set title = descToken[0] -%}#}
-{#{%- set code = descToken[1] -%}#}
-{#{{sub_title_level}} {{ title }} {{sub_title_level}}#}
-{#<code php>{{ code|raw }}</code>#}
-{#{% endfor %}#}
-{#{% endfor %}#}
-
-
-{% for tagName,tags in structure.tags if tagName in ['example'] %}
-{% if loop.first %}
-{{title_level}} Examples {{title_level}}
-{% endif %}
-{% for tag in tags %}
-{{ sub_title_level }} {{ tag.filePath|escape }}{{ sub_title_level }}
-<code php>{{ tag.description|raw }}</code>
-{% endfor %}
-{% endfor %}

.doc/phpdoc-templates/combodo-wiki/includes/inherited-from.txt.twig

@@ -1,12 +0,0 @@
-{% if title_level is not defined %}
-    {% set title_level='' %}
-{% endif %}
-
-{% if (node.parent is null) %}
-{{title_level}} File {{ structure.path }} {{title_level}}
-{% endif %}
-
-{% if (node.parent is not null and structure.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}
-{{title_level}} Inherited from {{title_level}}
-[[{{structure.parent}}|{{structure.parent}}]]
-{% endif %}

.doc/phpdoc-templates/combodo-wiki/includes/namespace-structure-toc.html.twig

@@ -1,26 +0,0 @@
-{% for structure in structures|sort_asc if structure.tags['internal'] is not defined and (structure.tags['api'] is defined or structure.tags['api-advanced'] is  defined or structure.tags['overwritable-hook'] is  defined or structure.tags['extension-hook'] is  defined ) %}
-{#{{ structure|raw }}#}
-
-{% set structureName = structure|trim('\\', 'left') %}
-
-<WRAP group box>
-<WRAP twothirds column >
-==== {{ structureName }} ====
-</WRAP>{# twothirds column#}
-
-<WRAP third column>
-{% if structure.deprecated %}<wrap danger>deprecated</wrap>{% endif %}
-{% if structure.abstract %}<wrap warning>abstract</wrap>{% endif %}
-{% if structure.final %}<wrap notice>final</wrap>{% endif %}
-{% if (node.parent is not null and structure.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
-{% include 'includes/wrap-tags.txt.twig' with {structure:structure, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
-</WRAP>{# third column#}
-
-
-{{ structure.summary|raw }}
-[[{{structureName}}|More information]]
-
-</WRAP>{# group #}
-
-{% endfor %}
-

.doc/phpdoc-templates/combodo-wiki/includes/see-also.txt.twig

@@ -1,26 +0,0 @@
-{% if title_level is not defined %}
-    {%- set title_level='==' -%}
-{% endif %}
-{% for tagName,tags in structure.tags if tagName in ['link', 'see'] %}
-{% if loop.first %}
-{{title_level}} See also {{title_level}}
-{% endif %}
-{% for tag in tags %}
-{%- set linkTag = tag.reference|trim('\\', 'left') -%}
-{% if not('()' in linkTag or '$' in linkTag or node.name in linkTag or  '::' in linkTag ) %}
-    {%- set linkTag = linkTag|lower -%}
-{% elseif node.name~'::' in linkTag %}
-    {%- set linkTag = linkTag|replace({(node.name~'::'): '#'})|lower -%}
-{% elseif '::' in linkTag -%}
-    {%- set linkTag = linkTag|replace({'::': '#'})|lower -%}
-{% else %}
-    {%- set linkTag = '#' ~ linkTag|lower -%}
-{%- endif %}
-
-{% if loop.length > 1 %}  * {% endif %}{% if tag.reference is not empty -%}
-    [[{{linkTag}}|{{ (tag.reference)|trim('\\', 'left') }}]] {% if tag.description|trim is not empty %}: {{ tag.description|trim('\\', 'left') }} {% endif %}
-{%- else -%}
-    {#{{ tag.description|trim('\\', 'left') }}#}
-{% endif %}
-{% endfor %}
-{% endfor %}

.doc/phpdoc-templates/combodo-wiki/includes/tag-synthesys.txt.twig

@@ -1,56 +0,0 @@
-{% if tag is not defined -%}
-    {# Do not display @api if @api-advanced is also present #}
-    {%- set tag = "api" -%}
-{%- endif %}
-
-{% if hidden_by is not defined -%}
-    {# Do not display @api if @api-advanced is also present #}
-    {%- set hidden_by = {"api" : "api-advanced"} -%}
-{%- endif %}
-
-
-
-{% for method in methods|sort_asc
-    if (method.visibility == 'public')
-    and (
-        method.tags[tag] is defined
-        and (
-            hidden_by[tag] is not defined or method.tags[hidden_by[tag]] is not defined
-        )
-    )
-%}
-{%- if loop.first %}
-{% if tag == 'api' %}
-===== API synthesis =====
-<WRAP>
-List of the public API methods.
-When manipulating {{ node.name }}, You can call those methods:
-</WRAP>
-{% elseif tag == 'api-advanced' %}
-===== Advanced API synthesis =====
-<WRAP>
-List of advanced API methods
-Beware they usage is recommended to advanced users only.
-</WRAP>
-{% elseif tag == 'overwritable-hook' %}
-===== overwritable-hook synthesis =====
-<WRAP >When inheriting from {{ node.name }},
-you can overwrite those methods in order to add custom logic:
-</WRAP>
-{% elseif tag == 'extension-hook' %}
-===== extension-hook synthesis =====
-<WRAP >
-When inheriting from {{ node.name }},
-you can extend the behaviour of iTop by implementing:
-</WRAP>
-{% endif %}
-{% endif %}
-{% set sanitizedMethod = method|trim('\\', 'left')|replace({(node.name~'::'): ''}) %}
-{% if '::' in sanitizedMethod -%}
-{%- if node.tags['phpdoc-tuning-exclude-inherited'] is not defined %}
-  * [[{{sanitizedMethod|replace({'::': '#'})|lower}}|↪{{sanitizedMethod}}]] — {{  method.summary|replace({"\n":""})|raw }}
-{% endif %}
-{%- else %}
-  * [[#{{sanitizedMethod}}|{{sanitizedMethod}}]] — {{  method.summary|replace({"\n":""})|raw }}
-{% endif %}
-{% endfor %}

.doc/phpdoc-templates/combodo-wiki/includes/tags-with-description.txt.twig

@@ -1,20 +0,0 @@
-{% if title_level is not defined %}
-    {% set title_level = '==' %}
-{% endif %}
-
-
-{%- for tagName,tags in structure.tags if tagName in tagsWithDescription -%}
-    {%- for tag in tags -%}
-        {%- if tag.description is not empty -%}
-{%- if WRAP is defined -%}
-    <WRAP {{WRAP}}>
-{%- endif -%}
-{{title_level}} {{ tagName }} {{title_level}}
-{{ tag.description|escape }}
-{%- if WRAP is defined -%}
-    </WRAP>
-{%- endif -%}
-        {%- endif -%}
-    {%- endfor -%}
-{%- endfor -%}
-

.doc/phpdoc-templates/combodo-wiki/includes/tags.txt.twig

@@ -1,22 +0,0 @@
-{% if title_level is not defined %}
-    {% set title_level='=====' %}
-{% endif %}
-
-{% if blacklist is not defined %}
-    {% set blacklist =['link', 'see', 'abstract', 'example', 'method', 'property', 'property-read', 'property-write', 'package', 'subpackage', 'api', 'api-advanced', 'todo', 'code-example'] %}
-{% endif %}
-{% if hidden_by is not defined -%}
-    {# Do not display @api if @api-advanced is also present #}
-    {%- set hidden_by = {"api" : "api-advanced"} -%}
-{%- endif %}
-
-{#^ {% for tagName,tags in structure.tags if tagName not in blacklist -%}#}
-{#{{ tagName }} ^#}
-{#{%- endfor %}#}
-
-{% for tagName,tags in structure.tags if tagName not in blacklist and (hidden_by[tagName] is not defined or structure.tags[hidden_by[tagName]] is not defined) %}
-{%- if loop.first %}
-{{title_level}} Tags {{title_level}}
-{% endif %}
-^ {{ tagName }} | {% for tag in tags %}{{ tag.version ? tag.version ~ ' '  : '' }}{{ tag.description}}{% endfor %}   |
-{% endfor %}

.doc/phpdoc-templates/combodo-wiki/includes/used-by.txt.twig

@@ -1,24 +0,0 @@
-{% if title_level is not defined %}
-    {% set title_level='' %}
-{% endif %}
-{% for tagName,tags in structure.tags if tagName in ['used-by'] %}
-{% if loop.first %}
-{{title_level}} Used by {{title_level}}
-{% endif %}
-{% for tag in tags %}
-{% if loop.length > 1 %}  * {% endif %}{{ tag.reference ?: tag.link }} : {{ tag.description ?: tag.reference }}
-{% endfor %}
-{% endfor %}
-
-
-
-
-
-{#{% for tagName,tags in method.tags if tagName in ['uses'] %}#}
-    {#{% if loop.first %}#}
-        {#<dt>Uses</dt>#}
-    {#{% endif %}#}
-    {#{% for tag in tags %}#}
-        {#<dd>{{ tag.reference|raw }}</dd>#}
-    {#{% endfor %}#}
-{#{% endfor %}#}

.doc/phpdoc-templates/combodo-wiki/includes/uses.txt.twig

@@ -1,24 +0,0 @@
-{% if title_level is not defined %}
-    {% set title_level='' %}
-{% endif %}
-{% for tagName,tags in structure.tags if tagName in ['uses'] %}
-{% if loop.first %}
-{{title_level}} Uses {{title_level}}
-{% endif %}
-{% for tag in tags %}
-{% if loop.length > 1 %}  * {% endif %}{{ tag.reference ?: tag.link }} : {{ tag.description ?: tag.reference }}
-{% endfor %}
-{% endfor %}
-
-
-
-
-
-{#{% for tagName,tags in method.tags if tagName in ['uses'] %}#}
-    {#{% if loop.first %}#}
-        {#<dt>Uses</dt>#}
-    {#{% endif %}#}
-    {#{% for tag in tags %}#}
-        {#<dd>{{ tag.reference|raw }}</dd>#}
-    {#{% endfor %}#}
-{#{% endfor %}#}

.doc/phpdoc-templates/combodo-wiki/includes/wrap-tags.txt.twig

@@ -1,11 +0,0 @@
-{% if wrap is not defined -%}
-    {% set wrap = 'notice' %}
-{%- endif -%}
-{% if hidden_by is not defined -%}
-    {# Do not display @api if @api-advanced is also present #}
-    {%- set hidden_by = {"api" : "api-advanced"} -%}
-{%- endif %}
-
-{%- for tagName,tags in structure.tags if tagName in wrapTags and (hidden_by[tagName] is not defined or structure.tags[hidden_by[tagName]] is not defined) %}
- <wrap {{wrap}}>{{tagName}}</wrap>
-{% endfor %}

.doc/phpdoc-templates/combodo-wiki/interface.txt.twig

@@ -1,121 +0,0 @@
-{% extends 'layout.txt.twig' %}
-
-{% block content %}
-<wrap button>[[start|🔙 Back]]</wrap>
-
-{% if node.tags['internal'] is defined %}
-====== {{ node.name }} ======
-<WRAP alert>This interface is "internal", and thus is not documented!</WRAP>
-{% elseif node.tags['api'] is not defined and node.tags['api-advanced'] is not defined and node.tags['overwritable-hook'] is not defined and node.tags['extension-hook'] is not defined %}
-====== {{ node.name }} ======
-<WRAP alert>This interface is neither "api", "overwritable-hook" or "extension-hook", and thus is not documented!</WRAP>
-{% else %}
-
-====== {{ node.name }} ======
-
-{% if node.deprecated %}<wrap danger>deprecated</wrap>{% endif %}
-{% if node.abstract %}<wrap warning>abstract</wrap>{% endif %}
-{% if node.final %}<wrap notice>final</wrap>{% endif %}
-{% include 'includes/wrap-tags.txt.twig' with {structure:node, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
-
-
-
-{% if node.deprecated %}
-=== **<del>Deprecated</del>**===
-//{{ node.tags.deprecated[0].description }}//
-{% endif %}
-
-
-== {{  node.summary|replace({"\n":""})|raw }} ==
-<html>{{ node.description|markdown|raw }}</html>
-
-
-{% include 'includes/code-examples.txt.twig' with {structure:node, title_level: '====='} %}
-
-
-{% set class = node.parent %}
-{% block hierarchy_element %}
-
-{% if class and class.name is defined and class.name|trim != '' %}
-==== parent ====
-{% set child = class %}
-{% set class = class.parent %}
-{{ block('hierarchy_element') }}
-[[{{ child.name }}|{{ child.name }}]]
-{% endif %}
-{% endblock %}
-
-
-{% for interface in node.interfaces|sort_asc %}
-{% if loop.first %}
-==== Implements ====
-{% endif %}
-{% if loop.length > 1 %}  * {% endif %}{{ interface.fullyQualifiedStructuralElementName ?: interface }}
-{% endfor %}
-
-
-{% for trait in node.usedTraits|sort_asc %}
-{% if loop.first %}
-==== Uses traits ====
-{% endif %}
-{% if loop.length > 1 %}  * {% endif %}{{ trait.fullyQualifiedStructuralElementName ?: trait }}
-{% endfor %}
-
-
-{% include 'includes/see-also.txt.twig' with {structure:node, title_level: '==='} %}
-
-{% include 'includes/tags.txt.twig' with {structure:node, title_level: '=====', blacklist:  ['link', 'see', 'abstract', 'example', 'method', 'property', 'property-read', 'property-write', 'package', 'subpackage', 'phpdoc-tuning-exclude-inherited', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'copyright', 'license', 'code-example']} %}
-
-
-{% set methods = node.inheritedMethods.merge(node.methods) %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api'} %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api-advanced'} %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'overwritable-hook'} %}
-{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'extension-hook'} %}
-
-<WRAP clear />
-
-
-{% for method in methods|sort_asc if method.visibility == 'public' %}
-{%- if loop.first %}
-===== Public methods =====
-{% endif %}
-{{ block('method') }}
-{% endfor %}
-{% for method in methods|sort_asc if method.visibility == 'protected' %}
-{%- if loop.first %}
-===== Protected methods =====
-{% endif %}
-{{ block('method') }}
-{% endfor %}
-
-
-
-{% set constants = node.inheritedConstants.merge(node.constants) %}
-{% if constants|length > 0 %}
-===== Constants =====
-{% for constant in constants|sort_asc %}
-{{ block('constant') }}
-{% endfor %}
-{% endif %}
-
-
-{#{% set properties = node.inheritedProperties.merge(node.properties) %}#}
-{#{% for property in properties|sort_asc if property.visibility == 'public' %}#}
-{#{%- if loop.first %}#}
-{#===== Public properties =====#}
-{#{% endif %}#}
-{#{{ block('property') }}#}
-{#{% endfor %}#}
-{#{% for property in properties|sort_asc if property.visibility == 'protected' %}#}
-{#{%- if loop.first %}#}
-{#===== Protected properties =====#}
-{#{% endif %}#}
-{#{{ block('property') }}#}
-{#{% endfor %}#}
-
-
-{%- endif %} {#{% elseif node.tags['xxx'] is not defined and ... #}
-
-<wrap button>[[start|🔙 Back]]</wrap>
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/layout.txt.twig

@@ -1,5 +0,0 @@
-{% use 'elements/constant.txt.twig' %}
-{% use 'elements/property.txt.twig' %}
-{% use 'elements/method.txt.twig' %}
-
-{% block content %}{% endblock %}

.doc/phpdoc-templates/combodo-wiki/namespace.txt.twig

@@ -1,51 +0,0 @@
-{% extends 'layout.txt.twig' %}
-
-{% block content %}
-{% set namespace = project.namespace %}
-{{ block('sidebarNamespaces') }}
-     
-{#{{ node.parent|raw }}#}
-{#====== {{ node.parent.fullyQualifiedStructuralElementName }}{{ node.name }} ======#}
-
-{% if node.children|length > 0 %}
-=====Namespaces=====
-{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.children} %}
-----
-{% endif %}
-
-{% if node.traits|length > 0 %}
-===== Traits =====
-{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.traits} %}
-----
-{%- endif %}
-
-{% if node.interfaces|length > 0 %}
-===== Interfaces =====
-{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.interfaces} %}
-----
-{% endif %}
-
-{% if node.classes|length > 0 %}
-===== Classes =====
-{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.classes} %}
-----
-{% endif %}
-
-
-
-{#{% if node.constants|length > 0 %}#}
-{#===== Constants =====#}
-{#{% for constant in node.constants|sort_asc %}#}
-{#    {{ block('constant') }}#}
-{#{% endfor %}#}
-{#{% endif %}#}
-
-{#{% if node.functions|length > 0 %}#}
-{#===== Functions =====#}
-
-{#{% for method in node.functions|sort_asc %}#}
-{#    {{ block('method') }}#}
-{#{% endfor %}#}
-{#{% endif %}#}
-
-{% endblock %}

.doc/phpdoc-templates/combodo-wiki/reports/deprecated.html.twig

@@ -1,49 +0,0 @@
-
-====== Deprecated elements ======
-
-{#{% for element in project.indexes.elements if element.deprecated %}#}
-    {#{% if element.file.path != previousPath %}#}
-        {#<li><a href="#{{ element.file.path }}"><i class="icon-file"></i> {{ element.file.path }}</a></li>#}
-    {#{% endif %}#}
-    {#{% set previousPath = element.file.path %}#}
-{#{% endfor %}#}
-
-{% for element in project.indexes.elements if element.deprecated %}
-    {% if element.file.path != previousPath %}
-    {% if previousPath %}
-</WRAP>{# group #}
-    {% endif %}
-    {#<a name="{{ element.file.path }}" id="{{ element.file.path }}"></a>#}
-===== {{ element.file.path }} ({{ element.tags.deprecated.count }} found)=====
-
-<WRAP group >
-<WRAP third column >
-Element
-</WRAP>{# third column#}
-<WRAP third column >
-Line
-</WRAP>{# third column#}
-<WRAP third column >
-Description
-</WRAP>{# third column#}
-
-{% endif %}
-{% for tag in element.tags.deprecated %}
-<WRAP group >
-<WRAP third column >
-    {{ element.fullyQualifiedStructuralElementName }}
-</WRAP>{# third column#}
-<WRAP third column >
-    {{ element.line }}
-</WRAP>{# third column#}
-<WRAP third column >
-    {{ tag.description }}
-</WRAP>{# third column#}
-
-{% endfor %}
-</WRAP>{# group #}
-{% set previousPath = element.file.path %}
-{% else %}
-<WRAP info>No deprecated elements have been found in this project.</WRAP>
-{% endfor %}
-

.doc/phpdoc-templates/combodo-wiki/template.xml

@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<template>
-  <author>Bruno DA SILVA</author>
-  <email>contact [at] combodo.com</email>
-  <version>1.0.0</version>
-  <copyright>Combodo 2018</copyright>
-  <description><![CDATA[
-
-      Forked from the clean theme of https://github.com/phpDocumentor/phpDocumentor2 provided under the MIT licence.
-      The original work is copyright "Mike van Riel".
-
-      ------------------------------------------------------------------------------------------------------------------
-
-      To improve performance you can add the following to your .htaccess:
-
-      <ifModule mod_deflate.c>
-          <filesMatch "\.(js|css|html)$">
-              SetOutputFilter DEFLATE
-          </filesMatch>
-      </ifModule>
-  ]]></description>
-  <transformations>
-    <transformation writer="twig" query="namespace" source="templates/combodo-wiki/namespace.txt.twig" artifact="start.txt"/>
-    <transformation writer="twig" query="indexes.classes" source="templates/combodo-wiki/class.txt.twig" artifact="{{name}}.txt"/>
-    <transformation writer="twig" query="indexes.interfaces" source="templates/combodo-wiki/interface.txt.twig" artifact="{{name}}.txt" />
-  </transformations>
-</template>

.github/pull_request_template.md

@@ -0,0 +1,83 @@
+<!--
+
+IMPORTANT: Please follow the guidelines within this PR template before submitting it, it will greatly help us process your PR. 🙏
+
+Any PRs not following the guidelines or with missing information will not be considered.
+
+-->
+
+## Base information
+| Question                                                      | Answer 
+|---------------------------------------------------------------|--------
+| Related to a SourceForge thead / Another PR / Combodo ticket? | <!-- Put the URL -->
+| Type of change?                                               | Bug fix / Enhancement / Translations
+
+
+## Symptom (bug) / Objective (enhancement)
+<!--
+If it's a bug
+  - Explain the symptom in details
+  - If possible put error messages, logs or screenshots (you can paste image directly in this editor).
+
+If it's an enhancement
+  - Describe what is blocking you, what is the objective with as much details as possible.
+  - Add screenshots if it's related to UI.
+-->
+
+
+## Reproduction procedure (bug)
+<!--
+Remove this section only if it's NOT a bug.
+
+Otherwise, explain step by step how to reproduce the issue on a standard iTop Community.
+
+If it requires a custom datamodel, provide the minimal XML delta to reproduce it on a standard iTop Community.
+-->
+
+1. On iTop x.y.z <!-- Put complete iTop version (eg. 3.1.0-2) -->
+2. With PHP x.y.z <!-- Put complete PHP version (eg. 8.1.24) -->
+2. First go there
+2. Then do that
+3. ...
+4. Finally, see that...
+
+
+## Cause (bug)
+<!--
+Remove this section only if it's NOT a bug.
+
+Otherwise, explain what is the cause of the issue (where in the code and why)
+-->
+
+
+## Proposed solution (bug and enhancement)
+<!--
+Explain in details how you are proposing to solve this:
+  - What did you do in the code and why
+  - If you changed something in the UI, put before / after screenshots (you can paste image directly in this editor)
+-->
+
+
+## Checklist before requesting a review
+<!--
+Don't remove these lines, check them once done.
+-->
+- [ ] I have performed a self-review of my code
+- [ ] I have tested all changes I made on an iTop instance
+- [ ] I have added a unit test, otherwise I have explained why I couldn't
+- [ ] Is the PR clear and detailed enough so anyone can understand digging in the code?
+
+## Checklist of things to do before PR is ready to merge
+<!--
+Things that needs to be done in the PR before it can be considered as ready to be merged
+
+Examples:
+- Changes requested in the review
+- Unit test to add
+- Dictionary entries to translate
+- ...
+-->
+
+- [ ] ...
+- [ ] ...
+- [ ] ...

.github/workflows/action.yml

@@ -0,0 +1,43 @@
+name: Add PRs to Combodo PRs Dashboard
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add PR to Combodo Project
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if author is a member of the organization
+        id: check-membership
+        run: |
+          ORG="Combodo"
+          AUTHOR=$(jq -r .pull_request.user.login "$GITHUB_EVENT_PATH")
+          RESPONSE=$(curl -s -o /dev/null -w "%{http_code}" -H "Authorization: token ${{ secrets.PR_AUTOMATICALLY_ADD_TO_PROJECT }}" \
+            "https://api.github.com/orgs/$ORG/members/$AUTHOR")
+          if [ "$RESPONSE" == "404" ]; then
+            echo "project_url=https://github.com/orgs/Combodo/projects/5" >> $GITHUB_ENV
+            echo "is_member=false" >> $GITHUB_ENV
+          else
+            echo "project_url=https://github.com/orgs/Combodo/projects/4" >> $GITHUB_ENV
+            echo "is_member=true" >> $GITHUB_ENV
+
+          fi
+
+      - name: Add internal tag if member
+        if: env.is_member == 'true'
+        run: |
+          curl -X POST -H "Authorization: token ${{ secrets.PR_AUTOMATICALLY_ADD_TO_PROJECT }}" \
+            -H "Accept: application/vnd.github.v3+json" \
+            https://api.github.com/repos/Combodo/iTop/issues/${{ github.event.pull_request.number }}/labels \
+            -d '{"labels":["internal"]}'
+        env:
+          is_member: ${{ env.is_member }}
+
+      - name: Add PR to the appropriate project
+        uses: actions/add-to-project@v1.0.2
+        with:
+          project-url: ${{ env.project_url }}
+          github-token: ${{ secrets.PR_AUTOMATICALLY_ADD_TO_PROJECT }}

.gitignore

@@ -47,6 +47,12 @@ tests/*/vendor/*
 !/log/index.php
 !/log/web.config
 
+# NPM: `jquery-ui` package is just there for vulnerability scans, so we don't want to version its files (only `jquery-ui-dist` is used within the code base)
+/node_modules/jquery-ui/**
+
+# Symfony: Local env file
+/resources/symfony/.env.local
+
 # PHPUnit: Cache file, local XML working copies
 /tests/php-unit-tests/.phpunit.result.cache
 /tests/php-unit-tests/phpunit.xml

.make/build/afterBuild.php

@@ -4,7 +4,7 @@ $iBeginTime = time();
 chdir(__DIR__);
 
 $aCommands = [
-	'php composer/rmDeniedTestDir.php',
+	'php composer/rmUnnecessaryFolders.php',
 	'php build/commands/setupCssCompiler.php',
 //	'bash /tmp/gabuzomeu.sh',
 ];
@@ -22,13 +22,13 @@ $iElapsed = time() - $iBeginTime;
 
 if (count($aFailedCommands))
 {
-	fwrite(STDERR, "\nafterBuild execution failed! (in ${iElapsed}s)\n");
+	fwrite(STDERR, "\nafterBuild execution failed! (in {$iElapsed}s)\n");
 	fwrite(STDERR, "List of failling commands:\n - " . implode("\n - ", $aFailedCommands) . "\n");
 	exit(1);
 }
 
 
-echo "\nDone (${iElapsed}s)\n";
+echo "\nDone ({$iElapsed}s)\n";
 exit(0);
 
 /**
@@ -74,7 +74,7 @@ function ExecCommand($cmd) {
 	}
 	else
 	{
-		echo "| elapsed:${iElapsed}s \n";
+		echo "| elapsed:{$iElapsed}s \n";
 	}
 
 	if (!empty($stderr))

.make/build/commands/setupCssCompiler.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright (C) 2010-2023 Combodo SARL
+ * Copyright (C) 2010-2024 Combodo SAS
  *
  *   This file is part of iTop.
  *
@@ -27,7 +27,7 @@ $iTopFolder = __DIR__."/../../../";
 require_once("$iTopFolder/approot.inc.php");
 require_once(APPROOT."/application/utils.inc.php");
 
-if (php_sapi_name() !== 'cli')
+if (PHP_SAPI !== 'cli')
 {
 	throw new \Exception('This script can only run from CLI');
 }
@@ -48,4 +48,4 @@ if (!file_exists($sCssFile))
 {
 	fwrite(STDERR, "Failed to compile $sCssFile, exiting.");
 	exit(1);
-}
+}

.make/composer/rmDeniedTestDir.php

@@ -1,73 +0,0 @@
-<?php
-/**
- * Copyright (C) 2010-2023 Combodo SARL
- *
- *   This file is part of iTop.
- *
- *   iTop is free software; you can redistribute it and/or modify
- *   it under the terms of the GNU Affero General Public License as published by
- *   the Free Software Foundation, either version 3 of the License, or
- *   (at your option) any later version.
- *
- *   iTop is distributed in the hope that it will be useful,
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *   GNU Affero General Public License for more details.
- *
- *   You should have received a copy of the GNU Affero General Public License
- *   along with iTop. If not, see <http: *www.gnu.org/licenses/>
- *
- */
-
-use Combodo\iTop\Composer\iTopComposer;
-
-$iTopFolder = __DIR__ . "/../../" ;
-
-require_once ("$iTopFolder/approot.inc.php");
-require_once (APPROOT."/setup/setuputils.class.inc.php");
-
-if  (php_sapi_name() !== 'cli')
-{
-	throw new \Exception('This script can only run from CLI');
-}
-
-clearstatcache();
-
-$oiTopComposer = new iTopComposer();
-$aDeniedButStillPresent = $oiTopComposer->ListDeniedButStillPresent();
-
-echo "\n";
-foreach ($aDeniedButStillPresent as $sDir)
-{
-	if (false === iTopComposer::IsTestDir($sDir))
-	{
-		echo "ERROR found INVALID denied test dir: '$sDir'\n";
-		throw new \Exception("$sDir must end with /Test/ or /test/");
-	}
-
-	if (false === file_exists($sDir)) {
-		echo "INFO $sDir is in denied list, but not existing on disk => skipping !\n";
-		continue;
-	}
-
-	try {
-		SetupUtils::rrmdir($sDir);
-		echo "OK Remove denied test dir: '$sDir'\n";
-	}
-	catch (\Exception $e) {
-		echo "\nFAILED to remove denied test dir: '$sDir'\n";
-	}
-}
-
-
-$aAllowedAndDeniedDirs = array_merge(
-	$oiTopComposer->ListAllowedTestDir(),
-	$oiTopComposer->ListDeniedTestDir()
-);
-$aExistingDirs = $oiTopComposer->ListAllTestDir();
-$aMissing = array_diff($aExistingDirs, $aAllowedAndDeniedDirs);
-if (false === empty($aMissing)) {
-	echo "Some new tests dirs exists !\n"
-		.'  They must be declared either in the allowed or denied list in '.iTopComposer::class." (see N°2651).\n"
-		.'  List of dirs:'."\n".var_export($aMissing, true);
-}

.make/dependencies/composer/listOutdated.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (C) 2010-2023 Combodo SARL
+ * Copyright (C) 2010-2024 Combodo SAS
  *
  *   This file is part of iTop.
  *
@@ -26,7 +26,7 @@
  * @link https://getcomposer.org/doc/03-cli.md#show
  */
 
-$iTopFolder = __DIR__."/../../";
+$iTopFolder = __DIR__."/../../../";
 
 require_once("$iTopFolder/approot.inc.php");
 $sApproot = APPROOT;

.make/dependencies/composer/tcpdf/droidsansfallback.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (C) 2013-2023 Combodo SARL
+ * Copyright (C) 2013-2024 Combodo SAS
  *
  * This file is part of iTop.
  *

.make/dependencies/composer/tcpdf/tcpdfDefaultFontsToKeepInItop.txt

@@ -0,0 +1,56 @@
+courier.php
+courierb.php
+courierbi.php
+courieri.php
+dejavusans.ctg.z
+dejavusans.php
+dejavusans.z
+dejavusansb.ctg.z
+dejavusansb.php
+dejavusansb.z
+dejavusansbi.ctg.z
+dejavusansbi.php
+dejavusansbi.z
+dejavusanscondensed.ctg.z
+dejavusanscondensed.php
+dejavusanscondensed.z
+dejavusanscondensedb.ctg.z
+dejavusanscondensedb.php
+dejavusanscondensedb.z
+dejavusanscondensedbi.ctg.z
+dejavusanscondensedbi.php
+dejavusanscondensedbi.z
+dejavusanscondensedi.ctg.z
+dejavusanscondensedi.php
+dejavusanscondensedi.z
+dejavusansextralight.ctg.z
+dejavusansextralight.php
+dejavusansextralight.z
+dejavusansi.ctg.z
+dejavusansi.php
+dejavusansi.z
+dejavusansmono.ctg.z
+dejavusansmono.php
+dejavusansmono.z
+dejavusansmonob.ctg.z
+dejavusansmonob.php
+dejavusansmonob.z
+dejavusansmonobi.ctg.z
+dejavusansmonobi.php
+dejavusansmonobi.z
+dejavusansmonoi.ctg.z
+dejavusansmonoi.php
+dejavusansmonoi.z
+droidsansfallback.ctg.z
+droidsansfallback.php
+droidsansfallback.z
+helvetica.php
+helveticab.php
+helveticabi.php
+helveticai.php
+symbol.php
+times.php
+timesb.php
+timesbi.php
+timesi.php
+zapfdingbats.php

.make/dependencies/composer/tcpdf/tcpdfUpdateFonts.php

@@ -0,0 +1,101 @@
+<?php
+/**
+ * This script will copy custom fonts in the TCPDF lib fonts directory.
+ * If you need to add other files :
+ * - add the corresponding files in this script directory
+ * - modify this script to copy also your files
+ *
+ * @since 2.7.0 N°1947 add DroidSansFallback font (see also PR #49 in the links below)
+ * @since 2.7.0 N°2435 TCPPDF lib forked and added in composer.json (at that time the lib was announced as deprecated and rewritten in tecnickcom/tc-lib-pdf)
+ * @since 3.2.0 N°7175 switch back to TCPDF original lib (which is finally still maintained, tecnickcom/tc-lib-pdf us still under dev), script creation to keep custom DroidSansFallback font
+ *
+ * @link https://github.com/Combodo/iTop/pull/49 add DroidSansFallback font
+ * @link https://github.com/tecnickcom/TCPDF?tab=readme-ov-file#note TCPDF is in support only mode
+ */
+
+$sItopRootFolder = realpath(__DIR__ . "/../../../../");
+$sCurrentScriptFileName = basename(__FILE__);
+
+
+require_once ("$sItopRootFolder/lib/autoload.php");
+
+
+$sTcPdfRootFolder = $sItopRootFolder.'/lib/tecnickcom/tcpdf';
+if (false === file_exists($sTcPdfRootFolder)) {
+	echo $sCurrentScriptFileName.": No TCPDF lib detected, exiting !\n";
+	return;
+}
+$sTcPdfFontsFolder = $sTcPdfRootFolder.'/fonts/';
+
+
+/**
+ * 1) Cleaning up the fonts directory to keep only the ones we want in iTop
+ */
+echo $sCurrentScriptFileName.": ---1) Cleaning up the fonts files\n";
+$aTcpdfDefaultFontsToKeepInItop = file(__DIR__.'/tcpdfDefaultFontsToKeepInItop.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+
+$aTcpdfFontsDirContent = scandir($sTcPdfFontsFolder);
+foreach ($aTcpdfFontsDirContent as $sTcpdfFontResourceName) {
+	if ($sTcpdfFontResourceName === '.') {
+		continue;
+	}
+	if ($sTcpdfFontResourceName === '..') {
+		continue;
+	}
+
+	if (!in_array($sTcpdfFontResourceName, $aTcpdfDefaultFontsToKeepInItop, true)) {
+		echo $sCurrentScriptFileName.": Removing $sTcpdfFontResourceName !\n";
+
+		$sTcpdfFontResourceFullPath = $sTcPdfFontsFolder.$sTcpdfFontResourceName;
+		if (is_file($sTcpdfFontResourceFullPath)) {
+			unlink($sTcpdfFontResourceFullPath);
+		} elseif (is_dir($sTcpdfFontResourceFullPath)) {
+			rrmdir($sTcpdfFontResourceFullPath);
+		}
+	}
+}
+
+
+
+/**
+ * 2) Then adding the DroidSansFallback font (useful for CJK data for example)
+ */
+echo $sCurrentScriptFileName.": ---2) Copying font files to TCPDF ($sTcPdfFontsFolder)...\n";
+$aFontFilesToCopy = glob(__DIR__.'\droidsansfallback.*');
+foreach ($aFontFilesToCopy as $sFontFileToCopy) {
+	$sFontFileName = basename($sFontFileToCopy);
+	echo $sCurrentScriptFileName.': copying '.$sFontFileName."\n";
+	copy($sFontFileToCopy, $sTcPdfFontsFolder.$sFontFileName);
+}
+echo $sCurrentScriptFileName.": Done !\n";
+
+
+
+/*-----------------------------------------------------------------------------------------------*/
+
+
+
+/**
+ * Recursively delete a directory and its content
+ *
+ * @param $sDirToRemovePath
+ *
+ * @return void
+ */
+function rrmdir($sDirToRemovePath):void
+{
+	if (is_dir($sDirToRemovePath)) {
+		$objects = scandir($sDirToRemovePath);
+		foreach ($objects as $object) {
+			if ($object != "." && $object != "..") {
+				if (filetype($sDirToRemovePath."/".$object) == "dir") {
+					rrmdir($sDirToRemovePath."/".$object);
+				} else {
+					unlink($sDirToRemovePath."/".$object);
+				}
+			}
+		}
+		reset($objects);
+		rmdir($sDirToRemovePath);
+	}
+}

.make/dependencies/npm/restoreFolderBrowsingProtection.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright (C) 2010-2024 Combodo SAS
+ *
+ *   This file is part of iTop.
+ *
+ *   iTop is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU Affero General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   iTop is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU Affero General Public License for more details.
+ *
+ *   You should have received a copy of the GNU Affero General Public License
+ *   along with iTop. If not, see <http: *www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Ensure that the files for folder browsing protection (.htaccess, web.config) are kept after an "npm install/update" command
+ */
+
+$iTopFolder = __DIR__."/../../../";
+
+require_once("$iTopFolder/approot.inc.php");
+
+$sDependenciesRootFolderAbsPath = APPROOT . "node_modules/";
+$aFilesToCheck = [
+	".htaccess",
+	"web.config",
+];
+
+echo "This command aims at ensuring that folder browsing protection files (.htaccess, web.config) are present in the dependencies folder even after an install/upgrade command\n";
+echo "Checking files:\n";
+
+foreach($aFilesToCheck as $sFileToCheck) {
+	if (file_exists($sDependenciesRootFolderAbsPath . $sFileToCheck)) {
+		echo "✔️ $sFileToCheck is present\n";
+		continue;
+	}
+
+	// If missing, copy the one from /lib as it contains the necessary allow/deny directives for third-parties
+	copy(APPROOT . "lib/$sFileToCheck", $sDependenciesRootFolderAbsPath . $sFileToCheck);
+	echo "✔️ $sFileToCheck was missing and has been re-created\n";
+}
+
+// Ensure separation with following scripts
+echo "\n";

.make/dependencies/rmUnnecessaryFolders.php

@@ -0,0 +1,100 @@
+<?php
+/**
+ * Copyright (C) 2010-2024 Combodo SAS
+ *
+ *   This file is part of iTop.
+ *
+ *   iTop is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU Affero General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   iTop is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU Affero General Public License for more details.
+ *
+ *   You should have received a copy of the GNU Affero General Public License
+ *   along with iTop. If not, see <http: *www.gnu.org/licenses/>
+ *
+ */
+
+$iTopFolder = __DIR__ . "/../../" ;
+
+require_once ("$iTopFolder/approot.inc.php");
+require_once (APPROOT."/setup/setuputils.class.inc.php");
+
+if  (php_sapi_name() !== 'cli')
+{
+	throw new \Exception('This script can only run from CLI');
+}
+
+clearstatcache();
+
+// Read params
+$key = array_search("--manager", $argv);
+if (false === $key || false === isset($argv[$key + 1]) ) {
+	throw new \InvalidArgumentException("Usage: " . __FILE__ . " --manager composer|npm");
+}
+$sDependenciesHandlerCode = $argv[$key + 1];
+
+switch ($sDependenciesHandlerCode) {
+	case "composer":
+		$sDependenciesHandlerFQCN = \Combodo\iTop\Dependencies\Composer\iTopComposer::class;
+		break;
+
+	case "npm":
+		$sDependenciesHandlerFQCN = \Combodo\iTop\Dependencies\NPM\iTopNPM::class;
+		break;
+
+	default:
+		throw new \Exception("Invalid dependencies handler code, $sDependenciesHandlerCode given, expected composer|npm");
+}
+
+// Start handler
+$oDependenciesHandler = new $sDependenciesHandlerFQCN();
+$aDeniedButStillPresent = $oDependenciesHandler->ListDeniedButStillPresentFilesAbsPaths();
+
+echo "\n";
+foreach ($aDeniedButStillPresent as $sDir)
+{
+	if (false === $oDependenciesHandler::IsQuestionnableFile($sDir))
+	{
+		echo "ERROR found INVALID denied test dir: '$sDir'\n";
+		throw new \RuntimeException("$sDir is in the denied list but doesn't comply with the rule (see IsQuestionnableFolder method)");
+	}
+
+	if (false === file_exists($sDir)) {
+		echo "INFO $sDir is in denied list, but not existing on disk => skipping !\n";
+		continue;
+	}
+
+	try {
+		if(is_dir($sDir)){
+			SetupUtils::rrmdir($sDir);
+		}
+		else{
+			unlink($sDir);
+		}
+		echo "✔️ Remove denied test dir: '$sDir'\n";
+	}
+	catch (\Exception $e) {
+		echo "\n❌ FAILED to remove denied test dir: '$sDir'\n";
+	}
+}
+
+
+$aAllowedAndDeniedDirs = array_merge(
+	$oDependenciesHandler->ListAllowedFilesAbsPaths(),
+	$oDependenciesHandler->ListDeniedFilesAbsPaths()
+);
+$aExistingDirs = $oDependenciesHandler->ListAllFilesAbsPaths();
+$aMissing = array_diff($aExistingDirs, $aAllowedAndDeniedDirs);
+if (false === empty($aMissing)) {
+	echo "Some new tests dirs exists !\n"
+		."  They must be declared either in the allowed or denied list in {$sDependenciesHandlerFQCN}\n"
+		.'  List of dirs:'."\n".var_export($aMissing, true)."\n";
+}
+
+// Ensure separation with following scripts
+echo "\n";

.make/release/changelog.php

@@ -25,12 +25,34 @@
 
 
 if (count($argv) === 1) {
-	echo '⚠ You must pass the base tag/sha1 as parameter';
+	echo "⚠ You must pass the base tag/sha1 as parameter\n";
 	exit(1);
 }
 $sBaseReference = $argv[1];
 
 
+/**
+ * Replace the Github emojis codes by their UTF-8 character equivalent
+ */
+function ReplaceGitmojis(string $sLine)
+{
+	static $aGitmojis = null;
+
+	if ($aGitmojis === null) {
+		$aRawGitmojis = json_decode(trim(file_get_contents(__DIR__.'/gitmojis.json')), true);
+		if ($aRawGitmojis === false) {
+			echo "\nFailed to parse ".__DIR__."/gitmojis.json, emoji codes will not be replaced by their unicode equivalent.\n";
+		} else {
+			foreach($aRawGitmojis["gitmojis"] as $aGitmoji) {
+				$aGitmojis[$aGitmoji['code']] = $aGitmoji['emoji'];
+			}
+		}
+	}
+	if (is_array($aGitmojis)) {
+		return str_replace(array_keys($aGitmojis), array_values($aGitmojis), $sLine);
+	}
+}
+
 //--- Get log
 $sGitLogCommand = 'git log --decorate --pretty="%h;%s" --date-order --no-merges '.$sBaseReference.'..HEAD';
 $sGitLogRaw = shell_exec($sGitLogCommand);
@@ -73,5 +95,5 @@ echo "\n";
 echo "# Logs line without bug referenced\n";
 echo "sha1;subject\n";
 foreach ($aLogLineNoBug as $sLogLine) {
-	echo "$sLogLine\n";
-}
+	echo ReplaceGitmojis($sLogLine)."\n";
+}

.make/release/gitmojis.json

@@ -0,0 +1,589 @@
+{
+  "$schema": "https://gitmoji.dev/api/gitmojis/schema",
+  "gitmojis": [
+    {
+      "emoji": "🎨",
+      "entity": "🎨",
+      "code": ":art:",
+      "description": "Improve structure / format of the code.",
+      "name": "art",
+      "semver": null
+    },
+    {
+      "emoji": "⚡️",
+      "entity": "⚡",
+      "code": ":zap:",
+      "description": "Improve performance.",
+      "name": "zap",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔥",
+      "entity": "🔥",
+      "code": ":fire:",
+      "description": "Remove code or files.",
+      "name": "fire",
+      "semver": null
+    },
+    {
+      "emoji": "🐛",
+      "entity": "🐛",
+      "code": ":bug:",
+      "description": "Fix a bug.",
+      "name": "bug",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🚑️",
+      "entity": "🚑",
+      "code": ":ambulance:",
+      "description": "Critical hotfix.",
+      "name": "ambulance",
+      "semver": "patch"
+    },
+    {
+      "emoji": "✨",
+      "entity": "✨",
+      "code": ":sparkles:",
+      "description": "Introduce new features.",
+      "name": "sparkles",
+      "semver": "minor"
+    },
+    {
+      "emoji": "📝",
+      "entity": "📝",
+      "code": ":memo:",
+      "description": "Add or update documentation.",
+      "name": "memo",
+      "semver": null
+    },
+    {
+      "emoji": "🚀",
+      "entity": "🚀",
+      "code": ":rocket:",
+      "description": "Deploy stuff.",
+      "name": "rocket",
+      "semver": null
+    },
+    {
+      "emoji": "💄",
+      "entity": "&#ff99cc;",
+      "code": ":lipstick:",
+      "description": "Add or update the UI and style files.",
+      "name": "lipstick",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🎉",
+      "entity": "🎉",
+      "code": ":tada:",
+      "description": "Begin a project.",
+      "name": "tada",
+      "semver": null
+    },
+    {
+      "emoji": "✅",
+      "entity": "✅",
+      "code": ":white_check_mark:",
+      "description": "Add, update, or pass tests.",
+      "name": "white-check-mark",
+      "semver": null
+    },
+    {
+      "emoji": "🔒️",
+      "entity": "🔒",
+      "code": ":lock:",
+      "description": "Fix security or privacy issues.",
+      "name": "lock",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔐",
+      "entity": "🔐",
+      "code": ":closed_lock_with_key:",
+      "description": "Add or update secrets.",
+      "name": "closed-lock-with-key",
+      "semver": null
+    },
+    {
+      "emoji": "🔖",
+      "entity": "🔖",
+      "code": ":bookmark:",
+      "description": "Release / Version tags.",
+      "name": "bookmark",
+      "semver": null
+    },
+    {
+      "emoji": "🚨",
+      "entity": "🚨",
+      "code": ":rotating_light:",
+      "description": "Fix compiler / linter warnings.",
+      "name": "rotating-light",
+      "semver": null
+    },
+    {
+      "emoji": "🚧",
+      "entity": "🚧",
+      "code": ":construction:",
+      "description": "Work in progress.",
+      "name": "construction",
+      "semver": null
+    },
+    {
+      "emoji": "💚",
+      "entity": "💚",
+      "code": ":green_heart:",
+      "description": "Fix CI Build.",
+      "name": "green-heart",
+      "semver": null
+    },
+    {
+      "emoji": "⬇️",
+      "entity": "⬇️",
+      "code": ":arrow_down:",
+      "description": "Downgrade dependencies.",
+      "name": "arrow-down",
+      "semver": "patch"
+    },
+    {
+      "emoji": "⬆️",
+      "entity": "⬆️",
+      "code": ":arrow_up:",
+      "description": "Upgrade dependencies.",
+      "name": "arrow-up",
+      "semver": "patch"
+    },
+    {
+      "emoji": "📌",
+      "entity": "📌",
+      "code": ":pushpin:",
+      "description": "Pin dependencies to specific versions.",
+      "name": "pushpin",
+      "semver": "patch"
+    },
+    {
+      "emoji": "👷",
+      "entity": "👷",
+      "code": ":construction_worker:",
+      "description": "Add or update CI build system.",
+      "name": "construction-worker",
+      "semver": null
+    },
+    {
+      "emoji": "📈",
+      "entity": "📈",
+      "code": ":chart_with_upwards_trend:",
+      "description": "Add or update analytics or track code.",
+      "name": "chart-with-upwards-trend",
+      "semver": "patch"
+    },
+    {
+      "emoji": "♻️",
+      "entity": "♻",
+      "code": ":recycle:",
+      "description": "Refactor code.",
+      "name": "recycle",
+      "semver": null
+    },
+    {
+      "emoji": "➕",
+      "entity": "➕",
+      "code": ":heavy_plus_sign:",
+      "description": "Add a dependency.",
+      "name": "heavy-plus-sign",
+      "semver": "patch"
+    },
+    {
+      "emoji": "➖",
+      "entity": "➖",
+      "code": ":heavy_minus_sign:",
+      "description": "Remove a dependency.",
+      "name": "heavy-minus-sign",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔧",
+      "entity": "🔧",
+      "code": ":wrench:",
+      "description": "Add or update configuration files.",
+      "name": "wrench",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔨",
+      "entity": "🔨",
+      "code": ":hammer:",
+      "description": "Add or update development scripts.",
+      "name": "hammer",
+      "semver": null
+    },
+    {
+      "emoji": "🌐",
+      "entity": "🌐",
+      "code": ":globe_with_meridians:",
+      "description": "Internationalization and localization.",
+      "name": "globe-with-meridians",
+      "semver": "patch"
+    },
+    {
+      "emoji": "✏️",
+      "entity": "",
+      "code": ":pencil2:",
+      "description": "Fix typos.",
+      "name": "pencil2",
+      "semver": "patch"
+    },
+    {
+      "emoji": "💩",
+      "entity": "",
+      "code": ":poop:",
+      "description": "Write bad code that needs to be improved.",
+      "name": "poop",
+      "semver": null
+    },
+    {
+      "emoji": "⏪️",
+      "entity": "⏪",
+      "code": ":rewind:",
+      "description": "Revert changes.",
+      "name": "rewind",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔀",
+      "entity": "🔀",
+      "code": ":twisted_rightwards_arrows:",
+      "description": "Merge branches.",
+      "name": "twisted-rightwards-arrows",
+      "semver": null
+    },
+    {
+      "emoji": "📦️",
+      "entity": "&#1F4E6;",
+      "code": ":package:",
+      "description": "Add or update compiled files or packages.",
+      "name": "package",
+      "semver": "patch"
+    },
+    {
+      "emoji": "👽️",
+      "entity": "&#1F47D;",
+      "code": ":alien:",
+      "description": "Update code due to external API changes.",
+      "name": "alien",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🚚",
+      "entity": "&#1F69A;",
+      "code": ":truck:",
+      "description": "Move or rename resources (e.g.: files, paths, routes).",
+      "name": "truck",
+      "semver": null
+    },
+    {
+      "emoji": "📄",
+      "entity": "&#1F4C4;",
+      "code": ":page_facing_up:",
+      "description": "Add or update license.",
+      "name": "page-facing-up",
+      "semver": null
+    },
+    {
+      "emoji": "💥",
+      "entity": "💥",
+      "code": ":boom:",
+      "description": "Introduce breaking changes.",
+      "name": "boom",
+      "semver": "major"
+    },
+    {
+      "emoji": "🍱",
+      "entity": "&#1F371",
+      "code": ":bento:",
+      "description": "Add or update assets.",
+      "name": "bento",
+      "semver": "patch"
+    },
+    {
+      "emoji": "♿️",
+      "entity": "♿",
+      "code": ":wheelchair:",
+      "description": "Improve accessibility.",
+      "name": "wheelchair",
+      "semver": "patch"
+    },
+    {
+      "emoji": "💡",
+      "entity": "💡",
+      "code": ":bulb:",
+      "description": "Add or update comments in source code.",
+      "name": "bulb",
+      "semver": null
+    },
+    {
+      "emoji": "🍻",
+      "entity": "🍻",
+      "code": ":beers:",
+      "description": "Write code drunkenly.",
+      "name": "beers",
+      "semver": null
+    },
+    {
+      "emoji": "💬",
+      "entity": "💬",
+      "code": ":speech_balloon:",
+      "description": "Add or update text and literals.",
+      "name": "speech-balloon",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🗃️",
+      "entity": "🗃",
+      "code": ":card_file_box:",
+      "description": "Perform database related changes.",
+      "name": "card-file-box",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔊",
+      "entity": "🔊",
+      "code": ":loud_sound:",
+      "description": "Add or update logs.",
+      "name": "loud-sound",
+      "semver": null
+    },
+    {
+      "emoji": "🔇",
+      "entity": "🔇",
+      "code": ":mute:",
+      "description": "Remove logs.",
+      "name": "mute",
+      "semver": null
+    },
+    {
+      "emoji": "👥",
+      "entity": "👥",
+      "code": ":busts_in_silhouette:",
+      "description": "Add or update contributor(s).",
+      "name": "busts-in-silhouette",
+      "semver": null
+    },
+    {
+      "emoji": "🚸",
+      "entity": "🚸",
+      "code": ":children_crossing:",
+      "description": "Improve user experience / usability.",
+      "name": "children-crossing",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🏗️",
+      "entity": "&#1f3d7;",
+      "code": ":building_construction:",
+      "description": "Make architectural changes.",
+      "name": "building-construction",
+      "semver": null
+    },
+    {
+      "emoji": "📱",
+      "entity": "📱",
+      "code": ":iphone:",
+      "description": "Work on responsive design.",
+      "name": "iphone",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🤡",
+      "entity": "🤡",
+      "code": ":clown_face:",
+      "description": "Mock things.",
+      "name": "clown-face",
+      "semver": null
+    },
+    {
+      "emoji": "🥚",
+      "entity": "🥚",
+      "code": ":egg:",
+      "description": "Add or update an easter egg.",
+      "name": "egg",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🙈",
+      "entity": "&#8bdfe7;",
+      "code": ":see_no_evil:",
+      "description": "Add or update a .gitignore file.",
+      "name": "see-no-evil",
+      "semver": null
+    },
+    {
+      "emoji": "📸",
+      "entity": "📸",
+      "code": ":camera_flash:",
+      "description": "Add or update snapshots.",
+      "name": "camera-flash",
+      "semver": null
+    },
+    {
+      "emoji": "⚗️",
+      "entity": "⚗",
+      "code": ":alembic:",
+      "description": "Perform experiments.",
+      "name": "alembic",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🔍️",
+      "entity": "🔍",
+      "code": ":mag:",
+      "description": "Improve SEO.",
+      "name": "mag",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🏷️",
+      "entity": "🏷",
+      "code": ":label:",
+      "description": "Add or update types.",
+      "name": "label",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🌱",
+      "entity": "🌱",
+      "code": ":seedling:",
+      "description": "Add or update seed files.",
+      "name": "seedling",
+      "semver": null
+    },
+    {
+      "emoji": "🚩",
+      "entity": "🚩",
+      "code": ":triangular_flag_on_post:",
+      "description": "Add, update, or remove feature flags.",
+      "name": "triangular-flag-on-post",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🥅",
+      "entity": "🥅",
+      "code": ":goal_net:",
+      "description": "Catch errors.",
+      "name": "goal-net",
+      "semver": "patch"
+    },
+    {
+      "emoji": "💫",
+      "entity": "💫",
+      "code": ":dizzy:",
+      "description": "Add or update animations and transitions.",
+      "name": "dizzy",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🗑️",
+      "entity": "🗑",
+      "code": ":wastebasket:",
+      "description": "Deprecate code that needs to be cleaned up.",
+      "name": "wastebasket",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🛂",
+      "entity": "🛂",
+      "code": ":passport_control:",
+      "description": "Work on code related to authorization, roles and permissions.",
+      "name": "passport-control",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🩹",
+      "entity": "🩹",
+      "code": ":adhesive_bandage:",
+      "description": "Simple fix for a non-critical issue.",
+      "name": "adhesive-bandage",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🧐",
+      "entity": "🧐",
+      "code": ":monocle_face:",
+      "description": "Data exploration/inspection.",
+      "name": "monocle-face",
+      "semver": null
+    },
+    {
+      "emoji": "⚰️",
+      "entity": "⚰",
+      "code": ":coffin:",
+      "description": "Remove dead code.",
+      "name": "coffin",
+      "semver": null
+    },
+    {
+      "emoji": "🧪",
+      "entity": "🧪",
+      "code": ":test_tube:",
+      "description": "Add a failing test.",
+      "name": "test-tube",
+      "semver": null
+    },
+    {
+      "emoji": "👔",
+      "entity": "👔",
+      "code": ":necktie:",
+      "description": "Add or update business logic.",
+      "name": "necktie",
+      "semver": "patch"
+    },
+    {
+      "emoji": "🩺",
+      "entity": "🩺",
+      "code": ":stethoscope:",
+      "description": "Add or update healthcheck.",
+      "name": "stethoscope",
+      "semver": null
+    },
+    {
+      "emoji": "🧱",
+      "entity": "🧱",
+      "code": ":bricks:",
+      "description": "Infrastructure related changes.",
+      "name": "bricks",
+      "semver": null
+    },
+    {
+      "emoji": "🧑‍💻",
+      "entity": "🧑‍💻",
+      "code": ":technologist:",
+      "description": "Improve developer experience.",
+      "name": "technologist",
+      "semver": null
+    },
+    {
+      "emoji": "💸",
+      "entity": "💸",
+      "code": ":money_with_wings:",
+      "description": "Add sponsorships or money related infrastructure.",
+      "name": "money-with-wings",
+      "semver": null
+    },
+    {
+      "emoji": "🧵",
+      "entity": "🧵",
+      "code": ":thread:",
+      "description": "Add or update code related to multithreading or concurrency.",
+      "name": "thread",
+      "semver": null
+    },
+    {
+      "emoji": "🦺",
+      "entity": "🦺",
+      "code": ":safety_vest:",
+      "description": "Add or update code related to validation.",
+      "name": "safety-vest",
+      "semver": null
+    }
+  ]
+}

CONTRIBUTING.md

@@ -7,6 +7,17 @@ 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
 You are welcome to create pull requests on any of those subjects:
 
@@ -140,7 +151,7 @@ When your code is working, please:
 * Pull request description: mind to add all the information useful to understand why you're suggesting this modification and anything necessary to dive into your work. Especially:
   - Bugfixes: exact steps to reproduce the bug (given/when/then), description of the bug cause and what solution is implemented 
   - Enhancements: use cases, implementation details if needed
-* Mind to check the "[Allow edits from maintainers](https://docs.github.com/en/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)" option !
+* Mind to check the "[Allow edits from maintainers](https://docs.github.com/en/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)" option ! (note that if you are working with an org fork, this option [won't be available](https://github.com/orgs/community/discussions/5634))
 
 
 ## 🙏 We are thankful
@@ -159,6 +170,6 @@ We have one sticker per contribution type. You might get multiple stickers with
 * Beta tester: Test and give feedback on beta releases
 * Extension developer: Develop and publish an extension
 
-Here is the design of each stickers for year 2022:
+Here is the design of each stickers for year 2024:
 
-![iTop stickers 2023](.doc/contributing-guide/2023.contributing-stickers-side-by-side.png)
+![iTop stickers 2025](.doc/contributing-guide/2025.contributing-stickers-side-by-side.png)

README.md

@@ -1,5 +1,9 @@
-<p align="center"><a href="https://www.combodo.com/itop-193" target="_blank">
-    <img src="https://www.combodo.com/logos/logo-itop-baseline.svg" width=350>
+<p align="center"><a href="https://combodo.com" target="_blank">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="/images/logos/logo-itop-baseline-light.svg">
+  <source media="(prefers-color-scheme: light)" srcset="/images/logos/logo-itop-baseline-dark.svg">
+  <img src="/images/logos/logo-itop-baseline-light.svg" width="350" alt="Logo iTop with baseline" />
+</picture>
 </a></p>
 
 
@@ -49,7 +53,7 @@ iTop also offers mass import tools to help you become even more efficient.
 [4]: https://www.itophub.io/wiki/page?id=latest:install:requirements
 [5]: https://www.itophub.io/wiki
 [6]: https://store.itophub.io/en_US/
-[7]: .doc/itop-version-history.md
+[7]: itop-version-history.md
 
 [10]: https://www.itophub.io/wiki/page?id=latest%3Adatamodel%3Astart#configuration_management_cmdb
 [11]: https://www.itophub.io/wiki/page?id=latest%3Adatamodel%3Astart#ticketing
@@ -76,7 +80,9 @@ We would like to give a special thank you 🤗 to the people from the community
 
 ### Names
 
+- Al Hallak, Amr (a.k.a [@v4yne1](https://github.com/v4yne1))
 - Alves, David
+- Audon, Florian
 - Beck, Pedro
 - Beer, Christian (a.k.a [@ChristianBeer](https://www.github.com/ChristianBeer))
 - Bilger, Jean-François
@@ -87,29 +93,46 @@ We would like to give a special thank you 🤗 to the people from the community
 - Castro, Randall Badilla
 - Colantoni, Maria Laura
 - Couronné, Guy
+- Dejin, Bie (a.k.a [@bdejin](https://github.com/bdejin))
+- Delicado, Elodie
 - Dvořák, Lukáš
 - Goethals, Stefan
+- Giuva, Vincenzo Katriel (a.k.a [@DarkNight97boss](https://github.com/DarkNight97boss))
 - Gumble, David
+- Håkon, Harnes (a.k.a [@hakonharnes](https://github.com/hakonharnes))
+- Heloir, Arthur 
+- Janssens, Jelle (a.k.a [@janssensjelle](https://github.com/janssensjelle))
+- Ji, Leeb (冀利斌) (a.k.a [@chileeb](https://github.com/chileeb))
 - Kaltefleiter, Lars (a.k.a [@larhip](https://www.github.com/larhip))
 - Khamit, Shamil
 - Kincel, Martin
 - Konečný, Kamil
 - Kunin, Vladimir
-- Lassiter, Dennis
+- Lassiter, Denis (a.k.a [@delassiter](https://github.com/delassiter))
 - Lazcano, Federico
 - Lucas, Jonathan
 - Malik, Remie
+- Mantel, Ina 
+- Martin, Pierre (a.k.a [@Worty](https://github.com/worty-syn))
+- Melchiorre, Romain
 - Mindêllo de Andrade, Lucas (a.k.a [@rokam](https://www.github.com/rokam))
 - Mozart de Oliveira, Eduardo (a.k.a [@eduardomozart](https://github.com/eduardomozart))
 - Raenker, Martin
 - Roháč, Richard (a.k.a [@RohacRichard](https://github.com/RohacRichard))
 - Rosenke, Stephan
+- Rossi, Tommaso (a.k.a [@tomrss](https://www.github.com/tomrss))
 - Rudner, Björn (a.k.a [@rudnerbjoern](https://github.com/rudnerbjoern))
+- Šafránek, Jaroslav (a.k.a [jkcinik](https://sourceforge.net/u/jkcinik/profile/) on SourceForge)
 - Seki, Shoji
 - Shilov, Vladimir
-- Stukalov, Ilya (a.k.a [@ilya](https://www.github.com/ilya)-stukalov)
+- Stetina, Pavel (a.k.a [@Stetinac](https://github.com/Stetinac))
+- Stukalov, Ilya (a.k.a [@ilya](https://www.github.com/ilya-stukalov))
+- Tarjányi, Csaba (a.k.a [@tacsaby](https://github.com/tacsaby))
+- Toraya, Chairat (a.k.a [@Kyokito1412](https://github.com/Kyokito1412))
 - Tulio, Marco
 - Turrubiates, Miguel
+- Višnjić, Aldin (a.k.a[@viliald](https://github.com/viliald))
+- Vlk, Karel (a.k.a [@vlk-charles](https://www.github.com/vlk-charles))
 
 ### Aliases
 
@@ -130,4 +153,6 @@ We would like to give a special thank you 🤗 to the people from the community
 - [ITOMIG](https://www.itomig.de/)
 - [Pimkie](https://www.pimkie.com/)
 - [Super-Visions](https://www.super-visions.com/)
-
+- [Defence Tech Cyber Security - Malware Lab](https://github.com/DefenceTechSecurity)
+- Orange Cyberdefense
+- MipihSIB

addons/userrights/userrightsmatrix.class.inc.php

@@ -1,362 +0,0 @@
-<?php
-// Copyright (C) 2010-2023 Combodo SARL
-//
-//   This file is part of iTop.
-//
-//   iTop is free software; you can redistribute it and/or modify	
-//   it under the terms of the GNU Affero General Public License as published by
-//   the Free Software Foundation, either version 3 of the License, or
-//   (at your option) any later version.
-//
-//   iTop is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU Affero General Public License for more details.
-//
-//   You should have received a copy of the GNU Affero General Public License
-//   along with iTop. If not, see <http://www.gnu.org/licenses/>
-
-/**
- * UserRightsMatrix (User management Module)
- *
- * @copyright   Copyright (C) 2010-2023 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
- */
-
-
-class UserRightsMatrixClassGrant extends DBObject
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "addon/userrights",
-			"key_type" => "autoincrement",
-			"name_attcode" => "",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_ur_matrixclasses",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		//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_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("login", array("allowed_values"=>null, "extkey_attcode"=> 'userid', "target_attcode"=>"login")));
-		MetaModel::Init_AddAttribute(new AttributeString("class", array("allowed_values"=>null, "sql"=>"class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-
-		MetaModel::Init_AddAttribute(new AttributeString("action", array("allowed_values"=>null, "sql"=>"action", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("permission", array("allowed_values"=>new ValueSetEnum('yes,no'), "sql"=>"permission", "default_value"=>"yes", "is_null_allowed"=>false, "depends_on"=>array())));
-	}
-}
-
-class UserRightsMatrixClassStimulusGrant extends DBObject
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "addon/userrights",
-			"key_type" => "autoincrement",
-			"name_attcode" => "",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_ur_matrixclassesstimulus",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		//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_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("login", array("allowed_values"=>null, "extkey_attcode"=> 'userid', "target_attcode"=>"login")));
-		MetaModel::Init_AddAttribute(new AttributeString("class", array("allowed_values"=>null, "sql"=>"class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-
-		MetaModel::Init_AddAttribute(new AttributeString("stimulus", array("allowed_values"=>null, "sql"=>"action", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("permission", array("allowed_values"=>new ValueSetEnum('yes,no'), "sql"=>"permission", "default_value"=>"yes", "is_null_allowed"=>false, "depends_on"=>array())));
-	}
-}
-
-class UserRightsMatrixAttributeGrant extends DBObject
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "addon/userrights",
-			"key_type" => "autoincrement",
-			"name_attcode" => "",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_ur_matrixattributes",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		//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_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("login", array("allowed_values"=>null, "extkey_attcode"=> 'userid', "target_attcode"=>"login")));
-		MetaModel::Init_AddAttribute(new AttributeString("class", array("allowed_values"=>null, "sql"=>"class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("attcode", array("allowed_values"=>null, "sql"=>"attcode", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-
-		MetaModel::Init_AddAttribute(new AttributeString("action", array("allowed_values"=>null, "sql"=>"action", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("permission", array("allowed_values"=>new ValueSetEnum('yes,no'), "sql"=>"permission", "default_value"=>"yes", "is_null_allowed"=>false, "depends_on"=>array())));
-	}
-}
-
-
-
-
-class UserRightsMatrix extends UserRightsAddOnAPI
-{
-	static public $m_aActionCodes = array(
-		UR_ACTION_READ => 'read',
-		UR_ACTION_MODIFY => 'modify',
-		UR_ACTION_DELETE => 'delete',
-		UR_ACTION_BULK_READ => 'bulk read',
-		UR_ACTION_BULK_MODIFY => 'bulk modify',
-		UR_ACTION_BULK_DELETE => 'bulk delete',
-	);
-
-	// Installation: create the very first user
-	public function CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage = 'EN US')
-	{
-		// Maybe we should check that no other user with userid == 0 exists
-		$oUser = new UserLocal();
-		$oUser->Set('login', $sAdminUser);
-		$oUser->Set('password', $sAdminPwd);
-		$oUser->Set('contactid', 1); // one is for root !
-		$oUser->Set('language', $sLanguage); // Language was chosen during the installation
-
-		// Now record the admin user object
-		$iUserId = $oUser->DBInsertNoReload();
-		$this->SetupUser($iUserId, true);
-		return true;
-	}
-
-	public function IsAdministrator($oUser)
-	{
-		return ($oUser->GetKey() == 1);
-	}
-
-	public function IsPortalUser($oUser)
-	{
-		return ($oUser->GetKey() == 1);
-	}
-
-	// Deprecated - create a new module !
-	public function Setup()
-	{
-		// Users must be added manually
-		// This procedure will then update the matrix when a new user is found or a new class/attribute appears
-		$oUserSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT User"));
-		while ($oUser = $oUserSet->Fetch())
-		{
-			$this->SetupUser($oUser->GetKey());
-		}
-		return true;
-	}
-
-	protected function SetupUser($iUserId, $bNewUser = false)
-	{
-		foreach(array('bizmodel', 'application', 'gui', 'core/cmdb') as $sCategory)
-		{
-			foreach (MetaModel::GetClasses($sCategory) as $sClass)
-			{
-				foreach (self::$m_aActionCodes as $iActionCode => $sAction)
-				{
-					if ($bNewUser)
-					{
-						$bAddCell = true;
-					}
-					else
-					{
-						$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT UserRightsMatrixClassGrant WHERE class = '$sClass' AND action = '$sAction' AND userid = $iUserId"));
-						$bAddCell = ($oSet->Count() < 1);
-					}
-					if ($bAddCell)
-					{
-						// Create a new entry
-						$oMyClassGrant = MetaModel::NewObject("UserRightsMatrixClassGrant");
-						$oMyClassGrant->Set("userid", $iUserId);
-						$oMyClassGrant->Set("class", $sClass);
-						$oMyClassGrant->Set("action", $sAction);
-						$oMyClassGrant->Set("permission", "yes");
-						$iId = $oMyClassGrant->DBInsertNoReload();
-					}
-				}
-				foreach (MetaModel::EnumStimuli($sClass) as $sStimulusCode => $oStimulus)
-				{
-					if ($bNewUser)
-					{
-						$bAddCell = true;
-					}
-					else
-					{
-						$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT UserRightsMatrixClassStimulusGrant WHERE class = '$sClass' AND stimulus = '$sStimulusCode' AND userid = $iUserId"));
-						$bAddCell = ($oSet->Count() < 1);
-					}
-					if ($bAddCell)
-					{
-						// Create a new entry
-						$oMyClassGrant = MetaModel::NewObject("UserRightsMatrixClassStimulusGrant");
-						$oMyClassGrant->Set("userid", $iUserId);
-						$oMyClassGrant->Set("class", $sClass);
-						$oMyClassGrant->Set("stimulus", $sStimulusCode);
-						$oMyClassGrant->Set("permission", "yes");
-						$iId = $oMyClassGrant->DBInsertNoReload();
-					}
-				}
-				foreach (MetaModel::GetAttributesList($sClass) as $sAttCode)
-				{
-					if ($bNewUser)
-					{
-						$bAddCell = true;
-					}
-					else
-					{
-						$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT UserRightsMatrixAttributeGrant WHERE class = '$sClass' AND attcode = '$sAttCode' AND userid = $iUserId"));
-						$bAddCell = ($oSet->Count() < 1);
-					}
-					if ($bAddCell)
-					{
-						foreach (array('read', 'modify') as $sAction)
-						{
-							// Create a new entry
-							$oMyAttGrant = MetaModel::NewObject("UserRightsMatrixAttributeGrant");
-							$oMyAttGrant->Set("userid", $iUserId);
-							$oMyAttGrant->Set("class", $sClass);
-							$oMyAttGrant->Set("attcode", $sAttCode);
-							$oMyAttGrant->Set("action", $sAction);
-							$oMyAttGrant->Set("permission", "yes");
-							$iId = $oMyAttGrant->DBInsertNoReload();
-						}
-					}
-				}
-			}
-		}
-		/*
-		// Create the "My Bookmarks" menu item (parent_id = 0, rank = 6)
-		if ($bNewUser)
-		{
-			$bAddMenu = true;
-		}
-		else
-		{
-			$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT menuNode WHERE type = 'user' AND parent_id = 0 AND user_id = $iUserId"));
-			$bAddMenu = ($oSet->Count() < 1);
-		}
-		if ($bAddMenu)
-		{
-			$oMenu = MetaModel::NewObject('menuNode');
-			$oMenu->Set('type', 'user');
-			$oMenu->Set('parent_id', 0);	// It's a toplevel entry
-			$oMenu->Set('rank', 6);			// Located just above the Admin Tools section (=7)
-			$oMenu->Set('name', 'My Bookmarks');
-			$oMenu->Set('label', 'My Favorite Items');
-			$oMenu->Set('hyperlink', 'UI.php');
-			$oMenu->Set('template', '<p></p><p></p><p style="text-align:center; font-family:Georgia, Times, serif; font-size:32px;">My bookmarks</p><p style="text-align:center; font-family:Georgia, Times, serif; font-size:14px;"><i>This section contains my most favorite search results</i></p>');
-			$oMenu->Set('user_id', $iUserId);
-			$oMenu->DBInsert();
-		}
-		*/
-	}
-
-
-	public function Init()
-	{
-		// Could be loaded in a shared memory (?)
-		return true;
-	}
-
-	public function GetSelectFilter($oUser, $sClass, $aSettings = array())
-	{
-		$oNullFilter  = new DBObjectSearch($sClass);
-		return $oNullFilter;
-	}
-
-	public function IsActionAllowed($oUser, $sClass, $iActionCode, $oInstanceSet = null)
-	{
-		if (!array_key_exists($iActionCode, self::$m_aActionCodes))
-		{
-			return UR_ALLOWED_NO;
-		}
-		$sAction = self::$m_aActionCodes[$iActionCode];
-
-		$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT UserRightsMatrixClassGrant WHERE class = '$sClass' AND action = '$sAction' AND userid = '{$oUser->GetKey()}'"));
-		if ($oSet->Count() < 1)
-		{
-			return UR_ALLOWED_NO;
-		}
-
-		$oGrantRecord = $oSet->Fetch();
-		switch ($oGrantRecord->Get('permission'))
-		{
-			case 'yes':
-				$iRetCode = UR_ALLOWED_YES;
-				break;
-			case 'no':
-			default:
-				$iRetCode = UR_ALLOWED_NO;
-				break;
-		}
-		return $iRetCode;
-	}
-
-	public function IsActionAllowedOnAttribute($oUser, $sClass, $sAttCode, $iActionCode, $oInstanceSet = null)
-	{
-		if (!array_key_exists($iActionCode, self::$m_aActionCodes))
-		{
-			return UR_ALLOWED_NO;
-		}
-		$sAction = self::$m_aActionCodes[$iActionCode];
-
-		$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT UserRightsMatrixAttributeGrant WHERE class = '$sClass' AND attcode = '$sAttCode' AND action = '$sAction' AND userid = '{$oUser->GetKey()}'"));
-		if ($oSet->Count() < 1)
-		{
-			return UR_ALLOWED_NO;
-		}
-
-		$oGrantRecord = $oSet->Fetch();
-		switch ($oGrantRecord->Get('permission'))
-		{
-			case 'yes':
-				$iRetCode = UR_ALLOWED_YES;
-				break;
-			case 'no':
-			default:
-				$iRetCode = UR_ALLOWED_NO;
-				break;
-		}
-		return $iRetCode;
-	}
-
-	public function IsStimulusAllowed($oUser, $sClass, $sStimulusCode, $oInstanceSet = null)
-	{
-		$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT UserRightsMatrixClassStimulusGrant WHERE class = '$sClass' AND stimulus = '$sStimulusCode' AND userid = '{$oUser->GetKey()}'"));
-		if ($oSet->Count() < 1)
-		{
-			return UR_ALLOWED_NO;
-		}
-
-		$oGrantRecord = $oSet->Fetch();
-		switch ($oGrantRecord->Get('permission'))
-		{
-			case 'yes':
-				$iRetCode = UR_ALLOWED_YES;
-				break;
-			case 'no':
-			default:
-				$iRetCode = UR_ALLOWED_NO;
-				break;
-		}
-		return $iRetCode;
-	}
-
-	public function FlushPrivileges()
-	{
-	}
-}
-
-UserRights::SelectModule('UserRightsMatrix');
-
-?>

addons/userrights/userrightsnull.class.inc.php

@@ -1,78 +0,0 @@
-<?php
-// Copyright (C) 2010-2023 Combodo SARL
-//
-//   This file is part of iTop.
-//
-//   iTop is free software; you can redistribute it and/or modify	
-//   it under the terms of the GNU Affero General Public License as published by
-//   the Free Software Foundation, either version 3 of the License, or
-//   (at your option) any later version.
-//
-//   iTop is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU Affero General Public License for more details.
-//
-//   You should have received a copy of the GNU Affero General Public License
-//   along with iTop. If not, see <http://www.gnu.org/licenses/>
-
-/**
- * UserRightsNull
- * User management Module - say Yeah! to everything
- *
- * @copyright   Copyright (C) 2010-2023 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
- */
-
-class UserRightsNull extends UserRightsAddOnAPI
-{
-	// Installation: create the very first user
-	public function CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage = 'EN US')
-	{
-		return true;
-	}
-
-	public function IsAdministrator($oUser)
-	{
-		return true;
-	}
-
-	public function IsPortalUser($oUser)
-	{
-		return true;
-	}
-
-	public function Init()
-	{
-		return true;
-	}
-
-	public function GetSelectFilter($oUser, $sClass, $aSettings = array())
-	{
-		$oNullFilter  = new DBObjectSearch($sClass);
-		return $oNullFilter;
-	}
-
-	public function IsActionAllowed($oUser, $sClass, $iActionCode, $oInstanceSet = null)
-	{
-		return UR_ALLOWED_YES;
-	}
-
-	public function IsStimulusAllowed($oUser, $sClass, $sStimulusCode, $oInstanceSet = null)
-	{
-		return UR_ALLOWED_YES;
-	}
-
-	public function IsActionAllowedOnAttribute($oUser, $sClass, $sAttCode, $iActionCode, $oInstanceSet = null)
-	{
-		return UR_ALLOWED_YES;
-	}
-
-	public function FlushPrivileges()
-	{
-	}
-}
-
-UserRights::SelectModule('UserRightsNull');
-
-?>

addons/userrights/userrightsprofile.class.inc.php

@@ -1,9 +1,11 @@
 <?php
 /*
- * @copyright   Copyright (C) 2010-2023 Combodo SARL
+ * @copyright   Copyright (C) 2010-2024 Combodo SAS
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
+use Combodo\iTop\Application\WebPage\WebPage;
+
 define('ADMIN_PROFILE_NAME', 'Administrator');
 define('PORTAL_PROFILE_NAME', 'Portal user');
 
@@ -823,49 +825,38 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		{
 			// 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
-			if (self::HasSharing())
-			{
-				$aClassProps = SharedObject::GetSharedClassProperties($sClass);
-				if ($aClassProps)
-				{
-					// This class is shared, GetSelectFilter may allow some objects for read only
-					// But currently we are checking wether the objects might be written...
-					// Let's exclude the objects based on the relevant criteria
+			if (self::HasSharing() && SharedObject::GetSharedClassProperties($sClass)) {
+				// This class is shared, GetSelectFilter may allow some objects for read only
+				// But currently we are checking whether the objects might be written...
+				// Let's exclude the objects based on the relevant criteria
 
-					$sOrgAttCode = self::GetOwnerOrganizationAttCode($sClass);
-					if (!is_null($sOrgAttCode))
-					{
-						$aUserOrgs = $this->GetUserOrgs($oUser, $sClass);
-						if (!is_null($aUserOrgs) && count($aUserOrgs) > 0)
-						{
-							$iCountNO = 0;
-							$iCountYES = 0;
-							$oInstanceSet->Rewind();
-							while($oObject = $oInstanceSet->Fetch())
-							{
-								$iOrg = $oObject->Get($sOrgAttCode);
-								if (in_array($iOrg, $aUserOrgs))
-								{
-									$iCountYES++;
-								}
-								else
-								{
-									$iCountNO++;
-								}
-							}
-							if ($iCountNO == 0)
-							{
-								$iPermission = UR_ALLOWED_YES;
-							}
-							elseif ($iCountYES == 0)
-							{
-								$iPermission = UR_ALLOWED_NO;
-							}
-							else
-							{
-								$iPermission = UR_ALLOWED_DEPENDS;
+				// Use $oInstanceSet only if sClass is the main class
+				if (!is_a($oInstanceSet->GetClass(), $sClass, true)) {
+					/** @var \DBObjectSet $oInstanceSet */
+					throw new CoreException(__FUNCTION__.': Expecting object set to be of class '.$sClass.' but it is of class '.$oInstanceSet->GetClass(), ['OQL_Query' => $oInstanceSet->GetFilter()->ToOQL(), 'classes' => $oInstanceSet->GetSelectedClasses()]);
+				}
+				$sOrgAttCode = self::GetOwnerOrganizationAttCode($sClass);
+				if (!is_null($sOrgAttCode)) {
+					$aUserOrgs = $this->GetUserOrgs($oUser, $sClass);
+					if (!is_null($aUserOrgs) && count($aUserOrgs) > 0) {
+						$iCountNO = 0;
+						$iCountYES = 0;
+						$oInstanceSet->Rewind();
+						while ($oObject = $oInstanceSet->Fetch()) {
+							$iOrg = $oObject->Get($sOrgAttCode);
+							if (in_array($iOrg, $aUserOrgs)) {
+								$iCountYES++;
+							} else {
+								$iCountNO++;
 							}
 						}
+						if ($iCountNO == 0) {
+							$iPermission = UR_ALLOWED_YES;
+						} elseif ($iCountYES == 0) {
+							$iPermission = UR_ALLOWED_NO;
+						} else {
+							$iPermission = UR_ALLOWED_DEPENDS;
+						}
 					}
 				}
 			}
@@ -980,4 +971,3 @@ class UserRightsProfile extends UserRightsAddOnAPI
 
 UserRights::SelectModule('UserRightsProfile');
 
-?>

app.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright (C) 2013-2024 Combodo SAS
+ *
+ * This file is part of iTop.
+ *
+ * iTop is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * iTop is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ */
+
+use Combodo\iTop\Kernel;
+
+require_once __DIR__.'/lib/autoload_runtime.php';
+
+require_once('approot.inc.php');
+require_once('application/startup.inc.php');
+
+return function (array $context) {
+    return new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
+};

application/DBSearchHelper.php

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

application/Html2Text.php

@@ -1,331 +0,0 @@
-<?php
-namespace Html2Text;
-
-if (!function_exists('mb_split'))
-{
-	function mb_split($pattern, $subject, $limit = -1)
-	{
-		return preg_split('/'.$pattern.'/', $subject, $limit);
-	}
-}
-/**
- * Replace all occurrences of the search string with the replacement string.
- *
- * @author Sean Murphy <sean@iamseanmurphy.com>
- * @copyright Copyright 2012 Sean Murphy. All rights reserved.
- * @license http://creativecommons.org/publicdomain/zero/1.0/
- * @link http://php.net/manual/function.str-replace.php
- *
- * @param mixed $search
- * @param mixed $replace
- * @param mixed $subject
- * @param int $count
- * @return mixed
- */
-function mb_str_replace($search, $replace, $subject, &$count = 0) {
-	if (!is_array($subject)) {
-		// Normalize $search and $replace so they are both arrays of the same length
-		$searches = is_array($search) ? array_values($search) : array($search);
-		$replacements = is_array($replace) ? array_values($replace) : array($replace);
-		$replacements = array_pad($replacements, count($searches), '');
-		foreach ($searches as $key => $search) {
-			$parts = mb_split(preg_quote($search), $subject);
-			if (is_array($parts))
-			{
-				$count += count($parts) - 1;
-				$subject = implode($replacements[$key], $parts);
-			}
-		}
-	} else {
-		// Call mb_str_replace for each subject in array, recursively
-		foreach ($subject as $key => $value) {
-			$subject[$key] = mb_str_replace($search, $replace, $value, $count);
-		}
-	}
-	return $subject;
-}
-
-/******************************************************************************
- * Copyright (c) 2010 Jevon Wright and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * or
- *
- * LGPL which is available at http://www.gnu.org/licenses/lgpl.html
- *
- *
- * Contributors:
- *    Jevon Wright - initial API and implementation
- *    Denis Flaven - some fixes for properly handling UTF-8 characters
- ****************************************************************************/
-
-class Html2Text {
-
-	/**
-	 * Tries to convert the given HTML into a plain text format - best suited for
-	 * e-mail display, etc.
-	 *
-	 * <p>In particular, it tries to maintain the following features:
-	 * <ul>
-	 *   <li>Links are maintained, with the 'href' copied over
-	 *   <li>Information in the &lt;head&gt; is lost
-	 * </ul>
-	 *
-	 * @param string html the input HTML
-	 * @return string the HTML converted, as best as possible, to text
-	 * @throws Html2TextException if the HTML could not be loaded as a {@link DOMDocument}
-	 */
-	static function convert($html) {
-		// replace &nbsp; with spaces
-
-		$html = str_replace("&nbsp;", " ", $html);
-		$html = mb_str_replace("\xc2\xa0", " ", $html); // DO NOT USE str_replace since it breaks the "à" character which is \xc3 \xa0 in UTF-8
-
-		$html = static::fixNewlines($html);
-
-		$doc = new \DOMDocument();
-		if (!@$doc->loadHTML('<?xml encoding="UTF-8">'.$html)) // Forces the UTF-8 character set for HTML fragments
-		{
-			throw new Html2TextException("Could not load HTML - badly formed?", $html);
-		}
-
-		$output = static::iterateOverNode($doc);
-
-		// remove leading and trailing spaces on each line
-		$output = preg_replace("/[ \t]*\n[ \t]*/im", "\n", $output);
-		$output = preg_replace("/ *\t */im", "\t", $output);
-
-		// remove unnecessary empty lines
-		$output = preg_replace("/\n\n\n*/im", "\n\n", $output);
-
-		// remove leading and trailing whitespace
-		$output = trim($output);
-
-		return $output;
-	}
-
-	/**
-	 * Unify newlines; in particular, \r\n becomes \n, and
-	 * then \r becomes \n. This means that all newlines (Unix, Windows, Mac)
-	 * all become \ns.
-	 *
-	 * @param string text text with any number of \r, \r\n and \n combinations
-	 * @return string the fixed text
-	 */
-	static function fixNewlines($text) {
-		// replace \r\n to \n
-		$text = str_replace("\r\n", "\n", $text);
-		// remove \rs
-		$text = str_replace("\r", "\n", $text);
-
-		return $text;
-	}
-
-	static function nextChildName($node) {
-		// get the next child
-		$nextNode = $node->nextSibling;
-		while ($nextNode != null) {
-			if ($nextNode instanceof \DOMElement) {
-				break;
-			}
-			$nextNode = $nextNode->nextSibling;
-		}
-		$nextName = null;
-		if ($nextNode instanceof \DOMElement && $nextNode != null) {
-			$nextName = strtolower($nextNode->nodeName);
-		}
-
-		return $nextName;
-	}
-
-	static function prevChildName($node) {
-		// get the previous child
-		$nextNode = $node->previousSibling;
-		while ($nextNode != null) {
-			if ($nextNode instanceof \DOMElement) {
-				break;
-			}
-			$nextNode = $nextNode->previousSibling;
-		}
-		$nextName = null;
-		if ($nextNode instanceof \DOMElement && $nextNode != null) {
-			$nextName = strtolower($nextNode->nodeName);
-		}
-
-		return $nextName;
-	}
-
-	static function iterateOverNode($node) {
-		if ($node instanceof \DOMText) {
-		  // Replace whitespace characters with a space (equivilant to \s)
-			return preg_replace("/[\\t\\n\\f\\r ]+/im", " ", $node->wholeText);
-		}
-		if ($node instanceof \DOMDocumentType) {
-			// ignore
-			return "";
-		}
-
-		$nextName = static::nextChildName($node);
-		$prevName = static::prevChildName($node);
-
-		$name = strtolower($node->nodeName);
-
-		// start whitespace
-		switch ($name) {
-			case "hr":
-				return "---------------------------------------------------------------\n";
-
-			case "style":
-			case "head":
-			case "title":
-			case "meta":
-			case "script":
-				// ignore these tags
-				return "";
-
-			case "h1":
-			case "h2":
-			case "h3":
-			case "h4":
-			case "h5":
-			case "h6":
-			case "ol":
-			case "ul":
-				// add two newlines, second line is added below
-				$output = "\n";
-				break;
-
-			case "td":
-			case "th":
-				// add tab char to separate table fields
-			   $output = "\t";
-			   break;
-
-			case "tr":
-			case "p":
-			case "div":
-				// add one line
-				$output = "\n";
-				break;
-
-			case "li":
-				$output = "- ";
-				break;
-
-			default:
-				// print out contents of unknown tags
-				$output = "";
-				break;
-		}
-
-		// debug
-		//$output .= "[$name,$nextName]";
-
-		if (isset($node->childNodes)) {
-			for ($i = 0; $i < $node->childNodes->length; $i++) {
-				$n = $node->childNodes->item($i);
-
-				$text = static::iterateOverNode($n);
-
-				$output .= $text;
-			}
-		}
-
-		// end whitespace
-		switch ($name) {
-			case "h1":
-			case "h2":
-			case "h3":
-			case "h4":
-			case "h5":
-			case "h6":
-				$output .= "\n";
-				break;
-
-			case "p":
-			case "br":
-				// add one line
-				if ($nextName != "div")
-					$output .= "\n";
-				break;
-
-			case "div":
-				// add one line only if the next child isn't a div
-				if ($nextName != "div" && $nextName != null)
-					$output .= "\n";
-				break;
-
-			case "a":
-				// links are returned in [text](link) format
-				$href = $node->getAttribute("href");
-
-				$output = trim($output);
-
-				// remove double [[ ]] s from linking images
-				if (substr($output, 0, 1) == "[" && substr($output, -1) == "]") {
-					$output = substr($output, 1, strlen($output) - 2);
-
-					// for linking images, the title of the <a> overrides the title of the <img>
-					if ($node->getAttribute("title")) {
-						$output = $node->getAttribute("title");
-					}
-				}
-
-				// if there is no link text, but a title attr
-				if (!$output && $node->getAttribute("title")) {
-					$output = $node->getAttribute("title");
-				}
-
-				if ($href == null) {
-					// it doesn't link anywhere
-					if ($node->getAttribute("name") != null) {
-						$output = "[$output]";
-					}
-				} else {
-					if ($href == $output || $href == "mailto:$output" || $href == "http://$output" || $href == "https://$output") {
-						// link to the same address: just use link
-						$output;
-					} else {
-						// replace it
-						if ($output) {
-							$output = "[$output]($href)";
-						} else {
-							// empty string
-							$output = $href;
-						}
-					}
-				}
-
-				// does the next node require additional whitespace?
-				switch ($nextName) {
-					case "h1": case "h2": case "h3": case "h4": case "h5": case "h6":
-						$output .= "\n";
-						break;
-				}
-				break;
-
-			case "img":
-				if ($node->getAttribute("title")) {
-					$output = "[" . $node->getAttribute("title") . "]";
-				} elseif ($node->getAttribute("alt")) {
-					$output = "[" . $node->getAttribute("alt") . "]";
-				} else {
-					$output = "";
-				}
-				break;
-
-			case "li":
-				$output .= "\n";
-				break;
-
-			default:
-				// do nothing
-		}
-
-		return $output;
-	}
-
-}

application/Html2TextException.php

@@ -1,28 +0,0 @@
-<?php
-
-/******************************************************************************
- * Copyright (c) 2010 Jevon Wright and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * or
- *
- * LGPL which is available at http://www.gnu.org/licenses/lgpl.html
- *
- *
- * Contributors:
- *    Jevon Wright - initial API and implementation
- ****************************************************************************/
-
-namespace Html2Text;
-
-class Html2TextException extends \Exception {
-	var $more_info;
-
-	public function __construct($message = "", $more_info = "") {
-		parent::__construct($message);
-		$this->more_info = $more_info;
-	}
-}

application/ajaxwebpage.class.inc.php

@@ -1,24 +0,0 @@
-<?php
-/**
- * @deprecated  3.0.0 will be removed in 3.1.0 - moved to sources/Application/WebPage/AjaxPage.php, now loadable using autoloader
- * @license     http://opensource.org/licenses/AGPL-3.0
- * @copyright   Copyright (C) 2010-2023 Combodo SARL
- */
-
-// cannot notify depreciation for now as this is still load in autoloader
-//DeprecatedCallsLog::NotifyDeprecatedFile('moved to sources/Application/WebPage/AjaxPage.php, now loadable using autoloader');
-
-/**
- * Class ajax_page
- *
- * @deprecated 3.0.0 will be removed in 3.1.0 - moved to AjaxPage
- */
-class ajax_page extends AjaxPage
-{
-	function __construct($s_title)
-	{
-		DeprecatedCallsLog::NotifyDeprecatedPhpMethod('ajax_page is deprecated. Please use AjaxPage instead');
-		parent::__construct($s_title);
-	}
-}
-

application/application.inc.php

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

application/applicationcontext.class.inc.php

@@ -1,5 +1,5 @@
 <?php
-// Copyright (C) 2010-2023 Combodo SARL
+// Copyright (C) 2010-2024 Combodo SAS
 //
 //   This file is part of iTop.
 //
@@ -20,7 +20,7 @@
 /**
  * Class ApplicationContext
  *
- * @copyright   Copyright (C) 2010-2023 Combodo SARL
+ * @copyright   Copyright (C) 2010-2024 Combodo SAS
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
@@ -195,16 +195,31 @@ class ApplicationContext
 	/**
 	 * Returns the context as string with the format name1=value1&name2=value2....
 	 * @return string The context as a string to be appended to an href property
+	 *
 	 */
-	public function GetForLink()
+	public function GetForLink(bool $bWithLeadingAmpersand = false)
 	{
+		// If there are no parameters, return an empty string
+		if(empty($this->aValues)){
+			return '';
+		}
+
+		// Build the query string with ampersand separated parameters
 		$aParams = array();
 		foreach($this->aValues as $sName => $sValue)
 		{
 			$aParams[] = "c[$sName]".'='.urlencode($sValue);
 		}
-		return implode("&", $aParams);
+		$sReturnValue = implode('&', $aParams);
+
+		// add the leading ampersand if requested
+		if($bWithLeadingAmpersand){
+			$sReturnValue = '&' . $sReturnValue;
+		}
+
+		return $sReturnValue;
 	}
+
 	/**
 	 * @since 3.0.0 N°2534 - dashboard: bug with autorefresh that deactivates filtering on organisation
 	 * Returns the params as c[menu]:..., c[org_id]:....
@@ -382,7 +397,7 @@ class ApplicationContext
 		$sUrl = call_user_func(array($sUrlMakerClass, 'MakeObjectUrl'), $sObjClass, $sObjKey);
 	   if (utils::StrLen($sUrl) > 0) {
 		   if ($bWithNavigationContext) {
-			   return $sUrl."&".$oAppContext->GetForLink();
+			   return $sUrl.$oAppContext->GetForLink(true);
 		   } else {
 			   return $sUrl;
 		   }

application/applicationextension/backoffice/AbstractApplicationUIExtension.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * Extend this class instead of implementing iApplicationUIExtension if you don't need to overload
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since       2.7.0
+ */
+abstract class AbstractApplicationUIExtension implements iApplicationUIExtension
+{
+    /**
+     * @inheritDoc
+     */
+    public function OnDisplayProperties($oObject, \Combodo\iTop\Application\WebPage\WebPage $oPage, $bEditMode = false)
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function OnDisplayRelations($oObject, \Combodo\iTop\Application\WebPage\WebPage $oPage, $bEditMode = false)
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function OnFormSubmit($oObject, $sFormPrefix = '')
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function OnFormCancel($sTempId)
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function EnumUsedAttributes($oObject)
+    {
+        return array();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function GetIcon($oObject)
+    {
+        return '';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function GetHilightClass($oObject)
+    {
+        return HILIGHT_CLASS_NONE;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function EnumAllowedActions(DBObjectSet $oSet)
+    {
+        return array();
+    }
+
+}

application/applicationextension/backoffice/AbstractPageUIBlockExtension.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Extend this class instead of iPageUIBlockExtension if you don't need to overload all methods
+ *
+ * @api
+ * @package     UIBlockExtensibilityAPI
+ * @since       3.0.0
+ */
+abstract class AbstractPageUIBlockExtension implements iPageUIBlockExtension
+{
+    /**
+     * @inheritDoc
+     */
+    public function GetBannerBlock()
+    {
+        return null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function GetHeaderBlock()
+    {
+        return null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function GetFooterBlock()
+    {
+        return null;
+    }
+}

application/applicationextension/backoffice/AbstractPreferencesExtension.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * Extend this class instead of implementing iPreferencesExtension if you don't need to overload all methods
+ *
+ * @api
+ * @package     PreferencesExtensibilityAPI
+ * @since       2.7.0
+ */
+abstract class AbstractPreferencesExtension implements iPreferencesExtension
+{
+    /**
+     * @inheritDoc
+     */
+    public function DisplayPreferences(\Combodo\iTop\Application\WebPage\WebPage $oPage)
+    {
+        // Do nothing
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function ApplyPreferences(\Combodo\iTop\Application\WebPage\WebPage $oPage, $sOperation)
+    {
+        // Do nothing
+    }
+
+}

application/applicationextension/backoffice/AbstractWelcomePopupExtension.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Inherit from this class to provide messages to be displayed in the "Welcome Popup"
+ *
+ * @api
+ * @since 3.2.0
+ */
+abstract class AbstractWelcomePopupExtension implements iWelcomePopupExtension
+{
+    /**
+     * @inheritDoc
+     */
+    public function GetIconRelPath(): string
+    {
+        return \Combodo\iTop\Application\Branding::$aLogoPaths[\Combodo\iTop\Application\Branding::ENUM_LOGO_TYPE_MAIN_LOGO_COMPACT]['default'];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function GetMessages(): array
+    {
+        return [];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function AcknowledgeMessage(string $sMessageId): void
+    {
+        // No need to process the acknowledgment notice by default
+        return;
+    }
+}

application/applicationextension/backoffice/ApplicationPopupMenuItem.php

@@ -0,0 +1,150 @@
+<?php
+
+/**
+ * Base class for the various types of custom menus
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+abstract class ApplicationPopupMenuItem
+{
+    /** @ignore */
+    protected $sUID;
+    /** @ignore */
+    protected $sLabel;
+    /** @ignore */
+    protected $sTooltip;
+    /** @ignore */
+    protected $sIconClass;
+    /** @ignore */
+    protected $aCssClasses;
+
+    /**
+     * Constructor
+     *
+     * @param string $sUID The unique identifier of this menu in iTop... make sure you pass something unique enough
+     * @param string $sLabel The display label of the menu (must be localized)
+     * @api
+     */
+    public function __construct($sUID, $sLabel)
+    {
+        $this->sUID = $sUID;
+        $this->sLabel = $sLabel;
+        $this->sTooltip = '';
+        $this->sIconClass = '';
+        $this->aCssClasses = array();
+    }
+
+    /**
+     * Get the UID
+     *
+     * @return string The unique identifier
+     * @ignore
+     */
+    public function GetUID()
+    {
+        return $this->sUID;
+    }
+
+    /**
+     * Get the label
+     *
+     * @return string The label
+     * @ignore
+     */
+    public function GetLabel()
+    {
+        return $this->sLabel;
+    }
+
+    /**
+     * Get the CSS classes
+     *
+     * @return array
+     * @ignore
+     */
+    public function GetCssClasses()
+    {
+        return $this->aCssClasses;
+    }
+
+    /**
+     * @param $aCssClasses
+     * @api
+     */
+    public function SetCssClasses($aCssClasses)
+    {
+        $this->aCssClasses = $aCssClasses;
+    }
+
+    /**
+     * Adds a CSS class to the CSS classes that will be put on the menu item
+     *
+     * @param $sCssClass
+     * @api
+     */
+    public function AddCssClass($sCssClass)
+    {
+        $this->aCssClasses[] = $sCssClass;
+    }
+
+
+    /**
+     * @param $sTooltip
+     *
+     * @api
+     * @since 3.0.0
+     */
+    public function SetTooltip($sTooltip)
+    {
+        $this->sTooltip = $sTooltip;
+    }
+
+    /**
+     * @return string
+     *
+     * @api
+     * @since 3.0.0
+     */
+    public function GetTooltip()
+    {
+        return $this->sTooltip;
+    }
+
+    /**
+     * @param $sIconClass
+     *
+     * @api
+     * @since 3.0.0
+     */
+    public function SetIconClass($sIconClass)
+    {
+        $this->sIconClass = $sIconClass;
+    }
+
+    /**
+     * @return string
+     *
+     * @api
+     * @since 3.0.0
+     */
+    public function GetIconClass()
+    {
+        return $this->sIconClass;
+    }
+
+    /**
+     * Returns the components to create a popup menu item in HTML
+     *
+     * @return array A hash array: array('label' => , 'url' => , 'target' => , 'onclick' => )
+     * @ignore
+     */
+    abstract public function GetMenuItem();
+
+    /** @ignore */
+    public function GetLinkedScripts()
+    {
+        return array();
+    }
+}

application/applicationextension/backoffice/JSButtonItem.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * Class for adding an item as a button that runs some JS code
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+class JSButtonItem extends JSPopupMenuItem
+{
+
+}

application/applicationextension/backoffice/JSPopupMenuItem.php

@@ -0,0 +1,70 @@
+<?php
+
+/**
+ * Class for adding an item into a popup menu that triggers some Javascript code
+ *
+ * Note: This works only in the backoffice, {@see \JSButtonItem} for the end-user portal
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+class JSPopupMenuItem extends ApplicationPopupMenuItem
+{
+    /** @ignore */
+    protected $sJsCode;
+    /** @ignore */
+    protected $sUrl;
+    /** @ignore */
+    protected $aIncludeJSFiles;
+
+    /**
+     * Class for adding an item that triggers some Javascript code
+     *
+     * @param string $sUID The unique identifier of this menu in iTop... make sure you pass something unique enough
+     * @param string $sLabel The display label of the menu (must be localized)
+     * @param string $sJSCode In case the menu consists in executing some havascript code inside the page, pass it here. If supplied $sURL
+     *     ans $sTarget will be ignored
+     * @param array $aIncludeJSFiles An array of file URLs to be included (once) to provide some JS libraries for the page.
+     * @api
+     */
+    public function __construct($sUID, $sLabel, $sJSCode, $aIncludeJSFiles = array())
+    {
+        parent::__construct($sUID, $sLabel);
+        $this->sJsCode = $sJSCode;
+        $this->sUrl = '#';
+        $this->aIncludeJSFiles = $aIncludeJSFiles;
+    }
+
+    /** @ignore */
+    public function GetMenuItem()
+    {
+        // Note: the semicolumn is a must here!
+        return array(
+            'label' => $this->GetLabel(),
+            'onclick' => $this->GetJsCode() . '; return false;',
+            'url' => $this->GetUrl(),
+            'css_classes' => $this->GetCssClasses(),
+            'icon_class' => $this->sIconClass,
+            'tooltip' => $this->sTooltip
+        );
+    }
+
+    /** @ignore */
+    public function GetLinkedScripts()
+    {
+        return $this->aIncludeJSFiles;
+    }
+
+    /** @ignore */
+    public function GetJsCode()
+    {
+        return $this->sJsCode;
+    }
+
+    /** @ignore */
+    public function GetUrl()
+    {
+        return $this->sUrl;
+    }
+}

application/applicationextension/backoffice/SeparatorPopupMenuItem.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Class for adding a separator (horizontal line, not selectable) the output
+ * will automatically reduce several consecutive separators to just one
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+class SeparatorPopupMenuItem extends ApplicationPopupMenuItem
+{
+    static $idx = 0;
+
+    /**
+     * Constructor
+     * @api
+     */
+    public function __construct()
+    {
+        parent::__construct('_separator_' . (self::$idx++), '');
+    }
+
+    /** @ignore */
+    public function GetMenuItem()
+    {
+        return array('label' => '<hr class="menu-separator">', 'url' => '', 'css_classes' => $this->aCssClasses);
+    }
+}

application/applicationextension/backoffice/URLButtonItem.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * Class for adding an item as a button that browses to the given URL
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+class URLButtonItem extends URLPopupMenuItem
+{
+
+}

application/applicationextension/backoffice/URLPopupMenuItem.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * Class for adding an item into a popup menu that browses to the given URL
+ *
+ * Note: This works only in the backoffice, {@see \URLButtonItem} for the end-user portal
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+class URLPopupMenuItem extends ApplicationPopupMenuItem
+{
+    /** @ignore */
+    protected $sUrl;
+    /** @ignore */
+    protected $sTarget;
+
+    /**
+     * Constructor
+     *
+     * @param string $sUID The unique identifier of this menu in iTop... make sure you pass something unique enough
+     * @param string $sLabel The display label of the menu (must be localized)
+     * @param string $sUrl If the menu is an hyperlink, provide the absolute hyperlink here
+     * @param string $sTarget In case the menu is an hyperlink and a specific target is needed (_blank for example), pass it here
+     * @api
+     */
+    public function __construct($sUID, $sLabel, $sUrl, $sTarget = '_top')
+    {
+        parent::__construct($sUID, $sLabel);
+        $this->sUrl = $sUrl;
+        $this->sTarget = $sTarget;
+    }
+
+    /** @ignore */
+    public function GetMenuItem()
+    {
+        return array('label' => $this->GetLabel(),
+            'url' => $this->GetUrl(),
+            'target' => $this->GetTarget(),
+            'css_classes' => $this->aCssClasses,
+            'icon_class' => $this->sIconClass,
+            'tooltip' => $this->sTooltip
+        );
+    }
+
+    /** @ignore */
+    public function GetUrl()
+    {
+        return $this->sUrl;
+    }
+
+    /** @ignore */
+    public function GetTarget()
+    {
+        return $this->sTarget;
+    }
+}

application/applicationextension/backoffice/iApplicationUIExtension.php

@@ -0,0 +1,173 @@
+<?php
+
+/**
+ * Implement this interface to change the behavior of the GUI for some objects.
+ *
+ * All methods are invoked by iTop for a given object. There are basically two usages:
+ *
+ * 1) To tweak the form of an object, you will have to implement a specific behavior within:
+ *
+ * * OnDisplayProperties (bEditMode = true)
+ * * OnFormSubmit
+ * * OnFormCancel
+ *
+ * 2) To tune the display of the object details, you can use:
+ *
+ * * OnDisplayProperties
+ * * OnDisplayRelations
+ * * GetIcon
+ * * GetHilightClass
+ *
+ * Please note that some of the APIs can be called several times for a single page displayed.
+ * Therefore it is not recommended to perform too many operations, such as querying the database.
+ * A recommended pattern is to cache data by the mean of static members.
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ */
+interface iApplicationUIExtension
+{
+    /**
+     *    Invoked when an object is being displayed (wiew or edit)
+     *
+     * The method is called right after the main tab has been displayed.
+     * You can add output to the page, either to change the display, or to add a form input
+     *
+     * Example:
+     * <code>
+     * if ($bEditMode)
+     * {
+     *    $oPage->p('Age of the captain: &lt;input type="text" name="captain_age"/&gt;');
+     * }
+     * else
+     * {
+     *    $oPage->p('Age of the captain: '.$iCaptainAge);
+     * }
+     * </code>
+     *
+     * @api
+     *
+     *@param \Combodo\iTop\Application\WebPage\WebPage $oPage The output context
+     * @param boolean $bEditMode True if the edition form is being displayed
+     *
+     * @param DBObject $oObject The object being displayed
+     *
+     * @return void
+     */
+    public function OnDisplayProperties($oObject, \Combodo\iTop\Application\WebPage\WebPage $oPage, $bEditMode = false);
+
+    /**
+     * Invoked when an object is being displayed (wiew or edit)
+     *
+     * The method is called rigth after all the tabs have been displayed
+     *
+     * @api
+     *
+     *@param \Combodo\iTop\Application\WebPage\WebPage $oPage The output context
+     * @param boolean $bEditMode True if the edition form is being displayed
+     *
+     * @param DBObject $oObject The object being displayed
+     *
+     * @return void
+     */
+    public function OnDisplayRelations($oObject, \Combodo\iTop\Application\WebPage\WebPage $oPage, $bEditMode = false);
+
+    /**
+     * Invoked when the end-user clicks on Modify from the object edition form
+     *
+     * The method is called after the changes from the standard form have been
+     * taken into account, and before saving the changes into the database.
+     *
+     * @param DBObject $oObject The object being edited
+     * @param string $sFormPrefix Prefix given to the HTML form inputs
+     *
+     * @return void
+     * @api
+     */
+    public function OnFormSubmit($oObject, $sFormPrefix = '');
+
+    /**
+     * Invoked when the end-user clicks on Cancel from the object edition form
+     *
+     * Implement here any cleanup. This is necessary when you have injected some
+     * javascript into the edition form, and if that code requires to store temporary data
+     * (this is the case when a file must be uploaded).
+     *
+     * @param string $sTempId Unique temporary identifier made of session_id and transaction_id. It identifies the object in a unique way.
+     *
+     * @return void
+     * @api
+     */
+    public function OnFormCancel($sTempId);
+
+    /**
+     * Not yet called by the framework!
+     *
+     * Sorry, the verb has been reserved. You must implement it, but it is not called as of now.
+     *
+     * @param DBObject $oObject The object being displayed
+     *
+     * @return string[] desc
+     * @api
+     */
+    public function EnumUsedAttributes($oObject); // Not yet implemented
+
+    /**
+     * Not yet called by the framework!
+     *
+     * Sorry, the verb has been reserved. You must implement it, but it is not called as of now.
+     *
+     * @param DBObject $oObject The object being displayed
+     *
+     * @return string Path of the icon, relative to the modules directory.
+     * @api
+     */
+    public function GetIcon($oObject); // Not yet implemented
+
+    /**
+     * Invoked when the object is displayed alone or within a list
+     *
+     * Returns a value influencing the appearance of the object depending on its
+     * state.
+     *
+     * Possible values are:
+     *
+     * * HILIGHT_CLASS_CRITICAL
+     * * HILIGHT_CLASS_WARNING
+     * * HILIGHT_CLASS_OK
+     * * HILIGHT_CLASS_NONE
+     *
+     * @param DBObject $oObject The object being displayed
+     *
+     * @return integer The value representing the mood of the object
+     * @api
+     */
+    public function GetHilightClass($oObject);
+
+    /**
+     * Called when building the Actions menu for a single object or a list of objects
+     *
+     * Use this to add items to the Actions menu. You will have to specify a label and an URL.
+     *
+     * Example:
+     * <code>
+     * $oObject = $oSet->fetch();
+     * if ($oObject instanceof Sheep)
+     * {
+     *    return array('View in my app' => 'http://myserver/view_sheeps?id='.$oObject->Get('name'));
+     * }
+     * else
+     * {
+     *    return array();
+     * }
+     * </code>
+     *
+     * See also iPopupMenuExtension for greater flexibility
+     *
+     * @param DBObjectSet $oSet A set of persistent objects (DBObject)
+     *
+     * @return array
+     * @api
+     */
+    public function EnumAllowedActions(DBObjectSet $oSet);
+}

application/applicationextension/backoffice/iBackofficeDictEntriesExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add Dict entries
+ *
+ * @see \iTopWebPage::$a_dict_entries
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeDictEntriesExtension
+{
+    /**
+     * @return array
+     * @see \iTopWebPage::a_dict_entries
+     * @api
+     */
+    public function GetDictEntries(): array;
+}

application/applicationextension/backoffice/iBackofficeDictEntriesPrefixesExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add Dict entries prefixes
+ *
+ * @see \iTopWebPage::$a_dict_entries_prefixes
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeDictEntriesPrefixesExtension
+{
+    /**
+     * @return array
+     * @see \iTopWebPage::a_dict_entries_prefixes
+     * @api
+     */
+    public function GetDictEntriesPrefixes(): array;
+}

application/applicationextension/backoffice/iBackofficeEarlyScriptExtension.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * Implement this interface to add inline script (JS) to the backoffice pages' head.
+ * Will be executed first, BEFORE the DOM interpretation.
+ *
+ * @see \iTopWebPage::$a_early_scripts
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeEarlyScriptExtension
+{
+    /**
+     * @return string
+     * @see \iTopWebPage::$a_early_scripts
+     * @api
+     */
+    public function GetEarlyScript(): string;
+}

application/applicationextension/backoffice/iBackofficeInitScriptExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add inline script (JS) to the backoffice pages that will be executed right when the DOM is ready.
+ *
+ * @see \iTopWebPage::$a_init_scripts
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeInitScriptExtension
+{
+    /**
+     * @return string
+     * @see \iTopWebPage::$a_init_scripts
+     * @api
+     */
+    public function GetInitScript(): string;
+}

application/applicationextension/backoffice/iBackofficeLinkedScriptsExtension.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * Implement this interface to add script (JS) files to the backoffice pages
+ *
+ * @see \iTopWebPage::$a_linked_scripts
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeLinkedScriptsExtension
+{
+    /**
+     * Each script will be included using this property
+     * @return array An array of absolute URLs to the files to include
+     * @see \iTopWebPage::$a_linked_scripts
+     * @api
+     */
+    public function GetLinkedScriptsAbsUrls(): array;
+}

application/applicationextension/backoffice/iBackofficeLinkedStylesheetsExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add stylesheets (CSS) to the backoffice pages
+ *
+ * @see \iTopWebPage::$a_linked_stylesheets
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeLinkedStylesheetsExtension
+{
+    /**
+     * @return array An array of absolute URLs to the files to include
+     * @see \iTopWebPage::$a_linked_stylesheets
+     * @api
+     */
+    public function GetLinkedStylesheetsAbsUrls(): array;
+}

application/applicationextension/backoffice/iBackofficeReadyScriptExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add inline script (JS) to the backoffice pages that will be executed slightly AFTER the DOM is ready (just after the init. scripts).
+ *
+ * @see \iTopWebPage::$a_ready_scripts
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeReadyScriptExtension
+{
+    /**
+     * @return string
+     * @see \iTopWebPage::$a_ready_scripts
+     * @api
+     */
+    public function GetReadyScript(): string;
+}

application/applicationextension/backoffice/iBackofficeSassExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add sass file (SCSS) to the backoffice pages.
+ * example: return "css/setup.scss"
+ *
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.3.0
+ */
+interface iBackofficeSassExtension
+{
+    /**
+     * @return string
+     * @see \iTopWebPage::$a_styles
+     * @api
+     */
+    public function GetSass(): string;
+}

application/applicationextension/backoffice/iBackofficeScriptExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add inline script (JS) to the backoffice pages that will be executed immediately, without waiting for the DOM to be ready.
+ *
+ * @see \iTopWebPage::$a_scripts
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeScriptExtension
+{
+    /**
+     * @return string
+     * @see \iTopWebPage::$a_scripts
+     * @api
+     */
+    public function GetScript(): string;
+}

application/applicationextension/backoffice/iBackofficeStyleExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Implement this interface to add inline style (CSS) to the backoffice pages' head.
+ *
+ * @see \iTopWebPage::$a_styles
+ * @api
+ * @package BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iBackofficeStyleExtension
+{
+    /**
+     * @return string
+     * @see \iTopWebPage::$a_styles
+     * @api
+     */
+    public function GetStyle(): string;
+}

application/applicationextension/backoffice/iFieldRendererMappingsExtension.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Implement this interface to register a new field renderer mapping to either:
+ * - Add the rendering of a new attribute type
+ * - Overload the default rendering of an attribute type
+ *
+ * @since 3.1.0 N°6041
+ *
+ * @experimental Form / Field / Renderer should be used in more places in next iTop releases, which may introduce major API changes
+ */
+interface iFieldRendererMappingsExtension
+{
+    /**
+     * @return array {
+     *              array: {
+     *                  field: string,
+     *                  form_renderer: string,
+     *                  field_renderer: string
+     *              }
+     *          }  List of field renderer mapping: FQCN field class, FQCN Form Renderer class, FQCN Field Renderer class
+     *
+     * Example:
+     *
+     * ```php
+     * [
+     *  ['field' => 'FQCN\FieldA', 'form_renderer' => 'Combodo\iTop\Renderer\Console\ConsoleFormRenderer', 'field_renderer' => 'FQCN\FieldRendererA'],
+     *  ['field' => 'FQCN\FieldB', 'form_renderer' => 'Combodo\iTop\Renderer\Console\ConsoleFormRenderer', 'field_renderer' => 'FQCN\FieldRendererB'],
+     *  ['field' => 'FQCN\FieldA', 'form_renderer' => 'Combodo\iTop\Renderer\Bootstrap\BsFormRenderer', 'field_renderer' => 'FQCN\FieldRendererA'],
+     *  ['field' => 'FQCN\FieldB', 'form_renderer' => 'Combodo\iTop\Renderer\Bootstrap\BsFormRenderer', 'field_renderer' => 'FQCN\FieldRendererB'],
+     * ]
+     * ```
+     */
+    public static function RegisterSupportedFields(): array;
+}

application/applicationextension/backoffice/iPageUIBlockExtension.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * Implement this interface to add content to any iTopWebPage
+ *
+ * There are 3 places where content can be added:
+ *
+ * * The north pane: (normaly empty/hidden) at the top of the page, spanning the whole
+ *   width of the page
+ * * The south pane: (normaly empty/hidden) at the bottom of the page, spanning the whole
+ *   width of the page
+ * * The admin banner (two tones gray background) at the left of the global search.
+ *   Limited space, use it for short messages
+ *
+ * Each of the methods of this interface is supposed to return the HTML to be inserted at
+ * the specified place and can use the passed iTopWebPage object to add javascript or CSS definitions
+ *
+ * @api
+ * @package     BackofficeUIExtensibilityAPI
+ * @since 3.0.0
+ */
+interface iPageUIBlockExtension
+{
+    /**
+     * Add content to the "admin banner"
+     *
+     * @api
+     * @return \Combodo\iTop\Application\UI\Base\iUIBlock|null The Block to add into the page
+     */
+    public function GetBannerBlock();
+
+    /**
+     * Add content to the header of the page
+     *
+     * @api
+     * @return \Combodo\iTop\Application\UI\Base\iUIBlock|null The Block to add into the page
+     */
+    public function GetHeaderBlock();
+
+    /**
+     * Add content to the footer of the page
+     *
+     * @api
+     * @return \Combodo\iTop\Application\UI\Base\iUIBlock|null The Block to add into the page
+     */
+    public function GetFooterBlock();
+}

application/applicationextension/backoffice/iPopupMenuExtension.php

@@ -0,0 +1,112 @@
+<?php
+
+/**
+ * New extension to add menu items in the "popup" menus inside iTop. Provides a greater flexibility than
+ * iApplicationUIExtension::EnumAllowedActions.
+ *
+ * To add some menus into iTop, declare a class that implements this interface, it will be called automatically
+ * by the application, as long as the class definition is included somewhere in the code
+ *
+ * @api
+ * @package     UIExtensibilityAPI
+ * @since 2.0
+ */
+interface iPopupMenuExtension
+{
+    /**
+     * Insert an item into the Actions menu of a list
+     *
+     * $param is a DBObjectSet containing the list of objects
+     * @api
+     */
+    const MENU_OBJLIST_ACTIONS = 1;
+    /**
+     * Insert an item into the Toolkit menu of a list
+     *
+     * $param is a DBObjectSet containing the list of objects
+     * @api
+     */
+    const MENU_OBJLIST_TOOLKIT = 2;
+    /**
+     * Insert an item into the Actions menu on an object details page
+     *
+     * $param is a DBObject instance: the object currently displayed
+     * @api
+     */
+    const MENU_OBJDETAILS_ACTIONS = 3;
+    /**
+     * Insert an item into the Dashboard menu
+     *
+     * The dashboad menu is shown on the top right corner when a dashboard
+     * is being displayed.
+     *
+     * $param is a Dashboard instance: the dashboard currently displayed
+     * @api
+     */
+    const MENU_DASHBOARD_ACTIONS = 4;
+    /**
+     * Insert an item into the User menu (upper right corner)
+     *
+     * $param is null
+     * @api
+     */
+    const MENU_USER_ACTIONS = 5;
+    /**
+     * Insert an item into the Action menu on an object item in an objects list in the portal
+     *
+     * $param is an array('portal_id' => $sPortalId, 'object' => $oObject) containing the portal id and a DBObject instance (the object on
+     * the current line)
+     * @api
+     */
+    const PORTAL_OBJLISTITEM_ACTIONS = 7;
+    /**
+     * Insert an item into the Action menu on an object details page in the portal
+     *
+     * $param is an array('portal_id' => $sPortalId, 'object' => $oObject) containing the portal id and a DBObject instance (the object
+     * currently displayed)
+     * @api
+     */
+    const PORTAL_OBJDETAILS_ACTIONS = 8;
+
+    /**
+     * Insert an item into the Actions menu of a list in the portal
+     * Note: This is not implemented yet !
+     *
+     * $param is an array('portal_id' => $sPortalId, 'object_set' => $oSet) containing DBObjectSet containing the list of objects
+     *
+     * @todo
+     */
+    const PORTAL_OBJLIST_ACTIONS = 6;
+    /**
+     * Insert an item into the user menu of the portal
+     * Note: This is not implemented yet !
+     *
+     * $param is the portal id
+     *
+     * @todo
+     */
+    const PORTAL_USER_ACTIONS = 9;
+    /**
+     * Insert an item into the navigation menu of the portal
+     * Note: This is not implemented yet !
+     *
+     * $param is the portal id
+     *
+     * @todo
+     */
+    const PORTAL_MENU_ACTIONS = 10;
+
+    /**
+     * Get the list of items to be added to a menu.
+     *
+     * This method is called by the framework for each menu.
+     * The items will be inserted in the menu in the order of the returned array.
+     *
+     * @param int $iMenuId The identifier of the type of menu, as listed by the constants MENU_xxx
+     * @param mixed $param Depends on $iMenuId, see the constants defined above
+     *
+     * @return object[] An array of ApplicationPopupMenuItem or an empty array if no action is to be added to the menu
+     * @api
+     */
+    public static function EnumItems($iMenuId, $param);
+}

application/applicationextension/backoffice/iPreferencesExtension.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @api
+ * @package     PreferencesExtensibilityAPI
+ * @since 2.7.0
+ */
+interface iPreferencesExtension
+{
+    /**
+     * @api
+     *
+     * @param \Combodo\iTop\Application\WebPage\WebPage $oPage
+     *
+     */
+    public function DisplayPreferences(\Combodo\iTop\Application\WebPage\WebPage $oPage);
+
+    /**
+     * @api
+     *
+     * @param string $sOperation
+     *
+     * @param \Combodo\iTop\Application\WebPage\WebPage $oPage
+     *
+     * @return bool true if the operation has been used
+     */
+    public function ApplyPreferences(\Combodo\iTop\Application\WebPage\WebPage $oPage, $sOperation);
+}

application/applicationextension/backoffice/iWelcomePopupExtension.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * Interface to provide messages to be displayed in the "Welcome Popup"
+ *
+ * @api
+ * @since 3.2.0
+ */
+interface iWelcomePopupExtension
+{
+    // Importance for ordering messages
+    // Just two levels since less important messages have nothing to do in the welcome popup
+    public const ENUM_IMPORTANCE_CRITICAL = 0;
+    public const ENUM_IMPORTANCE_HIGH = 1;
+    public const DEFAULT_IMPORTANCE = self::ENUM_IMPORTANCE_HIGH;
+
+    /**
+     * Overload this method if you need to display an icon representing the provider (eg. your own company logo, module icon, ...)
+     *
+     * @return string Relative path (from app. root) of the icon representing the provider
+     * @api
+     */
+    public function GetIconRelPath(): string;
+
+    /**
+     * @return \Combodo\iTop\Application\WelcomePopup\Message[]
+     * @api
+     */
+    public function GetMessages(): array;
+
+    /**
+     * Overload this method if the provider needs to do some additional processing after the message ($sMessageId) has been acknowledged by the current user
+     *
+     * @param string $sMessageId
+     * @api
+     */
+    public function AcknowledgeMessage(string $sMessageId): void;
+}

application/applicationextension/iBackupExtraFilesExtension.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * Implement this interface to add files to the backup
+ *
+ * @api
+ * @since 3.2.0
+ */
+interface iBackupExtraFilesExtension
+{
+    /**
+     * @return string[] Array of relative paths (from app root) for files and directories to be included in the backup
+     * @api
+     */
+    public function GetExtraFilesRelPaths(): array;
+}

application/applicationextension/iKPILoggerExtension.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * KPI logging extensibility point
+ *
+ * KPI Logger extension
+ */
+interface iKPILoggerExtension
+{
+    /**
+     * Init the statistics collected
+     *
+     * @return void
+     */
+    public function InitStats();
+
+    /**
+     * Add a new KPI to the stats
+     *
+     * @param \Combodo\iTop\Core\Kpi\KpiLogData $oKpiLogData
+     *
+     * @return mixed
+     */
+    public function LogOperation($oKpiLogData);
+}

application/applicationextension/iModuleExtension.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * Helpers for modules extensibility, with discover performed by the MetaModel.
+ *
+ *
+ * @api
+ * @package     Extensibility
+ */
+interface iModuleExtension
+{
+    /**
+     * @api
+     */
+    public function __construct();
+}

application/applicationextension/login/AbstractLoginFSMExtension.php

@@ -0,0 +1,159 @@
+<?php
+
+/**
+ * Login finite state machine
+ *
+ * Execute the action corresponding to the current login state.
+ *
+ *  * If a page is displayed, the action must exit at this point
+ *  * if LoginWebPage::LOGIN_FSM_RETURN_ERROR is returned $iErrorCode must be set
+ *  * if LoginWebPage::LOGIN_FSM_RETURN_OK is returned then the login is OK and terminated
+ *  * if LoginWebPage::LOGIN_FSM_CONTINUE is returned then the FSM will proceed to next plugin or to next state
+ *
+ * @api
+ * @package LoginExtensibilityAPI
+ * @since 2.7.0
+ */
+abstract class AbstractLoginFSMExtension implements iLoginFSMExtension
+{
+    /**
+     * @inheritDoc
+     */
+    abstract public function ListSupportedLoginModes();
+
+    /**
+     * @inheritDoc
+     */
+    public function LoginAction($sLoginState, &$iErrorCode)
+    {
+        switch ($sLoginState) {
+            case LoginWebPage::LOGIN_STATE_START:
+                return $this->OnStart($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_MODE_DETECTION:
+                return $this->OnModeDetection($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_READ_CREDENTIALS:
+                return $this->OnReadCredentials($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_CHECK_CREDENTIALS:
+                return $this->OnCheckCredentials($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_CREDENTIALS_OK:
+                return $this->OnCredentialsOK($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_USER_OK:
+                return $this->OnUsersOK($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_CONNECTED:
+                return $this->OnConnected($iErrorCode);
+
+            case LoginWebPage::LOGIN_STATE_ERROR:
+                return $this->OnError($iErrorCode);
+        }
+
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * Initialization
+     *
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnStart(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * Detect login mode explicitly without respecting configured order (legacy mode)
+     * In most case do nothing here
+     *
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnModeDetection(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * Obtain the credentials either if login mode is empty or set to yours.
+     * This step can be called multiple times by the FSM:
+     * for example:
+     * 1 - display login form
+     * 2 - read the values posted by the user (store that in session)
+     *
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnReadCredentials(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * Control the validity of the data from the session
+     * Automatic user provisioning can be done here
+     *
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnCheckCredentials(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnCredentialsOK(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnUsersOK(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnConnected(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+
+    /**
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    protected function OnError(&$iErrorCode)
+    {
+        return LoginWebPage::LOGIN_FSM_CONTINUE;
+    }
+}

application/applicationextension/login/iLoginExtension.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @api
+ * @package     LoginExtensibilityAPI
+ * @since       2.7.0
+ */
+interface iLoginExtension
+{
+    /**
+     * Return the list of supported login modes for this plugin
+     *
+     * @return array of supported login modes
+     * @api
+     */
+    public function ListSupportedLoginModes();
+}

application/applicationextension/login/iLoginFSMExtension.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * @api
+ * @package     LoginExtensibilityAPI
+ * @since 2.7.0
+ */
+interface iLoginFSMExtension extends iLoginExtension
+{
+    /**
+     * Execute action for this login state
+     * If a page is displayed, the action must exit at this point
+     * if LoginWebPage::LOGIN_FSM_RETURN_ERROR is returned $iErrorCode must be set
+     * if LoginWebPage::LOGIN_FSM_RETURN_OK is returned then the login is OK and terminated
+     * if LoginWebPage::LOGIN_FSM_CONTINUE is returned then the FSM will proceed to next plugin or state
+     *
+     * @param string $sLoginState (see LoginWebPage::LOGIN_STATE_...)
+     * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+     *
+     * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_CONTINUE
+     * @api
+     */
+    public function LoginAction($sLoginState, &$iErrorCode);
+}

application/applicationextension/login/iLoginUIExtension.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Login page extensibility
+ *
+ * @api
+ * @package UIExtensibilityAPI
+ * @since 2.7.0
+ */
+interface iLoginUIExtension extends iLoginExtension
+{
+    /**
+     * @return LoginTwigContext
+     * @api
+     */
+    public function GetTwigContext();
+}

application/applicationextension/login/iLogoutExtension.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * @api
+ * @package LoginExtensibilityAPI
+ * @since 2.7.0
+ */
+interface iLogoutExtension extends iLoginExtension
+{
+    /**
+     * Execute all actions to log out properly
+     * @api
+     */
+    public function LogoutAction();
+}