N°2174 ExternalField to friendlyname : restore behavior without dict key

* displaying "class -> field" was breaking exports (columns labels for ext fields to friendlynames in default datamodel, for example UserRequest.agent_id_friendlyname)
* dict key is always searched first, so a custom label can always be set

.doc/README.md

@@ -0,0 +1,103 @@
+# Phpdoc dokuwiki template
+This directory contains a template rendering iTop phpdoc as wiki pages.
+
+
+conventional tag 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 tags where 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 with `ClassName::` 
+   * 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 ans 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 enclose 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
+```
+composer require phpdocumentor/phpdocumentor:~2 --dev
+```
+
+## Generation
+`.doc/bin/build-doc-object-manipulation` and `.doc/bin/build-doc-extensions` contains examples of doc. generation, beware: they have to be called from iTop root directory:
+```shell
+cd /path/to/itop/
+./.doc/bin/build-doc-object-manipulation
+``` 
+
+the resulting documentation is written into `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

@@ -0,0 +1,7 @@
+#!/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 .doc/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

@@ -0,0 +1,8 @@
+#!/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 .doc/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/phpdoc-extensions.dist.xml

@@ -0,0 +1,20 @@
+<?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

@@ -0,0 +1,58 @@
+<?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

@@ -0,0 +1,136 @@
+{% 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

@@ -0,0 +1,31 @@
+{% 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

@@ -0,0 +1,95 @@
+{% 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

@@ -0,0 +1,49 @@
+{% 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

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

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

@@ -0,0 +1,122 @@
+{% 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

@@ -0,0 +1,42 @@
+{% 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

@@ -0,0 +1,5 @@
+# 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

@@ -0,0 +1,34 @@
+{% 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

@@ -0,0 +1,12 @@
+{% 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

@@ -0,0 +1,26 @@
+{% 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 informations]]
+
+</WRAP>{# group #}
+
+{% endfor %}
+

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

@@ -0,0 +1,26 @@
+{% 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

@@ -0,0 +1,56 @@
+{% 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

@@ -0,0 +1,20 @@
+{% 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

@@ -0,0 +1,22 @@
+{% 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

@@ -0,0 +1,24 @@
+{% 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

@@ -0,0 +1,24 @@
+{% 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

@@ -0,0 +1,11 @@
+{% 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

@@ -0,0 +1,121 @@
+{% 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

@@ -0,0 +1,5 @@
+{% 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

@@ -0,0 +1,51 @@
+{% 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

@@ -0,0 +1,49 @@
+
+====== 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

@@ -0,0 +1,27 @@
+<?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>

.gitflow

@@ -0,0 +1,9 @@
+[gitflow "branch"]
+master = master
+develop = develop
+[gitflow "prefix"]
+feature = feature/
+release = release/
+hotfix = hotfix/
+versiontag =
+support = support/

.gitignore

@@ -0,0 +1,125 @@
+
+# no slash at the end to handle also symlinks
+/toolkit
+/conf
+/env-*
+
+# composer reserver directory, from sources, populate/update using "composer install"
+vendor/*
+test/vendor/*
+
+# all datas but listing prevention
+/data/**
+!/data/.htaccess
+!/data/index.php
+!/data/web.config
+
+# iTop extensions
+/extensions/**
+!/extensions/readme.txt
+
+# all logs but listing prevention
+/log/**
+!/log/.htaccess
+!/log/index.php
+!/log/web.config
+
+
+# Jetbrains
+/.idea/**
+!/.idea/encodings.xml
+!/.idea/codeStyles
+!/.idea/codeStyles/*
+!/.idea/inspectionProfiles
+!/.idea/inspectionProfiles/*
+
+#phpdocumentor temp file
+ast.dump
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+### Eclipse template
+
+.metadata
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+.project
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# CDT- autotools
+.autotools
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Annotation Processing
+.apt_generated/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+

.idea/codeStyles/Project.xml

@@ -0,0 +1,57 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <option name="LINE_SEPARATOR" value="&#10;" />
+    <option name="RIGHT_MARGIN" value="320" />
+    <HTMLCodeStyleSettings>
+      <option name="HTML_DO_NOT_INDENT_CHILDREN_OF" value="html,body,thead,tbody,tfoot,script,style" />
+      <option name="HTML_DO_NOT_ALIGN_CHILDREN_OF_MIN_LINES" value="4" />
+    </HTMLCodeStyleSettings>
+    <PHPCodeStyleSettings>
+      <option name="CONCAT_SPACES" value="false" />
+      <option name="PHPDOC_BLANK_LINE_BEFORE_TAGS" value="true" />
+      <option name="PHPDOC_BLANK_LINES_AROUND_PARAMETERS" value="true" />
+      <option name="PHPDOC_WRAP_LONG_LINES" value="true" />
+      <option name="LOWER_CASE_BOOLEAN_CONST" value="true" />
+      <option name="LOWER_CASE_NULL_CONST" value="true" />
+      <option name="BLANK_LINES_BEFORE_RETURN_STATEMENT" value="1" />
+      <option name="KEEP_RPAREN_AND_LBRACE_ON_ONE_LINE" value="true" />
+      <option name="PHPDOC_USE_FQCN" value="true" />
+    </PHPCodeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="BRACE_STYLE" value="2" />
+      <option name="ELSE_ON_NEW_LINE" value="true" />
+      <option name="IF_BRACE_FORCE" value="3" />
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="PHP">
+      <option name="RIGHT_MARGIN" value="320" />
+      <option name="BLANK_LINES_AFTER_PACKAGE" value="1" />
+      <option name="BRACE_STYLE" value="2" />
+      <option name="ELSE_ON_NEW_LINE" value="true" />
+      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+      <option name="SPACE_BEFORE_FOR_PARENTHESES" value="false" />
+      <option name="CALL_PARAMETERS_WRAP" value="1" />
+      <option name="METHOD_PARAMETERS_WRAP" value="1" />
+      <option name="METHOD_PARAMETERS_LPAREN_ON_NEXT_LINE" value="true" />
+      <option name="METHOD_PARAMETERS_RPAREN_ON_NEXT_LINE" value="true" />
+      <option name="ARRAY_INITIALIZER_WRAP" value="5" />
+      <option name="ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE" value="true" />
+      <option name="ARRAY_INITIALIZER_RBRACE_ON_NEXT_LINE" value="true" />
+      <option name="IF_BRACE_FORCE" value="3" />
+      <option name="DOWHILE_BRACE_FORCE" value="3" />
+      <option name="WHILE_BRACE_FORCE" value="3" />
+      <option name="FOR_BRACE_FORCE" value="3" />
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+        <option name="SMART_TABS" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="XML">
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Combodo" />
+  </state>
+</component>

.idea/encodings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" defaultCharsetForPropertiesFiles="UTF-8">
+    <file url="PROJECT" charset="UTF-8" />
+  </component>
+</project>

.idea/inspectionProfiles/Combodo.xml

@@ -0,0 +1,44 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Combodo" />
+    <inspection_tool class="InconsistentLineSeparators" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="MysqlParsingInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="PhpIncludeInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="PhpMethodParametersCountMismatchInspection" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="PhpTooManyParametersInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="limit" value="7" />
+    </inspection_tool>
+    <inspection_tool class="PhpUndefinedClassInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="DONT_REPORT_MULTI_RESOLVE" value="true" />
+    </inspection_tool>
+    <inspection_tool class="PhpUndefinedMethodInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="PhpUnhandledExceptionInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="PhpUnusedLocalVariableInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="DONT_REPORT_INSIDE_LIST" value="true" />
+    </inspection_tool>
+    <inspection_tool class="PhpUnusedParameterInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="DONT_REPORT_ABSTRACT_CLASS" value="true" />
+    </inspection_tool>
+    <inspection_tool class="SqlAddNotNullColumnInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlAmbiguousColumnInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlAutoIncrementDuplicateInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlCheckUsingColumnsInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlConstantConditionInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlDeprecateTypeInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlDerivedTableAliasInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlDialectInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlDropIndexedColumnInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlIdentifierInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlInsertValuesInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlNoDataSourceInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlNullComparisonInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlPostgresqlSelectFromProcedureInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlResolveInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlShouldBeInGroupByInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlSideEffectsInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlSignatureInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlStorageInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlTypeInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SqlUnusedVariableInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,19 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="InconsistentLineSeparators" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="PhpIncludeInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="PhpMethodParametersCountMismatchInspection" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="PhpTooManyParametersInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="limit" value="7" />
+    </inspection_tool>
+    <inspection_tool class="PhpUndefinedClassInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="DONT_REPORT_MULTI_RESOLVE" value="true" />
+    </inspection_tool>
+    <inspection_tool class="PhpUnhandledExceptionInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="PhpUnusedParameterInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="DONT_REPORT_ABSTRACT_CLASS" value="true" />
+    </inspection_tool>
+    <inspection_tool class="SqlNoDataSourceInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="PROJECT_PROFILE" value="Combodo" />
+    <version value="1.0" />
+  </settings>
+</component>

.jenkins/bin/init/append_files.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -x
+
+# create target dirs
+mkdir -p var
+mkdir -p toolkit
+
+# cleanup target dirs
+rm -rf toolkit/*
+
+# fill target dirs
+curl http://www.combodo.com/documentation/iTopDataModelToolkit-2.3.zip | tar xvz --directory toolkit
+cp -r .jenkins/configuration/default-environment/unattended_install/* toolkit

.jenkins/bin/init/composer_install.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -x
+
+# on the root dir
+composer install
+
+
+# under the test dir
+cd test
+composer install

.jenkins/bin/init/debug.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -x
+
+whoami
+pwd
+ls
+
+echo "$BRANCH_NAME:${BRANCH_NAME}"
+
+echo "printenv :"
+printenv
+

.jenkins/bin/tests/phpunit.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -x
+
+cd test
+
+export DEBUG_UNIT_TEST="0"
+
+php vendor/bin/phpunit  --log-junit ../var/test/phpunit-log.junit.xml --teamcity

.jenkins/bin/unattended_install/default_env.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -x
+
+cd toolkit
+php unattended_install.php default-params.xml

.jenkins/configuration/default-environment/unattended_install/default-config-itop.php

@@ -0,0 +1,285 @@
+<?php
+
+/**
+ *
+ * Configuration file, generated by the iTop configuration wizard
+ *
+ * The file is used in MetaModel::LoadConfig() which does all the necessary initialization job
+ *
+ */
+$MySettings = array(
+
+	// access_message: Message displayed to the users when there is any access restriction
+	//	default: 'iTop is temporarily frozen, please wait... (the admin team)'
+	'access_message' => 'iTop is temporarily frozen, please wait... (the admin team)',
+
+	// access_mode: Access mode: ACCESS_READONLY = 0, ACCESS_ADMIN_WRITE = 2, ACCESS_FULL = 3
+	//	default: 3
+	'access_mode' => 3,
+
+	'allowed_login_types' => 'form|basic|external',
+
+	// apc_cache.enabled: If set, the APC cache is allowed (the PHP extension must also be active)
+	//	default: true
+	'apc_cache.enabled' => true,
+
+	// apc_cache.query_ttl: Time to live set in APC for the prepared queries (seconds - 0 means no timeout)
+	//	default: 3600
+	'apc_cache.query_ttl' => 3600,
+
+	// app_root_url: Root URL used for navigating within the application, or from an email to the application (you can put $SERVER_NAME$ as a placeholder for the server's name)
+	//	default: ''
+	'app_root_url' => 'http://127.0.0.1/itop/svn/trunk/',
+
+	// buttons_position: Position of the forms buttons: bottom | top | both
+	//	default: 'both'
+	'buttons_position' => 'both',
+
+	// cas_include_path: The path where to find the phpCAS library
+	//	default: '/usr/share/php'
+	'cas_include_path' => '/usr/share/php',
+
+	// cron_max_execution_time: Duration (seconds) of the page cron.php, must be shorter than php setting max_execution_time and shorter than the web server response timeout
+	//	default: 600
+	'cron_max_execution_time' => 600,
+
+	// csv_file_default_charset: Character set used by default for downloading and uploading data as a CSV file. Warning: it is case sensitive (uppercase is preferable).
+	//	default: 'ISO-8859-1'
+	'csv_file_default_charset' => 'ISO-8859-1',
+
+	'csv_import_charsets' => array (
+	),
+
+	// csv_import_history_display: Display the history tab in the import wizard
+	//	default: false
+	'csv_import_history_display' => false,
+
+	// date_and_time_format: Format for date and time display (per language)
+	//	default: array (
+	//		  'default' =>
+	//		  array (
+	//		    'date' => 'Y-m-d',
+	//		    'time' => 'H:i:s',
+	//		    'date_time' => '$date $time',
+	//		  ),
+	//		)
+	'date_and_time_format' => array (
+		'default' =>
+			array (
+				'date' => 'Y-m-d',
+				'time' => 'H:i:s',
+				'date_time' => '$date $time',
+			),
+		'FR FR' =>
+			array (
+				'date' => 'd/m/Y',
+				'time' => 'H:i:s',
+				'date_time' => '$date $time',
+			),
+	),
+
+	'db_host' => '',
+
+	'db_name' => 'itop_ci_main',
+
+	'db_pwd' => 'IKnowYouSeeMeInJenkinsConf',
+
+	'db_subname' => '',
+
+	'db_user' => 'jenkins_itop',
+
+	// deadline_format: The format used for displaying "deadline" attributes: any string with the following placeholders: $date$, $difference$
+	//	default: '$difference$'
+	'deadline_format' => '$difference$',
+
+	'default_language' => 'EN US',
+
+	// disable_attachments_download_legacy_portal: Disable attachments download from legacy portal
+	//	default: true
+	'disable_attachments_download_legacy_portal' => true,
+
+	// draft_attachments_lifetime: Lifetime (in seconds) of drafts' attachments and inline images: after this duration, the garbage collector will delete them.
+	//	default: 3600
+	'draft_attachments_lifetime' => 3600,
+
+	// email_asynchronous: If set, the emails are sent off line, which requires cron.php to be activated. Exception: some features like the email test utility will force the serialized mode
+	//	default: false
+	'email_asynchronous' => false,
+
+	// email_default_sender_address: Default address provided in the email from header field.
+	//	default: ''
+	'email_default_sender_address' => '',
+
+	// email_default_sender_label: Default label provided in the email from header field.
+	//	default: ''
+	'email_default_sender_label' => '',
+
+	// email_transport: Mean to send emails: PHPMail (uses the function mail()) or SMTP (implements the client protocole)
+	//	default: 'PHPMail'
+	'email_transport' => 'SMTP',
+
+	// email_transport_smtp.host: host name or IP address (optional)
+	//	default: 'localhost'
+	'email_transport_smtp.host' => 'smtp.combodo.com',
+
+	// email_transport_smtp.password: Authentication password (optional)
+	//	default: ''
+	'email_transport_smtp.password' => 'IDoNotWork',
+
+	// email_transport_smtp.port: port number (optional)
+	//	default: 25
+	'email_transport_smtp.port' => 25,
+
+	// email_transport_smtp.username: Authentication user (optional)
+	//	default: ''
+	'email_transport_smtp.username' => 'test2@combodo.com',
+
+	// email_validation_pattern: Regular expression to validate/detect the format of an eMail address
+	//	default: '[a-zA-Z0-9._&\'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z0-9-]{2,}'
+	'email_validation_pattern' => '[a-zA-Z0-9._&\'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z0-9-]{2,}',
+
+	'encryption_key' => '@iT0pEncr1pti0n!',
+
+	'ext_auth_variable' => '$_SERVER[\'REMOTE_USER\']',
+
+	'fast_reload_interval' => '60',
+
+	// graphviz_path: Path to the Graphviz "dot" executable for graphing objects lifecycle
+	//	default: '/usr/bin/dot'
+	'graphviz_path' => '/usr/bin/dot',
+
+	// inline_image_max_display_width: The maximum width (in pixels) when displaying images inside an HTML formatted attribute. Images will be displayed using this this maximum width.
+	//	default: '250'
+	'inline_image_max_display_width' => 250,
+
+	// inline_image_max_storage_width: The maximum width (in pixels) when uploading images to be used inside an HTML formatted attribute. Images larger than the given size will be downsampled before storing them in the database.
+	//	default: '1600'
+	'inline_image_max_storage_width' => 1600,
+
+	// link_set_attribute_qualifier: Link set from string: attribute qualifier (encloses both the attcode and the value)
+	//	default: '\''
+	'link_set_attribute_qualifier' => '\'',
+
+	// link_set_attribute_separator: Link set from string: attribute separator
+	//	default: ';'
+	'link_set_attribute_separator' => ';',
+
+	// link_set_item_separator: Link set from string: line separator
+	//	default: '|'
+	'link_set_item_separator' => '|',
+
+	// link_set_value_separator: Link set from string: value separator (between the attcode and the value itself
+	//	default: ':'
+	'link_set_value_separator' => ':',
+
+	'log_global' => true,
+
+	'log_issue' => true,
+
+	'log_notification' => true,
+
+	'log_web_service' => true,
+
+	// max_combo_length: The maximum number of elements in a drop-down list. If more then an autocomplete will be used
+	//	default: 50
+	'max_combo_length' => 50,
+
+	'max_display_limit' => '15',
+
+	// max_linkset_output: Maximum number of items shown when getting a list of related items in an email, using the form $this->some_list$. 0 means no limit.
+	//	default: 100
+	'max_linkset_output' => 100,
+
+	'min_display_limit' => '10',
+
+	// online_help: Hyperlink to the online-help web page
+	//	default: 'http://www.combodo.com/itop-help'
+	'online_help' => 'http://www.combodo.com/itop-help',
+
+	// php_path: Path to the php executable in CLI mode
+	//	default: 'php'
+	'php_path' => 'php',
+
+	// portal_tickets: CSV list of classes supported in the portal
+	//	default: 'UserRequest'
+	'portal_tickets' => 'UserRequest',
+
+	'query_cache_enabled' => true,
+
+	// search_manual_submit: Force manual submit of search requests (class => true)
+	//	default: false
+	'search_manual_submit' => array (
+		'Person' => true,
+	),
+
+	'secure_connection_required' => false,
+
+	// session_name: The name of the cookie used to store the PHP session id
+	//	default: 'iTop'
+	'session_name' => 'iTop',
+
+	// shortcut_actions: Actions that are available as direct buttons next to the "Actions" menu
+	//	default: 'UI:Menu:Modify,UI:Menu:New'
+	'shortcut_actions' => 'UI:Menu:Modify,UI:Menu:New',
+
+	// source_dir: Source directory for the datamodel files. (which gets compiled to env-production).
+	//	default: ''
+	'source_dir' => 'datamodels/2.x/',
+
+	'standard_reload_interval' => '300',
+
+	// synchro_trace: Synchronization details: none, display, save (includes 'display')
+	//	default: 'none'
+	'synchro_trace' => 'none',
+
+	// timezone: Timezone (reference: http://php.net/manual/en/timezones.php). If empty, it will be left unchanged and MUST be explicitely configured in PHP
+	//	default: 'Europe/Paris'
+	'timezone' => 'Europe/Paris',
+
+	// tracking_level_linked_set_default: Default tracking level if not explicitely set at the attribute level, for AttributeLinkedSet (defaults to NONE in case of a fresh install, LIST otherwise - this to preserve backward compatibility while upgrading from a version older than 2.0.3 - see TRAC #936)
+	//	default: 1
+	'tracking_level_linked_set_default' => 0,
+
+	// url_validation_pattern: Regular expression to validate/detect the format of an URL (URL attributes and Wiki formatting for Text attributes)
+	//	default: '(https?|ftp)\\://([a-zA-Z0-9+!*(),;?&=\\$_.-]+(\\:[a-zA-Z0-9+!*(),;?&=\\$_.-]+)?@)?([a-zA-Z0-9-.]{3,})(\\:[0-9]{2,5})?(/([a-zA-Z0-9%+\\$_-]\\.?)+)*/?(\\?[a-zA-Z+&\\$_.-][a-zA-Z0-9;:[\\]@&%=+/\\$_.-]*)?(#[a-zA-Z_.-][a-zA-Z0-9+\\$_.-]*)?'
+	'url_validation_pattern' => '(https?|ftp)\\://([a-zA-Z0-9+!*(),;?&=\\$_.-]+(\\:[a-zA-Z0-9+!*(),;?&=\\$_.-]+)?@)?([a-zA-Z0-9-.]{3,})(\\:[0-9]{2,5})?(/([a-zA-Z0-9%+\\$_-]\\.?)+)*/?(\\?[a-zA-Z+&\\$_.-][a-zA-Z0-9;:[\\]@&%=+/\\$_.-]*)?(#[a-zA-Z_.-][a-zA-Z0-9+\\$_.-]*)?',
+);
+
+/**
+ *
+ * Modules specific settings
+ *
+ */
+$MyModuleSettings = array(
+	'itop-attachments' => array (
+		'allowed_classes' => array (
+			0 => 'Ticket',
+		),
+		'position' => 'relations',
+		'preview_max_width' => 290,
+	),
+	'itop-backup' => array (
+		'mysql_bindir' => '',
+		'week_days' => 'monday, tuesday, wednesday, thursday, friday',
+		'time' => '23:30',
+		'retention_count' => 5,
+		'enabled' => true,
+		'debug' => false,
+	),
+	'molkobain-console-tooltips' => array (
+		'decoration_class' => 'fas fa-question',
+		'enabled' => true,
+	),
+);
+
+/**
+ *
+ * Data model modules to be loaded. Names are specified as relative paths
+ *
+ */
+$MyModules = array(
+	'addons' => array (
+		'user rights' => 'addons/userrights/userrightsprofile.class.inc.php',
+	),
+);
+?>

.jenkins/configuration/default-environment/unattended_install/default-params.xml

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<installation>
+<!-- On manual installs, this file is generated in setup/install-*.xml -->
+    <mode>upgrade</mode>
+    <preinstall>
+        <copies type="array"/>
+    </preinstall>
+    <source_dir>datamodels/2.x/</source_dir>
+    <datamodel_version>2.5.0</datamodel_version>
+    <previous_configuration_file>/var/lib/jenkins/workspace/iTop-CI/unattended_install/default-config-itop.php</previous_configuration_file>
+    <extensions_dir>extensions</extensions_dir>
+    <target_env>production</target_env>
+    <workspace_dir></workspace_dir>
+    <database>
+        <server></server>
+        <user>jenkins_itop</user>
+        <pwd>IKnowYouSeeMeInJenkinsConf</pwd>
+        <name>itop_ci</name>
+        <db_tls_enabled></db_tls_enabled>
+        <db_tls_ca></db_tls_ca>
+        <prefix></prefix>
+    </database>
+    <url>http://127.0.0.1/itop/svn/trunk/</url>
+    <graphviz_path>/usr/bin/dot</graphviz_path>
+    <admin_account>
+        <user>admin</user>
+        <pwd>admin</pwd>
+        <language>EN US</language>
+    </admin_account>
+    <language>EN US</language>
+    <selected_modules type="array">
+      <item>authent-external</item>
+      <item>authent-local</item>
+      <item>itop-backup</item>
+      <item>itop-config</item>
+      <item>itop-profiles-itil</item>
+      <item>itop-sla-computation</item>
+      <item>itop-tickets</item>
+      <item>itop-welcome-itil</item>
+      <item>itop-config-mgmt</item>
+      <item>itop-attachments</item>
+      <item>itop-datacenter-mgmt</item>
+      <item>itop-endusers-devices</item>
+      <item>itop-storage-mgmt</item>
+      <item>itop-virtualization-mgmt</item>
+      <item>itop-bridge-virtualization-storage</item>
+      <item>itop-service-mgmt</item>
+      <item>itop-request-mgmt</item>
+      <item>itop-portal</item>
+      <item>itop-portal-base</item>
+      <item>itop-change-mgmt</item>
+      <item>itop-knownerror-mgmt</item>
+    </selected_modules>
+    <selected_extensions type="array">
+      <item>itop-config-mgmt-core</item>
+      <item>itop-config-mgmt-datacenter</item>
+      <item>itop-config-mgmt-end-user</item>
+      <item>itop-config-mgmt-storage</item>
+      <item>itop-config-mgmt-virtualization</item>
+      <item>itop-service-mgmt-enterprise</item>
+      <item>itop-ticket-mgmt-simple-ticket</item>
+      <item>itop-ticket-mgmt-simple-ticket-enhanced-portal</item>
+      <item>itop-change-mgmt-simple</item>
+      <item>itop-kown-error-mgmt</item>
+    </selected_extensions>
+    <sample_data>1</sample_data>
+    <old_addon></old_addon>
+    <options>
+        <generate_config>1</generate_config>
+    </options>
+    <mysql_bindir></mysql_bindir>
+</installation>

.jenkins/configuration/default-environment/unattended_install/unattended_install.php

@@ -0,0 +1,190 @@
+<?php
+//this scrit will be run under the ./toolkit directory, relatively to the document root
+
+require_once('../approot.inc.php');
+require_once(APPROOT.'/application/utils.inc.php');
+require_once(APPROOT.'/application/clipage.class.inc.php');
+require_once(APPROOT.'/core/config.class.inc.php');
+require_once(APPROOT.'/core/log.class.inc.php');
+require_once(APPROOT.'/core/kpi.class.inc.php');
+require_once(APPROOT.'/core/cmdbsource.class.inc.php');
+require_once(APPROOT.'/setup/setuppage.class.inc.php');
+require_once(APPROOT.'/setup/wizardcontroller.class.inc.php');
+require_once(APPROOT.'/setup/wizardsteps.class.inc.php');
+require_once(APPROOT.'/setup/applicationinstaller.class.inc.php');
+
+
+
+/////////////////////////////////////////////////
+$sParamFile = utils::ReadParam('response_file', 'default-params.xml', true /* CLI allowed */, 'raw_data');
+$bCheckConsistency = (utils::ReadParam('check_consistency', '0', true /* CLI allowed */) == '1');
+
+$oParams = new XMLParameters($sParamFile);
+$sMode = $oParams->Get('mode');
+
+if ($sMode == 'install')
+{
+	echo "Installation mode detected.\n";
+	$bClean = utils::ReadParam('clean', false, true /* CLI allowed */);
+	if ($bClean)
+	{
+		echo "Cleanup mode detected.\n";
+		$sTargetEnvironment = $oParams->Get('target_env', '');
+		if ($sTargetEnvironment == '')
+		{
+			$sTargetEnvironment = 'production';
+		}
+		$sTargetDir = APPROOT.'env-'.$sTargetEnvironment;
+
+		// Configuration file
+		$sConfigFile = APPCONF.$sTargetEnvironment.'/'.ITOP_CONFIG_FILE;
+		if (file_exists($sConfigFile))
+		{
+			echo "Trying to delete the configuration file: '$sConfigFile'.\n";
+			@chmod($sConfigFile, 0770); // RWX for owner and group, nothing for others
+			unlink($sConfigFile);
+		}
+		else
+		{
+			echo "No config file to delete ($sConfigFile does not exist).\n";
+		}
+
+		// env-xxx directory
+		if (file_exists($sTargetDir))
+		{
+			if (is_dir($sTargetDir))
+			{
+				echo "Emptying the target directory '$sTargetDir'.\n";
+				SetupUtils::tidydir($sTargetDir);
+			}
+			else
+			{
+				die("ERROR the target dir '$sTargetDir' exists, but is NOT a directory !!!\nExiting.\n");
+			}
+		}
+		else
+		{
+			echo "No target directory to delete ($sTargetDir does not exist).\n";
+		}
+
+		// Database
+		$aDBSettings = $oParams->Get('database', array());
+		$sDBServer = $aDBSettings['server'];
+		$sDBUser = $aDBSettings['user'];
+		$sDBPwd = $aDBSettings['pwd'];
+		$sDBName = $aDBSettings['name'];
+		$sDBPrefix = $aDBSettings['prefix'];
+
+		if ($sDBPrefix != '')
+		{
+			die("Cleanup not implemented for a partial database (prefix= '$sDBPrefix')\nExiting.");
+		}
+
+		$oMysqli = new mysqli($sDBServer, $sDBUser, $sDBPwd);
+		if ($oMysqli->connect_errno)
+		{
+			die("Cannot connect to the MySQL server (".$mysqli->connect_errno . ") ".$mysqli->connect_error."\nExiting");
+		}
+		else
+		{
+			if ($oMysqli->select_db($sDBName))
+			{
+				echo "Deleting database '$sDBName'\n";
+				$oMysqli->query("DROP DATABASE `$sDBName`");
+			}
+			else
+			{
+				echo "The database '$sDBName' does not seem to exist. Nothing to cleanup.\n";
+			}
+		}
+	}
+}
+
+$bHasErrors = false;
+$aChecks = SetupUtils::CheckBackupPrerequisites(APPROOT.'data'); // mmm should be the backup destination dir
+
+$aSelectedModules = $oParams->Get('selected_modules');
+$sSourceDir = $oParams->Get('source_dir', 'datamodels/latest');
+$sExtensionDir = $oParams->Get('extensions_dir', 'extensions');
+$aChecks = array_merge($aChecks, SetupUtils::CheckSelectedModules($sSourceDir, $sExtensionDir, $aSelectedModules));
+
+
+foreach($aChecks as $oCheckResult)
+{
+	switch($oCheckResult->iSeverity)
+	{
+		case CheckResult::ERROR:
+			$bHasErrors = true;
+			$sHeader = "Error";
+			break;
+
+		case CheckResult::WARNING:
+			$sHeader = "Warning";
+			break;
+
+		case CheckResult::INFO:
+		default:
+			$sHeader = "Info";
+			break;
+	}
+	echo $sHeader.": ".$oCheckResult->sLabel;
+	if (strlen($oCheckResult->sDescription))
+	{
+		echo ' - '.$oCheckResult->sDescription;
+	}
+	echo "\n";
+}
+
+if ($bHasErrors)
+{
+	echo "Encountered stopper issues. Aborting...\n";
+	die;
+}
+
+$bFoundIssues = false;
+
+$bInstall = utils::ReadParam('install', true, true /* CLI allowed */);
+if ($bInstall)
+{
+	echo "Starting the unattended installation...\n";
+	$oWizard = new ApplicationInstaller($oParams);
+	$bRes = $oWizard->ExecuteAllSteps();
+	if (!$bRes)
+	{
+		echo "\nencountered installation issues!";
+		$bFoundIssues = true;
+	}
+}
+else
+{
+	echo "No installation requested.\n";
+}
+if (!$bFoundIssues && $bCheckConsistency)
+{
+	echo "Checking data model consistency.\n";
+	ob_start();
+	$sCheckRes = '';
+	try
+	{
+		MetaModel::CheckDefinitions(false);
+		$sCheckRes = ob_get_clean();
+	}
+	catch(Exception $e)
+	{
+		$sCheckRes = ob_get_clean()."\nException: ".$e->getMessage();
+	}
+	if (strlen($sCheckRes) > 0)
+	{
+		echo $sCheckRes;
+		echo "\nfound consistency issues!";
+		$bFoundIssues = true;
+	}
+}
+
+if (!$bFoundIssues)
+{
+	// last line: used to check the install
+	// the only way to track issues in case of Fatal error or even parsing error!
+	echo "\ninstalled!";
+	exit;
+}

README.md

@@ -0,0 +1,141 @@
+<p align="center"><a href="https://www.combodo.com/itop-193" target="_blank">
+    <img src="https://www.combodo.com/logos/logo-itop.svg">
+</a></p>
+
+
+# iTop - ITSM & CMDB
+ 
+iTop stands for *IT Operations Portal*.
+It is a complete open source, ITIL, web based service management tool including a fully customizable CMDB, a helpdesk system and a document management tool. 
+iTop also offers mass import tools and web services to integrate with your IT
+
+## Features
+- Fully configurable [Configuration Management (CMDB)][10]
+- [HelpDesk][11] and Incident Management
+- [Service and Contract Management][12]
+- [Change][13] Management
+- Configurable [SLA][14] Management
+- Graphical [impact analysis][15]
+- [CSV import][16] tool for any data
+- Consistency [audit][17] to check data quality
+- [Data synchronization][18] (for data federation)
+
+
+## Resources
+
+ - [iTop Forums][1]: for support request
+ - [iTop Tickets][2]: for feature requests and bug reports
+ - [Releases download][3]
+ - [iTop documentation][4] for iTop and official extensions
+ - [iTop extensions][5] for discovering and installing extensions
+
+ 
+## Releases
+### Version 2.6  
+ - [Changes since the previous version][58]
+ - [New features][59]
+ - [Migration notes][60]
+ - [Download iTop 2.6.1][61]
+
+
+### Version 2.5  
+ - [Changes since the previous version][54]
+ - [New features][55]
+ - [Migration notes][56]
+ - [Download iTop 2.5.1][57]
+ 
+
+### Version 2.4  
+ - [Changes since the previous version][50]
+ - [New features][51]
+ - [Migration notes][52]
+ - [Download iTop 2.4.1][53]
+
+
+# About Us
+
+iTop development is sponsored, led and supported by [Combodo][0].
+
+
+# Contributors
+
+We would like to give a special thank you to the people from the community who contributed to this project, including:
+ - Alves, David
+ - Beck, Pedro
+ - Bilger, Jean-François
+ - Bostoen, Jeffrey
+ - Cardoso, Anderson
+ - Cassaro, Bruno
+ - Casteleyn, Thomas
+ - Castro, Randall Badilla
+ - Colantoni, Maria Laura
+ - Dvořák, Lukáš
+ - Goethals, Stefan
+ - Gumble, David
+ - Hippler, Lars
+ - Khamit, Shamil
+ - Kincel, Martin
+ - Konečný, Kamil
+ - Kunin, Vladimir
+ - Lassiter, Dennis
+ - Lucas, Jonathan
+ - Malik, Remie
+ - Rosenke, Stephan
+ - Seki, Shoji
+ - Shilov, Vladimir
+ - Tulio, Marco
+ - Turrubiates, Miguel
+
+#### Aliases
+ - chifu1234
+ - cprobst
+ - Karkoff1212
+ - larhip
+ - Laura
+ - Purple Grape
+ - Schlobinux
+ - theBigOne
+ - ulmerspatz
+
+#### Companies
+ - Hardis
+ - ITOMIG
+
+
+
+[0]: https://www.combodo.com
+
+[1]: https://sourceforge.net/p/itop/discussion/
+[2]: https://sourceforge.net/p/itop/tickets/
+[3]: https://sourceforge.net/projects/itop/files/itop/
+[4]: https://www.itophub.io/wiki
+[5]: https://store.itophub.io/en_US/
+
+
+
+[10]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#configuration_management_cmdb
+[11]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#ticketing
+[12]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#service_management
+[13]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#change_management
+[14]: https://www.itophub.io/wiki/page?id=2_5_0%3Aimplementation%3Astart#service_level_agreements_and_targets
+[15]: https://www.itophub.io/wiki/page?id=2_5_0%3Auser%3Aactions#relations
+[16]: https://www.itophub.io/wiki/page?id=2_5_0%3Auser%3Abulk_modify#uploading_data
+[17]: https://www.itophub.io/wiki/page?id=2_5_0%3Aadmin%3Aaudit
+[18]: https://www.itophub.io/wiki/page?id=2_5_0%3Aadvancedtopics%3Adata_synchro_overview
+
+
+
+[50]: https://www.itophub.io/wiki/page?id=2_4_0:release:change_log
+[51]: https://www.itophub.io/wiki/page?id=2_4_0:release:2_4_whats_new
+[52]: https://www.itophub.io/wiki/page?id=2_4_0:install:230_to_240_migration_notes
+[53]: https://sourceforge.net/projects/itop/files/itop/2.4.1
+
+[54]: https://www.itophub.io/wiki/page?id=2_5_0:release:change_log
+[55]: https://www.itophub.io/wiki/page?id=2_5_0:release:2_5_whats_new
+[56]: https://www.itophub.io/wiki/page?id=2_5_0:install:240_to_250_migration_notes
+[57]: https://sourceforge.net/projects/itop/files/itop/2.5.1
+
+[58]: https://www.itophub.io/wiki/page?id=2_6_0:release:change_log
+[59]: https://www.itophub.io/wiki/page?id=2_6_0:release:2_6_whats_new
+[60]: https://www.itophub.io/wiki/page?id=2_6_0:install:250_to_260_migration_notes
+[61]: https://sourceforge.net/projects/itop/files/itop/2.6.1

addons/userrights/userrightsmatrix.class.inc.php

@@ -1,368 +1,368 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * UserRightsMatrix (User management Module)
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-
-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
-
-		// Create a change to record the history of the User object
-		$oChange = MetaModel::NewObject("CMDBChange");
-		$oChange->Set("date", time());
-		$oChange->Set("userinfo", "Initialization");
-		$iChangeId = $oChange->DBInsert();
-
-		// Now record the admin user object
-		$iUserId = $oUser->DBInsertTrackedNoReload($oChange, true /* skip security */);
-		$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)
-	{
-		$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');
-
-?>
+<?php
+// Copyright (C) 2010-2012 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-2012 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
+
+		// Create a change to record the history of the User object
+		$oChange = MetaModel::NewObject("CMDBChange");
+		$oChange->Set("date", time());
+		$oChange->Set("userinfo", "Initialization");
+		$iChangeId = $oChange->DBInsert();
+
+		// Now record the admin user object
+		$iUserId = $oUser->DBInsertTrackedNoReload($oChange, true /* skip security */);
+		$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 +1,78 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * UserRightsNull
- * User management Module - say Yeah! to everything
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-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)
-	{
-		$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');
-
-?>
+<?php
+// Copyright (C) 2010-2012 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-2012 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');
+
+?>

application/Html2Text.php

@@ -0,0 +1,328 @@
+<?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);
+			$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

@@ -0,0 +1,28 @@
+<?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,322 +1,401 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Simple web page with no includes, header or fancy formatting, useful to
- * generate HTML fragments when called by an AJAX method
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT."/application/webpage.class.inc.php");
- 
-class ajax_page extends WebPage
-{
-    /**
-     * Jquery style ready script
-     * @var Hash     
-     */	  
-	protected $m_sReadyScript;
-	protected $m_sCurrentTab;
-	protected $m_sCurrentTabContainer;
-	protected $m_aTabs;
-	
-    /**
-     * constructor for the web page
-     * @param string $s_title Not used
-     */	  
-	function __construct($s_title)
-    {
-        parent::__construct($s_title);
-        $this->m_sReadyScript = "";
-		//$this->add_header("Content-type: text/html; charset=utf-8");
-		$this->add_header("Cache-control: no-cache");
-		$this->m_sCurrentTabContainer = '';
-        $this->m_sCurrentTab = '';
-		$this->m_aTabs = array();
-		$this->sContentType = 'text/html';
-		$this->sContentDisposition = 'inline';
-    }	
-
-	public function AddTabContainer($sTabContainer, $sPrefix = '')
-	{
-		$this->m_aTabs[$sTabContainer] = array('content' =>'', 'prefix' => $sPrefix);
-		$this->add("\$Tabs:$sTabContainer\$");
-	}
-	
-	public function AddToTab($sTabContainer, $sTabLabel, $sHtml)
-	{
-		if (!isset($this->m_aTabs[$sTabContainer]['content'][$sTabLabel]))
-		{
-			// Set the content of the tab
-			$this->m_aTabs[$sTabContainer]['content'][$sTabLabel] = $sHtml;
-		}
-		else
-		{
-			// Append to the content of the tab
-			$this->m_aTabs[$sTabContainer]['content'][$sTabLabel] .= $sHtml;
-		}
-	}
-
-	public function SetCurrentTabContainer($sTabContainer = '')
-	{
-		$sPreviousTabContainer = $this->m_sCurrentTabContainer;
-		$this->m_sCurrentTabContainer = $sTabContainer;
-		return $sPreviousTabContainer;
-	}
-
-	public function SetCurrentTab($sTabLabel = '')
-	{
-		$sPreviousTab = $this->m_sCurrentTab;
-		$this->m_sCurrentTab = $sTabLabel;
-		return $sPreviousTab;
-	}
-	
-	public function GetCurrentTab()
-	{
-		return $this->m_sCurrentTab;
-	}
-	
-    /**
-     * Echoes the content of the whole page
-     * @return void
-     */	  
-    public function output()
-    {
-    	if (!empty($this->sContentType))
-    	{
-			$this->add_header('Content-type: '.$this->sContentType);
-    	}
-    	if (!empty($this->sContentDisposition))
-    	{
-			$this->add_header('Content-Disposition: '.$this->sContentDisposition.'; filename="'.$this->sContentFileName.'"');
-    	}
-        foreach($this->a_headers as $s_header)
-        {
-            header($s_header);
-        }
-		if (count($this->m_aTabs) > 0)
-		{
-					$this->add_ready_script(
-<<<EOF
-			// The "tab widgets" to handle.
-			var tabs = $('div[id^=tabbedContent]');
-			    
-			// This selector will be reused when selecting actual tab widget A elements.
-			var tab_a_selector = 'ul.ui-tabs-nav a';
-			  
-			// Enable tabs on all tab widgets. The `event` property must be overridden so
-			// that the tabs aren't changed on click, and any custom event name can be
-			// specified. Note that if you define a callback for the 'select' event, it
-			// will be executed for the selected tab whenever the hash changes.
-			tabs.tabs({ event: 'change' });
-			  
-			// Define our own click handler for the tabs, overriding the default.
-			tabs.find( tab_a_selector ).click(function()
-			{
-				var state = {};
-						  
-				// Get the id of this tab widget.
-				var id = $(this).closest( 'div[id^=tabbedContent]' ).attr( 'id' );
-				  
-				// Get the index of this tab.
-				var idx = $(this).parent().prevAll().length;
-				
-				// Set the state!
-				state[ id ] = idx;
-				$.bbq.pushState( state );
-			});
-EOF
-);
-		}
-		// Render the tabs in the page (if any)
-		foreach($this->m_aTabs as $sTabContainerName => $aTabContainer)
-		{
-			$sTabs = '';
-			$m_aTabs = $aTabContainer['content'];
-			$sPrefix = $aTabContainer['prefix'];
-			$container_index = 0;
-			if (count($m_aTabs) > 0)
-			{
-			  $sTabs = "<!-- tabs -->\n<div id=\"tabbedContent_{$sPrefix}{$container_index}\" class=\"light\">\n";
-			  $sTabs .= "<ul>\n";
-			  // Display the unordered list that will be rendered as the tabs
-	          $i = 0;
-			  foreach($m_aTabs as $sTabName => $sTabContent)
-			  {
-			      $sTabs .= "<li><a href=\"#tab_{$sPrefix}$i\" class=\"tab\"><span>".htmlentities($sTabName, ENT_QUOTES, 'UTF-8')."</span></a></li>\n";
-			      $i++;
-	          }
-			  $sTabs .= "</ul>\n";
-			  // Now add the content of the tabs themselves
-			  $i = 0;
-			  foreach($m_aTabs as $sTabName => $sTabContent)
-			  {
-			      $sTabs .= "<div id=\"tab_{$sPrefix}$i\">".$sTabContent."</div>\n";
-			      $i++;
-	          }
-			  $sTabs .= "</div>\n<!-- end of tabs-->\n";
-	        }
-			$this->s_content = str_replace("\$Tabs:$sTabContainerName\$", $sTabs, $this->s_content);
-			$container_index++;
-		}
-	
-        $s_captured_output = ob_get_contents();
-        ob_end_clean();
-        if (($this->sContentType == 'text/html') &&  ($this->sContentDisposition == 'inline'))
-        {
-        	// inline content != attachment && html => filter all scripts for malicious XSS scripts
-        	echo self::FilterXSS($this->s_content);
-        }
-        else
-        {
-        	echo $this->s_content;
-        }
-        //echo $this->s_deferred_content;
-        if (count($this->a_scripts) > 0)
-        {
-            echo "<script type=\"text/javascript\">\n";
-            echo implode("\n", $this->a_scripts);
-            echo "\n</script>\n";
-        }
-        if (!empty($this->s_deferred_content))
-        {
-            echo "<script type=\"text/javascript\">\n";
-            echo "\$('body').append('".addslashes(str_replace("\n", '', $this->s_deferred_content))."');\n";
-            echo "\n</script>\n";
-        }
-        if (!empty($this->m_sReadyScript))
-        {
-	        echo "<script type=\"text/javascript\">\n";
-	        echo $this->m_sReadyScript; // Ready Scripts are output as simple scripts
-	        echo "\n</script>\n";
-        }
-		if (trim($s_captured_output) != "")
-        {
-        	echo self::FilterXSS($s_captured_output);
-        }
-    }
-
-    /**
-     * Adds a paragraph with a smaller font into the page
-     * NOT implemented (i.e does nothing)
-     * @param string $sText Content of the (small) paragraph     
-     * @return void
-     */	 	      
-    public function small_p($sText)
-    {
-	}
-
-    public function add($sHtml)
-    {
-        if (!empty($this->m_sCurrentTabContainer) && !empty($this->m_sCurrentTab))
-        {
-            $this->AddToTab($this->m_sCurrentTabContainer, $this->m_sCurrentTab, $sHtml);
-        }
-        else
-        {
-            parent::add($sHtml);
-        }
-    }
-
-	/**
-	 * Records the current state of the 'html' part of the page output
-	 * @return mixed The current state of the 'html' output
-	 */    
-    public function start_capture()
-    {
-        if (!empty($this->m_sCurrentTabContainer) && !empty($this->m_sCurrentTab))
-        {
-        	$iOffset = isset($this->m_aTabs[$this->m_sCurrentTabContainer]['content'][$this->m_sCurrentTab]) ? strlen($this->m_aTabs[$this->m_sCurrentTabContainer]['content'][$this->m_sCurrentTab]): 0;
-            return array('tc' => $this->m_sCurrentTabContainer, 'tab' => $this->m_sCurrentTab, 'offset' => $iOffset);
-        }
-        else
-        {
-            return parent::start_capture();
-        }
-    }
-
-    /**
-     * Returns the part of the html output that occurred since the call to start_capture
-     * and removes this part from the current html output
-     * @param $offset mixed The value returned by start_capture
-     * @return string The part of the html output that was added since the call to start_capture
-     */    
-    public function end_capture($offset)
-    {
-    	if (is_array($offset))
-    	{
-    		if (isset($this->m_aTabs[$offset['tc']]['content'][$offset['tab']]))
-    		{
-		    	$sCaptured = substr($this->m_aTabs[$offset['tc']]['content'][$offset['tab']], $offset['offset']);
-		    	$this->m_aTabs[$offset['tc']]['content'][$offset['tab']] = substr($this->m_aTabs[$offset['tc']]['content'][$offset['tab']], 0, $offset['offset']);
-    		}
-    		else
-    		{
-    			$sCaptured = '';
-    		}
-    	}
-    	else
-    	{
-    		$sCaptured = parent::end_capture($offset);
-    	}
-    	return $sCaptured;
-    }
-
-	/**
-	 * Add any text or HTML fragment (identified by an ID) at the end of the body of the page
-	 * This is useful to add hidden content, DIVs or FORMs that should not
-	 * be embedded into each other.	 	 
-	 */
-    public function add_at_the_end($s_html, $sId = '')
-    {
-    	if ($sId != '')
-    	{
-	    	$this->add_script("$('#{$sId}').remove();"); // Remove any previous instance of the same Id
-    	}
-        $this->s_deferred_content .= $s_html;
-    }
-	
-	/**
-	 * Adds a script to be executed when the DOM is ready (typical JQuery use)
-	 * NOT implemented in this version of the class.
-	 * @return void	 
-	 */	 	 	
-	public function add_ready_script($sScript)
-	{
-		$this->m_sReadyScript .= $sScript;
-	}
-	
-	/**
-	 * Cannot be called in this context, since Ajax pages do not share
-	 * any context with the calling page !!
-	 */
-	public function GetUniqueId()
-	{
-		assert(false);
-		return 0;
-	}
-	
-	public static function FilterXSS($sHTML)
-	{
-		return str_ireplace(array('<script', '</script>'), array('<!-- <removed-script', '</removed-script> -->'), $sHTML);
-	}
-}
-
-?>
+<?php
+// Copyright (C) 2010-2018 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/>
+
+/**
+ * Simple web page with no includes, header or fancy formatting, useful to
+ * generate HTML fragments when called by an AJAX method
+ *
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/webpage.class.inc.php");
+ 
+class ajax_page extends WebPage implements iTabbedPage
+{
+    /**
+     * Jquery style ready script
+     * @var Hash     
+     */	  
+	protected $m_sReadyScript;
+	protected $m_oTabs;
+	private $m_sMenu; // If set, then the menu will be updated
+	
+    /**
+     * constructor for the web page
+     * @param string $s_title Not used
+     */	  
+	function __construct($s_title)
+    {
+		$sPrintable = utils::ReadParam('printable', '0');
+		$bPrintable = ($sPrintable == '1');
+
+        parent::__construct($s_title, $bPrintable);
+        $this->m_sReadyScript = "";
+		//$this->add_header("Content-type: text/html; charset=utf-8");
+		$this->add_header("Cache-control: no-cache");
+		$this->m_oTabs = new TabManager();
+		$this->sContentType = 'text/html';
+		$this->sContentDisposition = 'inline';
+		$this->m_sMenu = "";
+
+		utils::InitArchiveMode();
+    }
+
+	public function AddTabContainer($sTabContainer, $sPrefix = '')
+	{
+		$this->add($this->m_oTabs->AddTabContainer($sTabContainer, $sPrefix));
+	}
+
+	public function AddToTab($sTabContainer, $sTabLabel, $sHtml)
+	{
+		$this->add($this->m_oTabs->AddToTab($sTabContainer, $sTabLabel, $sHtml));
+	}
+
+	public function SetCurrentTabContainer($sTabContainer = '')
+	{
+		return $this->m_oTabs->SetCurrentTabContainer($sTabContainer);
+	}
+
+	public function SetCurrentTab($sTabLabel = '')
+	{
+		return $this->m_oTabs->SetCurrentTab($sTabLabel);
+	}
+	
+	/**
+	 * Add a tab which content will be loaded asynchronously via the supplied URL
+	 * 
+	 * Limitations:
+	 * Cross site scripting is not not allowed for security reasons. Use a normal tab with an IFRAME if you want to pull content from another server.
+	 * Static content cannot be added inside such tabs.
+	 * 
+	 * @param string $sTabLabel The (localised) label of the tab
+	 * @param string $sUrl The URL to load (on the same server)
+	 * @param boolean $bCache Whether or not to cache the content of the tab once it has been loaded. flase will cause the tab to be reloaded upon each activation.
+	 * @since 2.0.3
+	 */
+	public function AddAjaxTab($sTabLabel, $sUrl, $bCache = true)
+	{
+		$this->add($this->m_oTabs->AddAjaxTab($sTabLabel, $sUrl, $bCache));
+	}
+	
+	public function GetCurrentTab()
+	{
+		return $this->m_oTabs->GetCurrentTab();
+	}
+
+	public function RemoveTab($sTabLabel, $sTabContainer = null)
+	{
+		$this->m_oTabs->RemoveTab($sTabLabel, $sTabContainer);
+	}
+
+	/**
+	 * Finds the tab whose title matches a given pattern
+	 * @return mixed The name of the tab as a string or false if not found
+	 */
+	public function FindTab($sPattern, $sTabContainer = null)
+	{
+		return $this->m_oTabs->FindTab($sPattern, $sTabContainer);
+	}
+
+	/**
+	 * Make the given tab the active one, as if it were clicked
+	 * DOES NOT WORK: apparently in the *old* version of jquery
+	 * that we are using this is not supported... TO DO upgrade
+	 * the whole jquery bundle...
+	 */
+	public function SelectTab($sTabContainer, $sTabLabel)
+	{
+		$this->add_ready_script($this->m_oTabs->SelectTab($sTabContainer, $sTabLabel));
+	}
+	
+	public function AddToMenu($sHtml)
+	{
+		$this->m_sMenu .= $sHtml;
+	}
+
+    /**
+     * Echoes the content of the whole page
+     * @return void
+     */	  
+    public function output()
+    {
+    	if (!empty($this->sContentType))
+    	{
+			$this->add_header('Content-type: '.$this->sContentType);
+    	}
+    	if (!empty($this->sContentDisposition))
+    	{
+			$this->add_header('Content-Disposition: '.$this->sContentDisposition.'; filename="'.$this->sContentFileName.'"');
+    	}
+        foreach($this->a_headers as $s_header)
+        {
+            header($s_header);
+        }
+		if ($this->m_oTabs->TabsContainerCount() > 0)
+		{
+			$this->add_ready_script(
+<<<EOF
+			// The "tab widgets" to handle.
+			var tabs = $('div[id^=tabbedContent]');
+			  
+			// Ugly patch for a change in the behavior of jQuery UI:
+			// Before jQuery UI 1.9, tabs were always considered as "local" (opposed to Ajax)
+			// when their href was beginning by #. Starting with 1.9, a <base> tag in the page
+			// is taken into account and causes "local" tabs to be considered as Ajax
+			// unless their URL is equal to the URL of the page...
+			if ($('base').length > 0)
+			{
+				$('div[id^=tabbedContent] > ul > li > a').each(function() {
+					var sHash = location.hash;
+					var sCleanLocation = location.href.toString().replace(sHash, '').replace(/#$/, '');
+		    		$(this).attr("href", sCleanLocation+$(this).attr("href"));
+				});
+			}
+			if ($.bbq)
+			{
+				// This selector will be reused when selecting actual tab widget A elements.
+				var tab_a_selector = 'ul.ui-tabs-nav a';
+				  
+				// Enable tabs on all tab widgets. The `event` property must be overridden so
+				// that the tabs aren't changed on click, and any custom event name can be
+				// specified. Note that if you define a callback for the 'select' event, it
+				// will be executed for the selected tab whenever the hash changes.
+				tabs.tabs({ event: 'change' });
+				  
+				// Define our own click handler for the tabs, overriding the default.
+				tabs.find( tab_a_selector ).click(function()
+				{
+					var state = {};
+							  
+					// Get the id of this tab widget.
+					var id = $(this).closest( 'div[id^=tabbedContent]' ).attr( 'id' );
+					  
+					// Get the index of this tab.
+					var idx = $(this).parent().prevAll().length;
+					
+					// Set the state!
+					state[ id ] = idx;
+					$.bbq.pushState( state );
+				});
+			}
+			else
+			{
+				tabs.tabs();
+			}
+EOF
+);
+		}
+		// Render the tabs in the page (if any)
+		$this->s_content = $this->m_oTabs->RenderIntoContent($this->s_content, $this);
+		
+		// Additional UI widgets to be activated inside the ajax fragment
+		// Important: Testing the content type is not enough because some ajax handlers have not correctly positionned the flag (e.g json response corrupted by the script)
+		if (($this->sContentType == 'text/html') && (preg_match('/class="date-pick"/', $this->s_content) || preg_match('/class="datetime-pick"/', $this->s_content)) )
+		{
+			$this->add_ready_script(
+<<<EOF
+PrepareWidgets();
+EOF
+			);
+		}
+        $s_captured_output = $this->ob_get_clean_safe();
+		  if (($this->sContentType == 'text/html') &&  ($this->sContentDisposition == 'inline'))
+        {
+        	// inline content != attachment && html => filter all scripts for malicious XSS scripts
+        	echo self::FilterXSS($this->s_content);
+        }
+        else
+        {
+        	echo $this->s_content;
+        }
+        if (!empty($this->m_sMenu))
+        {
+           $uid = time();
+           echo "<div id=\"accordion_temp_$uid\">\n";
+           echo "<div id=\"accordion\">\n";
+           echo "<!-- Beginning of the accordion menu -->\n";
+           echo self::FilterXSS($this->m_sMenu);
+           echo "<!-- End of the accordion menu-->\n";
+           echo "</div>\n";
+           echo "</div>\n";
+
+	        echo "<script type=\"text/javascript\">\n";
+	        echo "$('#inner_menu').html($('#accordion_temp_$uid').html());\n";
+	        echo "$('#accordion_temp_$uid').remove();\n";
+	        echo "\n</script>\n";
+        }
+
+        //echo $this->s_deferred_content;
+        if (count($this->a_scripts) > 0)
+        {
+        	echo "<script type=\"text/javascript\">\n";
+        	echo implode("\n", $this->a_scripts);
+        	echo "\n</script>\n";
+        }
+        if (count($this->a_linked_scripts) > 0)
+        {
+        	echo "<script type=\"text/javascript\">\n";
+        	foreach($this->a_linked_scripts as $sScriptUrl)
+        	{
+        		echo '$.getScript('.json_encode($sScriptUrl).");\n";
+        	}
+        	echo "\n</script>\n";
+        }
+        if (!empty($this->s_deferred_content))
+        {
+            echo "<script type=\"text/javascript\">\n";
+            echo "\$('body').append('".addslashes(str_replace("\n", '', $this->s_deferred_content))."');\n";
+            echo "\n</script>\n";
+        }
+        if (!empty($this->m_sReadyScript))
+        {
+	        echo "<script type=\"text/javascript\">\n";
+	        echo $this->m_sReadyScript; // Ready Scripts are output as simple scripts
+	        echo "\n</script>\n";
+        }
+        if(count($this->a_linked_stylesheets) > 0)
+        {
+        	echo "<script type=\"text/javascript\">";
+        	foreach($this->a_linked_stylesheets as $aStylesheet)
+	        {
+		        $sStylesheetUrl = $aStylesheet['link'];
+	        	echo "if (!$('link[href=\"{$sStylesheetUrl}\"]').length) $('<link href=\"{$sStylesheetUrl}\" rel=\"stylesheet\">').appendTo('head');\n";
+	        }
+        	echo "\n</script>\n";
+        }
+        
+		if (trim($s_captured_output) != "")
+        {
+        	echo self::FilterXSS($s_captured_output);
+        }
+
+        if (class_exists('DBSearch'))
+        {
+            DBSearch::RecordQueryTrace();
+        }
+    }
+
+    /**
+     * Adds a paragraph with a smaller font into the page
+     * NOT implemented (i.e does nothing)
+     * @param string $sText Content of the (small) paragraph     
+     * @return void
+     */	 	      
+    public function small_p($sText)
+    {
+	}
+
+    public function add($sHtml)
+    {
+        if (($this->m_oTabs->GetCurrentTabContainer() != '') && ($this->m_oTabs->GetCurrentTab() != ''))
+        {
+            $this->m_oTabs->AddToTab($this->m_oTabs->GetCurrentTabContainer(), $this->m_oTabs->GetCurrentTab(), $sHtml);
+        }
+        else
+        {
+            parent::add($sHtml);
+        }
+    }
+
+	/**
+	 * Records the current state of the 'html' part of the page output
+	 * @return mixed The current state of the 'html' output
+	 */    
+    public function start_capture()
+    {
+    	$sCurrentTabContainer = $this->m_oTabs->GetCurrentTabContainer();
+		$sCurrentTab = $this->m_oTabs->GetCurrentTab();
+		
+		if (!empty($sCurrentTabContainer) && !empty($sCurrentTab))
+		{
+			$iOffset = $this->m_oTabs->GetCurrentTabLength();
+			return array('tc' => $sCurrentTabContainer, 'tab' => $sCurrentTab, 'offset' => $iOffset);
+		}
+		else
+		{
+			return parent::start_capture();
+		}
+    }
+
+    /**
+     * Returns the part of the html output that occurred since the call to start_capture
+     * and removes this part from the current html output
+     * @param $offset mixed The value returned by start_capture
+     * @return string The part of the html output that was added since the call to start_capture
+     */    
+    public function end_capture($offset)
+    {
+		if (is_array($offset))
+		{
+			if ($this->m_oTabs->TabExists($offset['tc'], $offset['tab']))
+			{
+				$sCaptured = $this->m_oTabs->TruncateTab($offset['tc'], $offset['tab'], $offset['offset']);
+			}
+			else
+			{
+				$sCaptured = '';
+			}
+		}
+		else
+		{
+			$sCaptured = parent::end_capture($offset);
+		}
+		return $sCaptured;
+    }
+
+	/**
+	 * Add any text or HTML fragment (identified by an ID) at the end of the body of the page
+	 * This is useful to add hidden content, DIVs or FORMs that should not
+	 * be embedded into each other.	 	 
+	 */
+    public function add_at_the_end($s_html, $sId = '')
+    {
+    	if ($sId != '')
+    	{
+	    	$this->add_script("$('#{$sId}').remove();"); // Remove any previous instance of the same Id
+    	}
+        $this->s_deferred_content .= $s_html;
+    }
+	
+	/**
+	 * Adds a script to be executed when the DOM is ready (typical JQuery use)
+	 * NOT implemented in this version of the class.
+	 * @return void	 
+	 */	 	 	
+	public function add_ready_script($sScript)
+	{
+		$this->m_sReadyScript .= $sScript."\n";
+	}
+	
+	/**
+	 * Cannot be called in this context, since Ajax pages do not share
+	 * any context with the calling page !!
+	 */
+	public function GetUniqueId()
+	{
+		assert(false);
+		return 0;
+	}
+	
+	public static function FilterXSS($sHTML)
+	{
+		return str_ireplace(array('<script', '</script>'), array('<!-- <removed-script', '</removed-script> -->'), $sHTML);
+	}
+}
+

application/application.inc.php

@@ -1,38 +1,40 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Includes all the classes to have the application up and running
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/application/applicationcontext.class.inc.php');
-require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
-require_once(APPROOT.'/application/displayblock.class.inc.php');
-require_once(APPROOT.'/application/sqlblock.class.inc.php');
-require_once(APPROOT.'/application/audit.category.class.inc.php');
-require_once(APPROOT.'/application/audit.rule.class.inc.php');
-//require_once(APPROOT.'/application/menunode.class.inc.php');
-require_once(APPROOT.'/application/utils.inc.php');
-
-class ApplicationException extends CoreException
-{
-}
-?>
+<?php
+// Copyright (C) 2010-2012 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/>
+
+
+/**
+ * Includes all the classes to have the application up and running
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'/application/applicationcontext.class.inc.php');
+require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
+require_once(APPROOT.'/application/displayblock.class.inc.php');
+require_once(APPROOT.'/application/audit.category.class.inc.php');
+require_once(APPROOT.'/application/audit.rule.class.inc.php');
+require_once(APPROOT.'/application/query.class.inc.php');
+require_once(APPROOT.'/setup/moduleinstallation.class.inc.php');
+//require_once(APPROOT.'/application/menunode.class.inc.php');
+require_once(APPROOT.'/application/utils.inc.php');
+
+class ApplicationException extends CoreException
+{
+}
+?>

application/applicationcontext.class.inc.php

@@ -1,303 +1,409 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class ApplicationContext
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT."/application/utils.inc.php");
-
-/**
- * Interface for directing end-users to the relevant application
- */ 
-interface iDBObjectURLMaker
-{
-	public static function MakeObjectURL($sClass, $iId);
-}
-
-/**
- * Direct end-users to the standard iTop application: UI.php
- */ 
-class iTopStandardURLMaker implements iDBObjectURLMaker
-{
-	public static function MakeObjectURL($sClass, $iId)
-	{
-		$sPage = DBObject::ComputeStandardUIPage($sClass);
-		$sAbsoluteUrl = utils::GetAbsoluteUrlAppRoot();
-		$sUrl = "{$sAbsoluteUrl}pages/$sPage?operation=details&class=$sClass&id=$iId";
-		return $sUrl;
-	}
-}
-
-/**
- * Direct end-users to the standard Portal application
- */ 
-class PortalURLMaker implements iDBObjectURLMaker
-{
-	public static function MakeObjectURL($sClass, $iId)
-	{
-		$sAbsoluteUrl = utils::GetAbsoluteUrlAppRoot();
-		$sUrl = "{$sAbsoluteUrl}portal/index.php?operation=details&class=$sClass&id=$iId";
-		return $sUrl;
-	}
-}
-
-
-/**
- * Helper class to store and manipulate the parameters that make the application's context
- *
- * Usage:
- * 1) Build the application's context by constructing the object
- *   (the object will read some of the page's parameters)
- *
- * 2) Add these parameters to hyperlinks or to forms using the helper, functions
- *    GetForLink(), GetForForm() or GetAsHash()
- */
-class ApplicationContext
-{
-	protected $aNames;
-	protected $aValues;
-	protected static $aDefaultValues; // Cache shared among all instances
-	
-	public function __construct()
-	{
-		$this->aNames = array(
-			'org_id', 'menu'
-		);
-		$this->ReadContext();
-	}
-	
-	/**
-	 * Read the context directly in the PHP parameters (either POST or GET)
-	 * return nothing
-	 */
-	protected function ReadContext()
-	{
-		if (!isset(self::$aDefaultValues))
-		{
-			self::$aDefaultValues = array();
-			$aContext = utils::ReadParam('c', array());
-			foreach($this->aNames as $sName)
-			{
-				$sValue = isset($aContext[$sName]) ? $aContext[$sName] : '';
-				// TO DO: check if some of the context parameters are mandatory (or have default values)
-				if (!empty($sValue))
-				{
-					self::$aDefaultValues[$sName] = $sValue;
-				}
-				// Hmm, there must be a better (more generic) way to handle the case below:
-				// When there is only one possible (allowed) organization, the context must be
-				// fixed to this org
-				if ($sName == 'org_id')
-				{
-					if (MetaModel::IsValidClass('Organization'))
-					{
-						$oSearchFilter = new DBObjectSearch('Organization');
-						$oSet = new CMDBObjectSet($oSearchFilter);
-						$iCount = $oSet->Count();
-						if ($iCount == 1)
-						{
-							// Only one possible value for org_id, set it in the context
-							$oOrg = $oSet->Fetch();
-							self::$aDefaultValues[$sName] = $oOrg->GetKey();
-						}
-					}					
-				}
-			}
-		}
-		$this->aValues = self::$aDefaultValues;
-	}
-	
-	/**
-	 * Returns the current value for the given parameter
-	 * @param string $sParamName Name of the parameter to read
-	 * @return mixed The value for this parameter
-	 */
-	public function GetCurrentValue($sParamName, $defaultValue = '')
-	{
-		if (isset($this->aValues[$sParamName]))
-		{
-			return $this->aValues[$sParamName];
-		}
-		return $defaultValue;
-	}
-	
-	/**
-	 * 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()
-	{
-		$aParams = array();
-		foreach($this->aValues as $sName => $sValue)
-		{
-			$aParams[] = "c[$sName]".'='.urlencode($sValue);
-		}
-		return implode("&", $aParams);
-	}
-	
-	/**
-	 * Returns the context as sequence of input tags to be inserted inside a <form> tag
-	 * return string The context as a sequence of <input type="hidden" /> tags
-	 */
-	public function GetForForm()
-	{
-		$sContext = "";
-		foreach($this->aValues as $sName => $sValue)
-		{
-			$sContext .= "<input type=\"hidden\" name=\"c[$sName]\" value=\"".htmlentities($sValue, ENT_QUOTES, 'UTF-8')."\" />\n";
-		}
-		return $sContext;
-	}
-
-	/**
-	 * Returns the context as a hash array 'parameter_name' => value
-	 * return array The context information
-	 */
-	public function GetAsHash()
-	{
-		$aReturn = array();
-		foreach($this->aValues as $sName => $sValue)
-		{
-			$aReturn["c[$sName]"] = $sValue;
-		}
-		return $aReturn;
-	}
-	
-	/**
-	 * Returns an array of the context parameters NAMEs
-	 * @return array The list of context parameters
-	 */
-	public function GetNames()
-	{
-		return $this->aNames;
-	}
-	/**
-	 * Removes the specified parameter from the context, for example when the same parameter
-	 * is already a search parameter
-	 * @param string $sParamName Name of the parameter to remove	 	 
-	 * @return none
-	 */	
-	public function Reset($sParamName)
-	{
-		if (isset($this->aValues[$sParamName]))
-		{
-			unset($this->aValues[$sParamName]);
-		}
-	}
-
-	/**
-	 * Initializes the given object with the default values provided by the context
-	 */
-	public function InitObjectFromContext(DBObject &$oObj)
-	{
-		$sClass = get_class($oObj);
-		foreach($this->GetNames() as $key)
-		{
-			$aCallSpec = array($sClass, 'MapContextParam');
-			if (is_callable($aCallSpec))
-			{
-				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
-			}
-
-			if (MetaModel::IsValidAttCode($sClass, $sAttCode))
-			{
-				$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
-				if ($oAttDef->IsWritable())
-				{
-					$value = $this->GetCurrentValue($key, null);
-					if (!is_null($value))
-					{
-						$oObj->Set($sAttCode, $value);
-					}
-				}
-			}
-		}		
-	}
-	
-	static $m_sUrlMakerClass = null;
-
-	/**
-	 * Set the current application url provider
-	 * @param sClass string Class implementing iDBObjectURLMaker	 
-	 * @return void
-	 */
-	public static function SetUrlMakerClass($sClass = 'iTopStandardURLMaker')
-	{
-		$sPrevious = self::GetUrlMakerClass();
-
-		self::$m_sUrlMakerClass = $sClass;
-		$_SESSION['UrlMakerClass'] = $sClass;
-
-		return $sPrevious;
-	}
-
-	/**
-	 * Get the current application url provider
-	 * @return string the name of the class
-	 */
-	public static function GetUrlMakerClass()
-	{
-		if (is_null(self::$m_sUrlMakerClass))
-		{
-			if (isset($_SESSION['UrlMakerClass']))
-			{
-				self::$m_sUrlMakerClass = $_SESSION['UrlMakerClass'];
-			}
-			else
-			{
-				self::$m_sUrlMakerClass = 'iTopStandardURLMaker';
-			}
-		}
-		return self::$m_sUrlMakerClass;
-	}
-
-	/**
-	 * Get the current application url provider
-	 * @return string the name of the class
-	 */
-   public static function MakeObjectUrl($sObjClass, $sObjKey, $sUrlMakerClass = null, $bWithNavigationContext = true)
-   {
-   	$oAppContext = new ApplicationContext();
-
-      if (is_null($sUrlMakerClass))
-      {
-			$sUrlMakerClass = self::GetUrlMakerClass();
-		}
-		$sUrl = call_user_func(array($sUrlMakerClass, 'MakeObjectUrl'), $sObjClass, $sObjKey);
-		if (strlen($sUrl) > 0)
-		{
-			if ($bWithNavigationContext)
-			{
-				return $sUrl."&".$oAppContext->GetForLink();
-			}
-			else
-			{
-				return $sUrl;
-			}
-		}
-		else
-		{
-			return '';
-		}	
-	}
-}
-?>
+<?php
+// Copyright (C) 2010-2018 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/>
+
+
+/**
+ * Class ApplicationContext
+ *
+ * @copyright   Copyright (C) 2010-2018 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/utils.inc.php");
+
+/**
+ * Interface for directing end-users to the relevant application
+ */ 
+interface iDBObjectURLMaker
+{
+    /**
+     * @param string $sClass
+     * @param string $iId
+     *
+     * @return string
+     */
+	public static function MakeObjectURL($sClass, $iId);
+}
+
+/**
+ * Direct end-users to the standard iTop application: UI.php
+ */ 
+class iTopStandardURLMaker implements iDBObjectURLMaker
+{
+    /**
+     * @param string $sClass
+     * @param string $iId
+     *
+     * @return string
+     * @throws \Exception
+     */
+	public static function MakeObjectURL($sClass, $iId)
+	{
+		$sPage = DBObject::ComputeStandardUIPage($sClass);
+		$sAbsoluteUrl = utils::GetAbsoluteUrlAppRoot();
+		$sUrl = "{$sAbsoluteUrl}pages/$sPage?operation=details&class=$sClass&id=$iId";
+		return $sUrl;
+	}
+}
+
+/**
+ * Direct end-users to the standard Portal application
+ */ 
+class PortalURLMaker implements iDBObjectURLMaker
+{
+    /**
+     * @param string $sClass
+     * @param string $iId
+     *
+     * @return string
+     * @throws \Exception
+     */
+	public static function MakeObjectURL($sClass, $iId)
+	{
+		$sAbsoluteUrl = utils::GetAbsoluteUrlAppRoot();
+		$sUrl = "{$sAbsoluteUrl}portal/index.php?operation=details&class=$sClass&id=$iId";
+		return $sUrl;
+	}
+}
+
+
+/**
+ * Helper class to store and manipulate the parameters that make the application's context
+ *
+ * Usage:
+ * 1) Build the application's context by constructing the object
+ *   (the object will read some of the page's parameters)
+ *
+ * 2) Add these parameters to hyperlinks or to forms using the helper, functions
+ *    GetForLink(), GetForForm() or GetAsHash()
+ */
+class ApplicationContext
+{
+    public static $m_sUrlMakerClass = null;
+    protected static $m_aPluginProperties = null;
+    protected static $aDefaultValues; // Cache shared among all instances
+
+	protected $aNames;
+	protected $aValues;
+
+    /**
+     * ApplicationContext constructor.
+     *
+     * @param bool $bReadContext
+     *
+     * @throws \Exception
+     */
+	public function __construct($bReadContext = true)
+	{
+		$this->aNames = array(
+			'org_id', 'menu'
+		);
+		if ($bReadContext)
+		{
+			$this->ReadContext();			
+		}
+
+	}
+
+    /**
+     * Read the context directly in the PHP parameters (either POST or GET)
+     * return nothing
+     *
+     * @throws \Exception
+     */
+	protected function ReadContext()
+	{
+		if (!isset(self::$aDefaultValues))
+		{
+			self::$aDefaultValues = array();
+			$aContext = utils::ReadParam('c', array(), false, 'context_param');
+			foreach($this->aNames as $sName)
+			{
+				$sValue = isset($aContext[$sName]) ? $aContext[$sName] : '';
+				// TO DO: check if some of the context parameters are mandatory (or have default values)
+				if (!empty($sValue))
+				{
+					self::$aDefaultValues[$sName] = $sValue;
+				}
+				// Hmm, there must be a better (more generic) way to handle the case below:
+				// When there is only one possible (allowed) organization, the context must be
+				// fixed to this org unless there is only one organization in the system then
+				// no filter is applied
+				if ($sName == 'org_id')
+				{
+					if (MetaModel::IsValidClass('Organization'))
+					{
+						$oSearchFilter = new DBObjectSearch('Organization');
+						$oSet = new CMDBObjectSet($oSearchFilter);
+						$iCount = $oSet->CountWithLimit(2);
+						if ($iCount > 1)
+						{
+							$oSearchFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true);
+							$oSet = new CMDBObjectSet($oSearchFilter);
+							$iCount = $oSet->CountWithLimit(2);
+							if ($iCount == 1)
+							{
+								// Only one possible value for org_id, set it in the context
+								$oOrg = $oSet->Fetch();
+								self::$aDefaultValues[$sName] = $oOrg->GetKey();
+							}
+						}
+					}					
+				}
+			}
+		}
+		$this->aValues = self::$aDefaultValues;
+	}
+
+    /**
+     * Returns the current value for the given parameter
+     *
+     * @param string $sParamName Name of the parameter to read
+     * @param string $defaultValue
+     *
+     * @return mixed The value for this parameter
+     */
+	public function GetCurrentValue($sParamName, $defaultValue = '')
+	{
+		if (isset($this->aValues[$sParamName]))
+		{
+			return $this->aValues[$sParamName];
+		}
+		return $defaultValue;
+	}
+	
+	/**
+	 * 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()
+	{
+		$aParams = array();
+		foreach($this->aValues as $sName => $sValue)
+		{
+			$aParams[] = "c[$sName]".'='.urlencode($sValue);
+		}
+		return implode("&", $aParams);
+	}
+	
+	/**
+	 * Returns the context as sequence of input tags to be inserted inside a <form> tag
+	 * @return string The context as a sequence of <input type="hidden" /> tags
+	 */
+	public function GetForForm()
+	{
+		$sContext = "";
+		foreach($this->aValues as $sName => $sValue)
+		{
+			$sContext .= "<input type=\"hidden\" name=\"c[$sName]\" value=\"".htmlentities($sValue, ENT_QUOTES, 'UTF-8')."\" />\n";
+		}
+		return $sContext;
+	}
+
+	/**
+	 * Returns the context as a hash array 'parameter_name' => value
+	 * @return array The context information
+	 */
+	public function GetAsHash()
+	{
+		$aReturn = array();
+		foreach($this->aValues as $sName => $sValue)
+		{
+			$aReturn["c[$sName]"] = $sValue;
+		}
+		return $aReturn;
+	}
+	
+	/**
+	 * Returns an array of the context parameters NAMEs
+	 * @return array The list of context parameters
+	 */
+	public function GetNames()
+	{
+		return $this->aNames;
+	}
+	/**
+	 * Removes the specified parameter from the context, for example when the same parameter
+	 * is already a search parameter
+	 * @param string $sParamName Name of the parameter to remove
+	 */	
+	public function Reset($sParamName)
+	{
+		if (isset($this->aValues[$sParamName]))
+		{
+			unset($this->aValues[$sParamName]);
+		}
+	}
+
+	/**
+	 * Initializes the given object with the default values provided by the context
+	 *
+	 * @param \DBObject $oObj
+	 *
+	 * @throws \Exception
+	 * @throws \CoreUnexpectedValue
+	 */
+	public function InitObjectFromContext(DBObject &$oObj)
+	{
+		$sClass = get_class($oObj);
+		foreach($this->GetNames() as $key)
+		{
+			$aCallSpec = array($sClass, 'MapContextParam');
+			if (is_callable($aCallSpec))
+			{
+				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+
+				if (MetaModel::IsValidAttCode($sClass, $sAttCode))
+				{
+					$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+					if ($oAttDef->IsWritable())
+					{
+						$value = $this->GetCurrentValue($key, null);
+						if (!is_null($value))
+						{
+							$oObj->Set($sAttCode, $value);
+						}
+					}
+				}
+			}
+		}		
+	}
+
+	/**
+	 * Set the current application url provider
+	 * @param string $sClass Class implementing iDBObjectURLMaker
+	 * @return string
+	 */
+	public static function SetUrlMakerClass($sClass = 'iTopStandardURLMaker')
+	{
+		$sPrevious = self::GetUrlMakerClass();
+
+		self::$m_sUrlMakerClass = $sClass;
+		$_SESSION['UrlMakerClass'] = $sClass;
+
+		return $sPrevious;
+	}
+
+	/**
+	 * Get the current application url provider
+	 * @return string the name of the class
+	 */
+	public static function GetUrlMakerClass()
+	{
+		if (is_null(self::$m_sUrlMakerClass))
+		{
+			if (isset($_SESSION['UrlMakerClass']))
+			{
+				self::$m_sUrlMakerClass = $_SESSION['UrlMakerClass'];
+			}
+			else
+			{
+				self::$m_sUrlMakerClass = 'iTopStandardURLMaker';
+			}
+		}
+		return self::$m_sUrlMakerClass;
+	}
+
+	/**
+	 * Get the current application url provider
+	 *
+	 * @param string $sObjClass
+	 * @param string $sObjKey
+	 * @param null $sUrlMakerClass
+	 * @param bool $bWithNavigationContext
+	 *
+	 * @return string the name of the class
+	 * @throws \Exception
+	 */
+   public static function MakeObjectUrl($sObjClass, $sObjKey, $sUrlMakerClass = null, $bWithNavigationContext = true)
+   {
+   	$oAppContext = new ApplicationContext();
+
+      if (is_null($sUrlMakerClass))
+      {
+			$sUrlMakerClass = self::GetUrlMakerClass();
+		}
+		$sUrl = call_user_func(array($sUrlMakerClass, 'MakeObjectUrl'), $sObjClass, $sObjKey);
+		if (strlen($sUrl) > 0)
+		{
+			if ($bWithNavigationContext)
+			{
+				return $sUrl."&".$oAppContext->GetForLink();
+			}
+			else
+			{
+				return $sUrl;
+			}
+		}
+		else
+		{
+			return '';
+		}	
+	}
+
+	/**
+	 * Load plugin properties for the current session
+	 * @return void
+	 */
+	protected static function LoadPluginProperties()
+	{
+		if (isset($_SESSION['PluginProperties']))
+		{
+			self::$m_aPluginProperties = $_SESSION['PluginProperties'];
+		}
+		else
+		{
+			self::$m_aPluginProperties = array();
+		}
+	}
+
+	/**
+	 * Set plugin properties
+	 * @param string $sPluginClass Class implementing any plugin interface
+	 * @param string $sProperty Name of the property
+	 * @param mixed $value Value (numeric or string)
+	 * @return void
+	 */
+	public static function SetPluginProperty($sPluginClass, $sProperty, $value)
+	{
+		if (is_null(self::$m_aPluginProperties)) self::LoadPluginProperties();
+
+		self::$m_aPluginProperties[$sPluginClass][$sProperty] = $value;
+		$_SESSION['PluginProperties'][$sPluginClass][$sProperty] = $value;
+	}
+
+	/**
+	 * Get plugin properties
+	 * @param string $sPluginClass Class implementing any plugin interface
+	 * @return array of sProperty=>value pairs
+	 */
+	public static function GetPluginProperties($sPluginClass)
+	{
+		if (is_null(self::$m_aPluginProperties)) self::LoadPluginProperties();
+
+		if (array_key_exists($sPluginClass, self::$m_aPluginProperties))
+		{
+			return self::$m_aPluginProperties[$sPluginClass];
+		}
+		else
+		{
+			return array();
+		}
+	}
+
+}

application/audit.category.class.inc.php

@@ -1,59 +1,60 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * This class manages the audit "categories". Each category defines a set of objects
- * to check and is linked to a set of rules that determine the valid or invalid objects
- * inside the set 
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
-
-class AuditCategory extends cmdbAbstractObject
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "application",
-			"key_type" => "autoincrement",
-			"name_attcode" => "name",
-			"state_attcode" => "",
-			"reconc_keys" => array('name'),
-			"db_table" => "priv_auditcategory",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		MetaModel::Init_AddAttribute(new AttributeString("name", array("description"=>"Short name for this category", "allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeOQL("definition_set", array("allowed_values"=>null, "sql"=>"definition_set", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeLinkedSet("rules_list", array("linked_class"=>"AuditRule", "ext_key_to_me"=>"category_id", "allowed_values"=>null, "count_min"=>0, "count_max"=>0, "depends_on"=>array())));
-
-		// Display lists
-		MetaModel::Init_SetZListItems('details', array('name', 'description', 'definition_set', 'rules_list')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('description', )); // Attributes to be displayed for a list
-		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('name', 'description')); // Criteria of the std search form
-		MetaModel::Init_SetZListItems('advanced_search', array('name', 'description', 'definition_set')); // Criteria of the advanced search form
-	}
-}
-?>
+<?php
+// Copyright (C) 2010-2012 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/>
+
+
+/**
+ * This class manages the audit "categories". Each category defines a set of objects
+ * to check and is linked to a set of rules that determine the valid or invalid objects
+ * inside the set 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
+
+class AuditCategory extends cmdbAbstractObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "application, grant_by_profile",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array('name'),
+			"db_table" => "priv_auditcategory",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("description"=>"Short name for this category", "allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeOQL("definition_set", array("allowed_values"=>null, "sql"=>"definition_set", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeLinkedSet("rules_list", array("linked_class"=>"AuditRule", "ext_key_to_me"=>"category_id", "allowed_values"=>null, "count_min"=>0, "count_max"=>0, "depends_on"=>array(), "edit_mode" => LINKSET_EDITMODE_INPLACE, "tracking_level" => LINKSET_TRACKING_ALL)));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'description', 'definition_set', 'rules_list')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('description', )); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('description', 'definition_set')); // Criteria of the std search form
+		MetaModel::Init_SetZListItems('default_search', array('name', 'description')); // Criteria of the default search form
+	}
+}
+?>

application/audit.rule.class.inc.php

@@ -1,63 +1,64 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * This class manages the audit "rule" linked to a given audit category.
- * Each rule is based on an OQL expression that returns either the "good" objects
- * or the "bad" ones. The core audit engines computes the complement to the definition
- * set when needed to obtain either the valid objects, or the ones with an error
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/application/audit.category.class.inc.php');
-
-class AuditRule extends cmdbAbstractObject
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "application",
-			"key_type" => "autoincrement",
-			"name_attcode" => "name",
-			"state_attcode" => "",
-			"reconc_keys" => array('name'),
-			"db_table" => "priv_auditrule",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-			"display_template" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeOQL("query", array("allowed_values"=>null, "sql"=>"query", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("valid_flag", array("allowed_values"=>new ValueSetEnum('true,false'), "sql"=>"valid_flag", "default_value"=>"true", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalKey("category_id", array("allowed_values"=>null, "sql"=>"category_id", "targetclass"=>"AuditCategory", "is_null_allowed"=>false, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("category_name", array("allowed_values"=>null, "extkey_attcode"=> 'category_id', "target_attcode"=>"name")));
-
-		// Display lists
-		MetaModel::Init_SetZListItems('details', array('category_id', 'name', 'description', 'query', 'valid_flag')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('category_id', 'description', 'valid_flag')); // Attributes to be displayed for a list
-		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('category_id', 'name', 'description', 'valid_flag')); // Criteria of the std search form
-		MetaModel::Init_SetZListItems('advanced_search', array('category_id', 'name', 'description', 'valid_flag', 'query')); // Criteria of the advanced search form
-	}
-}
-?>
+<?php
+// Copyright (C) 2010-2012 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/>
+
+
+/**
+ * This class manages the audit "rule" linked to a given audit category.
+ * Each rule is based on an OQL expression that returns either the "good" objects
+ * or the "bad" ones. The core audit engines computes the complement to the definition
+ * set when needed to obtain either the valid objects, or the ones with an error
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'/application/audit.category.class.inc.php');
+
+class AuditRule extends cmdbAbstractObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "application, grant_by_profile",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array('name'),
+			"db_table" => "priv_auditrule",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeOQL("query", array("allowed_values"=>null, "sql"=>"query", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("valid_flag", array("allowed_values"=>new ValueSetEnum('true,false'), "sql"=>"valid_flag", "default_value"=>"true", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeExternalKey("category_id", array("allowed_values"=>null, "sql"=>"category_id", "targetclass"=>"AuditCategory", "is_null_allowed"=>false, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeExternalField("category_name", array("allowed_values"=>null, "extkey_attcode"=> 'category_id', "target_attcode"=>"name")));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('category_id', 'name', 'description', 'query', 'valid_flag')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('category_id', 'description', 'valid_flag')); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('category_id', 'name', 'description', 'valid_flag', 'query')); // Criteria of the std search form
+		MetaModel::Init_SetZListItems('default_search', array('name', 'description', 'category_id')); // Criteria of the advanced search form
+	}
+}
+?>

application/capturewebpage.class.inc.php

@@ -0,0 +1,84 @@
+<?php
+// Copyright (C) 2016 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/>
+
+/**
+ * Adapter class: when an API requires WebPage and you want to produce something else
+ *
+ * @copyright   Copyright (C) 2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/webpage.class.inc.php");
+
+class CaptureWebPage extends WebPage
+{
+	protected $aReadyScripts;
+
+	function __construct()
+	{
+		parent::__construct('capture web page');
+		$this->aReadyScripts = array();
+	}
+
+	public function GetHtml()
+	{
+		$trash = $this->ob_get_clean_safe();
+		return $this->s_content;
+	}
+
+	public function GetJS()
+	{
+		$sRet = implode("\n", $this->a_scripts);
+		if (!empty($this->s_deferred_content))
+		{
+			$sRet .= "\n\$('body').append('".addslashes(str_replace("\n", '', $this->s_deferred_content))."');";
+		}
+		return $sRet;
+	}
+
+	public function GetReadyJS()
+	{
+		return "\$(document).ready(function() {\n".implode("\n", $this->aReadyScripts)."\n});";
+	}
+
+	public function GetCSS()
+	{
+		return $this->a_styles;
+	}
+
+	public function GetJSFiles()
+	{
+		return $this->a_linked_scripts;
+	}
+
+	public function GetCSSFiles()
+	{
+		return $this->a_linked_stylesheets;
+	}
+
+	public function output()
+	{
+		throw new Exception(__method__.' should not be called');
+	}
+
+	public function add_ready_script($sScript)
+	{
+		$this->aReadyScripts[] = $sScript;
+	}
+}
+

application/clipage.class.inc.php

@@ -1,88 +1,97 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * CLI page 
- * The page adds the content-type text/XML and the encoding into the headers
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT."/application/webpage.class.inc.php");
-
-class CLIPage
-{
-    function __construct($s_title)
-    {
-    }	
-
-    public function output()
-    {
-    }
-
-	public function add($sText)
-	{
-		echo $sText;
-	}	
-
-	public function p($sText)
-	{
-		echo $sText."\n";
-	}	
-
-	public function pre($sText)
-	{
-		echo $sText."\n";
-	}	
-
-	public function add_comment($sText)
-	{
-		echo "#".$sText."\n";
-	}	
-
-	public function table($aConfig, $aData, $aParams = array())
-	{
-		$aCells = array();
-		foreach($aConfig as $sName=>$aDef)
-		{
-			if (strlen($aDef['description']) > 0)
-			{
-				$aCells[] = $aDef['label'].' ('.$aDef['description'].')';
-			}
-			else
-			{
-				$aCells[] = $aDef['label'];
-			}
-		}
-		echo implode(';', $aCells)."\n";
-
-		foreach($aData as $aRow)
-		{
-			$aCells = array();
-			foreach($aConfig as $sName=>$aAttribs)
-			{
-				$sValue = $aRow["$sName"];
-				$aCells[] = $sValue;
-			}
-			echo implode(';', $aCells)."\n";
-		}
-	}
-}
-
-?>
+<?php
+// Copyright (C) 2010-2015 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/>
+
+
+/**
+ * CLI page 
+ * The page adds the content-type text/XML and the encoding into the headers
+ *
+ * @copyright   Copyright (C) 2010-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/webpage.class.inc.php");
+
+class CLIPage implements Page
+{
+    function __construct($s_title)
+    {
+    }	
+
+    public function output()
+    {
+        if (class_exists('DBSearch'))
+        {
+            DBSearch::RecordQueryTrace();
+        }
+        if (class_exists('ExecutionKPI'))
+        {
+            ExecutionKPI::ReportStats();
+        }
+    }
+
+	public function add($sText)
+	{
+		echo $sText;
+	}	
+
+	public function p($sText)
+	{
+		echo $sText."\n";
+	}	
+
+	public function pre($sText)
+	{
+		echo $sText."\n";
+	}	
+
+	public function add_comment($sText)
+	{
+		echo "#".$sText."\n";
+	}	
+
+	public function table($aConfig, $aData, $aParams = array())
+	{
+		$aCells = array();
+		foreach($aConfig as $sName=>$aDef)
+		{
+			if (strlen($aDef['description']) > 0)
+			{
+				$aCells[] = $aDef['label'].' ('.$aDef['description'].')';
+			}
+			else
+			{
+				$aCells[] = $aDef['label'];
+			}
+		}
+		echo implode(';', $aCells)."\n";
+
+		foreach($aData as $aRow)
+		{
+			$aCells = array();
+			foreach($aConfig as $sName=>$aAttribs)
+			{
+				$sValue = $aRow["$sName"];
+				$aCells[] = $sValue;
+			}
+			echo implode(';', $aCells)."\n";
+		}
+	}
+}
+
+?>

application/csvpage.class.inc.php

@@ -1,96 +1,111 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Simple web page with no includes or fancy formatting, useful to generateXML documents
- * The page adds the content-type text/XML and the encoding into the headers
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT."/application/webpage.class.inc.php");
-
-class CSVPage extends WebPage
-{
-    function __construct($s_title)
-    {
-        parent::__construct($s_title);
-		$this->add_header("Content-type: text/html; charset=utf-8");
-		$this->add_header("Cache-control: no-cache");
-    }	
-
-    public function output()
-    {
-		$this->add_header("Content-Length: ".strlen(trim($this->s_content)));
-        foreach($this->a_headers as $s_header)
-        {
-            header($s_header);
-        }
-        echo trim($this->s_content);
-    }
-
-	public function small_p($sText)
-	{
-	}
-
-	public function add($sText)
-	{
-		$this->s_content .= $sText;
-	}	
-
-	public function p($sText)
-	{
-		$this->s_content .= $sText."\n";
-	}	
-
-	public function add_comment($sText)
-	{
-		$this->s_content .= "#".$sText."\n";
-	}	
-
-	public function table($aConfig, $aData, $aParams = array())
-	{
-		$aCells = array();
-		foreach($aConfig as $sName=>$aDef)
-		{
-			if (strlen($aDef['description']) > 0)
-			{
-				$aCells[] = $aDef['label'].' ('.$aDef['description'].')';
-			}
-			else
-			{
-				$aCells[] = $aDef['label'];
-			}
-		}
-		$this->s_content .= implode(';', $aCells)."\n";
-
-		foreach($aData as $aRow)
-		{
-			$aCells = array();
-			foreach($aConfig as $sName=>$aAttribs)
-			{
-				$sValue = $aRow["$sName"];
-				$aCells[] = $sValue;
-			}
-			$this->s_content .= implode(';', $aCells)."\n";
-		}
-	}
-}
-
-?>
+<?php
+// Copyright (C) 2010-2015 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/>
+
+
+/**
+ * Simple web page with no includes or fancy formatting, useful to generateXML documents
+ * The page adds the content-type text/XML and the encoding into the headers
+ *
+ * @copyright   Copyright (C) 2010-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/webpage.class.inc.php");
+
+class CSVPage extends WebPage
+{
+    function __construct($s_title)
+    {
+        parent::__construct($s_title);
+		$this->add_header("Content-type: text/plain; charset=utf-8");
+		$this->add_header("Cache-control: no-cache");
+		//$this->add_header("Content-Transfer-Encoding: binary");
+    }	
+
+    public function output()
+    {
+			$this->add_header("Content-Length: ".strlen(trim($this->s_content)));
+
+			// Get the unexpected output but do nothing with it
+			$sTrash = $this->ob_get_clean_safe();
+
+        foreach($this->a_headers as $s_header)
+        {
+            header($s_header);
+        }
+        echo trim($this->s_content);
+        echo "\n";
+
+        if (class_exists('DBSearch'))
+        {
+            DBSearch::RecordQueryTrace();
+        }
+        if (class_exists('ExecutionKPI'))
+        {
+            ExecutionKPI::ReportStats();
+        }
+    }
+
+	public function small_p($sText)
+	{
+	}
+
+	public function add($sText)
+	{
+		$this->s_content .= $sText;
+	}	
+
+	public function p($sText)
+	{
+		$this->s_content .= $sText."\n";
+	}	
+
+	public function add_comment($sText)
+	{
+		$this->s_content .= "#".$sText."\n";
+	}	
+
+	public function table($aConfig, $aData, $aParams = array())
+	{
+		$aCells = array();
+		foreach($aConfig as $sName=>$aDef)
+		{
+			if (strlen($aDef['description']) > 0)
+			{
+				$aCells[] = $aDef['label'].' ('.$aDef['description'].')';
+			}
+			else
+			{
+				$aCells[] = $aDef['label'];
+			}
+		}
+		$this->s_content .= implode(';', $aCells)."\n";
+
+		foreach($aData as $aRow)
+		{
+			$aCells = array();
+			foreach($aConfig as $sName=>$aAttribs)
+			{
+				$sValue = $aRow["$sName"];
+				$aCells[] = $sValue;
+			}
+			$this->s_content .= implode(';', $aCells)."\n";
+		}
+	}
+}
+

application/dashboardlayout.class.inc.php

@@ -0,0 +1,220 @@
+<?php
+// Copyright (C) 2010-2012 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/>
+
+/**
+ * Dashboard presentation
+ * 
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */ 
+
+
+abstract class DashboardLayout
+{
+	public function __construct()
+	{
+		
+	}
+	
+	abstract public function Render($oPage, $aDashlets, $bEditMode = false);
+	
+	static public function GetInfo()
+	{
+		return array(
+			'label' => '',
+			'icon' => '',
+			'description' => '',
+		);
+	}
+}
+
+abstract class DashboardLayoutMultiCol extends DashboardLayout
+{
+	protected $iNbCols;
+	
+	public function __construct()
+	{
+		$this->iNbCols = 1;
+	}
+	
+	protected function TrimCell($aDashlets)
+	{
+		$aKeys = array_reverse(array_keys($aDashlets));
+		$idx = 0;
+		$bNoVisibleFound = true;
+		while($idx < count($aKeys) && $bNoVisibleFound)
+		{
+			/** @var \Dashlet $oDashlet */
+			$oDashlet = $aDashlets[$aKeys[$idx]];
+			if ($oDashlet->IsVisible())
+			{
+				$bNoVisibleFound = false;
+			}
+			else
+			{
+				unset($aDashlets[$aKeys[$idx]]);
+			}
+			$idx++;
+		}
+		return $aDashlets;
+	}
+	
+	protected function TrimCellsArray($aCells)
+	{
+		foreach($aCells as $key => $aDashlets)
+		{
+			$aCells[$key] = $this->TrimCell($aDashlets);
+		}
+		$aKeys = array_reverse(array_keys($aCells));
+		$idx = 0;
+		$bNoVisibleFound = true;
+		while($idx < count($aKeys) && $bNoVisibleFound)
+		{
+			$aDashlets = $aCells[$aKeys[$idx]];
+			if (count($aDashlets) > 0)
+			{
+				$bNoVisibleFound = false;
+			}
+			else
+			{
+				unset($aCells[$aKeys[$idx]]);
+			}
+			$idx++;
+		}
+		return $aCells;		
+		
+	}
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $aCells
+	 * @param bool $bEditMode
+	 * @param array $aExtraParams
+	 */
+	public function Render($oPage, $aCells, $bEditMode = false, $aExtraParams = array())
+	{
+		// Trim the list of cells to remove the invisible/empty ones at the end of the array
+		$aCells = $this->TrimCellsArray($aCells);
+		
+		$oPage->add('<table style="width:100%;table-layout:fixed;"><tbody>');
+		$iCellIdx = 0;
+		$fColSize = 100 / $this->iNbCols;
+		$sStyle = $bEditMode ? 'border: 1px #ccc dashed; width:'.$fColSize.'%;' : 'width: '.$fColSize.'%;';
+		$sClass = $bEditMode ? 'layout_cell edit_mode' : 'dashboard';
+		$iNbRows = ceil(count($aCells) / $this->iNbCols);
+		for($iRows = 0; $iRows < $iNbRows; $iRows++)
+		{
+			$oPage->add('<tr>');
+			for($iCols = 0; $iCols < $this->iNbCols; $iCols++)
+			{
+				$sCellClass = ($iRows == $iNbRows-1) ? $sClass.' layout_last_used_rank' : $sClass;
+				$oPage->add("<td style=\"$sStyle\" class=\"$sCellClass\" data-dashboard-cell-index=\"$iCellIdx\">");
+				if (array_key_exists($iCellIdx, $aCells))
+				{
+					$aDashlets = $aCells[$iCellIdx];
+					if (count($aDashlets) > 0)
+					{
+						/** @var \Dashlet $oDashlet */
+						foreach($aDashlets as $oDashlet)
+						{
+							if ($oDashlet->IsVisible())
+							{
+								$oDashlet->DoRender($oPage, $bEditMode, true /* bEnclosingDiv */, $aExtraParams);
+							}
+						}
+					}
+					else
+					{
+						$oPage->add('&nbsp;');
+					}
+				}
+				else
+				{
+					$oPage->add('&nbsp;');
+				}
+				$oPage->add('</td>');
+				$iCellIdx++;
+			}
+			$oPage->add('</tr>');
+		}
+		if ($bEditMode) // Add one row for extensibility
+		{
+			$sStyle = 'style="border: 1px #ccc dashed; width:'.$fColSize.'%;" class="layout_cell edit_mode layout_extension" data-dashboard-cell-index="'.$iCellIdx.'"';
+			$oPage->add('<tr>');
+			for($iCols = 0; $iCols < $this->iNbCols; $iCols++)
+			{
+				$oPage->add("<td $sStyle>");
+				$oPage->add('&nbsp;');
+				$oPage->add('</td>');
+			}
+			$oPage->add('</tr>');
+		}
+		$oPage->add('</tbody></table>');
+	}
+}
+
+class DashboardLayoutOneCol extends DashboardLayoutMultiCol
+{
+	public function __construct()
+	{
+		parent::__construct();
+		$this->iNbCols = 1;
+	}
+	static public function GetInfo()
+	{
+		return array(
+			'label' => 'One Column',
+			'icon' => 'images/layout_1col.png',
+			'description' => '',
+		);
+	}
+}
+
+class DashboardLayoutTwoCols extends DashboardLayoutMultiCol
+{
+	public function __construct()
+	{
+		parent::__construct();
+		$this->iNbCols = 2;
+	}
+	static public function GetInfo()
+	{
+		return array(
+			'label' => 'Two Columns',
+			'icon' =>  'images/layout_2col.png',
+			'description' => '',
+		);
+	}
+}
+
+class DashboardLayoutThreeCols extends DashboardLayoutMultiCol
+{
+	public function __construct()
+	{
+		parent::__construct();
+		$this->iNbCols = 3;
+	}
+	static public function GetInfo()
+	{
+		return array(
+			'label' => 'Two Columns',
+			'icon' =>  'images/layout_3col.png',
+			'description' => '',
+		);
+	}
+}

application/datamodel.application.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<itop_design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.6">
+  <portals>
+    <portal id="legacy_portal" _delta="define">
+      <url>portal/index.php</url>
+      <rank>1.0</rank>
+      <handler/>
+      <allow>
+      </allow>
+      <deny/>
+    </portal>
+    <portal id="backoffice" _delta="define">
+      <url>pages/UI.php</url>
+      <rank>2.0</rank>
+      <handler/>
+      <allow/>
+      <deny>
+        <profile id="Portal user"/>
+      </deny>
+    </portal>
+  </portals>
+  <menus>
+    <menu id="AdminTools" xsi:type="MenuGroup" _delta="define">
+      <rank>80</rank>
+    </menu>
+  </menus>
+</itop_design>

application/datatable.class.inc.php

@@ -0,0 +1,950 @@
+<?php
+// Copyright (C) 2010-2017 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/>
+/**
+ * Data Table to display a set of objects in a tabular manner in HTML
+ *
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class DataTable
+{
+	protected $iListId;		// Unique ID inside the web page
+	protected $sTableId;	// identifier for saving the settings (combined with the class aliases)
+	protected $oSet;		// The set of objects to display
+	protected $aClassAliases;	// The aliases (alias => class) inside the set
+	protected $iNbObjects;		// Total number of objects inthe set
+	protected $bUseCustomSettings;	// Whether or not the current display uses custom settings
+	protected $oDefaultSettings;	// the default settings for displaying such a list
+	protected $bShowObsoleteData;
+
+	/**
+	 * @param $iListId mixed Unique ID for this div/table in the page
+	 * @param $oSet DBObjectSet The set of data to display
+	 * @param $aClassAliases Hash The list of classes/aliases to be displayed in this set $sAlias => $sClassName
+	 * @param $sTableId mixed A string (or null) identifying this table in order to persist its settings
+	 */
+	public function __construct($iListId, $oSet, $aClassAliases, $sTableId = null)
+	{
+		$this->iListId = utils::GetSafeId($iListId); // Make a "safe" ID for jQuery
+		$this->oSet = $oSet;
+		$this->aClassAliases = $aClassAliases;
+		$this->sTableId = $sTableId;
+		$this->iNbObjects = $oSet->Count();
+		$this->bUseCustomSettings = false;
+		$this->oDefaultSettings = null;
+		$this->bShowObsoleteData = $oSet->GetShowObsoleteData();
+	}
+	
+	public function Display(WebPage $oPage, DataTableSettings $oSettings, $bActionsMenu, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		$this->oDefaultSettings = $oSettings;
+
+		// Identified tables can have their own specific settings
+		$oCustomSettings = DataTableSettings::GetTableSettings($this->aClassAliases, $this->sTableId);
+		
+		if ($oCustomSettings != null)
+		{
+			// Custom settings overload the default ones
+			$this->bUseCustomSettings = true;
+			if ($this->oDefaultSettings->iDefaultPageSize == 0)
+			{
+				$oCustomSettings->iDefaultPageSize = 0;
+			}
+		}
+		else
+		{
+			$oCustomSettings = $oSettings;
+		}
+
+		if ($oCustomSettings->iDefaultPageSize > 0)
+		{
+			$this->oSet->SetLimit($oCustomSettings->iDefaultPageSize);
+		}
+		$this->oSet->SetOrderBy($oCustomSettings->GetSortOrder());
+
+		// Load only the requested columns
+		$aColumnsToLoad = array();
+		foreach($oCustomSettings->aColumns as $sAlias => $aColumnsInfo)
+		{
+			foreach($aColumnsInfo as $sAttCode => $aData)
+			{
+				if ($sAttCode != '_key_')
+				{
+					if ($aData['checked'])
+					{
+						$aColumnsToLoad[$sAlias][] = $sAttCode;
+					}
+					else
+					{
+						// See if this column is a must to load			
+						$sClass = $this->aClassAliases[$sAlias];
+						$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+						if ($oAttDef->alwaysLoadInTables())
+						{
+							$aColumnsToLoad[$sAlias][] = $sAttCode;
+						}
+					}
+				}
+			}
+		}
+		$this->oSet->OptimizeColumnLoad($aColumnsToLoad);
+
+
+		$bToolkitMenu = true;
+		if (isset($aExtraParams['toolkit_menu']))
+		{
+			$bToolkitMenu = (bool) $aExtraParams['toolkit_menu'];
+		}
+		if (UserRights::IsPortalUser())
+		{
+			// Portal users have a limited access to data, for now they can only see what's configured for them
+			$bToolkitMenu = false;
+		}
+		
+		return $this->GetAsHTML($oPage, $oCustomSettings->iDefaultPageSize, $oCustomSettings->iDefaultPageSize, 0, $oCustomSettings->aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams);
+	}
+	
+	public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		$sObjectsCount = $this->GetObjectCount($oPage, $sSelectMode);
+		$sPager = $this->GetPager($oPage, $iPageSize, $iDefaultPageSize, $iPageIndex);
+		$sActionsMenu = '';
+		$sToolkitMenu = '';
+		if ($bActionsMenu)
+		{
+			$sActionsMenu = $this->GetActionsMenu($oPage, $aExtraParams);
+		}
+		if ($bToolkitMenu)
+		{
+			$sToolkitMenu = $this->GetToolkitMenu($oPage, $aExtraParams);
+		}
+		$sDataTable = $this->GetHTMLTable($oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+		$sConfigDlg = $this->GetTableConfigDlg($oPage, $aColumns, $bViewLink, $iDefaultPageSize);
+		
+		$sHtml = "<table id=\"datatable_{$this->iListId}\" class=\"datatable\">";
+		$sHtml .= "<tr><td>";
+		$sHtml .= "<table style=\"width:100%;\">";
+		$sHtml .= "<tr><td class=\"pagination_container\">$sObjectsCount</td><td class=\"menucontainer\">$sToolkitMenu $sActionsMenu</td></tr>";
+		$sHtml .= "<tr>$sPager</tr>";
+		$sHtml .= "</table>";
+		$sHtml .= "</td></tr>";
+		$sHtml .= "<tr><td class=\"datacontents\">$sDataTable</td></tr>";
+		$sHtml .= "</table>\n";
+		$oPage->add_at_the_end($sConfigDlg);
+
+		$aExtraParams['show_obsolete_data'] = $this->bShowObsoleteData;
+
+		$aOptions = array(
+			'sPersistentId' => '',
+			'sFilter' => $this->oSet->GetFilter()->serialize(),
+			'oColumns' => $aColumns,
+			'sSelectMode' => $sSelectMode,
+			'sViewLink' => ($bViewLink ? 'true' : 'false'),
+			'iNbObjects' => $this->iNbObjects,
+			'iDefaultPageSize' => $iDefaultPageSize,
+			'iPageSize' =>  $iPageSize,
+			'iPageIndex' =>  $iPageIndex,
+			'oClassAliases' => $this->aClassAliases,
+			'sTableId' => $this->sTableId,
+			'oExtraParams' => $aExtraParams,
+			'sRenderUrl' => utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php',
+			'oRenderParameters' => array('str' => ''), // Forces JSON to encode this as a object...
+			'oDefaultSettings' => array('str' => ''), // Forces JSON to encode this as a object...
+			'oLabels' => array('moveup' => Dict::S('UI:Button:MoveUp'), 'movedown' => Dict::S('UI:Button:MoveDown')),
+		);
+		if($this->oDefaultSettings != null)
+		{
+			$aOptions['oDefaultSettings'] = $this->GetAsHash($this->oDefaultSettings);
+		}
+		$sJSOptions = json_encode($aOptions);
+		$oPage->add_ready_script("$('#datatable_{$this->iListId}').datatable($sJSOptions);");
+
+		return $sHtml;
+	}
+	
+	/**
+	 * When refreshing the body of a paginated table, get the rows of the table (inside the TBODY)
+	 * return string The HTML rows to insert inside the <tbody> node
+	 */
+	public function GetAsHTMLTableRows(WebPage $oPage, $iPageSize, $aColumns, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		if ($iPageSize < 1)
+		{
+			$iPageSize = -1; // convention: no pagination
+		}
+		$aAttribs = $this->GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink);
+		$aValues = $this->GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+		
+		$sHtml = '';
+		foreach($aValues as $aRow)
+		{
+			$sHtml .= $oPage->GetTableRow($aRow, $aAttribs);
+		}
+		return $sHtml;
+	}
+	
+	protected function GetObjectCount(WebPage $oPage, $sSelectMode)
+	{
+		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
+		{
+			$sHtml = '<div class="pagination_objcount">'.Dict::Format('UI:Pagination:HeaderSelection', '<span id="total">'.$this->iNbObjects.'</span>', '<span class="selectedCount">0</span>').'</div>';
+		}
+		else
+		{
+			$sHtml = '<div class="pagination_objcount">'.Dict::Format('UI:Pagination:HeaderNoSelection', '<span id="total">'.$this->iNbObjects.'</span>').'</div>';
+		}
+		return $sHtml;		
+	}
+	protected function GetPager(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex)
+	{
+		$sHtml = '';
+		if ($iPageSize < 1) // Display all
+		{
+			$sPagerStyle = 'style="display:none"'; // no limit: display the full table, so hide the "pager" UI
+												   // WARNING: mPDF does not take the "display" style into account
+												   // when applied to a <td> or a <table> tag, so make sure you apply this to a div
+		}
+		else
+		{
+			$sPagerStyle = '';
+		}
+		
+		$sCombo = '<select class="pagesize">';
+		if($iPageSize < 1)
+		{
+			$sCombo .= "<option selected=\"selected\" value=\"-1\">".Dict::S('UI:Pagination:All')."</option>";
+		}
+		else
+		{
+			for($iPage = 1; $iPage < 5; $iPage++)
+			{
+				$iNbItems = $iPage * $iDefaultPageSize;
+				$sSelected = ($iNbItems == $iPageSize) ? 'selected="selected"' : '';
+				$sCombo .= "<option  $sSelected value=\"$iNbItems\">$iNbItems</option>";
+			}
+			$sCombo .= "<option value=\"-1\">".Dict::S('UI:Pagination:All')."</option>";
+		}
+
+		$sCombo .= '</select>';
+		
+		$sPages = Dict::S('UI:Pagination:PagesLabel');
+		$sPageSizeCombo = Dict::Format('UI:Pagination:PageSize', $sCombo);
+		
+		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
+		if ($iNbPages == 1)
+		{
+			// No need to display the pager
+			$sPagerStyle = 'style="display:none"';
+		}
+		$aPagesToDisplay = array();
+		for($idx = 0; $idx <= min(4, $iNbPages-1); $idx++)
+		{
+			if ($idx == 0)
+			{
+				$aPagesToDisplay[$idx] = '<span page="0" class="curr_page">1</span>';
+			}
+			else
+			{
+				$aPagesToDisplay[$idx] = "<span id=\"gotopage_$idx\" class=\"gotopage\" page=\"$idx\">".(1+$idx)."</span>";
+			}
+		}
+		$iLastPageIdx = $iNbPages - 1;
+		if (!isset($aPagesToDisplay[$iLastPageIdx]))
+		{
+			unset($aPagesToDisplay[$idx - 1]); // remove the last page added to make room for the very last page
+			$aPagesToDisplay[$iLastPageIdx] = "<span id=\"gotopage_$iLastPageIdx\" class=\"gotopage\" page=\"$iLastPageIdx\">... $iNbPages</span>";
+		}
+		$sPagesLinks = implode('', $aPagesToDisplay);
+		$sPagesList = '['.implode(',', array_keys($aPagesToDisplay)).']';
+
+		$sSelectionMode = ($iNbPages == 1) ? '' : 'positive';
+		$sHtml =
+<<<EOF
+		<td colspan="2">
+		<div $sPagerStyle>
+		<table id="pager{$this->iListId}" class="pager"><tr>
+		<td>$sPages</td>
+		<td><img src="../images/first.png" class="first"/></td>
+		<td><img src="../images/prev.png" class="prev"/></td>
+		<td><span id="index">$sPagesLinks</span></td>
+		<td><img src="../images/next.png" class="next"/></td>
+		<td><img src="../images/last.png" class="last"/></td>
+		<td>$sPageSizeCombo</td>
+		<td><span id="loading">&nbsp;</span><input type="hidden" name="selectionMode" value="$sSelectionMode"></input>
+		</td>
+		</tr>
+		</table>
+		</div>
+		</td>
+EOF;
+		return $sHtml;
+	}
+	
+	protected function GetActionsMenu(WebPage $oPage, $aExtraParams)
+	{
+		$oMenuBlock = new MenuBlock($this->oSet->GetFilter(), 'list');
+		
+		$sHtml = $oMenuBlock->GetRenderContent($oPage, $aExtraParams, $this->iListId);
+		return $sHtml;
+	}
+	
+	protected function GetToolkitMenu(WebPage $oPage, $aExtraParams)
+	{
+		if (!$oPage->IsPrintableVersion())
+		{
+			$sMenuTitle = Dict::S('UI:ConfigureThisList');
+			$sHtml = '<div class="itop_popup toolkit_menu" id="tk_'.$this->iListId.'"><ul><li><img src="../images/toolkit_menu.png?t='.utils::GetCacheBusterTimestamp().'"><ul>';
+	
+			$oMenuItem1 = new JSPopupMenuItem('iTop::ConfigureList', $sMenuTitle, "$('#datatable_dlg_".$this->iListId."').dialog('open');");
+			$aActions = array(
+				$oMenuItem1->GetUID() => $oMenuItem1->GetMenuItem(),
+			);
+			$this->oSet->Rewind();
+			utils::GetPopupMenuItems($oPage, iPopupMenuExtension::MENU_OBJLIST_TOOLKIT, $this->oSet, $aActions, $this->sTableId, $this->iListId);
+			$this->oSet->Rewind();
+			$sHtml .= $oPage->RenderPopupMenuItems($aActions);
+		}
+		else
+		{
+			$sHtml = '';
+		}
+		return $sHtml;
+	}
+	
+	protected function GetTableConfigDlg(WebPage $oPage, $aColumns, $bViewLink, $iDefaultPageSize)
+	{
+		$sHtml = "<div id=\"datatable_dlg_{$this->iListId}\" style=\"display: none;\">";
+		$sHtml .= "<form onsubmit=\"return false\">";
+		$sChecked = ($this->bUseCustomSettings) ? '' : 'checked';
+		$sHtml .= "<p><input id=\"dtbl_dlg_settings_{$this->iListId}\" type=\"radio\" name=\"settings\" $sChecked value=\"defaults\"><label for=\"dtbl_dlg_settings_{$this->iListId}\">&nbsp;".Dict::S('UI:UseDefaultSettings').'</label></p>';
+		$sHtml .= "<fieldset>";
+		$sChecked = ($this->bUseCustomSettings) ? 'checked':  '';
+		$sHtml .= "<legend class=\"transparent\"><input id=\"dtbl_dlg_specific_{$this->iListId}\" type=\"radio\" class=\"specific_settings\" name=\"settings\" $sChecked value=\"specific\"><label for=\"dtbl_dlg_specific_{$this->iListId}\">&nbsp;".Dict::S('UI:UseSpecificSettings')."</label></legend>";
+		$sHtml .= Dict::S('UI:ColumnsAndSortOrder').'<br/><ul class="sortable_field_list" id="sfl_'.$this->iListId.'"></ul>';
+		
+		$sHtml .= '<p>'.Dict::Format('UI:Display_X_ItemsPerPage', '<input type="text" size="4" name="page_size" value="'.$iDefaultPageSize.'">').'</p>';
+		$sHtml .= "</fieldset>";
+		$sHtml .= "<fieldset>";
+		$sSaveChecked = ($this->sTableId != null) ? 'checked' : '';
+		$sCustomDisabled = ($this->sTableId == null) ? 'disabled="disabled" stay-disabled="true" ' : '';
+		$sCustomChecked = ($this->sTableId != null) ? 'checked' : '';
+		$sGenericChecked = ($this->sTableId == null) ? 'checked' : '';
+		$sHtml .= "<legend class=\"transparent\"><input id=\"dtbl_dlg_save_{$this->iListId}\" type=\"checkbox\" $sSaveChecked name=\"save_settings\"><label for=\"dtbl_dlg_save_{$this->iListId}\">&nbsp;".Dict::S('UI:UseSavetheSettings')."</label></legend>";
+		$sHtml .= "<p><input id=\"dtbl_dlg_this_list_{$this->iListId}\" type=\"radio\" name=\"scope\" $sCustomChecked $sCustomDisabled value=\"this_list\"><label for=\"dtbl_dlg_this_list_{$this->iListId}\">&nbsp;".Dict::S('UI:OnlyForThisList').'</label>&nbsp;&nbsp;&nbsp;&nbsp;';
+		$sHtml .= "<input id=\"dtbl_dlg_all_{$this->iListId}\" type=\"radio\" name=\"scope\" $sGenericChecked value=\"defaults\"><label for=\"dtbl_dlg_all_{$this->iListId}\">&nbsp;".Dict::S('UI:ForAllLists').'</label></p>';
+		$sHtml .= "</fieldset>";
+		$sHtml .= '<table style="width:100%"><tr><td style="text-align:center;">';
+		$sHtml .= '<button type="button" onclick="$(\'#datatable_'.$this->iListId.'\').datatable(\'onDlgCancel\'); $(\'#datatable_dlg_'.$this->iListId.'\').dialog(\'close\')">'.Dict::S('UI:Button:Cancel').'</button>';
+		$sHtml .= '</td><td style="text-align:center;">';
+		$sHtml .= '<button type="submit" onclick="$(\'#datatable_'.$this->iListId.'\').datatable(\'onDlgOk\');$(\'#datatable_dlg_'.$this->iListId.'\').dialog(\'close\');">'.Dict::S('UI:Button:Ok').'</button>';
+		$sHtml .= '</td></tr></table>';
+		$sHtml .= "</form>";
+		$sHtml .= "</div>";
+		
+		$sDlgTitle = addslashes(Dict::S('UI:ListConfigurationTitle'));
+		$oPage->add_ready_script("$('#datatable_dlg_{$this->iListId}').dialog({autoOpen: false, title: '$sDlgTitle', width: 500, close: function() { $('#datatable_{$this->iListId}').datatable('onDlgCancel'); } });");
+
+		return $sHtml;
+	}
+	
+	public function GetAsHash($oSetting)
+	{
+		$aSettings = array('iDefaultPageSize' => $oSetting->iDefaultPageSize, 'oColumns' => $oSetting->aColumns);
+		return $aSettings;
+	}
+	
+	protected function GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink)
+	{
+		$aAttribs = array();
+		if ($sSelectMode == 'multiple')
+		{
+			$aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$this->iListId}:not(:disabled)', this.checked);\" class=\"checkAll\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
+		}
+		else if ($sSelectMode == 'single')
+		{
+			$aAttribs['form::select'] = array('label' => "", 'description' => '');
+		}
+
+		foreach($this->aClassAliases as $sAlias => $sClassName)
+		{
+			foreach($aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				if ($aData['checked'])
+				{
+					if ($sAttCode == '_key_')
+					{
+						$aAttribs['key_'.$sAlias] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
+					}
+					else
+					{
+						$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
+						$aAttribs[$sAttCode.'_'.$sAlias] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => $oAttDef->GetOrderByHint());
+					}
+				}
+			}
+		}
+		return $aAttribs;
+	}
+	
+	protected function GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
+	{
+		$bLocalize = true;
+		if (isset($aExtraParams['localize_values']))
+		{
+			$bLocalize = (bool) $aExtraParams['localize_values'];
+		}
+
+		$aValues = array();
+		$this->oSet->Seek(0);
+		$iMaxObjects = $iPageSize;
+		while (($aObjects = $this->oSet->FetchAssoc()) && ($iMaxObjects != 0))
+		{
+			$bFirstObject = true;
+			$aRow = array();
+			foreach($this->aClassAliases as $sAlias => $sClassName)
+			{
+				if (is_object($aObjects[$sAlias]))
+				{
+					$sHilightClass = $aObjects[$sAlias]->GetHilightClass();
+					if ($sHilightClass != '')
+					{
+						$aRow['@class'] = $sHilightClass;	
+					}
+					if ((($sSelectMode == 'single') || ($sSelectMode == 'multiple')) && $bFirstObject)
+					{
+						if (array_key_exists('selection_enabled', $aExtraParams) && isset($aExtraParams['selection_enabled'][$aObjects[$sAlias]->GetKey()]))
+						{
+							$sDisabled = ($aExtraParams['selection_enabled'][$aObjects[$sAlias]->GetKey()]) ? '' : ' disabled="disabled"';
+						}
+						else
+						{
+							$sDisabled = '';
+						}
+						if ($sSelectMode == 'single')
+						{
+							$aRow['form::select'] = "<input type=\"radio\" $sDisabled class=\"selectList{$this->iListId}\" name=\"selectObject\" value=\"".$aObjects[$sAlias]->GetKey()."\"></input>";
+						}
+						else
+						{
+							$aRow['form::select'] = "<input type=\"checkbox\" $sDisabled class=\"selectList{$this->iListId}\" name=\"selectObject[]\" value=\"".$aObjects[$sAlias]->GetKey()."\"></input>";
+						}
+					}
+					foreach($aColumns[$sAlias] as $sAttCode => $aData)
+					{
+						if ($aData['checked'])
+						{
+							if ($sAttCode == '_key_')
+							{
+								$aRow['key_'.$sAlias] = $aObjects[$sAlias]->GetHyperLink();
+							}
+							else
+							{
+								$aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode, $bLocalize);
+							}
+						}
+					}
+				}
+				else
+				{
+					foreach($aColumns[$sAlias] as $sAttCode => $aData)
+					{
+						if ($aData['checked'])
+						{
+							if ($sAttCode == '_key_')
+							{
+								$aRow['key_'.$sAlias] = '';
+							}
+							else
+							{
+								$aRow[$sAttCode.'_'.$sAlias] = '';
+							}
+						}
+					}
+				}
+				$bFirstObject = false;
+			}
+			$aValues[] = $aRow;
+			$iMaxObjects--;
+		}
+		return $aValues;
+	}
+	
+	public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
+	{
+		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
+		if ($iPageSize < 1)
+		{
+			$iPageSize = -1; // convention: no pagination
+		}
+		$aAttribs = $this->GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink);
+
+		$aValues = $this->GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+
+		$sHtml = '<table class="listContainer">';
+
+		foreach($this->oSet->GetFilter()->GetInternalParams() as $sName => $sValue)
+		{
+			$aExtraParams['query_params'][$sName] = $sValue;
+		}
+		$aExtraParams['show_obsolete_data'] = $this->bShowObsoleteData;
+
+		$sHtml .= "<tr><td>";
+		$sHtml .= $oPage->GetTable($aAttribs, $aValues);
+		$sHtml .= '</td></tr>';
+		$sHtml .= '</table>';
+		$iCount = $this->iNbObjects;
+
+		$aArgs = $this->oSet->GetArgs();
+		$sExtraParams = addslashes(str_replace('"', "'", json_encode(array_merge($aExtraParams, $aArgs)))); // JSON encode, change the style of the quotes and escape them
+		$sSelectModeJS = '';
+		$sHeaders = '';
+		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
+		{
+			$sSelectModeJS = $sSelectMode;
+			$sHeaders = 'headers: { 0: {sorter: false}},';
+		}
+		$sDisplayKey = ($bViewLink) ? 'true' : 'false';
+		// Protect against duplicate elements in the Zlist
+		$aUniqueOrderedList = array();
+		foreach($this->aClassAliases as $sAlias => $sClassName)
+		{
+			foreach($aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				if ($aData['checked'])
+				{
+					$aUniqueOrderedList[$sAttCode] = true;
+				}
+			}
+		}
+		$aUniqueOrderedList = array_keys($aUniqueOrderedList);
+		$sJSColumns = json_encode($aColumns);
+		$sJSClassAliases = json_encode($this->aClassAliases);
+		$sCssCount = isset($aExtraParams['cssCount']) ? ", cssCount: '{$aExtraParams['cssCount']}'" : '';
+		$this->oSet->ApplyParameters();
+		// Display the actual sort order of the table
+		$aRealSortOrder = $this->oSet->GetRealSortOrder();
+		$aDefaultSort = array();
+		$iColOffset = 0;
+		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
+		{
+			$iColOffset += 1;
+		}
+		if ($bViewLink)
+		{
+//			$iColOffset += 1;
+		}
+		foreach($aRealSortOrder as $sColCode => $bAscending)
+		{
+			$iPos = array_search($sColCode, $aUniqueOrderedList);
+			if ($iPos !== false)
+			{
+				$aDefaultSort[] = "[".($iColOffset+$iPos).",".($bAscending ? '0' : '1')."]";
+			}
+			else if (($iPos = array_search(preg_replace('/_friendlyname$/', '', $sColCode), $aUniqueOrderedList)) !== false)
+			{
+				// if sorted on the friendly name of an external key, then consider it sorted on the column that shows the links
+				$aDefaultSort[] = "[".($iColOffset+$iPos).",".($bAscending ? '0' : '1')."]";
+			}
+			else if($sColCode == 'friendlyname' && $bViewLink)
+			{
+				$aDefaultSort[] = "[".($iColOffset).",".($bAscending ? '0' : '1')."]";
+			}
+		}
+		$sFakeSortList = '';
+		if (count($aDefaultSort) > 0)
+		{
+			$sFakeSortList = '['.implode(',', $aDefaultSort).']';
+		}
+		$sOQL = addslashes($this->oSet->GetFilter()->serialize());
+		$oPage->add_ready_script(
+<<<EOF
+var oTable = $('#{$this->iListId} table.listResults');
+oTable.tableHover();
+oTable.tablesorter( { $sHeaders widgets: ['myZebra', 'truncatedList']} ).tablesorterPager({container: $('#pager{$this->iListId}'), totalRows:$iCount, size: $iPageSize, filter: '$sOQL', extra_params: '$sExtraParams', select_mode: '$sSelectModeJS', displayKey: $sDisplayKey, table_id: '{$this->iListId}', columns: $sJSColumns, class_aliases: $sJSClassAliases $sCssCount});
+EOF
+		);
+		if ($sFakeSortList != '')
+		{
+			$oPage->add_ready_script("oTable.trigger(\"fakesorton\", [$sFakeSortList]);");
+		}
+		return $sHtml;
+	}
+	
+	public function UpdatePager(WebPage $oPage, $iDefaultPageSize, $iStart)
+	{
+		$iPageSize = $iDefaultPageSize;
+		$iPageIndex = 0;
+		$sHtml = $this->GetPager($oPage, $iPageSize, $iDefaultPageSize, $iPageIndex);
+		$oPage->add_ready_script("$('#pager{$this->iListId}').html('".json_encode($sHtml)."');");
+		if ($iDefaultPageSize < 1)
+		{
+			$oPage->add_ready_script("$('#pager{$this->iListId}').parent().hide()");
+		}
+		else
+		{
+			$oPage->add_ready_script("$('#pager{$this->iListId}').parent().show()");
+		}
+	}
+}
+
+/**
+ * Simplified version of the data table with less "decoration" (and no paging)
+ * which is optimized for printing
+ */
+class PrintableDataTable extends DataTable
+{
+	public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		return $this->GetHTMLTable($oPage, $aColumns, $sSelectMode, -1, $bViewLink, $aExtraParams);
+	}
+	
+	public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
+	{
+		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
+		if ($iPageSize < 1)
+		{
+			$iPageSize = -1; // convention: no pagination
+		}
+		$aAttribs = $this->GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink);
+	
+		$aValues = $this->GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+	
+		$sHtml = $oPage->GetTable($aAttribs, $aValues);
+		
+		return $sHtml;
+	}
+}
+
+class DataTableSettings implements Serializable
+{
+	public $aClassAliases;
+	public $sTableId;
+	public $iDefaultPageSize;
+	public $aColumns;
+
+	
+	public function __construct($aClassAliases, $sTableId = null)
+	{
+		$this->aClassAliases = $aClassAliases;
+		$this->sTableId = $sTableId;
+		$this->iDefaultPageSize = 10;
+		$this->aColumns = array();
+	}
+	
+	protected function Init($iDefaultPageSize, $aSortOrder, $aColumns)
+	{
+		$this->iDefaultPageSize = $iDefaultPageSize;
+		$this->aColumns = $aColumns;
+		$this->FixVisibleColumns();
+	}
+	
+	public function serialize()
+	{
+		// Save only the 'visible' columns
+		$aColumns = array();
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			$aColumns[$sAlias] = array();
+			foreach($this->aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				unset($aData['label']); // Don't save the display name
+				unset($aData['alias']); // Don't save the alias (redundant)
+				unset($aData['code']); // Don't save the code (redundant)
+				if ($aData['checked'])
+				{
+					$aColumns[$sAlias][$sAttCode] = $aData;
+				}
+			}
+		}
+		return serialize(
+			array(
+				'iDefaultPageSize' => $this->iDefaultPageSize,
+				'aColumns' => $aColumns,		
+			)
+		);
+	}
+	
+	public function unserialize($sData)
+	{
+		$aData = unserialize($sData);
+		$this->iDefaultPageSize = $aData['iDefaultPageSize'];
+		$this->aColumns = $aData['aColumns'];
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			foreach($this->aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				$aFieldData = false;
+				if ($sAttCode == '_key_')
+				{
+					$aFieldData = $this->GetFieldData($sAlias, $sAttCode, null, true /* bChecked */, $aData['sort']);
+				}
+				else if (MetaModel::isValidAttCode($sClass, $sAttCode))
+				{
+					$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+					$aFieldData = $this->GetFieldData($sAlias, $sAttCode, $oAttDef, true /* bChecked */, $aData['sort']);
+				}
+
+				if ($aFieldData)
+				{
+					$this->aColumns[$sAlias][$sAttCode] = $aFieldData;
+				}
+				else
+				{
+					unset($this->aColumns[$sAlias][$sAttCode]);
+				}
+			}
+		}
+		$this->FixVisibleColumns();		
+	}
+	
+	static public function GetDataModelSettings($aClassAliases, $bViewLink, $aDefaultLists)
+	{
+		$oSettings = new DataTableSettings($aClassAliases);
+		// Retrieve the class specific settings for each class/alias based on the 'list' ZList
+		//TODO let the caller pass some other default settings (another Zlist, extre fields...)
+		$aColumns = array();
+		foreach($aClassAliases as $sAlias => $sClass)
+		{
+			if ($aDefaultLists == null)
+			{
+				$aList = cmdbAbstract::FlattenZList(MetaModel::GetZListItems($sClass, 'list'));
+			}
+			else
+			{
+				$aList = $aDefaultLists[$sAlias];
+			}
+			
+			$aSortOrder = MetaModel::GetOrderByDefault($sClass);
+			if ($bViewLink)
+			{
+				$sSort = 'none';
+				if(array_key_exists('friendlyname', $aSortOrder))
+				{
+					$sSort = $aSortOrder['friendlyname'] ? 'asc' : 'desc';
+				}
+				$sNormalizedFName = MetaModel::NormalizeFieldSpec($sClass, 'friendlyname');
+				if(array_key_exists($sNormalizedFName, $aSortOrder))
+				{
+					$sSort = $aSortOrder[$sNormalizedFName] ? 'asc' : 'desc';
+				}
+				
+				$aColumns[$sAlias]['_key_'] = $oSettings->GetFieldData($sAlias, '_key_', null, true /* bChecked */, $sSort);
+			}
+			foreach($aList as $sAttCode)
+			{
+				$sSort = 'none';
+				if(array_key_exists($sAttCode, $aSortOrder))
+				{
+					$sSort = $aSortOrder[$sAttCode] ? 'asc' : 'desc';
+				}
+				$oAttDef = Metamodel::GetAttributeDef($sClass, $sAttCode);
+				$aFieldData = $oSettings->GetFieldData($sAlias, $sAttCode, $oAttDef, true /* bChecked */, $sSort);
+				if ($aFieldData) $aColumns[$sAlias][$sAttCode] = $aFieldData;
+			}
+		}
+		$iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
+		$oSettings->Init($iDefaultPageSize, $aSortOrder, $aColumns);
+		return $oSettings;
+	}
+	
+	protected function FixVisibleColumns()
+	{
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			if (!isset($this->aColumns[$sAlias]))
+			{
+				continue;
+			}
+			foreach($this->aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				// Remove non-existent columns
+				// TODO: check if the existing ones are still valid (in case their type changed)
+				if (($sAttCode != '_key_') && (!MetaModel::IsValidAttCode($sClass, $sAttCode)))
+				{
+					unset($this->aColumns[$sAlias][$sAttCode]);
+				}
+			}
+			$aList = MetaModel::ListAttributeDefs($sClass);
+			
+			// Add the other (non visible ones), sorted in alphabetical order
+			$aTempData = array();
+			foreach($aList as $sAttCode => $oAttDef)
+			{
+				if ( (!array_key_exists($sAttCode, $this->aColumns[$sAlias])) && (!($oAttDef instanceof AttributeLinkedSet || $oAttDef instanceof AttributeDashboard)))
+				{
+					$aFieldData = $this->GetFieldData($sAlias, $sAttCode, $oAttDef, false /* bChecked */, 'none');
+					if ($aFieldData) $aTempData[$aFieldData['label']] = $aFieldData;
+				}
+			}
+			ksort($aTempData);
+			foreach($aTempData as $sLabel => $aFieldData)
+			{
+				$this->aColumns[$sAlias][$aFieldData['code']] = $aFieldData;
+			}
+		}		
+	}
+	
+	static public function GetTableSettings($aClassAliases, $sTableId = null, $bOnlyOnTable = false)
+	{
+		$pref = null;
+		$oSettings = new DataTableSettings($aClassAliases, $sTableId);
+
+		if ($sTableId != null)
+		{
+			// An identified table, let's fetch its own settings (if any)
+			$pref = appUserPreferences::GetPref($oSettings->GetPrefsKey($sTableId), null);
+		}
+		
+		if ($pref == null)
+		{
+			if (!$bOnlyOnTable)
+			{
+				// Try the global preferred values for this class / set of classes
+				$pref = appUserPreferences::GetPref($oSettings->GetPrefsKey(null), null);
+			}
+			if ($pref == null)
+			{
+				// no such settings, use the default values provided by the data model
+				return null;
+			}
+		}
+		$oSettings->unserialize($pref);
+		
+		return $oSettings;
+	}
+	
+	public function GetSortOrder()
+	{
+		$aSortOrder = array();
+		foreach($this->aColumns as $sAlias => $aColumns)
+		{
+			foreach($aColumns as $aColumn)
+			{
+				if ($aColumn['sort'] != 'none')
+				{
+					$sCode = ($aColumn['code'] == '_key_') ? 'friendlyname' : $aColumn['code'];
+					$aSortOrder[$sCode] = ($aColumn['sort']=='asc'); // true for ascending, false for descending
+				}
+			}
+			break; // TODO: For now the Set object supports only sorting on the first class of the set
+		}
+		return $aSortOrder;
+	}
+	
+	public function Save($sTargetTableId = null)
+	{
+		$sSaveId = is_null($sTargetTableId) ? $this->sTableId : $sTargetTableId;
+		if ($sSaveId == null) return false; // Cannot save, the table is not identified, use SaveAsDefault instead
+		
+		$sSettings = $this->serialize();
+		appUserPreferences::SetPref($this->GetPrefsKey($sSaveId), $sSettings);
+		return true;
+	}
+
+	public function SaveAsDefault()
+	{
+		$sSettings = $this->serialize();
+		appUserPreferences::SetPref($this->GetPrefsKey(null), $sSettings);
+		return true;
+	}
+	
+
+	/**
+	 * Clear the preferences for this particular table
+	 * @param $bResetAll boolean If true,the settings for all tables of the same class(es)/alias(es) are reset
+	 */
+	public function ResetToDefault($bResetAll)
+	{
+		if (($this->sTableId == null) && (!$bResetAll)) return false; // Cannot reset, the table is not identified, use force $bResetAll instead
+		if ($bResetAll)
+		{
+			// Turn the key into a suitable PCRE pattern
+			$sKey = $this->GetPrefsKey(null);
+			$sPattern = str_replace(array('|'), array('\\|'), $sKey); // escape the | character
+			$sPattern = '#^'.str_replace(array('*'), array('.*'), $sPattern).'$#'; // Don't use slash as the delimiter since it's used in our key to delimit aliases
+			appUserPreferences::UnsetPref($sPattern, true);
+		}
+		else
+		{
+			appUserPreferences::UnsetPref($this->GetPrefsKey($this->sTableId), false);
+		}
+		return true;
+	}
+	
+	protected function GetPrefsKey($sTableId = null)
+	{
+		if ($sTableId == null) $sTableId = '*';
+		$aKeys = array();
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			$aKeys[] = $sAlias.'-'.$sClass;
+		}
+		return implode('/', $aKeys).'|'.$sTableId;
+	}
+	
+	protected function GetFieldData($sAlias, $sAttCode, $oAttDef, $bChecked, $sSort)
+	{
+		$ret = false;
+		if ($sAttCode == '_key_')
+		{
+			$sLabel = Dict::Format('UI:ExtKey_AsLink', MetaModel::GetName($this->aClassAliases[$sAlias]));
+			$ret = array(
+				'label' => $sLabel,
+				'checked' => true,
+				'disabled' => true,
+				'alias' => $sAlias,
+				'code' => $sAttCode,
+				'sort' => $sSort,
+			);
+		}
+		else if (!$oAttDef->IsLinkSet())
+		{
+			$sLabel = $oAttDef->GetLabel();
+			if ($oAttDef->IsExternalKey())
+			{
+				$sLabel = Dict::Format('UI:ExtKey_AsLink', $oAttDef->GetLabel());
+			}
+			else if ($oAttDef->IsExternalField())
+			{
+				if ($oAttDef->IsFriendlyName())
+				{
+					$sLabel = Dict::Format('UI:ExtKey_AsFriendlyName', $oAttDef->GetLabel());
+				}
+				else
+				{
+					$oExtAttDef = $oAttDef->GetExtAttDef();
+					$sLabel = Dict::Format('UI:ExtField_AsRemoteField', $oAttDef->GetLabel(), $oExtAttDef->GetLabel());
+				}
+			}
+			elseif ($oAttDef instanceof AttributeFriendlyName)
+			{
+				$sLabel = Dict::Format('UI:ExtKey_AsFriendlyName', $oAttDef->GetLabel());
+			}
+			$ret = array(
+				'label' => $sLabel,
+				'checked' => $bChecked,
+				'disabled' => false,
+				'alias' => $sAlias,
+				'code' => $sAttCode,
+				'sort' => $sSort,
+			);
+		}
+		return $ret;		
+	}
+}

application/excelexporter.class.inc.php

@@ -0,0 +1,536 @@
+<?php
+require_once('xlsxwriter.class.php');
+
+class ExcelExporter
+{
+	protected $sToken;
+	protected $aStatistics;
+	protected $sState;
+	protected $fStartTime;
+	protected $oSearch;
+	protected $aObjectsIDs;
+	protected $aTableHeaders;
+	protected $aAuthorizedClasses;
+	protected $iChunkSize = 1000;
+	protected $iPosition;
+	protected $sOutputFilePath;
+	protected $bAdvancedMode;
+	
+	public function __construct($sToken = null)
+	{
+		$this->aStatistics = array(
+			'objects_count' => 0,
+			'total_duration' => 0,
+			'data_retrieval_duration' => 0,
+			'excel_build_duration' => 0,
+			'excel_write_duration' => 0,
+			'peak_memory_usage' => 0,		
+		);
+		$this->fStartTime = microtime(true);
+		$this->oSearch = null;
+		
+		$this->sState = 'new';
+		$this->aObjectsIDs = array();
+		$this->iPosition = 0;
+		$this->aAuthorizedClasses = null;
+		$this->aTableHeaders = null;
+		$this->sOutputFilePath = null;
+		$this->bAdvancedMode = false;
+		$this->CheckDataDir();
+		if ($sToken == null)
+		{
+			$this->sToken = $this->GetNewToken();
+		}
+		else
+		{
+			$this->sToken = $sToken;
+			$this->ReloadState();
+		}
+	}
+	
+	public function __destruct()
+	{
+		if (($this->sState != 'done') && ($this->sState != 'error') && ($this->sToken != null))
+		{
+			// Operation in progress, save the state
+			$this->SaveState();
+		}
+		else
+		{
+			// Operation completed, cleanup the temp files
+			@unlink($this->GetStateFile());
+			@unlink($this->GetDataFile());
+		}
+		self::CleanupOldFiles();	
+	}
+	
+	public function SetChunkSize($iChunkSize)
+	{
+		$this->iChunkSize = $iChunkSize;	
+	}
+	
+	public function SetOutputFilePath($sDestFilePath)
+	{
+		$this->sOutputFilePath = $sDestFilePath;
+	}
+	
+	public function SetAdvancedMode($bAdvanced)
+	{
+		$this->bAdvancedMode = $bAdvanced;
+	}
+	
+	public function SaveState()
+	{
+		$aState = array(
+			'state' => $this->sState,
+			'statistics' => $this->aStatistics,
+			'filter' => $this->oSearch->serialize(),
+			'position' => $this->iPosition,
+			'chunk_size' => $this->iChunkSize,
+			'object_ids' => $this->aObjectsIDs,
+			'output_file_path' => $this->sOutputFilePath,
+			'advanced_mode' => $this->bAdvancedMode,
+		);
+		
+		file_put_contents($this->GetStateFile(), json_encode($aState));
+		
+		return $this->sToken;
+	}
+	
+	public function ReloadState()
+	{
+		if ($this->sToken == null)
+		{
+			throw new Exception('ExcelExporter not initialized with a token, cannot reload state');
+		}
+		
+		if (!file_exists($this->GetStateFile()))
+		{
+			throw new Exception("ExcelExporter: missing status file '".$this->GetStateFile()."', cannot reload state.");
+		}
+		$sJson = file_get_contents($this->GetStateFile());
+		$aState = json_decode($sJson, true);
+		if ($aState === null)
+		{
+			throw new Exception("ExcelExporter:corrupted status file '".$this->GetStateFile()."', not a JSON, cannot reload state.");
+		}
+		
+		$this->sState = $aState['state'];
+		$this->aStatistics = $aState['statistics'];
+		$this->oSearch = DBObjectSearch::unserialize($aState['filter']);
+		$this->iPosition = $aState['position'];
+		$this->iChunkSize = $aState['chunk_size'];
+		$this->aObjectsIDs = $aState['object_ids'];
+		$this->sOutputFilePath  = $aState['output_file_path'];
+		$this->bAdvancedMode = $aState['advanced_mode'];
+	}
+	
+	public function SetObjectList($oSearch)
+	{
+		$this->oSearch = $oSearch;
+	}
+	
+	public function Run()
+	{
+		$sCode = 'error';
+		$iPercentage = 100;
+		$sMessage = Dict::Format('ExcelExporter:ErrorUnexpected_State', $this->sState);
+		$fTime = microtime(true);
+		
+		try
+		{
+			switch($this->sState)
+			{
+				case 'new':
+				$oIDSet = new DBObjectSet($this->oSearch);
+				$oIDSet->OptimizeColumnLoad(array('id'));
+				$this->aObjectsIDs = array();
+				while($oObj = $oIDSet->Fetch())
+				{
+					$this->aObjectsIDs[] = $oObj->GetKey();
+				}		
+				$sCode = 'retrieving-data';
+				$iPercentage = 5;
+				$sMessage = Dict::S('ExcelExporter:RetrievingData');
+				$this->iPosition = 0;
+				$this->aStatistics['objects_count'] = count($this->aObjectsIDs);
+				$this->aStatistics['data_retrieval_duration'] += microtime(true) - $fTime;
+				
+				// The first line of the file is the "headers" specifying the label and the type of each column
+				$this->GetFieldsList($oIDSet, $this->bAdvancedMode);
+				$sRow = json_encode($this->aTableHeaders);
+				$hFile = @fopen($this->GetDataFile(), 'ab');
+				if ($hFile === false)
+				{
+					throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.');
+				}
+				fwrite($hFile, $sRow."\n");
+				fclose($hFile);	
+				
+				// Next state
+				$this->sState = 'retrieving-data';
+				break;
+				
+				case 'retrieving-data':
+				$oCurrentSearch = clone $this->oSearch;
+				$aIDs = array_slice($this->aObjectsIDs, $this->iPosition, $this->iChunkSize);
+				
+				$oCurrentSearch->AddCondition('id', $aIDs, 'IN');
+				$hFile = @fopen($this->GetDataFile(), 'ab');
+				if ($hFile === false)
+				{
+					throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.');
+				}
+				$oSet = new DBObjectSet($oCurrentSearch);
+				$this->GetFieldsList($oSet, $this->bAdvancedMode);
+				while($aObjects = $oSet->FetchAssoc())
+				{
+					$aRow = array();
+					foreach($this->aAuthorizedClasses as $sAlias => $sClassName)
+					{
+						$oObj = $aObjects[$sAlias];
+						if ($this->bAdvancedMode)
+						{
+							$aRow[] = $oObj->GetKey();
+						}
+						foreach($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef)
+						{
+							$value = $oObj->Get($sAttCodeEx);
+							if ($value instanceOf ormCaseLog)
+							{
+								// Extract the case log as text and remove the "===" which make Excel think that the cell contains a formula the next time you edit it!
+								$sExcelVal = trim(preg_replace('/========== ([^=]+) ============/', '********** $1 ************', $value->GetText()));
+							}
+							else
+							{
+								$sExcelVal =  $oAttDef->GetEditValue($value, $oObj);					
+							}
+							$aRow[] = $sExcelVal;				
+						}
+					}
+					$sRow = json_encode($aRow);
+					fwrite($hFile, $sRow."\n");
+				}
+				fclose($hFile);
+				
+				if (($this->iPosition + $this->iChunkSize) > count($this->aObjectsIDs))
+				{
+					// Next state
+					$this->sState = 'building-excel';
+					$sCode = 'building-excel';
+					$iPercentage = 80;
+					$sMessage = Dict::S('ExcelExporter:BuildingExcelFile');
+				}
+				else
+				{
+					$sCode = 'retrieving-data';
+					$this->iPosition += $this->iChunkSize;
+					$iPercentage = 5 + round(75 * ($this->iPosition / count($this->aObjectsIDs)));
+					$sMessage = Dict::S('ExcelExporter:RetrievingData');			
+				}
+				break;
+				
+				case 'building-excel':
+				$hFile = @fopen($this->GetDataFile(), 'rb');
+				if ($hFile === false)
+				{
+					throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for reading.');
+				}
+				$sHeaders = fgets($hFile);
+				$aHeaders = json_decode($sHeaders, true);
+				
+				$aData = array();
+				while($sLine = fgets($hFile))
+				{
+					$aRow = json_decode($sLine);
+					$aData[] = $aRow;
+				}
+				fclose($hFile);
+				@unlink($this->GetDataFile());
+					
+				$fStartExcel = microtime(true);
+				$writer = new XLSXWriter();
+				$writer->setAuthor(UserRights::GetUserFriendlyName());
+				$writer->writeSheet($aData,'Sheet1', $aHeaders);
+				$fExcelTime = microtime(true) - $fStartExcel;
+				$this->aStatistics['excel_build_duration'] = $fExcelTime;
+				
+				$fTime = microtime(true);
+				$writer->writeToFile($this->GetExcelFilePath());
+				$fExcelSaveTime = microtime(true) - $fTime;
+				$this->aStatistics['excel_write_duration'] = $fExcelSaveTime;
+				
+				// Next state
+				$this->sState = 'done';
+				$sCode = 'done';
+				$iPercentage = 100;
+				$sMessage = Dict::S('ExcelExporter:Done');
+				break;
+				
+				case 'done':
+				$this->sState = 'done';
+				$sCode = 'done';
+				$iPercentage = 100;
+				$sMessage = Dict::S('ExcelExporter:Done');
+				break;
+			}
+		}
+		catch(Exception $e)
+		{
+			$sCode = 'error';
+			$sMessage = $e->getMessage();
+		}
+		
+		$this->aStatistics['total_duration'] += microtime(true) - $fTime;
+		$peak_memory = memory_get_peak_usage(true);
+		if ($peak_memory > $this->aStatistics['peak_memory_usage'])
+		{
+			$this->aStatistics['peak_memory_usage'] = $peak_memory;
+		}
+		
+		return array(
+			'code' => $sCode,
+			'message' => $sMessage,
+			'percentage' => $iPercentage,
+		);
+	}
+	
+	public function GetExcelFilePath()
+	{
+		if ($this->sOutputFilePath == null)
+		{
+			return APPROOT.'data/bulk_export/'.$this->sToken.'.xlsx';
+		}
+		else
+		{
+			return $this->sOutputFilePath;
+		}
+	}
+	
+	public static function GetExcelFileFromToken($sToken)
+	{
+		return @file_get_contents(APPROOT.'data/bulk_export/'.$sToken.'.xlsx');
+	}
+	
+	public static function CleanupFromToken($sToken)
+	{
+		@unlink(APPROOT.'data/bulk_export/'.$sToken.'.status');
+		@unlink(APPROOT.'data/bulk_export/'.$sToken.'.data');
+		@unlink(APPROOT.'data/bulk_export/'.$sToken.'.xlsx');
+	}
+	
+	public function Cleanup()
+	{
+		self::CleanupFromToken($this->sToken);
+	}
+	
+	/**
+	 * Delete all files in the data/bulk_export directory which are older than 1 day
+	 * unless a different delay is configured.
+	 */
+	public static function CleanupOldFiles()
+	{
+		$aFiles = glob(APPROOT.'data/bulk_export/*.*');
+		$iDelay = MetaModel::GetConfig()->Get('xlsx_exporter_cleanup_old_files_delay');
+		
+		if($iDelay > 0)
+		{
+			foreach($aFiles as $sFile)
+			{
+				$iModificationTime = filemtime($sFile);
+				
+				if($iModificationTime < (time() - $iDelay))
+				{
+					// Temporary files older than one day are deleted
+					//echo "Supposed to delete: '".$sFile." (Unix Modification Time: $iModificationTime)'\n";
+					@unlink($sFile);
+				}
+			}
+		}
+	}
+	
+	public function DisplayStatistics(Page $oPage)
+	{
+		$aStats = array(
+				'Number of objects exported' => $this->aStatistics['objects_count'],
+				'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']),
+				'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']),
+				'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']),
+				'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']),
+				'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']),
+		);
+		
+		if ($oPage instanceof CLIPage)
+		{
+			$oPage->add($this->GetStatistics('text'));
+		}
+		else
+		{
+			$oPage->add($this->GetStatistics('html'));
+		}
+	}
+	
+	public function GetStatistics($sFormat = 'html')
+	{
+		$sStats = '';
+		$aStats = array(
+				'Number of objects exported' => $this->aStatistics['objects_count'],
+				'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']),
+				'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']),
+				'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']),
+				'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']),
+				'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']),
+		);
+		
+		if ($sFormat == 'text')
+		{
+			foreach($aStats as $sLabel => $sValue)
+			{
+				$sStats .= "+------------------------------+----------+\n";
+				$sStats .= sprintf("|%-30s|%10s|\n", $sLabel, $sValue);
+			}
+			$sStats .= "+------------------------------+----------+";
+		}
+		else
+		{
+			$sStats .= '<table><tbody>';
+			foreach($aStats as $sLabel => $sValue)
+			{
+				$sStats .= "<tr><td>$sLabel</td><td>$sValue</td></tr>";
+			}
+			$sStats .= '</tbody></table>';
+			
+		}
+		return $sStats;
+	}
+	
+	public static function HumanDisplay($iSize)
+	{
+		$aUnits = array('B','KB','MB','GB','TB','PB');
+		return @round($iSize/pow(1024,($i=floor(log($iSize,1024)))),2).' '.$aUnits[$i];
+	}
+	
+	protected function CheckDataDir()
+	{
+		if(!is_dir(APPROOT."data/bulk_export"))
+		{
+			@mkdir(APPROOT."data/bulk_export", 0777, true /* recursive */);
+			clearstatcache();
+		}
+		if (!is_writable(APPROOT."data/bulk_export"))
+		{
+			throw new Exception('Data directory "'.APPROOT.'data/bulk_export" could not be written.');
+		}
+	}
+	
+	protected function GetStateFile($sToken = null)
+	{
+		if ($sToken == null)
+		{
+			$sToken = $this->sToken;
+		}
+		return APPROOT."data/bulk_export/$sToken.status";
+	}
+	
+	protected function GetDataFile()
+	{
+		return APPROOT.'data/bulk_export/'.$this->sToken.'.data';
+	}
+	
+	protected function GetNewToken()
+	{
+		$iNum = rand();
+		do
+		{
+			$iNum++;
+			$sToken = sprintf("%08x", $iNum);
+			$sFileName = $this->GetStateFile($sToken);
+			$hFile = @fopen($sFileName, 'x');
+		}
+		while($hFile === false);
+		
+		fclose($hFile);
+		return $sToken;
+	}
+	
+	protected function GetFieldsList($oSet, $bFieldsAdvanced = false, $bLocalize = true, $aFields = null)
+	{
+		$this->aFieldsList = array();
+	
+		$oAppContext = new ApplicationContext();
+		$aClasses = $oSet->GetFilter()->GetSelectedClasses();
+		$this->aAuthorizedClasses = array();
+		foreach($aClasses as $sAlias => $sClassName)
+		{
+			if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) != UR_ALLOWED_NO)
+			{
+				$this->aAuthorizedClasses[$sAlias] = $sClassName;
+			}
+		}
+		$aAttribs = array();
+		$this->aTableHeaders = array();
+		foreach($this->aAuthorizedClasses as $sAlias => $sClassName)
+		{
+			$aList[$sAlias] = array();
+	
+			foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
+			{
+				if (is_null($aFields) || (count($aFields) == 0))
+				{
+					// Standard list of attributes (no link sets)
+					if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
+					{
+						$sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
+						
+						if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
+						{
+							if ($bFieldsAdvanced)
+							{
+								$aList[$sAlias][$sAttCodeEx] = $oAttDef;
+	
+								if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE))
+								{
+							  		$sRemoteClass = $oAttDef->GetTargetClass();
+									foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
+								  	{
+										$this->aFieldsList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
+								  	}
+								}
+							}
+						}
+						else
+						{
+							// Any other attribute
+							$this->aFieldsList[$sAlias][$sAttCodeEx] = $oAttDef;
+						}
+					}
+				}
+				else
+				{
+					// User defined list of attributes
+					if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
+					{
+						$this->aFieldsList[$sAlias][$sAttCode] = $oAttDef;
+					}
+				}
+			}
+			if ($bFieldsAdvanced)
+			{
+				$this->aTableHeaders['id'] = '0';
+			}
+			foreach($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef)
+			{
+				$sLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx, isset($aParams['showMandatoryFields'])) : $sAttCodeEx;
+				if($oAttDef instanceof AttributeDateTime)
+				{
+					$this->aTableHeaders[$sLabel] = 'datetime';
+				}
+				else
+				{
+					$this->aTableHeaders[$sLabel] = 'string';
+				}
+			}
+		}
+	}
+}
+

application/iotask.class.inc.php

@@ -1,68 +1,69 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Persistent class InputOutputTask
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
-
-/**
- * This class manages the input/output tasks
- * for synchronizing information with external data sources 
- */
-class InputOutputTask extends cmdbAbstractObject
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "application",
-			"key_type" => "autoincrement",
-			"name_attcode" => "name",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_iotask",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-			"display_template" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("category", array("allowed_values"=>new ValueSetEnum('Input, Ouput'), "sql"=>"category", "default_value"=>"Input", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("source_type", array("allowed_values"=>new ValueSetEnum('File, Database, Web Service'), "sql"=>"source_type", "default_value"=>"File", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("source_subtype", array("allowed_values"=>new ValueSetEnum('Oracle, MySQL, Postgress, MSSQL, SOAP, HTTP-Get, HTTP-Post, XML/RPC, CSV, XML, Excel'), "sql"=>"source_subtype", "default_value"=>"CSV", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("source_path", array("allowed_values"=>null, "sql"=>"source_path", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeClass("objects_class", array("class_category"=>"", "more_values"=>"", "sql"=>"objects_class", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("test_mode", array("allowed_values"=>new ValueSetEnum('Yes,No'), "sql"=>"test_mode", "default_value"=>'No', "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("verbose_mode", array("allowed_values"=>new ValueSetEnum('Yes,No'), "sql"=>"verbose_mode", "default_value" => 'No', "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("options", array("allowed_values"=>new ValueSetEnum('Full, Update Only, Creation Only'), "sql"=>"options", "default_value"=> 'Full', "is_null_allowed"=>true, "depends_on"=>array())));
-
-		// Display lists
-		MetaModel::Init_SetZListItems('details', array('name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype', 'source_path' , 'options', 'test_mode', 'verbose_mode')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('description', 'category', 'objects_class', 'source_type', 'source_subtype', 'options')); // Attributes to be displayed for a list
-		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('name', 'category', 'objects_class', 'source_type', 'source_subtype')); // Criteria of the std search form
-		MetaModel::Init_SetZListItems('advanced_search', array('name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype')); // Criteria of the advanced search form
-	}
-}
-?>
+<?php
+// Copyright (C) 2010-2012 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/>
+
+
+/**
+ * Persistent class InputOutputTask
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
+
+/**
+ * This class manages the input/output tasks
+ * for synchronizing information with external data sources 
+ */
+class InputOutputTask extends cmdbAbstractObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "application",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_iotask",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("category", array("allowed_values"=>new ValueSetEnum('Input, Ouput'), "sql"=>"category", "default_value"=>"Input", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("source_type", array("allowed_values"=>new ValueSetEnum('File, Database, Web Service'), "sql"=>"source_type", "default_value"=>"File", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("source_subtype", array("allowed_values"=>new ValueSetEnum('Oracle, MySQL, Postgress, MSSQL, SOAP, HTTP-Get, HTTP-Post, XML/RPC, CSV, XML, Excel'), "sql"=>"source_subtype", "default_value"=>"CSV", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("source_path", array("allowed_values"=>null, "sql"=>"source_path", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeClass("objects_class", array("class_category"=>"", "more_values"=>"", "sql"=>"objects_class", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("test_mode", array("allowed_values"=>new ValueSetEnum('Yes,No'), "sql"=>"test_mode", "default_value"=>'No', "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("verbose_mode", array("allowed_values"=>new ValueSetEnum('Yes,No'), "sql"=>"verbose_mode", "default_value" => 'No', "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("options", array("allowed_values"=>new ValueSetEnum('Full, Update Only, Creation Only'), "sql"=>"options", "default_value"=> 'Full', "is_null_allowed"=>true, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype', 'source_path' , 'options', 'test_mode', 'verbose_mode')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('description', 'category', 'objects_class', 'source_type', 'source_subtype', 'options')); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('name', 'category', 'objects_class', 'source_type', 'source_subtype')); // Criteria of the std search form
+		MetaModel::Init_SetZListItems('advanced_search', array('name', 'description', 'category', 'objects_class', 'source_type', 'source_subtype')); // Criteria of the advanced search form
+	}
+}
+?>

application/itopwizardwebpage.class.inc.php

@@ -1,56 +1,57 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class iTopWizardWebPage
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once('itopwebpage.class.inc.php');
-/**
- * Web page to display a wizard in the iTop framework
- */
-class iTopWizardWebPage extends iTopWebPage
-{
-	var $m_iCurrentStep;
-	var $m_aSteps;
-    public function __construct($sTitle, $currentOrganization, $iCurrentStep, $aSteps)
-    {
-    	parent::__construct($sTitle." - step $iCurrentStep of ".count($aSteps)." - ".$aSteps[$iCurrentStep - 1], $currentOrganization);
-		$this->m_iCurrentStep = $iCurrentStep;
-		$this->m_aSteps = $aSteps;
-    }
-    
-    public function output()
-    {
-    	$aSteps = array();
-    	$iIndex = 0;
-    	foreach($this->m_aSteps as $sStepTitle)
-    	{
-    		$iIndex++;
-    		$sStyle = ($iIndex == $this->m_iCurrentStep) ? 'wizActiveStep' : 'wizStep';
-    		$aSteps[] = "<div class=\"$sStyle\"><span>$sStepTitle</span></div>";
-    	}
-    	$sWizardHeader = "<div class=\"wizHeader\"><h1>".htmlentities($this->s_title, ENT_QUOTES, 'UTF-8')."</h1>\n".implode("<div class=\"wizSeparator\"><img align=\"bottom\" src=\"../images/wizArrow.gif\"></div>", $aSteps)."<br style=\"clear:both;\"/></div>\n";
-    	$this->s_content = "$sWizardHeader<div class=\"wizContainer\">".$this->s_content."</div>";
-    	parent::output();
-	}
-}
-?>
+<?php
+// Copyright (C) 2010-2012 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/>
+
+
+/**
+ * Class iTopWizardWebPage
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once('itopwebpage.class.inc.php');
+/**
+ * Web page to display a wizard in the iTop framework
+ */
+class iTopWizardWebPage extends iTopWebPage
+{
+	var $m_iCurrentStep;
+	var $m_aSteps;
+    public function __construct($sTitle, $currentOrganization, $iCurrentStep, $aSteps)
+    {
+    	parent::__construct($sTitle." - step $iCurrentStep of ".count($aSteps)." - ".$aSteps[$iCurrentStep - 1], $currentOrganization);
+		$this->m_iCurrentStep = $iCurrentStep;
+		$this->m_aSteps = $aSteps;
+    }
+    
+    public function output()
+    {
+    	$aSteps = array();
+    	$iIndex = 0;
+    	foreach($this->m_aSteps as $sStepTitle)
+    	{
+    		$iIndex++;
+    		$sStyle = ($iIndex == $this->m_iCurrentStep) ? 'wizActiveStep' : 'wizStep';
+    		$aSteps[] = "<div class=\"$sStyle\"><span>$sStepTitle</span></div>";
+    	}
+    	$sWizardHeader = "<div class=\"wizHeader\"><h1>".htmlentities($this->s_title, ENT_QUOTES, 'UTF-8')."</h1>\n".implode("<div class=\"wizSeparator\"><img align=\"bottom\" src=\"../images/wizArrow.gif\"></div>", $aSteps)."<br style=\"clear:both;\"/></div>\n";
+    	$this->s_content = "$sWizardHeader<div class=\"wizContainer\">".$this->s_content."</div>";
+    	parent::output();
+	}
+}
+?>

application/newsroomprovider.class.inc.php

@@ -0,0 +1,159 @@
+<?php
+// Copyright (C) 2010-2015 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/>
+
+/**
+ * A provider for messages to be displayed in the iTop Newsroom
+ */
+interface iNewsroomProvider
+{
+	/**
+	 * Inject the current configuration in the provider
+	 * @param Config $oConfig
+	 * @return void
+	 */
+	public function SetConfig(Config $oConfig);
+
+	/**
+	 * Tells if this provider is enabled for the given user
+	 * @param User $oUser The user for who to check if the provider is applicable.
+	 * return bool
+	 */
+	public function IsApplicable(User $oUser = null);
+	
+	/**
+	 * The human readable (localized) label for this provider
+	 * @return string
+	 */
+	public function GetLabel();
+	
+	/**
+	 * The URL to query (from the browser, using jsonp) to fetch all unread messages
+	 * @return string
+	 */
+	public function GetFetchURL();
+	
+	/**
+	 * The URL to navigate to in order to display all messages
+	 * @return string
+	 */
+	public function GetViewAllURL();
+	
+	/**
+	 * The URL to query(from the browser, using jsonp) to mark all unread messages as read
+	 * @return string
+	 */
+	public function GetMarkAllAsReadURL();
+	
+	/**
+	 * Return the URL to configure the preferences for this provider or null is there is nothing to configure
+	 * @return string|null
+	 */
+	public function GetPreferencesUrl();
+	
+	/**
+	 * Return an array key => value to be replaced in URL of the messages
+	 * Example: '%itop_root%' => utils::GetAbsoluteUrlAppRoot();
+	 * @return string[]
+	 */
+	public function GetPlaceholders();
+	
+	/**
+	 * The duration between to refreshes of the cache (in seconds)
+	 * @return int
+	 */
+	public function GetTTL();
+}
+
+/**
+ * Basic implementation of a Newsroom provider, to be overloaded by your own provider implementation
+ *
+ */
+abstract class NewsroomProviderBase implements iNewsroomProvider
+{
+	/**
+	 * The current configuration parameters
+	 * @var Config
+	 */
+	protected $oConfig;
+	
+	public function __construct()
+	{
+		$this->oConfig = null;
+	}
+	
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::SetConfig()
+	 */
+	public function SetConfig(Config $oConfig)
+	{
+		$this->oConfig = $oConfig;		
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetPreferencesUrl()
+	 */
+	public function GetPreferencesUrl()
+	{
+		return null; // No preferences
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetLabel()
+	 */
+	public abstract function GetLabel();
+	
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetFetchURL()
+	 */
+	public abstract function GetFetchURL();
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetMarkAllURL()
+	 */
+	public abstract function GetMarkAllAsReadURL();
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetViewAllURL()
+	 */
+	public abstract function GetViewAllURL();
+
+	public function IsApplicable(User $oUser = null)
+	{
+		return false;
+	}
+	
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetPlaceholders()
+	 */
+	public function GetPlaceholders()
+	{
+		return array(); // By default, empty set of placeholders
+	}
+	
+	public function GetTTL()
+	{
+		return 10*60; // Refresh every 10 minutes
+	}
+}

application/nicewebpage.class.inc.php

@@ -1,111 +1,259 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class NiceWebPage
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT."/application/webpage.class.inc.php");
-/**
- * Web page with some associated CSS and scripts (jquery) for a fancier display
- */
-class NiceWebPage extends WebPage
-{
-	var $m_aReadyScripts;
-	
-    public function __construct($s_title)
-    {
-        parent::__construct($s_title);
-		$this->m_aReadyScripts = array();
-		$this->add_linked_script("../js/jquery-1.4.2.min.js");
-		//$this->add_linked_script("../js/jquery.history_remote.pack.js");
-		$this->add_linked_stylesheet('../css/ui-lightness/jquery-ui-1.8.2.custom.css');
-		$this->add_linked_script('../js/jquery-ui-1.8.2.custom.min.js');
-		//$this->add_linked_script("../js/ui.resizable.js");
-//		$this->add_linked_script("../js/ui.tabs.js");
-		$this->add_linked_script("../js/hovertip.js");
-//		$this->add_linked_script("../js/jqModal.js");
-		$this->add_linked_stylesheet("../css/light-grey.css");
-//		$this->add_linked_stylesheet("../js/themes/light/light.tabs.css");
-		//$this->add_linked_stylesheet("../css/jquery.tabs-ie.css", "lte IE 7");
-//		$this->add_linked_stylesheet("../css/jqModal.css");
-		$this->add_ready_script('    window.setTimeout(hovertipInit, 1);');
-    }
-	
-	public function small_p($sText)
-	{
-		$this->add("<p style=\"font-size:smaller\">$sText</p>\n");
-	}	
-
-	// By Rom, used by CSVImport and Advanced search
-	public function MakeClassesSelect($sName, $sDefaultValue, $iWidthPx, $iActionCode = null)
-	{
-		// $aTopLevelClasses = array('bizService', 'bizContact', 'logInfra', 'bizDocument');
-		// These are classes wich root class is cmdbAbstractObject ! 
-		$this->add("<select id=\"select_$sName\" name=\"$sName\">");
-		$aValidClasses = array();
-		foreach(MetaModel::GetClasses('bizmodel') as $sClassName)
-		{
-			if (is_null($iActionCode) || UserRights::IsActionAllowed($sClassName, $iActionCode))
-			{
-				$sSelected = ($sClassName == $sDefaultValue) ? " SELECTED" : "";
-				$sDescription = MetaModel::GetClassDescription($sClassName);
-				$sDisplayName = MetaModel::GetName($sClassName);
-				$aValidClasses[$sDisplayName] = "<option style=\"width: ".$iWidthPx." px;\" title=\"$sDescription\" value=\"$sClassName\"$sSelected>$sDisplayName</option>";
-			}
-		}
-		ksort($aValidClasses);
-		$this->add(implode("\n", $aValidClasses));
-		
-		$this->add("</select>");
-	}
-
-	// By Rom, used by Advanced search
-	public function add_select($aChoices, $sName, $sDefaultValue, $iWidthPx)
-	{
-		$this->add("<select id=\"select_$sName\" name=\"$sName\">");
-		foreach($aChoices as $sKey => $sValue)
-		{
-			$sSelected = ($sKey == $sDefaultValue) ? " SELECTED" : "";
-			$this->add("<option style=\"width: ".$iWidthPx." px;\" value=\"".htmlspecialchars($sKey)."\"$sSelected>".htmlentities($sValue, ENT_QUOTES, 'UTF-8')."</option>");
-		}
-		$this->add("</select>");
-	}
-	
-	public function add_ready_script($sScript)
-	{
-		$this->m_aReadyScripts[] = $sScript;
-	}
-	
-		/**
-	 * Outputs (via some echo) the complete HTML page by assembling all its elements
-	 */
-    public function output()
-    {
-        if (count($this->m_aReadyScripts)>0)
-        {
-			$this->add_script("\$(document).ready(function() {\n".implode("\n", $this->m_aReadyScripts)."\n});");
-		}
-		parent::output();
-	}
-}
-
-?>
+<?php
+// Copyright (C) 2010-2016 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/>
+
+
+/**
+ * Class NiceWebPage
+ *
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/webpage.class.inc.php");
+/**
+ * Web page with some associated CSS and scripts (jquery) for a fancier display
+ */
+class NiceWebPage extends WebPage
+{
+	var $m_aReadyScripts;
+	var $m_sRootUrl;
+	
+    public function __construct($s_title, $bPrintable = false)
+    {
+        parent::__construct($s_title, $bPrintable);
+		$this->m_aReadyScripts = array();
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-3.3.1.min.js');
+		if(utils::IsDevelopmentEnvironment()) // Needed since many other plugins still rely on oldies like $.browser
+		{
+			$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-migrate-3.0.1.dev.js');
+		}
+		else
+		{
+			$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-migrate-3.0.1.prod.min.js');
+		}
+		$this->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/ui-lightness/jquery-ui-1.11.4.custom.css');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-ui-1.11.4.custom.min.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/utils.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/hovertip.js');
+		// table sorting
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.tablesorter.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.tablesorter.pager.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.tablehover.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/table-selectable-lines.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/field_sorter.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/datatable.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.positionBy.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.popupmenu.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/searchformforeignkeys.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/latinise/latinise.min.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_handler.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_handler_history.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_raw.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_string.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_external_field.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_numeric.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_enum.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_tag_set.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_external_key.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_hierarchical_key.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_date_abstract.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_date.js');
+	    $this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/search/search_form_criteria_date_time.js');
+
+	    $this->add_dict_entries('UI:Combo');
+
+	    $this->add_ready_script(
+<<< EOF
+	//add new widget called TruncatedList to properly display truncated lists when they are sorted
+	$.tablesorter.addWidget({ 
+		// give the widget a id 
+		id: "truncatedList", 
+		// format is called when the on init and when a sorting has finished 
+		format: function(table)
+		{ 
+			// Check if there is a "truncated" line
+			this.truncatedList = false;  
+			if ($("tr td.truncated",table).length > 0)
+			{
+				this.truncatedList = true;
+			}
+			if (this.truncatedList)
+			{
+				$("tr td",table).removeClass('truncated');
+				$("tr:last td",table).addClass('truncated');
+			}
+		} 
+	});
+	
+	$.tablesorter.addWidget({ 
+		// give the widget a id 
+		id: "myZebra", 
+		// format is called when the on init and when a sorting has finished 
+		format: function(table)
+		{
+			// Replace the 'red even' lines by 'red_even' since most browser do not support 2 classes selector in CSS, etc..
+			$("tbody tr:even",table).addClass('even');
+			$("tbody tr.red:even",table).removeClass('red').removeClass('even').addClass('red_even');
+			$("tbody tr.orange:even",table).removeClass('orange').removeClass('even').addClass('orange_even');
+			$("tbody tr.green:even",table).removeClass('green').removeClass('even').addClass('green_even');
+			// In case we sort again the table, we need to remove the added 'even' classes on odd rows
+			$("tbody tr:odd",table).removeClass('even');
+			$("tbody tr.red_even:odd",table).removeClass('even').removeClass('red_even').addClass('red');
+			$("tbody tr.orange_even:odd",table).removeClass('even').removeClass('orange_even').addClass('orange');
+			$("tbody tr.green_even:odd",table).removeClass('even').removeClass('green_even').addClass('green');
+		} 
+	});
+	$("table.listResults").tableHover(); // hover tables
+EOF
+		);
+		$this->add_saas("css/light-grey.scss");
+
+		$this->m_sRootUrl = $this->GetAbsoluteUrlAppRoot();
+     	$sAbsURLAppRoot = addslashes($this->m_sRootUrl);
+    	$sAbsURLModulesRoot = addslashes($this->GetAbsoluteUrlModulesRoot());
+    	$sEnvironment = addslashes(utils::GetCurrentEnvironment());
+
+		$sAppContext = addslashes($this->GetApplicationContext());
+
+		$this->add_script(
+<<<EOF
+function GetAbsoluteUrlAppRoot()
+{
+	return '$sAbsURLAppRoot';
+}
+
+function GetAbsoluteUrlModulesRoot()
+{
+	return '$sAbsURLModulesRoot';
+}
+
+function GetAbsoluteUrlModulePage(sModule, sPage, aArguments)
+{
+	// aArguments is optional, it default to an empty hash
+	aArguments = typeof aArguments !== 'undefined' ? aArguments : {};
+
+	var sUrl = '$sAbsURLAppRoot'+'pages/exec.php?exec_module='+sModule+'&exec_page='+sPage+'&exec_env='+'$sEnvironment';
+	for (var sArgName in aArguments)
+	{
+		if (aArguments.hasOwnProperty(sArgName))
+		{
+			sUrl = sUrl + '&'+sArgName+'='+aArguments[sArgname];
+		}
+	}
+	return sUrl;
+}
+
+function AddAppContext(sURL)
+{
+	var sContext = '$sAppContext';
+	if (sContext.length > 0)
+	{
+		if (sURL.indexOf('?') == -1)
+		{
+			return sURL+'?'+sContext;
+		}				
+		return sURL+'&'+sContext;
+	}
+	return sURL;
+}
+EOF
+		);
+	}
+	
+    public function SetRootUrl($sRootUrl)
+    {
+    	$this->m_sRootUrl = $sRootUrl;
+    }
+    
+	public function small_p($sText)
+	{
+		$this->add("<p style=\"font-size:smaller\">$sText</p>\n");
+	}
+
+	public function GetAbsoluteUrlAppRoot()
+	{
+		return utils::GetAbsoluteUrlAppRoot();
+	}
+
+	public function GetAbsoluteUrlModulesRoot()
+	{
+		return utils::GetAbsoluteUrlModulesRoot();
+	}
+
+	function GetApplicationContext()
+	{
+		$oAppContext = new ApplicationContext();
+		return $oAppContext->GetForLink();
+	}
+
+	// By Rom, used by CSVImport and Advanced search
+	public function MakeClassesSelect($sName, $sDefaultValue, $iWidthPx, $iActionCode = null)
+	{
+		// $aTopLevelClasses = array('bizService', 'bizContact', 'logInfra', 'bizDocument');
+		// These are classes wich root class is cmdbAbstractObject ! 
+		$this->add("<select id=\"select_$sName\" name=\"$sName\">");
+		$aValidClasses = array();
+		foreach(MetaModel::GetClasses('bizmodel') as $sClassName)
+		{
+			if (is_null($iActionCode) || UserRights::IsActionAllowed($sClassName, $iActionCode))
+			{
+				$sSelected = ($sClassName == $sDefaultValue) ? " SELECTED" : "";
+				$sDescription = MetaModel::GetClassDescription($sClassName);
+				$sDisplayName = MetaModel::GetName($sClassName);
+				$aValidClasses[$sDisplayName] = "<option style=\"width: ".$iWidthPx." px;\" title=\"$sDescription\" value=\"$sClassName\"$sSelected>$sDisplayName</option>";
+			}
+		}
+		ksort($aValidClasses);
+		$this->add(implode("\n", $aValidClasses));
+		
+		$this->add("</select>");
+	}
+
+	// By Rom, used by Advanced search
+	public function add_select($aChoices, $sName, $sDefaultValue, $iWidthPx)
+	{
+		$this->add("<select id=\"select_$sName\" name=\"$sName\">");
+		foreach($aChoices as $sKey => $sValue)
+		{
+			$sSelected = ($sKey == $sDefaultValue) ? " SELECTED" : "";
+			$this->add("<option style=\"width: ".$iWidthPx." px;\" value=\"".htmlspecialchars($sKey)."\"$sSelected>".htmlentities($sValue, ENT_QUOTES, 'UTF-8')."</option>");
+		}
+		$this->add("</select>");
+	}
+	
+	public function add_ready_script($sScript)
+	{
+		$this->m_aReadyScripts[] = $sScript;
+	}
+	
+		/**
+	 * Outputs (via some echo) the complete HTML page by assembling all its elements
+	 */
+    public function output()
+    {
+		//$this->set_base($this->m_sRootUrl.'pages/');
+        if (count($this->m_aReadyScripts)>0)
+        {
+			$this->add_script("\$(document).ready(function() {\n".implode("\n", $this->m_aReadyScripts)."\n});");
+		}
+		parent::output();
+	}
+}
+
+?>

application/pdfpage.class.inc.php

@@ -0,0 +1,194 @@
+<?php
+require_once(APPROOT.'lib/tcpdf/tcpdf.php');
+
+/**
+ * Custom class derived from TCPDF for providing custom headers and footers
+ * @author denis
+ *
+ */
+class iTopPDF extends TCPDF
+{
+	protected $sDocumentTitle;
+	
+	public function SetDocumentTitle($sDocumentTitle)
+	{
+		$this->sDocumentTitle = $sDocumentTitle;
+	}
+
+	/**
+	 * Builds the custom header. Called for each new page.
+	 * @see TCPDF::Header()
+	 */
+	public function Header()
+	{
+		// Title
+		// Set font
+		$this->SetFont('dejavusans', 'B', 10);
+		
+		$iPageNumberWidth = 25;
+		$aMargins = $this->getMargins();
+		
+		// Display the title (centered)
+		$this->SetXY($aMargins['left'] + $iPageNumberWidth, 0);
+		$this->MultiCell($this->getPageWidth() - $aMargins['left'] - $aMargins['right'] - 2*$iPageNumberWidth, 15, $this->sDocumentTitle, 0, 'C', false, 0 /* $ln */, '', '', true, 0, false, true, 15, 'M' /* $valign */);
+		$this->SetFont('dejavusans', '', 10);
+		
+		// Display the page number (right aligned)
+		// Warning: the 'R'ight alignment does not work when using placeholders like $this->getAliasNumPage() or $this->getAliasNbPages()
+		$this->MultiCell($iPageNumberWidth, 15, Dict::Format('Core:BulkExport:PDF:PageNumber' ,$this->page), 0, 'R', false, 0 /* $ln */, '', '', true, 0, false, true, 15, 'M' /* $valign */);
+		
+		// Branding logo
+		$sBrandingIcon = APPROOT.'images/itop-logo.png';
+		if (file_exists(MODULESROOT.'branding/main-logo.png'))
+		{
+			$sBrandingIcon = MODULESROOT.'branding/main-logo.png';
+		}
+		$this->Image($sBrandingIcon, $aMargins['left'], 5, 0, 10);
+	}
+
+	// Page footer
+	public function Footer()
+	{
+		// No footer
+	}
+}
+
+/**
+ * Special class of WebPage for printing into a PDF document
+ */
+class PDFPage extends WebPage
+{
+	/**
+	 * Instance of the TCPDF object for creating the PDF
+	 * @var TCPDF
+	 */
+	protected $oPdf;
+	
+	public function __construct($s_title, $sPageFormat = 'A4', $sPageOrientation = 'L')
+	{
+		parent::__construct($s_title);
+		define(K_PATH_FONTS, APPROOT.'lib/tcpdf/fonts');
+		$this->oPdf = new iTopPDF($sPageOrientation, 'mm', $sPageFormat, true, 'UTF-8', false);
+		
+		// set document information
+		$this->oPdf->SetCreator(PDF_CREATOR);
+		$this->oPdf->SetAuthor('iTop');
+		$this->oPdf->SetTitle($s_title);
+		$this->oPdf->SetDocumentTitle($s_title);
+		
+		$this->oPdf->setFontSubsetting(true);
+		
+		// Set font
+		// dejavusans is a UTF-8 Unicode font. Standard PDF fonts like helvetica or times new roman are NOT UTF-8
+		$this->oPdf->SetFont('dejavusans', '', 10, '', true);
+		
+		// set auto page breaks
+		$this->oPdf->SetAutoPageBreak(true, 15); // 15 mm break margin at the bottom
+		$this->oPdf->SetTopMargin(15);
+		
+		// Add a page, we're ready to start
+		$this->oPdf->AddPage();
+		
+		$this->SetContentDisposition('inline', $s_title.'.pdf');
+		$this->SetDefaultStyle();
+		
+	}
+	
+	/**
+	 * Sets a default style (suitable for printing) to be included each time $this->oPdf->writeHTML() is called
+	 */
+	protected function SetDefaultStyle()
+	{
+		$this->add_style(
+<<<EOF
+table {
+	padding: 2pt;
+}
+table.listResults td {
+	border: 0.5pt solid #000 ;
+}
+table.listResults th {
+	background-color: #eee;
+	border: 0.5pt solid #000 ;
+}
+a {
+	text-decoration: none;
+	color: #000;
+}
+table.section td {
+	vertical-align: middle;
+	font-size: 10pt;
+	background-color:#eee;
+}
+td.icon {
+	width: 30px;
+}
+EOF
+		);		
+	}
+	
+	/**
+	 * Get access to the underlying TCPDF object
+	 * @return TCPDF
+	 */
+	public function get_tcpdf()
+	{
+		$this->flush();
+		return $this->oPdf;
+	}
+	
+	/**
+	 * Writes the currently buffered HTML content into the PDF. This can be useful:
+	 * - to sync the flow in case you want to access the underlying TCPDF object for some specific/graphic output
+	 * - to process the HTML by smaller chunks instead of processing the whole page at once for performance reasons
+	 */
+	public function flush()
+	{
+		if (strlen($this->s_content) > 0)
+		{
+			$sHtml = '';
+			if (count($this->a_styles) > 0)
+			{
+				$sHtml .= "<style>\n".implode("\n", $this->a_styles)."\n</style>\n";
+			}
+			$sHtml .= $this->s_content;
+			$this->oPdf->writeHTML($sHtml); // The style(s) must be supplied each time we call writeHtml
+			$this->s_content = '';
+		}
+	}
+	
+	/**
+	 * Whether or not the page is a PDF page
+	 * @return boolean
+	 */
+	public function is_pdf()
+	{
+		return true;
+	}
+	
+	/**
+	 * Generates the PDF document and returns the PDF content as a string
+	 * @return string
+	 * @see WebPage::output()
+	 */
+	public function output()
+	{
+		$this->add_header('Content-type: application/x-pdf');
+    	if (!empty($this->sContentDisposition))
+    	{
+			$this->add_header('Content-Disposition: '.$this->sContentDisposition.'; filename="'.$this->sContentFileName.'"');
+    	}
+    	foreach($this->a_headers as $s_header)
+        {
+            header($s_header);
+        }
+        $this->flush();
+		echo $this->oPdf->Output($this->s_title.'.pdf', 'S');
+	}
+	
+	public function get_pdf()
+	{
+		$this->flush();
+		return $this->oPdf->Output($this->s_title.'.pdf', 'S');
+	}
+}

application/portaldispatcher.class.inc.php

@@ -0,0 +1,66 @@
+<?php
+class PortalDispatcher
+{
+	protected $sPortalid;
+	protected $aData;
+	
+	public function __construct($sPortalId)
+	{
+		$this->sPortalid = $sPortalId;
+		$this->aData = PortalDispatcherData::GetData($sPortalId);
+	}
+	
+	public function IsUserAllowed()
+	{
+		$bRet = true;
+		$aProfiles = UserRights::ListProfiles();
+		
+		foreach($this->aData['deny'] as $sDeniedProfile)
+		{
+			// If one denied profile is present, it's enough => return false
+			if (in_array($sDeniedProfile, $aProfiles))
+			{
+				return false;
+			}
+		}
+		// If there are some "allow" profiles, then by default the result is false
+		// since the user must have at least one of the profiles to be allowed
+		if (count($this->aData['allow']) > 0)
+		{
+			$bRet = false;
+		}
+		foreach($this->aData['allow'] as $sAllowProfile)
+		{
+			// If one "allow" profile is present, it's enough => return true
+			if (in_array($sAllowProfile, $aProfiles))
+			{
+				return true;
+			}
+		}
+		return $bRet;
+	}
+	
+	public function GetURL()
+	{
+		$aOverloads = MetaModel::GetConfig()->Get('portal_dispatch_urls');
+		if (array_key_exists($this->sPortalid, $aOverloads))
+		{
+			$sRet = $aOverloads[$this->sPortalid];
+		}
+		else
+		{
+			$sRet = utils::GetAbsoluteUrlAppRoot().$this->aData['url'];
+		}
+		return $sRet;
+	}
+	
+	public function GetLabel()
+	{
+		return Dict::S('portal:'.$this->sPortalid);
+	}
+	
+	public function GetRank()
+	{
+		return $this->aData['rank'];
+	}
+}

application/portalwebpage.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   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 General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class PortalWebPage
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/nicewebpage.class.inc.php");
@@ -49,9 +49,12 @@ class PortalWebPage extends NiceWebPage
 	 */
 	protected $m_sWelcomeMsg;
 	protected $m_aMenuButtons;
+	protected $m_oCtx;
+	
 	
     public function __construct($sTitle, $sAlternateStyleSheet = '')
     {
+    	$this->m_oCtx = new ContextTag('GUI:Portal');
     	$this->m_sWelcomeMsg = '';
     	$this->m_aMenuButtons = array();
         parent::__construct($sTitle);
@@ -59,9 +62,12 @@ class PortalWebPage extends NiceWebPage
 		$this->add_header("Cache-control: no-cache");
 		$this->add_linked_stylesheet("../css/jquery.treeview.css");
 		$this->add_linked_stylesheet("../css/jquery.autocomplete.css");
+		$this->add_linked_stylesheet("../css/jquery.multiselect.css");
 		$sAbsURLAppRoot = addslashes(utils::GetAbsoluteUrlAppRoot()); // Pass it to Javascript scripts
+		$sAbsURLModulesRoot = addslashes(utils::GetAbsoluteUrlModulesRoot()); // Pass it to Javascript scripts
 		$oAppContext = new ApplicationContext();
 		$sAppContext = addslashes($oAppContext->GetForLink());
+		$this->add_dict_entry('UI:FillAllMandatoryFields');
 		if ($sAlternateStyleSheet != '')
 		{
 			$this->add_linked_stylesheet("../portal/$sAlternateStyleSheet/portal.css");
@@ -85,6 +91,94 @@ class PortalWebPage extends NiceWebPage
 		$this->add_linked_script("../js/forms-json-utils.js");
 		$this->add_linked_script("../js/swfobject.js");
 		$this->add_linked_script("../js/jquery.qtip-1.0.min.js");
+		$this->add_linked_script('../js/jquery.multiselect.js');
+		$this->add_linked_script("../js/ajaxfileupload.js");
+		$this->add_linked_script("../js/ckeditor/ckeditor.js");
+		$this->add_linked_script("../js/ckeditor/adapters/jquery.js");
+
+		$this->add_linked_script("../js/jquery-ui-timepicker-addon.js");
+		$this->add_linked_script("../js/jquery-ui-timepicker-addon-i18n.min.js");
+		$this->add_linked_stylesheet("../css/jquery-ui-timepicker-addon.css");
+
+		$sJSDisconnectedMessage = json_encode(Dict::S('UI:DisconnectedDlgMessage'));
+		$sJSTitle = json_encode(Dict::S('UI:DisconnectedDlgTitle'));
+		$sJSLoginAgain = json_encode(Dict::S('UI:LoginAgain'));
+		$sJSStayOnThePage = json_encode(Dict::S('UI:StayOnThePage'));
+		$aDaysMin = array(Dict::S('DayOfWeek-Sunday-Min'), Dict::S('DayOfWeek-Monday-Min'), Dict::S('DayOfWeek-Tuesday-Min'), Dict::S('DayOfWeek-Wednesday-Min'),
+			Dict::S('DayOfWeek-Thursday-Min'), Dict::S('DayOfWeek-Friday-Min'), Dict::S('DayOfWeek-Saturday-Min'));
+		$aMonthsShort = array(Dict::S('Month-01-Short'), Dict::S('Month-02-Short'), Dict::S('Month-03-Short'), Dict::S('Month-04-Short'), Dict::S('Month-05-Short'), Dict::S('Month-06-Short'),
+			Dict::S('Month-07-Short'), Dict::S('Month-08-Short'), Dict::S('Month-09-Short'), Dict::S('Month-10-Short'), Dict::S('Month-11-Short'), Dict::S('Month-12-Short'));
+		$sTimeFormat = AttributeDateTime::GetFormat()->ToTimeFormat();
+		$oTimeFormat = new DateTimeFormat($sTimeFormat);
+		$sJSLangShort = json_encode(strtolower(substr(Dict::GetUserLanguage(), 0, 2)));
+
+		// Date picker options
+		$aPickerOptions = array(
+			'showOn' => 'button',
+			'buttonImage' => '../images/calendar.png',
+			'buttonImageOnly' => true,
+			'dateFormat' => AttributeDate::GetFormat()->ToDatePicker(),
+			'constrainInput' => false,
+			'changeMonth' => true,
+			'changeYear' => true,
+			'dayNamesMin' => $aDaysMin,
+			'monthNamesShort' => $aMonthsShort,
+			'firstDay' => (int) Dict::S('Calendar-FirstDayOfWeek'),
+		);
+		$sJSDatePickerOptions = json_encode($aPickerOptions);
+
+		// Time picker additional options
+		$aPickerOptions['showOn'] = '';
+		$aPickerOptions['buttonImage'] = null;
+		$aPickerOptions['timeFormat'] = $oTimeFormat->ToDatePicker();
+		$aPickerOptions['controlType'] = 'select';
+		$aPickerOptions['closeText'] = 	Dict::S('UI:Button:Ok');
+		$sJSDateTimePickerOptions = json_encode($aPickerOptions);
+		if ($sJSLangShort != '"en"')
+		{
+			// More options that cannot be passed via json_encode since they must be evaluated client-side
+			$aMoreJSOptions = ",
+				'timeText': $.timepicker.regional[$sJSLangShort].timeText,
+				'hourText': $.timepicker.regional[$sJSLangShort].hourText,
+				'minuteText': $.timepicker.regional[$sJSLangShort].minuteText,
+				'secondText': $.timepicker.regional[$sJSLangShort].secondText,
+				'currentText': $.timepicker.regional[$sJSLangShort].currentText
+			}";
+			$sJSDateTimePickerOptions = substr($sJSDateTimePickerOptions, 0, -1).$aMoreJSOptions;
+		}
+		$this->add_script(
+			<<< EOF
+				function PrepareWidgets()
+	{
+		// note: each action implemented here must be idempotent,
+		//       because this helper function might be called several times on a given page 
+	
+		$(".date-pick").datepicker($sJSDatePickerOptions);
+	
+		// Hack for the date and time picker addon issue on Chrome (see #1305)
+		// The workaround is to instantiate the widget on demand
+		// It relies on the same markup, thus reverting to the original implementation should be straightforward
+		$(".datetime-pick:not(.is-widget-ready)").each(function(){
+			var oInput = this;
+			$(oInput).addClass('is-widget-ready');
+			$('<img class="datetime-pick-button" src="../images/calendar.png">')
+				.insertAfter($(this))
+				.on('click', function(){
+					$(oInput)
+						.datetimepicker($sJSDateTimePickerOptions)
+						.datetimepicker('show')
+						.datetimepicker('option', 'onClose', function(dateText,inst){
+							$(oInput).datetimepicker('destroy');
+						})
+						.on('click keypress', function(){
+							$(oInput).datetimepicker('hide');
+						});
+				});
+		});
+	}
+EOF
+		);
+		
 		$this->add_ready_script(
 <<<EOF
 try
@@ -125,17 +219,29 @@ try
 	    } 
 	});
 		
-	$(".date-pick").datepicker({
-			showOn: 'button',
-			buttonImage: '../images/calendar.png',
-			buttonImageOnly: true,
-			dateFormat: 'yy-mm-dd',
-			constrainInput: false,
-			changeMonth: true,
-			changeYear: true
-		});
+	PrepareWidgets();
+
 	//$('.resizable').resizable(); // Make resizable everything that claims to be resizable !
-	$('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry').toggle(); });
+	$('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry,.caselog_entry_html').toggle(); });
+			
+	$(document).ajaxSend(function(event, jqxhr, options) {
+		jqxhr.setRequestHeader('X-Combodo-Ajax', 'true');
+	});
+	$(document).ajaxError(function(event, jqxhr, options) {
+		if (jqxhr.status == 401)
+		{
+			$('<div>'+$sJSDisconnectedMessage+'</div>').dialog({
+				modal:true,
+				title: $sJSTitle,
+				close: function() { $(this).remove(); },
+				minWidth: 400,
+				buttons: [
+				{ text: $sJSLoginAgain, click: function() { window.location.href= GetAbsoluteUrlAppRoot()+'pages/UI.php' } },
+				{ text: $sJSStayOnThePage, click: function() { $(this).dialog('close'); } }
+				]
+			});
+		}
+	});
 }
 catch(err)
 {
@@ -172,6 +278,11 @@ EOF
 		return '$sAbsURLAppRoot';
 	}
 	
+	function GetAbsoluteUrlModulesRoot()
+	{
+		return '$sAbsURLModulesRoot';
+	}
+
 	function AddAppContext(sURL)
 	{
 		var sContext = '$sAppContext';
@@ -201,7 +312,7 @@ EOF
 	{
 		var form = $('FORM');
 		form.unbind('submit'); // De-activate validation
-		window.location.href = '?operation=';
+		window.location.href = window.location.href.replace(/operation=[^&]*&?/, '');
 		return false;
 	}
 
@@ -210,10 +321,37 @@ EOF
 		var next_step = $('input[id=next_step]');
 		next_step.val(sStep);
 	}
+		
+	// For disabling the CKEditor at init time when the corresponding textarea is disabled !
+	CKEDITOR.plugins.add( 'disabler',
+	{
+		init : function( editor )
+		{
+			editor.on( 'instanceReady', function(e)
+			{
+				e.removeListener();
+				$('#'+ editor.name).trigger('update');
+			});
+		}
+		
+	});
 EOF
 );
-		
-	}
+
+		// For Wizard helper to process the ajax replies
+		$this->add('<div id="ajax_content"></div>');
+
+		// Customize the logo (unless a customer CSS has been defined)
+		if ($sAlternateStyleSheet == '')
+		{
+			if (file_exists(MODULESROOT.'branding/portal-logo.png'))
+			{
+				$sDisplayIcon = utils::GetAbsoluteUrlModulesRoot().'branding/portal-logo.png';
+				$this->add_style("div#portal #logo {background: url(\"$sDisplayIcon\") no-repeat scroll 0 0 transparent;}");
+			}
+		}
+
+}
 
 	public function SetCurrentTab($sTabLabel = '')
 	{
@@ -244,16 +382,31 @@ EOF
 	
 	public function output()
 	{
+		$sApplicationBanner = '';
+		if (!MetaModel::DBHasAccess(ACCESS_USER_WRITE))
+		{
+			$sReadOnly = Dict::S('UI:AccessRO-Users');
+			$sAdminMessage = trim(MetaModel::GetConfig()->Get('access_message'));
+			$sApplicationBanner .= '<div class="app-message">';
+			$sApplicationBanner .= '<img src="../images/locked.png" style="vertical-align:middle;">';
+			$sApplicationBanner .= '&nbsp;<b>'.$sReadOnly.'</b>';
+			if (strlen($sAdminMessage) > 0)
+			{
+				$sApplicationBanner .= '&nbsp;: '.$sAdminMessage.'';
+			}
+			$sApplicationBanner .= '</div>';
+		}
+
 		$sMenu = '';
 		if ($this->m_bEnableDisconnectButton)
 		{
-			$this->AddMenuButton('logoff', 'Portal:Disconnect', utils::GetAbsoluteUrlAppRoot().'pages/logoff.php'); // This menu is always present and is the last one
+			$this->AddMenuButton('logoff', 'Portal:Disconnect', utils::GetAbsoluteUrlAppRoot().'pages/logoff.php?operation=do_logoff'); // This menu is always present and is the last one
 		}
 		foreach($this->m_aMenuButtons as $aMenuItem)
 		{
 			$sMenu .= "<a class=\"button\" id=\"{$aMenuItem['id']}\" href=\"{$aMenuItem['hyperlink']}\"><span>".Dict::S($aMenuItem['label'])."</span></a>";
 		}
-		$this->s_content = '<div id="portal"><div id="welcome">'.$this->m_sWelcomeMsg.'</div><div id="banner"><div id="logo"></div><div id="menu">'.$sMenu.'</div></div><div id="content">'.$this->s_content.'</div></div>';
+		$this->s_content = '<div id="portal"><div id="welcome">'.$this->m_sWelcomeMsg.'</div><div id="banner"><div id="logo"></div><div id="menu">'.$sMenu.'</div></div>'.$sApplicationBanner.'<div id="content">'.$this->s_content.'</div></div>';
 		parent::output();
 	}
 
@@ -273,13 +426,9 @@ EOF
 			{
 				// Home-made and very limited display of an object set
 
-				//
-				//$oSet->Seek(0);// juste pour que le warning soit moins crado
-				//$oSet->Fetch();// juste pour que le warning soit moins crado
-				//
-
-				$this->add("<div id=\"listOf$sClass\">\n");
-				cmdbAbstractObject::DisplaySet($this, $oSet, array('currentId' => "listOf$sClass", 'menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
+				$sUniqueId = $sClass.$this->GetUniqueId();
+				$this->add("<div id=\"$sUniqueId\">\n"); // The id here MUST be the same as currentId, otherwise the pagination will be broken
+				cmdbAbstractObject::DisplaySet($this, $oSet, array('currentId' => $sUniqueId, 'menu' => false, 'toolkit_menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
 				$this->add("</div>\n");
 			}
 			else
@@ -375,7 +524,7 @@ EOF
 			}
 			$oObjSearch->AddCondition_ReferencedBy($oLinkSet->GetFilter(), $sRemoteAttCode);
 
-			$aExtraParams = array('menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList));
+			$aExtraParams = array('menu' => false, 'toolkit_menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList));
 			$oBlock = new DisplayBlock($oObjSearch, 'list', false);
 			$oBlock->Display($this, 1, $aExtraParams);
 		}
@@ -385,8 +534,7 @@ EOF
 		}
 	}
 
-
-	protected function DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, $sFieldName = null)
+	protected function DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, $sFieldName = null, $aFilterParams = array())
 	{
 		if (is_null($sFieldName))
 		{
@@ -417,7 +565,7 @@ EOF
 			{
 				throw new Exception("Attribute specification '$sAttSpec', '$sAttCode' should be either a link set or an external key");
 			}
-			$this->DisplaySearchField($sTargetClass, $sSubSpec, $aExtraParams, $sPrefix, $sFieldName);
+			$this->DisplaySearchField($sTargetClass, $sSubSpec, $aExtraParams, $sPrefix, $sFieldName, $aFilterParams);
 		}
 		else
 		{
@@ -431,7 +579,24 @@ EOF
 			if ($oAttDef->IsExternalKey())
 			{
 				$sTargetClass = $oAttDef->GetTargetClass();
-				$oAllowedValues = new DBObjectSet(new DBObjectSearch($sTargetClass));
+				$sFilterDefName = 'PORTAL_TICKETS_SEARCH_FILTER_'.$sAttSpec;
+				if (defined($sFilterDefName))
+				{
+					try
+					{
+						$oFitlerWithParams = DBObjectSearch::FromOQL(constant($sFilterDefName));
+						$sFilterOQL = $oFitlerWithParams->ToOQL(true, $aFilterParams);
+						$oAllowedValues = new DBObjectSet(DBObjectSearch::FromOQL($sFilterOQL), array(), $aFilterParams);
+					}
+					catch(OQLException $e)
+					{
+						throw new Exception("Incorrect filter '$sFilterDefName' for attribute '$sAttcode': ".$e->getMessage());
+					}
+				}
+				else
+				{
+					$oAllowedValues = new DBObjectSet(new DBObjectSearch($sTargetClass));
+				}
 		
 				$iFieldSize = $oAttDef->GetMaxSize();
 				$iMaxComboLength = $oAttDef->GetMaximumComboLength();
@@ -451,7 +616,8 @@ EOF
 				if (is_null($aAllowedValues))
 				{
 					// Any value is possible, display an input box
-					$this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;<input class=\"textSearch\" name=\"$sPrefix$sFieldName\" value=\"$sFilterValue\"/>\n");
+					$sSanitizedValue = htmlentities($sFilterValue, ENT_QUOTES, 'UTF-8');
+					$this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;<input class=\"textSearch\" name=\"$sPrefix$sFieldName\" value=\"$sSanitizedValue\"/>\n");
 				}
 				else
 				{
@@ -488,9 +654,30 @@ EOF
 		}
 	}
 	
+	/**
+	 * Get The organization of the current user (i.e. the organization of its contact)
+	 * @throws Exception
+	 */
+	function GetUserOrg()
+	{
+		$oOrg = null;
+		$iContactId = UserRights::GetContactId();
+		$oContact = MetaModel::GetObject('Contact', $iContactId, false); // false => Can fail
+		if (is_object($oContact))
+		{
+			$oOrg = MetaModel::GetObject('Organization', $oContact->Get('org_id'), false); // false => can fail
+		}
+		else
+		{
+			throw new Exception(Dict::S('Portal:ErrorNoContactForThisUser'));
+		}
+		return $oOrg;
+	}
 	
 	public function DisplaySearchForm($sClass, $aAttList, $aExtraParams, $sPrefix, $bClosed = true)
 	{
+		$oUserOrg = $this->GetUserOrg();
+		$aFilterParams = array('org_id' => $oUserOrg->GetKey(), 'contact_id' => UserRights::GetContactId());
 		$sCSSClass = ($bClosed) ? 'DrawerClosed' : '';
 		$this->add("<div id=\"ds_$sPrefix\" class=\"SearchDrawer $sCSSClass\">\n");
 		$this->add_ready_script(
@@ -507,13 +694,17 @@ EOF
 		foreach($aAttList as $sAttSpec)
 		{
 			//$oAppContext->Reset($sAttSpec); // Make sure the same parameter will not be passed twice
-			$this->DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix);
+			$this->DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, null, $aFilterParams);
 		}
 		$this->add("</p>\n");
 		$this->add("<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n");
 		foreach($aExtraParams as $sName => $sValue)
 		{
-			$this->add("<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n");
+			// Note: use DumpHiddenParams() to transmit arrays as hidden params
+			if (is_scalar($sValue))
+			{
+				$this->add("<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n");
+			}
 		}
 	//	$this->add($oAppContext->GetForForm());
 		$this->add("</form>\n");
@@ -592,7 +783,7 @@ EOF
 		{
 			$sFieldName = str_replace('->', PARAM_ARROW_SEP, $sAttSpec);
 			$value = utils::ReadPostedParam($sPrefix.$sFieldName, null, 'raw_data');
-			if (!is_null($value) && strlen($value) > 0)
+			if (!is_null($value) && (is_array($value) ? count($value)>0 : strlen($value)>0))
 			{
 				$oFilter->AddConditionAdvanced($sAttSpec, $value);
 				$iCountParams++;
@@ -616,7 +807,7 @@ EOF
 	 */
 	public function DoUpdateObjectFromPostedForm(DBObject $oObj, $aAttList = null)
 	{
-		$sTransactionId = utils::ReadPostedParam('transaction_id', '');
+		$sTransactionId = utils::ReadPostedParam('transaction_id', '', 'transaction_id');
 		if (!utils::IsTransactionValid($sTransactionId))
 		{
 			throw new TransactionException();
@@ -625,7 +816,7 @@ EOF
 		$sClass = get_class($oObj);
 
 		$sStimulus = trim(utils::ReadPostedParam('apply_stimulus', ''));
-		$sTargetState = '';
+		$aExpectedAttributes = array();
 		if (!empty($sStimulus))
 		{
 			// Compute the target state
@@ -635,10 +826,10 @@ EOF
 			{
 				throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
 			}
-			$sTargetState = $aTransitions[$sStimulus]['target_state'];
-		}
+			$aExpectedAttributes = $oObj->GetTransitionAttributes($sStimulus /*, current state*/);
+        }
 			
-		$oObj->UpdateObjectFromPostedForm('' /* form prefix */, $aAttList, $sTargetState);
+		$oObj->UpdateObjectFromPostedForm('' /* form prefix */, $aAttList, $aExpectedAttributes);
 
 		// Optional: apply a stimulus
 		//
@@ -650,26 +841,35 @@ EOF
 			}
 		}
 		
-		// Record the change
-		//
-		$oMyChange = MetaModel::NewObject("CMDBChange");
-		$oMyChange->Set("date", time());
-		$sUserString = CMDBChange::GetCurrentUserName();
-		$oMyChange->Set("userinfo", $sUserString);
-		$iChangeId = $oMyChange->DBInsert();
-		$oObj->DBUpdateTracked($oMyChange);
-		
-		// Trigger ?
-		//
-		$aClasses = MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL);
-		$sClassList = implode(", ", CMDBSource::Quote($aClasses));
-		$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnPortalUpdate AS t WHERE t.target_class IN ($sClassList)"));
-		while ($oTrigger = $oSet->Fetch())
+		if ($oObj->IsModified())
 		{
-			$oTrigger->DoActivate($oObj->ToArgs('this'));
+			// Record the change
+			//
+			$oObj->DBUpdate();
+			
+			// Trigger ?
+			//
+			$aClasses = MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL);
+			$sClassList = implode(", ", CMDBSource::Quote($aClasses));
+			$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnPortalUpdate AS t WHERE t.target_class IN ($sClassList)"));
+			while ($oTrigger = $oSet->Fetch())
+			{
+				$oTrigger->DoActivate($oObj->ToArgs('this'));
+			}
+	
+			$this->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName())."</h1>\n");
+		}
+		$bLockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
+		if ($bLockEnabled)
+		{
+			// Release the concurrent lock, if any
+			$sOwnershipToken = utils::ReadPostedParam('ownership_token', null, false, 'raw_data');
+			if ($sOwnershipToken !== null)
+			{
+				// We're done, let's release the lock
+				iTopOwnershipLock::ReleaseLock(get_class($oObj), $oObj->GetKey(), $sOwnershipToken);
+			}
 		}
-
-		$this->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName())."</h1>\n");
 	}
 
 	/**
@@ -711,7 +911,7 @@ EOF
 			}
 		}
 
-		$oObj = MetaModel::GetObject($sClass, $iId, false);
+		$oObj = MetaModel::GetObject($sClass, $iId, false);		
 		if (!is_object($oObj))
 		{
 			throw new Exception("Could not find the object $sClass/$iId");
@@ -726,7 +926,7 @@ EOF
 		$this->m_sWizardId = $sId;
 
 		// multipart... needed for file upload
-		$this->add("<form id=\"{$this->m_sWizardId}\" method=\"$sMethod\" enctype=\"multipart/form-data\">\n");
+		$this->add("<form id=\"{$this->m_sWizardId}\" method=\"$sMethod\" enctype=\"multipart/form-data\" onsubmit=\"window.bInSubmit = true;\">\n");
 
 		$aPreviousSteps = $this->GetWizardStepHistory();
 		if (utils::ReadParam('step_back', 0) == 1)
@@ -741,7 +941,7 @@ EOF
 		}
 
 		$sStepHistory = implode(',', $aPreviousSteps);
-		$this->add("<input type=\"hidden\" id=\"step_history\" name=\"step_history\" value=\"$sStepHistory\">");
+		$this->add("<input type=\"hidden\" id=\"step_history\" name=\"step_history\" value=\"".htmlentities($sStepHistory, ENT_QUOTES, 'UTF-8')."\">");
 
 		if (!is_null($sNextStep))
 		{		
@@ -752,7 +952,7 @@ EOF
 		$sTransactionId = utils::GetNewTransactionId();
 		$this->SetTransactionId($sTransactionId);
 		$this->add("<input type=\"hidden\" id=\"transaction_id\" name=\"transaction_id\" value=\"$sTransactionId\">\n");
-		$this->add_ready_script("$(window).unload(function() { OnUnload('$sTransactionId') } );\n");
+		$this->add_ready_script("$(window).on('unload', function() { OnUnload('$sTransactionId') } );\n");
 	}
 
 	public function WizardFormButtons($iButtonFlags)
@@ -764,7 +964,10 @@ EOF
 		}
 		if ($iButtonFlags & BUTTON_BACK)
 		{
-			$aButtons[] = "<input id=\"btn_back\" type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\"  onClick=\"GoBack('{$this->m_sWizardId}');\">";
+			if (utils::ReadParam('step_back', 1) != 1)
+			{
+				$aButtons[] = "<input id=\"btn_back\" type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\"  onClick=\"GoBack('{$this->m_sWizardId}');\">";
+			}
 		}
 		if ($iButtonFlags & BUTTON_NEXT)
 		{

application/query.class.inc.php

@@ -0,0 +1,178 @@
+<?php
+// Copyright (C) 2010-2015 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/>
+
+
+/**
+ * Persistent class Event and derived
+ * Application internal events
+ * There is also a file log 
+ *
+ * @copyright   Copyright (C) 2010-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class Query extends cmdbAbstractObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb,view_in_gui,application,grant_by_profile",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_query",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "realclass",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		//MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'description')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('name', 'description')); // Criteria of the std search form
+		MetaModel::Init_SetZListItems('default_search', array('name', 'description')); // Criteria of the default search form
+		// MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+}
+
+class QueryOQL extends Query
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb,view_in_gui,application,grant_by_profile",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_query_oql",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeOQL("oql", array("allowed_values"=>null, "sql"=>"oql", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("fields", array("allowed_values"=>null, "sql"=>"fields", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		// Rolled back to AttributeText until AttributeQueryAttCodeSet can manage fields order correctly
+		//MetaModel::Init_AddAttribute(new AttributeQueryAttCodeSet("fields", array("allowed_values"=>null,"max_items" => 1000, "query_field" => "oql", "sql"=>"fields", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array('oql'))));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'description', 'oql', 'fields')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('name', 'description', 'fields', 'oql')); // Criteria of the std search form
+	}
+
+	function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
+	{
+		$aFieldsMap = parent::DisplayBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
+		
+		if (!$bEditMode)
+		{
+			$sFields = trim($this->Get('fields'));
+			$bExportV1Recommended = ($sFields == '');
+			if ($bExportV1Recommended)
+			{
+				$oFieldAttDef = MetaModel::GetAttributeDef('QueryOQL', 'fields');
+				$oPage->add('<div class="message message_error" style="padding-left: 30px;"><div style="padding: 10px;">'.Dict::Format('UI:Query:UrlV1', $oFieldAttDef->GetLabel()).'</div></div>');
+				$sUrl = utils::GetAbsoluteUrlAppRoot().'webservices/export.php?format=spreadsheet&login_mode=basic&query='.$this->GetKey();
+			}
+			else 
+			{
+				$sUrl = utils::GetAbsoluteUrlAppRoot().'webservices/export-v2.php?format=spreadsheet&login_mode=basic&date_format='.urlencode((string)AttributeDateTime::GetFormat()).'&query='.$this->GetKey();
+			}
+			$sOql = $this->Get('oql');
+			$sMessage = null;
+			try
+			{
+				$oSearch = DBObjectSearch::FromOQL($sOql);
+				$aParameters = $oSearch->GetQueryParams();
+				foreach($aParameters as $sParam => $val)
+				{
+					$sUrl .= '&arg_'.$sParam.'=["'.$sParam.'"]';
+				}
+
+				$oPage->p(Dict::S('UI:Query:UrlForExcel').':<br/><textarea cols="80" rows="3" READONLY>'.$sUrl.'</textarea>');
+
+				if (count($aParameters) == 0)
+				{
+					$oBlock = new DisplayBlock($oSearch, 'list');
+					$aExtraParams = array(
+						//'menu' => $sShowMenu,
+						'table_id' => 'query_preview_'.$this->getKey(),
+					);
+					$sBlockId = 'block_query_preview_'.$this->GetKey(); // make a unique id (edition occuring in the same DOM)
+					$oBlock->Display($oPage, $sBlockId, $aExtraParams);
+				}
+			}
+			catch (OQLException $e)
+			{
+				$sMessage = '<div class="message message_error" style="padding-left: 30px;"><div style="padding: 10px;">'.Dict::Format('UI:RunQuery:Error', $e->getHtmlDesc()).'</div></div>';
+				$oPage->p($sMessage);
+			}
+		}
+		return $aFieldsMap;
+	}
+
+// Rolled back until 'fields' can be properly managed by AttributeQueryAttCodeSet
+//
+//	public function ComputeValues()
+//	{
+//		parent::ComputeValues();
+//
+//		// Remove unwanted attribute codes
+//		$aChanges = $this->ListChanges();
+//		if (isset($aChanges['fields']))
+//		{
+//			$oAttDef = MetaModel::GetAttributeDef(get_class($this), 'fields');
+//			$aArgs = array('this' => $this);
+//			$aAllowedValues = $oAttDef->GetAllowedValues($aArgs);
+//
+//			/** @var \ormSet $oValue */
+//			$oValue = $this->Get('fields');
+//			$aValues = $oValue->GetValues();
+//			$bChanged = false;
+//			foreach($aValues as $key => $sValue)
+//			{
+//				if (!isset($aAllowedValues[$sValue]))
+//				{
+//					unset($aValues[$key]);
+//					$bChanged = true;
+//				}
+//			}
+//			if ($bChanged)
+//			{
+//				$oValue->SetValues($aValues);
+//				$this->Set('fields', $oValue);
+//			}
+//		}
+//	}
+
+}
+
+?>

application/shortcut.class.inc.php

@@ -0,0 +1,338 @@
+<?php
+// Copyright (C) 2010-2016 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/>
+
+
+/**
+ * Persistent class Shortcut and derived
+ * Shortcuts of any kind
+ *
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class Shortcut extends DBObject implements iDisplay
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "gui,view_in_gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_shortcut",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "realclass",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		//MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>true, "on_target_delete"=>DEL_AUTO, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("context", array("allowed_values"=>null, "sql"=>"context", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'context')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('name')); // Attributes to be displayed for a list
+		// Search criteria
+//		MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
+//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+
+	abstract public function RenderContent(WebPage $oPage, $aExtraParams = array());
+
+	protected function OnInsert()
+	{
+		$this->Set('user_id', UserRights::GetUserId());
+	}
+
+	public function StartRenameDialog($oPage)
+	{
+		$oPage->add('<div id="shortcut_rename_dlg">');
+
+		$oForm = new DesignerForm();
+		$sDefault = $this->Get('name');
+		$oField = new DesignerTextField('name', Dict::S('Class:Shortcut/Attribute:name'), $sDefault);
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+		$oForm->Render($oPage);
+		$oPage->add('</div>');
+		
+		$sDialogTitle = Dict::S('UI:ShortcutRenameDlg:Title');
+		$sOkButtonLabel = Dict::S('UI:Button:Ok');
+		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
+		$iShortcut = $this->GetKey();
+		
+		$oPage->add_ready_script(
+<<<EOF
+function ShortcutRenameOK() 
+{
+	var oForm = $(this).find('form');
+	var sFormId = oForm.attr('id');
+	var oParams = null;
+	var aErrors = ValidateForm(sFormId, false);
+	if (aErrors.length == 0)
+	{
+		oParams = ReadFormParams(sFormId);
+	}
+	oParams.operation = 'shortcut_rename_go';
+	oParams.id = $iShortcut;
+	var me = $(this);
+	$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', oParams, function(data) {
+		me.dialog( "close" );
+		me.remove();
+		$('body').append(data);
+	});
+}
+
+$('#shortcut_rename_dlg form').bind('submit', function() { return false; });
+
+$('#shortcut_rename_dlg').dialog({
+	width: 400,
+	modal: true,
+	title: '$sDialogTitle',
+	buttons: [
+	{ text: "$sOkButtonLabel", click: ShortcutRenameOK},
+	{ text: "$sCancelButtonLabel", click: function() {
+		$(this).dialog( "close" ); $(this).remove();
+	} },
+	],
+	close: function() { $(this).remove(); }
+});
+EOF
+		);
+	}
+
+	// Minimual implementation of iDisplay: to make the shortcut be listable
+	//
+	public static function MapContextParam($sContextParam)
+	{
+		return (($sContextParam == 'menu') ? null : $sContextParam);
+	}
+
+	public function GetHilightClass()
+	{
+		return HILIGHT_CLASS_NONE;
+	}
+
+	public static function GetUIPage()
+	{
+		return '';
+	}
+
+	function DisplayDetails(WebPage $oPage, $bEditMode = false)
+	{
+	}
+
+	function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
+	{
+		return array();
+	}
+	// End of the minimal implementation of iDisplay
+}
+
+class ShortcutOQL extends Shortcut
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "gui,view_in_gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_shortcut_oql",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeOQL("oql", array("allowed_values"=>null, "sql"=>"oql", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("auto_reload", array("allowed_values"=>new ValueSetEnum('none,custom'), "sql"=>"auto_reload", "default_value"=>"none", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeInteger("auto_reload_sec", array("allowed_values"=>null, "sql"=>"auto_reload_sec", "default_value"=>60, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'context', 'oql')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('name')); // Attributes to be displayed for a list
+		// Search criteria
+//		MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
+//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+
+	public function RenderContent(WebPage $oPage, $aExtraParams = array())
+	{
+		$oPage->set_title($this->Get('name'));
+
+		switch($this->Get('auto_reload'))
+		{
+		case 'custom':
+			$iRate = (int)$this->Get('auto_reload_sec');
+			if ($iRate > 0)
+			{
+				// Must a string otherwise it can be evaluated to 'true' and defaults to "standard" refresh rate!
+				$aExtraParams['auto_reload'] = (string)$iRate;
+			}
+			break;
+
+		default:
+		case 'none':
+		}
+
+		$bSearchPane = true;
+		$bSearchOpen = true;
+		try
+		{
+			OQLMenuNode::RenderOQLSearch($this->Get('oql'), $this->Get('name'), 'shortcut_'.$this->GetKey(), $bSearchPane, $bSearchOpen, $oPage, $aExtraParams, true);
+		}
+		catch (Exception $e)
+		{
+			throw new Exception("The OQL shortcut '".$this->Get('name')."' (id: ".$this->GetKey().") could not be displayed: ".$e->getMessage());
+		}
+			
+	}
+
+	public function CloneTableSettings($sTableSettings)
+	{
+		$aTableSettings = json_decode($sTableSettings, true);
+
+		$oFilter = DBObjectSearch::FromOQL($this->Get('oql'));
+		$oCustomSettings = new DataTableSettings($oFilter->GetSelectedClasses());
+		$oCustomSettings->iDefaultPageSize = $aTableSettings['iPageSize'];
+		$oCustomSettings->aColumns = $aTableSettings['oColumns'];
+		$oCustomSettings->Save('shortcut_'.$this->GetKey());
+	}
+
+	public static function GetCreationForm($sOQL = null, $sTableSettings = null)
+	{
+		$oForm = new DesignerForm();
+
+		// Find a unique default name
+		// -> The class of the query + an index if necessary
+		if ($sOQL == null)
+		{
+			$sDefault = '';
+		}
+		else
+		{
+			$oBMSearch = new DBObjectSearch('Shortcut');
+			$oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
+			$oBMSet = new DBObjectSet($oBMSearch);
+			$aNames = $oBMSet->GetColumnAsArray('name');
+	 		$oSearch = DBObjectSearch::FromOQL($sOQL);
+			$sDefault = utils::MakeUniqueName($oSearch->GetClass(), $aNames);
+		}
+
+		$oField = new DesignerTextField('name', Dict::S('Class:Shortcut/Attribute:name'), $sDefault);
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+
+		/*
+		$oField = new DesignerComboField('auto_reload', Dict::S('Class:ShortcutOQL/Attribute:auto_reload'), 'none');
+		$oAttDef = MetaModel::GetAttributeDef(__class__, 'auto_reload');
+		$oField->SetAllowedValues($oAttDef->GetAllowedValues());
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+		*/
+		$oField = new DesignerBooleanField('auto_reload', Dict::S('Class:ShortcutOQL/Attribute:auto_reload'), false);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerIntegerField('auto_reload_sec', Dict::S('Class:ShortcutOQL/Attribute:auto_reload_sec'), MetaModel::GetConfig()->GetStandardReloadInterval());
+		$oField->SetBoundaries(MetaModel::GetConfig()->Get('min_reload_interval'), null); // no upper limit
+		$oField->SetMandatory(false);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerHiddenField('oql', '', $sOQL);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerHiddenField('table_settings', '', $sTableSettings);
+		$oForm->AddField($oField);
+
+		return $oForm;
+	}
+
+	public static function GetCreationDlgFromOQL($oPage, $sOQL, $sTableSettings)
+	{
+		$oPage->add('<div id="shortcut_creation_dlg">');
+
+		$oForm = self::GetCreationForm($sOQL, $sTableSettings);
+
+		$oForm->Render($oPage);
+		$oPage->add('</div>');
+		
+		$sDialogTitle = Dict::S('UI:ShortcutListDlg:Title');
+		$sOkButtonLabel = Dict::S('UI:Button:Ok');
+		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
+		
+		$oAppContext = new ApplicationContext();
+		$sContext = $oAppContext->GetForLink();
+
+		$sRateTitle = addslashes(Dict::Format('Class:ShortcutOQL/Attribute:auto_reload_sec/tip', MetaModel::GetConfig()->Get('min_reload_interval')));
+
+		$oPage->add_ready_script(
+<<<EOF
+
+// Note: the title gets deleted by the validation mechanism
+$("#attr_auto_reload_sec").tooltip({items: 'input', content: '$sRateTitle'});
+$("#attr_auto_reload_sec").prop('disabled', !$('#attr_auto_reload').is(':checked'));
+
+$('#attr_auto_reload').change( function(ev) {
+	$("#attr_auto_reload_sec").prop('disabled', !$(this).is(':checked'));
+} );
+
+function ShortcutCreationOK() 
+{
+	var oForm = $('#shortcut_creation_dlg form');
+	var sFormId = oForm.attr('id');
+	var oParams = null;
+	var aErrors = ValidateForm(sFormId, false);
+	if (aErrors.length == 0)
+	{
+		oParams = ReadFormParams(sFormId);
+	}
+	oParams.operation = 'shortcut_list_create';
+	var me = $('#shortcut_creation_dlg');
+	$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php?$sContext', oParams, function(data) {
+		me.dialog( "close" );
+		me.remove();
+		$('body').append(data);
+	});
+}
+
+$('#shortcut_creation_dlg form').bind('submit', function() { ShortcutCreationOK(); return false; });
+
+$('#shortcut_creation_dlg').dialog({
+	width: 400,
+	modal: true,
+	title: '$sDialogTitle',
+	buttons: [
+	{ text: "$sOkButtonLabel", click: ShortcutCreationOK },
+	{ text: "$sCancelButtonLabel", click: function() {
+		$(this).dialog( "close" ); $(this).remove();
+	} },
+	],
+	close: function() { $(this).remove(); }
+});
+EOF
+		);
+	}
+}
+
+?>

application/sqlblock.class.inc.php

@@ -1,430 +0,0 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * SqlBlock - display tables or charts, given an SQL query - use cautiously!
- *  
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-
-require_once(APPROOT.'/application/webpage.class.inc.php');
-require_once(APPROOT.'/application/utils.inc.php');
-
-require_once(APPROOT.'/pages/php-ofc-library/open-flash-chart.php');
-
-/**
- * Helper class to design optimized dashboards, based on an SQL query
- *  
- */
-class SqlBlock
-{
-	protected $m_sQuery;
-	protected $m_aColumns;
-	protected $m_sTitle;
-	protected $m_sType;
-	                            
-	public function __construct($sQuery, $aColumns, $sTitle, $sType)
-	{
-		$this->m_sQuery = $sQuery;
-		$this->m_aColumns = $aColumns;
-		$this->m_sTitle = $sTitle;
-		$this->m_sType = $sType;
-	}
-	
-	/**
-	 * Constructs a SqlBlock object from an XML template
-	/*
-	 *
-	 *		<sqlblock>
-	 *			<sql>SELECT date_format(start_date, '%d') AS Date, count(*) AS Count FROM ticket WHERE DATE_SUB(NOW(), INTERVAL 15 DAY) &lt; start_date AND finalclass = 'UserIssue' GROUP BY date_format(start_date, '%d')</sql>
-	 *			<type>table</type>
-	 *			<title>UserRequest:Overview-Title</title>
-	 *			<column>
-	 *				<name>Date</name>
-	 *				<label>UserRequest:Overview-Date</label>
-	 *				<drilldown></drilldown>
-	 *			</column>
-	 *			<column>
-	 *				<name>Count</name>
-	 *				<label>UserRequest:Overview-Count</label>
-	 *				<drilldown>SELECT UserIssue WHERE date_format(start_date, '%d') = :Date</drilldown>
-	 *			</column>
-	 *		</sqlblock>
-	 *
-	 * Tags
-	 * - sql: a (My)SQL query. Do not forget to use html entities (e.g. &lt; for <)
-	 * - type: table (default), bars or pie. If bars or pie is selected only the two first columns are taken into account.
-	 * - title: optional title, typed in clear or given as a dictionnary entry
-	 * - column: specification of a column (not displayed if omitted)
-	 * - column / name: name of the column in the SQL query (use aliases)
-	 * - column / label: label, typed in clear or given as a dictionnary entry
-	 * - column / drilldown: NOT IMPLEMENTED YET - OQL with parameters corresponding to column names (in the query)
-	 *
-	 * @param $sTemplate string The XML template
-	 * @return DisplayBlock The DisplayBlock object, or null if the template is invalid
-	 */
-	public static function FromTemplate($sTemplate)
-	{
-		$oXml = simplexml_load_string('<root>'.$sTemplate.'</root>', 'SimpleXMLElement', LIBXML_NOCDATA);
-		if (false)
-		{
-			// Debug
-			echo "<pre>\n";
-			print_r($oXml);
-			echo "</pre>\n";
-		}
-
-		if (isset($oXml->title))
-		{
-			$sTitle = (string)$oXml->title;
-		}
-		if (isset($oXml->type))
-		{
-			$sType = (string)$oXml->type;
-		}
-		else
-		{
-			$sType = 'table';
-		}
-		if (!isset($oXml->sql))
-		{
-			throw new Exception('Missing tag "sql" in sqlblock');
-		}
-		$sQuery = (string)$oXml->sql;
-
-		$aColumns = array();
-		if (isset($oXml->column))
-		{
-			foreach ($oXml->column AS $oColumnData)
-			{
-				if (!isset($oColumnData->name))
-				{
-					throw new Exception("Missing tag 'name' in sqlblock/column");
-				}
-				$sName = (string) $oColumnData->name;
-				if (strlen($sName) == 0)
-				{
-					throw new Exception("Empty tag 'name' in sqlblock/column");
-				}
-
-				$aColumns[$sName] = array();
-				if (isset($oColumnData->label))
-				{
-					$sLabel = (string)$oColumnData->label;
-					if (strlen($sLabel) > 0)
-					{
-						$aColumns[$sName]['label'] = Dict::S($sLabel);
-					}
-				}
-				if (isset($oColumnData->drilldown))
-				{
-					$sDrillDown = (string)$oColumnData->drilldown;
-					if (strlen($sDrillDown) > 0)
-					{
-						$aColumns[$sName]['drilldown'] = $sDrillDown;
-					}
-				}
-			}
-		}
-
-		return new SqlBlock($sQuery, $aColumns, $sTitle, $sType);		
-	}
-	
-	public function RenderContent(WebPage $oPage, $aExtraParams = array())
-	{
-		if (empty($aExtraParams['currentId']))
-		{
-			$sId = 'sqlblock_'.$oPage->GetUniqueId(); // Works only if the page is not an Ajax one !
-		}
-		else
-		{
-			$sId = $aExtraParams['currentId'];
-		}
-//		$oPage->add($this->GetRenderContent($oPage, $aExtraParams, $sId));
-
-		$res = CMDBSource::Query($this->m_sQuery);
-		$aQueryCols = CMDBSource::GetColumns($res);
-
-		// Prepare column definitions (check + give default values)
-		//
-		foreach($this->m_aColumns as $sName => $aColumnData)
-		{
-			if (!in_array($sName, $aQueryCols))
-			{
-				throw new Exception("Unknown column name '$sName' in sqlblock column");
-			}
-			if (!isset($aColumnData['label']))
-			{
-				$this->m_aColumns[$sName]['label'] = $sName;
-			}
-			if (isset($aColumnData['drilldown']) && !empty($aColumnData['drilldown']))
-			{
-				// Check if the OQL is valid
-				try
-				{
-					$this->m_aColumns[$sName]['filter'] = DBObjectSearch::FromOQL($aColumnData['drilldown']);
-				}
-				catch(OQLException $e)
-				{
-					unset($aColumnData['drilldown']);
-				}
-			}
-		}
-
-		if (strlen($this->m_sTitle) > 0)
-		{
-			$oPage->add("<h2>".Dict::S($this->m_sTitle)."</h2>\n");
-		}
-
-		switch ($this->m_sType)
-		{
-		case 'bars':
-		case 'pie':
-			$aColNames = array_keys($this->m_aColumns);
-			$sXColName = $aColNames[0];
-			$sYColName = $aColNames[1]; 
-			$aData = array();
-			$aRows = array();
-			while($aRow = CMDBSource::FetchArray($res))
-			{
-				$aData[$aRow[$sXColName]] = $aRow[$sYColName];
-				$aRows[$aRow[$sXColName]] = $aRow;
-			}
-			$this->RenderChart($oPage, $sId, $aData, $this->m_aColumns[$sYColName]['drilldown'], $aRows);
-			break;
-
-		default:
-		case 'table':
-			$oAppContext = new ApplicationContext();
-			$sContext = $oAppContext->GetForLink();
-			if (!empty($sContext))
-			{
-				$sContext = '&'.$sContext;
-			}
-			$aDisplayConfig = array();
-			foreach($this->m_aColumns as $sName => $aColumnData)
-			{
-				$aDisplayConfig[$sName] = array('label' => $aColumnData['label'], 'description' => '');
-			}
-	
-			$aDisplayData = array();
-			while($aRow = CMDBSource::FetchArray($res))
-			{
-				$aSQLColNames = array_keys($aRow);
-				$aDisplayRow = array();
-				foreach($this->m_aColumns as $sName => $aColumnData)
-				{
-					if (isset($aColumnData['filter']))
-					{
-						$sFilter = $aColumnData['drilldown'];
-						$sClass = $aColumnData['filter']->GetClass();
-						$sFilter = str_replace('SELECT '.$sClass, '', $sFilter);
-						foreach($aSQLColNames as $sColName)
-						{
-							$sFilter = str_replace(':'.$sColName, "'".addslashes( $aRow[$sColName] )."'", $sFilter);
-						}
-						$sURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=search_oql&search_form=0&oql_class='.$sClass.'&oql_clause='.urlencode($sFilter).'&format=html'.$sContext;
-						$aDisplayRow[$sName] = '<a href="'.$sURL.'">'.$aRow[$sName]."</a>";					
-					}
-					else
-					{
-						$aDisplayRow[$sName] = $aRow[$sName];
-					}
-				}
-				$aDisplayData[] = $aDisplayRow;
-			}
-			$oPage->table($aDisplayConfig, $aDisplayData);
-			break;
-		}
-	}
-	
-	public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
-	{
-		$sHtml = '';
-		return $sHtml;
-	}
-
-	protected function RenderChart($oPage, $sId, $aValues, $sDrillDown = '', $aRows = array())
-	{
-		// 1- Compute Open Flash Chart data
-		//
-		$aValueKeys = array();
-		$index = 0;
-		if ((count($aValues) > 0) && ($sDrillDown != ''))
-		{
-			$oFilter = DBObjectSearch::FromOQL($sDrillDown);
-			$sClass = $oFilter->GetClass();
-			$sOQLClause = str_replace('SELECT '.$sClass, '', $sDrillDown);
-			$aSQLColNames = array_keys(current($aRows)); // Read the list of columns from the current (i.e. first) element of the array
-			$oAppContext = new ApplicationContext();
-			$sURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=search_oql&search_form=0&oql_class='.$sClass.'&format=html&'.$oAppContext->GetForLink().'&oql_clause=';				
-		}
-		$aURLs = array();
-		foreach($aValues as $key => $value)
-		{
-			// Make sure that values are integers (so that max() will work....)
-			// and build an array of STRING with the keys (numeric keys are transformed into string by PHP :-(
-			$aValues[$key] = (int)$value;
-			$aValueKeys[] = (string)$key;
-			
-			// Build the custom query for the 'drill down' on each element
-			if ($sDrillDown != '')
-			{
-				$sFilter = $sOQLClause;
-				foreach($aSQLColNames as $sColName)
-				{
-					$sFilter = str_replace(':'.$sColName, "'".addslashes( $aRows[$key][$sColName] )."'", $sFilter);
-					$aURLs[$index] = $sURL.urlencode($sFilter);
-				}
-			}
-			$index++;
-		}
-	
-		$oChart = new open_flash_chart();
-	
-		if ($this->m_sType == 'bars')
-		{
-			$oChartElement = new bar_glass();
-		
-			if (count($aValues) > 0)
-			{
-				$maxValue = max($aValues);
-			}
-			else
-			{
-				$maxValue = 1;
-			}
-			$oYAxis = new y_axis();
-			$aMagicValues = array(1,2,5,10);
-			$iMultiplier = 1;
-			$index = 0;
-			$iTop = $aMagicValues[$index % count($aMagicValues)]*$iMultiplier;
-			while($maxValue > $iTop)
-			{
-				$index++;
-				$iTop = $aMagicValues[$index % count($aMagicValues)]*$iMultiplier;
-				if (($index % count($aMagicValues)) == 0)
-				{
-					$iMultiplier = $iMultiplier * 10;
-				}
-			}
-			//echo "oYAxis->set_range(0, $iTop, $iMultiplier);\n";
-			$oYAxis->set_range(0, $iTop, $iMultiplier);
-			$oChart->set_y_axis( $oYAxis );
-			$aBarValues = array();
-			foreach($aValues as $iValue)
-			{
-				$oBarValue = new bar_value($iValue);
-				$oBarValue->on_click("ofc_drilldown_{$sId}");
-				$aBarValues[] = $oBarValue;
-			}
-			$oChartElement->set_values($aBarValues);	
-			//$oChartElement->set_values(array_values($aValues));
-			$oXAxis = new x_axis();
-			$oXLabels = new x_axis_labels();
-			// set them vertical
-			$oXLabels->set_vertical();
-			// set the label text
-			$oXLabels->set_labels($aValueKeys);
-			// Add the X Axis Labels to the X Axis
-			$oXAxis->set_labels( $oXLabels );
-			$oChart->set_x_axis( $oXAxis );
-		}
-		else
-		{
-			$oChartElement = new pie();
-			$oChartElement->set_start_angle( 35 );
-			$oChartElement->set_animate( true );
-			$oChartElement->set_tooltip( '#label# - #val# (#percent#)' );
-			$oChartElement->set_colours( array('#FF8A00', '#909980', '#2C2B33', '#CCC08D', '#596664') );
-	
-			$aData = array();
-			foreach($aValues as $sValue => $iValue)
-			{
-				$oPieValue = new pie_value($iValue, $sValue); //@@ BUG: not passed via ajax !!!
-				$oPieValue->on_click("ofc_drilldown_{$sId}");
-				$aData[] = $oPieValue;
-			}
-	
-			$oChartElement->set_values( $aData );
-			$oChart->x_axis = null;
-		}
-	
-		// Title given in HTML
-		//$oTitle = new title($this->m_sTitle);
-		//$oChart->set_title($oTitle);
-		$oChart->set_bg_colour('#FFFFFF');
-		$oChart->add_element( $oChartElement );
-			
-		$sData = $oChart->toPrettyString();
-		$sData = json_encode($sData);
-
-		// 2- Declare the Javascript function that will render the chart data\
-		//
-		$oPage->add_script(
-<<< EOF
-function ofc_get_data_{$sId}()
-{
-	return $sData;
-}
-EOF
-		);
-		
-		if (count($aURLs) > 0)
-		{
-			$sURLList = '';
-			foreach($aURLs as $index => $sURL)
-			{
-				$sURLList .= "\taURLs[$index] = '".addslashes($sURL)."';\n";
-			}
-
-			$oPage->add_script(
-<<< EOF
-function ofc_drilldown_{$sId}(index)
-{
-	var aURLs = new Array();
-{$sURLList}
-	var sURL = aURLs[index];
-	
-	window.location.href = sURL; // Navigate ! 
-}
-EOF
-			);
-		}
-
-		// 3- Insert the Open Flash chart
-		//
-		$oPage->add("<div id=\"$sId\"><div>\n");
-		$oPage->add_ready_script(
-<<<EOF
-swfobject.embedSWF(	"../images/open-flash-chart.swf", 
-	"{$sId}", 
-	"100%", "300","9.0.0",
-	"expressInstall.swf",
-	{"get-data":"ofc_get_data_{$sId}", "id":"{$sId}"}, 
-	{'wmode': 'transparent'}
-);
-EOF
-		);
-	}
-}
-
-?>

application/startup.inc.php

@@ -1,31 +1,82 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * File to include to initialize the datamodel in memory
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/core/cmdbobject.class.inc.php');
-require_once(APPROOT.'/application/utils.inc.php');
-
-MetaModel::Startup(ITOP_CONFIG_FILE);
-
-?>
+<?php
+// Copyright (C) 2010-2016 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/>
+
+
+/**
+ * File to include to initialize the datamodel in memory
+ *
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+// This storage is freed on error (case of allowed memory exhausted)
+$sReservedMemory = str_repeat('*', 1024 * 1024);
+register_shutdown_function(function()
+{
+	global $sReservedMemory;
+	$sReservedMemory = null;
+	if (!is_null($err = error_get_last()) && ($err['type'] == E_ERROR))
+	{
+		if (strpos($err['message'], 'Allowed memory size of') !== false)
+		{
+			$sLimit = ini_get('memory_limit');
+			echo "<p>iTop: Allowed memory size of $sLimit exhausted, contact your administrator to increase memory_limit in php.ini</p>\n";
+		}
+		else
+		{
+			echo "<p>iTop: An error occurred, check server error log for more information.</p>\n";
+		}
+	}
+});
+
+require_once(APPROOT.'/core/cmdbobject.class.inc.php');
+require_once(APPROOT.'/application/utils.inc.php');
+require_once(APPROOT.'/core/contexttag.class.inc.php');
+session_name('itop-'.md5(APPROOT));
+session_start();
+$sSwitchEnv = utils::ReadParam('switch_env', null);
+$bAllowCache = true;
+if (($sSwitchEnv != null) && (file_exists(APPCONF.$sSwitchEnv.'/'.ITOP_CONFIG_FILE)) && isset($_SESSION['itop_env']) && ($_SESSION['itop_env'] !== $sSwitchEnv))
+{
+	$_SESSION['itop_env'] = $sSwitchEnv;
+	$sEnv = $sSwitchEnv;
+    $bAllowCache = false;
+    // Reset the opcache since otherwise the PHP "model" files may still be cached !!
+    if (function_exists('opcache_reset'))
+    {
+        // Zend opcode cache
+        opcache_reset();
+    }
+    if (function_exists('apc_clear_cache'))
+    {
+        // APC(u) cache
+        apc_clear_cache();
+    }
+	// TODO: reset the credentials as well ??
+}
+else if (isset($_SESSION['itop_env']))
+{
+	$sEnv = $_SESSION['itop_env'];
+}
+else
+{
+	$sEnv = ITOP_DEFAULT_ENV;
+	$_SESSION['itop_env'] = ITOP_DEFAULT_ENV;
+}
+$sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE;
+MetaModel::Startup($sConfigFile, false /* $bModelOnly */, $bAllowCache, false /* $bTraceSourceFiles */, $sEnv);

application/template.class.inc.php

@@ -1,402 +1,428 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class DisplayTemplate
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/application/displayblock.class.inc.php');
-/**
- * This class manages the special template format used internally to build the iTop web pages
- */
-class DisplayTemplate
-{
-	protected $m_sTemplate;
-	protected $m_aTags;
-	static protected $iBlockCount = 0;
-	
-	public function __construct($sTemplate)
-	{
-		$this->m_aTags = array (
-			'itopblock',
-			'itopcheck',
-			'itoptabs',
-			'itoptab',
-			'itoptoggle',
-			'itopstring',
-			'sqlblock'
-		);
-		$this->m_sTemplate = $sTemplate;
-	}
-	
-	public function Render(WebPage $oPage, $aParams = array())
-	{
-		$this->m_sTemplate = MetaModel::ApplyParams($this->m_sTemplate, $aParams);
-		$iStart = 0;
-		$iEnd = strlen($this->m_sTemplate);
-		$iCount = 0;
-		$iBeforeTagPos = $iStart;
-		$iAfterTagPos = $iStart;
-		while($sTag = $this->GetNextTag($iStart, $iEnd))
-		{
-			$sContent = $this->GetTagContent($sTag, $iStart, $iEnd);
-			$iAfterTagPos = $iEnd + strlen('</'.$sTag.'>');
-			$sOuterTag = substr($this->m_sTemplate, $iStart, $iAfterTagPos - $iStart);
-			$oPage->add(substr($this->m_sTemplate, $iBeforeTagPos, $iStart - $iBeforeTagPos));
-			if ($sTag == DisplayBlock::TAG_BLOCK)
-			{
-				try
-				{
-					$oBlock = DisplayBlock::FromTemplate($sOuterTag);
-					if (is_object($oBlock))
-					{
-						$oBlock->Display($oPage, 'block_'.self::$iBlockCount, $aParams);
-					}
-				}
-				catch(OQLException $e)
-				{
-					$oPage->p('Error in template (please contact your administrator) - Invalid query<!--'.$sOuterTag.'-->');
-				}
-				catch(Exception $e)
-				{
-					$oPage->p('Error in template (please contact your administrator)<!--'.$e->getMessage().'--><!--'.$sOuterTag.'-->');
-				}
-				
-				self::$iBlockCount++;
-			}
-			else
-			{
-				$aAttributes = $this->GetTagAttributes($sTag, $iStart, $iEnd);
-				//$oPage->p("Tag: $sTag - ($iStart, $iEnd)");
-				$this->RenderTag($oPage, $sTag, $aAttributes, $sContent);
-	
-			}
-			$iAfterTagPos = $iEnd + strlen('</'.$sTag.'>');
-			$iBeforeTagPos = $iAfterTagPos;
-			$iStart = $iEnd;
-			$iEnd = strlen($this->m_sTemplate); 
-			$iCount++;
-		}
-		$oPage->add(substr($this->m_sTemplate, $iAfterTagPos));
-	}
-	
-	public function GetNextTag(&$iStartPos, &$iEndPos)
-	{
-		$iChunkStartPos = $iStartPos;
-		$sNextTag = null;
-		$iStartPos = $iEndPos;
-		foreach($this->m_aTags as $sTag)
-		{
-			// Search for the opening tag
-			$iOpeningPos = stripos($this->m_sTemplate, '<'.$sTag.' ', $iChunkStartPos);
-			if ($iOpeningPos === false)
-			{
-				$iOpeningPos = stripos($this->m_sTemplate, '<'.$sTag.'>', $iChunkStartPos);
-			}
-			if ($iOpeningPos !== false)
-			{
-				$iClosingPos = stripos($this->m_sTemplate, '</'.$sTag.'>', $iOpeningPos);
-			}
-			if ( ($iOpeningPos !== false) && ($iClosingPos !== false))
-			{
-				if ($iOpeningPos < $iStartPos)
-				{
-					// This is the next tag
-					$iStartPos = $iOpeningPos;
-					$iEndPos = $iClosingPos;
-					$sNextTag = $sTag;
-				}
-			}
-		}
-		return $sNextTag;
-	}
-	
-	public function GetTagContent($sTag, $iStartPos, $iEndPos)
-	{
-		$sContent  = "";
-		$iContentStart = strpos($this->m_sTemplate, '>', $iStartPos); // Content of tag start immediatly after the first closing bracket
-		if ($iContentStart !== false)
-		{
-			$sContent = substr($this->m_sTemplate, 1+$iContentStart, $iEndPos - $iContentStart - 1);
-		}
-		return $sContent;
-	}
-
-	public function GetTagAttributes($sTag, $iStartPos, $iEndPos)
-	{
-		$aAttr  = array();
-		$iAttrStart = strpos($this->m_sTemplate, ' ', $iStartPos); // Attributes start just after the first space
-		$iAttrEnd = strpos($this->m_sTemplate, '>', $iStartPos); // Attributes end just before the first closing bracket
-		if ( ($iAttrStart !== false) && ($iAttrEnd !== false) && ($iAttrEnd > $iAttrStart))
-		{
-			$sAttributes = substr($this->m_sTemplate, 1+$iAttrStart, $iAttrEnd - $iAttrStart - 1);
-			$aAttributes = explode(' ', $sAttributes);
-			foreach($aAttributes as $sAttr)
-			{
-				if ( preg_match('/(.+) *= *"(.+)"$/', $sAttr, $aMatches) )
-				{
-					$aAttr[strtolower($aMatches[1])] = $aMatches[2];
-				}
-			}
-		}
-		return $aAttr;
-	}
-	
-	protected function RenderTag($oPage, $sTag, $aAttributes, $sContent)
-	{
-		static $iTabContainerCount = 0;
-		switch($sTag)
-		{
-			case 'itoptabs':
-				$oPage->AddTabContainer('Tabs_'.$iTabContainerCount);
-				$oPage->SetCurrentTabContainer('Tabs_'.$iTabContainerCount);
-				$iTabContainerCount++;
-				//$oPage->p('Content:<pre>'.htmlentities($sContent, ENT_QUOTES, 'UTF-8').'</pre>');
-				$oTemplate = new DisplayTemplate($sContent);
-				$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
-				$oPage->SetCurrentTabContainer('');
-			break;
-			
-			case 'itopcheck':
-				$sClassName = $aAttributes['class'];
-				if (MetaModel::IsValidClass($sClassName) && UserRights::IsActionAllowed($sClassName, UR_ACTION_READ))
-				{
-					$oTemplate = new DisplayTemplate($sContent);
-					$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
-				}
-				else
-				{
-					// Leave a trace for those who'd like to understand why nothing is displayed
-					$oPage->add("<!-- class $sClassName does not exist, skipping some part of the template -->\n");
-				}
-			break;
-			
-			case 'itoptab':
-				$oPage->SetCurrentTab(Dict::S(str_replace('_', ' ', $aAttributes['name'])));
-				$oTemplate = new DisplayTemplate($sContent);
-				$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
-				//$oPage->p('iTop Tab Content:<pre>'.htmlentities($sContent, ENT_QUOTES, 'UTF-8').'</pre>');
-				$oPage->SetCurrentTab('');
-			break;
-			
-			case 'itoptoggle':
-				$sName = isset($aAttributes['name']) ? $aAttributes['name'] : 'Tagada';
-				$bOpen = isset($aAttributes['open']) ? $aAttributes['open'] : true;
-				$oPage->StartCollapsibleSection(Dict::S($sName), $bOpen);
-				$oTemplate = new DisplayTemplate($sContent);
-				$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
-				//$oPage->p('iTop Tab Content:<pre>'.htmlentities($sContent, ENT_QUOTES, 'UTF-8').'</pre>');
-				$oPage->EndCollapsibleSection();
-			break;
-			
-			case 'itopstring':
-				$oPage->add(Dict::S($sContent));
-			break;
-			
-			case 'sqlblock':
-				$oBlock = SqlBlock::FromTemplate($sContent);
-				$oBlock->RenderContent($oPage);
-			break;
-			
-			case 'itopblock': // No longer used, handled by DisplayBlock::FromTemplate see above
-				$oPage->add("<!-- Application Error: should be handled by DisplayBlock::FromTemplate -->");
-			break;
-			
-			default:
-				// Unknown tag, just ignore it or now -- output an HTML comment
-				$oPage->add("<!-- unsupported tag: $sTag -->");
-		}
-	}
-	
-	/**
-	 * Unit test
-	 */
-	static public function UnitTest()
-	{
-		require_once(APPROOT.'/application/startup.inc.php');
-		require_once(APPROOT."/application/itopwebpage.class.inc.php");
-		
-		$sTemplate = '<div class="page_header">
-		<div class="actions_details"><a href="#"><span>Actions</span></a></div>
-		<h1>$class$: <span class="hilite">$name$</span></h1>
-		<itopblock blockclass="HistoryBlock" type="toggle" encoding="text/oql">SELECT CMDBChangeOp WHERE objkey = $id$ AND objclass = \'$class$\'</itopblock>
-		</div>
-		<img src="../../images/connect_to_network.png" style="margin-top:-10px; margin-right:10px; float:right">
-		<itoptabs>
-			<itoptab name="Interfaces">
-				<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT Interface AS i WHERE i.device_id = $id$</itopblock>
-			</itoptab>
-			<itoptab name="Contacts">
-				<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT Contact AS c JOIN lnkContactToCI AS l ON l.contact_id = c.id WHERE l.ci_id = $id$</itopblock>
-			</itoptab>
-			<itoptab name="Documents">
-				<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT Document AS d JOIN lnkDocumentToCI as l ON l.document_id = d.id WHERE l.ci_id = $id$)</itopblock>
-			</itoptab>
-		</itoptabs>';
-		
-		$oPage = new iTopWebPage('Unit Test');
-		//$oPage->add("Template content: <pre>".htmlentities($sTemplate, ENT_QUOTES, 'UTF-8')."</pre>\n");
-		$oTemplate = new DisplayTemplate($sTemplate);
-		$oTemplate->Render($oPage, array('class'=>'Network device','pkey'=> 271, 'name' => 'deliversw01.mecanorama.fr', 'org_id' => 3));
-		$oPage->output();
-	}
-}
-
-/**
- * Special type of template for displaying the details of an object
- * On top of the defaut 'blocks' managed by the parent class, the following placeholders
- * are available in such a template:
- * $attribute_code$ An attribute of the object (in edit mode this is the input for the attribute)
- * $attribute_code->label()$ The label of an attribute
- * $PlugIn:plugInClass->properties()$ The ouput of OnDisplayProperties of the specified plugInClass
- */
-class ObjectDetailsTemplate extends DisplayTemplate
-{
-	public function __construct($sTemplate, $oObj, $sFormPrefix = '')
-	{
-		parent::__construct($sTemplate);
-		$this->m_oObj = $oObj;
-		$this->m_sPrefix = $sFormPrefix;
-	}
-	
-	public function Render(WebPage $oPage, $aParams = array(), $bEditMode = false)
-	{
-		$sStateAttCode = MetaModel :: GetStateAttributeCode(get_class($this->m_oObj));
-		$aTemplateFields = array();
-		preg_match_all('/\\$this->([a-z0-9_]+)\\$/', $this->m_sTemplate, $aMatches);
-		$aTemplateFields = $aMatches[1];
-		preg_match_all('/\\$this->field\\(([a-z0-9_]+)\\)\\$/', $this->m_sTemplate, $aMatches);
-		$aTemplateFields = array_merge($aTemplateFields, $aMatches[1]);
-		$aFieldsComments = (isset($aParams['fieldsComments'])) ? $aParams['fieldsComments'] : array();
-		$aFieldsMap = array();
-
-		$sClass = get_class($this->m_oObj);
-		// Renders the fields used in the template
-		foreach(MetaModel::ListAttributeDefs(get_class($this->m_oObj)) as $sAttCode => $oAttDef)
-		{
-			$aParams['this->label('.$sAttCode.')'] = $oAttDef->GetLabel();
-			$aParams['this->comments('.$sAttCode.')'] = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : '';
-			$iInputId = '2_'.$sAttCode; // TODO: generate a real/unique prefix...
-			if (in_array($sAttCode, $aTemplateFields))
-			{
-				if ($this->m_oObj->IsNew())
-				{
-					$iFlags = $this->m_oObj->GetInitialStateAttributeFlags($sAttCode);
-				}
-				else
-				{
-				$iFlags = $this->m_oObj->GetAttributeFlags($sAttCode);
-				}
-				if (($iFlags & OPT_ATT_MANDATORY) && $this->m_oObj->IsNew())
-				{
-					$iFlags = $iFlags & ~OPT_ATT_READONLY; // Mandatory fields cannot be read-only when creating an object
-				}
-				
-				if ((!$oAttDef->IsWritable()) || ($sStateAttCode == $sAttCode))
-				{
-					$iFlags = $iFlags | OPT_ATT_READONLY;
-				}
-
-				if ($iFlags & OPT_ATT_HIDDEN)
-				{
-					$aParams['this->label('.$sAttCode.')'] = '';
-					$aParams['this->field('.$sAttCode.')'] = '';
-					$aParams['this->comments('.$sAttCode.')'] = '';
-					$aParams['this->'.$sAttCode] = '';
-				}
-				else
-				{
-					if ($bEditMode && ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
-					{
-						// Check if the attribute is not read-only because of a synchro...
-						$aReasons = array();
-						$sSynchroIcon = '';
-						if ($iFlags & OPT_ATT_SLAVE)
-						{
-							$iSynchroFlags = $this->m_oObj->GetSynchroReplicaFlags($sAttCode, $aReasons);
-							$sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
-							$sTip = '';
-							foreach($aReasons as $aRow)
-							{
-								$sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
-							}
-							$oPage->add_ready_script("$('#synchro_$iInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
-						}
-	
-						// Attribute is read-only
-						$sHTMLValue = "<span id=\"field_{$iInputId}\">".$this->m_oObj->GetAsHTML($sAttCode);
-						$sHTMLValue .= '<input type="hidden" id="'.$iInputId.'" name="attr_'.$sAttCode.'" value="'.htmlentities($this->m_oObj->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/></span>';
-						$aFieldsMap[$sAttCode] = $iInputId;
-						$aParams['this->comments('.$sAttCode.')'] = $sSynchroIcon;
-					}
-	
-					if ($bEditMode && !($iFlags & OPT_ATT_READONLY)) //TODO: check the data synchro status...
-					{
-						$aParams['this->field('.$sAttCode.')'] = "<span id=\"field_{$iInputId}\">".$this->m_oObj->GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef,
-						$this->m_oObj->Get($sAttCode),
-						$this->m_oObj->GetEditValue($sAttCode),
-						$iInputId, // InputID
-						'',
-						$iFlags,
-						array('this' => $this->m_oObj) // aArgs
-					).'</span>';
-					$aFieldsMap[$sAttCode] = $iInputId;
-				}
-				else 
-				{
-						$aParams['this->field('.$sAttCode.')'] = $this->m_oObj->GetAsHTML($sAttCode);
-					}
-					$aParams['this->'.$sAttCode] = "<table class=\"field\"><tr><td class=\"label\">".$aParams['this->label('.$sAttCode.')'].":</td><td>".$aParams['this->field('.$sAttCode.')']."</td><td>".$aParams['this->comments('.$sAttCode.')']."</td></tr></table>";					
-				}
-			}
-		}
-		
-		// Renders the PlugIns used in the template
-		preg_match_all('/\\$PlugIn:([A-Za-z0-9_]+)->properties\\(\\)\\$/', $this->m_sTemplate, $aMatches);
-		$aPlugInProperties = $aMatches[1];
-		foreach($aPlugInProperties as $sPlugInClass)
-		{
-			$oInstance = MetaModel::GetPlugins('iApplicationUIExtension', $sPlugInClass);
-			if ($oInstance != null) // Safety check...
-			{
-				$offset = $oPage->start_capture();
-				$oInstance->OnDisplayProperties($this->m_oObj, $oPage, $bEditMode);
-				$sContent = $oPage->end_capture($offset);
-				$aParams["PlugIn:{$sPlugInClass}->properties()"]= $sContent;			
-			}
-			else
-			{
-				$aParams["PlugIn:{$sPlugInClass}->properties()"]= "Missing PlugIn: $sPlugInClass";				
-			}			
-		}
-
-		$offset = $oPage->start_capture();
-		parent::Render($oPage, $aParams);
-		$sContent = $oPage->end_capture($offset);
-		// Remove empty table rows in case some attributes are hidden...
-		$sContent = preg_replace('/<tr[^>]*>\s*(<td[^>]*>\s*<\\/td>)+\s*<\\/tr>/im', '', $sContent);
-		$oPage->add($sContent);
-		return $aFieldsMap;
-	}
-}
-
-//DisplayTemplate::UnitTest();
-?>
+<?php
+// Copyright (C) 2010-2017 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/>
+
+
+/**
+ * Class DisplayTemplate
+ *
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'/application/displayblock.class.inc.php');
+/**
+ * This class manages the special template format used internally to build the iTop web pages
+ */
+class DisplayTemplate
+{
+	protected $m_sTemplate;
+	protected $m_aTags;
+	static protected $iBlockCount = 0;
+	
+	public function __construct($sTemplate)
+	{
+		$this->m_aTags = array (
+			'itopblock',
+			'itopcheck',
+			'itoptabs',
+			'itoptab',
+			'itoptoggle',
+			'itopstring',
+			'sqlblock'
+		);
+		$this->m_sTemplate = $sTemplate;
+	}
+	
+	public function Render(WebPage $oPage, $aParams = array())
+	{
+		$this->m_sTemplate = MetaModel::ApplyParams($this->m_sTemplate, $aParams);
+		$iStart = 0;
+		$iEnd = strlen($this->m_sTemplate);
+		$iCount = 0;
+		$iBeforeTagPos = $iStart;
+		$iAfterTagPos = $iStart;
+		while($sTag = $this->GetNextTag($iStart, $iEnd))
+		{
+			$sContent = $this->GetTagContent($sTag, $iStart, $iEnd);
+			$iAfterTagPos = $iEnd + strlen('</'.$sTag.'>');
+			$sOuterTag = substr($this->m_sTemplate, $iStart, $iAfterTagPos - $iStart);
+			$oPage->add(substr($this->m_sTemplate, $iBeforeTagPos, $iStart - $iBeforeTagPos));
+			if ($sTag == DisplayBlock::TAG_BLOCK)
+			{
+				try
+				{
+					$oBlock = DisplayBlock::FromTemplate($sOuterTag);
+					if (is_object($oBlock))
+					{
+						$oBlock->Display($oPage, 'block_'.self::$iBlockCount, $aParams);
+					}
+				}
+				catch(OQLException $e)
+				{
+					$oPage->p('Error in template (please contact your administrator) - Invalid query<!--'.$sOuterTag.'-->');
+				}
+				catch(Exception $e)
+				{
+					$oPage->p('Error in template (please contact your administrator)<!--'.$e->getMessage().'--><!--'.$sOuterTag.'-->');
+				}
+				
+				self::$iBlockCount++;
+			}
+			else
+			{
+				$aAttributes = $this->GetTagAttributes($sTag, $iStart, $iEnd);
+				//$oPage->p("Tag: $sTag - ($iStart, $iEnd)");
+				$this->RenderTag($oPage, $sTag, $aAttributes, $sContent);
+	
+			}
+			$iAfterTagPos = $iEnd + strlen('</'.$sTag.'>');
+			$iBeforeTagPos = $iAfterTagPos;
+			$iStart = $iEnd;
+			$iEnd = strlen($this->m_sTemplate); 
+			$iCount++;
+		}
+		$oPage->add(substr($this->m_sTemplate, $iAfterTagPos));
+	}
+	
+	public function GetNextTag(&$iStartPos, &$iEndPos)
+	{
+		$iChunkStartPos = $iStartPos;
+		$sNextTag = null;
+		$iStartPos = $iEndPos;
+		foreach($this->m_aTags as $sTag)
+		{
+			// Search for the opening tag
+			$iOpeningPos = stripos($this->m_sTemplate, '<'.$sTag.' ', $iChunkStartPos);
+			if ($iOpeningPos === false)
+			{
+				$iOpeningPos = stripos($this->m_sTemplate, '<'.$sTag.'>', $iChunkStartPos);
+			}
+			if ($iOpeningPos !== false)
+			{
+				$iClosingPos = stripos($this->m_sTemplate, '</'.$sTag.'>', $iOpeningPos);
+			}
+			if ( ($iOpeningPos !== false) && ($iClosingPos !== false))
+			{
+				if ($iOpeningPos < $iStartPos)
+				{
+					// This is the next tag
+					$iStartPos = $iOpeningPos;
+					$iEndPos = $iClosingPos;
+					$sNextTag = $sTag;
+				}
+			}
+		}
+		return $sNextTag;
+	}
+	
+	public function GetTagContent($sTag, $iStartPos, $iEndPos)
+	{
+		$sContent  = "";
+		$iContentStart = strpos($this->m_sTemplate, '>', $iStartPos); // Content of tag start immediatly after the first closing bracket
+		if ($iContentStart !== false)
+		{
+			$sContent = substr($this->m_sTemplate, 1+$iContentStart, $iEndPos - $iContentStart - 1);
+		}
+		return $sContent;
+	}
+
+	public function GetTagAttributes($sTag, $iStartPos, $iEndPos)
+	{
+		$aAttr  = array();
+		$iAttrStart = strpos($this->m_sTemplate, ' ', $iStartPos); // Attributes start just after the first space
+		$iAttrEnd = strpos($this->m_sTemplate, '>', $iStartPos); // Attributes end just before the first closing bracket
+		if ( ($iAttrStart !== false) && ($iAttrEnd !== false) && ($iAttrEnd > $iAttrStart))
+		{
+			$sAttributes = substr($this->m_sTemplate, 1+$iAttrStart, $iAttrEnd - $iAttrStart - 1);
+			$aAttributes = explode(' ', $sAttributes);
+			foreach($aAttributes as $sAttr)
+			{
+				if ( preg_match('/(.+) *= *"(.+)"$/', $sAttr, $aMatches) )
+				{
+					$aAttr[strtolower($aMatches[1])] = $aMatches[2];
+				}
+			}
+		}
+		return $aAttr;
+	}
+	
+	protected function RenderTag($oPage, $sTag, $aAttributes, $sContent)
+	{
+		static $iTabContainerCount = 0;
+		switch($sTag)
+		{
+			case 'itoptabs':
+				$oPage->AddTabContainer('Tabs_'.$iTabContainerCount);
+				$oPage->SetCurrentTabContainer('Tabs_'.$iTabContainerCount);
+				$iTabContainerCount++;
+				//$oPage->p('Content:<pre>'.htmlentities($sContent, ENT_QUOTES, 'UTF-8').'</pre>');
+				$oTemplate = new DisplayTemplate($sContent);
+				$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
+				$oPage->SetCurrentTabContainer('');
+			break;
+			
+			case 'itopcheck':
+				$sClassName = $aAttributes['class'];
+				if (MetaModel::IsValidClass($sClassName) && UserRights::IsActionAllowed($sClassName, UR_ACTION_READ))
+				{
+					$oTemplate = new DisplayTemplate($sContent);
+					$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
+				}
+				else
+				{
+					// Leave a trace for those who'd like to understand why nothing is displayed
+					$oPage->add("<!-- class $sClassName does not exist, skipping some part of the template -->\n");
+				}
+			break;
+			
+			case 'itoptab':
+				$oPage->SetCurrentTab(Dict::S(str_replace('_', ' ', $aAttributes['name'])));
+				$oTemplate = new DisplayTemplate($sContent);
+				$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
+				//$oPage->p('iTop Tab Content:<pre>'.htmlentities($sContent, ENT_QUOTES, 'UTF-8').'</pre>');
+				$oPage->SetCurrentTab('');
+			break;
+			
+			case 'itoptoggle':
+				$sName = isset($aAttributes['name']) ? $aAttributes['name'] : 'Tagada';
+				$bOpen = isset($aAttributes['open']) ? $aAttributes['open'] : true;
+				$oPage->StartCollapsibleSection(Dict::S($sName), $bOpen);
+				$oTemplate = new DisplayTemplate($sContent);
+				$oTemplate->Render($oPage, array()); // no params to apply, they have already been applied
+				//$oPage->p('iTop Tab Content:<pre>'.htmlentities($sContent, ENT_QUOTES, 'UTF-8').'</pre>');
+				$oPage->EndCollapsibleSection();
+			break;
+			
+			case 'itopstring':
+				$oPage->add(Dict::S($sContent));
+			break;
+			
+			case 'sqlblock':
+				$oBlock = SqlBlock::FromTemplate($sContent);
+				$oBlock->RenderContent($oPage);
+			break;
+			
+			case 'itopblock': // No longer used, handled by DisplayBlock::FromTemplate see above
+				$oPage->add("<!-- Application Error: should be handled by DisplayBlock::FromTemplate -->");
+			break;
+			
+			default:
+				// Unknown tag, just ignore it or now -- output an HTML comment
+				$oPage->add("<!-- unsupported tag: $sTag -->");
+		}
+	}
+	
+	/**
+	 * Unit test
+	 */
+	static public function UnitTest()
+	{
+		require_once(APPROOT.'/application/startup.inc.php');
+		require_once(APPROOT."/application/itopwebpage.class.inc.php");
+		
+		$sTemplate = '<div class="page_header">
+		<div class="actions_details"><a href="#"><span>Actions</span></a></div>
+		<h1>$class$: <span class="hilite">$name$</span></h1>
+		<itopblock blockclass="HistoryBlock" type="toggle" encoding="text/oql">SELECT CMDBChangeOp WHERE objkey = $id$ AND objclass = \'$class$\'</itopblock>
+		</div>
+		<img src="../../images/connect_to_network.png" style="margin-top:-10px; margin-right:10px; float:right">
+		<itoptabs>
+			<itoptab name="Interfaces">
+				<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT Interface AS i WHERE i.device_id = $id$</itopblock>
+			</itoptab>
+			<itoptab name="Contacts">
+				<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT Contact AS c JOIN lnkContactToCI AS l ON l.contact_id = c.id WHERE l.ci_id = $id$</itopblock>
+			</itoptab>
+			<itoptab name="Documents">
+				<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT Document AS d JOIN lnkDocumentToCI as l ON l.document_id = d.id WHERE l.ci_id = $id$)</itopblock>
+			</itoptab>
+		</itoptabs>';
+		
+		$oPage = new iTopWebPage('Unit Test');
+		//$oPage->add("Template content: <pre>".htmlentities($sTemplate, ENT_QUOTES, 'UTF-8')."</pre>\n");
+		$oTemplate = new DisplayTemplate($sTemplate);
+		$oTemplate->Render($oPage, array('class'=>'Network device','pkey'=> 271, 'name' => 'deliversw01.mecanorama.fr', 'org_id' => 3));
+		$oPage->output();
+	}
+}
+
+/**
+ * Special type of template for displaying the details of an object
+ * On top of the defaut 'blocks' managed by the parent class, the following placeholders
+ * are available in such a template:
+ * $attribute_code$ An attribute of the object (in edit mode this is the input for the attribute)
+ * $attribute_code->label()$ The label of an attribute
+ * $PlugIn:plugInClass->properties()$ The ouput of OnDisplayProperties of the specified plugInClass
+ */
+class ObjectDetailsTemplate extends DisplayTemplate
+{
+	public function __construct($sTemplate, $oObj, $sFormPrefix = '')
+	{
+		parent::__construct($sTemplate);
+		$this->m_oObj = $oObj;
+		$this->m_sPrefix = $sFormPrefix;
+	}
+	
+	public function Render(WebPage $oPage, $aParams = array(), $bEditMode = false)
+	{
+		$sStateAttCode = MetaModel :: GetStateAttributeCode(get_class($this->m_oObj));
+		$aTemplateFields = array();
+		preg_match_all('/\\$this->([a-z0-9_]+)\\$/', $this->m_sTemplate, $aMatches);
+		foreach ($aMatches[1] as $sAttCode)
+		{
+			if (MetaModel::IsValidAttCode(get_class($this->m_oObj), $sAttCode))
+			{
+				$aTemplateFields[] = $sAttCode;
+			}
+			else
+			{
+				$aParams['this->'.$sAttCode] = "<!--Unknown attribute: $sAttCode-->";					
+			}
+		}
+		preg_match_all('/\\$this->field\\(([a-z0-9_]+)\\)\\$/', $this->m_sTemplate, $aMatches);
+		foreach ($aMatches[1] as $sAttCode)
+		{
+			if (MetaModel::IsValidAttCode(get_class($this->m_oObj), $sAttCode))
+			{
+				$aTemplateFields[] = $sAttCode;
+			}
+			else
+			{
+				$aParams['this->field('.$sAttCode.')'] = "<!--Unknown attribute: $sAttCode-->";
+			}
+		}
+		$aFieldsComments = (isset($aParams['fieldsComments'])) ? $aParams['fieldsComments'] : array();
+		$aFieldsMap = array();
+
+		$sClass = get_class($this->m_oObj);
+		// Renders the fields used in the template
+		foreach(MetaModel::ListAttributeDefs(get_class($this->m_oObj)) as $sAttCode => $oAttDef)
+		{
+			$aParams['this->label('.$sAttCode.')'] = $oAttDef->GetLabel();
+			$aParams['this->comments('.$sAttCode.')'] = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : '';
+			$iInputId = '2_'.$sAttCode; // TODO: generate a real/unique prefix...
+			if (in_array($sAttCode, $aTemplateFields))
+			{
+				if ($this->m_oObj->IsNew())
+				{
+					$iFlags = $this->m_oObj->GetInitialStateAttributeFlags($sAttCode);
+				}
+				else
+				{
+				$iFlags = $this->m_oObj->GetAttributeFlags($sAttCode);
+				}
+				if (($iFlags & OPT_ATT_MANDATORY) && $this->m_oObj->IsNew())
+				{
+					$iFlags = $iFlags & ~OPT_ATT_READONLY; // Mandatory fields cannot be read-only when creating an object
+				}
+				
+				if ((!$oAttDef->IsWritable()) || ($sStateAttCode == $sAttCode))
+				{
+					$iFlags = $iFlags | OPT_ATT_READONLY;
+				}
+
+				if ($iFlags & OPT_ATT_HIDDEN)
+				{
+					$aParams['this->label('.$sAttCode.')'] = '';
+					$aParams['this->field('.$sAttCode.')'] = '';
+					$aParams['this->comments('.$sAttCode.')'] = '';
+					$aParams['this->'.$sAttCode] = '';
+				}
+				else
+				{
+					if ($bEditMode && ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
+					{
+						// Check if the attribute is not read-only because of a synchro...
+						$aReasons = array();
+						$sSynchroIcon = '';
+						if ($iFlags & OPT_ATT_SLAVE)
+						{
+							$iSynchroFlags = $this->m_oObj->GetSynchroReplicaFlags($sAttCode, $aReasons);
+							$sSynchroIcon = "&nbsp;<img id=\"synchro_$iInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
+							$sTip = '';
+							foreach($aReasons as $aRow)
+							{
+								$sDescription = htmlentities($aRow['description'], ENT_QUOTES, 'UTF-8');
+								$sDescription = str_replace(array("\r\n", "\n"), "<br/>", $sDescription);
+								$sTip .= "<div class='synchro-source'>";
+								$sTip .= "<div class='synchro-source-title'>Synchronized with {$aRow['name']}</div>";
+								$sTip .= "<div class='synchro-source-description'>$sDescription</div>";
+							}
+							$oPage->add_ready_script("$('#synchro_$iInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
+						}
+	
+						// Attribute is read-only
+						$sHTMLValue = "<span id=\"field_{$iInputId}\">".$this->m_oObj->GetAsHTML($sAttCode);
+						$sHTMLValue .= '<input type="hidden" id="'.$iInputId.'" name="attr_'.$sAttCode.'" value="'.htmlentities($this->m_oObj->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/></span>';
+						$aFieldsMap[$sAttCode] = $iInputId;
+						$aParams['this->comments('.$sAttCode.')'] = $sSynchroIcon;
+					}
+	
+					if ($bEditMode && !($iFlags & OPT_ATT_READONLY)) //TODO: check the data synchro status...
+					{
+						$aParams['this->field('.$sAttCode.')'] = "<span id=\"field_{$iInputId}\">".$this->m_oObj->GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef,
+						$this->m_oObj->Get($sAttCode),
+						$this->m_oObj->GetEditValue($sAttCode),
+						$iInputId, // InputID
+						'',
+						$iFlags,
+						array('this' => $this->m_oObj) // aArgs
+					).'</span>';
+					$aFieldsMap[$sAttCode] = $iInputId;
+				}
+				else 
+				{
+						$aParams['this->field('.$sAttCode.')'] = $this->m_oObj->GetAsHTML($sAttCode);
+					}
+					$aParams['this->'.$sAttCode] = "<table class=\"field\"><tr><td class=\"label\">".$aParams['this->label('.$sAttCode.')'].":</td><td>".$aParams['this->field('.$sAttCode.')']."</td><td>".$aParams['this->comments('.$sAttCode.')']."</td></tr></table>";					
+				}
+			}
+		}
+		
+		// Renders the PlugIns used in the template
+		preg_match_all('/\\$PlugIn:([A-Za-z0-9_]+)->properties\\(\\)\\$/', $this->m_sTemplate, $aMatches);
+		$aPlugInProperties = $aMatches[1];
+		foreach($aPlugInProperties as $sPlugInClass)
+		{
+			/** @var \iApplicationUIExtension $oInstance */
+			$oInstance = MetaModel::GetPlugins('iApplicationUIExtension', $sPlugInClass);
+			if ($oInstance != null) // Safety check...
+			{
+				$offset = $oPage->start_capture();
+				$oInstance->OnDisplayProperties($this->m_oObj, $oPage, $bEditMode);
+				$sContent = $oPage->end_capture($offset);
+				$aParams["PlugIn:{$sPlugInClass}->properties()"]= $sContent;			
+			}
+			else
+			{
+				$aParams["PlugIn:{$sPlugInClass}->properties()"]= "Missing PlugIn: $sPlugInClass";				
+			}			
+		}
+
+		$offset = $oPage->start_capture();
+		parent::Render($oPage, $aParams);
+		$sContent = $oPage->end_capture($offset);
+		// Remove empty table rows in case some attributes are hidden...
+		$sContent = preg_replace('/<tr[^>]*>\s*(<td[^>]*>\s*<\\/td>)+\s*<\\/tr>/im', '', $sContent);
+		$oPage->add($sContent);
+		return $aFieldsMap;
+	}
+}
+
+//DisplayTemplate::UnitTest();
+?>

application/templates/audit_category.html

@@ -1,12 +1,12 @@
-<div class="page_header">
-	<itopblock blockclass="MenuBlock" type="popup" encoding="text/oql" label="Actions">SELECT $class$ WHERE id = $id$</itopblock>
-	<h1>$class$: <span class="hilite">$name$</span></h1>
-	<itopblock blockclass="HistoryBlock" type="toggle" encoding="text/oql">SELECT CMDBChangeOp WHERE objkey = $id$ AND objclass = '$class$'</itopblock>
-</div>
-<img src="../../images/clean.png" style="margin-top:-20px; margin-right:10px; float:right">
-<itopblock blockclass="DisplayBlock" asynchronous="false" type="bare_details" encoding="text/oql">SELECT $class$ WHERE id = $id$</itopblock>
-<itoptabs>
-	<itoptab name="Rules">
-		<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT AuditRule WHERE category_id = $id$</itopblock>
-	</itoptab>
-</itoptabs>
+<div class="page_header">
+	<itopblock blockclass="MenuBlock" type="popup" encoding="text/oql" label="Actions">SELECT $class$ WHERE id = $id$</itopblock>
+	<h1>$class$: <span class="hilite">$name$</span></h1>
+	<itopblock blockclass="HistoryBlock" type="toggle" encoding="text/oql">SELECT CMDBChangeOp WHERE objkey = $id$ AND objclass = '$class$'</itopblock>
+</div>
+<img src="../../images/clean.png" style="margin-top:-20px; margin-right:10px; float:right">
+<itopblock blockclass="DisplayBlock" asynchronous="false" type="bare_details" encoding="text/oql">SELECT $class$ WHERE id = $id$</itopblock>
+<itoptabs>
+	<itoptab name="Rules">
+		<itopblock blockclass="DisplayBlock" type="list" encoding="text/oql">SELECT AuditRule WHERE category_id = $id$</itopblock>
+	</itoptab>
+</itoptabs>

application/templates/notifications_menu.html

@@ -1,20 +0,0 @@
-<div class="page_header" style="padding:0.5em;">
-<h1><itopstring>UI:NotificationsMenu:Title</itopstring></h1>
-</div>
-<itoptoggle name="UI:NotificationsMenu:Help" open="true">
-<div style="padding: 1em; font-size:10pt;background:#E8F3CF;margin-top: 0.25em;">
-<img src="../images/bell.png" style="margin-top: -60px; margin-right: 10px; float: right;">
-<itopstring>UI:NotificationsMenu:HelpContent</itopstring>
-</div>
-</itoptoggle>
-<p>&nbsp;</p>
-<itoptabs>
-	<itoptab name="UI:NotificationsMenu:Triggers">
-		<h2><itopstring>UI:NotificationsMenu:AvailableTriggers</itopstring></h2>
-		<itopblock BlockClass="DisplayBlock" type="list" asynchronous="false" encoding="text/oql">SELECT Trigger</itopblock>
-	</itoptab>
-	<itoptab name="UI:NotificationsMenu:Actions">
-		<h2><itopstring>UI:NotificationsMenu:AvailableActions</itopstring></h2>
-		<itopblock BlockClass="DisplayBlock" type="list" asynchronous="false" encoding="text/oql">SELECT ActionEmail</itopblock>
-	</itoptab>
-</itoptabs>

application/templates/welcome_popup.html

@@ -1,15 +1,6 @@
 <div style="width:100%;background: #fff url(../images/welcome.jpg) top left no-repeat;">
 <style>
-.dashboard {
-vertical-align:top;
-width:50%;
-border:0px solid #000;
-background-color:#F9F9F1;
-padding:10px;
-text-align:left;
-font-size:10pt;
-}
-.dashboard2 {
+.welcome_popup_cell {
 vertical-align:top;
 width:50%;
 border:0px solid #000;
@@ -17,15 +8,7 @@ border:0px solid #000;
 padding:5px;
 text-align:left;
 }
-
-td.dashboard li {
-margin-top: 5px;
-display: list-item;
-}
-td div.display_block {
-padding:0;
-}
-tr td.dashboard2,  tr td.dashboard2 ul {
+tr td.welcome_popup_cell,  tr td.welcome_popup_cell ul {
 font-size:10pt;
 }
 </style>
@@ -35,10 +18,10 @@ font-size:10pt;
 <p></p>
 <table border="0" style="padding:10px;border-spacing: 10px;width:100%">
 <tr>
-<td class="dashboard2">
+<td class="welcome_popup_cell">
 <itopstring>UI:WelcomeMenu:LeftBlock</itopstring>
 </td>
-<td class="dashboard2">
+<td class="welcome_popup_cell">
 <itopstring>UI:WelcomeMenu:RightBlock</itopstring>
 </td>
 </tr>

application/transaction.class.inc.php

@@ -1,28 +1,109 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   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 General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * This class records the pending "transactions" corresponding to forms that have not been
  * submitted yet, in order to prevent double submissions. When created a transaction remains valid
- * until the user's session expires
+ * until the user's session expires. This class is actually a wrapper to the underlying implementation
+ * which choice is configured via the parameter 'transaction_storage'
+ *  
  * @package     iTop
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
 class privUITransaction
+{
+	/**
+	 * Create a new transaction id, store it in the session and return its id
+	 * @param void
+	 * @return int The identifier of the new transaction
+	 */
+	public static function GetNewTransactionId()
+	{
+		$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
+		if (!$bTransactionsEnabled)
+		{
+			return 'notransactions'; // Any value will do
+		}
+		$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
+		if (!class_exists($sClass, false))
+		{
+			IssueLog::Error("Incorrect value '".MetaModel::GetConfig()->Get('transaction_storage')."' for 'transaction_storage', the class '$sClass' does not exists. Using privUITransactionSession instead for storing sessions.");
+			$sClass = 'privUITransactionSession';
+		}
+
+		return (string)$sClass::GetNewTransactionId();
+	}
+
+	/**
+	 * Check whether a transaction is valid or not and (optionally) remove the valid transaction from
+	 * the session so that another call to IsTransactionValid for the same transaction id
+	 * will return false
+	 * @param int $id Identifier of the transaction, as returned by GetNewTransactionId
+	 * @param bool $bRemoveTransaction True if the transaction must be removed
+	 * @return bool True if the transaction is valid, false otherwise
+	 */
+	public static function IsTransactionValid($id, $bRemoveTransaction = true)
+	{
+		$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
+		if (!$bTransactionsEnabled)
+		{
+			return true; // All values are valid
+		}
+		$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
+		if (!class_exists($sClass, false))
+		{
+			$sClass = 'privUITransactionSession';
+		}
+		
+		return $sClass::IsTransactionValid($id, $bRemoveTransaction);
+	}
+
+	/**
+	 * Removes the transaction specified by its id
+	 * @param int $id The Identifier (as returned by GetNewTranscationId) of the transaction to be removed.
+	 * @return void
+	 */
+	public static function RemoveTransaction($id)
+	{
+		$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
+		if (!$bTransactionsEnabled)
+		{
+			return; // Nothing to do
+		}
+		$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
+		if (!class_exists($sClass, false))
+		{
+			$sClass = 'privUITransactionSession';
+		}
+		
+		$sClass::RemoveTransaction($id);
+	}
+}
+
+/**
+ * The original (and by default) mechanism for storing transaction information
+ * as an array in the $_SESSION variable
+ *
+ */
+class privUITransactionSession
 {
 	/**
 	 * Create a new transaction id, store it in the session and return its id
@@ -38,7 +119,7 @@ class privUITransaction
 		// Strictly speaking, the two lines below should be grouped together
 		// by a critical section
 		// sem_acquire($rSemIdentified);
-		$id = str_replace(array('.', ' '), '', microtime()); //1 + count($_SESSION['transactions']);
+		$id = static::GetUserPrefix() . str_replace(array('.', ' '), '', microtime()); //1 + count($_SESSION['transactions']);
 		$_SESSION['transactions'][$id] = true;
 		// sem_release($rSemIdentified);
 		
@@ -93,5 +174,195 @@ class privUITransaction
 			// sem_release($rSemIdentified);
 		}		
 	}
+
+	/**
+	 * Returns a string to prefix transaction ID with info from the current user.
+	 *
+	 * @return string
+	 */
+	protected static function GetUserPrefix()
+	{
+		$sPrefix = 'u'.UserRights::GetUserId();
+		return $sPrefix.'-';
+	}
+}
+
+/**
+ * An alternate implementation for storing the transactions as temporary files
+ * Useful when using an in-memory storage for the session which do not
+ * guarantee mutual exclusion for writing
+ */
+class privUITransactionFile
+{
+	/**
+	 * Create a new transaction id, store it in the session and return its id
+	 * @param void
+	 * @return int The identifier of the new transaction
+	 */
+	public static function GetNewTransactionId()
+	{
+		if (!is_dir(APPROOT.'data/transactions'))
+		{
+			if (!is_writable(APPROOT.'data'))
+			{
+				throw new Exception('The directory "'.APPROOT.'data" must be writable to the application.');
+			}
+			if (!@mkdir(APPROOT.'data/transactions'))
+			{
+				throw new Exception('Failed to create the directory "'.APPROOT.'data/transactions". Ajust the rights on the parent directory or let an administrator create the transactions directory and give the web sever enough rights to write into it.');
+			}
+		}
+		if (!is_writable(APPROOT.'data/transactions'))
+		{
+			throw new Exception('The directory "'.APPROOT.'data/transactions" must be writable to the application.');
+		}
+		self::CleanupOldTransactions();
+		$id = basename(tempnam(APPROOT.'data/transactions', static::GetUserPrefix()));
+		self::Info('GetNewTransactionId: Created transaction: '.$id);
+
+		return (string)$id;
+	}
+
+	/**
+	 * Check whether a transaction is valid or not and (optionally) remove the valid transaction from
+	 * the session so that another call to IsTransactionValid for the same transaction id
+	 * will return false
+	 * @param int $id Identifier of the transaction, as returned by GetNewTransactionId
+	 * @param bool $bRemoveTransaction True if the transaction must be removed
+	 * @return bool True if the transaction is valid, false otherwise
+	 */
+	public static function IsTransactionValid($id, $bRemoveTransaction = true)
+	{
+		$sFilepath = APPROOT.'data/transactions/'.$id;
+		clearstatcache(true, $sFilepath);
+		$bResult = file_exists($sFilepath);
+		if ($bResult)
+		{
+			if ($bRemoveTransaction)
+			{
+				$bResult = @unlink($sFilepath);
+				if (!$bResult)
+				{
+					self::Error('IsTransactionValid: FAILED to remove transaction '.$id);
+				}
+				else
+				{
+					self::Info('IsTransactionValid: OK. Removed transaction: '.$id);
+				}
+			}
+		}
+		else
+		{
+			self::Info("IsTransactionValid: Transaction '$id' not found. Pending transactions for this user:\n".implode("\n", self::GetPendingTransactions()));
+		}
+		return $bResult;
+	}
+
+	/**
+	 * Removes the transaction specified by its id
+	 * @param int $id The Identifier (as returned by GetNewTransactionId) of the transaction to be removed.
+	 * @return void
+	 */
+	public static function RemoveTransaction($id)
+	{
+		$bSuccess = true;
+		$sFilepath = APPROOT.'data/transactions/'.$id;
+		clearstatcache(true, $sFilepath);
+		if(!file_exists($sFilepath))
+		{
+			$bSuccess = false;
+			self::Error("RemoveTransaction: Transaction '$id' not found. Pending transactions for this user:\n".implode("\n", self::GetPendingTransactions()));
+		}
+		$bSuccess = @unlink($sFilepath);
+		if (!$bSuccess)
+		{
+			self::Error('RemoveTransaction: FAILED to remove transaction '.$id);
+		}
+		else
+		{
+			self::Info('RemoveTransaction: OK '.$id);
+		}
+		return $bSuccess;
+	}
+
+	/**
+	 * Cleanup old transactions which have been pending since more than 24 hours
+	 * Use filemtime instead of filectime since filectime may be affected by operations on the directory (like changing the access rights)
+	 */
+	protected static function CleanupOldTransactions()
+	{
+		$iLimit = time() - 24*3600;
+		clearstatcache();
+		$aTransactions = glob(APPROOT.'data/transactions/*-*');
+		foreach($aTransactions as $sFileName)
+		{
+			if (filemtime($sFileName) < $iLimit)
+			{
+				@unlink($sFileName);
+				self::Info('CleanupOldTransactions: Deleted transaction: '.$sFileName);
+			}
+		}
+	}
+
+	/**
+	 * For debugging purposes: gets the pending transactions of the current user
+	 * as an array, with the date of the creation of the transaction file
+	 */
+	protected static function GetPendingTransactions()
+	{
+		clearstatcache();
+		$aResult = array();
+		$aTransactions = glob(APPROOT.'data/transactions/'.self::GetUserPrefix().'*');
+		foreach($aTransactions as $sFileName)
+		{
+			$aResult[] = date('Y-m-d H:i:s', filemtime($sFileName)).' - '.basename($sFileName);
+		}
+		sort($aResult);
+		return $aResult;
+	}
+
+	/**
+	 * Returns a prefix based on the user login instead of its ID for a better usage in tempnam()
+	 *
+	 * @inheritdoc
+	 */
+	protected static function GetUserPrefix()
+	{
+		$sPrefix = substr(UserRights::GetUser(), 0, 10);
+		$sPrefix = preg_replace('/[^a-zA-Z0-9-_]/', '_', $sPrefix);
+		return $sPrefix.'-';
+	}
+
+	protected static function Info($sText)
+	{
+		self::Write('Info | '.$sText);
+	}
+
+	protected static function Warning($sText)
+	{
+		self::Write('Warning | '.$sText);
+	}
+			
+	protected static function Error($sText)
+	{
+		self::Write('Error | '.$sText);
+	}
+	
+	protected static function Write($sText)
+	{
+		$bLogEnabled = MetaModel::GetConfig()->Get('log_transactions');
+		if ($bLogEnabled)
+		{
+		$hLogFile = @fopen(APPROOT.'log/transactions.log', 'a');
+		if ($hLogFile !== false)
+		{
+			flock($hLogFile, LOCK_EX);
+			$sDate = date('Y-m-d H:i:s');
+			fwrite($hLogFile, "$sDate | $sText\n");
+			fflush($hLogFile);
+			flock($hLogFile, LOCK_UN);
+			fclose($hLogFile);
+			}
+		}
+	}
 }
-?>

application/ui.extkeywidget.class.inc.php

@@ -1,31 +1,33 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   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 General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 /**
  * Class UIExtKeyWidget
  * UI wdiget for displaying and editing external keys when
  * A simple drop-down list is not enough...
- * 
+ *
  * The layout is the following
- * 
+ *
  * +-- #label_<id> (input)-------+  +-----------+
  * |                             |  | Browse... |
  * +-----------------------------+  +-----------+
- * 
+ *
  * And the popup dialog has the following layout:
- * 
+ *
  * +------------------- ac_dlg_<id> (div)-----------+
  * + +--- ds_<id> (div)---------------------------+ |
  * | | +------------- fs_<id> (form)------------+ | |
@@ -52,20 +54,23 @@
  * | |   +--------+    +-----+                    | |
  * | +--------------------------------------------+ |
  * +------------------------------------------------+
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
 require_once(APPROOT.'/application/displayblock.class.inc.php');
 
-class UIExtKeyWidget 
+class UIExtKeyWidget
 {
+	const ENUM_OUTPUT_FORMAT_CSV = 'csv';
+	const ENUM_OUTPUT_FORMAT_JSON = 'json';
+
 	protected $iId;
 	protected $sTargetClass;
-	
+	protected $sAttCode;
+	protected $bSearchMode;
+
 	//public function __construct($sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sNameSuffix = '', $sFieldPrefix = '', $sFormPrefix = '')
 	static public function DisplayFromAttCode($oPage, $sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName = '', $sFormPrefix = '', $aArgs, $bSearchMode = false)
 	{
@@ -81,59 +86,80 @@ class UIExtKeyWidget
 		{
 			$sDisplayStyle = 'select'; // In search mode, always use a drop-down list
 		}
-		$oWidget = new UIExtKeyWidget($sTargetClass, $iInputId);
-		return $oWidget->Display($oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix, $aArgs, $bSearchMode, $sDisplayStyle);
+		$oWidget = new UIExtKeyWidget($sTargetClass, $iInputId, $sAttCode, $bSearchMode);
+		return $oWidget->Display($oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix, $aArgs, null, $sDisplayStyle);
 	}
 
-	public function __construct($sTargetClass, $iInputId)
+	public function __construct($sTargetClass, $iInputId, $sAttCode = '', $bSearchMode = false)
 	{
 		$this->sTargetClass = $sTargetClass;
 		$this->iId = $iInputId;
+		$this->sAttCode = $sAttCode;
+		$this->bSearchMode = $bSearchMode;
 	}
-	
+
 	/**
-	 * Get the HTML fragment corresponding to the linkset editing widget
+	 * Get the HTML fragment corresponding to the ext key editing widget
 	 * @param WebPage $oP The web page used for all the output
-	 * @param Hash $aArgs Extra context arguments
+	 * @param array $aArgs Extra context arguments
 	 * @return string The HTML fragment to be inserted into the page
 	 */
-	public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), $bSearchMode = false, $sDisplayStyle = 'select')
+	public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, DBObjectset $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), $bSearchMode = null, $sDisplayStyle = 'select', $bSearchMultiple = true)
 	{
-		$sTitle = addslashes($sTitle);	
+		if (!is_null($bSearchMode))
+		{
+			$this->bSearchMode = $bSearchMode;
+		}
+		$sTitle = addslashes($sTitle);
 		$oPage->add_linked_script('../js/extkeywidget.js');
 		$oPage->add_linked_script('../js/forms-json-utils.js');
-		
-		$bCreate = (!$bSearchMode) && (!MetaModel::IsAbstract($this->sTargetClass)) && (UserRights::IsActionAllowed($this->sTargetClass, UR_ACTION_BULK_MODIFY) && $bAllowTargetCreation);
+
+		$bCreate = (!$this->bSearchMode) && (UserRights::IsActionAllowed($this->sTargetClass, UR_ACTION_BULK_MODIFY) && $bAllowTargetCreation);
 		$bExtensions = true;
 		$sMessage = Dict::S('UI:Message:EmptyList:UseSearchForm');
-		$sAttrFieldPrefix = ($bSearchMode) ? '' : 'attr_';
+		$sAttrFieldPrefix = ($this->bSearchMode) ? '' : 'attr_';
 
-		$sHTMLValue = "<span style=\"white-space:nowrap\">"; // no wrap
+		$sHTMLValue = "<div class=\"field_input_zone field_input_extkey\">";
 		$sFilter = addslashes($oAllowedValues->GetFilter()->ToOQL());
-		if($bSearchMode)
+		if($this->bSearchMode)
 		{
 			$sWizHelper = 'null';
 			$sWizHelperJSON = "''";
-		} 
+			$sJSSearchMode = 'true';
+		}
 		else
 		{
-			$sWizHelper = 'oWizardHelper'.$sFormPrefix;
-			$sWizHelperJSON = $sWizHelper.'.ToJSON()';
+			if (isset($aArgs['wizHelper']))
+			{
+				$sWizHelper = $aArgs['wizHelper'];
+			}
+			else
+			{
+				$sWizHelper = 'oWizardHelper'.$sFormPrefix;
+			}
+			$sWizHelperJSON = $sWizHelper.'.UpdateWizardToJSON()';
+			$sJSSearchMode = 'false';
 		}
 		if (is_null($oAllowedValues))
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
-		elseif ($oAllowedValues->Count() < $iMaxComboLength)
+		$oAllowedValues->SetShowObsoleteData(utils::ShowObsoleteData());
+		// Don't automatically launch the search if the table is huge
+		$bDoSearch = !utils::IsHighCardinality($this->sTargetClass);
+		$sJSDoSearch = $bDoSearch ? 'true' : 'false';
+
+		// We just need to compare the number of entries with MaxComboLength, so no need to get the real count.
+		if (!$oAllowedValues->CountExceeds($iMaxComboLength))
 		{
-			// Discrete list of values, use a SELECT or RADIO buttons depending on the config
+            // Discrete list of values, use a SELECT or RADIO buttons depending on the config
 			switch($sDisplayStyle)
 			{
 				case 'radio':
 				case 'radio_horizontal':
 				case 'radio_vertical':
-				$sValidationField = "<span id=\"v_{$this->iId}\"></span>";
-				$sHTMLValue = '';
+				$sValidationField = null;
+
 				$bVertical = ($sDisplayStyle != 'radio_horizontal');
 				$bExtensions = false;
 				$oAllowedValues->Rewind();
@@ -141,48 +167,78 @@ class UIExtKeyWidget
 				while($oObj = $oAllowedValues->Fetch())
 				{
 					$aAllowedValues[$oObj->GetKey()] = $oObj->GetName();
-				}				
-				$sHTMLValue = $oPage->GetRadioButtons($aAllowedValues, $value, $this->iId, "{$sAttrFieldPrefix}{$sFieldName}", $bMandatory, $bVertical, $sValidationField);
+				}
+				$sHTMLValue .= $oPage->GetRadioButtons($aAllowedValues, $value, $this->iId, "{$sAttrFieldPrefix}{$sFieldName}", false /*  $bMandatory will be placed manually */, $bVertical, $sValidationField);
 				$aEventsList[] ='change';
 				break;
 
 				case 'select':
+				case 'list':
 				default:
-				$sSelectMode = 'true';
-				
+
 				$sHelpText = ''; //$this->oAttDef->GetHelpOnEdition();
-				
-				$sHTMLValue = "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
-				if ($bSearchMode)
+				$sHTMLValue .= "<div class=\"field_select_wrapper\">\n";
+
+				if ($this->bSearchMode)
 				{
-					$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : Dict::S('UI:SearchValue:Any');
-					$sHTMLValue .= "<option value=\"\">$sDisplayValue</option>\n";			
+					if ($bSearchMultiple)
+					{
+						$sHTMLValue .= "<select class=\"multiselect\" multiple title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}[]\" id=\"$this->iId\">\n";
+					}
+					else
+					{
+						$sHTMLValue .= "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
+						$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : Dict::S('UI:SearchValue:Any');
+						$sHTMLValue .= "<option value=\"\">$sDisplayValue</option>\n";
+					}
 				}
 				else
 				{
+					$sHTMLValue .= "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
 					$sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
 				}
+
 				$oAllowedValues->Rewind();
 				while($oObj = $oAllowedValues->Fetch())
 				{
 					$key = $oObj->GetKey();
 					$display_value = $oObj->GetName();
-	
+
 					if (($oAllowedValues->Count() == 1) && ($bMandatory == 'true') )
 					{
 						// When there is only once choice, select it by default
-						$sSelected = ' selected';
+						$sSelected = 'selected';
+						$oPage->add_ready_script(
+							<<<EOF
+$('#$this->iId').attr('data-validate','dependencies');
+EOF
+						);
 					}
 					else
 					{
-						$sSelected = ($value == $key) ? ' selected' : '';
+						$sSelected = (is_array($value) && in_array($key, $value)) || ($value == $key) ? 'selected' : '';
 					}
-					$sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
+					$sHTMLValue .= "<option value=\"$key\" $sSelected>$display_value</option>\n";
 				}
 				$sHTMLValue .= "</select>\n";
+				$sHTMLValue .= "</div>\n";
+
+				if (($this->bSearchMode) && $bSearchMultiple)
+				{
+					$aOptions = array(
+						'header' => true,
+						'checkAllText' => Dict::S('UI:SearchValue:CheckAll'),
+						'uncheckAllText' => Dict::S('UI:SearchValue:UncheckAll'),
+						'noneSelectedText' => Dict::S('UI:SearchValue:Any'),
+						'selectedText' => Dict::S('UI:SearchValue:NbSelected'),
+						'selectedList' => 1,
+					);
+					$sJSOptions = json_encode($aOptions);
+					$oPage->add_ready_script("$('.multiselect').multiselect($sJSOptions);");
+				}
 				$oPage->add_ready_script(
 <<<EOF
-		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', true, $sWizHelper);
+		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', true, $sWizHelper, '{$this->sAttCode}', $sJSSearchMode, $sJSDoSearch);
 		oACWidget_{$this->iId}.emptyHtml = "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>$sMessage</p></div>";
 		$('#$this->iId').bind('update', function() { oACWidget_{$this->iId}.Update(); } );
 		$('#$this->iId').bind('change', function() { $(this).trigger('extkeychange') } );
@@ -194,8 +250,15 @@ EOF
 		else
 		{
 			// Too many choices, use an autocomplete
-			$sSelectMode = 'false';
-		
+			// Check that the given value is allowed
+			$oSearch = $oAllowedValues->GetFilter();
+			$oSearch->AddCondition('id', $value);
+			$oSet = new DBObjectSet($oSearch);
+			if ($oSet->Count() == 0)
+			{
+				$value = null;
+			}
+
 			if (is_null($value) || ($value == 0)) // Null values are displayed as ''
 			{
 				$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : '';
@@ -205,21 +268,21 @@ EOF
 				$sDisplayValue = $this->GetObjectName($value);
 			}
 			$iMinChars = isset($aArgs['iMinChars']) ? $aArgs['iMinChars'] : 3; //@@@ $this->oAttDef->GetMinAutoCompleteChars();
-			$iFieldSize = isset($aArgs['iFieldSize']) ? $aArgs['iFieldSize'] : 30; //@@@ $this->oAttDef->GetMaxSize();
-	
+
 			// the input for the auto-complete
-			$sHTMLValue = "<input count=\"".$oAllowedValues->Count()."\" type=\"text\" id=\"label_$this->iId\" size=\"$iFieldSize\" value=\"$sDisplayValue\"/>&nbsp;";
-			$sHTMLValue .= "<img id=\"mini_search_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_search.gif\" onClick=\"oACWidget_{$this->iId}.Search();\"/>&nbsp;";
-	
+			$sHTMLValue .= "<input class=\"field_autocomplete\" type=\"text\" id=\"label_$this->iId\" value=\"$sDisplayValue\"/>";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><img id=\"mini_search_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_search.gif?t=".utils::GetCacheBusterTimestamp()."\" onClick=\"oACWidget_{$this->iId}.Search();\"/></span>";
+
 			// another hidden input to store & pass the object's Id
-			$sHTMLValue .= "<input type=\"hidden\" id=\"$this->iId\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" value=\"$value\" />\n";
-	
+			$sHTMLValue .= "<input type=\"hidden\" id=\"$this->iId\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" />\n";
+
+			$JSSearchMode = $this->bSearchMode ? 'true' : 'false';
 			// Scripts to start the autocomplete and bind some events to it
 			$oPage->add_ready_script(
 <<<EOF
-		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', false, $sWizHelper);
+		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', false, $sWizHelper, '{$this->sAttCode}', $sJSSearchMode, $sJSDoSearch);
 		oACWidget_{$this->iId}.emptyHtml = "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>$sMessage</p></div>";
-		$('#label_$this->iId').autocomplete(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', { scroll:true, minChars:{$iMinChars}, autoFill:false, matchContains:true, mustMatch: true, keyHolder:'#{$this->iId}', extraParams:{operation:'ac_extkey', sTargetClass:'{$this->sTargetClass}',sFilter:'$sFilter', json: function() { return $sWizHelperJSON; } }});
+		$('#label_$this->iId').autocomplete(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', { scroll:true, minChars:{$iMinChars}, autoFill:false, matchContains:true, mustMatch: true, keyHolder:'#{$this->iId}', extraParams:{operation:'ac_extkey', sTargetClass:'{$this->sTargetClass}',sFilter:'$sFilter',bSearchMode:$JSSearchMode, json: function() { return $sWizHelperJSON; } }});
 		$('#label_$this->iId').keyup(function() { if ($(this).val() == '') { $('#$this->iId').val(''); } } ); // Useful for search forms: empty value in the "label", means no value, immediatly !
 		$('#label_$this->iId').result( function(event, data, formatted) { OnAutoComplete('{$this->iId}', event, data, formatted); } );
 		$('#$this->iId').bind('update', function() { oACWidget_{$this->iId}.Update(); } );
@@ -232,7 +295,7 @@ EOF
 		}
 		if ($bExtensions && MetaModel::IsHierarchicalClass($this->sTargetClass) !== false)
 		{
-			$sHTMLValue .= "<img id=\"mini_tree_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_tree.gif\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"/>&nbsp;";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><img id=\"mini_tree_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_tree.gif?t=".utils::GetCacheBusterTimestamp()."\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"/></span>";
 			$oPage->add_ready_script(
 <<<EOF
 			if ($('#ac_tree_{$this->iId}').length == 0)
@@ -244,7 +307,9 @@ EOF
 		}
 		if ($bCreate && $bExtensions)
 		{
-			$sHTMLValue .= "<img id=\"mini_add_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_add.gif\" onClick=\"oACWidget_{$this->iId}.CreateObject();\"/>&nbsp;";
+			$sCallbackName = (MetaModel::IsAbstract($this->sTargetClass)) ? 'SelectObjectClass' : 'CreateObject';
+
+			$sHTMLValue .= "<span class=\"field_input_btn\"><img id=\"mini_add_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_add.gif?t=".utils::GetCacheBusterTimestamp()."\" onClick=\"oACWidget_{$this->iId}.{$sCallbackName}();\"/></span>";
 			$oPage->add_ready_script(
 <<<EOF
 		if ($('#ajax_{$this->iId}').length == 0)
@@ -254,22 +319,47 @@ EOF
 EOF
 );
 		}
-		if ($sDisplayStyle == 'select')
-		{
-			$sHTMLValue .= "<span id=\"v_{$this->iId}\"></span>";
-		}
-		$sHTMLValue .= "</span>"; // end of no wrap
+        $sHTMLValue .= "</div>";
+
+		// Note: This test is no longer necessary as we changed the markup to extract validation decoration in the standard .field_input_xxx container
+		//if (($sDisplayStyle == 'select') || ($sDisplayStyle == 'list'))
+		//{
+			$sHTMLValue .= "<span class=\"form_validation\" id=\"v_{$this->iId}\"></span><span class=\"field_status\" id=\"fstatus_{$this->iId}\"></span>";
+		//}
+
 		return $sHTMLValue;
 	}
-	
-	public function GetSearchDialog(WebPage $oPage, $sTitle)
+
+	public function GetSearchDialog(WebPage $oPage, $sTitle, $oCurrObject = null)
 	{
 		$sHTML = '<div class="wizContainer" style="vertical-align:top;"><div id="dc_'.$this->iId.'">';
 
-		$oFilter = new DBObjectSearch($this->sTargetClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'search', false);
-		$sHTML .= $oBlock->GetDisplay($oPage, $this->iId, array('open' => true, 'currentId' => $this->iId));
+		if ( ($oCurrObject != null) && ($this->sAttCode != ''))
+		{
+			$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
+			/** @var \DBObject $oCurrObject */
+			$aArgs = $oCurrObject->ToArgsForQuery();
+			$aParams = array('query_params' => $aArgs);
+			$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aArgs);
+			$oFilter = $oSet->GetFilter();
+		}
+		else
+		{
+			$aParams = array();
+			$oFilter = new DBObjectSearch($this->sTargetClass);
+		}
+		$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
+		$oBlock = new DisplayBlock($oFilter, 'search', false, $aParams);
+		$sHTML .= $oBlock->GetDisplay($oPage, $this->iId,
+            array(
+                'menu' => false,
+                'currentId' => $this->iId,
+                'table_id' => "dr_{$this->iId}",
+                'table_inner_id' => "{$this->iId}_results",
+                'selection_mode' => true,
+                'selection_type' => 'single',
+                'cssCount' => '#count_'.$this->iId)
+        );
 		$sHTML .= "<form id=\"fr_{$this->iId}\" OnSubmit=\"return oACWidget_{$this->iId}.DoOk();\">\n";
 		$sHTML .= "<div id=\"dr_{$this->iId}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
 		$sHTML .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
@@ -293,9 +383,13 @@ EOF
 
 	/**
 	 * Search for objects to be selected
+	 *
 	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
+	 * @param $sFilter
 	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of m_sRemoteClass
-	 * @param Array $aAlreadyLinkedIds List of IDs of objects of "remote" class already linked, to be filtered out of the search
+	 * @param null $oObj
+	 *
+	 * @throws \OQLException
 	 */
 	public function SearchObjectsToSelect(WebPage $oP, $sFilter, $sRemoteClass = '', $oObj = null)
 	{
@@ -303,57 +397,155 @@ EOF
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
-		try
+
+		$oFilter = DBObjectSearch::FromOQL($sFilter);
+		if (strlen($sRemoteClass) > 0)
 		{
-			$oFilter = DBObjectSearch::FromOQL($sFilter);
-			$oBlock = new DisplayBlock($oFilter, 'list', false);
-			$oBlock->Display($oP, $this->iId.'_results', array('this' => $oObj, 'cssCount'=> '#count_'.$this->iId, 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single')); // Don't display the 'Actions' menu on the results
-		}
-		catch(MissingQueryArgument $e)
-		{
-			// When used in a search form the $this parameter may be missing, in this case return all possible values...
-			// TODO check if we can improve this behavior...
-			$sOQL = 'SELECT '.$sRemoteClass;
-			$oFilter = DBObjectSearch::FromOQL($sOQL);
-			$oBlock = new DisplayBlock($oFilter, 'list', false);
-			$oBlock->Display($oP, $this->iId.'_results', array('cssCount'=> '#count_'.$this->iId, 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single')); // Don't display the 'Actions' menu on the results
+			$oFilter->ChangeClass($sRemoteClass);
 		}
+		$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
+
+		// Current extkey value, so we can display event if it is not available anymore (eg. archived).
+		$iCurrentExtKeyId = (is_null($oObj)) ? 0 : $oObj->Get($this->sAttCode);
+
+		$oBlock = new DisplayBlock($oFilter, 'list_search', false, array('query_params' => array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId)));
+		$oBlock->Display($oP, $this->iId.'_results', array('this' => $oObj, 'cssCount'=> '#count_'.$this->iId, 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single', 'table_id' => 'select_'.$this->sAttCode)); // Don't display the 'Actions' menu on the results
 	}
-	
-	/**
-	 * Search for objects to be selected
-	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
-	 * @param string $sFilter The OQL expression used to define/limit limit the scope of possible values
-	 * @param DBObject $oObj The current object for the OQL context
-	 * @param string $sContains The text of the autocomplete to filter the results
-	 */
-	public function AutoComplete(WebPage $oP, $sFilter, $oObj = null, $sContains)
+
+    /**
+     * Search for objects to be selected
+     *
+     * @param WebPage  $oP        The page used for the output (usually an AjaxWebPage)
+     * @param string   $sFilter   The OQL expression used to define/limit limit the scope of possible values
+     * @param DBObject $oObj      The current object for the OQL context
+     * @param string   $sContains The text of the autocomplete to filter the results
+     * @param string   $sOutputFormat
+     * @param null     $sOperation for the values @see ValueSetObjects->LoadValues()
+     *
+     * @throws CoreException
+     * @throws OQLException
+     */
+	public function AutoComplete(WebPage $oP, $sFilter, $oObj = null, $sContains, $sOutputFormat = self::ENUM_OUTPUT_FORMAT_CSV, $sOperation = null)
 	{
 		if (is_null($sFilter))
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
+
+        // Current extkey value, so we can display event if it is not available anymore (eg. archived).
+        $iCurrentExtKeyId = (is_null($oObj) || $this->sAttCode === '') ? 0 : $oObj->Get($this->sAttCode);
+
 		$oValuesSet = new ValueSetObjects($sFilter, 'friendlyname'); // Bypass GetName() to avoid the encoding by htmlentities
-		$aValues = $oValuesSet->GetValues(array('this' => $oObj), $sContains);
-		foreach($aValues as $sKey => $sFriendlyName)
+		$iMax = 150;
+		$oValuesSet->SetLimit($iMax);
+		$oValuesSet->SetSort(false);
+		$oValuesSet->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
+		$oValuesSet->SetLimit($iMax);
+		$aValuesContains = $oValuesSet->GetValues(array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId), $sContains, 'contains');
+		asort($aValuesContains);
+		$aValues = array();
+		foreach($aValuesContains as $sKey => $sFriendlyName)
 		{
-			$oP->add(trim($sFriendlyName)."\t".$sKey."\n");
+			if (!isset($aValues[$sKey]))
+			{
+				$aValues[$sKey] = $sFriendlyName;
+			}
+		}
+
+		switch($sOutputFormat)
+		{
+			case static::ENUM_OUTPUT_FORMAT_JSON:
+
+			    $aJsonMap = array();
+			    foreach ($aValues as $sKey => $sLabel)
+                {
+                    $aJsonMap[] = array('value' => $sKey, 'label' => $sLabel);
+                }
+
+			    $oP->SetContentType('application/json');
+                $oP->add(json_encode($aJsonMap));
+				break;
+
+			case static::ENUM_OUTPUT_FORMAT_CSV:
+				foreach($aValues as $sKey => $sFriendlyName)
+				{
+					$oP->add(trim($sFriendlyName)."\t".$sKey."\n");
+				}
+				break;
+			default:
+				throw new Exception('Invalid output format, "'.$sOutputFormat.'" given.');
+				break;
 		}
 	}
-	
+
 	/**
 	 * Get the display name of the selected object, to fill back the autocomplete
 	 */
 	public function GetObjectName($iObjId)
 	{
-		$oObj = MetaModel::GetObject($this->sTargetClass, $iObjId);
-		return $oObj->GetName();
+		$aModifierProps = array();
+		$aModifierProps['UserRightsGetSelectFilter']['bSearchMode'] = $this->bSearchMode;
+
+		$oObj = MetaModel::GetObject($this->sTargetClass, $iObjId, false, false, $aModifierProps);
+		if ($oObj)
+		{
+			return $oObj->GetName();
+		}
+		else
+		{
+			return '';
+		}
 	}
-	
+
+	/**
+	 * Get the form to select a leaf class from the $this->sTargetClass (that should be abstract)
+	 * Note: Inspired from UILinksWidgetDirect::GetObjectCreationDialog()
+	 *
+	 * @param WebPage $oPage
+	 *
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 */
+	public function GetClassSelectionForm(WebPage $oPage)
+	{
+        // For security reasons: check that the "proposed" class is actually a subclass of the linked class
+        // and that the current user is allowed to create objects of this class
+        $aSubClasses = MetaModel::EnumChildClasses($this->sTargetClass);
+        $aPossibleClasses = array();
+        foreach($aSubClasses as $sCandidateClass)
+        {
+            if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
+            {
+                $aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass);
+            }
+        }
+
+        $sDialogTitle = '';
+        $oPage->add('<div id="ac_create_'.$this->iId.'"><div class="wizContainer" style="vertical-align:top;"><div id="dcr_'.$this->iId.'">');
+        $oPage->add('<form>');
+
+		$sClassLabel = MetaModel::GetName($this->sTargetClass);
+		$oPage->add('<p>'.Dict::Format('UI:SelectTheTypeOf_Class_ToCreate', $sClassLabel));
+		$oPage->add('<nobr><select name="class">');
+		asort($aPossibleClasses);
+		foreach($aPossibleClasses as $sClassName => $sClassLabel)
+		{
+			$oPage->add("<option value=\"$sClassName\">$sClassLabel</option>");
+		}
+		$oPage->add('</select>');
+		$oPage->add('&nbsp; <button type="submit" class="action" style="margin-top:15px;"><span>' . Dict::S('UI:Button:Ok') . '</span></button></nobr></p>');
+
+        $oPage->add('</form>');
+        $oPage->add('</div></div></div>');
+        $oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: 'auto', height: 'auto', maxHeight: $(window).height() - 50, autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
+        $oPage->add_ready_script("$('#dcr_{$this->iId} form').removeAttr('onsubmit');");
+        $oPage->add_ready_script("$('#dcr_{$this->iId} form').bind('submit.uilinksWizard', oACWidget_{$this->iId}.DoSelectObjectClass);");
+	}
+
 	/**
 	 * Get the form to create a new object of the 'target' class
 	 */
-	public function GetObjectCreationForm(WebPage $oPage)
+	public function GetObjectCreationForm(WebPage $oPage, $oCurrObject, $aPrefillFormParam)
 	{
 		// Set all the default values in an object and clone this "default" object
 		$oNewObj = MetaModel::NewObject($this->sTargetClass);
@@ -361,17 +553,44 @@ EOF
 		// 1st - set context values
 		$oAppContext = new ApplicationContext();
 		$oAppContext->InitObjectFromContext($oNewObj);
+		$oNewObj->PrefillForm('creation_from_extkey', $aPrefillFormParam);
+		// 2nd set the default values from the constraint on the external key... if any
+		if ( ($oCurrObject != null) && ($this->sAttCode != ''))
+		{
+			$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
+			$aParams = array('this' => $oCurrObject);
+			$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aParams);
+			$aConsts = $oSet->ListConstantFields();
+			$sClassAlias = $oSet->GetFilter()->GetClassAlias();
+			if (isset($aConsts[$sClassAlias]))
+			{
+				foreach($aConsts[$sClassAlias] as $sAttCode => $value)
+				{
+					$oNewObj->Set($sAttCode, $value);
+				}
+			}
+		}
 
-		// 2nd - set values from the page argument 'default'
+		// 3rd - set values from the page argument 'default'
 		$oNewObj->UpdateObjectFromArg('default');
 
-		$sDialogTitle = addslashes($this->sTitle);
+		$sDialogTitle = '';
 		$oPage->add('<div id="ac_create_'.$this->iId.'"><div class="wizContainer" style="vertical-align:top;"><div id="dcr_'.$this->iId.'">');
 		$oPage->add("<h1>".MetaModel::GetClassIcon($this->sTargetClass)."&nbsp;".Dict::Format('UI:CreationTitle_Class', MetaModel::GetName($this->sTargetClass))."</h1>\n");
-	 	cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, array(), array('formPrefix' => $this->iId, 'noRelations' => true));	
+		$aFieldsFlags = array();
+		$aFieldsComments = array();
+		foreach(MetaModel::ListAttributeDefs($this->sTargetClass) as $sAttCode => $oAttDef)
+		{
+			if (($oAttDef instanceof AttributeBlob) || (false))
+			{
+				$aFieldsFlags[$sAttCode] = OPT_ATT_READONLY;
+				$aFieldsComments[$sAttCode] = '&nbsp;<img src="../images/transp-lock.png" style="vertical-align:middle" title="'.htmlentities(Dict::S('UI:UploadNotSupportedInThisMode')).'"/>';
+			}
+		}
+	 	cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, array(), array('formPrefix' => $this->iId, 'noRelations' => true, 'fieldsFlags' => $aFieldsFlags, 'fieldsComments' => $aFieldsComments));
 		$oPage->add('</div></div></div>');
 //		$oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: $(window).width()*0.8, height: 'auto', autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
-		$oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: 'auto', height: 'auto', autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
+		$oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: 'auto', height: 'auto', maxHeight: $(window).height() - 50, autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
 		$oPage->add_ready_script("$('#dcr_{$this->iId} form').removeAttr('onsubmit');");
 		$oPage->add_ready_script("$('#dcr_{$this->iId} form').bind('submit.uilinksWizard', oACWidget_{$this->iId}.DoCreateObject);");
 	}
@@ -388,19 +607,12 @@ EOF
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
-		try
-		{
-			$oFilter = DBObjectSearch::FromOQL($sFilter);
-			$oSet = new DBObjectSet($oFilter, array(), array('this' => $oObj));
-		}
-		catch(MissingQueryArgument $e)
-		{
-			// When used in a search form the $this parameter may be missing, in this case return all possible values...
-			// TODO check if we can improve this behavior...
-			$sOQL = 'SELECT '.$this->m_sTargetClass;
-			$oFilter = DBObjectSearch::FromOQL($sOQL);
-			$oSet = new DBObjectSet($oFilter);
-		}
+
+	    $oFilter = DBObjectSearch::FromOQL($sFilter);
+		$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
+		$oSet = new DBObjectSet($oFilter, array(), array('this' => $oObj, 'current_extkey_id' => $currValue));
+
+		$oSet->SetShowObsoleteData(utils::ShowObsoleteData());
 
 		$sHKAttCode = MetaModel::IsHierarchicalClass($this->sTargetClass);
 		$this->DumpTree($oPage, $oSet, $sHKAttCode, $currValue);
@@ -409,7 +621,7 @@ EOF
 		$oPage->add('</div>');
 		$oPage->add("<input type=\"button\" id=\"btn_cancel_{$this->iId}\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#dlg_tree_{$this->iId}').dialog('close');\">&nbsp;&nbsp;");
 		$oPage->add("<input type=\"button\" id=\"btn_ok_{$this->iId}\" value=\"".Dict::S('UI:Button:Ok')."\"  onClick=\"oACWidget_{$this->iId}.DoHKOk();\">");
-		
+
 		$oPage->add('</div></div>');
 		$oPage->add_ready_script("\$('#tree_$this->iId ul').treeview();\n");
 		$oPage->add_ready_script("\$('#dlg_tree_$this->iId').dialog({ width: 'auto', height: 'auto', autoOpen: true, modal: true, title: '$sDialogTitle', resizeStop: oACWidget_{$this->iId}.OnHKResize, close: oACWidget_{$this->iId}.OnHKClose });\n");
@@ -420,21 +632,23 @@ EOF
 	 */
 	public function DoCreateObject($oPage)
 	{
-		$oObj = MetaModel::NewObject($this->sTargetClass);
-		$aErrors = $oObj->UpdateObjectFromPostedForm($this->iId);
-		if (count($aErrors) == 0)
+		try
 		{
-			$oMyChange = MetaModel::NewObject("CMDBChange");
-			$oMyChange->Set("date", time());
-			$sUserString = CMDBChange::GetCurrentUserName();
-			$oMyChange->Set("userinfo", $sUserString);
-			$iChangeId = $oMyChange->DBInsert();
-			$oObj->DBInsertTracked($oMyChange);
-			return array('name' => $oObj->GetName(), 'id' => $oObj->GetKey());
+			$oObj = MetaModel::NewObject($this->sTargetClass);
+			$aErrors = $oObj->UpdateObjectFromPostedForm($this->iId);
+			if (count($aErrors) == 0)
+			{
+				$oObj->DBInsert();
+				return array('name' => $oObj->GetName(), 'id' => $oObj->GetKey());
+			}
+			else
+			{
+				return array('error' => implode(' ', $aErrors), 'id' => 0);
+			}
 		}
-		else
+		catch(Exception $e)
 		{
-			return array('name' => implode(' ', $aErrors), 'id' => 0);		
+			return array('error' => $e->getMessage(), 'id' => 0);
 		}
 	}
 
@@ -452,7 +666,7 @@ EOF
 			$aTree[$iParentId][$oObj->GetKey()] = $oObj->GetName();
 			$aNodes[$oObj->GetKey()] = $oObj;
 		}
-		
+
 		$aParents = array_keys($aTree);
 		$aRoots = array();
 		foreach($aParents as $id)
@@ -467,7 +681,7 @@ EOF
 			$this->DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue);
 		}
 	}
-	
+
 	function DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue)
 	{
 		$bSelect = true;
@@ -478,6 +692,7 @@ EOF
 			$aSortedRoots = $aTree[$iRootId];
 			asort($aSortedRoots);
 			$oP->add("<ul>\n");
+			$fUniqueId = microtime(true);
 			foreach($aSortedRoots as $id => $sName)
 			{
 				if ($bSelect)
@@ -485,14 +700,14 @@ EOF
 					$sChecked = ($aNodes[$id]->GetKey() == $currValue) ? 'checked' : '';
 					if ($bMultiple)
 					{
-						$sSelect = '<input type="checkbox" value="'.$aNodes[$id]->GetKey().'" name="selectObject[]" '.$sChecked.'>&nbsp;';
+						$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="checkbox" value="'.$aNodes[$id]->GetKey().'" name="selectObject[]" '.$sChecked.'>&nbsp;';
 					}
 					else
 					{
-						$sSelect = '<input type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;';
+						$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;';
 					}
 				}
-				$oP->add('<li>'.$sSelect.$aNodes[$id]->GetHyperlink());
+				$oP->add('<li>'.$sSelect.'<label for="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'">'.$aNodes[$id]->GetName().'</label>');
 				$this->DumpNodes($oP, $id, $aTree, $aNodes, $currValue);
 				$oP->add("</li>\n");
 			}
@@ -501,4 +716,3 @@ EOF
 	}
 
 }
-?>

application/ui.htmleditorwidget.class.inc.php

@@ -1,32 +1,34 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2016 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   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 General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class UIHTMLEditorWidget
  * UI wdiget for displaying and editing one-way encrypted passwords
  *
- * @author      Phil Eddies
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @author      Romain Quetiez
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class UIHTMLEditorWidget 
 {
 	protected $m_iId;
+	protected $m_oAttDef;
 	protected $m_sAttCode;
 	protected $m_sNameSuffix;
 	protected $m_sFieldPrefix;
@@ -35,10 +37,11 @@ class UIHTMLEditorWidget
 	protected $m_sValue;
 	protected $m_sMandatory;
 	
-	public function __construct($iInputId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $sValue, $sMandatory)
+	public function __construct($iInputId, $oAttDef, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $sValue, $sMandatory)
 	{
 		$this->m_iId = $iInputId;
-		$this->m_sAttCode = $sAttCode;
+		$this->m_oAttDef = $oAttDef;
+		$this->m_sAttCode = $oAttDef->GetCode();
 		$this->m_sNameSuffix = $sNameSuffix;
 		$this->m_sHelpText = $sHelpText;
 		$this->m_sValidationField = $sValidationField;
@@ -61,14 +64,30 @@ class UIHTMLEditorWidget
 		$sHelpText = $this->m_sHelpText;
 		$sValidationField = $this->m_sValidationField;
 
-		$sHtmlValue = "<table><tr><td><textarea class=\"htmlEditor\" title=\"$sHelpText\" name=\"attr_{$this->m_sFieldPrefix}{$sCode}\" rows=\"10\" cols=\"10\" id=\"$iId\">$sValue</textarea></td><td>$sValidationField</td></tr></table>";
+		$sHtmlValue = "<div class=\"field_input_zone field_input_html\"><textarea class=\"htmlEditor\" title=\"$sHelpText\" name=\"attr_{$this->m_sFieldPrefix}{$sCode}\" rows=\"10\" cols=\"10\" id=\"$iId\">$sValue</textarea></div>$sValidationField";
 
 		// Replace the text area with CKEditor
 		// To change the default settings of the editor,
 		// a) edit the file /js/ckeditor/config.js
 		// b) or override some of the configuration settings, using the second parameter of ckeditor()
+		$aConfig = array();
 		$sLanguage = strtolower(trim(UserRights::GetUserLanguage()));
-		$oPage->add_ready_script("$('#$iId').ckeditor(function() { /* callback code */ }, { language : '$sLanguage' , contentsLanguage : '$sLanguage', extraPlugins: 'disabler' });"); // Transform $iId into a CKEdit
+		$aConfig['language'] = $sLanguage;
+		$aConfig['contentsLanguage'] = $sLanguage;
+		$aConfig['extraPlugins'] = 'disabler';
+		$sWidthSpec = addslashes(trim($this->m_oAttDef->GetWidth()));
+		if ($sWidthSpec != '')
+		{
+			$aConfig['width'] = $sWidthSpec;
+		}
+		$sHeightSpec = addslashes(trim($this->m_oAttDef->GetHeight()));
+		if ($sHeightSpec != '')
+		{
+			$aConfig['height'] = $sHeightSpec;
+		}
+		$sConfigJS = json_encode($aConfig);
+
+		$oPage->add_ready_script("$('#$iId').ckeditor(function() { /* callback code */ }, $sConfigJS);"); // Transform $iId into a CKEdit
 
 		// Please read...
 		// ValidateCKEditField triggers a timer... calling itself indefinitely
@@ -79,9 +98,26 @@ class UIHTMLEditorWidget
 
 		// Could also be bound to 'instanceReady.ckeditor'
 		$oPage->add_ready_script("$('#$iId').bind('validate', function(evt, sFormId) { return ValidateCKEditField('$iId', '', {$this->m_sMandatory}, sFormId, '') } );\n");
-		$oPage->add_ready_script("$('#$iId').bind('update', function() { BlockField('cke_$iId', $('#$iId').attr('disabled')); } );\n");
-
+		$oPage->add_ready_script(
+				<<<EOF
+$('#$iId').bind('update', function(evt){
+	BlockField('cke_$iId', $('#$iId').prop('disabled'));
+	//Delayed execution - ckeditor must be properly initialized before setting readonly
+	var retryCount = 0;
+	var oMe = $('#$iId');
+	var delayedSetReadOnly = function () {
+		if (oMe.data('ckeditorInstance').editable() == undefined && retryCount++ < 10) {
+			setTimeout(delayedSetReadOnly, retryCount * 100); //Wait a while longer each iteration
+		}
+		else
+		{
+			oMe.data('ckeditorInstance').setReadOnly(oMe.prop('disabled'));
+		}
+	};
+	setTimeout(delayedSetReadOnly, 50);
+});
+EOF
+		);
 		return $sHtmlValue;
 	}
 }
-?>

application/ui.linksdirectwidget.class.inc.php

@@ -0,0 +1,533 @@
+<?php
+// Copyright (C) 2010-2017 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/>
+
+/**
+ * Class UILinksWidgetDirect
+ *  
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */ 
+
+class UILinksWidgetDirect
+{
+	protected $sClass;
+	protected $sAttCode;
+	protected $sInputid;
+	protected $sNameSuffix;
+	protected $sLinkedClass;
+
+	/**
+	 * UILinksWidgetDirect constructor.
+	 * @param string $sClass
+	 * @param string $sAttCode
+	 * @param string $sInputId
+	 * @param string $sNameSuffix
+	 */
+	public function __construct($sClass, $sAttCode, $sInputId, $sNameSuffix = '')
+	{
+		$this->sClass = $sClass;
+		$this->sAttCode = $sAttCode;
+		$this->sInputid = $sInputId;
+		$this->sNameSuffix = $sNameSuffix;
+		$this->aZlist = array();
+		$this->sLinkedClass = '';
+		
+		// Compute the list of attributes visible from the given objet:
+		// All the attributes from the "list" Zlist of the Link class except
+		// the ExternalKey that points to the current object and its related external fields
+		$oLinksetDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+		$this->sLinkedClass = $oLinksetDef->GetLinkedClass();
+		$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+		switch($oLinksetDef->GetEditMode())
+		{
+			case LINKSET_EDITMODE_INPLACE: // The whole linkset can be edited 'in-place'
+			$aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'details'));
+			break;
+			
+			default:
+			$aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'list'));
+			array_unshift($aZList, 'friendlyname');
+		}
+		foreach($aZList as $sLinkedAttCode)
+		{
+			if ($sLinkedAttCode != $sExtKeyToMe)
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode);
+				
+				if ((!$oAttDef->IsExternalField() || ($oAttDef->GetKeyAttCode() != $sExtKeyToMe)) &&
+					(!$oAttDef->IsLinkSet()) )
+				{
+					$this->aZlist[] = $sLinkedAttCode;
+				}
+			}
+		}
+		
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObjectSet|ormLinkSet $oValue
+	 * @param array $aArgs
+	 * @param string $sFormPrefix
+	 * @param DBObject $oCurrentObj
+	 */
+	public function Display(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj)
+	{
+		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		switch($oLinksetDef->GetEditMode())
+		{
+			case LINKSET_EDITMODE_NONE: // The linkset is read-only
+			$this->DisplayAsBlock($oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, false /* bDisplayMenu*/);
+			break;
+			
+			case LINKSET_EDITMODE_ADDONLY: // The only possible action is to open (in a new window) the form to create a new object
+			if ($oCurrentObj && !$oCurrentObj->IsNew())
+			{
+				$sTargetClass = $oLinksetDef->GetLinkedClass();
+				$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+				$sDefault = "default[$sExtKeyToMe]=".$oCurrentObj->GetKey();
+				$oAppContext = new ApplicationContext();
+				$sParams = $oAppContext->GetForLink();
+				$oPage->p("<a target=\"_blank\" href=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php?operation=new&class=$sTargetClass&$sParams&{$sDefault}\">".Dict::Format('UI:ClickToCreateNew', Metamodel::GetName($sTargetClass))."</a>\n");
+			}
+			$this->DisplayAsBlock($oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, false /* bDisplayMenu*/);
+			break;
+			
+			case LINKSET_EDITMODE_INPLACE: // The whole linkset can be edited 'in-place'
+			$this->DisplayEditInPlace($oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj);
+			break;
+			
+			case LINKSET_EDITMODE_ADDREMOVE: // The whole linkset can be edited 'in-place'
+			$sTargetClass = $oLinksetDef->GetLinkedClass();
+			$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+			$oExtKeyDef = MetaModel::GetAttributeDef($sTargetClass, $sExtKeyToMe);
+			$aButtons = array('add');
+			if ($oExtKeyDef->IsNullAllowed())
+			{
+				$aButtons = array('add', 'remove');
+			}
+			$this->DisplayEditInPlace($oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj, $aButtons);
+			break;
+			
+			case LINKSET_EDITMODE_ACTIONS:
+			default:
+			$this->DisplayAsBlock($oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, true /* bDisplayMenu*/);
+		}
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObjectSet $oValue
+	 * @param array $aArgs
+	 * @param string $sFormPrefix
+	 * @param DBObject $oCurrentObj
+	 * @param bool $bDisplayMenu
+	 */
+	protected function DisplayAsBlock(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, $bDisplayMenu)
+	{
+		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		$sTargetClass = $oLinksetDef->GetLinkedClass();
+		if ($oCurrentObj && $oCurrentObj->IsNew() && $bDisplayMenu)
+		{
+			$oPage->p(Dict::Format('UI:BeforeAdding_Class_ObjectsSaveThisObject', MetaModel::GetName($sTargetClass)));
+		}
+		else
+		{
+			$oFilter = new DBObjectSearch($sTargetClass);
+			$oFilter->AddCondition($oLinksetDef->GetExtKeyToMe(), $oCurrentObj->GetKey(),'=');
+
+			$aDefaults = array($oLinksetDef->GetExtKeyToMe() => $oCurrentObj->GetKey());
+			$oAppContext = new ApplicationContext();
+			foreach($oAppContext->GetNames() as $sKey)
+			{
+				// The linked object inherits the parent's value for the context
+				if (MetaModel::IsValidAttCode($this->sClass, $sKey) && $oCurrentObj)
+				{
+					$aDefaults[$sKey] = $oCurrentObj->Get($sKey);
+				}
+			}
+			$aParams = array(
+				'target_attr' => $oLinksetDef->GetExtKeyToMe(),
+				'object_id' => $oCurrentObj ? $oCurrentObj->GetKey() : null,
+				'menu' => $bDisplayMenu,
+                'menu_actions_target' => '_blank',
+				'default' => $aDefaults,
+				'table_id' => $this->sClass.'_'.$this->sAttCode,
+			);
+
+			$oBlock = new DisplayBlock($oFilter, 'list', false);
+			$oBlock->Display($oPage, $this->sInputid, $aParams);
+		}	
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param string $sProposedRealClass
+	 */
+	public function GetObjectCreationDlg(WebPage $oPage, $sProposedRealClass = '', $oSourceObj = null)
+	{
+		// For security reasons: check that the "proposed" class is actually a subclass of the linked class
+		// and that the current user is allowed to create objects of this class
+		$sRealClass = '';
+		$oPage->add('<div class="wizContainer" style="vertical-align:top;"><div>');
+		$aSubClasses = MetaModel::EnumChildClasses($this->sLinkedClass, ENUM_CHILD_CLASSES_ALL); // Including the specified class itself
+		$aPossibleClasses = array();
+		foreach($aSubClasses as $sCandidateClass)
+		{
+			if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
+			{
+				if ($sCandidateClass == $sProposedRealClass)
+				{
+					$sRealClass = $sProposedRealClass;
+				}
+				$aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass);
+			}
+		}
+		// Only one of the subclasses can be instantiated...
+		if (count($aPossibleClasses) == 1)
+		{
+			$aKeys = array_keys($aPossibleClasses);
+			$sRealClass = $aKeys[0];
+		}
+
+		if ($sRealClass != '')
+		{
+			$oPage->add("<h1>".MetaModel::GetClassIcon($sRealClass)."&nbsp;".Dict::Format('UI:CreationTitle_Class', MetaModel::GetName($sRealClass))."</h1>\n");
+			$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+			$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+			$aFieldFlags = array( $sExtKeyToMe => OPT_ATT_HIDDEN);
+			$oObj = DBObject::MakeDefaultInstance($sRealClass);
+			$aPrefillParam = array('source_obj' => $oSourceObj);
+			$oObj->PrefillForm('creation_from_editinplace', $aPrefillParam);
+		 	cmdbAbstractObject::DisplayCreationForm($oPage, $sRealClass, $oObj, array(), array('formPrefix' => $this->sInputid, 'noRelations' => true, 'fieldsFlags' => $aFieldFlags));
+		}
+		else
+		{
+			$sClassLabel = MetaModel::GetName($this->sLinkedClass);
+			$oPage->add('<p>'.Dict::Format('UI:SelectTheTypeOf_Class_ToCreate', $sClassLabel));
+			$oPage->add('<nobr><select name="class">');
+			asort($aPossibleClasses);
+			foreach($aPossibleClasses as $sClassName => $sClassLabel)
+			{
+				$oPage->add("<option value=\"$sClassName\">$sClassLabel</option>");
+			}
+			$oPage->add('</select>');
+			$oPage->add('&nbsp; <button type="button" onclick="$(\'#'.$this->sInputid.'\').directlinks(\'subclassSelected\');">'.Dict::S('UI:Button:Apply').'</button><span class="indicator" style="display:inline-block;width:16px"></span></nobr></p>');
+		}
+		$oPage->add('</div></div>');
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObjectSet $oValue
+	 * @param array $aArgs
+	 * @param string $sFormPrefix
+	 * @param DBObject $oCurrentObj
+	 * @param array $aButtons
+	 */
+	protected function DisplayEditInPlace(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, $aButtons = array('create', 'delete'))
+	{
+		$aAttribs = $this->GetTableConfig();
+
+		$oValue->Rewind();
+		$oPage->add('<table class="listContainer" id="'.$this->sInputid.'"><tr><td>');
+
+		$aData = array();
+		while($oLinkObj = $oValue->Fetch())
+		{
+			$aRow = array();
+			$aRow['form::select'] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.$oLinkObj->GetKey().'"/>';
+			foreach($this->aZlist as $sLinkedAttCode)
+			{
+				$aRow[$sLinkedAttCode] = $oLinkObj->GetAsHTML($sLinkedAttCode);
+			}
+			$aData[] = $aRow;
+		}
+		$oPage->table($aAttribs, $aData);
+		$oPage->add('</td></tr></table>'); //listcontainer
+		$sInputName = $sFormPrefix.'attr_'.$this->sAttCode;
+		$aLabels = array(
+			'delete' => Dict::S('UI:Button:Delete'),
+			// 'modify' => 'Modify...' ,
+			'creation_title' => Dict::Format('UI:CreationTitle_Class', MetaModel::GetName($this->sLinkedClass)),
+			'create' => Dict::Format('UI:ClickToCreateNew', MetaModel::GetName($this->sLinkedClass)),
+			'remove' => Dict::S('UI:Button:Remove'),
+			'add' => Dict::Format('UI:AddAnExisting_Class', MetaModel::GetName($this->sLinkedClass)),
+			'selection_title' => Dict::Format('UI:SelectionOf_Class', MetaModel::GetName($this->sLinkedClass)),
+		);
+		$oContext = new ApplicationContext();
+		$sSubmitUrl = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?'.$oContext->GetForLink();
+		$sJSONLabels = json_encode($aLabels);
+		$sJSONButtons = json_encode($aButtons);
+		$sWizHelper = 'oWizardHelper'.$sFormPrefix;
+		// Don't automatically launch the search if the table is huge
+		$bDoSearch = !utils::IsHighCardinality($this->sLinkedClass);
+		$sJSDoSearch = $bDoSearch ? 'true' : 'false';
+		$oPage->add_ready_script("$('#{$this->sInputid}').directlinks({class_name: '$this->sClass', att_code: '$this->sAttCode', input_name:'$sInputName', labels: $sJSONLabels, submit_to: '$sSubmitUrl', buttons: $sJSONButtons, oWizardHelper: $sWizHelper, do_search: $sJSDoSearch});");
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObject $oCurrentObj
+	 * @param $aAlreadyLinked
+	 *
+	 * @param array $aPrefillFormParam
+	 *
+	 * @throws \CoreException
+	 * @throws \MissingQueryArgument
+	 * @throws \OQLException
+	 */
+	public function GetObjectsSelectionDlg($oPage, $oCurrentObj, $aAlreadyLinked, $aPrefillFormParam = array())
+	{
+		$sHtml = "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
+
+		$oHiddenFilter = new DBObjectSearch($this->sLinkedClass);
+		if (($oCurrentObj != null) && MetaModel::IsSameFamilyBranch($this->sLinkedClass, $this->sClass))
+		{
+			// Prevent linking to self if the linked object is of the same family
+			// and already present in the database
+			if (!$oCurrentObj->IsNew())
+			{
+				$oHiddenFilter->AddCondition('id', $oCurrentObj->GetKey(), '!=');
+			}
+		}
+		if (count($aAlreadyLinked) > 0)
+		{
+			$oHiddenFilter->AddCondition('id', $aAlreadyLinked, 'NOTIN');
+		}
+		$oHiddenCriteria = $oHiddenFilter->GetCriteria();
+		$aArgs = $oHiddenFilter->GetInternalParams();
+		$sHiddenCriteria = $oHiddenCriteria->Render($aArgs);
+
+		$oLinkSetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		$valuesDef = $oLinkSetDef->GetValuesDef();
+		if ($valuesDef === null)
+		{
+			$oFilter = new DBObjectSearch($this->sLinkedClass);
+		}
+		else
+		{
+			if (!$valuesDef instanceof ValueSetObjects)
+			{
+				throw new Exception('Error: only ValueSetObjects are supported for "allowed_values" in AttributeLinkedSet ('.$this->sClass.'/'.$this->sAttCode.').');
+			}
+			$oFilter = DBObjectSearch::FromOQL($valuesDef->GetFilterExpression());
+		}
+
+		if ($oCurrentObj != null)
+		{
+			$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
+
+			$aArgs = array_merge($oCurrentObj->ToArgs('this'), $oFilter->GetInternalParams());
+			$oFilter->SetInternalParams($aArgs);
+			$aPrefillFormParam['filter'] = $oFilter;
+			$oCurrentObj->PrefillForm('search', $aPrefillFormParam);
+		}
+		$oBlock = new DisplayBlock($oFilter, 'search', false);
+		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->sInputid}",
+			array(
+				'result_list_outer_selector' => "SearchResultsToAdd_{$this->sInputid}",
+				'table_id' => "add_{$this->sInputid}",
+				'table_inner_id' => "ResultsToAdd_{$this->sInputid}",
+				'selection_mode' => true,
+				'cssCount' => "#count_{$this->sInputid}",
+				'query_params' => $oFilter->GetInternalParams(),
+				'hidden_criteria' => $sHiddenCriteria,
+			)
+        );
+		$sHtml .= "<form id=\"ObjectsAddForm_{$this->sInputid}\">\n";
+		$sHtml .= "<div id=\"SearchResultsToAdd_{$this->sInputid}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
+		$sHtml .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
+		$sHtml .= "</div>\n";
+		$sHtml .= "<input type=\"hidden\" id=\"count_{$this->sInputid}\" value=\"0\"/>";
+		$sHtml .= "<button type=\"button\" class=\"cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;<button type=\"button\" class=\"ok\" disabled=\"disabled\">".Dict::S('UI:Button:Add')."</button>";
+		$sHtml .= "</div>\n";
+		$sHtml .= "</form>\n";
+		$oPage->add($sHtml);
+	}
+
+	/**
+	 * Search for objects to be linked to the current object (i.e "remote" objects)
+	 *
+	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
+	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of $this->sLinkedClass
+	 * @param array $aAlreadyLinked Array of indentifiers of objects which are already linke to the current object (or about to be linked)
+	 * @param DBObject $oCurrentObj The object currently being edited... if known...
+	 * @param array $aPrefillFormParam
+	 *
+	 * @throws \CoreException
+	 * @throws \OQLException
+	 */
+	public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinked = array(), $oCurrentObj = null, $aPrefillFormParam = array())
+	{
+		if ($sRemoteClass == '')
+		{
+			$sRemoteClass = $this->sLinkedClass;
+		}
+		$oLinkSetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		$valuesDef = $oLinkSetDef->GetValuesDef();
+		if ($valuesDef === null)
+		{
+			$oFilter = new DBObjectSearch($sRemoteClass);
+		}
+		else
+		{
+			if (!$valuesDef instanceof ValueSetObjects)
+			{
+				throw new Exception('Error: only ValueSetObjects are supported for "allowed_values" in AttributeLinkedSet ('.$this->sClass.'/'.$this->sAttCode.').');
+			}
+			$oFilter = DBObjectSearch::FromOQL($valuesDef->GetFilterExpression());
+		}
+		
+		if (($oCurrentObj != null) && MetaModel::IsSameFamilyBranch($sRemoteClass, $this->sClass))
+		{
+			// Prevent linking to self if the linked object is of the same family
+			// and already present in the database
+			if (!$oCurrentObj->IsNew())
+			{
+				$oFilter->AddCondition('id', $oCurrentObj->GetKey(), '!=');
+			}
+		}
+		if ($oCurrentObj != null)
+		{
+			$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
+
+			$aArgs = array_merge($oCurrentObj->ToArgs('this'), $oFilter->GetInternalParams());
+			$oFilter->SetInternalParams($aArgs);
+			
+			$aPrefillFormParam['filter'] = $oFilter;
+			$oCurrentObj->PrefillForm('search', $aPrefillFormParam);
+		}
+		if (count($aAlreadyLinked) > 0)
+		{
+			$oFilter->AddCondition('id', $aAlreadyLinked, 'NOTIN');
+		}
+		$oBlock = new DisplayBlock($oFilter, 'list', false);
+		$oBlock->Display($oP, "ResultsToAdd_{$this->sInputid}", array('menu' => false, 'cssCount'=> '#count_'.$this->sInputid , 'selection_mode' => true, 'table_id' => 'add_'.$this->sInputid)); // Don't display the 'Actions' menu on the results
+	}
+
+	/**
+	 * @param WebPage $oP
+	 * @param $oFullSetFilter
+	 */
+	public function DoAddObjects(WebPage $oP, $oFullSetFilter)
+	{
+		$aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter);
+		foreach($aLinkedObjectIds as $iObjectId)
+		{
+			$oLinkObj = MetaModel::GetObject($this->sLinkedClass, $iObjectId);
+			$oP->add($this->GetObjectRow($oP, $oLinkObj, $oLinkObj->GetKey()));
+		}
+	}
+	
+	public function GetObjectModificationDlg()
+	{
+		
+	}
+	
+	protected function GetTableConfig()
+	{
+		$aAttribs = array();
+		$aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$this->sInputid}:not(:disabled)', this.checked);\" class=\"checkAll\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
+
+		foreach($this->aZlist as $sLinkedAttCode)
+		{
+			$oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode);
+			$aAttribs[$sLinkedAttCode] = array('label' => MetaModel::GetLabel($this->sLinkedClass, $sLinkedAttCode), 'description' => $oAttDef->GetOrderByHint());
+		}
+		return $aAttribs;	
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param string $sRealClass
+	 * @param array $aValues
+	 * @param int $iTempId
+	 * @return mixed
+	 */
+	public function GetRow($oPage, $sRealClass, $aValues, $iTempId)
+	{
+		if ($sRealClass == '')
+		{
+			$sRealClass = $this->sLinkedClass;
+		}
+		$oLinkObj = new $sRealClass();
+		$oLinkObj->UpdateObjectFromPostedForm($this->sInputid);
+		
+		return $this->GetObjectRow($oPage, $oLinkObj, $iTempId);
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param $oLinkObj
+	 * @param int $iTempId
+	 * @return mixed
+	 */
+	protected function GetObjectRow($oPage, $oLinkObj, $iTempId)
+	{
+		$aAttribs = $this->GetTableConfig();
+		$aRow = array();
+		$aRow['form::select'] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.($iTempId).'"/>';
+		foreach($this->aZlist as $sLinkedAttCode)
+		{
+			$aRow[$sLinkedAttCode] = $oLinkObj->GetAsHTML($sLinkedAttCode);
+		}
+		return $oPage->GetTableRow($aRow, $aAttribs);		
+	}
+	
+	/**
+	 * Initializes the default search parameters based on 1) a 'current' object and 2) the silos defined by the context
+	 * @param DBObject $oSourceObj
+	 * @param DBSearch|DBObjectSearch $oSearch
+	 */
+	protected function SetSearchDefaultFromContext($oSourceObj, &$oSearch)
+	{
+		$oAppContext = new ApplicationContext();
+		$sSrcClass = get_class($oSourceObj);
+		$sDestClass = $oSearch->GetClass();
+		foreach($oAppContext->GetNames() as $key)
+		{
+			// Find the value of the object corresponding to each 'context' parameter
+			$aCallSpec = array($sSrcClass, 'MapContextParam');
+			$sAttCode = '';
+			if (is_callable($aCallSpec))
+			{
+				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+			}
+
+			if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode))
+			{
+				$defaultValue = $oSourceObj->Get($sAttCode);
+
+				// Find the attcode for the same 'context' parameter in the destination class
+				// and sets its value as the default value for the search condition
+				$aCallSpec = array($sDestClass, 'MapContextParam');
+				$sAttCode = '';
+				if (is_callable($aCallSpec))
+				{
+					$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+				}
+	
+				if (MetaModel::IsValidAttCode($sDestClass, $sAttCode) && !empty($defaultValue))
+				{
+					$oSearch->AddCondition($sAttCode, $defaultValue);
+				}
+			}
+		}
+	}
+}

application/ui.linkswidget.class.inc.php

@@ -1,366 +1,628 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class UILinksWidget
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-require_once(APPROOT.'/application/webpage.class.inc.php');
-require_once(APPROOT.'/application/displayblock.class.inc.php');
-
-class UILinksWidget 
-{
-	protected $m_sClass;
-	protected $m_sAttCode;
-	protected $m_sNameSuffix;
-	protected $m_iInputId;
-	protected $m_aAttributes;
-	protected $m_sExtKeyToRemote;
-	protected $m_sLinkedClass;
-	protected $m_sRemoteClass;
-	protected $m_bDuplicatesAllowed;
-	
-	public function __construct($sClass, $sAttCode, $iInputId, $sNameSuffix = '', $bDuplicatesAllowed = false)
-	{
-		$this->m_sClass = $sClass;
-		$this->m_sAttCode = $sAttCode;
-		$this->m_sNameSuffix = $sNameSuffix;
-		$this->m_iInputId = $iInputId;
-		$this->m_bDuplicatesAllowed = $bDuplicatesAllowed;
-		$this->m_aEditableFields = array();
-			
-		$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sAttCode);
-		$this->m_sLinkedClass = $oAttDef->GetLinkedClass();
-		$this->m_sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
-		$oLinkingAttDef = 	MetaModel::GetAttributeDef($this->m_sLinkedClass, $this->m_sExtKeyToRemote);
-		$this->m_sRemoteClass = $oLinkingAttDef->GetTargetClass();
-		$sExtKeyToMe = $oAttDef->GetExtKeyToMe();
-		$sStateAttCode = MetaModel::GetStateAttributeCode($this->m_sClass);
-		$sDefaultState = MetaModel::GetDefaultState($this->m_sClass);		
-
-		$this->m_aEditableFields = array();
-		$this->m_aTableConfig = array();
-		$this->m_aTableConfig['form::checkbox'] = array( 'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onClick=\"CheckAll('#linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix} .selection', this.checked); oWidget".$this->m_iInputId.".OnSelectChange();\">", 'description' => Dict::S('UI:SelectAllToggle+'));
-
-		foreach(MetaModel::ListAttributeDefs($this->m_sLinkedClass) as $sAttCode=>$oAttDef)
-		{
-			if ($sStateAttCode == $sAttCode)
-			{
-				// State attribute is always hidden from the UI
-			}
-			else if ($oAttDef->IsWritable() && ($sAttCode != $sExtKeyToMe) && ($sAttCode != $this->m_sExtKeyToRemote) && ($sAttCode != 'finalclass'))
-			{
-				$iFlags = MetaModel::GetAttributeFlags($this->m_sLinkedClass, $sDefaultState, $sAttCode);				
-				if ( !($iFlags & OPT_ATT_HIDDEN) && !($iFlags & OPT_ATT_READONLY) )
-				{
-					$this->m_aEditableFields[] = $sAttCode;
-					$this->m_aTableConfig[$sAttCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());				
-				}
-			}
-		}
-		
-		$this->m_aTableConfig['static::key'] = array( 'label' => MetaModel::GetName($this->m_sRemoteClass), 'description' => MetaModel::GetClassDescription($this->m_sRemoteClass));
-		foreach(MetaModel::GetZListItems($this->m_sRemoteClass, 'list') as $sFieldCode)
-		{
-			// TO DO: check the state of the attribute: hidden or visible ?
-			if ($sFieldCode != 'finalclass')
-			{
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sRemoteClass, $sFieldCode);
-				$this->m_aTableConfig['static::'.$sFieldCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
-			}
-		}
-	}
-	
-	/**
-	 * A one-row form for editing a link record
-	 * @param WebPage $oP Web page used for the ouput
-	 * @param DBObject $oLinkedObj The object to which all the elements of the linked set refer to
-	 * @param mixed $linkObjOrId Either the object linked or a unique number for new link records to add
-	 * @param Hash $aArgs Extra context arguments
-	 * @return string The HTML fragment of the one-row form
-	 */
-	protected function GetFormRow(WebPage $oP, DBObject $oLinkedObj, $linkObjOrId = null, $aArgs = array() )
-	{
-		$sPrefix = "$this->m_sAttCode{$this->m_sNameSuffix}";
-		$aRow = array();
-		if(is_object($linkObjOrId))
-		{
-			$key = $linkObjOrId->GetKey();
-			$sPrefix .= "[$key][";
-			$sNameSuffix = "]"; // To make a tabular form
-			$aArgs['prefix'] = $sPrefix;
-			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$key\">";
-			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"attr_{$sPrefix}id{$sNameSuffix}\" value=\"$key\">";
-			foreach($this->m_aEditableFields as $sFieldCode)
-			{
-				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId->GetKey().']';
-				$sSafeId = str_replace(array('[',']','-'), '_', $sFieldId);
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $linkObjOrId->Get($sFieldCode), '' /* DisplayValue */, $sSafeId, $sNameSuffix, 0, $aArgs);
-			}
-		}
-		else
-		{
-			// form for creating a new record
-			$sPrefix .= "[$linkObjOrId][";
-			$sNameSuffix = "]"; // To make a tabular form
-			$aArgs['prefix'] = $sPrefix;
-			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$linkObjOrId\">";
-			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"attr_{$sPrefix}id{$sNameSuffix}\" value=\"\">";
-			foreach($this->m_aEditableFields as $sFieldCode)
-			{
-				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId.']';
-				$sSafeId = str_replace(array('[',']','-'), '_', $sFieldId);
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, '' /* TO DO/ call GetDefaultValue($oObject->ToArgs()) */, '' /* DisplayValue */, $sSafeId /* id */, $sNameSuffix, 0, $aArgs);
-			}
-		}
-
-		$aRow['static::key'] = $oLinkedObj->GetHyperLink();
-		foreach(MetaModel::GetZListItems($this->m_sRemoteClass, 'list') as $sFieldCode)
-		{
-			$aRow['static::'.$sFieldCode] = $oLinkedObj->GetAsHTML($sFieldCode);
-		}
-		return $aRow;
-	}
-
-	/**
-	 * Display one row of the whole form
-	 * @return none
-	 */
-	protected function DisplayFormRow(WebPage $oP, $aConfig, $aRow, $iRowId)
-	{
-		$sHtml = '';
-		$sHtml .= "<tr id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_row_$iRowId\">\n";
-		foreach($aConfig as $sName=>$void)
-		{
-			$sHtml .= "<td>".$aRow[$sName]."</td>\n";
-		}
-		$sHtml .= "</tr>\n";
-		
-		return $sHtml;
-	}
-	
-	/**
-	 * Display the table with the form for editing all the links at once
-	 * @param WebPage $oP The web page used for the output
-	 * @param Hash $aConfig The table's header configuration
-	 * @param Hash $aData The tabular data to be displayed
-	 * @return string Html fragment representing the form table
-	 */
-	protected function DisplayFormTable(WebPage $oP, $aConfig, $aData)
-	{
-		$sHtml = '';
-		$sHtml .= "<table class=\"listResults\">\n";
-		// Header
-		$sHtml .= "<thead>\n";
-		$sHtml .= "<tr>\n";
-		foreach($aConfig as $sName=>$aDef)
-		{
-			$sHtml .= "<th title=\"".$aDef['description']."\">".$aDef['label']."</th>\n";
-		}
-		$sHtml .= "</tr>\n";
-		$sHtml .= "</thead>\n";
-		
-		// Content
-		$sHtml .= "</tbody>\n";
-		$sEmptyRowStyle = '';
-		if (count($aData) != 0)
-		{
-			$sEmptyRowStyle = 'style="display:none;"';
-		}
-
-		$sHtml .= "<tr $sEmptyRowStyle id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_empty_row\"><td colspan=\"".count($aConfig)."\" style=\"text-align:center;\">".Dict::S('UI:Message:EmptyList:UseAdd')."<input type=\"hidden\" name=\"attr_{$this->m_sAttCode}{$this->m_sNameSuffix}\" value=\"\"></td></td>";
-		foreach($aData as $iRowId => $aRow)
-		{
-			$sHtml .= $this->DisplayFormRow($oP, $aConfig, $aRow, $iRowId);
-		}		
-		$sHtml .= "</tbody>\n";
-		
-		// Footer
-		$sHtml .= "</table>\n";
-		
-		return $sHtml;
-	}
-	
-
-	/**
-	 * Get the HTML fragment corresponding to the linkset editing widget
-	 * @param WebPage $oP The web page used for all the output
-	 * @param DBObjectSet The initial value of the linked set
-	 * @param Hash $aArgs Extra context arguments
-	 * @return string The HTML fragment to be inserted into the page
-	 */
-	public function Display(WebPage $oPage, DBObjectSet $oValue, $aArgs = array())
-	{
-		$sHtmlValue = '';
-		$sTargetClass = self::GetTargetClass($this->m_sClass, $this->m_sAttCode);
-		$sHtmlValue .= "<div id=\"linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix}\">\n";
-		$oValue->Rewind();
-		$aForm = array();
-		while($oCurrentLink = $oValue->Fetch())
-		{
-			$aRow = array();
-			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $oCurrentLink->Get($this->m_sExtKeyToRemote));
-			if ($oCurrentLink->IsNew())
-			{
-				$key = -$oLinkedObj->GetKey();
-				$aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $key, $aArgs);
-			}
-			else
-			{
-				$key = $oCurrentLink->GetKey();
-				$aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $oCurrentLink, $aArgs);
-			}
-
-		}
-		$sHtmlValue .= $this->DisplayFormTable($oPage, $this->m_aTableConfig, $aForm);
-		$sDuplicates = ($this->m_bDuplicatesAllowed) ? 'true' : 'false';
-		$oPage->add_ready_script(<<<EOF
-		oWidget{$this->m_iInputId} = new LinksWidget('{$this->m_sAttCode}{$this->m_sNameSuffix}', '{$this->m_sClass}', '{$this->m_sAttCode}', '{$this->m_iInputId}', '{$this->m_sNameSuffix}', $sDuplicates);
-		oWidget{$this->m_iInputId}.Init();
-EOF
-);
-		$sHtmlValue .= "<span style=\"float:left;\">&nbsp;&nbsp;&nbsp;<img src=\"../images/tv-item-last.gif\">&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnRemove\" type=\"button\" value=\"".Dict::S('UI:RemoveLinkedObjectsOf_Class')."\" onClick=\"oWidget{$this->m_iInputId}.RemoveSelected();\" >";
-		$sHtmlValue .= "&nbsp;&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnAdd\" type=\"button\" value=\"".Dict::Format('UI:AddLinkedObjectsOf_Class', MetaModel::GetName($this->m_sRemoteClass))."\" onClick=\"oWidget{$this->m_iInputId}.AddObjects();\"></span>\n";
-		$sHtmlValue .= "<span style=\"clear:both;\"><p>&nbsp;</p></span>\n";
-		$sHtmlValue .= "</div>\n";
-		$oPage->add_at_the_end($this->GetObjectPickerDialog($oPage), "dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}"); // To prevent adding forms inside the main form
-		return $sHtmlValue;
-	}
-	         
-	protected static function GetTargetClass($sClass, $sAttCode)
-	{
-		$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
-		$sLinkedClass = $oAttDef->GetLinkedClass();
-		switch(get_class($oAttDef))
-		{
-			case 'AttributeLinkedSetIndirect':
-			$oLinkingAttDef = 	MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
-			$sTargetClass = $oLinkingAttDef->GetTargetClass();
-			break;
-
-			case 'AttributeLinkedSet':
-			$sTargetClass = $sLinkedClass;
-			break;
-		}
-		
-		return $sTargetClass;
-	}
-	
-	protected function GetObjectPickerDialog($oPage)
-	{
-		$sHtml = "<div id=\"dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}\">";
-		$sHtml .= "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
-		$oFilter = new DBObjectSearch($this->m_sRemoteClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'search', false);
-		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}", array('open' => true));
-		$sHtml .= "<form id=\"ObjectsAddForm_{$this->m_sAttCode}{$this->m_sNameSuffix}\" OnSubmit=\"return oWidget{$this->m_iInputId}.DoAddObjects(this.id);\">\n";
-		$sHtml .= "<div id=\"SearchResultsToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
-		$sHtml .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
-		$sHtml .= "</div>\n";
-		$sHtml .= "<input type=\"hidden\" id=\"count_{$this->m_sAttCode}{$this->m_sNameSuffix}\" value=\"0\"/>";
-		$sHtml .= "<input type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog('close');\">&nbsp;&nbsp;<input id=\"btn_ok_{$this->m_sAttCode}{$this->m_sNameSuffix}\" disabled=\"disabled\" type=\"submit\" value=\"".Dict::S('UI:Button:Add')."\">";
-		$sHtml .= "</div>\n";
-		$sHtml .= "</form>\n";
-		$sHtml .= "</div>\n";
-		$oPage->add_ready_script("$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog({ width: $(window).width()*0.8, height: $(window).height()*0.8, autoOpen: false, modal: true, resizeStop: oWidget{$this->m_iInputId}.UpdateSizes });");
-		$oPage->add_ready_script("$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog('option', {title:'".addslashes(Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName($this->m_sClass)))."'});");
-		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix} form').bind('submit.uilinksWizard', oWidget{$this->m_iInputId}.SearchObjectsToAdd);");
-		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}').resize(oWidget{$this->m_iInputId}.UpdateSizes);");
-		return $sHtml;
-	}
-
-	/**
-	 * Search for objects to be linked to the current object (i.e "remote" objects)
-	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
-	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of m_sRemoteClass
-	 * @param Array $aAlreadyLinkedIds List of IDs of objects of "remote" class already linked, to be filtered out of the search
-	 */
-	public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinkedIds = array())
-	{
-		if ($sRemoteClass != '')
-		{
-			// assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass));
-			$oFilter = new DBObjectSearch($sRemoteClass);
-		}
-		else
-		{
-			// No remote class specified use the one defined in the linkedset
-			$oFilter = new DBObjectSearch($this->m_sRemoteClass);		
-		}
-		if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0)
-		{
-			// Positive IDs correspond to existing link records
-			// negative IDs correspond to "remote" objects to be linked
-			$aLinkIds = array();
-			$aRemoteObjIds = array();
-			foreach($aAlreadyLinkedIds as $iId)
-			{
-				if ($iId > 0)
-				{
-					$aLinkIds[] = $iId;
-				}
-				else
-				{
-					$aRemoteObjIds[] = -$iId;
-				}
-			}
-			
-			if (count($aLinkIds) >0)
-			{
-				// Search for the links to find to which "remote" object they are linked
-				$oLinkFilter = new DBObjectSearch($this->m_sLinkedClass);
-				$oLinkFilter->AddCondition('id', $aLinkIds, 'IN');
-				$oLinkSet = new CMDBObjectSet($oLinkFilter);
-				while($oLink = $oLinkSet->Fetch())
-				{
-					$aRemoteObjIds[] = $oLink->Get($this->m_sExtKeyToRemote);
-				}
-			}
-			$oFilter->AddCondition('id', $aRemoteObjIds, 'NOTIN');
-		}
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'list', false);
-		$oBlock->Display($oP, "ResultsToAdd_{$this->m_sAttCode}", array('menu' => false, 'cssCount'=> '#count_'.$this->m_sAttCode.$this->m_sNameSuffix , 'selection_mode' => true)); // Don't display the 'Actions' menu on the results
-	}
-	
-	public function DoAddObjects(WebPage $oP, $oFullSetFilter)
-	{
-		$aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter);
-
-		foreach($aLinkedObjectIds as $iObjectId)
-		{
-			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId);
-			if (is_object($oLinkedObj))
-			{
-				$aRow = $this->GetFormRow($oP, $oLinkedObj, -$iObjectId ); // Not yet created link get negative Ids
-				$oP->add($this->DisplayFormRow($oP, $this->m_aTableConfig, $aRow, -$iObjectId)); 
-			}
-			else
-			{
-				$oP->p(Dict::Format('UI:Error:Object_Class_Id_NotFound', $this->m_sLinkedClass, $iObjectId));
-			}
-		}
-	}
-}
-?>
+<?php
+// Copyright (C) 2010-2017 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/>
+
+
+/**
+ * Class UILinksWidget
+ *
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'application/webpage.class.inc.php');
+require_once(APPROOT.'application/displayblock.class.inc.php');
+
+class UILinksWidget 
+{
+	protected $m_sClass;
+	protected $m_sAttCode;
+	protected $m_sNameSuffix;
+	protected $m_iInputId;
+	protected $m_aAttributes;
+	protected $m_sExtKeyToRemote;
+	protected $m_sExtKeyToMe;
+	protected $m_sLinkedClass;
+	protected $m_sRemoteClass;
+	protected $m_bDuplicatesAllowed;
+	protected $m_aEditableFields;
+	protected $m_aTableConfig;
+
+	/**
+	 * UILinksWidget constructor.
+	 *
+	 * @param string $sClass
+	 * @param string $sAttCode
+	 * @param int $iInputId
+	 * @param string $sNameSuffix
+	 * @param bool $bDuplicatesAllowed
+	 *
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 * @throws \Exception
+	 */
+	public function __construct($sClass, $sAttCode, $iInputId, $sNameSuffix = '', $bDuplicatesAllowed = false)
+	{
+		$this->m_sClass = $sClass;
+		$this->m_sAttCode = $sAttCode;
+		$this->m_sNameSuffix = $sNameSuffix;
+		$this->m_iInputId = $iInputId;
+		$this->m_bDuplicatesAllowed = $bDuplicatesAllowed;
+		$this->m_aEditableFields = array();
+
+		/** @var AttributeLinkedSetIndirect $oAttDef */
+		$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sAttCode);
+		$this->m_sLinkedClass = $oAttDef->GetLinkedClass();
+		$this->m_sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
+		$this->m_sExtKeyToMe = $oAttDef->GetExtKeyToMe();
+
+		/** @var AttributeExternalKey $oLinkingAttDef */
+		$oLinkingAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $this->m_sExtKeyToRemote);
+		$this->m_sRemoteClass = $oLinkingAttDef->GetTargetClass();
+		$sExtKeyToMe = $oAttDef->GetExtKeyToMe();
+		$sStateAttCode = MetaModel::GetStateAttributeCode($this->m_sClass);
+		$sDefaultState = MetaModel::GetDefaultState($this->m_sClass);		
+
+		$this->m_aEditableFields = array();
+		$this->m_aTableConfig = array();
+		$this->m_aTableConfig['form::checkbox'] = array( 'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onClick=\"CheckAll('#linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix} .selection', this.checked); oWidget".$this->m_iInputId.".OnSelectChange();\">", 'description' => Dict::S('UI:SelectAllToggle+'));
+
+		foreach(MetaModel::FlattenZList(MetaModel::GetZListItems($this->m_sLinkedClass, 'list')) as $sAttCode)
+		{
+			$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sAttCode);
+			if ($sStateAttCode == $sAttCode)
+			{
+				// State attribute is always hidden from the UI
+			}
+			else if ($oAttDef->IsWritable() && ($sAttCode != $sExtKeyToMe) && ($sAttCode != $this->m_sExtKeyToRemote) && ($sAttCode != 'finalclass'))
+			{
+				$iFlags = MetaModel::GetAttributeFlags($this->m_sLinkedClass, $sDefaultState, $sAttCode);				
+				if ( !($iFlags & OPT_ATT_HIDDEN) && !($iFlags & OPT_ATT_READONLY) )
+				{
+					$this->m_aEditableFields[] = $sAttCode;
+					$this->m_aTableConfig[$sAttCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());				
+				}
+			}
+		}
+		
+		$this->m_aTableConfig['static::key'] = array( 'label' => MetaModel::GetName($this->m_sRemoteClass), 'description' => MetaModel::GetClassDescription($this->m_sRemoteClass));
+		foreach(MetaModel::GetZListItems($this->m_sRemoteClass, 'list') as $sFieldCode)
+		{
+			// TO DO: check the state of the attribute: hidden or visible ?
+			if ($sFieldCode != 'finalclass')
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->m_sRemoteClass, $sFieldCode);
+				$this->m_aTableConfig['static::'.$sFieldCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
+			}
+		}
+	}
+
+	/**
+	 * A one-row form for editing a link record
+	 *
+	 * @param WebPage $oP Web page used for the ouput
+	 * @param DBObject $oLinkedObj Remote object
+	 * @param mixed $linkObjOrId Either the object linked or a unique number for new link records to add
+	 * @param array $aArgs Extra context arguments
+	 * @param DBObject $oCurrentObj The object to which all the elements of the linked set refer to
+	 * @param int $iUniqueId A unique identifier of new links
+	 * @param boolean $bReadOnly Display link as editable or read-only. Default is false (editable)
+	 *
+	 * @return array The HTML fragment of the one-row form
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \Exception
+	 */
+	protected function GetFormRow(WebPage $oP, DBObject $oLinkedObj, $linkObjOrId, $aArgs, $oCurrentObj, $iUniqueId, $bReadOnly = false)
+	{
+		$sPrefix = "$this->m_sAttCode{$this->m_sNameSuffix}";
+		$aRow = array();
+		$aFieldsMap = array();
+		$iKey = 0;
+		if(is_object($linkObjOrId) && (!$linkObjOrId->IsNew()))
+		{
+			$iKey = $linkObjOrId->GetKey();
+			$iRemoteObjKey =  $linkObjOrId->Get($this->m_sExtKeyToRemote);
+			$sPrefix .= "[$iKey][";
+			$sNameSuffix = "]"; // To make a tabular form
+			$aArgs['prefix'] = $sPrefix;
+			$aArgs['wizHelper'] = "oWizardHelper{$this->m_iInputId}{$iKey}";
+			$aArgs['this'] = $linkObjOrId;
+
+			if($bReadOnly)
+            {
+                $aRow['form::checkbox'] = "";
+                foreach($this->m_aEditableFields as $sFieldCode)
+                {
+                    $sDisplayValue = $linkObjOrId->GetEditValue($sFieldCode);
+                    $aRow[$sFieldCode] = $sDisplayValue;
+                }
+            }
+            else
+            {
+                $aRow['form::checkbox'] = "<input class=\"selection\" data-remote-id=\"$iRemoteObjKey\" data-link-id=\"$iKey\" data-unique-id=\"$iUniqueId\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$iKey\">";
+                foreach($this->m_aEditableFields as $sFieldCode)
+                {
+                    $sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId->GetKey().']';
+                    $sSafeId = utils::GetSafeId($sFieldId);
+                    $sValue = $linkObjOrId->Get($sFieldCode);
+                    $sDisplayValue = $linkObjOrId->GetEditValue($sFieldCode);
+                    $oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
+                    $aRow[$sFieldCode] = '<div class="field_container" style="border:none;"><div class="field_data"><div class="field_value">'.
+                        cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $sValue, $sDisplayValue, $sSafeId, $sNameSuffix, 0, $aArgs).
+	                    '</div></div></div>';
+                    $aFieldsMap[$sFieldCode] = $sSafeId;
+                }
+            }
+
+			$sState = $linkObjOrId->GetState();
+		}
+		else
+		{
+			// form for creating a new record
+			if (is_object($linkObjOrId))
+			{
+				// New link existing only in memory
+				$oNewLinkObj = $linkObjOrId;
+				$iRemoteObjKey = $oNewLinkObj->Get($this->m_sExtKeyToRemote);
+				$oNewLinkObj->Set($this->m_sExtKeyToMe, $oCurrentObj); // Setting the extkey with the object also fills the related external fields
+			}
+			else
+			{
+				$iRemoteObjKey = $linkObjOrId;
+				$oNewLinkObj = MetaModel::NewObject($this->m_sLinkedClass);
+				$oRemoteObj = MetaModel::GetObject($this->m_sRemoteClass, $iRemoteObjKey);
+				$oNewLinkObj->Set($this->m_sExtKeyToRemote, $oRemoteObj); // Setting the extkey with the object alsoo fills the related external fields
+				$oNewLinkObj->Set($this->m_sExtKeyToMe, $oCurrentObj); // Setting the extkey with the object also fills the related external fields
+			}
+			$sPrefix .= "[-$iUniqueId][";
+			$sNameSuffix = "]"; // To make a tabular form
+			$aArgs['prefix'] = $sPrefix;
+			$aArgs['wizHelper'] = "oWizardHelper{$this->m_iInputId}_".($iUniqueId < 0 ? -$iUniqueId : $iUniqueId);
+			$aArgs['this'] = $oNewLinkObj;
+			$sInputValue = $iUniqueId > 0 ? "-$iUniqueId" : "$iUniqueId";
+			$aRow['form::checkbox'] = "<input class=\"selection\" data-remote-id=\"$iRemoteObjKey\" data-link-id=\"0\" data-unique-id=\"$iUniqueId\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$sInputValue\">";
+
+			if ($iUniqueId > 0)
+			{
+				// Rows created with ajax call need OnLinkAdded call.
+				//
+				$oP->add_ready_script(
+					<<<EOF
+PrepareWidgets();
+oWidget{$this->m_iInputId}.OnLinkAdded($iUniqueId, $iRemoteObjKey);
+EOF
+				);
+			}
+			else
+			{
+				// Rows added before loading the form don't have to call OnLinkAdded.
+				// Listeners are already present and DOM is not recreated
+				$iPositiveUniqueId = -$iUniqueId;
+				$oP->add_ready_script(<<<EOF
+oWidget{$this->m_iInputId}.AddLink($iPositiveUniqueId, $iRemoteObjKey);
+EOF
+				);
+			}
+
+			foreach($this->m_aEditableFields as $sFieldCode)
+			{
+				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.-$iUniqueId.']';
+				$sSafeId = utils::GetSafeId($sFieldId);
+				$sValue = $oNewLinkObj->Get($sFieldCode);
+				$sDisplayValue = $oNewLinkObj->GetEditValue($sFieldCode);
+				$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
+				$aRow[$sFieldCode] = '<div class="field_container" style="border:none;"><div class="field_data"><div class="field_value">'.
+					cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $sValue, $sDisplayValue, $sSafeId /* id */, $sNameSuffix, 0, $aArgs).
+					'</div></div></div>';
+				$aFieldsMap[$sFieldCode] = $sSafeId;
+				$oP->add_ready_script(<<<EOF
+oWidget{$this->m_iInputId}.OnValueChange($iKey, $iUniqueId, '$sFieldCode', '$sValue');
+EOF
+					);
+			}
+			$sState = '';
+		}
+
+		if(!$bReadOnly)
+        {
+            $sExtKeyToMeId = utils::GetSafeId($sPrefix.$this->m_sExtKeyToMe);
+            $aFieldsMap[$this->m_sExtKeyToMe] = $sExtKeyToMeId;
+            $aRow['form::checkbox'] .= "<input type=\"hidden\" id=\"$sExtKeyToMeId\" value=\"".$oCurrentObj->GetKey()."\">";
+
+            $sExtKeyToRemoteId = utils::GetSafeId($sPrefix.$this->m_sExtKeyToRemote);
+            $aFieldsMap[$this->m_sExtKeyToRemote] = $sExtKeyToRemoteId;
+            $aRow['form::checkbox'] .= "<input type=\"hidden\" id=\"$sExtKeyToRemoteId\" value=\"$iRemoteObjKey\">";
+        }
+
+		$iFieldsCount = count($aFieldsMap);
+		$sJsonFieldsMap = json_encode($aFieldsMap);
+		
+		$oP->add_script(
+<<<EOF
+var {$aArgs['wizHelper']} = new WizardHelper('{$this->m_sLinkedClass}', '', '$sState');
+{$aArgs['wizHelper']}.SetFieldsMap($sJsonFieldsMap);
+{$aArgs['wizHelper']}.SetFieldsCount($iFieldsCount);
+EOF
+		);
+		$aRow['static::key'] = $oLinkedObj->GetHyperLink();
+		foreach(MetaModel::GetZListItems($this->m_sRemoteClass, 'list') as $sFieldCode)
+		{
+			$aRow['static::'.$sFieldCode] = $oLinkedObj->GetAsHTML($sFieldCode);
+		}
+		return $aRow;
+	}
+
+	/**
+	 * Display one row of the whole form
+	 * @param WebPage $oP
+	 * @param array $aConfig
+	 * @param array $aRow
+	 * @param int $iRowId
+	 * @return string
+	 */
+	protected function DisplayFormRow(WebPage $oP, $aConfig, $aRow, $iRowId)
+	{
+		$sHtml = '';
+		$sHtml .= "<tr id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_row_$iRowId\">\n";
+		foreach($aConfig as $sName=>$void)
+		{
+			$sHtml .= "<td>".$aRow[$sName]."</td>\n";
+		}
+		$sHtml .= "</tr>\n";
+		
+		return $sHtml;
+	}
+	
+	/**
+	 * Display the table with the form for editing all the links at once
+	 * @param WebPage $oP The web page used for the output
+	 * @param array $aConfig The table's header configuration
+	 * @param array $aData The tabular data to be displayed
+	 * @return string Html fragment representing the form table
+	 */
+	protected function DisplayFormTable(WebPage $oP, $aConfig, $aData)
+	{
+		$sHtml = "<input type=\"hidden\" name=\"attr_{$this->m_sAttCode}{$this->m_sNameSuffix}\" value=\"\">";
+		$sHtml .= "<table class=\"listResults\">\n";
+		// Header
+		$sHtml .= "<thead>\n";
+		$sHtml .= "<tr>\n";
+		foreach($aConfig as $sName=>$aDef)
+		{
+			$sHtml .= "<th title=\"".$aDef['description']."\">".$aDef['label']."</th>\n";
+		}
+		$sHtml .= "</tr>\n";
+		$sHtml .= "</thead>\n";
+		
+		// Content
+		$sHtml .= "</tbody>\n";
+		$sEmptyRowStyle = '';
+		if (count($aData) != 0)
+		{
+			$sEmptyRowStyle = 'style="display:none;"';
+		}
+
+		foreach($aData as $iRowId => $aRow)
+		{
+			$sHtml .= $this->DisplayFormRow($oP, $aConfig, $aRow, $iRowId);
+		}		
+		$sHtml .= "<tr $sEmptyRowStyle id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_empty_row\"><td colspan=\"".count($aConfig)."\" style=\"text-align:center;\">".Dict::S('UI:Message:EmptyList:UseAdd')."</td></tr>";
+		$sHtml .= "</tbody>\n";
+		
+		// Footer
+		$sHtml .= "</table>\n";
+		
+		return $sHtml;
+	}
+
+
+	/**
+	 * Get the HTML fragment corresponding to the linkset editing widget
+	 *
+	 * @param WebPage $oPage
+	 * @param DBObject|ormLinkSet $oValue
+	 * @param array $aArgs Extra context arguments
+	 * @param string $sFormPrefix prefix of the fields in the current form
+	 * @param DBObject $oCurrentObj the current object to which the linkset is related
+	 *
+	 * @return string The HTML fragment to be inserted into the page
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 */
+	public function Display(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj)
+	{
+		$sHtmlValue = '';
+		$sHtmlValue .= "<div id=\"linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix}\">\n";
+		$sHtmlValue .= "<input type=\"hidden\" id=\"{$sFormPrefix}{$this->m_iInputId}\">\n";
+		$oValue->Rewind();
+		$aForm = array();
+		$iAddedId = -1; // Unique id for new links
+
+		$sDuplicates = ($this->m_bDuplicatesAllowed) ? 'true' : 'false';
+		// Don't automatically launch the search if the table is huge
+		$bDoSearch = !utils::IsHighCardinality($this->m_sRemoteClass);
+		$sJSDoSearch = $bDoSearch ? 'true' : 'false';
+		$sWizHelper = 'oWizardHelper'.$sFormPrefix;
+		$oPage->add_ready_script(<<<EOF
+		oWidget{$this->m_iInputId} = new LinksWidget('{$this->m_sAttCode}{$this->m_sNameSuffix}', '{$this->m_sClass}', '{$this->m_sAttCode}', '{$this->m_iInputId}', '{$this->m_sNameSuffix}', $sDuplicates, $sWizHelper, '{$this->m_sExtKeyToRemote}', $sJSDoSearch);
+		oWidget{$this->m_iInputId}.Init();
+EOF
+		);
+
+		while($oCurrentLink = $oValue->Fetch())
+		{
+		    // We try to retrieve the remote object as usual
+			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $oCurrentLink->Get($this->m_sExtKeyToRemote), false /* Must not be found */);
+			// If successful, it means that we can edit its link
+			if($oLinkedObj !== null)
+            {
+                $bReadOnly = false;
+            }
+            // Else we retrieve it without restrictions (silos) and will display its link as readonly
+            else
+            {
+                $bReadOnly = true;
+                $oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $oCurrentLink->Get($this->m_sExtKeyToRemote), false /* Must not be found */, true);
+            }
+
+            if ($oCurrentLink->IsNew())
+            {
+                $key = $iAddedId--;
+            }
+            else
+            {
+                $key = $oCurrentLink->GetKey();
+            }
+            $aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $oCurrentLink, $aArgs, $oCurrentObj, $key, $bReadOnly);
+		}
+		$sHtmlValue .= $this->DisplayFormTable($oPage, $this->m_aTableConfig, $aForm);
+
+		$sHtmlValue .= "<span style=\"float:left;\">&nbsp;&nbsp;&nbsp;<img src=\"../images/tv-item-last.gif\">&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnRemove\" type=\"button\" value=\"".Dict::S('UI:RemoveLinkedObjectsOf_Class')."\" onClick=\"oWidget{$this->m_iInputId}.RemoveSelected();\" >";
+		$sHtmlValue .= "&nbsp;&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnAdd\" type=\"button\" value=\"".Dict::Format('UI:AddLinkedObjectsOf_Class', MetaModel::GetName($this->m_sRemoteClass))."\" onClick=\"oWidget{$this->m_iInputId}.AddObjects();\"><span id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_indicatorAdd\"></span></span>\n";
+		$sHtmlValue .= "<span style=\"clear:both;\"><p>&nbsp;</p></span>\n";
+		$sHtmlValue .= "</div>\n";
+		$oPage->add_at_the_end("<div id=\"dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}\"></div>"); // To prevent adding forms inside the main form
+        return $sHtmlValue;
+	}
+
+	/**
+	 * @param string $sClass
+	 * @param string $sAttCode
+	 *
+	 * @return string
+	 * @throws \Exception
+	 */
+	protected static function GetTargetClass($sClass, $sAttCode)
+	{
+		/** @var AttributeLinkedSet $oAttDef */
+		$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+		$sLinkedClass = $oAttDef->GetLinkedClass();
+		$sTargetClass = '';
+		switch(get_class($oAttDef))
+		{
+			case 'AttributeLinkedSetIndirect':
+			/** @var AttributeExternalKey $oLinkingAttDef */
+			/** @var AttributeLinkedSetIndirect $oAttDef */
+			$oLinkingAttDef = 	MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
+			$sTargetClass = $oLinkingAttDef->GetTargetClass();
+			break;
+
+			case 'AttributeLinkedSet':
+			$sTargetClass = $sLinkedClass;
+			break;
+		}
+		
+		return $sTargetClass;
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObject $oCurrentObj
+	 * @param $sJson
+	 * @param array $aAlreadyLinkedIds
+	 *
+	 * @throws DictExceptionMissingString
+	 * @throws Exception
+	 */
+	public function GetObjectPickerDialog($oPage, $oCurrentObj, $sJson, $aAlreadyLinkedIds = array(), $aPrefillFormParam = array())
+	{
+		$sHtml = "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
+
+		$oAlreadyLinkedFilter = new DBObjectSearch($this->m_sRemoteClass);
+		if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0)
+		{
+			$oAlreadyLinkedFilter->AddCondition('id', $aAlreadyLinkedIds, 'NOTIN');
+			$oAlreadyLinkedExpression = $oAlreadyLinkedFilter->GetCriteria();
+			$sAlreadyLinkedExpression = $oAlreadyLinkedExpression->Render();
+		}
+		else
+		{
+			$sAlreadyLinkedExpression = '';
+		}
+
+		$oFilter = new DBObjectSearch($this->m_sRemoteClass);
+
+		if(!empty($oCurrentObj))
+		{
+			$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
+			$aPrefillFormParam['filter'] = $oFilter;
+			$aPrefillFormParam['dest_class'] = $this->m_sRemoteClass;
+			$oCurrentObj->PrefillForm('search', $aPrefillFormParam);
+		}
+		$oBlock = new DisplayBlock($oFilter, 'search', false);
+		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}",
+			array(
+				'menu' => false,
+				'result_list_outer_selector' => "SearchResultsToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}",
+				'table_id' => 'add_'.$this->m_sAttCode,
+				'table_inner_id' => "ResultsToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}",
+				'selection_mode' => true,
+				'json' => $sJson,
+				'cssCount' => '#count_'.$this->m_sAttCode.$this->m_sNameSuffix,
+				'query_params' => $oFilter->GetInternalParams(),
+				'hidden_criteria' => $sAlreadyLinkedExpression,
+			));
+		$sHtml .= "<form id=\"ObjectsAddForm_{$this->m_sAttCode}{$this->m_sNameSuffix}\">\n";
+		$sHtml .= "<div id=\"SearchResultsToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
+		$sHtml .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
+		$sHtml .= "</div>\n";
+		$sHtml .= "<input type=\"hidden\" id=\"count_{$this->m_sAttCode}{$this->m_sNameSuffix}\" value=\"0\"/>";
+		$sHtml .= "<input type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog('close');\">&nbsp;&nbsp;<input id=\"btn_ok_{$this->m_sAttCode}{$this->m_sNameSuffix}\" disabled=\"disabled\" type=\"button\" onclick=\"return oWidget{$this->m_iInputId}.DoAddObjects(this.id);\" value=\"".Dict::S('UI:Button:Add')."\">";
+		$sHtml .= "</div>\n";
+		$sHtml .= "</form>\n";
+		$oPage->add($sHtml);
+		$oPage->add_ready_script("$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog({ width: $(window).width()*0.8, height: $(window).height()*0.8, autoOpen: false, modal: true, resizeStop: oWidget{$this->m_iInputId}.UpdateSizes });");
+		$oPage->add_ready_script("$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog('option', {title:'".addslashes(Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName($this->m_sClass)))."'});");
+		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix} form').bind('submit.uilinksWizard', oWidget{$this->m_iInputId}.SearchObjectsToAdd);");
+		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}').resize(oWidget{$this->m_iInputId}.UpdateSizes);");
+	}
+
+	/**
+	 * Search for objects to be linked to the current object (i.e "remote" objects)
+	 *
+	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
+	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of
+	 *     m_sRemoteClass
+	 * @param array $aAlreadyLinkedIds List of IDs of objects of "remote" class already linked, to be filtered out of
+	 *     the search
+	 *
+	 * @throws \CoreException
+	 * @throws \Exception
+	 */
+	public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinkedIds = array(), $oCurrentObj = null)
+	{
+		if ($sRemoteClass != '')
+		{
+			// assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass));
+			$oFilter = new DBObjectSearch($sRemoteClass);
+		}
+		else
+		{
+			// No remote class specified use the one defined in the linkedset
+			$oFilter = new DBObjectSearch($this->m_sRemoteClass);		
+		}
+		if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0)
+		{
+			$oFilter->AddCondition('id', $aAlreadyLinkedIds, 'NOTIN');
+		}
+		$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
+		$oBlock = new DisplayBlock($oFilter, 'list', false);
+		$oBlock->Display($oP, "ResultsToAdd_{$this->m_sAttCode}", array('menu' => false, 'cssCount'=> '#count_'.$this->m_sAttCode.$this->m_sNameSuffix , 'selection_mode' => true, 'table_id' => 'add_'.$this->m_sAttCode)); // Don't display the 'Actions' menu on the results
+	}
+
+	/**
+	 * @param WebPage $oP
+	 * @param int $iMaxAddedId
+	 * @param $oFullSetFilter
+	 * @param DBObject $oCurrentObj
+	 *
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 */
+	public function DoAddObjects(WebPage $oP, $iMaxAddedId, $oFullSetFilter, $oCurrentObj)
+	{
+		$aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter);
+
+		$iAdditionId = $iMaxAddedId + 1;
+		foreach($aLinkedObjectIds as $iObjectId)
+		{
+			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId, false);
+			if (is_object($oLinkedObj))
+			{
+				$aRow = $this->GetFormRow($oP, $oLinkedObj, $iObjectId, array(), $oCurrentObj, $iAdditionId); // Not yet created link get negative Ids
+				$oP->add($this->DisplayFormRow($oP, $this->m_aTableConfig, $aRow, -$iAdditionId));
+				$iAdditionId++;
+			}
+			else
+			{
+				$oP->p(Dict::Format('UI:Error:Object_Class_Id_NotFound', $this->m_sLinkedClass, $iObjectId));
+			}
+		}
+	}
+
+	/**
+	 * Initializes the default search parameters based on 1) a 'current' object and 2) the silos defined by the context
+	 *
+	 * @param DBObject $oSourceObj
+	 * @param DBSearch|DBObjectSearch $oSearch
+	 *
+	 * @throws \CoreException
+	 * @throws \Exception
+	 */
+	protected function SetSearchDefaultFromContext($oSourceObj, &$oSearch)
+	{
+		$oAppContext = new ApplicationContext();
+		$sSrcClass = get_class($oSourceObj);
+		$sDestClass = $oSearch->GetClass();
+		foreach($oAppContext->GetNames() as $key)
+		{
+			// Find the value of the object corresponding to each 'context' parameter
+			$aCallSpec = array($sSrcClass, 'MapContextParam');
+			$sAttCode = '';
+			if (is_callable($aCallSpec))
+			{
+				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+			}
+
+			if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode))
+			{
+				$defaultValue = $oSourceObj->Get($sAttCode);
+
+				// Find the attcode for the same 'context' parameter in the destination class
+				// and sets its value as the default value for the search condition
+				$aCallSpec = array($sDestClass, 'MapContextParam');
+				$sAttCode = '';
+				if (is_callable($aCallSpec))
+				{
+					$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+				}
+	
+				if (MetaModel::IsValidAttCode($sDestClass, $sAttCode) && !empty($defaultValue))
+				{
+					// Add Hierarchical condition if hierarchical key
+					$oAttDef = MetaModel::GetAttributeDef($sDestClass, $sAttCode);
+					if (isset($oAttDef) && ($oAttDef->IsExternalKey()))
+					{
+						try
+						{
+							/** @var AttributeExternalKey $oAttDef */
+							$sTargetClass = $oAttDef->GetTargetClass();
+							$sHierarchicalKeyCode = MetaModel::IsHierarchicalClass($sTargetClass);
+							if ($sHierarchicalKeyCode !== false)
+							{
+								$oFilter = new DBObjectSearch($sTargetClass);
+								$oFilter->AddCondition('id', $defaultValue);
+								$oHKFilter = new DBObjectSearch($sTargetClass);
+								$oHKFilter->AddCondition_PointingTo($oFilter, $sHierarchicalKeyCode, TREE_OPERATOR_BELOW);
+								$oSearch->AddCondition_PointingTo($oHKFilter, $sAttCode);
+							}
+						} catch (Exception $e)
+						{
+						}
+					}
+					else
+					{
+						$oSearch->AddCondition($sAttCode, $defaultValue);
+					}
+				}
+			}
+		}
+	}
+}

application/ui.passwordwidget.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   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 General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class UIPasswordWidget
  * UI wdiget for displaying and editing one-way encrypted passwords
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -52,30 +52,38 @@ class UIPasswordWidget
 	{
 		$sCode = $this->sAttCode.$this->sNameSuffix;
 		$iWidgetIndex = self::$iWidgetIndex;
-		$sPasswordValue = utils::ReadPostedParam("attr_{$sCode}[value]", '*****', 'raw_data');
-		$sConfirmPasswordValue = utils::ReadPostedParam("attr_{$sCode}[confirm]", '*****', 'raw_data');
+
+		$aPasswordValues = utils::ReadPostedParam("attr_{$sCode}", null, 'raw_data');
+		$sPasswordValue = $aPasswordValues ? $aPasswordValues['value'] : '*****';
+		$sConfirmPasswordValue = $aPasswordValues ? $aPasswordValues['confirm'] : '*****';
 		$sChangedValue = (($sPasswordValue != '*****') || ($sConfirmPasswordValue != '*****')) ? 1 : 0;
 		$sHtmlValue = '';
-		$sHtmlValue = '<input type="password" maxlength="255" name="attr_'.$sCode.'[value]" id="'.$this->iId.'" value="'.htmlentities($sPasswordValue, ENT_QUOTES, 'UTF-8').'"/>&nbsp;<span class="form_validation" id="v_'.$this->iId.'"></span><br/>';
-		$sHtmlValue .= '<input type="password" maxlength="255" id="'.$this->iId.'_confirm" value="'.htmlentities($sConfirmPasswordValue, ENT_QUOTES, 'UTF-8').'" name="attr_'.$sCode.'[confirm]"/> '.Dict::S('UI:PasswordConfirm').' <input id="'.$this->iId.'_reset" type="button" value="'.Dict::S('UI:Button:ResetPassword').'" onClick="ResetPwd(\''.$this->iId.'\');">';
+		$sHtmlValue .= '<div class="field_input_zone field_input_onewaypassword">';
+		$sHtmlValue .= '<input type="password" maxlength="255" name="attr_'.$sCode.'[value]" id="'.$this->iId.'" value="'.htmlentities($sPasswordValue, ENT_QUOTES, 'UTF-8').'"/>';
+		$sHtmlValue .= '<input type="password" maxlength="255" id="'.$this->iId.'_confirm" value="'.htmlentities($sConfirmPasswordValue, ENT_QUOTES, 'UTF-8').'" name="attr_'.$sCode.'[confirm]"/>';
+		$sHtmlValue .= '<span>'.Dict::S('UI:PasswordConfirm').'</span>';
+		$sHtmlValue .= '<input id="'.$this->iId.'_reset" type="button" value="'.Dict::S('UI:Button:ResetPassword').'" onClick="ResetPwd(\''.$this->iId.'\');">';
 		$sHtmlValue .= '<input type="hidden" id="'.$this->iId.'_changed" name="attr_'.$sCode.'[changed]" value="'.$sChangedValue.'"/>';
+		$sHtmlValue .= '</div>';
+
+		$sHtmlValue .= '<span class="form_validation" id="v_'.$this->iId.'"></span><span class="field_status" id="fstatus_'.$this->iId.'"></span>';
 
 		$oPage->add_ready_script("$('#$this->iId').bind('keyup change', function(evt) { return PasswordFieldChanged('$this->iId') } );"); // Bind to a custom event: validate
 		$oPage->add_ready_script("$('#$this->iId').bind('keyup change validate', function(evt, sFormId) { return ValidatePasswordField('$this->iId', sFormId) } );"); // Bind to a custom event: validate
 		$oPage->add_ready_script("$('#{$this->iId}_confirm').bind('keyup change', function(evt, sFormId) { return ValidatePasswordField('$this->iId', sFormId) } );"); // Bind to a custom event: validate
 		$oPage->add_ready_script("$('#{$this->iId}').bind('update', function(evt, sFormId)
 			{
-				if ($(this).attr('disabled'))
+				if ($(this).prop('disabled'))
 				{
-					$('#{$this->iId}_confirm').attr('disabled', 'disabled');
-					$('#{$this->iId}_changed').attr('disabled', 'disabled');
-					$('#{$this->iId}_reset').attr('disabled', 'disabled');
+					$('#{$this->iId}_confirm').prop('disabled', true);
+					$('#{$this->iId}_changed').prop('disabled', true);
+					$('#{$this->iId}_reset').prop('disabled', true);
 				}
 				else
 				{
-					$('#{$this->iId}_confirm').removeAttr('disabled');
-					$('#{$this->iId}_changed').removeAttr('disabled');
-					$('#{$this->iId}_reset').removeAttr('disabled');
+					$('#{$this->iId}_confirm').prop('disabled', false);
+					$('#{$this->iId}_changed').prop('disabled', false);
+					$('#{$this->iId}_reset').prop('disabled', false);
 				}
 			}
 		);"); // Bind to a custom event: update to handle enabling/disabling

application/ui.searchformforeignkeys.class.inc.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ *
+ * Copyright (C) 2010-2018 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/>
+ *
+ */
+
+
+require_once(APPROOT.'/application/webpage.class.inc.php');
+require_once(APPROOT.'/application/displayblock.class.inc.php');
+
+class UISearchFormForeignKeys
+{
+	public function __construct($sTargetClass, $iInputId = null)
+	{
+		$this->m_sRemoteClass = $sTargetClass;
+		$this->m_iInputId = $iInputId;
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 *
+	 * @param $sTitle
+	 *
+	 * @throws \Exception
+	 */
+	public function ShowModalSearchForeignKeys($oPage, $sTitle)
+	{
+		$sHtml = "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
+
+		$oFilter = new DBObjectSearch($this->m_sRemoteClass);
+
+		$oBlock = new DisplayBlock($oFilter, 'search', false);
+		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->m_iInputId}",
+			array(
+				'menu' => false,
+				'result_list_outer_selector' => "SearchResultsToAdd_{$this->m_iInputId}",
+				'table_id' => "add_{$this->m_iInputId}",
+				'table_inner_id' => "ResultsToAdd_{$this->m_iInputId}",
+				'selection_mode' => true,
+				'cssCount' => "#count_{$this->m_iInputId}",
+				'query_params' => $oFilter->GetInternalParams(),
+			));
+		$sHtml .= "<form id=\"ObjectsAddForm_{$this->m_iInputId}\">\n";
+		$sHtml .= "<div id=\"SearchResultsToAdd_{$this->m_iInputId}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
+		$sHtml .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
+		$sHtml .= "</div>\n";
+		$sHtml .= "<input type=\"hidden\" id=\"count_{$this->m_iInputId}\" value=\"0\"/>";
+		$sHtml .= "<input type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#dlg_{$this->m_iInputId}').dialog('close');\">&nbsp;&nbsp;<input id=\"btn_ok_{$this->m_iInputId}\" disabled=\"disabled\" type=\"button\" onclick=\"return oForeignKeysWidget{$this->m_iInputId}.DoAddObjects(this.id);\" value=\"".Dict::S('UI:Button:Add')."\">";
+		$sHtml .= "</div>\n";
+		$sHtml .= "</form>\n";
+		$oPage->add($sHtml);
+		$oPage->add_ready_script("$('#dlg_{$this->m_iInputId}').dialog({ width: $(window).width()*0.8, height: $(window).height()*0.8, autoOpen: false, modal: true, resizeStop: oForeignKeysWidget{$this->m_iInputId}.UpdateSizes });");
+		$oPage->add_ready_script("$('#dlg_{$this->m_iInputId}').dialog('option', {title:'$sTitle'});");
+		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_iInputId} form').bind('submit.uilinksWizard', oForeignKeysWidget{$this->m_iInputId}.SearchObjectsToAdd);");
+		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_iInputId}').resize(oForeignKeysWidget{$this->m_iInputId}.UpdateSizes);");
+	}
+
+	public function GetFullListForeignKeysFromSelection($oPage, $oFullSetFilter)
+	{
+		try
+		{
+			$aLinkedObjects = utils::ReadMultipleSelectionWithFriendlyname($oFullSetFilter);
+			$oPage->add(json_encode($aLinkedObjects));
+		}
+		catch (CoreException $e)
+		{
+			http_response_code(500);
+			$oPage->add(json_encode(array('error' => $e->GetMessage())));
+			IssueLog::Error($e->getMessage()."\nDebug trace:\n".$e->getTraceAsString());
+		}
+	}
+
+	/**
+	 * Search for objects to be linked to the current object (i.e "remote" objects)
+	 *
+	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
+	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of m_sRemoteClass
+	 *
+	 * @throws \Exception
+	 */
+	public function ListResultsSearchForeignKeys(WebPage $oP, $sRemoteClass = '')
+	{
+		if ($sRemoteClass != '')
+		{
+			// assert(MetaModel::IsParentClass($this->m_sRemoteClass, $sRemoteClass));
+			$oFilter = new DBObjectSearch($sRemoteClass);
+		}
+		else
+		{
+			// No remote class specified use the one defined in the linkedset
+			$oFilter = new DBObjectSearch($this->m_sRemoteClass);
+		}
+
+		$oBlock = new DisplayBlock($oFilter, 'list', false);
+		$oBlock->Display($oP, "ResultsToAdd_{$this->m_iInputId}",
+			array('menu' => false, 'cssCount' => "#count_{$this->m_iInputId}", 'selection_mode' => true, 'table_id' => "add_{$this->m_iInputId}"));
+	}
+
+}

application/uilinkswizard.class.inc.php

@@ -1,422 +0,0 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class UILinksWizard
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-class UILinksWizard
-{
-	protected $m_sClass;
-	protected $m_sLinkageAttr;
-	protected $m_iObjectId;
-	protected $m_sLinkedClass;
-	protected $m_sLinkingAttCode;
-	protected $m_aEditableFields;
-	protected $m_aTableConfig;
-	
-	public function __construct($sClass,  $sLinkageAttr, $iObjectId, $sLinkedClass = '')
-	{
-		$this->m_sClass = $sClass;
-		$this->m_sLinkageAttr = $sLinkageAttr;
-		$this->m_iObjectId = $iObjectId;
-		$this->m_sLinkedClass = $sLinkedClass; // Will try to guess below, if it's empty
-		$this->m_sLinkingAttCode = ''; // Will be filled once we've found the attribute corresponding to the linked class
-		
-		$this->m_aEditableFields = array();
-		$this->m_aTableConfig = array();
-		$this->m_aTableConfig['form::checkbox'] = array( 'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onChange=\"var value = this.checked; $('.selection').each( function() { this.checked = value; } );OnSelectChange();\">", 'description' => Dict::S('UI:SelectAllToggle+'));
-		foreach(MetaModel::GetAttributesList($this->m_sClass) as $sAttCode)
-		{
-			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-			if ($oAttDef->IsExternalKey() && ($sAttCode != $this->m_sLinkageAttr))
-			{
-				if (empty($this->m_sLinkedClass))
-				{
-					// This is a class of objects we can manage !
-					// Since nothing was specify, any class will do !
-					$this->m_sLinkedClass = $oAttDef->GetTargetClass();
-					$this->m_sLinkingAttCode = $sAttCode;
-				}
-				else if ($this->m_sLinkedClass == $oAttDef->GetTargetClass())
-				{
-					// This is the class of objects we want to manage !
-					$this->m_sLinkingAttCode = $sAttCode;
-				}
-			}
-			else if ( (!$oAttDef->IsExternalKey()) && (!$oAttDef->IsExternalField()))
-			{
-				$this->m_aEditableFields[] = $sAttCode;
-				$this->m_aTableConfig[$sAttCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
-			}
-		}
-		if (empty($this->m_sLinkedClass))
-		{
-			throw( new Exception(Dict::Format('UI:Error:IncorrectLinkDefinition_LinkedClass_Class', $sLinkedClass, $sClass)));
-		}
-		foreach(MetaModel::GetZListItems($this->m_sLinkedClass, 'list') as $sFieldCode)
-		{
-			$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
-			$this->m_aTableConfig['static::'.$sFieldCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
-		}
-	}
-
-	public function Display(WebPage $oP, $aExtraParams = array())
-	{
-		$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-		$sTargetClass = $oAttDef->GetTargetClass();
-		$oTargetObj = MetaModel::GetObject($sTargetClass, $this->m_iObjectId);
-
-		$oP->set_title("iTop - ".MetaModel::GetName($this->m_sLinkedClass)." objects linked with ".MetaModel::GetName(get_class($oTargetObj)).": ".$oTargetObj->GetRawName());
-		$oP->add("<div class=\"wizContainer\">\n");
-		$oP->add("<form method=\"post\">\n");
-		$oP->add("<div class=\"page_header\">\n");
-		$oP->add("<input type=\"hidden\" id=\"linksToRemove\" name=\"linksToRemove\" value=\"\">\n");
-		$oP->add("<input type=\"hidden\" name=\"operation\" value=\"do_modify_links\">\n");
-		$oP->add("<input type=\"hidden\" name=\"class\" value=\"{$this->m_sClass}\">\n");
-		$oP->add("<input type=\"hidden\" name=\"linkage\" value=\"{$this->m_sLinkageAttr}\">\n");
-		$oP->add("<input type=\"hidden\" name=\"object_id\" value=\"{$this->m_iObjectId}\">\n");
-		$oP->add("<input type=\"hidden\" name=\"linking_attcode\" value=\"{$this->m_sLinkingAttCode}\">\n");
-		$oP->add("<h1>".Dict::Format('UI:ManageObjectsOf_Class_LinkedWith_Class_Instance', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName(get_class($oTargetObj)), "<span class=\"hilite\">".$oTargetObj->GetHyperlink()."</span>")."</h1>\n");
-		$oP->add("</div>\n");
-		$oP->add_script(
-<<<EOF
-		function OnSelectChange()
-		{
-			var nbChecked = $('.selection:checked').length;
-			if (nbChecked > 0)
-			{
-				$('#btnRemove').attr('disabled','');
-			}
-			else
-			{
-				$('#btnRemove').attr('disabled','disabled');
-			}
-		}
-		
-		function RemoveSelected()
-		{
-			$('.selection:checked').each(
-				function()
-				{
-					$('#linksToRemove').val($('#linksToRemove').val() + ' ' + this.value);
-					$('#row_'+this.value).remove();
-				}
-			);
-			// Disable the button since all the selected items have been removed
-			$('#btnRemove').attr('disabled','disabled');
-			// Re-run the zebra plugin to properly highlight the remaining lines
-			$('.listResults').trigger('update');
-			
-		}
-		
-		function AddObjects()
-		{
-			// TO DO: compute the list of objects already linked with the current Object
-			$.post( GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', { 'operation': 'addObjects',
-										'class': '{$this->m_sClass}',
-										'linkageAttr': '{$this->m_sLinkageAttr}',
-										'linkedClass': '{$this->m_sLinkedClass}',
-										'objectId': '{$this->m_iObjectId}'
-										}, 
-				function(data)
-				{
-					$('#ModalDlg').html(data);
-					dlgWidth = $(document).width() - 100;
-					$('#ModalDlg').css('width', dlgWidth);
-					$('#ModalDlg').css('left', 50);
-					$('#ModalDlg').css('top', 50);
-					$('#ModalDlg').dialog( 'open' );
-				},
-				'html'
-			);
-		}
-		
-		function SearchObjectsToAdd(currentFormId)
-		{
-			var theMap = { 'class': '{$this->m_sClass}',
-						   'linkageAttr': '{$this->m_sLinkageAttr}',
-						   'linkedClass': '{$this->m_sLinkedClass}',
-						   'objectId': '{$this->m_iObjectId}'
-						 }
-			if ($('#'+currentFormId+' :input[name=class]').val() != undefined)
-			{
-				theMap.linkedClass = $('#'+currentFormId+' :input[name=class]').val();
-			}
-			// Gather the parameters from the search form
-			$('#'+currentFormId+' :input').each(
-				function(i)
-				{
-					if (this.name != '')
-					{
-						theMap[this.name] = this.value;
-					}
-				}
-			);
-			theMap['operation'] = 'searchObjectsToAdd';
-			
-			// Run the query and display the results
-			$.post( GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', theMap, 
-				function(data)
-				{
-					$('#SearchResultsToAdd').html(data);
-					$('#SearchResultsToAdd .listResults').tablesorter( { headers: {0: false}}, widgets: ['myZebra', 'truncatedList']} ); // sortable and zebra tables
-					
-				},
-				'html'
-			);
-
-			return false;
-		}
-		
-		function DoAddObjects(currentFormId)
-		{
-			var theMap = { 'class': '{$this->m_sClass}',
-						   'linkageAttr': '{$this->m_sLinkageAttr}',
-						   'linkedClass': '{$this->m_sLinkedClass}',
-						   'objectId': '{$this->m_iObjectId}'
-						 }
-			
-			// Gather the parameters from the search form
-			$('#'+currentFormId+' :input').each(
-				function(i)
-				{
-					if ( (this.name != '') && ((this.type != 'checkbox') || (this.checked)) ) 
-					{
-						//console.log(this.type);
-						arrayExpr = /\[\]$/;
-						if (arrayExpr.test(this.name))
-						{
-							// Array
-							if (theMap[this.name] == undefined)
-							{
-								theMap[this.name] = new Array();
-							}
-							theMap[this.name].push(this.value);
-						}
-						else
-						{
-							theMap[this.name] = this.value;
-						}
-					}
-				}
-			);
-			theMap['operation'] = 'doAddObjects';
-			
-			// Run the query and display the results
-			$.post( GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', theMap, 
-				function(data)
-				{
-					//console.log('Data: ' + data);
-					if (data != '')
-					{
-						$('#empty_row').remove();
-					}
-					$('.listResults tbody').append(data);
-					$('.listResults').trigger('update');
-					$('.listResults').tablesorter( { headers: {0: false}}, widgets: ['myZebra', 'truncatedList']} ); // sortable and zebra tables
-				},
-				'html'
-			);
-			$('#ModalDlg').dialog('close');
-			return false;
-		}
-		
-		function InitForm()
-		{
-			// make sure that the form is clean
-			$('.selection').each( function() { this.checked = false; });
-			$('#btnRemove').attr('disabled','disabled');
-			$('#linksToRemove').val('');
-		}
-		
-		function SubmitHook() 
-		{
-			var the_form = this;
-			SearchObjectsToAdd(the_form.id);
-			return false;
-		}
-EOF
-);
-		$oP->add_ready_script("InitForm();");
-		$oFilter = new DBObjectSearch($this->m_sClass);
-		$oFilter->AddCondition($this->m_sLinkageAttr, $this->m_iObjectId, '=');
-		$oSet = new DBObjectSet($oFilter);
-		$aForm = array();
-		while($oCurrentLink = $oSet->Fetch())
-		{
-			$aRow = array();
-			$key = $oCurrentLink->GetKey();
-			$oLinkedObj = MetaModel::GetObject($this->m_sLinkedClass, $oCurrentLink->Get($this->m_sLinkingAttCode));
-
-			$aForm[$key] = $this->GetFormRow($oP, $oLinkedObj, $oCurrentLink);
-		}
-		//var_dump($aTableLabels);
-		//var_dump($aForm);
-		$this->DisplayFormTable($oP, $this->m_aTableConfig, $aForm);
-		$oP->add("<span style=\"float:left;\">&nbsp;&nbsp;&nbsp;<img src=\"../images/tv-item-last.gif\">&nbsp;&nbsp;<input id=\"btnRemove\" type=\"button\" value=\"".Dict::S('UI:RemoveLinkedObjectsOf_Class')."\" onClick=\"RemoveSelected();\" >");
-		$oP->add("&nbsp;&nbsp;&nbsp;<input id=\"btnAdd\" type=\"button\" value=\"".Dict::Format('UI:AddLinkedObjectsOf_Class', MetaModel::GetName($this->m_sLinkedClass))."\" onClick=\"AddObjects();\"></span>\n");
-		$oP->add("<span style=\"float:right;\"><input id=\"btnCancel\" type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"BackToDetails('".$sTargetClass."', ".$this->m_iObjectId.");\">");
-		$oP->add("&nbsp;&nbsp;&nbsp;<input id=\"btnOk\" type=\"submit\" value=\"".Dict::S('UI:Button:Ok')."\"></span>\n");
-		$oP->add("<span style=\"clear:both;\"><p>&nbsp;</p></span>\n");
-		$oP->add("</div>\n");
-		$oP->add("</form>\n");
-		if (isset($aExtraParams['StartWithAdd']) && ($aExtraParams['StartWithAdd']))
-		{
-			$oP->add_ready_script("AddObjects();");
-		}
-	}
-	
-	protected function GetFormRow($oP, $oLinkedObj, $currentLink = null )
-	{
-		$aRow = array();
-		if(is_object($currentLink))
-		{
-			$key = $currentLink->GetKey();
-			$sNameSuffix = "[$key]"; // To make a tabular form
-			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onChange=\"OnSelectChange();\" value=\"$key\">";
-			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"linkId[$key]\" value=\"$key\">";
-			foreach($this->m_aEditableFields as $sFieldCode)
-			{
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sClass, $sFieldCode, $oAttDef, $currentLink->Get($sFieldCode), '' /* DisplayValue */, $key, $sNameSuffix);
-			}
-		}
-		else
-		{
-			// form for creating a new record
-			$sNameSuffix = "[$currentLink]"; // To make a tabular form
-			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onChange=\"OnSelectChange();\" value=\"$currentLink\">";
-			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"linkId[$currentLink]\" value=\"$currentLink\">";
-			foreach($this->m_aEditableFields as $sFieldCode)
-			{
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sClass, $sFieldCode, $oAttDef, '' /* TO DO/ call GetDefaultValue($oObject->ToArgs()) */, '' /* DisplayValue */, '' /* id */, $sNameSuffix);
-			}
-		}
-		foreach(MetaModel::GetZListItems($this->m_sLinkedClass, 'list') as $sFieldCode)
-		{
-			$aRow['static::'.$sFieldCode] = $oLinkedObj->GetAsHTML($sFieldCode);
-		}
-		return $aRow;
-	}
-	
-	protected function DisplayFormTable(WebPage $oP, $aConfig, $aData)
-	{
-		$oP->add("<table class=\"listResults\">\n");
-		// Header
-		$oP->add("<thead>\n");
-		$oP->add("<tr>\n");
-		foreach($aConfig as $sName=>$aDef)
-		{
-			$oP->add("<th title=\"".$aDef['description']."\">".$aDef['label']."</th>\n");
-		}
-		$oP->add("</tr>\n");
-		$oP->add("</thead>\n");
-		
-		// Content
-		$oP->add("</tbody>\n");
-		if (count($aData) == 0)
-		{
-			$oP->add("<tr id=\"empty_row\"><td colspan=\"".count($aConfig)."\" style=\"text-align:center;\">".Dict::S('UI:Message:EmptyList:UseAdd')."</td></td>");
-		}
-		else
-		{
-			foreach($aData as $iRowId => $aRow)
-			{
-				$this->DisplayFormRow($oP, $aConfig, $aRow, $iRowId);
-			}		
-		}
-		$oP->add("</tbody>\n");
-		
-		// Footer
-		$oP->add("</table>\n");
-	}
-	
-	protected function DisplayFormRow(WebPage $oP, $aConfig, $aRow, $iRowId)
-	{
-		$oP->add("<tr id=\"row_$iRowId\">\n");
-		foreach($aConfig as $sName=>$void)
-		{
-			$oP->add("<td>".$aRow[$sName]."</td>\n");
-		}
-		$oP->add("</tr>\n");
-	}
-	
-	public function DisplayAddForm(WebPage $oP)
-	{
-		$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-		$sTargetClass = $oAttDef->GetTargetClass();
-		$oTargetObj = MetaModel::GetObject($sTargetClass, $this->m_iObjectId);
-		$oP->add("<div class=\"wizContainer\">\n");
-		//$oP->add("<div class=\"page_header\">\n");
-		//$oP->add("<h1>".Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class_Instance', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName(get_class($oTargetObj)), "<span class=\"hilite\">".$oTargetObj->GetHyperlink()."</span>")."</h1>\n");
-		//$oP->add("</div>\n");
-
-		$oFilter = new DBObjectSearch($this->m_sLinkedClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'search', false);
-		$oBlock->Display($oP, 'SearchFormToAdd', array('open' => true));
-		$oP->Add("<form id=\"ObjectsAddForm\" OnSubmit=\"return DoAddObjects(this.id);\">\n");
-		$oP->Add("<div id=\"SearchResultsToAdd\">\n");
-		$oP->Add("<div style=\"height: 100px; background: #fff;border-color:#F6F6F1 #E6E6E1 #E6E6E1 #F6F6F1; border-style:solid; border-width:3px; text-align: center; vertical-align: center;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n");
-		$oP->Add("</div>\n");
-		$oP->add("<input type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#ModalDlg').dialog('close');\">&nbsp;&nbsp;<input type=\"submit\" value=\"".Dict::S('UI:Button:Add')."\">");
-		$oP->Add("</div>\n");
-		$oP->Add("</form>\n");
-		$oP->add_ready_script("$('#ModalDlg').dialog('option', {title:'".Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class_Instance', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName(get_class($oTargetObj)), "<span class=\"hilite\">".$oTargetObj->GetHyperlink()."</span>")."'});");
-		$oP->add_ready_script("$('div#SearchFormToAdd form').bind('submit.uilinksWizard', SubmitHook);");
-	}
-
-	public function SearchObjectsToAdd(WebPage $oP)
-	{
-		//$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-
-		$oFilter = new DBObjectSearch($this->m_sLinkedClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'list', false);
-		$oBlock->Display($oP, 'ResultsToAdd', array('menu' => false, 'selection_mode' => true)); // Don't display the 'Actions' menu on the results
-	}
-	
-	public function DoAddObjects(WebPage $oP, $aLinkedObjectIds = array())
-	{
-		//$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-		//$sTargetClass = $oAttDef->GetTargetClass();
-		//$oP->Add("<!-- nb of objects to add: ".count($aLinkedObjectIds)." -->\n"); // Just to make sure it's not empty
-		$aTable = array();
-		foreach($aLinkedObjectIds as $iObjectId)
-		{
-			$oLinkedObj = MetaModel::GetObject($this->m_sLinkedClass, $iObjectId);
-			if (is_object($oLinkedObj))
-			{
-				$aRow = $this->GetFormRow($oP, $oLinkedObj, -$iObjectId ); // Not yet created link get negative Ids
-				$this->DisplayFormRow($oP, $this->m_aTableConfig, $aRow, -$iObjectId); 
-			}
-			else
-			{
-				echo Dict::Format('UI:Error:Object_Class_Id_NotFound', $this->m_sLinkedClass, $iObjectId);
-			}
-		}
-		//var_dump($aTable);
-		//$oP->Add("<!-- end of added list -->\n"); // Just to make sure it's not empty
-	}
-}
-?>

application/uiwizard.class.inc.php

@@ -1,330 +1,331 @@
-<?php
-// Copyright (C) 2010 Combodo SARL
-//
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
-//
-//   This program is distributed in the hope that it will be useful,
-//   but WITHOUT ANY WARRANTY; without even the implied warranty of
-//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
-//
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-/**
- * Class UIWizard
- *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
-
-class UIWizard
-{
-	protected $m_oPage;
-	protected $m_sClass;
-	protected $m_sTargetState;
-	protected $m_aWizardSteps;
-	
-	public function __construct($oPage, $sClass, $sTargetState = '')
-	{
-		$this->m_oPage = $oPage;
-		$this->m_sClass = $sClass;
-		if (empty($sTargetState))
-		{
-			$sTargetState = MetaModel::GetDefaultState($sClass);
-		}
-		$this->m_sTargetState = $sTargetState;
-		$this->m_aWizardSteps = $this->ComputeWizardStructure();
-	}
-	
-	public function GetObjectClass() { return $this->m_sClass; }
-	public function GetTargetState() { return $this->m_sTargetState; }
-	public function GetWizardStructure() { return $this->m_aWizardSteps; }
-	
-	/**
-	 * Displays one step of the wizard
-	 */	 
-	public function DisplayWizardStep($aStep, $iStepIndex, &$iMaxInputId, &$aFieldsMap, $bFinishEnabled = false, $aArgs = array())
-	{
-		if ($iStepIndex == 1) // one big form that contains everything, to make sure that the uploaded files are posted too
-		{
-			$this->m_oPage->add("<form method=\"post\" enctype=\"multipart/form-data\" action=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php\">\n");
-		}
-		$this->m_oPage->add("<div class=\"wizContainer\" id=\"wizStep$iStepIndex\" style=\"display:none;\">\n");
-		$this->m_oPage->add("<a name=\"step$iStepIndex\" />\n");
-		$aStates = MetaModel::EnumStates($this->m_sClass);
-		$aDetails = array();
-		$sJSHandlerCode = ''; // Javascript code to be executed each time this step of the wizard is entered
-		foreach($aStep as $sAttCode)
-		{
-			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-			if ($oAttDef->IsWritable())
-			{
-				$sAttLabel = $oAttDef->GetLabel();
-				$iOptions = isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode]) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0;
-		
-				$aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
-				if ($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT))
-				{
-					$aFields[$sAttCode] = array();
-					foreach($aPrerequisites as $sCode)
-					{
-						$aFields[$sAttCode][$sCode] = '';
-					}
-				}
-				if (count($aPrerequisites) > 0)
-				{
-					$aOptions[] = 'Prerequisites: '.implode(', ', $aPrerequisites);
-				}
-				
-				$sFieldFlag = (($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE)) || (!$oAttDef->IsNullAllowed()) )? ' <span class="hilite">*</span>' : '';
-				$oDefaultValuesSet = $oAttDef->GetDefaultValue(/* $oObject->ToArgs() */); // @@@ TO DO: get the object's current value if the object exists
-				$sHTMLValue = cmdbAbstractObject::GetFormElementForField($this->m_oPage, $this->m_sClass, $sAttCode, $oAttDef, $oDefaultValuesSet, '', "att_$iMaxInputId", '', $iOptions, $aArgs);
-				$aFieldsMap["att_$iMaxInputId"] = $sAttCode;
-				$aDetails[] = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().$sFieldFlag.'</span>', 'value' => "<span id=\"field_att_$iMaxInputId\">$sHTMLValue</span>");
-				if ($oAttDef->GetValuesDef() != null)
-				{
-					$sJSHandlerCode .= "\toWizardHelper.RequestAllowedValues('$sAttCode');\n";
-				}
-				if ($oAttDef->GetDefaultValue() != null)
-				{
-					$sJSHandlerCode .= "\toWizardHelper.RequestDefaultValue('$sAttCode');\n";
-				}
-				if ($oAttDef->IsLinkSet())
-				{
-					$sJSHandlerCode .= "\toLinkWidgetatt_$iMaxInputId.Init();";
-				}
-				$iMaxInputId++;
-			}
-		}
-		//$aDetails[] = array('label' => '', 'value' => '<input type="button" value="Next &gt;&gt;">');
-		$this->m_oPage->details($aDetails);
-		$sBackButtonDisabled = ($iStepIndex <= 1) ? 'disabled' : '';
-		$sDisabled = $bFinishEnabled ? '' : 'disabled';
-		$nbSteps = count($this->m_aWizardSteps['mandatory']) + count($this->m_aWizardSteps['optional']);
-		$this->m_oPage->add("<div style=\"text-align:center\">
-		<input type=\"button\" value=\"".Dict::S('UI:Button:Back')."\" $sBackButtonDisabled onClick=\"GoToStep($iStepIndex, $iStepIndex - 1)\" />
-		<input type=\"button\" value=\"".Dict::S('UI:Button:Next')."\" onClick=\"GoToStep($iStepIndex, 1+$iStepIndex)\" />
-		<input type=\"button\" value=\"".Dict::S('UI:Button:Finish')."\" $sDisabled onClick=\"GoToStep($iStepIndex, 1+$nbSteps)\" />
-		</div>\n");
-		$this->m_oPage->add_script("
-function OnEnterStep{$iStepIndex}()
-{
-	oWizardHelper.ResetQuery();
-	oWizardHelper.UpdateWizard();
-	
-$sJSHandlerCode
-
-	oWizardHelper.AjaxQueryServer();
-}
-");
-		$this->m_oPage->add("</div>\n\n");
-	}	
-
-	/**
-	 * Display the final step of the wizard: a confirmation screen
-	 */	 	
-	public function DisplayFinalStep($iStepIndex, $aFieldsMap)
-	{
-		$oAppContext = new ApplicationContext();
-		$this->m_oPage->add("<div class=\"wizContainer\" id=\"wizStep$iStepIndex\" style=\"display:none;\">\n");
-		$this->m_oPage->add("<a name=\"step$iStepIndex\" />\n");
-		$this->m_oPage->P(Dict::S('UI:Wizard:FinalStepTitle'));
-		$this->m_oPage->add("<input type=\"hidden\" name=\"operation\" value=\"wizard_apply_new\" />\n");
-		$this->m_oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\" />\n");
-		$this->m_oPage->add("<input type=\"hidden\" id=\"wizard_json_obj\" name=\"json_obj\" value=\"\" />\n");
-		$sScript = "function OnEnterStep$iStepIndex() {\n";
-		foreach($aFieldsMap as $iInputId => $sAttCode)
-		{
-			$sScript .= "\toWizardHelper.UpdateCurrentValue('$sAttCode');\n";		
-		}
-		$sScript .= "\toWizardHelper.Preview('object_preview');\n";		
-		$sScript .= "\t$('#wizard_json_obj').val(oWizardHelper.ToJSON());\n";		
-		$sScript .= "}\n";
-		$this->m_oPage->add_script($sScript);
-		$this->m_oPage->add("<div id=\"object_preview\">\n");
-		$this->m_oPage->add("</div>\n");
-		$this->m_oPage->add($oAppContext->GetForForm());		
-		$this->m_oPage->add("<input type=\"button\" value=\"".Dict::S('UI:Button:Back')."\" onClick=\"GoToStep($iStepIndex, $iStepIndex - 1)\" />");
-		$this->m_oPage->add("<input type=\"submit\" value=\"Create ".MetaModel::GetName($this->m_sClass)."\" />\n");
-		$this->m_oPage->add("</div>\n");
-		$this->m_oPage->add("</form>\n");
-	}	
-	/**
-	 * Compute the order of the fields & pages in the wizard
-	 * @param $oPage iTopWebPage The current page (used to display error messages) 
-	 * @param $sClass string Name of the class
-	 * @param $sStateCode string Code of the target state of the object
-	 * @return hash Two dimensional array: each element represents the list of fields for a given page   
-	 */
-	protected function ComputeWizardStructure()
-	{
-		$aWizardSteps = array( 'mandatory' => array(), 'optional' => array());
-		$aFieldsDone = array(); // Store all the fields that are already covered by a previous step of the wizard
-	
-		$aStates = MetaModel::EnumStates($this->m_sClass);
-		$sStateAttCode = MetaModel::GetStateAttributeCode($this->m_sClass);
-		
-		$aMandatoryAttributes = array();
-		// Some attributes are always mandatory independently of the state machine (if any)
-        foreach(MetaModel::GetAttributesList($this->m_sClass) as $sAttCode)
-        {
-            $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-            if (!$oAttDef->IsExternalField() && !$oAttDef->IsNullAllowed() && 
-			    $oAttDef->IsWritable() && ($sAttCode != $sStateAttCode) )
-            {
-                $aMandatoryAttributes[$sAttCode] = OPT_ATT_MANDATORY;
-            }
-        }
-
-        // Now check the attributes that are mandatory in the specified state
-		if ( (!empty($this->m_sTargetState)) && (count($aStates[$this->m_sTargetState]['attribute_list']) > 0) )
-		{
-			// Check all the fields that *must* be included in the wizard for this
-			// particular target state
-			$aFields = array();
-			foreach($aStates[$this->m_sTargetState]['attribute_list'] as $sAttCode => $iOptions)
-			{
-				if ( (isset($aMandatoryAttributes[$sAttCode])) && 
-					 ($aMandatoryAttributes[$sAttCode] & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) )
-				{
-					$aMandatoryAttributes[$sAttCode] |= $iOptions;
-				}
-				else
-				{
-					$aMandatoryAttributes[$sAttCode] = $iOptions;
-				}
-			}
-		}
-        
-		// Check all the fields that *must* be included in the wizard
-		// i.e. all mandatory, must-change or must-prompt fields that are
-		// not also read-only or hidden.
-		// Some fields may be required (null not allowed) from the database
-		// perspective, but hidden or read-only from the user interface perspective 
-		$aFields = array();
-		foreach($aMandatoryAttributes as $sAttCode => $iOptions)
-		{
-			if ( ($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) &&
-				 !($iOptions & (OPT_ATT_READONLY | OPT_ATT_HIDDEN)) )
-			{
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-				$aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
-				$aFields[$sAttCode] = array();
-				foreach($aPrerequisites as $sCode)
-				{
-					$aFields[$sAttCode][$sCode] = '';
-				}
-			}
-		}
-			
-		// Now use the dependencies between the fields to order them
-		// Start from the order of the 'details'
-		$aList = MetaModel::FlattenZlist(MetaModel::GetZListItems($this->m_sClass, 'details'));
-		$index = 0;
-		$aOrder = array();
-		foreach($aFields as $sAttCode => $void)
-		{
-				$aOrder[$sAttCode] = 999; // At the end of the list...
-		}
-		foreach($aList as $sAttCode)
-		{
-			if (array_key_exists($sAttCode, $aFields))
-			{
-				$aOrder[$sAttCode] = $index;
-			}
-			$index++;
-		}
-		foreach($aFields as $sAttCode => $aDependencies)
-		{
-			// All fields with no remaining dependencies can be entered at this
-			// step of the wizard
-			if (count($aDependencies) > 0)
-			{
-				$iMaxPos = 0;
-				// Remove this field from the dependencies of the other fields
-				foreach($aDependencies as $sDependentAttCode => $void)
-				{
-					// position the current field after the ones it depends on
-					$iMaxPos = max($iMaxPos, 1+$aOrder[$sDependentAttCode]);
-				}
-			}
-		}
-		asort($aOrder);
-		$aCurrentStep = array();
-		foreach($aOrder as $sAttCode => $rank)
-		{
-			$aCurrentStep[] = $sAttCode;
-			$aFieldsDone[$sAttCode] = '';
-		}
-		$aWizardSteps['mandatory'][] = $aCurrentStep;
-
-
-		// Now computes the steps to fill the optional fields
-		$aFields = array(); // reset
-		foreach(MetaModel::ListAttributeDefs($this->m_sClass) as $sAttCode=>$oAttDef)
-		{
-			$iOptions = (isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode])) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0;				
-			if ( ($sStateAttCode != $sAttCode) &&
-				 (!$oAttDef->IsExternalField()) &&
-				 (($iOptions & (OPT_ATT_HIDDEN | OPT_ATT_READONLY)) == 0) &&
-				 (!isset($aFieldsDone[$sAttCode])) )
-				 
-			{
-				// 'State', external fields, read-only and hidden fields
-				// and fields that are already listed in the wizard
-				// are removed from the 'optional' part of the wizard
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-				$aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
-				$aFields[$sAttCode] = array();
-				foreach($aPrerequisites as $sCode)
-				{
-					if (!isset($aFieldsDone[$sCode]))
-					{
-						// retain only the dependencies that were not covered
-						// in the 'mandatory' part of the wizard
-						$aFields[$sAttCode][$sCode] = '';
-					}
-				}
-			}
-		}
-		// Now use the dependencies between the fields to order them
-		while(count($aFields) > 0)
-		{
-			$aCurrentStep = array();
-			foreach($aFields as $sAttCode => $aDependencies)
-			{
-				// All fields with no remaining dependencies can be entered at this
-				// step of the wizard
-				if (count($aDependencies) == 0)
-				{
-					$aCurrentStep[] = $sAttCode;
-					$aFieldsDone[$sAttCode] = '';
-					unset($aFields[$sAttCode]);
-					// Remove this field from the dependencies of the other fields
-					foreach($aFields as $sUpdatedCode => $aDummy)
-					{
-						// remove the dependency
-						unset($aFields[$sUpdatedCode][$sAttCode]);
-					}
-				}
-			}
-			if (count($aCurrentStep) == 0)
-			{
-				// This step of the wizard would contain NO field !
-				$this->m_oPage->add(Dict::S('UI:Error:WizardCircularReferenceInDependencies'));
-				print_r($aFields);
-				break;
-			}
-			$aWizardSteps['optional'][] = $aCurrentStep;
-		}
-		return $aWizardSteps;
-	
-	} 
-}
-?>
+<?php
+// Copyright (C) 2010-2012 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/>
+
+
+/**
+ * Class UIWizard
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class UIWizard
+{
+	protected $m_oPage;
+	protected $m_sClass;
+	protected $m_sTargetState;
+	protected $m_aWizardSteps;
+	
+	public function __construct($oPage, $sClass, $sTargetState = '')
+	{
+		$this->m_oPage = $oPage;
+		$this->m_sClass = $sClass;
+		if (empty($sTargetState))
+		{
+			$sTargetState = MetaModel::GetDefaultState($sClass);
+		}
+		$this->m_sTargetState = $sTargetState;
+		$this->m_aWizardSteps = $this->ComputeWizardStructure();
+	}
+	
+	public function GetObjectClass() { return $this->m_sClass; }
+	public function GetTargetState() { return $this->m_sTargetState; }
+	public function GetWizardStructure() { return $this->m_aWizardSteps; }
+	
+	/**
+	 * Displays one step of the wizard
+	 */	 
+	public function DisplayWizardStep($aStep, $iStepIndex, &$iMaxInputId, &$aFieldsMap, $bFinishEnabled = false, $aArgs = array())
+	{
+		if ($iStepIndex == 1) // one big form that contains everything, to make sure that the uploaded files are posted too
+		{
+			$this->m_oPage->add("<form method=\"post\" enctype=\"multipart/form-data\" action=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php\">\n");
+		}
+		$this->m_oPage->add("<div class=\"wizContainer\" id=\"wizStep$iStepIndex\" style=\"display:none;\">\n");
+		$this->m_oPage->add("<a name=\"step$iStepIndex\" />\n");
+		$aStates = MetaModel::EnumStates($this->m_sClass);
+		$aDetails = array();
+		$sJSHandlerCode = ''; // Javascript code to be executed each time this step of the wizard is entered
+		foreach($aStep as $sAttCode)
+		{
+			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+			if ($oAttDef->IsWritable())
+			{
+				$sAttLabel = $oAttDef->GetLabel();
+				$iOptions = isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode]) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0;
+		
+				$aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
+				if ($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT))
+				{
+					$aFields[$sAttCode] = array();
+					foreach($aPrerequisites as $sCode)
+					{
+						$aFields[$sAttCode][$sCode] = '';
+					}
+				}
+				if (count($aPrerequisites) > 0)
+				{
+					$aOptions[] = 'Prerequisites: '.implode(', ', $aPrerequisites);
+				}
+				
+				$sFieldFlag = (($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE)) || (!$oAttDef->IsNullAllowed()) )? ' <span class="hilite">*</span>' : '';
+				$oDefaultValuesSet = $oAttDef->GetDefaultValue(/* $oObject->ToArgs() */); // @@@ TO DO: get the object's current value if the object exists
+				$sHTMLValue = cmdbAbstractObject::GetFormElementForField($this->m_oPage, $this->m_sClass, $sAttCode, $oAttDef, $oDefaultValuesSet, '', "att_$iMaxInputId", '', $iOptions, $aArgs);
+				$aFieldsMap["att_$iMaxInputId"] = $sAttCode;
+				$aDetails[] = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().$sFieldFlag.'</span>', 'value' => "<span id=\"field_att_$iMaxInputId\">$sHTMLValue</span>");
+				if ($oAttDef->GetValuesDef() != null)
+				{
+					$sJSHandlerCode .= "\toWizardHelper.RequestAllowedValues('$sAttCode');\n";
+				}
+				if ($oAttDef->GetDefaultValue() != null)
+				{
+					$sJSHandlerCode .= "\toWizardHelper.RequestDefaultValue('$sAttCode');\n";
+				}
+				if ($oAttDef->IsLinkSet())
+				{
+					$sJSHandlerCode .= "\toLinkWidgetatt_$iMaxInputId.Init();";
+				}
+				$iMaxInputId++;
+			}
+		}
+		//$aDetails[] = array('label' => '', 'value' => '<input type="button" value="Next &gt;&gt;">');
+		$this->m_oPage->details($aDetails);
+		$sBackButtonDisabled = ($iStepIndex <= 1) ? 'disabled' : '';
+		$sDisabled = $bFinishEnabled ? '' : 'disabled';
+		$nbSteps = count($this->m_aWizardSteps['mandatory']) + count($this->m_aWizardSteps['optional']);
+		$this->m_oPage->add("<div style=\"text-align:center\">
+		<input type=\"button\" value=\"".Dict::S('UI:Button:Back')."\" $sBackButtonDisabled onClick=\"GoToStep($iStepIndex, $iStepIndex - 1)\" />
+		<input type=\"button\" value=\"".Dict::S('UI:Button:Next')."\" onClick=\"GoToStep($iStepIndex, 1+$iStepIndex)\" />
+		<input type=\"button\" value=\"".Dict::S('UI:Button:Finish')."\" $sDisabled onClick=\"GoToStep($iStepIndex, 1+$nbSteps)\" />
+		</div>\n");
+		$this->m_oPage->add_script("
+function OnEnterStep{$iStepIndex}()
+{
+	oWizardHelper.ResetQuery();
+	oWizardHelper.UpdateWizard();
+	
+$sJSHandlerCode
+
+	oWizardHelper.AjaxQueryServer();
+}
+");
+		$this->m_oPage->add("</div>\n\n");
+	}	
+
+	/**
+	 * Display the final step of the wizard: a confirmation screen
+	 */	 	
+	public function DisplayFinalStep($iStepIndex, $aFieldsMap)
+	{
+		$oAppContext = new ApplicationContext();
+		$this->m_oPage->add("<div class=\"wizContainer\" id=\"wizStep$iStepIndex\" style=\"display:none;\">\n");
+		$this->m_oPage->add("<a name=\"step$iStepIndex\" />\n");
+		$this->m_oPage->P(Dict::S('UI:Wizard:FinalStepTitle'));
+		$this->m_oPage->add("<input type=\"hidden\" name=\"operation\" value=\"wizard_apply_new\" />\n");
+		$this->m_oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\" />\n");
+		$this->m_oPage->add("<input type=\"hidden\" id=\"wizard_json_obj\" name=\"json_obj\" value=\"\" />\n");
+		$sScript = "function OnEnterStep$iStepIndex() {\n";
+		foreach($aFieldsMap as $iInputId => $sAttCode)
+		{
+			$sScript .= "\toWizardHelper.UpdateCurrentValue('$sAttCode');\n";		
+		}
+		$sScript .= "\toWizardHelper.Preview('object_preview');\n";		
+		$sScript .= "\t$('#wizard_json_obj').val(oWizardHelper.ToJSON());\n";		
+		$sScript .= "}\n";
+		$this->m_oPage->add_script($sScript);
+		$this->m_oPage->add("<div id=\"object_preview\">\n");
+		$this->m_oPage->add("</div>\n");
+		$this->m_oPage->add($oAppContext->GetForForm());		
+		$this->m_oPage->add("<input type=\"button\" value=\"".Dict::S('UI:Button:Back')."\" onClick=\"GoToStep($iStepIndex, $iStepIndex - 1)\" />");
+		$this->m_oPage->add("<input type=\"submit\" value=\"Create ".MetaModel::GetName($this->m_sClass)."\" />\n");
+		$this->m_oPage->add("</div>\n");
+		$this->m_oPage->add("</form>\n");
+	}	
+	/**
+	 * Compute the order of the fields & pages in the wizard
+	 * @param $oPage iTopWebPage The current page (used to display error messages) 
+	 * @param $sClass string Name of the class
+	 * @param $sStateCode string Code of the target state of the object
+	 * @return hash Two dimensional array: each element represents the list of fields for a given page   
+	 */
+	protected function ComputeWizardStructure()
+	{
+		$aWizardSteps = array( 'mandatory' => array(), 'optional' => array());
+		$aFieldsDone = array(); // Store all the fields that are already covered by a previous step of the wizard
+	
+		$aStates = MetaModel::EnumStates($this->m_sClass);
+		$sStateAttCode = MetaModel::GetStateAttributeCode($this->m_sClass);
+		
+		$aMandatoryAttributes = array();
+		// Some attributes are always mandatory independently of the state machine (if any)
+        foreach(MetaModel::GetAttributesList($this->m_sClass) as $sAttCode)
+        {
+            $oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+            if (!$oAttDef->IsExternalField() && !$oAttDef->IsNullAllowed() && 
+			    $oAttDef->IsWritable() && ($sAttCode != $sStateAttCode) )
+            {
+                $aMandatoryAttributes[$sAttCode] = OPT_ATT_MANDATORY;
+            }
+        }
+
+        // Now check the attributes that are mandatory in the specified state
+		if ( (!empty($this->m_sTargetState)) && (count($aStates[$this->m_sTargetState]['attribute_list']) > 0) )
+		{
+			// Check all the fields that *must* be included in the wizard for this
+			// particular target state
+			$aFields = array();
+			foreach($aStates[$this->m_sTargetState]['attribute_list'] as $sAttCode => $iOptions)
+			{
+				if ( (isset($aMandatoryAttributes[$sAttCode])) && 
+					 ($aMandatoryAttributes[$sAttCode] & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) )
+				{
+					$aMandatoryAttributes[$sAttCode] |= $iOptions;
+				}
+				else
+				{
+					$aMandatoryAttributes[$sAttCode] = $iOptions;
+				}
+			}
+		}
+        
+		// Check all the fields that *must* be included in the wizard
+		// i.e. all mandatory, must-change or must-prompt fields that are
+		// not also read-only or hidden.
+		// Some fields may be required (null not allowed) from the database
+		// perspective, but hidden or read-only from the user interface perspective 
+		$aFields = array();
+		foreach($aMandatoryAttributes as $sAttCode => $iOptions)
+		{
+			if ( ($iOptions & (OPT_ATT_MANDATORY | OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) &&
+				 !($iOptions & (OPT_ATT_READONLY | OPT_ATT_HIDDEN)) )
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+				$aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
+				$aFields[$sAttCode] = array();
+				foreach($aPrerequisites as $sCode)
+				{
+					$aFields[$sAttCode][$sCode] = '';
+				}
+			}
+		}
+			
+		// Now use the dependencies between the fields to order them
+		// Start from the order of the 'details'
+		$aList = MetaModel::FlattenZlist(MetaModel::GetZListItems($this->m_sClass, 'details'));
+		$index = 0;
+		$aOrder = array();
+		foreach($aFields as $sAttCode => $void)
+		{
+				$aOrder[$sAttCode] = 999; // At the end of the list...
+		}
+		foreach($aList as $sAttCode)
+		{
+			if (array_key_exists($sAttCode, $aFields))
+			{
+				$aOrder[$sAttCode] = $index;
+			}
+			$index++;
+		}
+		foreach($aFields as $sAttCode => $aDependencies)
+		{
+			// All fields with no remaining dependencies can be entered at this
+			// step of the wizard
+			if (count($aDependencies) > 0)
+			{
+				$iMaxPos = 0;
+				// Remove this field from the dependencies of the other fields
+				foreach($aDependencies as $sDependentAttCode => $void)
+				{
+					// position the current field after the ones it depends on
+					$iMaxPos = max($iMaxPos, 1+$aOrder[$sDependentAttCode]);
+				}
+			}
+		}
+		asort($aOrder);
+		$aCurrentStep = array();
+		foreach($aOrder as $sAttCode => $rank)
+		{
+			$aCurrentStep[] = $sAttCode;
+			$aFieldsDone[$sAttCode] = '';
+		}
+		$aWizardSteps['mandatory'][] = $aCurrentStep;
+
+
+		// Now computes the steps to fill the optional fields
+		$aFields = array(); // reset
+		foreach(MetaModel::ListAttributeDefs($this->m_sClass) as $sAttCode=>$oAttDef)
+		{
+			$iOptions = (isset($aStates[$this->m_sTargetState]['attribute_list'][$sAttCode])) ? $aStates[$this->m_sTargetState]['attribute_list'][$sAttCode] : 0;				
+			if ( ($sStateAttCode != $sAttCode) &&
+				 (!$oAttDef->IsExternalField()) &&
+				 (($iOptions & (OPT_ATT_HIDDEN | OPT_ATT_READONLY)) == 0) &&
+				 (!isset($aFieldsDone[$sAttCode])) )
+				 
+			{
+				// 'State', external fields, read-only and hidden fields
+				// and fields that are already listed in the wizard
+				// are removed from the 'optional' part of the wizard
+				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+				$aPrerequisites = $oAttDef->GetPrerequisiteAttributes();
+				$aFields[$sAttCode] = array();
+				foreach($aPrerequisites as $sCode)
+				{
+					if (!isset($aFieldsDone[$sCode]))
+					{
+						// retain only the dependencies that were not covered
+						// in the 'mandatory' part of the wizard
+						$aFields[$sAttCode][$sCode] = '';
+					}
+				}
+			}
+		}
+		// Now use the dependencies between the fields to order them
+		while(count($aFields) > 0)
+		{
+			$aCurrentStep = array();
+			foreach($aFields as $sAttCode => $aDependencies)
+			{
+				// All fields with no remaining dependencies can be entered at this
+				// step of the wizard
+				if (count($aDependencies) == 0)
+				{
+					$aCurrentStep[] = $sAttCode;
+					$aFieldsDone[$sAttCode] = '';
+					unset($aFields[$sAttCode]);
+					// Remove this field from the dependencies of the other fields
+					foreach($aFields as $sUpdatedCode => $aDummy)
+					{
+						// remove the dependency
+						unset($aFields[$sUpdatedCode][$sAttCode]);
+					}
+				}
+			}
+			if (count($aCurrentStep) == 0)
+			{
+				// This step of the wizard would contain NO field !
+				$this->m_oPage->add(Dict::S('UI:Error:WizardCircularReferenceInDependencies'));
+				print_r($aFields);
+				break;
+			}
+			$aWizardSteps['optional'][] = $aCurrentStep;
+		}
+		return $aWizardSteps;
+	
+	} 
+}
+?>

application/user.dashboard.class.inc.php

@@ -0,0 +1,61 @@
+<?php
+// Copyright (C) 2010-2012 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/>
+
+/**
+ * Store and retrieve user custom dashboards
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+require_once(APPROOT.'/core/dbobject.class.php');
+
+/**
+ * This class is used to store, in a persistent manner, a dashboard edited by a user
+ */
+class UserDashboard extends DBObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "user_id",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_app_dashboards",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_AUTO, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("menu_code", array("allowed_values"=>null, "sql"=>"menu_code", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("contents", array("allowed_values"=>null, "sql"=>"contents", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+
+	/**
+	* Overloading this function here to secure a fix done right before the release
+	* The real fix should be to implement this verb in DBObject	
+	*/
+	public function DBDeleteTracked(CMDBChange $oChange, $bSkipStrongSecurity = null, &$oDeletionPlan = null)
+	{
+		$this->DBDelete($oDeletionPlan);
+	}
+}
+?>