Version number bump.

* security hardening

.doc/README.md

@@ -23,7 +23,7 @@ Some iTop specific tags were added :
  
 ### known limitations:
 #### `@see` tags must be very specific: 
-   * always prefix class members with `ClassName::` 
+   * always prefix class members (attributes or methods) with `ClassName::` (do not use self) 
    * for methods always suffix them with `()`, 
    * do not reference variables since they are not documented. If you have to, always prefix them with `$`
  

.editorconfig

@@ -1,26 +1,30 @@
+root = true
+
 [*]
 charset = utf-8
 end_of_line = lf
 indent_size = 4
 indent_style = space
 insert_final_newline = false
-max_line_length = 140
+max_line_length = 300
 tab_width = 4
 ij_continuation_indent_size = 8
 ij_formatter_off_tag = @formatter:off
 ij_formatter_on_tag = @formatter:on
 ij_formatter_tags_enabled = false
 ij_smart_tabs = false
-ij_visual_guides = 140
+ij_visual_guides = 300
 ij_wrap_on_typing = true
 
 [*.css]
 indent_style = tab
 ij_smart_tabs = true
+ij_visual_guides = none
 ij_css_align_closing_brace_with_properties = false
 ij_css_blank_lines_around_nested_selector = 1
 ij_css_blank_lines_between_blocks = 1
-ij_css_brace_placement = 0
+ij_css_brace_placement = end_of_line
+ij_css_enforce_quotes_on_format = false
 ij_css_hex_color_long_format = false
 ij_css_hex_color_lower_case = false
 ij_css_hex_color_short_format = false
@@ -31,59 +35,18 @@ ij_css_keep_single_line_blocks = false
 ij_css_properties_order = font,font-family,font-size,font-weight,font-style,font-variant,font-size-adjust,font-stretch,line-height,position,z-index,top,right,bottom,left,display,visibility,float,clear,overflow,overflow-x,overflow-y,clip,zoom,align-content,align-items,align-self,flex,flex-flow,flex-basis,flex-direction,flex-grow,flex-shrink,flex-wrap,justify-content,order,box-sizing,width,min-width,max-width,height,min-height,max-height,margin,margin-top,margin-right,margin-bottom,margin-left,padding,padding-top,padding-right,padding-bottom,padding-left,table-layout,empty-cells,caption-side,border-spacing,border-collapse,list-style,list-style-position,list-style-type,list-style-image,content,quotes,counter-reset,counter-increment,resize,cursor,user-select,nav-index,nav-up,nav-right,nav-down,nav-left,transition,transition-delay,transition-timing-function,transition-duration,transition-property,transform,transform-origin,animation,animation-name,animation-duration,animation-play-state,animation-timing-function,animation-delay,animation-iteration-count,animation-direction,text-align,text-align-last,vertical-align,white-space,text-decoration,text-emphasis,text-emphasis-color,text-emphasis-style,text-emphasis-position,text-indent,text-justify,letter-spacing,word-spacing,text-outline,text-transform,text-wrap,text-overflow,text-overflow-ellipsis,text-overflow-mode,word-wrap,word-break,tab-size,hyphens,pointer-events,opacity,color,border,border-width,border-style,border-color,border-top,border-top-width,border-top-style,border-top-color,border-right,border-right-width,border-right-style,border-right-color,border-bottom,border-bottom-width,border-bottom-style,border-bottom-color,border-left,border-left-width,border-left-style,border-left-color,border-radius,border-top-left-radius,border-top-right-radius,border-bottom-right-radius,border-bottom-left-radius,border-image,border-image-source,border-image-slice,border-image-width,border-image-outset,border-image-repeat,outline,outline-width,outline-style,outline-color,outline-offset,background,background-color,background-image,background-repeat,background-attachment,background-position,background-position-x,background-position-y,background-clip,background-origin,background-size,box-decoration-break,box-shadow,text-shadow
 ij_css_space_after_colon = true
 ij_css_space_before_opening_brace = true
-ij_css_value_alignment = 0
-
-[*.csv]
-max_line_length = 2147483647
-ij_wrap_on_typing = false
-ij_csv_wrap_long_lines = false
-
-[*.feature]
-indent_size = 2
-ij_gherkin_keep_indents_on_empty_lines = false
-
-[*.less]
-indent_size = 2
-ij_less_align_closing_brace_with_properties = false
-ij_less_blank_lines_around_nested_selector = 1
-ij_less_blank_lines_between_blocks = 1
-ij_less_brace_placement = 0
-ij_less_hex_color_long_format = false
-ij_less_hex_color_lower_case = false
-ij_less_hex_color_short_format = false
-ij_less_hex_color_upper_case = false
-ij_less_keep_blank_lines_in_code = 2
-ij_less_keep_indents_on_empty_lines = false
-ij_less_keep_single_line_blocks = false
-ij_less_properties_order = font,font-family,font-size,font-weight,font-style,font-variant,font-size-adjust,font-stretch,line-height,position,z-index,top,right,bottom,left,display,visibility,float,clear,overflow,overflow-x,overflow-y,clip,zoom,align-content,align-items,align-self,flex,flex-flow,flex-basis,flex-direction,flex-grow,flex-shrink,flex-wrap,justify-content,order,box-sizing,width,min-width,max-width,height,min-height,max-height,margin,margin-top,margin-right,margin-bottom,margin-left,padding,padding-top,padding-right,padding-bottom,padding-left,table-layout,empty-cells,caption-side,border-spacing,border-collapse,list-style,list-style-position,list-style-type,list-style-image,content,quotes,counter-reset,counter-increment,resize,cursor,user-select,nav-index,nav-up,nav-right,nav-down,nav-left,transition,transition-delay,transition-timing-function,transition-duration,transition-property,transform,transform-origin,animation,animation-name,animation-duration,animation-play-state,animation-timing-function,animation-delay,animation-iteration-count,animation-direction,text-align,text-align-last,vertical-align,white-space,text-decoration,text-emphasis,text-emphasis-color,text-emphasis-style,text-emphasis-position,text-indent,text-justify,letter-spacing,word-spacing,text-outline,text-transform,text-wrap,text-overflow,text-overflow-ellipsis,text-overflow-mode,word-wrap,word-break,tab-size,hyphens,pointer-events,opacity,color,border,border-width,border-style,border-color,border-top,border-top-width,border-top-style,border-top-color,border-right,border-right-width,border-right-style,border-right-color,border-bottom,border-bottom-width,border-bottom-style,border-bottom-color,border-left,border-left-width,border-left-style,border-left-color,border-radius,border-top-left-radius,border-top-right-radius,border-bottom-right-radius,border-bottom-left-radius,border-image,border-image-source,border-image-slice,border-image-width,border-image-outset,border-image-repeat,outline,outline-width,outline-style,outline-color,outline-offset,background,background-color,background-image,background-repeat,background-attachment,background-position,background-position-x,background-position-y,background-clip,background-origin,background-size,box-decoration-break,box-shadow,text-shadow
-ij_less_space_after_colon = true
-ij_less_space_before_opening_brace = true
-ij_less_value_alignment = 0
-
-[*.sass]
-indent_size = 2
-ij_sass_align_closing_brace_with_properties = false
-ij_sass_blank_lines_around_nested_selector = 1
-ij_sass_blank_lines_between_blocks = 1
-ij_sass_brace_placement = 0
-ij_sass_hex_color_long_format = false
-ij_sass_hex_color_lower_case = false
-ij_sass_hex_color_short_format = false
-ij_sass_hex_color_upper_case = false
-ij_sass_keep_blank_lines_in_code = 2
-ij_sass_keep_indents_on_empty_lines = false
-ij_sass_keep_single_line_blocks = false
-ij_sass_properties_order = font,font-family,font-size,font-weight,font-style,font-variant,font-size-adjust,font-stretch,line-height,position,z-index,top,right,bottom,left,display,visibility,float,clear,overflow,overflow-x,overflow-y,clip,zoom,align-content,align-items,align-self,flex,flex-flow,flex-basis,flex-direction,flex-grow,flex-shrink,flex-wrap,justify-content,order,box-sizing,width,min-width,max-width,height,min-height,max-height,margin,margin-top,margin-right,margin-bottom,margin-left,padding,padding-top,padding-right,padding-bottom,padding-left,table-layout,empty-cells,caption-side,border-spacing,border-collapse,list-style,list-style-position,list-style-type,list-style-image,content,quotes,counter-reset,counter-increment,resize,cursor,user-select,nav-index,nav-up,nav-right,nav-down,nav-left,transition,transition-delay,transition-timing-function,transition-duration,transition-property,transform,transform-origin,animation,animation-name,animation-duration,animation-play-state,animation-timing-function,animation-delay,animation-iteration-count,animation-direction,text-align,text-align-last,vertical-align,white-space,text-decoration,text-emphasis,text-emphasis-color,text-emphasis-style,text-emphasis-position,text-indent,text-justify,letter-spacing,word-spacing,text-outline,text-transform,text-wrap,text-overflow,text-overflow-ellipsis,text-overflow-mode,word-wrap,word-break,tab-size,hyphens,pointer-events,opacity,color,border,border-width,border-style,border-color,border-top,border-top-width,border-top-style,border-top-color,border-right,border-right-width,border-right-style,border-right-color,border-bottom,border-bottom-width,border-bottom-style,border-bottom-color,border-left,border-left-width,border-left-style,border-left-color,border-radius,border-top-left-radius,border-top-right-radius,border-bottom-right-radius,border-bottom-left-radius,border-image,border-image-source,border-image-slice,border-image-width,border-image-outset,border-image-repeat,outline,outline-width,outline-style,outline-color,outline-offset,background,background-color,background-image,background-repeat,background-attachment,background-position,background-position-x,background-position-y,background-clip,background-origin,background-size,box-decoration-break,box-shadow,text-shadow
-ij_sass_space_after_colon = true
-ij_sass_space_before_opening_brace = true
-ij_sass_value_alignment = 0
+ij_css_use_double_quotes = true
+ij_css_value_alignment = do_not_align
 
 [*.scss]
-indent_style = tab
+indent_size = 2
+tab_width = 2
+ij_visual_guides = none
 ij_scss_align_closing_brace_with_properties = false
 ij_scss_blank_lines_around_nested_selector = 1
 ij_scss_blank_lines_between_blocks = 1
 ij_scss_brace_placement = 0
+ij_scss_enforce_quotes_on_format = false
 ij_scss_hex_color_long_format = false
 ij_scss_hex_color_lower_case = false
 ij_scss_hex_color_short_format = false
@@ -94,17 +57,20 @@ ij_scss_keep_single_line_blocks = false
 ij_scss_properties_order = font,font-family,font-size,font-weight,font-style,font-variant,font-size-adjust,font-stretch,line-height,position,z-index,top,right,bottom,left,display,visibility,float,clear,overflow,overflow-x,overflow-y,clip,zoom,align-content,align-items,align-self,flex,flex-flow,flex-basis,flex-direction,flex-grow,flex-shrink,flex-wrap,justify-content,order,box-sizing,width,min-width,max-width,height,min-height,max-height,margin,margin-top,margin-right,margin-bottom,margin-left,padding,padding-top,padding-right,padding-bottom,padding-left,table-layout,empty-cells,caption-side,border-spacing,border-collapse,list-style,list-style-position,list-style-type,list-style-image,content,quotes,counter-reset,counter-increment,resize,cursor,user-select,nav-index,nav-up,nav-right,nav-down,nav-left,transition,transition-delay,transition-timing-function,transition-duration,transition-property,transform,transform-origin,animation,animation-name,animation-duration,animation-play-state,animation-timing-function,animation-delay,animation-iteration-count,animation-direction,text-align,text-align-last,vertical-align,white-space,text-decoration,text-emphasis,text-emphasis-color,text-emphasis-style,text-emphasis-position,text-indent,text-justify,letter-spacing,word-spacing,text-outline,text-transform,text-wrap,text-overflow,text-overflow-ellipsis,text-overflow-mode,word-wrap,word-break,tab-size,hyphens,pointer-events,opacity,color,border,border-width,border-style,border-color,border-top,border-top-width,border-top-style,border-top-color,border-right,border-right-width,border-right-style,border-right-color,border-bottom,border-bottom-width,border-bottom-style,border-bottom-color,border-left,border-left-width,border-left-style,border-left-color,border-radius,border-top-left-radius,border-top-right-radius,border-bottom-right-radius,border-bottom-left-radius,border-image,border-image-source,border-image-slice,border-image-width,border-image-outset,border-image-repeat,outline,outline-width,outline-style,outline-color,outline-offset,background,background-color,background-image,background-repeat,background-attachment,background-position,background-position-x,background-position-y,background-clip,background-origin,background-size,box-decoration-break,box-shadow,text-shadow
 ij_scss_space_after_colon = true
 ij_scss_space_before_opening_brace = true
+ij_scss_use_double_quotes = true
 ij_scss_value_alignment = 0
 
 [*.twig]
-indent_style = tab
 ij_smart_tabs = true
+ij_visual_guides = none
 ij_wrap_on_typing = false
 ij_twig_keep_indents_on_empty_lines = false
+ij_twig_spaces_inside_comments_delimiters = true
 ij_twig_spaces_inside_delimiters = true
 ij_twig_spaces_inside_variable_delimiters = true
 
 [.editorconfig]
+ij_visual_guides = none
 ij_editorconfig_align_group_field_declarations = false
 ij_editorconfig_space_after_colon = false
 ij_editorconfig_space_after_comma = true
@@ -112,10 +78,45 @@ ij_editorconfig_space_before_colon = false
 ij_editorconfig_space_before_comma = false
 ij_editorconfig_spaces_around_assignment_operators = true
 
+[{*.ant, *.fxml, *.jhm, *.jnlp, *.jrxml, *.rng, *.tld, *.wsdl, *.xml, *.xsd, *.xsl, *.xslt, *.xul, phpunit.xml.dist}]
+indent_size = 2
+tab_width = 2
+ij_smart_tabs = true
+ij_visual_guides = none
+ij_wrap_on_typing = false
+ij_xml_align_attributes = true
+ij_xml_align_text = false
+ij_xml_attribute_wrap = normal
+ij_xml_block_comment_at_first_column = true
+ij_xml_keep_blank_lines = 2
+ij_xml_keep_indents_on_empty_lines = false
+ij_xml_keep_line_breaks = true
+ij_xml_keep_line_breaks_in_text = true
+ij_xml_keep_whitespaces = false
+ij_xml_keep_whitespaces_around_cdata = preserve
+ij_xml_keep_whitespaces_inside_cdata = true
+ij_xml_line_comment_at_first_column = true
+ij_xml_space_after_tag_name = false
+ij_xml_space_around_equals_in_attribute = false
+ij_xml_space_inside_empty_tag = false
+ij_xml_text_wrap = off
+
+[{*.bash,*.sh,*.zsh}]
+indent_size = 2
+tab_width = 2
+ij_visual_guides = none
+ij_shell_binary_ops_start_line = false
+ij_shell_keep_column_alignment_padding = false
+ij_shell_minify_program = false
+ij_shell_redirect_followed_by_space = false
+ij_shell_switch_cases_indented = false
+ij_shell_use_unix_line_separator = true
+
 [{*.cjs,*.js}]
 indent_style = tab
 ij_continuation_indent_size = 4
 ij_smart_tabs = true
+ij_visual_guides = none
 ij_javascript_align_imports = false
 ij_javascript_align_multiline_array_initializer_expression = false
 ij_javascript_align_multiline_binary_operation = false
@@ -134,13 +135,13 @@ ij_javascript_array_initializer_wrap = off
 ij_javascript_assignment_wrap = off
 ij_javascript_binary_operation_sign_on_next_line = false
 ij_javascript_binary_operation_wrap = off
-ij_javascript_blacklist_imports = rxjs/Rx,node_modules/**/*
+ij_javascript_blacklist_imports = rxjs/Rx,node_modules/**,**/node_modules/**,@angular/material,@angular/material/typings/**
 ij_javascript_blank_lines_after_imports = 1
 ij_javascript_blank_lines_around_class = 1
 ij_javascript_blank_lines_around_field = 0
 ij_javascript_blank_lines_around_function = 1
 ij_javascript_blank_lines_around_method = 1
-ij_javascript_block_brace_style = next_line
+ij_javascript_block_brace_style = end_of_line
 ij_javascript_call_parameters_new_line_after_left_paren = false
 ij_javascript_call_parameters_right_paren_on_new_line = false
 ij_javascript_call_parameters_wrap = off
@@ -148,15 +149,15 @@ ij_javascript_catch_on_new_line = false
 ij_javascript_chained_call_dot_on_new_line = true
 ij_javascript_class_brace_style = end_of_line
 ij_javascript_comma_on_new_line = false
-ij_javascript_do_while_brace_force = never
-ij_javascript_else_on_new_line = true
+ij_javascript_do_while_brace_force = always
+ij_javascript_else_on_new_line = false
 ij_javascript_enforce_trailing_comma = keep
 ij_javascript_extends_keyword_wrap = off
 ij_javascript_extends_list_wrap = off
 ij_javascript_field_prefix = _
 ij_javascript_file_name_style = relaxed
 ij_javascript_finally_on_new_line = false
-ij_javascript_for_brace_force = never
+ij_javascript_for_brace_force = always
 ij_javascript_for_statement_new_line_after_left_paren = false
 ij_javascript_for_statement_right_paren_on_new_line = false
 ij_javascript_for_statement_wrap = off
@@ -192,6 +193,9 @@ ij_javascript_parentheses_expression_new_line_after_left_paren = false
 ij_javascript_parentheses_expression_right_paren_on_new_line = false
 ij_javascript_place_assignment_sign_on_next_line = false
 ij_javascript_prefer_as_type_cast = false
+ij_javascript_prefer_explicit_types_function_expression_returns = false
+ij_javascript_prefer_explicit_types_function_returns = false
+ij_javascript_prefer_explicit_types_vars_fields = false
 ij_javascript_prefer_parameters_wrap = false
 ij_javascript_reformat_c_style_comments = false
 ij_javascript_space_after_colon = true
@@ -272,11 +276,11 @@ ij_javascript_use_path_mapping = always
 ij_javascript_use_public_modifier = false
 ij_javascript_use_semicolon_after_statement = true
 ij_javascript_var_declaration_wrap = normal
-ij_javascript_while_brace_force = never
+ij_javascript_while_brace_force = always
 ij_javascript_while_on_new_line = false
 ij_javascript_wrap_comments = false
 
-[{*.module,*.hphp,*.phtml,*.php5,*.php4,*.php,*.ctp,*.inc}]
+[{*.ctp, *.hphp, *.inc, *.module, *.php, *.php4, *.php5, *.phtml}]
 indent_style = tab
 ij_continuation_indent_size = 4
 ij_smart_tabs = true
@@ -285,8 +289,8 @@ ij_php_align_assignments = false
 ij_php_align_class_constants = false
 ij_php_align_group_field_declarations = false
 ij_php_align_inline_comments = false
-ij_php_align_key_value_pairs = false
-ij_php_align_multiline_array_initializer_expression = false
+ij_php_align_key_value_pairs = true
+ij_php_align_multiline_array_initializer_expression = true
 ij_php_align_multiline_binary_operation = false
 ij_php_align_multiline_chained_methods = false
 ij_php_align_multiline_extends_list = false
@@ -296,12 +300,14 @@ ij_php_align_multiline_parameters_in_calls = false
 ij_php_align_multiline_ternary_operation = false
 ij_php_align_phpdoc_comments = false
 ij_php_align_phpdoc_param_names = false
+ij_php_anonymous_brace_style = end_of_line
 ij_php_api_weight = 1
 ij_php_array_initializer_new_line_after_left_brace = true
 ij_php_array_initializer_right_brace_on_new_line = true
 ij_php_array_initializer_wrap = on_every_item
 ij_php_assignment_wrap = off
-ij_php_author_weight = 7
+ij_php_attributes_wrap = off
+ij_php_author_weight = 8
 ij_php_binary_operation_sign_on_next_line = false
 ij_php_binary_operation_wrap = off
 ij_php_blank_lines_after_class_header = 0
@@ -318,7 +324,8 @@ ij_php_blank_lines_before_imports = 1
 ij_php_blank_lines_before_method_body = 0
 ij_php_blank_lines_before_package = 1
 ij_php_blank_lines_before_return_statement = 1
-ij_php_block_brace_style = next_line
+ij_php_blank_lines_between_imports = 0
+ij_php_block_brace_style = end_of_line
 ij_php_call_parameters_new_line_after_left_paren = false
 ij_php_call_parameters_right_paren_on_new_line = false
 ij_php_call_parameters_wrap = normal
@@ -328,11 +335,11 @@ ij_php_class_brace_style = next_line
 ij_php_comma_after_last_array_element = true
 ij_php_concat_spaces = false
 ij_php_copyright_weight = 28
-ij_php_deprecated_weight = 28
+ij_php_deprecated_weight = 2
 ij_php_do_while_brace_force = always
 ij_php_else_if_style = as_is
-ij_php_else_on_new_line = true
-ij_php_example_weight = 3
+ij_php_else_on_new_line = false
+ij_php_example_weight = 4
 ij_php_extends_keyword_wrap = off
 ij_php_extends_list_wrap = off
 ij_php_fields_default_visibility = private
@@ -343,6 +350,8 @@ ij_php_for_statement_new_line_after_left_paren = false
 ij_php_for_statement_right_paren_on_new_line = false
 ij_php_for_statement_wrap = off
 ij_php_force_short_declaration_array_style = false
+ij_php_getters_setters_naming_style = camel_case
+ij_php_getters_setters_order_style = getters_first
 ij_php_global_weight = 28
 ij_php_group_use_wrap = on_every_item
 ij_php_if_brace_force = always
@@ -362,7 +371,8 @@ ij_php_keep_control_statement_in_one_line = true
 ij_php_keep_first_column_comment = true
 ij_php_keep_indents_on_empty_lines = false
 ij_php_keep_line_breaks = true
-ij_php_keep_rparen_and_lbrace_on_one_line = true
+ij_php_keep_rparen_and_lbrace_on_one_line = false
+ij_php_keep_simple_classes_in_one_line = false
 ij_php_keep_simple_methods_in_one_line = false
 ij_php_lambda_brace_style = end_of_line
 ij_php_license_weight = 28
@@ -370,6 +380,7 @@ ij_php_line_comment_add_space = false
 ij_php_line_comment_at_first_column = true
 ij_php_link_weight = 28
 ij_php_lower_case_boolean_const = true
+ij_php_lower_case_keywords = true
 ij_php_lower_case_null_const = true
 ij_php_method_brace_style = next_line
 ij_php_method_call_chain_wrap = off
@@ -380,9 +391,11 @@ ij_php_method_weight = 28
 ij_php_modifier_list_wrap = false
 ij_php_multiline_chained_calls_semicolon_on_new_line = false
 ij_php_namespace_brace_style = 1
+ij_php_new_line_after_php_opening_tag = false
 ij_php_null_type_position = in_the_end
 ij_php_package_weight = 28
-ij_php_param_weight = 4
+ij_php_param_weight = 5
+ij_php_parameters_attributes_wrap = off
 ij_php_parentheses_expression_new_line_after_left_paren = false
 ij_php_parentheses_expression_right_paren_on_new_line = false
 ij_php_phpdoc_blank_line_before_tags = true
@@ -399,11 +412,12 @@ ij_php_property_read_weight = 28
 ij_php_property_weight = 28
 ij_php_property_write_weight = 28
 ij_php_return_type_on_new_line = false
-ij_php_return_weight = 5
-ij_php_see_weight = 2
+ij_php_return_weight = 6
+ij_php_see_weight = 3
 ij_php_since_weight = 28
 ij_php_sort_phpdoc_elements = true
 ij_php_space_after_colon = true
+ij_php_space_after_colon_in_named_argument = true
 ij_php_space_after_colon_in_return_type = true
 ij_php_space_after_comma = true
 ij_php_space_after_for_semicolon = true
@@ -417,6 +431,7 @@ ij_php_space_before_catch_parentheses = true
 ij_php_space_before_class_left_brace = true
 ij_php_space_before_closure_left_parenthesis = true
 ij_php_space_before_colon = true
+ij_php_space_before_colon_in_named_argument = false
 ij_php_space_before_colon_in_return_type = false
 ij_php_space_before_comma = false
 ij_php_space_before_do_left_brace = true
@@ -433,6 +448,7 @@ ij_php_space_before_method_call_parentheses = false
 ij_php_space_before_method_left_brace = true
 ij_php_space_before_method_parentheses = false
 ij_php_space_before_quest = true
+ij_php_space_before_short_closure_left_parenthesis = false
 ij_php_space_before_switch_left_brace = true
 ij_php_space_before_switch_parentheses = true
 ij_php_space_before_try_left_brace = true
@@ -465,11 +481,11 @@ ij_php_spaces_within_parentheses = false
 ij_php_spaces_within_short_echo_tags = true
 ij_php_spaces_within_switch_parentheses = false
 ij_php_spaces_within_while_parentheses = false
-ij_php_special_else_if_treatment = false
+ij_php_special_else_if_treatment = true
 ij_php_subpackage_weight = 28
 ij_php_ternary_operation_signs_on_next_line = false
 ij_php_ternary_operation_wrap = off
-ij_php_throws_weight = 6
+ij_php_throws_weight = 7
 ij_php_todo_weight = 28
 ij_php_unknown_tag_weight = 28
 ij_php_upper_case_boolean_const = false
@@ -481,9 +497,24 @@ ij_php_version_weight = 28
 ij_php_while_brace_force = always
 ij_php_while_on_new_line = false
 
-[{*.sht,*.htm,*.html,*.shtm,*.shtml}]
+[{*.har,*.jsb2,*.jsb3,*.json,.babelrc,.eslintrc,.stylelintrc,bowerrc,composer.lock,jest.config}]
+indent_size = 2
+ij_visual_guides = none
+ij_json_keep_blank_lines_in_code = 0
+ij_json_keep_indents_on_empty_lines = false
+ij_json_keep_line_breaks = true
+ij_json_space_after_colon = true
+ij_json_space_after_comma = true
+ij_json_space_before_colon = true
+ij_json_space_before_comma = false
+ij_json_spaces_within_braces = false
+ij_json_spaces_within_brackets = false
+ij_json_wrap_long_lines = false
+
+[{*.htm,*.html,*.sht,*.shtm,*.shtml}]
 indent_style = tab
 ij_smart_tabs = true
+ij_visual_guides = none
 ij_html_add_new_line_before_tags = body,div,p,form,h1,h2,h3
 ij_html_align_attributes = true
 ij_html_align_text = false
@@ -503,209 +534,38 @@ ij_html_keep_whitespaces_inside = span,pre,textarea
 ij_html_line_comment_at_first_column = true
 ij_html_new_line_after_last_attribute = never
 ij_html_new_line_before_first_attribute = never
-ij_html_quote_style = double
+ij_html_quote_style = none
 ij_html_remove_new_line_before_tags = br
 ij_html_space_after_tag_name = false
 ij_html_space_around_equality_in_attribute = false
 ij_html_space_inside_empty_tag = false
 ij_html_text_wrap = normal
+ij_html_uniform_ident = false
 
-[{*.ts,*.ats}]
-ij_continuation_indent_size = 4
-ij_typescript_align_imports = false
-ij_typescript_align_multiline_array_initializer_expression = false
-ij_typescript_align_multiline_binary_operation = false
-ij_typescript_align_multiline_chained_methods = false
-ij_typescript_align_multiline_extends_list = false
-ij_typescript_align_multiline_for = true
-ij_typescript_align_multiline_parameters = true
-ij_typescript_align_multiline_parameters_in_calls = false
-ij_typescript_align_multiline_ternary_operation = false
-ij_typescript_align_object_properties = 0
-ij_typescript_align_union_types = false
-ij_typescript_align_var_statements = 0
-ij_typescript_array_initializer_new_line_after_left_brace = false
-ij_typescript_array_initializer_right_brace_on_new_line = false
-ij_typescript_array_initializer_wrap = off
-ij_typescript_assignment_wrap = off
-ij_typescript_binary_operation_sign_on_next_line = false
-ij_typescript_binary_operation_wrap = off
-ij_typescript_blacklist_imports = rxjs/Rx,node_modules/**/*
-ij_typescript_blank_lines_after_imports = 1
-ij_typescript_blank_lines_around_class = 1
-ij_typescript_blank_lines_around_field = 0
-ij_typescript_blank_lines_around_field_in_interface = 0
-ij_typescript_blank_lines_around_function = 1
-ij_typescript_blank_lines_around_method = 1
-ij_typescript_blank_lines_around_method_in_interface = 1
-ij_typescript_block_brace_style = end_of_line
-ij_typescript_call_parameters_new_line_after_left_paren = false
-ij_typescript_call_parameters_right_paren_on_new_line = false
-ij_typescript_call_parameters_wrap = off
-ij_typescript_catch_on_new_line = false
-ij_typescript_chained_call_dot_on_new_line = true
-ij_typescript_class_brace_style = end_of_line
-ij_typescript_comma_on_new_line = false
-ij_typescript_do_while_brace_force = never
-ij_typescript_else_on_new_line = false
-ij_typescript_enforce_trailing_comma = keep
-ij_typescript_extends_keyword_wrap = off
-ij_typescript_extends_list_wrap = off
-ij_typescript_field_prefix = _
-ij_typescript_file_name_style = relaxed
-ij_typescript_finally_on_new_line = false
-ij_typescript_for_brace_force = never
-ij_typescript_for_statement_new_line_after_left_paren = false
-ij_typescript_for_statement_right_paren_on_new_line = false
-ij_typescript_for_statement_wrap = off
-ij_typescript_force_quote_style = false
-ij_typescript_force_semicolon_style = false
-ij_typescript_function_expression_brace_style = end_of_line
-ij_typescript_if_brace_force = never
-ij_typescript_import_merge_members = global
-ij_typescript_import_prefer_absolute_path = global
-ij_typescript_import_sort_members = true
-ij_typescript_import_sort_module_name = false
-ij_typescript_import_use_node_resolution = true
-ij_typescript_imports_wrap = on_every_item
-ij_typescript_indent_case_from_switch = true
-ij_typescript_indent_chained_calls = true
-ij_typescript_indent_package_children = 0
-ij_typescript_jsdoc_include_types = false
-ij_typescript_jsx_attribute_value = braces
-ij_typescript_keep_blank_lines_in_code = 2
-ij_typescript_keep_first_column_comment = true
-ij_typescript_keep_indents_on_empty_lines = false
-ij_typescript_keep_line_breaks = true
-ij_typescript_keep_simple_blocks_in_one_line = false
-ij_typescript_keep_simple_methods_in_one_line = false
-ij_typescript_line_comment_add_space = true
-ij_typescript_line_comment_at_first_column = false
-ij_typescript_method_brace_style = end_of_line
-ij_typescript_method_call_chain_wrap = off
-ij_typescript_method_parameters_new_line_after_left_paren = false
-ij_typescript_method_parameters_right_paren_on_new_line = false
-ij_typescript_method_parameters_wrap = off
-ij_typescript_object_literal_wrap = on_every_item
-ij_typescript_parentheses_expression_new_line_after_left_paren = false
-ij_typescript_parentheses_expression_right_paren_on_new_line = false
-ij_typescript_place_assignment_sign_on_next_line = false
-ij_typescript_prefer_as_type_cast = false
-ij_typescript_prefer_parameters_wrap = false
-ij_typescript_reformat_c_style_comments = false
-ij_typescript_space_after_colon = true
-ij_typescript_space_after_comma = true
-ij_typescript_space_after_dots_in_rest_parameter = false
-ij_typescript_space_after_generator_mult = true
-ij_typescript_space_after_property_colon = true
-ij_typescript_space_after_quest = true
-ij_typescript_space_after_type_colon = true
-ij_typescript_space_after_unary_not = false
-ij_typescript_space_before_async_arrow_lparen = true
-ij_typescript_space_before_catch_keyword = true
-ij_typescript_space_before_catch_left_brace = true
-ij_typescript_space_before_catch_parentheses = true
-ij_typescript_space_before_class_lbrace = true
-ij_typescript_space_before_class_left_brace = true
-ij_typescript_space_before_colon = true
-ij_typescript_space_before_comma = false
-ij_typescript_space_before_do_left_brace = true
-ij_typescript_space_before_else_keyword = true
-ij_typescript_space_before_else_left_brace = true
-ij_typescript_space_before_finally_keyword = true
-ij_typescript_space_before_finally_left_brace = true
-ij_typescript_space_before_for_left_brace = true
-ij_typescript_space_before_for_parentheses = true
-ij_typescript_space_before_for_semicolon = false
-ij_typescript_space_before_function_left_parenth = true
-ij_typescript_space_before_generator_mult = false
-ij_typescript_space_before_if_left_brace = true
-ij_typescript_space_before_if_parentheses = true
-ij_typescript_space_before_method_call_parentheses = false
-ij_typescript_space_before_method_left_brace = true
-ij_typescript_space_before_method_parentheses = false
-ij_typescript_space_before_property_colon = false
-ij_typescript_space_before_quest = true
-ij_typescript_space_before_switch_left_brace = true
-ij_typescript_space_before_switch_parentheses = true
-ij_typescript_space_before_try_left_brace = true
-ij_typescript_space_before_type_colon = false
-ij_typescript_space_before_unary_not = false
-ij_typescript_space_before_while_keyword = true
-ij_typescript_space_before_while_left_brace = true
-ij_typescript_space_before_while_parentheses = true
-ij_typescript_spaces_around_additive_operators = true
-ij_typescript_spaces_around_arrow_function_operator = true
-ij_typescript_spaces_around_assignment_operators = true
-ij_typescript_spaces_around_bitwise_operators = true
-ij_typescript_spaces_around_equality_operators = true
-ij_typescript_spaces_around_logical_operators = true
-ij_typescript_spaces_around_multiplicative_operators = true
-ij_typescript_spaces_around_relational_operators = true
-ij_typescript_spaces_around_shift_operators = true
-ij_typescript_spaces_around_unary_operator = false
-ij_typescript_spaces_within_array_initializer_brackets = false
-ij_typescript_spaces_within_brackets = false
-ij_typescript_spaces_within_catch_parentheses = false
-ij_typescript_spaces_within_for_parentheses = false
-ij_typescript_spaces_within_if_parentheses = false
-ij_typescript_spaces_within_imports = false
-ij_typescript_spaces_within_interpolation_expressions = false
-ij_typescript_spaces_within_method_call_parentheses = false
-ij_typescript_spaces_within_method_parentheses = false
-ij_typescript_spaces_within_object_literal_braces = false
-ij_typescript_spaces_within_object_type_braces = true
-ij_typescript_spaces_within_parentheses = false
-ij_typescript_spaces_within_switch_parentheses = false
-ij_typescript_spaces_within_type_assertion = false
-ij_typescript_spaces_within_union_types = true
-ij_typescript_spaces_within_while_parentheses = false
-ij_typescript_special_else_if_treatment = true
-ij_typescript_ternary_operation_signs_on_next_line = false
-ij_typescript_ternary_operation_wrap = off
-ij_typescript_union_types_wrap = on_every_item
-ij_typescript_use_chained_calls_group_indents = false
-ij_typescript_use_double_quotes = true
-ij_typescript_use_explicit_js_extension = global
-ij_typescript_use_path_mapping = always
-ij_typescript_use_public_modifier = false
-ij_typescript_use_semicolon_after_statement = true
-ij_typescript_var_declaration_wrap = normal
-ij_typescript_while_brace_force = never
-ij_typescript_while_on_new_line = false
-ij_typescript_wrap_comments = false
+[{*.markdown,*.md}]
+ij_visual_guides = none
+ij_markdown_force_one_space_after_blockquote_symbol = true
+ij_markdown_force_one_space_after_header_symbol = true
+ij_markdown_force_one_space_after_list_bullet = true
+ij_markdown_force_one_space_between_words = true
+ij_markdown_keep_indents_on_empty_lines = false
+ij_markdown_max_lines_around_block_elements = 1
+ij_markdown_max_lines_around_header = 1
+ij_markdown_max_lines_between_paragraphs = 1
+ij_markdown_min_lines_around_block_elements = 1
+ij_markdown_min_lines_around_header = 1
+ij_markdown_min_lines_between_paragraphs = 1
 
-[{*.yml,*.yaml}]
+[{*.yaml,*.yml}]
 indent_size = 2
-ij_continuation_indent_size = 2
+ij_visual_guides = none
+ij_yaml_align_values_properties = do_not_align
+ij_yaml_autoinsert_sequence_marker = true
+ij_yaml_block_mapping_on_new_line = false
+ij_yaml_indent_sequence_value = true
 ij_yaml_keep_indents_on_empty_lines = false
 ij_yaml_keep_line_breaks = true
-
-[{*.zsh,*.bash,*.sh}]
-ij_shell_binary_ops_start_line = false
-ij_shell_keep_column_alignment_padding = false
-ij_shell_minify_program = false
-ij_shell_redirect_followed_by_space = false
-ij_shell_switch_cases_indented = false
-
-[{.stylelintrc,.eslintrc,.babelrc,jest.config,*.bowerrc,*.jsb3,*.jsb2,*.json}]
-indent_size = 2
-ij_json_keep_blank_lines_in_code = 0
-ij_json_keep_indents_on_empty_lines = false
-ij_json_keep_line_breaks = true
-ij_json_space_after_colon = true
-ij_json_space_after_comma = true
-ij_json_space_before_colon = true
-ij_json_space_before_comma = false
-ij_json_spaces_within_braces = false
-ij_json_spaces_within_brackets = false
-ij_json_wrap_long_lines = false
-
-[{phpunit.xml.dist,*.jhm,*.rng,*.wsdl,*.fxml,*.xslt,*.jrxml,*.ant,*.xul,*.xsl,*.xsd,*.tld,*.jnlp,*.xml}]
-indent_size = 2
-indent_style = tab
-tab_width = 2
-ij_smart_tabs = true
-ij_xml_block_comment_at_first_column = true
-ij_xml_keep_indents_on_empty_lines = false
-ij_xml_line_comment_at_first_column = true
+ij_yaml_sequence_on_new_line = false
+ij_yaml_space_before_colon = false
+ij_yaml_spaces_within_braces = true
+ij_yaml_spaces_within_brackets = true

.gitattributes

@@ -0,0 +1,48 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.bash text eol=lf
+*.bat text eol=lf
+*.cmd text eol=lf
+*.css text eol=lf
+*.scss text eol=lf
+*.dist text eol=lf
+.editorconfig text eol=lf
+.env* text eol=lf
+.gitignore text eol=lf
+.htaccess text eol=lf
+*.htm text eol=lf
+*.html text eol=lf
+*.ini text eol=lf
+*.js text eol=lf
+*.json text eol=lf
+*.lock text eol=lf
+*.md text eol=lf
+*.php text eol=lf
+*.php_cs text eol=lf
+*.php8 text eol=lf
+*.plex text eol=lf
+*.sh text eol=lf
+*.svg text eol=lf
+*.ts text eol=lf
+*.twig text eol=lf
+*.txt text eol=lf
+*.xml text eol=lf
+*.xsd text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpeg binary
+*.jpg binary
+*.gif binary
+*.ico binary
+*.pdf binary
+*.swf binary
+*.zip binary
+*.ttf binary
+*.woff binary
+*.woff2 binary

.gitflow

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

.github/pull_request_template.md

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

.github/workflows/action.yml

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

.gitignore

@@ -6,16 +6,16 @@
 # maintenance mode (N°2240)
 /.maintenance
 
-# listing prevention in conf directory
+# composer reserver directory, from sources, populate/update using "composer install"
+vendor/*
+tests/*/vendor/*
+
+# all conf but listing prevention
 /conf/**
 !/conf/.htaccess
 !/conf/index.php
 !/conf/web.config
 
-# composer reserver directory, from sources, populate/update using "composer install"
-vendor/*
-test/vendor/*
-
 # all datas but listing prevention
 /data/**
 !/data/.htaccess
@@ -24,7 +24,9 @@ test/vendor/*
 
 # iTop extensions
 /extensions/**
+!/extensions/.htaccess
 !/extensions/readme.txt
+!/extensions/web.config
 
 # all logs but listing prevention
 /log/**
@@ -32,14 +34,19 @@ test/vendor/*
 !/log/index.php
 !/log/web.config
 
+# PHPUnit: Cache file, local XML working copies
+/tests/php-unit-tests/.phpunit.result.cache
+/tests/php-unit-tests/phpunit.xml
+/tests/php-unit-tests/postbuild_integration.xml
+
 
 # Jetbrains
 /.idea/**
-!/.idea/encodings.xml
-!/.idea/codeStyles
-!/.idea/codeStyles/*
-!/.idea/inspectionProfiles
-!/.idea/inspectionProfiles/*
+!/.idea/IntelliLang.xml
+
+# doc. generation
+/.doc/vendor
+
 
 #phpdocumentor temp file
 ast.dump
@@ -130,4 +137,3 @@ local.properties
 .cache-main
 .scala_dependencies
 .worksheet
-

.idea/IntelliLang.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="LanguageInjectionConfiguration">
+    <injection language="InjectablePHP" injector-id="xml">
+      <display-name>iTop - Class method code</display-name>
+      <place><![CDATA[xmlTag().withLocalName(string().equalTo("code"))]]></place>
+      <xpath-condition>name(..) = 'method' and count(/itop_design) = 1</xpath-condition>
+    </injection>
+    <injection language="InjectablePHP" injector-id="xml">
+      <display-name>iTop - Snippet code</display-name>
+      <place><![CDATA[xmlTag().withLocalName(string().equalTo("snippet"))]]></place>
+      <xpath-condition>name(..) = 'snippets' and count(/itop_design) = 1</xpath-condition>
+    </injection>
+  </component>
+</project>

.idea/codeStyles/Project.xml

@@ -1,79 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <option name="LINE_SEPARATOR" value="&#10;" />
-    <option name="RIGHT_MARGIN" value="140" />
-    <option name="WRAP_WHEN_TYPING_REACHES_RIGHT_MARGIN" value="true" />
-    <option name="SOFT_MARGINS" value="140" />
-    <HTMLCodeStyleSettings>
-      <option name="HTML_DO_NOT_INDENT_CHILDREN_OF" value="html,body,thead,tbody,tfoot,style,script,head" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="USE_CHAINED_CALLS_GROUP_INDENTS" value="true" />
-    </JSCodeStyleSettings>
-    <PHPCodeStyleSettings>
-      <option name="CONCAT_SPACES" value="false" />
-      <option name="COMMA_AFTER_LAST_ARRAY_ELEMENT" value="true" />
-      <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="THROWS_WEIGHT" value="6" />
-      <option name="PARAM_WEIGHT" value="4" />
-      <option name="RETURN_WEIGHT" value="5" />
-      <option name="AUTHOR_WEIGHT" value="7" />
-      <option name="INTERNAL_WEIGHT" value="0" />
-      <option name="API_WEIGHT" value="1" />
-      <option name="EXAMPLE_WEIGHT" value="3" />
-      <option name="SEE_WEIGHT" value="2" />
-      <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>
-    <XML>
-      <option name="XML_TEXT_WRAP" value="0" />
-      <option name="XML_KEEP_LINE_BREAKS" value="false" />
-      <option name="XML_KEEP_WHITE_SPACES_INSIDE_CDATA" value="true" />
-    </XML>
-    <codeStyleSettings language="JavaScript">
-      <option name="BRACE_STYLE" value="2" />
-      <option name="ELSE_ON_NEW_LINE" value="true" />
-      <option name="SPACE_AROUND_ADDITIVE_OPERATORS" value="false" />
-      <option name="IF_BRACE_FORCE" value="3" />
-      <indentOptions>
-        <option name="USE_TAB_CHARACTER" value="true" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="PHP">
-      <option name="BLANK_LINES_AFTER_PACKAGE" value="1" />
-      <option name="BRACE_STYLE" value="2" />
-      <option name="ELSE_ON_NEW_LINE" value="true" />
-      <option name="CATCH_ON_NEW_LINE" value="true" />
-      <option name="FINALLY_ON_NEW_LINE" value="true" />
-      <option name="ALIGN_MULTILINE_PARAMETERS" 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="SCSS">
-      <indentOptions>
-        <option name="USE_TAB_CHARACTER" value="true" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="XML">
-      <option name="WRAP_ON_TYPING" value="1" />
-    </codeStyleSettings>
-  </code_scheme>
-</component>

.idea/codeStyles/codeStyleConfig.xml

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

.idea/encodings.xml

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

@@ -1,48 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Combodo" />
-    <inspection_tool class="HtmlRequiredAltAttribute" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
-    <inspection_tool class="HtmlRequiredLangAttribute" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
-    <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="PhpComposerExtensionStubsInspection" 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="PhpShortOpenTagInspection" 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

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

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

.jenkins/bin/init/append_files.sh

@@ -1,16 +0,0 @@
-#!/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 https://www.combodo.com/documentation/iTopDataModelToolkit-2.3.zip > toolkit.zip
-unzip toolkit.zip
-rm toolkit.zip
-cp -r .jenkins/configuration/default-environment/unattended_install/* toolkit

.jenkins/bin/init/composer_install.sh

@@ -1,11 +0,0 @@
-#!/usr/bin/env bash
-
-set -x
-
-# on the root dir
-# composer install -a # => Not needed anymore (libs were added to git with N°2435)
-
-
-# under the test dir
-cd test
-composer install

.jenkins/bin/init/debug.sh

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

.jenkins/bin/tests/phpunit.sh

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

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

@@ -1,281 +0,0 @@
-<?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',
-
-	// 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

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

@@ -1,209 +0,0 @@
-<?php
-/**
- * Copyright (C) 2013-2019 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
- */
-
-//this scrit will be run under the ./toolkit directory, relatively to the document root
-
-require_once('../approot.inc.php');
-require_once(APPROOT.'/bootstrap.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;
-}

.make/README.md

@@ -0,0 +1,6 @@
+= Make Doc =
+.make folder is meant to gather tools for releasing process. Maybe other new purposes will come as well....
+
+== license ==
+- updateLicenses.php: used to update community-licenses.xml easily based on composer.json files
+- sortLicenceXml.php: used to sort licenses based on scope + product name

.make/build/afterBuild.php

@@ -0,0 +1,90 @@
+<?php
+$iBeginTime = time();
+
+chdir(__DIR__);
+
+$aCommands = [
+	'php composer/rmDeniedTestDir.php',
+	'php build/commands/setupCssCompiler.php',
+//	'bash /tmp/gabuzomeu.sh',
+];
+
+$aFailedCommands=[];
+foreach ($aCommands as $sCommand)
+{
+	if (!ExecCommand($sCommand))
+	{
+		$aFailedCommands[] = $sCommand;
+	}
+}
+
+$iElapsed = time() - $iBeginTime;
+
+if (count($aFailedCommands))
+{
+	fwrite(STDERR, "\nafterBuild execution failed! (in ${iElapsed}s)\n");
+	fwrite(STDERR, "List of failling commands:\n - " . implode("\n - ", $aFailedCommands) . "\n");
+	exit(1);
+}
+
+
+echo "\nDone (${iElapsed}s)\n";
+exit(0);
+
+/**
+ * Executes a command and returns an array with exit code, stdout and stderr content
+ *
+ * @param string $cmd - Command to execute
+ *
+ * @return bool
+ * @throws \Exception
+ */
+function ExecCommand($cmd) {
+	$iBeginTime = time();
+
+
+	echo sprintf("command: %s", str_pad("$cmd ", 50));
+
+	$descriptorspec = array(
+		0 => array("pipe", "r"),  // stdin
+		1 => array("pipe", "w"),  // stdout
+		2 => array("pipe", "w"),  // stderr
+	);
+	$process = proc_open($cmd, $descriptorspec, $pipes, __DIR__ . '/..', null);
+
+	$stdout = stream_get_contents($pipes[1]);
+	fclose($pipes[1]);
+
+	$stderr = stream_get_contents($pipes[2]);
+	fclose($pipes[2]);
+
+	$iCode = proc_close($process);
+	$bSuccess = (0 === $iCode);
+
+	$iElapsed = time() - $iBeginTime;
+	if (!$bSuccess) {
+		fwrite(STDERR, sprintf(
+			"\nCOMMAND FAILED! (%s) \n - status:%s \n - stderr:%s \n - stdout: %s\n - elapsed:%ss\n\n",
+			$cmd,
+			$iCode,
+			rtrim($stderr),
+			rtrim($stdout),
+			$iElapsed
+		));
+	}
+	else
+	{
+		echo "| elapsed:${iElapsed}s \n";
+	}
+
+	if (!empty($stderr))
+	 {
+		 fwrite(STDERR, "$stderr\n");
+	 }
+	 if (!empty($stdout))
+	 {
+		 echo "stdout :$stdout\n\n";
+	 }
+
+	return $bSuccess;
+}

.make/build/commands/setupCssCompiler.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * Copyright (C) 2010-2020 Combodo SARL
+ *
+ *   This file is part of iTop.
+ *
+ *   iTop is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU Affero General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   iTop is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU Affero General Public License for more details.
+ *
+ *   You should have received a copy of the GNU Affero General Public License
+ *   along with iTop. If not, see <http: *www.gnu.org/licenses/>
+ *
+ */
+
+use Combodo\iTop\Composer\iTopComposer;
+
+$iTopFolder = __DIR__."/../../../";
+
+require_once("$iTopFolder/approot.inc.php");
+require_once(APPROOT."/application/utils.inc.php");
+
+if (PHP_SAPI !== 'cli')
+{
+	throw new \Exception('This script can only run from CLI');
+}
+
+$sCssFile = APPROOT.'/css/setup.css';
+if (file_exists($sCssFile))
+{
+	fwrite(STDERR, "$sCssFile already exists (it should not), removing it.");
+	if (!unlink($sCssFile))
+	{
+		fwrite(STDERR, "Failed to remove $sCssFile, exiting.");
+		exit(1);
+	}
+}
+$sCssRelPath = utils::GetCSSFromSASS('css/setup.scss');
+
+if (!file_exists($sCssFile))
+{
+	fwrite(STDERR, "Failed to compile $sCssFile, exiting.");
+	exit(1);
+}

.make/composer/listOutdated.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Copyright (C) 2010-2020 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/>
+ *
+ */
+
+$iTopFolder = __DIR__ . "/../../" ;
+
+require_once ("$iTopFolder/approot.inc.php");
+$sApproot = APPROOT;
+$aTrace = array();
+
+$aParamsConfig = array(
+	'composer-path' => array(
+		'default' => 'composer.phar',
+	)
+);
+$aParamsConfigNotFound = array_flip(array_keys($aParamsConfig));
+$aGivenArgs = $argv;
+unset($aGivenArgs[0]);
+
+$aParams = array();
+
+foreach ($aParamsConfig as $sParam => $aConfig)
+{
+	$bParamsFound = false;
+	foreach ($aGivenArgs as $sGivenArg)
+	{
+		if (preg_match("/--$sParam(?:=(?<value>.*))?$/", $sGivenArg, $aMatches))
+		{
+			$aParams[$sParam] =
+				isset($aMatches['value'])
+					? $aMatches['value']
+					: true
+			;
+			$bParamsFound = true;
+			unset($aGivenArgs[$sGivenArg]);
+
+		}
+	}
+
+	if ($bParamsFound)
+	{
+		unset($aParamsConfigNotFound[$sParam]);
+	}
+}
+
+foreach ($aParamsConfigNotFound as $sParamsConfigNotFound => $void)
+{
+	if (isset($aParamsConfig[$sParamsConfigNotFound]['default']))
+	{
+		$aParams[$sParamsConfigNotFound] = $aParamsConfig[$sParamsConfigNotFound]['default'];
+		$aTrace[] =  "\e[1;30mUsing default value '{$aParams[$sParamsConfigNotFound]}' for '$sParamsConfigNotFound'\e[0m\n";
+		continue;
+	}
+
+	die("Missing '$sParamsConfigNotFound'");
+}
+
+echo "This command aims at helping you find upgradable dependencies\n";
+echo "\e[0;33mBeware of the version colored in orange, they probably introduce BC breaks!\e[0m\n";
+
+$sCommand = "{$aParams['composer-path']} show -loD --working-dir=$sApproot --ansi";
+$execCode = exec($sCommand, $output);
+$sOutput = implode("\n", $output)."\n";
+
+if (!$execCode)
+{
+	echo  "\e[41mFailed to execute '$sCommand'\e[0m\n";
+	echo "Trace: \n".implode("\n", $aTrace);
+}
+else
+{
+	$iCountDepdendenciesFound = count($output);
+
+	$iCountBc =  substr_count($sOutput, '[33m');
+
+	echo sprintf("Found \033[44m%d\033[0m upgradable dependencies, including \e[41m%s  BC break\e[0m 😱 :\n\n", $iCountDepdendenciesFound, $iCountBc);
+}
+
+
+echo $sOutput;
+

.make/composer/rmDeniedTestDir.php

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

.make/license/gen-community-license.sh

@@ -0,0 +1,90 @@
+#/bin/bash
+
+#git diff --name-status 2.6.2..HEAD js |grep   'A\sjs/' |awk -F/ '{printf("lib/%s/%s\n",$2,$3)}'|sort |uniq >/tmp/toto
+#git diff --name-status 2.6.2..HEAD lib |grep   'A\slib/' |awk -F/ '{printf("lib/%s/%s\n",$2,$3)}'|sort |uniq >/tmp/toto
+
+function HELP(){
+  echo "    Syntax: bash $0 /var/www/html/iTop"
+}
+
+if [ $# -eq 0 ]
+then
+	echo "no iTop path provided"
+  HELP
+	exit 1
+fi
+
+iTopPath=$1
+
+if [ ! -d $iTopPath ]
+then
+	echo "$iTopPath is not an iTop path."
+  HELP
+	exit 1
+fi
+
+echo "<?xml version=\"1.0\"?>
+<licenses>"
+
+for subfolder in lib datamodels
+do
+  for l in $(find $iTopPath/$subfolder/ -name composer.json|sed 's|/composer.json||')
+  do
+    if [ ! -d $l ]
+    then
+      continue
+    fi
+    if [ "$subfolder" == "datamodels" ]
+    then
+      if [ $(find $l -name module*.php|wc -l) -ne 0 -o $(echo "$l"|grep -c "itop-portal-base") -ne 0 ]
+      then
+        continue
+      fi
+    fi
+    dir=$(dirname $(dirname $l))
+    prod=$(echo $l| sed "s|$dir/||1")
+    echo $l $subfolder
+    lictype=$(cd $l && composer licenses --format json |jq .license[] |sed 's|\"||g')
+
+    authors=""
+    if [ -f $l/composer.json ]
+    then
+      author_nb=$(grep -c authors $l/composer.json|sed 's| ||g')
+      if [ "x$author_nb" != "x0" ]
+      then
+        OLDIFS=$IFS
+        IFS=$'\n'
+        for a in $(cat $l/composer.json |jq .authors[].name|sed 's|\"||g')
+        do
+          authors="$authors$a - "
+        done
+        authors="$authors#"
+        authors=$(echo $authors |sed 's| - #||')
+        IFS=$OLDIFS
+      fi
+    fi
+
+    lic=""
+    for licf in $(find $l -name LICEN*)
+    do
+      lic=$(cat $licf)
+      break
+    done
+
+    #if [ "x$lic" == "x" ]
+    #then
+    #	echo "============== no license found $l"
+    #fi
+
+    echo "    <license>
+          <product scope=\"$subfolder\">$prod</product>
+          <author>$authors</author>
+          <license_type>$lictype</license_type>
+          <text><![CDATA[
+  $lic
+  ]]></text>
+      </license>"
+  done
+done
+
+echo "</licenses>"

.make/license/sortLicenceXml.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * script used to sort license file (usefull for autogeneration)
+ * Example: 
+ */
+$iTopFolder = __DIR__ . "/../../" ;
+$xmlFilePath = $iTopFolder . "setup/licenses/community-licenses.xml";
+$dom = new DOMDocument();
+$dom->load($xmlFilePath);
+$xp = new DOMXPath($dom);
+
+$licenseList = $xp->query('/licenses/license');
+$licenses = iterator_to_array($licenseList);
+
+
+function get_scope($product_node)
+{
+	$scope = $product_node->getAttribute("scope");
+
+	if ($scope === "")
+	{   //put iTop first
+		return "aaaaaaaaa";
+	}
+	return $scope;
+}
+
+function get_product_node($license_node)
+{
+	foreach ($license_node->childNodes as $child)
+	{
+		if (is_a($child, 'DomElement') && $child->tagName === "product")
+		{
+			return $child;
+		}
+	}
+	return null;
+}
+
+function sort_by_product($a, $b)
+{
+	$aProductNode = get_product_node($a);
+	$bProductNode = get_product_node($b);
+
+	$res = strcmp(get_scope($aProductNode), get_scope($bProductNode));
+	if ($res !== 0)
+	{
+		return $res;
+	}
+	//sort on node product name
+    return strcmp($aProductNode->nodeValue, $bProductNode->nodeValue);
+}
+
+usort($licenses, 'sort_by_product');
+
+$newdom = new DOMDocument("1.0");
+$newdom->formatOutput = true;
+$root = $newdom->createElement("licenses");
+$newdom->appendChild($root);
+foreach ($licenses as $b) {
+    $node = $newdom->importNode($b,true);
+    $root->appendChild($newdom->importNode($b,true));
+}
+
+$newdom->save($xmlFilePath);

.make/license/updateLicenses.php

@@ -0,0 +1,155 @@
+<?php
+/**
+ * script used to sort license file (useful for autogeneration)
+ *
+ * Requirements :
+ *  * bash (on Windows, use Git Bash)
+ *  * composer (if you use the phar version, mind to create a `Composer` alias !)
+ *  * JQ command
+ *    to install on Windows :
+ *       `curl -L -o /usr/bin/jq.exe https://github.com/stedolan/jq/releases/latest/download/jq-win64.exe`
+ *    this is a Windows port : https://stedolan.github.io/jq/
+ *
+ * Licenses sources :
+ *  * `composer licenses --format json` (see https://getcomposer.org/doc/03-cli.md#licenses)
+ *  * keep every existing nodes with `/licenses/license[11]/product/@scope` not in ['lib', 'datamodels']
+ *    ⚠ If licenses were added manually, they might be removed by this tool ! Be very careful to check for the result before pushing !
+ *
+ * To launch, check requirements and run `php updateLicenses.php`
+ * The target license file path is in `$xmlFilePath`
+ */
+
+$iTopFolder = __DIR__."/../../";
+$xmlFilePath = $iTopFolder."setup/licenses/community-licenses.xml";
+
+$jqExec = shell_exec("jq -V"); // a param is mandatory otherwise the script will freeze
+if ((null === $jqExec) || (false === $jqExec)) {
+	echo "/!\ JQ is required but cannot be launched :( \n";
+	echo "Check this script PHPDoc block for instructions\n";
+	die(-1);
+}
+
+
+function get_scope($product_node) {
+	$scope = $product_node->getAttribute("scope");
+
+	if ($scope === "") {   //put iTop first
+		return "aaaaaaaaa";
+	}
+
+	return $scope;
+}
+
+function get_product_node($license_node)
+{
+	foreach ($license_node->childNodes as $child)
+	{
+		if (is_a($child, 'DomElement') && $child->tagName === "product")
+		{
+			return $child;
+		}
+	}
+	return null;
+}
+
+function sort_by_product($a, $b)
+{
+	$aProductNode = get_product_node($a);
+	$bProductNode = get_product_node($b);
+
+	$res = strcmp(get_scope($aProductNode), get_scope($bProductNode));
+	if ($res !== 0)
+	{
+		return $res;
+	}
+	//sort on node product name
+    return strcmp($aProductNode->nodeValue, $bProductNode->nodeValue);
+}
+
+function get_license_nodes($file_path)
+{
+	$dom = new DOMDocument();
+	$dom->load($file_path);
+	$xp = new DOMXPath($dom);
+
+	$licenseList = $xp->query('/licenses/license');
+	$licenses    = iterator_to_array($licenseList);
+
+	usort($licenses, 'sort_by_product');
+
+	return $licenses;
+}
+
+/** @noinspection SuspiciousAssignmentsInspection */
+function fix_product_name(DOMNode &$oProductNode)
+{
+	$sProductNameOrig = $oProductNode->nodeValue;
+
+	// sample : `C:\Dev\wamp64\www\itop-27\.make\license/../..//lib/symfony/polyfill-ctype`
+	$sProductNameFixed = remove_dir_from_string($sProductNameOrig, 'lib/');
+
+	// sample : `C:\Dev\wamp64\www\itop-27\.make\license/../..//datamodels/2.x/authent-cas/vendor/apereo/phpcas`
+	$sProductNameFixed = remove_dir_from_string($sProductNameFixed, 'vendor/');
+
+	$oProductNode->nodeValue = $sProductNameFixed;
+}
+
+function remove_dir_from_string($sString, $sNeedle)
+{
+	if (strpos($sString, $sNeedle) === false) {
+		return $sString;
+	}
+
+	$sStringTmp   = strstr($sString, $sNeedle);
+	$sStringFixed = str_replace($sNeedle, '', $sStringTmp);
+
+	// DEBUG trace O:)
+//	echo "$sNeedle = $sString => $sStringFixed\n";
+
+	return $sStringFixed;
+}
+
+$old_licenses = get_license_nodes($xmlFilePath);
+
+//generate file with updated licenses
+$generated_license_file_path = __DIR__."/provfile.xml";
+echo "- Generating licences...";
+exec("bash ".__DIR__."/gen-community-license.sh $iTopFolder > ".$generated_license_file_path);
+echo "OK!\n";
+
+echo "- Get licenses nodes...";
+$new_licenses = get_license_nodes($generated_license_file_path);
+unlink($generated_license_file_path);
+
+foreach ($old_licenses as $b) {
+	$aProductNode = get_product_node($b);
+
+	if (get_scope($aProductNode) !== "lib" && get_scope($aProductNode) !== "datamodels") {
+		$new_licenses[] = $b;
+	}
+}
+
+usort($new_licenses, 'sort_by_product');
+echo "OK!\n";
+
+echo "- Overwritting Combodo license file...";
+$new_dom = new DOMDocument("1.0");
+$new_dom->formatOutput = true;
+$root = $new_dom->createElement("licenses");
+$new_dom->appendChild($root);
+
+foreach ($new_licenses as $b) {
+	$node = $new_dom->importNode($b, true);
+
+	// N°3870 fix when running script in Windows
+	// fix should be in gen-community-license.sh but it is easier to do it here !
+	if (strncasecmp(PHP_OS, 'WIN', 3) === 0) {
+		$oProductNodeOrig = get_product_node($node);
+		fix_product_name($oProductNodeOrig);
+	}
+
+	$root->appendChild($node);
+}
+
+$new_dom->save($xmlFilePath);
+echo "OK!\n";

.make/release/changelog.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Usage :
+ * `php changelog.php 2.7.4`
+ *
+ * As argument is passed the git ref (tag name or sha1) we want to use as reference
+ *
+ * Outputs :
+ *
+ * 1. List of bugs as CSV :
+ * bug ref;link
+ * Example :
+ * <code>
+ * Bug_ref;Bug_URL;sha1
+ * 1234;https://support.combodo.com/pages/UI.php?operation=details&class=Bug&id=1234;949b213f9|b1ca1f263|a1271da74
+ * </code>
+ *
+ * 2. List of commits sha1/message without bug ref
+ * Example :
+ * <code>
+ * sha1;subject
+ * a6aa183e2;:bookmark: Prepare 2.7.5
+ * </code>
+ */
+
+
+if (count($argv) === 1) {
+	echo '⚠ You must pass the base tag/sha1 as parameter';
+	exit(1);
+}
+$sBaseReference = $argv[1];
+
+
+//--- Get log
+$sGitLogCommand = 'git log --decorate --pretty="%h;%s" --date-order --no-merges '.$sBaseReference.'..HEAD';
+$sGitLogRaw = shell_exec($sGitLogCommand);
+
+
+//--- Analyze log
+$aGitLogLines = preg_split('/\n/', trim($sGitLogRaw));;
+$aLogLinesWithBugRef = [];
+$aLogLineNoBug = [];
+foreach ($aGitLogLines as $sLogLine) {
+	$sBugRef = preg_match('/[nN]°(\d{3,4})/', $sLogLine, $aLineBugRef);
+	if (($sBugRef === false) || empty($aLineBugRef)) {
+		$aLogLineNoBug[] = $sLogLine;
+		continue;
+	}
+
+	$iBugId = $aLineBugRef[1];
+	$sSha = substr($sLogLine, 0, 9);
+
+	if (array_key_exists($iBugId, $aLogLinesWithBugRef)) {
+		$aBugShaRefs = $aLogLinesWithBugRef[$iBugId];
+		$aBugShaRefs[] = $sSha;
+		$aLogLinesWithBugRef[$iBugId] = $aBugShaRefs;
+	} else {
+		$aLogLinesWithBugRef[$iBugId] = [$sSha];
+	}
+}
+$aBugsList = array_keys($aLogLinesWithBugRef);
+sort($aBugsList, SORT_NUMERIC);
+
+
+//-- Output results
+echo "# Bugs included\n";
+echo "Bug_ref;Bug_URL;sha1\n";
+foreach ($aBugsList as $sBugRef) {
+	$sShaRefs = implode('|', $aLogLinesWithBugRef[$sBugRef]);
+	echo "{$sBugRef};https://support.combodo.com/pages/UI.php?operation=details&class=Bug&id={$sBugRef};$sShaRefs\n";
+}
+echo "\n";
+echo "# Logs line without bug referenced\n";
+echo "sha1;subject\n";
+foreach ($aLogLineNoBug as $sLogLine) {
+	echo "$sLogLine\n";
+}

.make/release/update-versions.php

@@ -0,0 +1,48 @@
+<?php
+
+/*******************************************************************************
+ * Tool to automate version update before release
+ *
+ * Will update version in the following files :
+ *
+ * * datamodels/2.x/.../module.*.php
+ * * datamodels/2.x/version.xml
+ * * css/css-variables.scss $version
+ *
+ * Usage :
+ * `php .make\release\update-versions.php "2.7.0-rc"`
+ *
+ * @since 2.7.0
+ ******************************************************************************/
+
+
+
+require_once (__DIR__.'/../../approot.inc.php');
+require_once (__DIR__.DIRECTORY_SEPARATOR.'update.classes.inc.php');
+
+
+
+/** @var \FileVersionUpdater[] $aFilesUpdaters */
+$aFilesUpdaters = array(
+	new iTopVersionFileUpdater(),
+	new CssVariablesFileUpdater(),
+	new DatamodelsModulesFiles(),
+	new ConstantFileUpdater('ITOP_CORE_VERSION', 'approot.inc.php'),
+);
+
+if (count($argv) === 1)
+{
+	echo '/!\ You must pass the new version as parameter';
+	exit(1);
+}
+$sVersionLabel = $argv[1];
+if (empty($sVersionLabel))
+{
+	echo 'Version passed as parameter is empty !';
+	exit(2);
+}
+
+foreach ($aFilesUpdaters as $oFileVersionUpdater)
+{
+	$oFileVersionUpdater->UpdateAllFiles($sVersionLabel);
+}

.make/release/update-xml.php

@@ -0,0 +1,36 @@
+<?php
+
+/*******************************************************************************
+ * Tool to automate datamodel version update in XML
+ *
+ * Will update version in the following files :
+ *
+ * datamodels/2.x/.../datamodel.*.xml
+ *
+ * Usage :
+ * `php .make\release\update-xml.php "1.7"`
+ *
+ * @since 2.7.0
+ ******************************************************************************/
+
+
+
+require_once (__DIR__.'/../../approot.inc.php');
+require_once (__DIR__.DIRECTORY_SEPARATOR.'update.classes.inc.php');
+
+
+
+if (count($argv) === 1)
+{
+	echo '/!\ You must pass the new version as parameter';
+	exit(1);
+}
+$sVersionLabel = $argv[1];
+if (empty($sVersionLabel))
+{
+	echo 'Version passed as parameter is empty !';
+	exit(2);
+}
+
+$oFileVersionUpdater = new DatamodelsXmlFiles();
+$oFileVersionUpdater->UpdateAllFiles($sVersionLabel);

.make/release/update.classes.inc.php

@@ -0,0 +1,203 @@
+<?php
+
+/*******************************************************************************
+ * Classes for updater tools
+ *
+ * @see update-versions.php
+ * @see update-xml.php
+ ******************************************************************************/
+
+
+
+require_once (__DIR__.'/../../approot.inc.php');
+
+
+
+
+abstract class FileVersionUpdater
+{
+	/**
+	 * @return string[] full path of files to modify
+	 */
+	abstract public function GetFiles();
+
+	/**
+	 * Warnign : will consume lots of memory on larger files !
+	 *
+	 * @param string $sVersionLabel
+	 * @param string $sFileContent
+	 * @param string $sFileFullPath
+	 *
+	 * @return string file content with replaced values
+	 */
+	abstract public function UpdateFileContent($sVersionLabel, $sFileContent, $sFileFullPath);
+
+	public function UpdateAllFiles($sVersionLabel)
+	{
+		$aFilesToUpdate = $this->GetFiles();
+		$sFileUpdaterName = get_class($this);
+		echo "# Updater : $sFileUpdaterName\n";
+		foreach ($aFilesToUpdate as $sFileToUpdateFullPath)
+		{
+			try
+			{
+				$sCurrentFileContent = file_get_contents($sFileToUpdateFullPath);
+				$sNewFileContent = $this->UpdateFileContent($sVersionLabel, $sCurrentFileContent, $sFileToUpdateFullPath);
+				file_put_contents($sFileToUpdateFullPath, $sNewFileContent);
+				echo "   - $sFileToUpdateFullPath : OK !\n";
+			}
+			catch (Exception $e)
+			{
+				echo "   - $sFileToUpdateFullPath : Error :(\n";
+			}
+		}
+	}
+}
+
+abstract class AbstractSingleFileVersionUpdater extends FileVersionUpdater
+{
+	private $sFileToUpdate;
+
+	public function __construct($sFileToUpdate)
+	{
+		$this->sFileToUpdate = $sFileToUpdate;
+	}
+
+	public function GetFiles()
+	{
+		return array(APPROOT.$this->sFileToUpdate);
+	}
+}
+
+/**
+ * @since 2.7.7 3.0.1 3.1.0 N°4714
+ */
+class ConstantFileUpdater extends AbstractSingleFileVersionUpdater {
+	/** @var string */
+	private $sConstantName;
+
+	/**
+	 * @param $sConstantName constant to search, for example `ITOP_CORE_VERSION`
+	 * @param $sFileToUpdate file containing constant definition
+	 */
+	public function __construct($sConstantName, $sFileToUpdate)
+	{
+		$this->sConstantName = $sConstantName;
+		parent::__construct($sFileToUpdate);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function UpdateFileContent($sVersionLabel, $sFileContent, $sFileFullPath)
+	{
+		$sConstantSearchPattern = <<<REGEXP
+/define\('{$this->sConstantName}', ?'[^']+'\);/
+REGEXP;
+
+		return preg_replace(
+			$sConstantSearchPattern,
+			"define('{$this->sConstantName}', '{$sVersionLabel}');",
+			$sFileContent
+		);
+	}
+}
+
+class iTopVersionFileUpdater extends AbstractSingleFileVersionUpdater
+{
+	public function __construct()
+	{
+		parent::__construct('datamodels/2.x/version.xml');
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function UpdateFileContent($sVersionLabel, $sFileContent, $sFileFullPath)
+	{
+		return preg_replace(
+			'/(<version>)[^<]*(<\/version>)/',
+			'${1}'.$sVersionLabel.'${2}',
+			$sFileContent
+		);
+	}
+}
+
+class CssVariablesFileUpdater extends AbstractSingleFileVersionUpdater
+{
+	public function __construct()
+	{
+		parent::__construct('css/css-variables.scss');
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function UpdateFileContent($sVersionLabel, $sFileContent, $sFileFullPath)
+	{
+		return preg_replace(
+			'/(\$version: "v)[^"]*(";)/',
+			'${1}'.$sVersionLabel.'${2}',
+			$sFileContent
+		);
+	}
+}
+
+abstract class AbstractGlobFileVersionUpdater extends FileVersionUpdater
+{
+	protected $sGlobPattern;
+
+	public function __construct($sGlobPattern)
+	{
+		$this->sGlobPattern = $sGlobPattern;
+	}
+
+	public function GetFiles()
+	{
+		return glob($this->sGlobPattern);
+	}
+}
+
+class DatamodelsModulesFiles extends AbstractGlobFileVersionUpdater
+{
+	public function __construct()
+	{
+		parent::__construct(APPROOT.'datamodels/2.x/*/module.*.php');
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function UpdateFileContent($sVersionLabel, $sFileContent, $sFileFullPath)
+	{
+		$sModulePath = realpath($sFileFullPath);
+		$sModuleFileName = basename($sModulePath, 1);
+		$sModuleName = preg_replace('/[^.]+\.([^.]+)\.php/', '$1', $sModuleFileName);
+
+		return preg_replace(
+			"/('$sModuleName\/)[^']+(')/",
+			'${1}'.$sVersionLabel.'${2}',
+			$sFileContent
+		);
+	}
+}
+
+class DatamodelsXmlFiles extends AbstractGlobFileVersionUpdater
+{
+	public function __construct()
+	{
+		parent::__construct(APPROOT.'datamodels/2.x/*/datamodel.*.xml');
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function UpdateFileContent($sVersionLabel, $sFileContent, $sFileFullPath)
+	{
+		return preg_replace(
+			'/(<itop_design .* version=")[^"]+(">)/',
+			'${1}'.$sVersionLabel.'${2}',
+			$sFileContent
+		);
+	}
+}

CONTRIBUTING.md

@@ -10,8 +10,8 @@ Here are some guidelines that will help us integrate your work!
 ### Subjects
 You are welcome to create pull requests on any of those subjects:
 
-* 🐛 `:bug:` bug fix
-* 🌐 `:globe_with_meridians:` translation / i18n / l10n
+* 🐛 bug fix
+* 🌐 translation / i18n / l10n
 
 If you want to implement a **new feature**, please [create a corresponding ticket](https://sourceforge.net/p/itop/tickets/new/) for review.   
 If you ever want to begin implementation, do so in a fork, and add a link to the corresponding commits in the ticket.
@@ -27,7 +27,7 @@ If you have an idea you're sure would benefit to all of iTop users, you may
 [create a corresponding ticket](https://sourceforge.net/p/itop/tickets/new/) to submit it, but be warned that there are lots of good 
 reasons to refuse such changes.
 
-### License
+### 📄 License
 iTop is distributed under the AGPL-3.0 license (see the [license.txt] file),
 your code must comply with this license.
 
@@ -37,58 +37,69 @@ If you want to use another license, you may [create an extension][wiki new ext].
 [wiki new ext]: https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Astart#by_writing_your_own_extension
 
 
-## Branch model
+## 🔀 iTop branch model
 
-TL;DR:
-> **create a fork from iTop main repository,  
-> create a branch based on the develop branch**
+When we first start with Git, we were using the [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) branch model. As
+ there was some confusions about branches to use for current developed release and previous maintained release, and also because we were
+ using just a very few of the GitFlow commands, we decided to add just a little modification to this branch model : since april 2020
+  we don't have anymore a `master` branch.
 
-We are using the [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) branch model. That means we have in our repo those
-main branches:
+Here are the branches we use and their meaning : 
 
-- develop: ongoing development version
-- release/\*: if present, that means we are working on a beta version
-- master: previous stable version
-- support/\*: maintenance branches for older versions
+- `develop`: ongoing development version
+- `release/*`: if present, that means we are working on a alpha/beta/rc version for shipping
+- `support/*`: maintenance branches for older versions
 
-For example, if no beta version is currently ongoing we could have:
+For example, if no version is currently prepared for shipping we could have:
 
-- develop containing future 2.8.0 version
-- master containing 2.7.x maintenance version
-- support/2.6 containing 2.6.x maintenance version
-- support/2.5 containing 2.5.x maintenance version
+- `develop` containing future 2.8.0 version
+- `support/2.7`: 2.7.x maintenance version
+- `support/2.6`: 2.6.x maintenance version
+- `support/2.5`: 2.5.x maintenance version
 
 In this example, when 2.8.0-beta is shipped that will become:
 
-- develop: future 2.9.0 version
-- release/2.8: 2.8.0-beta
-- master: 2.7.x maintenance version
-- support/2.6 containing 2.6.x maintenance version
-- support/2.5 containing 2.5.x maintenance version
+- `develop`: future 2.9.0 version
+- `release/2.8`: 2.8.0-beta
+- `support/2.7`: 2.7.x maintenance version
+- `support/2.6`: 2.6.x maintenance version
+- `support/2.5`: 2.5.x maintenance version
 
 And when 2.8.0 final will be out:
 
-- develop: future 2.9.0 version
-- master: 2.8.x maintenance version
-- support/2.7 : 2.7.x maintenance version
-- support/2.6 containing 2.6.x maintenance version
-- support/2.5 containing 2.5.x maintenance version
+- `develop`: future 2.9.0 version
+- `support/2.8`: 2.8.x maintenance version (will host developments for 2.8.1)
+- `support/2.7`: 2.7.x maintenance version
+- `support/2.6`: 2.6.x maintenance version
+- `support/2.5`: 2.5.x maintenance version
 
-Most of the time you should based your developments on the develop branch.  
-That may be different if you want to fix a bug, please use develop anyway and ask in your PR if rebase is possible.
+Also note that we have a "micro-version" concept : each of those versions have a very small amount of modifications. They are made from
+ `support/*` branches as well. For example 2.6.2-1 and 2.6.2-2 were made from the `support/2.6.2` branch. 
 
 
 ## Coding
 
-### PHP styleguide
-
-Please follow [our guidelines](https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Acoding_standards).
-
 ### 🌐 Translations
 
 A [dedicated page](https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Atranslation) is available in the official wiki.
 
-### Tests
+### Where to start ?
+
+1. Create a fork from our repository (see [Working with forks - GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks))
+2. Create a branch in this fork, based on the develop branch
+3. Code !
+
+Do create a dedicated branch for each modification you want to propose : if you don't it will be very hard to merge back your work !
+
+Most of the time you should based your developments on the develop branch.    
+That may be different if you want to fix a bug, please use develop anyway and ask in your PR if rebase is possible.
+
+
+### 🎨 PHP styleguide
+
+Please follow [our guidelines](https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Acoding_standards).
+
+### ✅ Tests
 
 Please create tests that covers as much as possible the code you're submitting.
 
@@ -100,9 +111,9 @@ Our tests are located in the `test/` directory, containing a PHPUnit config file
 * Use the present tense ("Add feature" not "Added feature")
 * Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
 * Limit the first line to 72 characters or less
-* Please start the commit message with an applicable emoji code (following the [Gitmoji guide](https://gitmoji.carloscuesta.me/)).  
- Beware to use the code (for example `:bug:`) and not the character (🐛) as Unicode support in git clients is very poor for now...  
- Emoji examples :
+* Please start the commit message with an applicable emoji code (following the [Gitmoji guide](https://gitmoji.dev/)).  
+  Beware to use the code (for example `:bug:`) and not the character (🐛) as Unicode support in git clients is very poor for now...  
+  Emoji examples :
     * 🌐 `:globe_with_meridians:` for translations
     * 🎨 `:art:` when improving the format/structure of the code
     * ⚡️ `:zap:` when improving performance
@@ -117,11 +128,11 @@ Our tests are located in the `test/` directory, containing a PHPUnit config file
     * 💄 `:lipstick:` Updating the UI and style files.  
   
 
-## Pull request
+## 👥 Pull request
 
 When your code is working, please:
 
-* stash as much as possible your commits,
+* squash as much as possible your commits,
 * rebase your branch on our repo last commit,
 * create a pull request.
 

Jenkinsfile

@@ -1,65 +1,19 @@
-pipeline {
-  agent any
-  stages {
+def infra
 
-    stage('init') {
-      parallel {
-        stage('debug') {
-          steps {
-            sh './.jenkins/bin/init/debug.sh'
-          }
-        }
-        stage('append files to project') {
-          steps {
-            sh './.jenkins/bin/init/append_files.sh'
-          }
-        }
-        stage('composer install') {
-          steps {
-            sh './.jenkins/bin/init/composer_install.sh'
-          }
-        }
-      }
-    }
+node(){
+    properties([
+            buildDiscarder(
+                    logRotator(
+                            daysToKeepStr: "28",
+                            numToKeepStr: "500")
+            )
+    ])
 
-    stage('unattended_install') {
-      parallel {
-        stage('unattended_install default env') {
-          steps {
-            sh './.jenkins/bin/unattended_install/default_env.sh'
-          }
-        }
-      }
-    }
+  checkout scm
 
-    stage('test') {
-      parallel {
-        stage('phpunit') {
-          steps {
-            sh './.jenkins/bin/tests/phpunit.sh'
-          }
-        }
-      }
-    }
-
-  }
-
-  post {
-    always {
-      junit 'var/test/phpunit-log.junit.xml'
-    }
-    failure {
-      slackSend(channel: "#jenkins-itop", color: '#FF0000', message: "Ho no! Build failed! (${currentBuild.result}), Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")
-    }
-    fixed {
-      slackSend(channel: "#jenkins-itop", color: '#FFa500', message: "Yes! Build repaired! (${currentBuild.result}), Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")
-    }
-  }
-
-  environment {
-    DEBUG_UNIT_TEST = '0'
-  }
-  options {
-    timeout(time: 20, unit: 'MINUTES')
-  }
+  infra = load '/var/lib/jenkins/workspace/itop-test-infra_master/src/Infra.groovy'
 }
+
+
+infra.call()
+

README.md

@@ -21,6 +21,19 @@ iTop also offers mass import tools and web services to integrate with your IT
 - [Data synchronization][18] (for data federation)
 
 
+## Latest release
+
+- [Changes since the previous version][62]
+- [New features][63]
+- [Installation notes][64]
+- [Download][65]
+
+[62]: https://www.itophub.io/wiki/page?id=latest:release:change_log
+[63]: https://www.itophub.io/wiki/page?id=latest:release:start
+[64]: https://www.itophub.io/wiki/page?id=latest:install:start
+[65]: https://sourceforge.net/projects/itop/files/latest/download
+
+
 ## Resources
 
  - [iTop Forums][1]: community support
@@ -49,48 +62,6 @@ iTop also offers mass import tools and web services to integrate with your IT
 
 
 
-## Last releases
-
-### Versions 2.6.*
- - 2.6.0 published on January 9, 2019
- - [Changes since the previous version][58]
- - [New features][59]
- - [Migration notes][60]
- - [Download iTop 2.6.1][61]
-
-[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
-
-
-### Versions 2.5.*
- - 2.5.0 published on July 11, 2018
- - [Changes since the previous version][54]
- - [New features][55]
- - [Migration notes][56]
- - [Download iTop 2.5.1][57]
-
-[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
- 
-
-### Versions 2.4.*
- - 2.4.0 published on November 16, 2017
- - [Changes since the previous version][50]
- - [New features][51]
- - [Migration notes][52]
- - [Download iTop 2.4.1][53]
-
-[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
-
-
-
 ## About Us
 
 iTop development is sponsored, led and supported by [Combodo][0].
@@ -112,6 +83,7 @@ We would like to give a special thank you to the people from the community who c
  - Casteleyn, Thomas
  - Castro, Randall Badilla
  - Colantoni, Maria Laura
+ - Couronné, Guy
  - Dvořák, Lukáš
  - Goethals, Stefan
  - Gumble, David
@@ -121,9 +93,11 @@ We would like to give a special thank you to the people from the community who c
  - Konečný, Kamil
  - Kunin, Vladimir
  - Lassiter, Dennis
+ - Lazcano, Federico
  - Lucas, Jonathan
- - Malik, Remie
- - Rosenke, Stephan
+- Malik, Remie
+- Mindêllo de Andrade, Lucas (a.k.a @rokam)
+- Rosenke, Stephan
  - Seki, Shoji
  - Shilov, Vladimir
  - Tulio, Marco
@@ -143,4 +117,5 @@ We would like to give a special thank you to the people from the community who c
 ### Companies
  - Hardis
  - ITOMIG
+ - Pimkie
 

addons/userrights/userrightsmatrix.class.inc.php

@@ -121,20 +121,15 @@ class UserRightsMatrix extends UserRightsAddOnAPI
 	public function CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage = 'EN US')
 	{
 		// Maybe we should check that no other user with userid == 0 exists
+		CMDBObject::SetTrackInfo('Initialization');
 		$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 */);
+		$iUserId = $oUser->DBInsertNoReload();
 		$this->SetupUser($iUserId, true);
 		return true;
 	}

addons/userrights/userrightsprofile.class.inc.php

@@ -1,27 +1,20 @@
 <?php
-// Copyright (C) 2010-2013 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/>
-
 /**
- * UserRightsProfile
- * User management Module, basing the right on profiles and a matrix (similar to UserRightsMatrix, but profiles and other decorations have been added) 
+ * Copyright (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2012 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 define('ADMIN_PROFILE_NAME', 'Administrator');
@@ -30,7 +23,7 @@ define('PORTAL_PROFILE_NAME', 'Portal user');
 class UserRightsBaseClassGUI extends cmdbAbstractObject
 {
 	// Whenever something changes, reload the privileges
-	
+
 	protected function AfterInsert()
 	{
 		UserRights::FlushPrivileges();
@@ -80,7 +73,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 	}
 
 	protected static $m_aCacheProfiles = null;
-	
+
 	public static function DoCreateProfile($sName, $sDescription)
 	{
 		if (is_null(self::$m_aCacheProfiles))
@@ -92,7 +85,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 			{
 				self::$m_aCacheProfiles[$oProfile->Get('name')] = $oProfile->GetKey();
 			}
-		}	
+		}
 
 		$sCacheKey = $sName;
 		if (isset(self::$m_aCacheProfiles[$sCacheKey]))
@@ -103,10 +96,10 @@ class URP_Profiles extends UserRightsBaseClassGUI
 		$oNewObj->Set('name', $sName);
 		$oNewObj->Set('description', $sDescription);
 		$iId = $oNewObj->DBInsertNoReload();
-		self::$m_aCacheProfiles[$sCacheKey] = $iId;	
+		self::$m_aCacheProfiles[$sCacheKey] = $iId;
 		return $iId;
 	}
-	
+
 	function GetGrantAsHtml($oUserRights, $sClass, $sAction)
 	{
 		$bGrant = $oUserRights->GetProfileActionGrant($this->GetKey(), $sClass, $sAction);
@@ -123,7 +116,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 			return '<span style="background-color: #ffdddd;">'.Dict::S('UI:UserManagement:ActionAllowed:No').'</span>';
 		}
 	}
-	
+
 	function DoShowGrantSumary($oPage)
 	{
 		if ($this->GetRawName() == "Administrator")
@@ -135,7 +128,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 
 		// Note: for sure, we assume that the instance is derived from UserRightsProfile
 		$oUserRights = UserRights::GetModuleInstance();
-	
+
 		$aDisplayData = array();
 		foreach (MetaModel::GetClasses('bizmodel,grant_by_profile') as $sClass)
 		{
@@ -144,12 +137,12 @@ class URP_Profiles extends UserRightsBaseClassGUI
 			{
 				$bGrant = $oUserRights->GetClassStimulusGrant($this->GetKey(), $sClass, $sStimulusCode);
 				if ($bGrant === true)
-				{ 
+				{
 					$aStimuli[] = '<span title="'.$sStimulusCode.': '.htmlentities($oStimulus->GetDescription(), ENT_QUOTES, 'UTF-8').'">'.htmlentities($oStimulus->GetLabel(), ENT_QUOTES, 'UTF-8').'</span>';
 				}
 			}
 			$sStimuli = implode(', ', $aStimuli);
-			
+
 			$aDisplayData[] = array(
 				'class' => MetaModel::GetName($sClass),
 				'read' => $this->GetGrantAsHtml($oUserRights, $sClass, 'r'),
@@ -161,7 +154,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 				'stimuli' => $sStimuli,
 			);
 		}
-	
+
 		$aDisplayConfig = array();
 		$aDisplayConfig['class'] = array('label' => Dict::S('UI:UserManagement:Class'), 'description' => Dict::S('UI:UserManagement:Class+'));
 		$aDisplayConfig['read'] = array('label' => Dict::S('UI:UserManagement:Action:Read'), 'description' => Dict::S('UI:UserManagement:Action:Read+'));
@@ -179,7 +172,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 		parent::DisplayBareRelations($oPage, $bEditMode);
 		if (!$bEditMode)
 		{
-			$oPage->SetCurrentTab(Dict::S('UI:UserManagement:GrantMatrix'));
+			$oPage->SetCurrentTab('UI:UserManagement:GrantMatrix');
 			$this->DoShowGrantSumary($oPage);
 		}
 	}
@@ -221,7 +214,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 	 * @param $aReasons array To store the reasons why the attribute is read-only (info about the synchro replicas)
 	 * @param $sTargetState string The target state in which to evalutate the flags, if empty the current state will be used
 	 * @return integer Flags: the binary combination of the flags applicable to this attribute
-	 */	 	  	 	
+	 */
 	public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '')
 	{
 		$iFlags = parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState);
@@ -404,7 +397,7 @@ class URP_UserOrg extends UserRightsBaseClassGUI
 	{
 		if (!UserRights::IsLoggedIn() || UserRights::IsAdministrator()) { return; }
 
-		$oUser = UserRights::GetUserObject();		
+		$oUser = UserRights::GetUserObject();
 		$oAddon = UserRights::GetModuleInstance();
 		$aOrgs = $oAddon->GetUserOrgs($oUser, '');
 		if (count($aOrgs) > 0)
@@ -432,38 +425,38 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		UR_ACTION_BULK_DELETE => 'bd',
 	);
 
+    /**
+     * @var array $aUsersProfilesList Cache of users' profiles. Hash array of user ID => [profile ID => profile friendlyname, profile ID => profile friendlyname, ...]
+     * @since 2.7.10 3.0.4 3.1.1 3.2.0 N°6887
+     */
+	private $aUsersProfilesList = [];
+
 	// Installation: create the very first user
 	public function CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage = 'EN US')
 	{
 		CMDBObject::SetTrackInfo('Initialization');
 
-		$oChange = CMDBObject::GetCurrentChange();
-
 		$iContactId = 0;
 		// Support drastic data model changes: no organization class (or not writable)!
 		if (MetaModel::IsValidClass('Organization') && !MetaModel::IsAbstract('Organization'))
 		{
-			$oOrg = new Organization();
+			$oOrg = MetaModel::NewObject('Organization');
 			$oOrg->Set('name', 'My Company/Department');
 			$oOrg->Set('code', 'SOMECODE');
-			$iOrgId = $oOrg->DBInsertTrackedNoReload($oChange, true /* skip security */);
+			$iOrgId = $oOrg->DBInsertNoReload();
 
 			// Support drastic data model changes: no Person class  (or not writable)!
 			if (MetaModel::IsValidClass('Person') && !MetaModel::IsAbstract('Person'))
 			{
-				$oContact = new Person();
+				$oContact = MetaModel::NewObject('Person');
 				$oContact->Set('name', 'My last name');
 				$oContact->Set('first_name', 'My first name');
 				if (MetaModel::IsValidAttCode('Person', 'org_id'))
 				{
 					$oContact->Set('org_id', $iOrgId);
 				}
-				if (MetaModel::IsValidAttCode('Person', 'phone'))
-				{
-					$oContact->Set('phone', '+00 000 000 000');
-				}
 				$oContact->Set('email', 'my.email@foo.org');
-				$iContactId = $oContact->DBInsertTrackedNoReload($oChange, true /* skip security */);
+				$iContactId = $oContact->DBInsertNoReload();
 			}
 		}
 
@@ -482,14 +475,12 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		if (is_object($oAdminProfile))
 		{
 			$oUserProfile = new URP_UserProfile();
-			//$oUserProfile->Set('userid', $iUserId);
 			$oUserProfile->Set('profileid', $oAdminProfile->GetKey());
 			$oUserProfile->Set('reason', 'By definition, the administrator must have the administrator profile');
-			//$oUserProfile->DBInsertTrackedNoReload($oChange, true /* skip security */);
 			$oSet = DBObjectSet::FromObject($oUserProfile);
 			$oUser->Set('profile_list', $oSet);
 		}
-		$iUserId = $oUser->DBInsertTrackedNoReload($oChange, true /* skip security */);
+		$iUserId = $oUser->DBInsertNoReload();
 		return true;
 	}
 
@@ -536,7 +527,7 @@ class UserRightsProfile extends UserRightsAddOnAPI
 				$oSearch->AllowAllData();
 				$oCondition = new BinaryExpression(new FieldExpression('userid'), '=', new VariableExpression('userid'));
 				$oSearch->AddConditionExpression($oCondition);
-				
+
 				$oUserOrgSet = new DBObjectSet($oSearch, array(), array('userid' => $iUser));
 				while ($oUserOrg = $oUserOrgSet->Fetch())
 				{
@@ -572,7 +563,7 @@ class UserRightsProfile extends UserRightsAddOnAPI
 
 	/**
 	 * @param $oUser User
-	 * @return array
+	 * @return bool
 	 */
 	public function IsAdministrator($oUser)
 	{
@@ -582,16 +573,22 @@ class UserRightsProfile extends UserRightsAddOnAPI
 
 	/**
 	 * @param $oUser User
-	 * @return array
+	 * @return bool
 	 */
 	public function IsPortalUser($oUser)
 	{
 		// UserRights caches the list for us
 		return UserRights::HasProfile(PORTAL_PROFILE_NAME, $oUser);
 	}
+
 	/**
 	 * @param $oUser User
-	 * @return bool
+	 *
+	 * @return array
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MySQLException
 	 */
 	public function ListProfiles($oUser)
 	{
@@ -655,14 +652,20 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		// load and cache permissions for the current user on the given class
 		//
 		$iUser = $oUser->GetKey();
-		$aTest = @$this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode];
-		if (is_array($aTest)) return $aTest;
+		if (isset($this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode])){
+			$aTest = $this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode];
+			if (is_array($aTest)) return $aTest;
+		}
 
 		$sAction = self::$m_aActionCodes[$iActionCode];
 
 		$bStatus = null;
+        // Cache user's profiles
+		if(false === array_key_exists($iUser, $this->aUsersProfilesList)){
+		     $this->aUsersProfilesList[$iUser] = UserRights::ListProfiles($oUser);
+		}
 		// Call the API of UserRights because it caches the list for us
-		foreach(UserRights::ListProfiles($oUser) as $iProfile => $oProfile)
+		foreach($this->aUsersProfilesList[$iUser] as $iProfile => $oProfile)
 		{
 			$bGrant = $this->GetProfileActionGrant($iProfile, $sClass, $sAction);
 			if (!is_null($bGrant))
@@ -788,11 +791,16 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		// Note: this code is VERY close to the code of IsActionAllowed()
 		$iUser = $oUser->GetKey();
 
+        // Cache user's profiles
+		if(false === array_key_exists($iUser, $this->aUsersProfilesList)){
+			$this->aUsersProfilesList[$iUser] = UserRights::ListProfiles($oUser);
+		}
+
 		// Note: The object set is ignored because it was interesting to optimize for huge data sets
 		//       and acceptable to consider only the root class of the object set
 		$bStatus = null;
 		// Call the API of UserRights because it caches the list for us
-		foreach(UserRights::ListProfiles($oUser) as $iProfile => $oProfile)
+		foreach($this->aUsersProfilesList[$iUser] as $iProfile => $oProfile)
 		{
 			$bGrant = $this->GetClassStimulusGrant($iProfile, $sClass, $sStimulusCode);
 			if (!is_null($bGrant))
@@ -821,9 +829,10 @@ class UserRightsProfile extends UserRightsAddOnAPI
 	}
 
 	/**
-	 * Find out which attribute is corresponding the the dimension 'owner org'
-	 * returns null if no such attribute has been found (no filtering should occur)	 
-	 */	 	
+	 * @param string $sClass
+	 * @return string|null Find out which attribute is corresponding the dimension 'owner org'
+	 *                   returns null if no such attribute has been found (no filtering should occur)
+	 */
 	public static function GetOwnerOrganizationAttCode($sClass)
 	{
 		$sAttCode = null;

addons/userrights/userrightsprofile.db.class.inc.php

@@ -1,27 +1,20 @@
 <?php
-// Copyright (C) 2010-2013 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/>
-
 /**
- * UserRightsProfile
- * User management Module, basing the right on profiles and a matrix (similar to UserRightsMatrix, but profiles and other decorations have been added) 
+ * Copyright (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2012 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 define('ADMIN_PROFILE_NAME', 'Administrator');
@@ -321,7 +314,7 @@ class URP_Profiles extends UserRightsBaseClassGUI
 		parent::DisplayBareRelations($oPage, $bEditMode);
 		if (!$bEditMode)
 		{
-			$oPage->SetCurrentTab(Dict::S('UI:UserManagement:GrantMatrix'));
+			$oPage->SetCurrentTab('UI:UserManagement:GrantMatrix');
 			$this->DoShowGrantSumary($oPage);		
 		}
 	}
@@ -533,36 +526,34 @@ class UserRightsProfile extends UserRightsAddOnAPI
 	public function CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage = 'EN US')
 	{
 		// Create a change to record the history of the User object
+		/** @var \CMDBChange $oChange */
 		$oChange = MetaModel::NewObject("CMDBChange");
 		$oChange->Set("date", time());
 		$oChange->Set("userinfo", "Initialization");
-		$iChangeId = $oChange->DBInsert();
 
 		$iContactId = 0;
 		// Support drastic data model changes: no organization class (or not writable)!
 		if (MetaModel::IsValidClass('Organization') && !MetaModel::IsAbstract('Organization'))
 		{
-			$oOrg = new Organization();
+			$oOrg = MetaModel::NewObject('Organization');
 			$oOrg->Set('name', 'My Company/Department');
 			$oOrg->Set('code', 'SOMECODE');
-			$iOrgId = $oOrg->DBInsertTrackedNoReload($oChange, true /* skip security */);
+			$oOrg::SetCurrentChange($oChange);
+			$iOrgId = $oOrg->DBInsertNoReload();
 
 			// Support drastic data model changes: no Person class  (or not writable)!
 			if (MetaModel::IsValidClass('Person') && !MetaModel::IsAbstract('Person'))
 			{
-				$oContact = new Person();
+				$oContact = MetaModel::NewObject('Person');
 				$oContact->Set('name', 'My last name');
 				$oContact->Set('first_name', 'My first name');
 				if (MetaModel::IsValidAttCode('Person', 'org_id'))
 				{
 					$oContact->Set('org_id', $iOrgId);
 				}
-				if (MetaModel::IsValidAttCode('Person', 'phone'))
-				{
-					$oContact->Set('phone', '+00 000 000 000');
-				}
 				$oContact->Set('email', 'my.email@foo.org');
-				$iContactId = $oContact->DBInsertTrackedNoReload($oChange, true /* skip security */);
+				$oContact::SetCurrentChange($oChange);
+				$iContactId = $oContact->DBInsertNoReload();
 			}
 		}
 
@@ -581,14 +572,13 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		if (is_object($oAdminProfile))
 		{
 			$oUserProfile = new URP_UserProfile();
-			//$oUserProfile->Set('userid', $iUserId);
 			$oUserProfile->Set('profileid', $oAdminProfile->GetKey());
 			$oUserProfile->Set('reason', 'By definition, the administrator must have the administrator profile');
-			//$oUserProfile->DBInsertTrackedNoReload($oChange, true /* skip security */);
 			$oSet = DBObjectSet::FromObject($oUserProfile);
 			$oUser->Set('profile_list', $oSet);
 		}
-		$iUserId = $oUser->DBInsertTrackedNoReload($oChange, true /* skip security */);
+		$oUser::SetCurrentChange($oChange);
+		$iUserId = $oUser->DBInsertNoReload();
 		return true;
 	}
 
@@ -614,10 +604,10 @@ class UserRightsProfile extends UserRightsAddOnAPI
 	/**
 	 * Read and cache organizations allowed to the given user
 	 *
-	 * @param $oUser
-	 * @param $sClass (not used here but can be used in overloads)
+	 * @param User $oUser
+	 * @param string $sClass (not used here but can be used in overloads)
 	 *
-	 * @return array
+	 * @return array keys of the User allowed org
 	 * @throws \CoreException
 	 * @throws \Exception
 	 */
@@ -717,7 +707,7 @@ class UserRightsProfile extends UserRightsAddOnAPI
 
 	public function LoadCache()
 	{
-		if (!is_null($this->m_aProfiles)) return;
+		if (!is_null($this->m_aProfiles)) return false;
 		// Could be loaded in a shared memory (?)
 
 		$oKPI = new ExecutionKPI();

addons/userrights/userrightsprojection.class.inc.php

@@ -1,27 +1,20 @@
 <?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/>
-
 /**
- * UserRightsProjection
- * User management Module, basing the right on profiles and a matrix (similar to UserRightsProfile, but enhanced with dimensions and projection of classes and profile over the dimensions) 
+ * Copyright (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2012 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 define('ADMIN_PROFILE_ID', 1);
@@ -153,7 +146,7 @@ class URP_Profiles extends UserRightsBaseClass
 		parent::DisplayBareRelations($oPage, $bEditMode);
 		if (!$bEditMode)
 		{
-			$oPage->SetCurrentTab(Dict::S('UI:UserManagement:GrantMatrix'));
+			$oPage->SetCurrentTab('UI:UserManagement:GrantMatrix');
 			$this->DoShowGrantSumary($oPage);		
 		}
 	}
@@ -593,25 +586,12 @@ class UserRightsProjection extends UserRightsAddOnAPI
 		$oChange = MetaModel::NewObject("CMDBChange");
 		$oChange->Set("date", time());
 		$oChange->Set("userinfo", "Initialization");
-		$iChangeId = $oChange->DBInsert();
 
 		$oOrg = new Organization();
 		$oOrg->Set('name', 'My Company/Department');
 		$oOrg->Set('code', 'SOMECODE');
-//		$oOrg->Set('status', 'implementation');
-		//$oOrg->Set('parent_id', xxx);
-		$iOrgId = $oOrg->DBInsertTrackedNoReload($oChange, true /* skip strong security */);
-
-		// Location : optional
-		//$oLocation = new bizLocation();
-		//$oLocation->Set('name', 'MyOffice');
-		//$oLocation->Set('status', 'implementation');
-		//$oLocation->Set('org_id', $iOrgId);
-		//$oLocation->Set('severity', 'high');
-		//$oLocation->Set('address', 'my building in my city');
-		//$oLocation->Set('country', 'my country');
-		//$oLocation->Set('parent_location_id', xxx);
-		//$iLocationId = $oLocation->DBInsertNoReload();
+		$oOrg::SetCurrentChange($oChange);
+		$iOrgId = $oOrg->DBInsertNoReload();
 
 		$oContact = new Person();
 		$oContact->Set('name', 'My last name');
@@ -619,24 +599,24 @@ class UserRightsProjection extends UserRightsAddOnAPI
 		//$oContact->Set('status', 'available');
 		$oContact->Set('org_id', $iOrgId);
 		$oContact->Set('email', 'my.email@foo.org');
-		//$oContact->Set('phone', '');
-		//$oContact->Set('location_id', $iLocationId);
-		//$oContact->Set('employee_number', '');
-		$iContactId = $oContact->DBInsertTrackedNoReload($oChange, true /* skip security */);
+		$oContact::SetCurrentChange($oChange);
+		$iContactId = $oContact->DBInsertNoReload();
 		
 		$oUser = new UserLocal();
 		$oUser->Set('login', $sAdminUser);
 		$oUser->Set('password', $sAdminPwd);
 		$oUser->Set('contactid', $iContactId);
 		$oUser->Set('language', $sLanguage); // Language was chosen during the installation
-		$iUserId = $oUser->DBInsertTrackedNoReload($oChange, true /* skip security */);
+		$oUser::SetCurrentChange($oChange);
+		$iUserId = $oUser->DBInsertNoReload();
 		
 		// Add this user to the very specific 'admin' profile
 		$oUserProfile = new URP_UserProfile();
 		$oUserProfile->Set('userid', $iUserId);
 		$oUserProfile->Set('profileid', ADMIN_PROFILE_ID);
 		$oUserProfile->Set('reason', 'By definition, the administrator must have the administrator profile');
-		$oUserProfile->DBInsertTrackedNoReload($oChange, true /* skip security */);
+		$oUserProfile::SetCurrentChange($oChange);
+		$oUserProfile->DBInsertNoReload();
 		return true;
 	}
 

application/ajaxwebpage.class.inc.php

@@ -1,27 +1,20 @@
 <?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 (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2017 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -30,83 +23,105 @@ class ajax_page extends WebPage implements iTabbedPage
 {
     /**
      * Jquery style ready script
-     * @var Hash     
-     */	  
+     * @var array
+     */
 	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)
-    {
+
+	/**
+	 * 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 = "";
+		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->no_cache();
+		$this->add_http_headers();
 		$this->m_oTabs = new TabManager();
 		$this->sContentType = 'text/html';
 		$this->sContentDisposition = 'inline';
 		$this->m_sMenu = "";
 
 		utils::InitArchiveMode();
-    }
+	}
 
+	/**
+	 * Disabling sending the header so that resource won't be blocked by CORB. See parent method documentation.
+	 * @return void
+	 * @since 2.7.10 3.0.4 3.1.2 3.2.0 N°4368 method creation
+	 */
+	public function add_xcontent_type_options()
+	{
+		// Nothing to do !
+	}
+
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
 	public function AddTabContainer($sTabContainer, $sPrefix = '')
 	{
 		$this->add($this->m_oTabs->AddTabContainer($sTabContainer, $sPrefix));
 	}
 
-	public function AddToTab($sTabContainer, $sTabLabel, $sHtml)
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
+	public function AddToTab($sTabContainer, $sTabCode, $sHtml)
 	{
-		$this->add($this->m_oTabs->AddToTab($sTabContainer, $sTabLabel, $sHtml));
+		$this->add($this->m_oTabs->AddToTab($sTabContainer, $sTabCode, $sHtml));
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	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
+	 * @inheritDoc
 	 */
-	public function AddAjaxTab($sTabLabel, $sUrl, $bCache = true)
+	public function SetCurrentTab($sTabCode = '', $sTabTitle = null)
 	{
-		$this->add($this->m_oTabs->AddAjaxTab($sTabLabel, $sUrl, $bCache));
+		return $this->m_oTabs->SetCurrentTab($sTabCode, $sTabTitle);
 	}
-	
+
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
+	public function AddAjaxTab($sTabCode, $sUrl, $bCache = true, $sTabTitle = null)
+	{
+		$this->add($this->m_oTabs->AddAjaxTab($sTabCode, $sUrl, $bCache, $sTabTitle));
+	}
+
+	/**
+	 * @inheritDoc
+	 */
 	public function GetCurrentTab()
 	{
 		return $this->m_oTabs->GetCurrentTab();
 	}
 
-	public function RemoveTab($sTabLabel, $sTabContainer = null)
+	/**
+	 * @inheritDoc
+	 */
+	public function RemoveTab($sTabCode, $sTabContainer = null)
 	{
-		$this->m_oTabs->RemoveTab($sTabLabel, $sTabContainer);
+		$this->m_oTabs->RemoveTab($sTabCode, $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
+	 * @inheritDoc
 	 */
 	public function FindTab($sPattern, $sTabContainer = null)
 	{
@@ -119,21 +134,23 @@ class ajax_page extends WebPage implements iTabbedPage
 	 * that we are using this is not supported... TO DO upgrade
 	 * the whole jquery bundle...
 	 */
-	public function SelectTab($sTabContainer, $sTabLabel)
+	public function SelectTab($sTabContainer, $sTabCode)
 	{
-		$this->add_ready_script($this->m_oTabs->SelectTab($sTabContainer, $sTabLabel));
+		$this->add_ready_script($this->m_oTabs->SelectTab($sTabContainer, $sTabCode));
 	}
-	
+
+	/**
+	 * @param string $sHtml
+	 */
 	public function AddToMenu($sHtml)
 	{
 		$this->m_sMenu .= $sHtml;
 	}
 
-    /**
-     * Echoes the content of the whole page
-     * @return void
-     */	  
-    public function output()
+	/**
+	 * @inheritDoc
+	 */
+	public function output()
     {
     	if (!empty($this->sContentType))
     	{
@@ -216,8 +233,9 @@ EOF
 		}
 	    $this->outputCollapsibleSectionInit();
 
+	    $oKPI = new ExecutionKPI();
 	    $s_captured_output = $this->ob_get_clean_safe();
-		  if (($this->sContentType == 'text/html') &&  ($this->sContentDisposition == 'inline'))
+	    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);
@@ -287,6 +305,8 @@ EOF
         	echo self::FilterXSS($s_captured_output);
         }
 
+	    $oKPI->ComputeAndReport('Echoing');
+
         if (class_exists('DBSearch'))
         {
             DBSearch::RecordQueryTrace();
@@ -307,7 +327,11 @@ EOF
     {
 	}
 
-    public function add($sHtml)
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
+	public function add($sHtml)
     {
         if (($this->m_oTabs->GetCurrentTabContainer() != '') && ($this->m_oTabs->GetCurrentTab() != ''))
         {
@@ -320,10 +344,9 @@ EOF
     }
 
 	/**
-	 * 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()
+	 * @inheritDoc
+	 */
+	public function start_capture()
     {
     	$sCurrentTabContainer = $this->m_oTabs->GetCurrentTabContainer();
 		$sCurrentTab = $this->m_oTabs->GetCurrentTab();
@@ -339,13 +362,10 @@ EOF
 		}
     }
 
-    /**
-     * 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)
+	/**
+	 * @inheritDoc
+	 */
+	public function end_capture($offset)
     {
 		if (is_array($offset))
 		{
@@ -366,11 +386,9 @@ EOF
     }
 
 	/**
-	 * 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.	 	 
+	 * @inheritDoc
 	 */
-    public function add_at_the_end($s_html, $sId = '')
+	public function add_at_the_end($s_html, $sId = '')
     {
     	if ($sId != '')
     	{
@@ -378,27 +396,27 @@ EOF
     	}
         $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	 
-	 */	 	 	
+	 * @inheritDoc
+	 */
 	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 !!
+	 * @inheritDoc
 	 */
 	public function GetUniqueId()
 	{
 		assert(false);
 		return 0;
 	}
-	
+
+	/**
+	 * @inheritDoc
+	 */
 	public static function FilterXSS($sHTML)
 	{
 		return str_ireplace(array('<script', '</script>'), array('<!-- <removed-script', '</removed-script> -->'), $sHTML);

application/csvpage.class.inc.php

@@ -29,13 +29,13 @@ 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=".self::PAGES_CHARSET);
-		$this->add_header("Cache-control: no-cache");
+	function __construct($s_title) {
+		parent::__construct($s_title);
+		$this->add_header("Content-type: text/plain; charset=".self::PAGES_CHARSET);
+		$this->no_cache();
+		$this->add_http_headers();
 		//$this->add_header("Content-Transfer-Encoding: binary");
-    }	
+	}
 
     public function output()
     {

application/dashboard.class.inc.php

@@ -1,20 +1,21 @@
 <?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/>
+/**
+ * Copyright (C) 2013-2019 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
+ */
 
 require_once(APPROOT.'application/dashboardlayout.class.inc.php');
 require_once(APPROOT.'application/dashlet.class.inc.php');
@@ -24,21 +25,33 @@ require_once(APPROOT.'core/modelreflection.class.inc.php');
  *
  * A user editable dashboard page
  *
- * @copyright   Copyright (C) 2010-2017 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
  */
 abstract class Dashboard
 {
+	/** @var string $sTitle*/
 	protected $sTitle;
+	/** @var bool $bAutoReload */
 	protected $bAutoReload;
+	/** @var float|int $iAutoReloadSec */
 	protected $iAutoReloadSec;
+	/** @var string $sLayoutClass */
 	protected $sLayoutClass;
+	/** @var array $aWidgetsData */
 	protected $aWidgetsData;
+	/** @var \DOMNode|null $oDOMNode */
 	protected $oDOMNode;
+	/** @var string $sId */
 	protected $sId;
+	/** @var array $aCells */
 	protected $aCells;
+	/** @var \ModelReflection $oMetaModel */
 	protected $oMetaModel;
-	
+
+	/**
+	 * Dashboard constructor.
+	 *
+	 * @param string $sId
+	 */
 	public function __construct($sId)
 	{
 		$this->sTitle = '';
@@ -51,7 +64,7 @@ abstract class Dashboard
 	}
 
 	/**
-	 * @param $sXml
+	 * @param string $sXml
 	 *
 	 * @throws \Exception
 	 */
@@ -64,7 +77,10 @@ abstract class Dashboard
 		restore_error_handler();
 		$this->FromDOMDocument($oDoc);
 	}
-	
+
+	/**
+	 * @param \DOMDocument $oDoc
+	 */
 	public function FromDOMDocument(DOMDocument $oDoc)
 	{
 		$this->oDOMNode = $oDoc->getElementsByTagName('dashboard')->item(0);
@@ -160,9 +176,10 @@ abstract class Dashboard
 	protected function InitDashletFromDOMNode($oDomNode)
     {
         $sId = $oDomNode->getAttribute('id');
+
 	    $sDashletType = $oDomNode->getAttribute('xsi:type');
 
-        // Test if dashlet can be instanciated, otherwise (uninstalled, broken, ...) we display a placeholder
+        // Test if dashlet can be instantiated, otherwise (uninstalled, broken, ...) we display a placeholder
 	    $sClass = static::GetDashletClassFromType($sDashletType);
 	    /** @var \Dashlet $oNewDashlet */
 	    $oNewDashlet = new $sClass($this->oMetaModel, $sId);
@@ -172,7 +189,13 @@ abstract class Dashboard
         return $oNewDashlet;
     }
 
-	static function SortOnRank($aItem1, $aItem2)
+	/**
+	 * @param array $aItem1
+	 * @param array $aItem2
+	 *
+	 * @return int
+	 */
+	public static function SortOnRank($aItem1, $aItem2)
 	{
 		return ($aItem1['rank'] > $aItem2['rank']) ? +1 : -1;
 	}
@@ -200,6 +223,10 @@ abstract class Dashboard
 		}
 	}
 
+	/**
+	 * @return string
+	 * @throws \Exception
+	 */
 	public function ToXml()
 	{
 		$oDoc = new DOMDocument();
@@ -268,7 +295,9 @@ abstract class Dashboard
 		}
 	}
 
-
+	/**
+	 * @param array $aParams
+	 */
 	public function FromParams($aParams)
 	{
 		$this->sLayoutClass = $aParams['layout_class'];
@@ -305,42 +334,85 @@ abstract class Dashboard
 	{
 		
 	}
-	
+
+	/**
+	 * @return mixed
+	 */
+	public function GetId()
+	{
+		return $this->sId;
+	}
+
+	/**
+	 * Return a sanitize ID for usages in XML/HTML attributes
+	 *
+	 * @return string
+	 * @since 2.7.0
+	 */
+	public function GetSanitizedId()
+	{
+		return utils::Sanitize($this->GetId(), '', 'element_identifier');
+	}
+
+	/**
+	 * @return string
+	 */
 	public function GetLayout()
 	{
 		return $this->sLayoutClass;
 	}
-	
+
+	/**
+	 * @param string $sLayoutClass
+	 */
 	public function SetLayout($sLayoutClass)
 	{
 		$this->sLayoutClass = $sLayoutClass;
 	}
-	
+
+	/**
+	 * @return string
+	 */
 	public function GetTitle()
 	{
 		return $this->sTitle;
 	}
 
+	/**
+	 * @param string $sTitle
+	 */
 	public function SetTitle($sTitle)
 	{
 		$this->sTitle = $sTitle;
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function GetAutoReload()
 	{
 		return $this->bAutoReload;
 	}
 
+	/**
+	 * @param bool $bAutoReload
+	 */
 	public function SetAutoReload($bAutoReload)
 	{
 		$this->bAutoReload = $bAutoReload;
 	}
 
+	/**
+	 * @return float|int
+	 */
 	public function GetAutoReloadInterval()
 	{
 		return $this->iAutoReloadSec;
 	}
 
+	/**
+	 * @param bool $iAutoReloadSec
+	 */
 	public function SetAutoReloadInterval($iAutoReloadSec)
 	{
 		$this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int)$iAutoReloadSec);
@@ -356,12 +428,13 @@ abstract class Dashboard
 		$this->aCells[] = array($oDashlet);
 	}
 
-    /**
-     * @param \WebPage $oPage     *
-     * @param array $aExtraParams
-     *
-     * @throws \ReflectionException
-     */
+	/**
+	 * @param \WebPage $oPage *
+	 * @param array $aExtraParams
+	 *
+	 * @throws \ReflectionException
+	 * @throws \Exception
+	 */
 	public function RenderProperties($oPage, $aExtraParams = array())
 	{
 		// menu to pick a layout and edit other properties of the dashboard
@@ -449,17 +522,32 @@ EOF
 	}
 
 	/**
-	 * @param \iTopWebPage $oPage
+	 * @param \WebPage $oPage
 	 * @param bool $bEditMode
 	 * @param array $aExtraParams
 	 * @param bool $bCanEdit
 	 */
 	public function Render($oPage, $bEditMode = false, $aExtraParams = array(), $bCanEdit = true)
 	{
+		if (!array_key_exists('dashboard_div_id', $aExtraParams))
+		{
+			$aExtraParams['dashboard_div_id'] = utils::Sanitize($this->GetId(), '', 'element_identifier');
+		}
+
 		$oPage->add('<div class="dashboard-title-line"><div class="dashboard-title">'.htmlentities(Dict::S($this->sTitle), ENT_QUOTES, 'UTF-8', false).'</div></div>');
 
-		$oLayout = new $this->sLayoutClass;
 		/** @var \DashboardLayoutMultiCol $oLayout */
+		$oLayout = new $this->sLayoutClass();
+
+		foreach($this->aCells as $iCellIdx => $aDashlets)
+		{
+			foreach($aDashlets as $oDashlet)
+			{
+				$aDashletCoordinates = $oLayout->GetDashletCoordinates($iCellIdx);
+				$this->PrepareDashletForRendering($oDashlet, $aDashletCoordinates, $aExtraParams);
+			}
+		}
+
 		$oLayout->Render($oPage, $this->aCells, $bEditMode, $aExtraParams);
 		if (!$bEditMode)
 		{
@@ -468,6 +556,12 @@ EOF
 		}
 	}
 
+	/**
+	 * @param \WebPage $oPage
+	 *
+	 * @throws \ReflectionException
+	 * @throws \Exception
+	 */
 	public function RenderDashletsSelection(WebPage $oPage)
 	{
 		// Toolbox/palette to drag and drop dashlets
@@ -485,25 +579,31 @@ EOF
 		$oPage->add('</div>');
 		$oPage->add_ready_script("$('.dashlet_icon').draggable({helper: 'clone', appendTo: 'body', zIndex: 10000, revert:'invalid'});");
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param array $aExtraParams
+	 */
 	public function RenderDashletsProperties(WebPage $oPage, $aExtraParams = array())
 	{
 		// Toolbox/palette to edit the properties of each dashlet
 		$oPage->add('<div class="ui-widget-content ui-corner-all"><div class="ui-widget-header ui-corner-all" style="text-align:center; padding: 2px;">'.Dict::S('UI:DashboardEdit:DashletProperties').'</div>');
 
+		/** @var \DashboardLayoutMultiCol $oLayout */
+		$oLayout = new $this->sLayoutClass();
+
 		$oPage->add('<div id="dashlet_properties" style="text-align:center">');
-		foreach($this->aCells as $aCell)
+		foreach($this->aCells as $iCellIdx => $aCell)
 		{
 			/** @var \Dashlet $oDashlet */
 			foreach($aCell as $oDashlet)
 			{
-				$sId = $oDashlet->GetID();
 				if ($oDashlet->IsVisible())
 				{
-					$oPage->add('<div class="dashlet_properties" id="dashlet_properties_'.$sId.'" style="display:none">');
+					$oPage->add('<div class="dashlet_properties" id="dashlet_properties_'.$oDashlet->GetID().'" style="display:none">');
 					$oForm = $oDashlet->GetForm();
 					$this->SetFormParams($oForm, $aExtraParams);
-					$oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard');		
+					$oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard');
 					$oPage->add('</div>');
 				}
 			}
@@ -545,7 +645,10 @@ EOF
 
 		return $aDashlets;
 	}
-	
+
+	/**
+	 * @return int|mixed
+	 */
 	protected function GetNewDashletId()
 	{
 		$iNewId = 0;
@@ -560,14 +663,32 @@ EOF
 		return $iNewId + 1;
 	}
 
+	/**
+	 * Prepare dashlet for rendering (eg. change its ID or another processing).
+	 * Meant to be overloaded.
+	 *
+	 * @param \Dashlet $oDashlet
+	 * @param array $aCoordinates
+	 * @param array $aExtraParams
+	 *
+	 * @return void
+	 */
+	abstract protected function PrepareDashletForRendering(Dashlet $oDashlet, $aCoordinates, $aExtraParams = array());
+
     /**
-     * @param $oForm
+     * @param \DesignerForm $oForm
      * @param array $aExtraParams
      *
      * @return mixed
      */
 	abstract protected function SetFormParams($oForm, $aExtraParams = array());
 
+	/**
+	 * @param string $sType
+	 * @param \ModelFactory|null $oFactory
+	 *
+	 * @return string
+	 */
 	public static function GetDashletClassFromType($sType, $oFactory = null)
 	{
 		if (is_subclass_of($sType, 'Dashlet'))
@@ -578,45 +699,90 @@ EOF
 	}
 
 	/**
-	 * @return mixed
+	 *  N°2634: we must have a unique id per dashlet!
+	 * To avoid collision with other dashlets with the same ID we prefix it with row/cell id
+	 * Collisions typically happen with extensions.
+	 *
+	 * @param boolean $bIsCustomized
+	 * @param string $sDashboardDivId
+	 * @param int $iRow
+	 * @param int $iCol
+	 * @param string $sDashletOrigId
+	 *
+	 * @return string
+	 *
+	 * @since 2.7.0 N°2735
 	 */
-	public function GetId()
+	public static function GetDashletUniqueId($bIsCustomized, $sDashboardDivId, $iRow, $iCol, $sDashletOrigId)
 	{
-		return $this->sId;
+		if(strpos($sDashletOrigId, '_ID_row') !== false)
+		{
+			return $sDashletOrigId;
+		}
+
+		$sDashletId = $sDashboardDivId."_ID_row".$iRow."_col".$iCol."_".$sDashletOrigId;
+		if ($bIsCustomized)
+		{
+			$sDashletId = 'CUSTOM_'.$sDashletId;
+		}
+
+		return $sDashletId;
 	}
 }
 
+/**
+ * Class RuntimeDashboard
+ */
 class RuntimeDashboard extends Dashboard
 {
-	protected $bCustomized;
+	/** @var string $sDefinitionFile */
 	private $sDefinitionFile = '';
+	/** @var null $sReloadURL */
 	private $sReloadURL = null;
+	/** @var bool $bCustomized */
+	protected $bCustomized;
 
-
+	/**
+	 * @inheritDoc
+	 */
 	public function __construct($sId)
 	{
 		parent::__construct($sId);
-		$this->bCustomized = false;
 		$this->oMetaModel = new ModelReflectionRuntime();
+		$this->bCustomized = false;
 	}
-		
+
+	/**
+	 * @return bool
+	 * @since 2.7.0
+	 */
+	public function GetCustomFlag()
+	{
+		return $this->bCustomized;
+	}
+
+	/**
+	 * @param bool $bCustomized
+	 * @since 2.7.0
+	 */
 	public function SetCustomFlag($bCustomized)
 	{
 		$this->bCustomized = $bCustomized;
 	}
 
 	/**
-	 * @param \DesignerForm $oForm
-	 *
-	 * @param array $aExtraParams
-	 *
+	 * @inheritDoc
 	 * @throws \Exception
 	 */
 	protected function SetFormParams($oForm, $aExtraParams = array())
 	{
 		$oForm->SetSubmitParams(utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php', array('operation' => 'update_dashlet_property', 'extra_params' => $aExtraParams));
 	}
-	
+
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
 	public function Save()
 	{
 		$sXml = $this->ToXml();
@@ -632,7 +798,7 @@ class RuntimeDashboard extends Dashboard
 		}
 		else
 		{
-			// No such customized dasboard for the current user, let's create a new record
+			// No such customized dashboard for the current user, let's create a new record
 			$oUserDashboard = new UserDashboard();
 			$oUserDashboard->Set('user_id', UserRights::GetUserId());
 			$oUserDashboard->Set('menu_code', $this->sId);
@@ -642,7 +808,18 @@ class RuntimeDashboard extends Dashboard
 		$oUserDashboard->DBWrite();
 		utils::PopArchiveMode();
 	}
-	
+
+	/**
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \DeleteException
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \OQLException
+	 */
 	public function Revert()
 	{
 		$oUDSearch = new DBObjectSearch('UserDashboard');
@@ -669,33 +846,35 @@ class RuntimeDashboard extends Dashboard
 	 * @throws \MissingQueryArgument
 	 * @throws \MySQLException
 	 * @throws \MySQLHasGoneAwayException
+	 * @throws \Exception
 	 */
 	public static function GetDashboard($sDashboardFile, $sDashBoardId)
 	{
 		$bCustomized = false;
 
-		if (!appUserPreferences::GetPref('display_original_dashboard_'.$sDashBoardId, false))
-		{
+		$sDashboardFileSanitized = utils::RealPath($sDashboardFile, APPROOT);
+		if (false === $sDashboardFileSanitized) {
+			throw new SecurityException('Invalid dashboard file !');
+		}
+
+		if (!appUserPreferences::GetPref('display_original_dashboard_'.$sDashBoardId, false)) {
 			// Search for an eventual user defined dashboard
 			$oUDSearch = new DBObjectSearch('UserDashboard');
 			$oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
 			$oUDSearch->AddCondition('menu_code', $sDashBoardId, '=');
 			$oUDSet = new DBObjectSet($oUDSearch);
-			if ($oUDSet->Count() > 0)
-			{
+			if ($oUDSet->Count() > 0) {
 				// Assuming there is at most one couple {user, menu}!
 				$oUserDashboard = $oUDSet->Fetch();
 				$sDashboardDefinition = $oUserDashboard->Get('contents');
 				$bCustomized = true;
-			}
-			else
-			{
-				$sDashboardDefinition = @file_get_contents($sDashboardFile);
+			} else {
+				$sDashboardDefinition = @file_get_contents($sDashboardFileSanitized);
 			}
 		}
 		else
 		{
-			$sDashboardDefinition = @file_get_contents($sDashboardFile);
+			$sDashboardDefinition = @file_get_contents($sDashboardFileSanitized);
 		}
 
 		if ($sDashboardDefinition !== false)
@@ -703,7 +882,7 @@ class RuntimeDashboard extends Dashboard
 			$oDashboard = new RuntimeDashboard($sDashBoardId);
 			$oDashboard->FromXml($sDashboardDefinition);
 			$oDashboard->SetCustomFlag($bCustomized);
-			$oDashboard->SetDefinitionFile($sDashboardFile);
+			$oDashboard->SetDefinitionFile($sDashboardFileSanitized);
 		}
 		else
 		{
@@ -713,10 +892,7 @@ class RuntimeDashboard extends Dashboard
 	}
 
 	/**
-	 * @param \iTopWebPage $oPage
-	 * @param bool $bEditMode
-	 * @param array $aExtraParams (class and id of the current object
-	 *
+	 * @inheritDoc
 	 * @throws \Exception
 	 */
 	public function Render($oPage, $bEditMode = false, $aExtraParams = array(), $bCanEdit = true)
@@ -746,7 +922,7 @@ class RuntimeDashboard extends Dashboard
 		if (!$bEditMode && !$oPage->IsPrintableVersion())
 		{
 			$sId = $this->GetId();
-			$sDivId = preg_replace('/[^a-zA-Z0-9_]/', '', $sId);
+			$sDivId = utils::Sanitize($sId, '', 'element_identifier');
 			if ($this->GetAutoReload())
 			{
 				$sFile = addslashes($this->GetDefinitionFile());
@@ -809,7 +985,7 @@ EOF
 	protected function RenderSelector($oPage, $aAjaxParams = array())
 	{
 		$sId = $this->GetId();
-		$sDivId = preg_replace('/[^a-zA-Z0-9_]/', '', $sId);
+		$sDivId = utils::Sanitize($sId, '', 'element_identifier');
 		$sExtraParams = json_encode($aAjaxParams);
 
 		$sSelectorHtml = '<div class="dashboard-selector">';
@@ -851,6 +1027,9 @@ EOF
 		);
 	}
 
+	/**
+	 * @return bool
+	 */
 	protected function HasCustomDashboard()
 	{
 		try
@@ -879,7 +1058,7 @@ EOF
 	{
 		$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.iframe-transport.js');
 		$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.fileupload.js');
-		$sEditMenu = "<div id=\"DashboardMenu\"><ul><li><img src=\"../images/pencil-menu.png\"><ul>";
+		$sEditMenu = "<div id=\"DashboardMenu\"><ul><li><i class=\"top-right-icon icon-additional-arrow fas fa-pencil-alt\"></i><ul>";
 	
 		$aActions = array();
 		$sFile = addslashes($this->sDefinitionFile);
@@ -939,9 +1118,7 @@ EOF
 	}
 
 	/**
-	 * @param \WebPage $oPage
-	 *
-	 * @throws \ReflectionException
+	 * @inheritDoc
 	 */
 	public function RenderProperties($oPage, $aExtraParams = array())
 	{
@@ -977,7 +1154,7 @@ EOF
 
 
 	/**
-	 * @param \iTopWebPage $oPage
+	 * @param \WebPage $oPage
 	 *
 	 * @param array $aExtraParams
 	 *
@@ -997,9 +1174,11 @@ EOF
 		{
 			$aRenderParams = $aExtraParams;
 		}
+		$aRenderParams['dashboard_div_id'] = $aExtraParams['dashboard_div_id'];
 		$sJSExtraParams = json_encode($aExtraParams);
 		$oPage->add('<div id="dashboard_editor">');
 		$oPage->add('<div class="ui-layout-center">');
+		$this->SetCustomFlag(true);
 		$this->Render($oPage, true, $aRenderParams);
 		$oPage->add('</div>');
 		$oPage->add('<div class="ui-layout-east">');
@@ -1014,12 +1193,12 @@ EOF
 		$sOkButtonLabel = Dict::S('UI:Button:Save');
 		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
 		
-		$sId = addslashes($this->sId);
-		$sLayoutClass = addslashes($this->sLayoutClass);
+		$sId = json_encode($this->sId);
+		$sLayoutClass = json_encode($this->sLayoutClass);
 		$sAutoReload = $this->bAutoReload ? 'true' : 'false';
 		$sAutoReloadSec = (string) $this->iAutoReloadSec;
-		$sTitle = addslashes($this->sTitle);
-		$sFile = addslashes($this->GetDefinitionFile());
+		$sTitle = json_encode($this->sTitle);
+		$sFile = json_encode($this->GetDefinitionFile());
 		$sUrl = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php';
 		$sReloadURL = $this->GetReloadURL();
 
@@ -1028,7 +1207,7 @@ EOF
 		$sAutoApplyConfirmationMessage = addslashes(Dict::S('UI:AutoApplyConfirmationMessage'));
 		
 		$oPage->add_ready_script(
-<<<EOF
+<<<JS
 window.bLeavingOnUserAction = false;
 
 $('#dashboard_editor').dialog({
@@ -1071,10 +1250,15 @@ $('#dashboard_editor').dialog({
 });
 
 $('#dashboard_editor .ui-layout-center').runtimedashboard({
-	dashboard_id: '$sId', layout_class: '$sLayoutClass', title: '$sTitle',
-	auto_reload: $sAutoReload, auto_reload_sec: $sAutoReloadSec,
-	submit_to: '$sUrl', submit_parameters: {operation: 'save_dashboard', file: '$sFile', extra_params: $sJSExtraParams, reload_url: '$sReloadURL'},
-	render_to: '$sUrl', render_parameters: {operation: 'render_dashboard', file: '$sFile', extra_params: $sJSExtraParams, reload_url: '$sReloadURL'},
+	dashboard_id: $sId, 
+	layout_class: $sLayoutClass, 
+	title: $sTitle,
+	auto_reload: $sAutoReload, 
+	auto_reload_sec: $sAutoReloadSec,
+	submit_to: '$sUrl', 
+	submit_parameters: {operation: 'save_dashboard', file: $sFile, extra_params: $sJSExtraParams, reload_url: '$sReloadURL'},
+	render_to: '$sUrl', 
+	render_parameters: {operation: 'render_dashboard', file: $sFile, extra_params: $sJSExtraParams, reload_url: '$sReloadURL'},
 	new_dashlet_parameters: {operation: 'new_dashlet'}
 });
 
@@ -1113,11 +1297,18 @@ window.onbeforeunload = function() {
 	}
 	// return nothing ! safer for IE
 };
-EOF
+JS
 		);
 		$oPage->add_ready_script("");
 	}
-	
+
+	/**
+	 * @param string|null $sOQL
+	 *
+	 * @return \DesignerForm
+	 * @throws \DictExceptionMissingString
+	 * @throws \ReflectionException
+	 */
 	public static function GetDashletCreationForm($sOQL = null)
 	{
 		$oAppContext = new ApplicationContext();
@@ -1228,6 +1419,9 @@ EOF
 	/**
 	 * @param \WebPage $oPage
 	 * @param $sOQL
+	 *
+	 * @throws \DictExceptionMissingString
+	 * @throws \ReflectionException
 	 */
 	public static function GetDashletCreationDlgFromOQL($oPage, $sOQL)
 	{
@@ -1243,7 +1437,7 @@ EOF
 		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
 		
 		$oPage->add_ready_script(
-<<<EOF
+<<<JS
 $('#dashlet_creation_dlg').dialog({
 	width: 600,
 	modal: true,
@@ -1272,7 +1466,7 @@ $('#dashlet_creation_dlg').dialog({
 	],
 	close: function() { $(this).remove(); }
 });
-EOF
+JS
 		);
 	}
 
@@ -1284,6 +1478,29 @@ EOF
 		return $this->sDefinitionFile;
 	}
 
+	/**
+	 * @param string $sDashboardFileRelative can also be an absolute path (compatibility with old URL)
+	 *
+	 * @return string full path to the Dashboard file
+	 * @throws \SecurityException if path isn't under approot
+	 * @uses utils::RealPath()
+	 * @since 2.7.8 3.0.3 3.1.0 N°4449 remove FPD
+	 */
+	public static function GetDashboardFileFromRelativePath($sDashboardFileRelative)
+	{
+		if (utils::RealPath($sDashboardFileRelative, APPROOT)) {
+			// compatibility with old URL containing absolute path !
+			return $sDashboardFileRelative;
+		}
+
+		$sDashboardFile = APPROOT.$sDashboardFileRelative;
+		if (false === utils::RealPath($sDashboardFile, APPROOT)) {
+			throw new SecurityException('Invalid dashboard file !');
+		}
+
+		return $sDashboardFile;
+	}
+
 	/**
 	 * @param string $sDefinitionFile
 	 */
@@ -1292,13 +1509,105 @@ EOF
 		$this->sDefinitionFile = $sDefinitionFile;
 	}
 
+	/**
+	 * @return string|null
+	 */
 	public function GetReloadURL()
 	{
 		return $this->sReloadURL;
 	}
 
+	/**
+	 * @param string $sReloadURL
+	 */
 	public function SetReloadURL($sReloadURL)
 	{
 		$this->sReloadURL = $sReloadURL;
 	}
-}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function PrepareDashletForRendering(Dashlet $oDashlet, $aCoordinates, $aExtraParams = array())
+	{
+		$sDashletIdOrig = $oDashlet->GetID();
+		$sDashboardSanitizedId = $this->GetSanitizedId();
+		$sDashletIdNew = static::GetDashletUniqueId($this->GetCustomFlag(), $sDashboardSanitizedId, $aCoordinates[1], $aCoordinates[0], $sDashletIdOrig);
+		$oDashlet->SetID($sDashletIdNew);
+		$this->UpdateDashletUserPrefs($oDashlet, $sDashletIdOrig, $aExtraParams);
+	}
+
+	/**
+	 * Migrate dashlet specific prefs to new format
+	 *      Before 2.7.0 we were using the same for dashboard menu or dashboard attributes, standard or custom :
+	 *          <alias>-<class>|Dashlet<idx_dashlet>
+	 *      Since 2.7.0 it is the following, with a "CUSTOM_" prefix if necessary :
+	 *          * dashboard menu : <dashboard_id>_IDrow<row_idx>-col<col_idx>-<dashlet_idx>
+	 *          * dashboard attribute : <class>__<attcode>_IDrow<row_idx>-col<col_idx>-<dashlet_idx>
+	 *
+	 * @param \Dashlet $oDashlet
+	 * @param string $sDashletIdOrig
+	 *
+	 * @param array $aExtraParams
+	 *
+	 * @since 2.7.0 N°2735
+	 */
+	private function UpdateDashletUserPrefs(Dashlet $oDashlet, $sDashletIdOrig, array $aExtraParams)
+	{
+		$bIsDashletWithListPref = ($oDashlet instanceof  DashletObjectList);
+		if (!$bIsDashletWithListPref)
+		{
+			return;
+		}
+		/** @var \DashletObjectList $oDashlet */
+
+		$bDashletIdInNewFormat = ($sDashletIdOrig === $oDashlet->GetID());
+		if ($bDashletIdInNewFormat)
+		{
+			return;
+		}
+
+		$sNewPrefKey = $this->GetDashletObjectListAppUserPreferencesPrefix($oDashlet, $aExtraParams, $oDashlet->GetID());
+		$sPrefValueForNewKey = appUserPreferences::GetPref($sNewPrefKey, null);
+		$bHasPrefInNewFormat = ($sPrefValueForNewKey !== null);
+		if ($bHasPrefInNewFormat)
+		{
+			return;
+		}
+
+		$sOldPrefKey = $this->GetDashletObjectListAppUserPreferencesPrefix($oDashlet, $aExtraParams, $sDashletIdOrig);
+		$sPrefValueForOldKey = appUserPreferences::GetPref($sOldPrefKey, null);
+		$bHasPrefInOldFormat = ($sPrefValueForOldKey !== null);
+		if (!$bHasPrefInOldFormat)
+		{
+			return;
+		}
+
+		appUserPreferences::SetPref($sNewPrefKey, $sPrefValueForOldKey);
+		appUserPreferences::UnsetPref($sOldPrefKey);
+	}
+
+	/**
+	 * @param \DashletObjectList $oDashlet
+	 * @param array $aExtraParams
+	 * @param string $sDashletId
+	 *
+	 * @return string
+	 * @since 2.7.0
+	 */
+	private function GetDashletObjectListAppUserPreferencesPrefix(DashletObjectList $oDashlet, $aExtraParams, $sDashletId)
+	{
+		$sDataTableId = Dashlet::APPUSERPREFERENCES_PREFIX.$sDashletId;
+		$aClassAliases = array();
+		try{
+			$oFilter = $oDashlet->GetDBSearch($aExtraParams);
+			$aClassAliases = $oFilter->GetSelectedClasses();
+		}
+		catch (Exception $e)
+		{
+			//on error, return default value
+			return null;
+		}
+		return DataTableSettings::GetAppUserPreferenceKey($aClassAliases, $sDataTableId);
+	}
+}

application/dashboardlayout.class.inc.php

@@ -26,14 +26,17 @@
 
 abstract class DashboardLayout
 {
-	public function __construct()
-	{
-		
-	}
-	
 	abstract public function Render($oPage, $aDashlets, $bEditMode = false);
+
+	/**
+	 * @param int $iCellIdx
+	 *
+	 * @return array Containing 2 scalars: Col number and row number (starting from 0)
+	 * @since 2.7.0
+	 */
+	abstract public function GetDashletCoordinates($iCellIdx);
 	
-	static public function GetInfo()
+	public static function GetInfo()
 	{
 		return array(
 			'label' => '',
@@ -51,7 +54,7 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
 	{
 		$this->iNbCols = 1;
 	}
-	
+
 	protected function TrimCell($aDashlets)
 	{
 		$aKeys = array_reverse(array_keys($aDashlets));
@@ -61,7 +64,7 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
 		{
 			/** @var \Dashlet $oDashlet */
 			$oDashlet = $aDashlets[$aKeys[$idx]];
-			if ($oDashlet->IsVisible())
+			if ($oDashlet::IsVisible())
 			{
 				$bNoVisibleFound = false;
 			}
@@ -110,20 +113,21 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
 	{
 		// 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>');
+			$oPage->add("<tr data-dashboard-row-index=\"$iRows\">");
 			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\">");
+				$oPage->add("<td style=\"$sStyle\" class=\"$sCellClass\" data-dashboard-column-index=\"$iCols\" data-dashboard-cell-index=\"$iCellIdx\">");
 				if (array_key_exists($iCellIdx, $aCells))
 				{
 					$aDashlets = $aCells[$iCellIdx];
@@ -132,7 +136,7 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
 						/** @var \Dashlet $oDashlet */
 						foreach($aDashlets as $oDashlet)
 						{
-							if ($oDashlet->IsVisible())
+							if ($oDashlet::IsVisible())
 							{
 								$oDashlet->DoRender($oPage, $bEditMode, true /* bEnclosingDiv */, $aExtraParams);
 							}
@@ -155,10 +159,10 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
 		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>');
+			$oPage->add("<tr data-dashboard-row-index=\"$iRows\">");
 			for($iCols = 0; $iCols < $this->iNbCols; $iCols++)
 			{
-				$oPage->add("<td $sStyle>");
+				$oPage->add("<td $sStyle data-dashboard-column-index=\"$iCols\">");
 				$oPage->add('&nbsp;');
 				$oPage->add('</td>');
 			}
@@ -166,6 +170,17 @@ abstract class DashboardLayoutMultiCol extends DashboardLayout
 		}
 		$oPage->add('</tbody></table>');
 	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function GetDashletCoordinates($iCellIdx)
+	{
+		$iColNumber = (int) $iCellIdx % $this->iNbCols;
+		$iRowNumber = (int) floor($iCellIdx / $this->iNbCols);
+
+		return array($iColNumber, $iRowNumber);
+	}
 }
 
 class DashboardLayoutOneCol extends DashboardLayoutMultiCol

application/dashlet.class.inc.php

@@ -26,6 +26,9 @@ require_once(APPROOT.'application/forms.class.inc.php');
  */
 abstract class Dashlet
 {
+	/** @var string */
+	const APPUSERPREFERENCES_PREFIX = 'Dashlet';
+
 	protected $oModelReflection;
 	protected $sId;
 	protected $bRedrawNeeded;
@@ -252,7 +255,7 @@ abstract class Dashlet
 		catch(OqlException $e)
 		{
 			$oPage->add('<div class="dashlet-content">');
-			$oPage->p($e->GetUserFriendlyDescription());
+			$oPage->p(utils::HtmlEntities($e->GetUserFriendlyDescription()));
 			$oPage->add('</div>');
 		}
 		catch(Exception $e)
@@ -456,17 +459,21 @@ EOF
 					$sAttType = $aTargetAttCodes[$sTargetAttCode];
 					$sExtFieldAttCode = $sTargetAttCode;
 				}
-				if (is_a($sAttType, 'AttributeLinkedSet', true))
-				{
-					continue;
-				}
-				if (is_a($sAttType, 'AttributeFriendlyName', true))
-				{
-					continue;
-				}
-				if (is_a($sAttType, 'AttributeOneWayPassword', true))
-				{
-					continue;
+
+				$aForbidenAttType = [
+					'AttributeLinkedSet',
+					'AttributeFriendlyName',
+
+					'iAttributeNoGroupBy', //we cannot only use iAttributeNoGroupBy since this method is also used by the designer who do not have access to the classes' PHP reflection API. So the known classes has to be listed altogether
+					'AttributeOneWayPassword',
+					'AttributeEncryptedString',
+					'AttributePassword',
+				];
+				foreach ($aForbidenAttType as $sForbidenAttType) {
+					if (is_a($sAttType, $sForbidenAttType, true))
+					{
+						continue 2;
+					}
 				}
 
 				$sLabel = $this->oModelReflection->GetLabel($sClass, $sAttCode);
@@ -514,7 +521,7 @@ EOF
  *
  * Used as a fallback in iTop for unknown dashlet classes.
  *
- * @since 2.5
+ * @since 2.5.0
  */
 class DashletUnknown extends Dashlet
 {
@@ -613,12 +620,12 @@ class DashletUnknown extends Dashlet
 	{
 		$aInfos = static::GetInfo();
 
-		$sIconUrl = utils::GetAbsoluteUrlAppRoot().$aInfos['icon'];
+		$sIconUrl = utils::HtmlEntities(utils::GetAbsoluteUrlAppRoot().$aInfos['icon']);
 		$sExplainText = ($bEditMode) ? Dict::Format('UI:DashletUnknown:RenderText:Edit', $this->GetDashletType()) : Dict::S('UI:DashletUnknown:RenderText:View');
 
 		$oPage->add('<div class="dashlet-content">');
 
-		$oPage->add('<div class="dashlet-ukn-image"><img src="'.utils::HtmlEntities($sIconUrl).'" /></div>');
+		$oPage->add('<div class="dashlet-ukn-image"><img src="'.$sIconUrl.'" /></div>');
 		$oPage->add('<div class="dashlet-ukn-text">'.$sExplainText.'</div>');
 
 		$oPage->add('</div>');
@@ -633,12 +640,12 @@ class DashletUnknown extends Dashlet
 	{
 		$aInfos = static::GetInfo();
 
-		$sIconUrl = utils::GetAbsoluteUrlAppRoot().$aInfos['icon'];
+		$sIconUrl = utils::HtmlEntities(utils::GetAbsoluteUrlAppRoot().$aInfos['icon']);
 		$sExplainText = Dict::Format('UI:DashletUnknown:RenderNoDataText:Edit', $this->GetDashletType());
 
 		$oPage->add('<div class="dashlet-content">');
 
-		$oPage->add('<div class="dashlet-ukn-image"><img src="'.utils::HtmlEntities($sIconUrl).'" /></div>');
+		$oPage->add('<div class="dashlet-ukn-image"><img src="'.$sIconUrl.'" /></div>');
 		$oPage->add('<div class="dashlet-ukn-text">'.$sExplainText.'</div>');
 
 		$oPage->add('</div>');
@@ -774,12 +781,12 @@ class DashletProxy extends DashletUnknown
 	{
 		$aInfos = static::GetInfo();
 
-		$sIconUrl = utils::GetAbsoluteUrlAppRoot().$aInfos['icon'];
+		$sIconUrl = utils::HtmlEntities(utils::GetAbsoluteUrlAppRoot().$aInfos['icon']);
 		$sExplainText = Dict::Format('UI:DashletProxy:RenderNoDataText:Edit', $this->GetDashletType());
 
 		$oPage->add('<div class="dashlet-content">');
 
-		$oPage->add('<div class="dashlet-pxy-image"><img src="'.utils::HtmlEntities($sIconUrl).'" /></div>');
+		$oPage->add('<div class="dashlet-pxy-image"><img src="'.$sIconUrl.'" /></div>');
 		$oPage->add('<div class="dashlet-pxy-text">'.$sExplainText.'</div>');
 
 		$oPage->add('</div>');
@@ -860,7 +867,7 @@ class DashletPlainText extends Dashlet
 	 */
 	public function Render($oPage, $bEditMode = false, $aExtraParams = array())
 	{
-		$sText = htmlentities($this->aProperties['text'], ENT_QUOTES, 'UTF-8');
+		$sText = utils::HtmlEntities($this->aProperties['text']);
 		$sText = str_replace(array("\r\n", "\n", "\r"), "<br/>", $sText);
 
 		$sId = 'plaintext_'.($bEditMode? 'edit_' : '').$this->sId;
@@ -913,15 +920,28 @@ class DashletObjectList extends Dashlet
 	public function Render($oPage, $bEditMode = false, $aExtraParams = array())
 	{
 		$sTitle = $this->aProperties['title'];
-		$sQuery = $this->aProperties['query'];
 		$sShowMenu = $this->aProperties['menu'] ? '1' : '0';
 
 		$oPage->add('<div class="dashlet-content">');
-		$sHtmlTitle = htmlentities(Dict::S($sTitle), ENT_QUOTES, 'UTF-8'); // done in the itop block
+		$sHtmlTitle = utils::HtmlEntities(Dict::S($sTitle)); // done in the itop block
 		if ($sHtmlTitle != '')
 		{
-			$oPage->add('<h1>'.$sHtmlTitle.'</h1>');
+			$oPage->add('<div class="main_header"><h1>&nbsp;'.$sHtmlTitle.'</h1></div>');
 		}
+		$oFilter = $this->GetDBSearch($aExtraParams);
+		$oBlock = new DisplayBlock($oFilter, 'list');
+		$aParams = array(
+			'menu' => $sShowMenu,
+			'table_id' => self::APPUSERPREFERENCES_PREFIX.$this->sId,
+		);
+		$sBlockId = 'block_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occurring in the same DOM)
+		$oBlock->Display($oPage, $sBlockId, array_merge($aExtraParams, $aParams));
+		$oPage->add('</div>');
+	}
+
+	public function GetDBSearch($aExtraParams = array())
+	{
+		$sQuery = $this->aProperties['query'];
 		if (isset($aExtraParams['query_params']))
 		{
 			$aQueryParams = $aExtraParams['query_params'];
@@ -935,15 +955,8 @@ class DashletObjectList extends Dashlet
 		{
 			$aQueryParams = array();
 		}
-		$oFilter = DBObjectSearch::FromOQL($sQuery, $aQueryParams);
-		$oBlock = new DisplayBlock($oFilter, 'list');
-		$aParams = array(
-			'menu' => $sShowMenu,
-			'table_id' => 'Dashlet'.$this->sId,
-		);
-		$sBlockId = 'block_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occurring in the same DOM)
-		$oBlock->Display($oPage, $sBlockId, array_merge($aExtraParams, $aParams));
-		$oPage->add('</div>');
+
+		return DBObjectSearch::FromOQL($sQuery, $aQueryParams);
 	}
 
 	/**
@@ -956,7 +969,7 @@ class DashletObjectList extends Dashlet
 		$bShowMenu = $this->aProperties['menu'];
 
 		$oPage->add('<div class="dashlet-content">');
-		$sHtmlTitle = htmlentities($this->oModelReflection->DictString($sTitle), ENT_QUOTES, 'UTF-8'); // done in the itop block
+		$sHtmlTitle = utils::HtmlEntities($this->oModelReflection->DictString($sTitle)); // done in the itop block
 		if ($sHtmlTitle != '')
 		{
 			$oPage->add('<h1>'.$sHtmlTitle.'</h1>');
@@ -1112,7 +1125,7 @@ abstract class DashletGroupBy extends Dashlet
 			$this->sFunction = null;
 		}
 
-		if (empty($this->aProperties['order_direction']))
+		if ((!is_null($this->sClass)) && empty($this->aProperties['order_direction']))
 		{
 			$aAttributeTypes = $this->oModelReflection->ListAttributes($this->sClass);
 			if (isset($aAttributeTypes[$this->sGroupByAttCode]))
@@ -1249,7 +1262,7 @@ abstract class DashletGroupBy extends Dashlet
 
 				case 'table':
 				default:
-					$sHtmlTitle = htmlentities(Dict::S($sTitle), ENT_QUOTES, 'UTF-8'); // done in the itop block
+					$sHtmlTitle = utils::HtmlEntities(Dict::S($sTitle)); // done in the itop block
 					$sType = 'count';
 					$aParams = array(
 						'group_by' => $this->sGroupByExpr,
@@ -1263,10 +1276,10 @@ abstract class DashletGroupBy extends Dashlet
 					break;
 			}
 
-			$oPage->add('<div style="text-align:center" class="dashlet-content">');
+			$oPage->add('<div class="dashlet-content">');
 			if ($sHtmlTitle != '')
 			{
-				$oPage->add('<h1>'.$sHtmlTitle.'</h1>');
+				$oPage->add('<div class="main_header"><h1>&nbsp;'.$sHtmlTitle.'</h1></div>');
 			}
 			$sBlockId = 'block_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM)
 			$oBlock = new DisplayBlock($oFilter, $sType);
@@ -1686,7 +1699,7 @@ class DashletGroupByPie extends DashletGroupBy
 
 		$sBlockId = 'block_fake_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM)
 
-		$HTMLsTitle = ($sTitle != '') ? '<h1 style="text-align:center">'.htmlentities($sTitle, ENT_QUOTES, 'UTF-8').'</h1>' : '';
+		$HTMLsTitle = ($sTitle != '') ? '<h1 style="text-align:center">'.utils::HtmlEntities($sTitle).'</h1>' : '';
 		$oPage->add("<div style=\"background-color:#fff;padding:0.25em;\">$HTMLsTitle<div id=\"$sBlockId\" style=\"background-color:#fff;\"></div></div>");
 
 		$aDisplayValues = $this->MakeSimulatedData();
@@ -1758,7 +1771,7 @@ class DashletGroupByBars extends DashletGroupBy
 
 		$sBlockId = 'block_fake_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM)
 
-		$HTMLsTitle = ($sTitle != '') ? '<h1 style="text-align:center">'.htmlentities($sTitle, ENT_QUOTES, 'UTF-8').'</h1>' : '';
+		$HTMLsTitle = ($sTitle != '') ? '<h1 style="text-align:center">'.utils::HtmlEntities($sTitle).'</h1>' : '';
 		$oPage->add("<div style=\"background-color:#fff;padding:0.25em;\">$HTMLsTitle<div id=\"$sBlockId\" style=\"background-color:#fff;\"></div></div>");
 
 		$aDisplayValues = $this->MakeSimulatedData();
@@ -1859,11 +1872,11 @@ class DashletGroupByTable extends DashletGroupBy
 			$iTotal += $aDisplayData['value'];
 		}
 
-		$oPage->add('<div class="dashlet-content">');
 
 		$sBlockId = 'block_fake_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM)
 
 		$oPage->add('<div id="'.$sBlockId.'" class="display_block">');
+		$oPage->add('<div class="dashlet-content">');
 		$oPage->add('<p>'.Dict::Format('UI:Pagination:HeaderNoSelection', $iTotal).'</p>');
 		$oPage->add('<table class="listResults">');
 		$oPage->add('<thead>');
@@ -1907,17 +1920,17 @@ class DashletHeaderStatic extends Dashlet
 	 */
 	public function Render($oPage, $bEditMode = false, $aExtraParams = array())
 	{
-		$sTitle = $this->aProperties['title'];
+		$sTitle = utils::HtmlEntities($this->aProperties['title']);
 		$sIcon = $this->aProperties['icon'];
 
 		$oIconSelect = $this->oModelReflection->GetIconSelectionField('icon');
-		$sIconPath = $oIconSelect->MakeFileUrl($sIcon);
+		$sIconPath = utils::HtmlEntities($oIconSelect->MakeFileUrl($sIcon));
 
 		$oPage->add('<div class="dashlet-content">');
 		$oPage->add('<div class="main_header">');
 
-		$oPage->add('<img src="'.utils::HtmlEntities($sIconPath).'">');
-		$oPage->add('<h1>'.$this->oModelReflection->DictString($sTitle).'</h1>');
+		$oPage->add('<img src="'.$sIconPath.'">');
+		$oPage->add('<div class="main_header"><h1>&nbsp;'.$this->oModelReflection->DictString($sTitle).'</h1></div>');
 
 		$oPage->add('</div>');
 		$oPage->add('</div>');
@@ -2037,14 +2050,14 @@ class DashletHeaderDynamic extends Dashlet
 	 */
 	public function Render($oPage, $bEditMode = false, $aExtraParams = array())
 	{
-		$sTitle = $this->aProperties['title'];
+		$sTitle = utils::HtmlEntities($this->aProperties['title']);
 		$sIcon = $this->aProperties['icon'];
-		$sSubtitle = $this->aProperties['subtitle'];
+		$sSubtitle = utils::HtmlEntities($this->aProperties['subtitle']);
 		$sQuery = $this->aProperties['query'];
 		$sGroupBy = $this->aProperties['group_by'];
 
 		$oIconSelect = $this->oModelReflection->GetIconSelectionField('icon');
-		$sIconPath = $oIconSelect->MakeFileUrl($sIcon);
+		$sIconPath = utils::HtmlEntities($oIconSelect->MakeFileUrl($sIcon));
 
 		$aValues = $this->GetValues();
 		if (count($aValues) > 0)
@@ -2072,7 +2085,7 @@ class DashletHeaderDynamic extends Dashlet
 		$oPage->add('<div class="dashlet-content">');
 		$oPage->add('<div class="main_header">');
 
-		$oPage->add('<img src="'.utils::HtmlEntities($sIconPath).'">');
+		$oPage->add('<img src="'.$sIconPath.'">');
 
 		if (isset($aExtraParams['query_params']))
 		{
@@ -2101,9 +2114,9 @@ class DashletHeaderDynamic extends Dashlet
 	 */
 	public function RenderNoData($oPage, $bEditMode = false, $aExtraParams = array())
 	{
-		$sTitle = $this->aProperties['title'];
+		$sTitle = utils::HtmlEntities($this->aProperties['title']);
 		$sIcon = $this->aProperties['icon'];
-		$sSubtitle = $this->aProperties['subtitle'];
+		$sSubtitle = utils::HtmlEntities($this->aProperties['subtitle']);
 		$sQuery = $this->aProperties['query'];
 		$sGroupBy = $this->aProperties['group_by'];
 
@@ -2111,12 +2124,12 @@ class DashletHeaderDynamic extends Dashlet
 		$sClass = $oQuery->GetClass();
 
 		$oIconSelect = $this->oModelReflection->GetIconSelectionField('icon');
-		$sIconPath = $oIconSelect->MakeFileUrl($sIcon);
+		$sIconPath = utils::HtmlEntities($oIconSelect->MakeFileUrl($sIcon));
 
 		$oPage->add('<div class="dashlet-content">');
 		$oPage->add('<div class="main_header">');
 
-		$oPage->add('<img src="'.utils::HtmlEntities($sIconPath).'">');
+		$oPage->add('<img src="'.$sIconPath.'">');
 
 		$sBlockId = 'block_fake_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM)
 
@@ -2147,8 +2160,8 @@ class DashletHeaderDynamic extends Dashlet
 		$sTitle = $this->oModelReflection->DictString($sTitle);
 		$sSubtitle = $this->oModelReflection->DictFormat($sSubtitle, $iTotal);
 
-		$oPage->add('<h1>'.$sTitle.'</h1>');
-		$oPage->add('<a class="summary">'.$sSubtitle.'</a>');
+		$oPage->add('<h1>'.utils::HtmlEntities($sTitle).'</h1>');
+		$oPage->add('<a class="summary">'.utils::HtmlEntities($sSubtitle).'</a>');
 		$oPage->add('</div>');
 
 		$oPage->add('</div>');

application/datamodel.application.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<itop_design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.6">
+<itop_design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.7">
   <portals>
     <portal id="backoffice" _delta="define">
       <url>pages/UI.php</url>
@@ -15,5 +15,10 @@
     <menu id="AdminTools" xsi:type="MenuGroup" _delta="define">
       <rank>80</rank>
     </menu>
+    <menu id="SystemTools" xsi:type="MenuGroup" _delta="define">
+      <rank>100</rank>
+      <enable_class>ResourceSystemMenu</enable_class>
+      <enable_action>UR_ACTION_MODIFY</enable_action>
+    </menu>
   </menus>
 </itop_design>

application/datatable.class.inc.php

@@ -1,30 +1,27 @@
 <?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 (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2017 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 class DataTable
 {
 	protected $iListId;		// Unique ID inside the web page
+	/** @var string */
+	private $sDatatableContainerId;
 	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
@@ -34,14 +31,20 @@ class DataTable
 	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
+	 * @param string $iListId  Unique ID for this div/table in the page
+	 * @param DBObjectSet $oSet The set of data to display
+	 * @param array$aClassAliases The list of classes/aliases to be displayed in this set $sAlias => $sClassName
+	 * @param string $sTableId A string (or null) identifying this table in order to persist its settings
+	 *
+	 * @throws \CoreException
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
 	 */
 	public function __construct($iListId, $oSet, $aClassAliases, $sTableId = null)
 	{
 		$this->iListId = utils::GetSafeId($iListId); // Make a "safe" ID for jQuery
+		$this->sDatatableContainerId = 'datatable_'.utils::GetSafeId($iListId);
 		$this->oSet = $oSet;
 		$this->aClassAliases = $aClassAliases;
 		$this->sTableId = $sTableId;
@@ -50,7 +53,19 @@ class DataTable
 		$this->oDefaultSettings = null;
 		$this->bShowObsoleteData = $oSet->GetShowObsoleteData();
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param \DataTableSettings $oSettings
+	 * @param $bActionsMenu
+	 * @param $sSelectMode
+	 * @param $bViewLink
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \CoreException
+	 * @throws \MySQLException
+	 */
 	public function Display(WebPage $oPage, DataTableSettings $oSettings, $bActionsMenu, $sSelectMode, $bViewLink, $aExtraParams)
 	{
 		$this->oDefaultSettings = $oSettings;
@@ -119,7 +134,23 @@ class DataTable
 		
 		return $this->GetAsHTML($oPage, $oCustomSettings->iDefaultPageSize, $oCustomSettings->iDefaultPageSize, 0, $oCustomSettings->aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams);
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $iPageSize
+	 * @param $iDefaultPageSize
+	 * @param $iPageIndex
+	 * @param $aColumns
+	 * @param $bActionsMenu
+	 * @param $bToolkitMenu
+	 * @param $sSelectMode
+	 * @param $bViewLink
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 */
 	public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
 	{
 		$sObjectsCount = $this->GetObjectCount($oPage, $sSelectMode);
@@ -137,7 +168,7 @@ class DataTable
 		$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 = "<table id=\"{$this->sDatatableContainerId}\" 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>";
@@ -173,7 +204,7 @@ class DataTable
 			$aOptions['oDefaultSettings'] = $this->GetAsHash($this->oDefaultSettings);
 		}
 		$sJSOptions = json_encode($aOptions);
-		$oPage->add_ready_script("$('#datatable_{$this->iListId}').datatable($sJSOptions);");
+		$oPage->add_ready_script("$('#{$this->sDatatableContainerId}').datatable($sJSOptions);");
 
 		return $sHtml;
 	}
@@ -198,7 +229,13 @@ class DataTable
 		}
 		return $sHtml;
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $sSelectMode
+	 *
+	 * @return string
+	 */
 	protected function GetObjectCount(WebPage $oPage, $sSelectMode)
 	{
 		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
@@ -211,6 +248,15 @@ class DataTable
 		}
 		return $sHtml;		
 	}
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $iPageSize
+	 * @param $iDefaultPageSize
+	 * @param $iPageIndex
+	 *
+	 * @return string
+	 */
 	protected function GetPager(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex)
 	{
 		$sHtml = '';
@@ -295,7 +341,17 @@ class DataTable
 EOF;
 		return $sHtml;
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 */
 	protected function GetActionsMenu(WebPage $oPage, $aExtraParams)
 	{
 		$oMenuBlock = new MenuBlock($this->oSet->GetFilter(), 'list');
@@ -303,13 +359,20 @@ EOF;
 		$sHtml = $oMenuBlock->GetRenderContent($oPage, $aExtraParams, $this->iListId);
 		return $sHtml;
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \Exception
+	 */
 	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>';
+			$sHtml = '<div class="itop_popup toolkit_menu" id="tk_'.$this->iListId.'"><ul><li aria-label="'.Dict::S('UI:Menu:Toolkit').'"><i class="fas fa-tools"></i><i class="fas fa-caret-down"></i><ul>';
 	
 			$oMenuItem1 = new JSPopupMenuItem('iTop::ConfigureList', $sMenuTitle, "$('#datatable_dlg_".$this->iListId."').dialog('open');");
 			$aActions = array(
@@ -326,7 +389,15 @@ EOF;
 		}
 		return $sHtml;
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $aColumns
+	 * @param $bViewLink
+	 * @param $iDefaultPageSize
+	 *
+	 * @return string
+	 */
 	protected function GetTableConfigDlg(WebPage $oPage, $aColumns, $bViewLink, $iDefaultPageSize)
 	{
 		$sHtml = "<div id=\"datatable_dlg_{$this->iListId}\" style=\"display: none;\">";
@@ -350,35 +421,54 @@ EOF;
 		$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 .= '<button type="button" onclick="$(\'#'.$this->sDatatableContainerId.'\').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 .= '<button type="submit" onclick="$(\'#'.$this->sDatatableContainerId.'\').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'); } });");
+		$oPage->add_ready_script("$('#datatable_dlg_{$this->iListId}').dialog({autoOpen: false, title: '$sDlgTitle', width: 500, close: function() { $('#{$this->sDatatableContainerId}').datatable('onDlgCancel'); } });");
 
 		return $sHtml;
 	}
-	
+
+	/**
+	 * @param $oSetting
+	 *
+	 * @return array
+	 */
 	public function GetAsHash($oSetting)
 	{
 		$aSettings = array('iDefaultPageSize' => $oSetting->iDefaultPageSize, 'oColumns' => $oSetting->aColumns);
 		return $aSettings;
 	}
-	
+
+	/**
+	 * @param array $aColumns
+	 * @param string $sSelectMode
+	 * @param bool $bViewLink
+	 *
+	 * @return array
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 * @throws \Exception
+	 */
 	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+'));
+			$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+'),
+				'metadata' => array(),
+			);
 		}
 		else if ($sSelectMode == 'single')
 		{
-			$aAttribs['form::select'] = array('label' => "", 'description' => '');
+			$aAttribs['form::select'] = array('label' => '', 'description' => '', 'metadata' => array());
 		}
 
 		foreach($this->aClassAliases as $sAlias => $sClassName)
@@ -389,19 +479,55 @@ EOF;
 				{
 					if ($sAttCode == '_key_')
 					{
-						$aAttribs['key_'.$sAlias] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
+						$sAttLabel = MetaModel::GetName($sClassName);
+
+						$aAttribs['key_'.$sAlias] = array(
+							'label' => $sAttLabel,
+							'description' => '',
+							'metadata' => array(
+								'object_class' => $sClassName,
+								'attribute_label' => $sAttLabel,
+							),
+						);
 					}
 					else
 					{
 						$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
-						$aAttribs[$sAttCode.'_'.$sAlias] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => $oAttDef->GetOrderByHint());
+						$sAttDefClass = get_class($oAttDef);
+						$sAttLabel = MetaModel::GetLabel($sClassName, $sAttCode);
+
+						$aAttribs[$sAttCode.'_'.$sAlias] = array(
+							'label' => $sAttLabel,
+							'description' => $oAttDef->GetOrderByHint(),
+							'metadata' => array(
+								'object_class' => $sClassName,
+								'attribute_code' => $sAttCode,
+								'attribute_type' => $sAttDefClass,
+								'attribute_label' => $sAttLabel,
+							),
+						);
 					}
 				}
 			}
 		}
 		return $aAttribs;
 	}
-	
+
+	/**
+	 * @param $aColumns
+	 * @param $sSelectMode
+	 * @param $iPageSize
+	 * @param $bViewLink
+	 * @param $aExtraParams
+	 *
+	 * @return array
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \Exception
+	 */
 	protected function GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
 	{
 		$bLocalize = true;
@@ -411,6 +537,7 @@ EOF;
 		}
 
 		$aValues = array();
+		$aAttDefsCache = array();
 		$this->oSet->Seek(0);
 		$iMaxObjects = $iPageSize;
 		while (($aObjects = $this->oSet->FetchAssoc()) && ($iMaxObjects != 0))
@@ -451,11 +578,41 @@ EOF;
 						{
 							if ($sAttCode == '_key_')
 							{
-								$aRow['key_'.$sAlias] = $aObjects[$sAlias]->GetHyperLink();
+								$aRow['key_'.$sAlias] = array(
+									'value_raw' => $aObjects[$sAlias]->GetKey(),
+									'value_html' => $aObjects[$sAlias]->GetHyperLink(),
+								);
 							}
 							else
 							{
-								$aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode, $bLocalize);
+								// Prepare att. def. classes cache to avoid retrieving AttDef for each row
+								if(!isset($aAttDefsCache[$sClassName][$sAttCode]))
+								{
+									$aAttDefClassesCache[$sClassName][$sAttCode] = get_class(MetaModel::GetAttributeDef($sClassName, $sAttCode));
+								}
+
+								// Only retrieve raw (stored) value for simple fields
+								$bExcludeRawValue = false;
+								foreach (cmdbAbstractObject::GetAttDefClassesToExcludeFromMarkupMetadataRawValue() as $sAttDefClassToExclude)
+								{
+									if (is_a($aAttDefClassesCache[$sClassName][$sAttCode], $sAttDefClassToExclude, true))
+									{
+										$bExcludeRawValue = true;
+										break;
+									}
+								}
+
+								if($bExcludeRawValue)
+								{
+									$aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode, $bLocalize);
+								}
+								else
+								{
+									$aRow[$sAttCode.'_'.$sAlias] = array(
+										'value_raw' => $aObjects[$sAlias]->Get($sAttCode),
+										'value_html' => $aObjects[$sAlias]->GetAsHTML($sAttCode, $bLocalize),
+									);
+								}
 							}
 						}
 					}
@@ -484,7 +641,25 @@ EOF;
 		}
 		return $aValues;
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $aColumns
+	 * @param $sSelectMode
+	 * @param $iPageSize
+	 * @param $bViewLink
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \DictExceptionMissingString
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \Exception
+	 */
 	public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
 	{
 		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
@@ -496,7 +671,7 @@ EOF;
 
 		$aValues = $this->GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
 
-		$sHtml = '<table class="listContainer">';
+		$sHtml = '<table class="listContainer object-list">';
 
 		foreach($this->oSet->GetFilter()->GetInternalParams() as $sName => $sValue)
 		{
@@ -573,19 +748,37 @@ EOF;
 		}
 		$sOQL = addslashes($this->oSet->GetFilter()->serialize());
 		$oPage->add_ready_script(
-<<<EOF
-var oTable = $('#{$this->iListId} table.listResults');
+<<<JS
+var oTable = $('#{$this->sDatatableContainerId} 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
-		);
+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->sDatatableContainerId}',
+		columns: $sJSColumns,
+		class_aliases: $sJSClassAliases $sCssCount
+	});
+JS
+	);
 		if ($sFakeSortList != '')
 		{
 			$oPage->add_ready_script("oTable.trigger(\"fakesorton\", [$sFakeSortList]);");
 		}
 		return $sHtml;
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $iDefaultPageSize
+	 * @param $iStart
+	 */
 	public function UpdatePager(WebPage $oPage, $iDefaultPageSize, $iStart)
 	{
 		$iPageSize = $iDefaultPageSize;
@@ -609,11 +802,48 @@ EOF
  */
 class PrintableDataTable extends DataTable
 {
+	/**
+	 * @param \WebPage $oPage
+	 * @param $iPageSize
+	 * @param $iDefaultPageSize
+	 * @param $iPageIndex
+	 * @param $aColumns
+	 * @param $bActionsMenu
+	 * @param $bToolkitMenu
+	 * @param $sSelectMode
+	 * @param $bViewLink
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \DictExceptionMissingString
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 */
 	public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
 	{
 		return $this->GetHTMLTable($oPage, $aColumns, $sSelectMode, -1, $bViewLink, $aExtraParams);
 	}
-	
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param $aColumns
+	 * @param $sSelectMode
+	 * @param $iPageSize
+	 * @param $bViewLink
+	 * @param $aExtraParams
+	 *
+	 * @return string
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \DictExceptionMissingString
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 */
 	public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
 	{
 		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
@@ -638,7 +868,13 @@ class DataTableSettings implements Serializable
 	public $iDefaultPageSize;
 	public $aColumns;
 
-	
+
+	/**
+	 * DataTableSettings constructor.
+	 *
+	 * @param $aClassAliases
+	 * @param null $sTableId
+	 */
 	public function __construct($aClassAliases, $sTableId = null)
 	{
 		$this->aClassAliases = $aClassAliases;
@@ -646,14 +882,22 @@ class DataTableSettings implements Serializable
 		$this->iDefaultPageSize = 10;
 		$this->aColumns = array();
 	}
-	
+
+	/**
+	 * @param $iDefaultPageSize
+	 * @param $aSortOrder
+	 * @param $aColumns
+	 */
 	protected function Init($iDefaultPageSize, $aSortOrder, $aColumns)
 	{
 		$this->iDefaultPageSize = $iDefaultPageSize;
 		$this->aColumns = $aColumns;
 		$this->FixVisibleColumns();
 	}
-	
+
+	/**
+	 * @return string
+	 */
 	public function serialize()
 	{
 		// Save only the 'visible' columns
@@ -679,7 +923,12 @@ class DataTableSettings implements Serializable
 			)
 		);
 	}
-	
+
+	/**
+	 * @param string $sData
+	 *
+	 * @throws \Exception
+	 */
 	public function unserialize($sData)
 	{
 		$aData = unserialize($sData);
@@ -712,7 +961,16 @@ class DataTableSettings implements Serializable
 		}
 		$this->FixVisibleColumns();		
 	}
-	
+
+	/**
+	 * @param $aClassAliases
+	 * @param $bViewLink
+	 * @param $aDefaultLists
+	 *
+	 * @return \DataTableSettings
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 */
 	static public function GetDataModelSettings($aClassAliases, $bViewLink, $aDefaultLists)
 	{
 		$oSettings = new DataTableSettings($aClassAliases);
@@ -762,7 +1020,10 @@ class DataTableSettings implements Serializable
 		$oSettings->Init($iDefaultPageSize, $aSortOrder, $aColumns);
 		return $oSettings;
 	}
-	
+
+	/**
+	 * @throws \CoreException
+	 */
 	protected function FixVisibleColumns()
 	{
 		foreach($this->aClassAliases as $sAlias => $sClass)
@@ -799,7 +1060,15 @@ class DataTableSettings implements Serializable
 			}
 		}		
 	}
-	
+
+	/**
+	 * @param $aClassAliases
+	 * @param null $sTableId
+	 * @param bool $bOnlyOnTable
+	 *
+	 * @return \DataTableSettings|null
+	 * @throws \Exception
+	 */
 	static public function GetTableSettings($aClassAliases, $sTableId = null, $bOnlyOnTable = false)
 	{
 		$pref = null;
@@ -828,7 +1097,10 @@ class DataTableSettings implements Serializable
 		
 		return $oSettings;
 	}
-	
+
+	/**
+	 * @return array
+	 */
 	public function GetSortOrder()
 	{
 		$aSortOrder = array();
@@ -846,7 +1118,12 @@ class DataTableSettings implements Serializable
 		}
 		return $aSortOrder;
 	}
-	
+
+	/**
+	 * @param null $sTargetTableId
+	 *
+	 * @return bool
+	 */
 	public function Save($sTargetTableId = null)
 	{
 		$sSaveId = is_null($sTargetTableId) ? $this->sTableId : $sTargetTableId;
@@ -857,6 +1134,9 @@ class DataTableSettings implements Serializable
 		return true;
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function SaveAsDefault()
 	{
 		$sSettings = $this->serialize();
@@ -886,18 +1166,43 @@ class DataTableSettings implements Serializable
 		}
 		return true;
 	}
-	
+
+	/**
+	 * @param null $sTableId
+	 *
+	 * @return string
+	 */
 	protected function GetPrefsKey($sTableId = null)
 	{
-		if ($sTableId == null) $sTableId = '*';
+		return static::GetAppUserPreferenceKey($this->aClassAliases, $sTableId);
+	}
+
+	public static function GetAppUserPreferenceKey($aClassAliases, $sTableId)
+	{
+		if ($sTableId === null)
+		{
+			$sTableId = '*';
+		}
+
 		$aKeys = array();
-		foreach($this->aClassAliases as $sAlias => $sClass)
+		foreach($aClassAliases as $sAlias => $sClass)
 		{
 			$aKeys[] = $sAlias.'-'.$sClass;
 		}
 		return implode('/', $aKeys).'|'.$sTableId;
 	}
-	
+
+	/**
+	 * @param $sAlias
+	 * @param $sAttCode
+	 * @param $oAttDef
+	 * @param $bChecked
+	 * @param $sSort
+	 *
+	 * @return array|bool
+	 * @throws \CoreException
+	 * @throws \DictExceptionMissingString
+	 */
 	protected function GetFieldData($sAlias, $sAttCode, $oAttDef, $bChecked, $sSort)
 	{
 		$ret = false;

application/displayblock.class.inc.php

@@ -1,26 +1,20 @@
 <?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/>
-
 /**
- * DisplayBlock and derived class
+ * Copyright (C) 2013-2019 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2017 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -91,7 +85,7 @@ class DisplayBlock
 	{
 		$oDummyFilter = new DBObjectSearch($oSet->GetClass());
 		$aKeys = array();
-		$oSet->OptimizeColumnLoad(array('id')); // No need to load all the columns just to get the id
+		$oSet->OptimizeColumnLoad(array($oSet->GetClassAlias() => array())); // No need to load all the columns just to get the id
 		while($oObject = $oSet->Fetch())
 		{
 			$aKeys[] = $oObject->GetKey();	
@@ -330,8 +324,10 @@ class DisplayBlock
 	 * @throws DictExceptionMissingString
 	 * @throws MySQLException
 	 * @throws Exception
+	 *
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 add type hinting to $aExtraParams
 	 */
-	public function GetRenderContent(WebPage $oPage, $aExtraParams, $sId)
+	public function GetRenderContent(WebPage $oPage, array $aExtraParams, $sId)
 	{
 		$sHtml = '';
 		// Add the extra params into the filter if they make sense for such a filter
@@ -452,8 +448,21 @@ class DisplayBlock
 			$this->m_oSet = new CMDBObjectSet($this->m_oFilter, $aOrderBy, $aQueryParams);
 		}
 		$this->m_oSet->SetShowObsoleteData($this->m_bShowObsoleteData);
-		switch($this->m_sStyle)
-		{
+
+		switch($this->m_sStyle) {
+			case 'list_search':
+			case 'list':
+				break;
+			default:
+				// N°3473: except for 'list_search' and 'list' (which have more granularity, see the other switch below),
+				// refuse to render if the user is not allowed to see the class.
+				if (! UserRights::IsActionAllowed($this->m_oSet->GetClass(), UR_ACTION_READ, $this->m_oSet) == UR_ALLOWED_YES) {
+					$sHtml .= $oPage->GetP(Dict::Format('UI:Error:ReadNotAllowedOn_Class', $this->m_oSet->GetClass()));
+					return $sHtml;
+				}
+		}
+
+		switch ($this->m_sStyle) {
 			case 'count':
 			if (isset($aExtraParams['group_by']))
 			{
@@ -843,7 +852,8 @@ class DisplayBlock
 
 				foreach($aStates as $sStateValue)
 				{
-					$aStateLabels[$sStateValue] = htmlentities($oAttDef->GetValueLabel($sStateValue), ENT_QUOTES, 'UTF-8');
+					$sHtmlValue=$aGroupBy['group1']->MakeValueLabel($this->m_oFilter, $sStateValue, $sStateValue);
+					$aStateLabels[$sStateValue] = strip_tags($sHtmlValue);
 
 					$aCounts[$sStateValue] = (array_key_exists($sStateValue, $aCountsQueryResults))
 						? $aCountsQueryResults[$sStateValue]
@@ -952,7 +962,7 @@ class DisplayBlock
 			$iChartCounter++;
 	
 			$sChartType = isset($aExtraParams['chart_type']) ? $aExtraParams['chart_type'] : 'pie';
-			$sTitle = isset($aExtraParams['chart_title']) ? '<h1 style="text-align:center">'.htmlentities(Dict::S($aExtraParams['chart_title']), ENT_QUOTES, 'UTF-8').'</h1>' : '';
+			$sTitle = isset($aExtraParams['chart_title']) ? '<div class="main_header"><h1>&#160;'.htmlentities(Dict::S($aExtraParams['chart_title']), ENT_QUOTES, 'UTF-8').'</h1></div>' : '';
 			$sHtml = "$sTitle<div style=\"height:200px;width:100%\" class=\"dashboard_chart\" id=\"my_chart_$sId{$iChartCounter}\"><div style=\"height:200px;line-height:200px;vertical-align:center;text-align:center;width:100%\"><img src=\"../images/indicator.gif\"></div></div>\n";
 			$sGroupBy = isset($aExtraParams['group_by']) ? $aExtraParams['group_by'] : '';
 			$sGroupByExpr = isset($aExtraParams['group_by_expr']) ? '&params[group_by_expr]='.$aExtraParams['group_by_expr'] : '';
@@ -999,6 +1009,7 @@ EOF
 				$iTotalCount = 0;
 				$aValues = array();
 				$aURLs = array();
+				
 				foreach ($aRes as $iRow => $aRow)
 				{
 					$sValue = $aRow['grouped_by_1'];
@@ -1006,7 +1017,8 @@ EOF
 					$aGroupBy[(int)$iRow] = (int) $aRow[$sFctVar];
 					$iTotalCount += $aRow['_itop_count_'];
 					$aValues[] = array('label' => html_entity_decode(strip_tags($sHtmlValue), ENT_QUOTES, 'UTF-8'), 'label_html' => $sHtmlValue, 'value' => (int) $aRow[$sFctVar]);
-					
+
+
 					// Build the search for this subset
 					$oSubsetSearch = $this->m_oFilter->DeepClone();
 					$oCondition = new BinaryExpression($oGroupByExp, '=', new ScalarExpression($sValue));
@@ -1020,16 +1032,23 @@ EOF
 			{
 				case 'bars':
 				$aNames = array();
+				$iMaxNbCharsInLabel = 0;
 				foreach($aValues as $idx => $aValue)
 				{
 					$aNames[$idx] = $aValue['label'];
+					if ($iMaxNbCharsInLabel < mb_strlen($aValue['label'])) {
+						$iMaxNbCharsInLabel = mb_strlen($aValue['label']);
+					}
 				}
 				$sJSNames = json_encode($aNames);
 				
 				$sJson = json_encode($aValues);
 				$oPage->add_ready_script(
 <<<EOF
-
+var iChartDefaultHeight = 200,
+      iChartLegendHeight = 6 * $iMaxNbCharsInLabel,
+      iChartTotalHeight = iChartDefaultHeight + iChartLegendHeight;
+$('#my_chart_$sId').height(iChartTotalHeight+ 'px');
 var chart = c3.generate({
     bindto: d3.select('#my_chart_$sId'),
     data: {
@@ -1097,8 +1116,19 @@ EOF
 				}
 				$sJSColumns = json_encode($aColumns);
 				$sJSNames = json_encode($aNames);
+				$iNbLinesToAddForName = 0;
+				if (count($aNames) > 50) {
+					// Calculation of the number of legends line add to the height of the graph to have a maximum of 5 legend columns
+					$iNbLinesIncludedInChartHeight = 10;
+					$iNbLinesToAddForName = ceil(count($aNames) / 5) - $iNbLinesIncludedInChartHeight;
+				}
 				$oPage->add_ready_script(
 <<<EOF
+// Calculate height of graph : 200px (minimum height for the chart) + 20*iNbLinesToAddForName for the legend
+var iChartDefaultHeight = 200,
+      iChartLegendHeight = 20 * $iNbLinesToAddForName,
+      iChartTotalHeight = (iChartDefaultHeight + iChartLegendHeight);
+$('#my_chart_$sId').height(iChartTotalHeight + 'px');
 var chart = c3.generate({
     bindto: d3.select('#my_chart_$sId'),
     data: {
@@ -1410,8 +1440,25 @@ class HistoryBlock extends DisplayBlock
 		$this->iLimitStart = $iStart;
 		$this->iLimitCount = $iCount;
 	}
-	
-	public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
+
+	/**
+	 * @param \WebPage $oPage
+	 * @param array $aExtraParams
+	 * @param string $sId
+	 *
+	 * @return string
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \DictExceptionMissingString
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 *
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 Remove default value for $aExtraParams and add type hinting for PHP 8.0 compatibility
+	 *      (var is unused, and all calls were already made using a default value)
+	 */
+	public function GetRenderContent(WebPage $oPage, array $aExtraParams, $sId)
 	{
 		$sHtml = '';
 		$bTruncated = false;
@@ -1550,8 +1597,10 @@ class MenuBlock extends DisplayBlock
 	 * @throws \Exception
 	 * @throws \MissingQueryArgument
 	 * @throws \MySQLException
+	 *
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 Remove default value and add type hinting on $aExtraParams for PHP 8.0 compatibility
 	 */
-	public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
+	public function GetRenderContent(WebPage $oPage, array $aExtraParams, $sId)
 	{
 		if ($this->m_sStyle == 'popup') // popup is a synonym of 'list' for backward compatibility
 		{
@@ -1886,11 +1935,13 @@ class MenuBlock extends DisplayBlock
 		{
 			if (count($aFavoriteActions) > 0)
 			{
-				$sHtml .= "<div class=\"itop_popup actions_menu\"><ul>\n<li>".Dict::S('UI:Menu:OtherActions')."\n<ul>\n";
+				$sActionsMenuLabel = Dict::S('UI:Menu:OtherActions');
+				$sHtml .= "<div class=\"itop_popup actions_menu\"><ul>\n<li aria-label=\"{$sActionsMenuLabel}\">{$sActionsMenuLabel}<i class=\"fas fa-caret-down\"></i>"."\n<ul>\n";
 			}
 			else
 			{
-				$sHtml .= "<div class=\"itop_popup actions_menu\"><ul>\n<li>".Dict::S('UI:Menu:Actions')."\n<ul>\n";
+				$sActionsMenuLabel = Dict::S('UI:Menu:Actions');
+				$sHtml .= "<div class=\"itop_popup actions_menu\"><ul>\n<li aria-label=\"{$sActionsMenuLabel}\">{$sActionsMenuLabel}<i class=\"fas fa-caret-down\"></i>"."\n<ul>\n";
 			}
 
 			$sHtml .= $oPage->RenderPopupMenuItems($aActions, $aFavoriteActions);

application/errorpage.class.inc.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * @copyright   Copyright (C) 2010-2020 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+
+class ErrorPage extends NiceWebPage
+{
+	public function __construct($sTitle)
+	{
+		parent::__construct($sTitle);
+		$this->add_linked_script("../js/jquery.blockUI.js");
+		$this->add_linked_script("../setup/setup.js");
+		$this->add_saas("css/setup.scss");
+	}
+
+	public function info($sText)
+	{
+		$this->add("<p class=\"info\">$sText</p>\n");
+		$this->log_info($sText);
+	}
+
+	public function ok($sText)
+	{
+		$this->add("<div class=\"message message-valid\"><span class=\"message-title\">Success:</span>$sText</div>");
+		$this->log_ok($sText);
+	}
+
+	public function warning($sText)
+	{
+		$this->add("<div class=\"message message-warning\"><span class=\"message-title\">Warning:</span>$sText</div>");
+		$this->log_warning($sText);
+	}
+
+	public function error($sText)
+	{
+		$this->add("<div class=\"message message-error\">$sText</div>");
+		$this->log_error($sText);
+	}
+
+	public function output()
+	{
+		$sLogo = utils::GetAbsoluteUrlAppRoot().'/images/itop-logo.png';
+		$sTimeStamp = utils::GetCacheBusterTimestamp();
+		$sTitle = utils::HtmlEntities($this->s_title);
+		$this->s_content = <<<HTML
+<div id="header" class="error_page">
+	<h1><a href="http://www.combodo.com/itop" target="_blank"><img title="iTop by Combodo" alt=" " src="{$sLogo}?t={$sTimeStamp}"></a>&nbsp;{$sTitle}</h1>
+</div>
+<div id="setup" class="error_page">
+	{$this->s_content}
+</div>
+HTML;
+		return parent::output();
+	}
+
+	public static function log_error($sText)
+	{
+		IssueLog::Error($sText);
+	}
+
+	public static function log_warning($sText)
+	{
+		IssueLog::Warning($sText);
+	}
+
+	public static function log_info($sText)
+	{
+		IssueLog::Info($sText);
+	}
+
+	public static function log_ok($sText)
+	{
+		IssueLog::Ok($sText);
+	}
+
+	public static function log($sText)
+	{
+		IssueLog::Ok($sText);
+	}
+}

application/forms.class.inc.php

@@ -395,6 +395,7 @@ EOF
 		{
 			foreach($aFields as $oField)
 			{
+				/** @var \DesignerFormField $oField */
 				$oField->ReadParam($aValues);
 			}
 		}
@@ -679,18 +680,34 @@ class DesignerTabularForm extends DesignerForm
 
 class DesignerFormField
 {
+	/** @var string $sLabel */
 	protected $sLabel;
+	/** @var string $sCode */
 	protected $sCode;
+	/** @var mixed $defaultValue */
 	protected $defaultValue;
 	/** @var \DesignerForm $oForm */
 	protected $oForm;
+	/** @var bool $bMandatory */
 	protected $bMandatory;
+	/** @var bool $bReadOnly */
 	protected $bReadOnly;
+	/** @var bool $bAutoApply */
 	protected $bAutoApply;
+	/** @var array $aCSSClasses */
 	protected $aCSSClasses;
+	/** @var bool $bDisplayed */
 	protected $bDisplayed;
+	/** @var array $aWidgetExtraParams */
 	protected $aWidgetExtraParams;
-	
+
+	/**
+	 * DesignerFormField constructor.
+	 *
+	 * @param string $sCode
+	 * @param string $sLabel
+	 * @param mixed $defaultValue
+	 */
 	public function __construct($sCode, $sLabel, $defaultValue)
 	{
 		$this->sLabel = $sLabel;
@@ -703,7 +720,10 @@ class DesignerFormField
 		$this->bDisplayed = true;
 		$this->aWidgetExtraParams = array();
 	}
-	
+
+	/**
+	 * @return string
+	 */
 	public function GetCode()
 	{
 		return $this->sCode;
@@ -712,69 +732,108 @@ class DesignerFormField
     /**
      * @param \DesignerForm $oForm
      */
-	public function SetForm(\DesignerForm $oForm)
+	public function SetForm(DesignerForm $oForm)
 	{
 		$this->oForm = $oForm;
 	}
-	
 
+	/**
+	 * @param bool $bMandatory
+	 */
 	public function SetMandatory($bMandatory = true)
 	{
 		$this->bMandatory = $bMandatory;
 	}
 
+	/**
+	 * @param bool $bReadOnly
+	 */
 	public function SetReadOnly($bReadOnly = true)
 	{
 		$this->bReadOnly = $bReadOnly;
 	}
-	
+
+	/**
+	 * @return bool
+	 */
 	public function IsReadOnly()
 	{
 		return ($this->oForm->IsReadOnly() || $this->bReadOnly);
 	}
 
+	/**
+	 * @param bool $bAutoApply
+	 */
 	public function SetAutoApply($bAutoApply)
 	{
 		$this->bAutoApply = $bAutoApply;
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function IsAutoApply()
 	{
 		return $this->bAutoApply;
 	}
 
+	/**
+	 * @param bool $bDisplayed
+	 */
 	public function SetDisplayed($bDisplayed)
 	{
 		$this->bDisplayed = $bDisplayed;
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function IsDisplayed()
 	{
 		return $this->bDisplayed;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function GetFieldId()
 	{
 		return $this->oForm->GetFieldId($this->sCode);
 	}
-	
+
+	/**
+	 * @return string
+	 */
 	public function GetWidgetClass()
 	{
 		return 'property_field';
 	}
-	
+
+	/**
+	 * @return array
+	 */
 	public function GetWidgetExtraParams()
 	{
 		return $this->aWidgetExtraParams;
 	}
-	
+
+	/**
+	 * @param \WebPage $oP
+	 * @param string $sFormId
+	 * @param string $sRenderMode
+	 *
+	 * @return array
+	 */
 	public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog')
 	{
 		$sId = $this->oForm->GetFieldId($this->sCode);
 		$sName = $this->oForm->GetFieldName($this->sCode);
 		return array('label' => $this->sLabel, 'value' => "<input type=\"text\" id=\"$sId\" name=\"$sName\" value=\"".htmlentities($this->defaultValue, ENT_QUOTES, 'UTF-8')."\">");
 	}
-	
+
+	/**
+	 * @param array $aValues
+	 */
 	public function ReadParam(&$aValues)
 	{
 		if ($this->IsReadOnly())
@@ -801,12 +860,18 @@ class DesignerFormField
 			}
 		}
 	}
-	
+
+	/**
+	 * @return bool
+	 */
 	public function IsVisible()
 	{
 		return true;
 	}
-	
+
+	/**
+	 * @param string $sCSSClass
+	 */
 	public function AddCSSClass($sCSSClass)
 	{
 		$this->aCSSClasses[] = $sCSSClass;
@@ -814,6 +879,8 @@ class DesignerFormField
 	
 	/**
 	 * A way to set/change the default value after constructing the field
+	 *
+	 * @param array $aAllDefaultValue
 	 */
 	public function SetDefaultValueFrom($aAllDefaultValue)
 	{
@@ -822,7 +889,12 @@ class DesignerFormField
 			$this->defaultValue = $aAllDefaultValue[$this->GetCode()];
 		}
 	}
-	
+
+	/**
+	 * @param $sFieldCode
+	 *
+	 * @return \DesignerFormField|false
+	 */
 	public function FindField($sFieldCode)
 	{
 		if ($this->sCode == $sFieldCode)
@@ -832,11 +904,17 @@ class DesignerFormField
 		return false;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function GetHandlerEquals()
 	{
 		return 'null';
 	}
 
+	/**
+	 * @return string
+	 */
 	public function GetHandlerGetValue()
 	{
 		return 'null';
@@ -845,25 +923,43 @@ class DesignerFormField
 
 class DesignerLabelField extends DesignerFormField
 {
+	/** @var int $iCount A counter to automatically make the field code */
+	protected static $iCount = 0;
+	/** @var string $sDescription */
 	protected $sDescription;
-	
+
+	/**
+	 * @inheritdoc
+	 */
 	public function __construct($sLabel, $sDescription)
 	{
-		parent::__construct('', $sLabel, '');
+		// Increase counter
+		static::$iCount++;
+
+		parent::__construct('label_number_' . static::$iCount, $sLabel, '');
 		$this->sDescription = $sDescription;
 	}
-	
+
+	/**
+	 * @inheritdoc
+	 */
 	public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog')
 	{
 		$sId = $this->oForm->GetFieldId($this->sCode);
 		$sName = $this->oForm->GetFieldName($this->sCode);
 		return array('label' => $this->sLabel, 'value' => $this->sDescription);
 	}
-	
+
+	/**
+	 * @inheritdoc
+	 */
 	public function ReadParam(&$aValues)
 	{
 	}
-	
+
+	/**
+	 * @inheritdoc
+	 */
 	public function IsVisible()
 	{
 		return true;
@@ -1127,7 +1223,7 @@ class DesignerComboField extends DesignerFormField
 		$sChecked = $this->defaultValue ? 'checked' : '';
 		$sMandatory = $this->bMandatory ? 'true' :  'false';
 		$sReadOnly = $this->IsReadOnly() ? 'disabled="disabled"' :  '';
-		if ($this->IsSorted())
+		if ($this->IsSorted() )
 		{
 			asort($this->aAllowedValues);
 		}
@@ -1175,18 +1271,14 @@ class DesignerComboField extends DesignerFormField
 					$sHtml .= "<option value=\"\">".$this->sNullLabel."</option>";
 				}
 			}
-			foreach($this->aAllowedValues as $sKey => $sDisplayValue)
-			{
-				if ($this->bMultipleSelection)
-				{
+			foreach ($this->aAllowedValues as $sKey => $sDisplayValue) {
+				if ($this->bMultipleSelection) {
 					$sSelected = in_array($sKey, $this->defaultValue) ? 'selected' : '';
-				}
-				else
-				{
+				} else {
 					$sSelected = ($sKey == $this->defaultValue) ? 'selected' : '';
 				}
 				// Quick and dirty: display the menu parents as a tree
-				$sHtmlValue = str_replace(' ', '&nbsp;', htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8'));
+				$sHtmlValue = str_replace(' ', '&nbsp;', $sDisplayValue);
 				$sHtml .= "<option value=\"".htmlentities($sKey, ENT_QUOTES, 'UTF-8')."\" $sSelected>$sHtmlValue</option>";
 			}
 			$sHtml .= "</select>";
@@ -1334,7 +1426,8 @@ class DesignerIconSelectionField extends DesignerFormField
 		$sPostUploadTo = ($this->sUploadUrl == null) ? 'null' : "'{$this->sUploadUrl}'";
 		if (!$this->IsReadOnly())
 		{
-			$sValue = "<input type=\"hidden\" id=\"$sId\" name=\"$sName\" value=\"{$this->defaultValue}\"/>";
+			$sDefaultValue = ($this->defaultValue !== '') ? $this->defaultValue : $this->aAllowedValues[$idx]['value'];
+			$sValue = "<input type=\"hidden\" id=\"$sId\" name=\"$sName\" value=\"{$sDefaultValue}\"/>";
 			$oP->add_ready_script(
 <<<EOF
 	$('#$sId').icon_select({current_idx: $idx, items: $sJSItems, post_upload_to: $sPostUploadTo});
@@ -1396,6 +1489,7 @@ class RunTimeIconSelectionField extends DesignerIconSelectionField
 			$sAvailableIcons .= '   static $sKey = '.var_export($sKey, true).';'.PHP_EOL;
 			$sAvailableIcons .= '   static $aIconFiles = '.var_export($aFiles, true).';'.PHP_EOL;
 			$sAvailableIcons .= '}'.PHP_EOL;
+			SetupUtils::builddir(dirname($sCacheFile));
 			file_put_contents($sCacheFile, $sAvailableIcons, LOCK_EX);
 		}
 		return $aFiles;

application/itopwebpage.class.inc.php

@@ -1,27 +1,20 @@
 <?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 iTopWebPage
+ * Copyright (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2018 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 require_once(APPROOT."/application/nicewebpage.class.inc.php");
@@ -46,11 +39,19 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
 	protected $sBreadCrumbEntryIcon;
 	protected $oCtx;
 
+	/**
+	 * iTopWebPage constructor.
+	 *
+	 * @param string $sTitle
+	 * @param bool $bPrintable
+	 *
+	 * @throws \Exception
+	 */
 	public function __construct($sTitle, $bPrintable = false)
 	{
 		parent::__construct($sTitle, $bPrintable);
 		$this->m_oTabs = new TabManager();
-		$this->oCtx = new ContextTag('GUI:Console');
+		$this->oCtx = new ContextTag(ContextTag::TAG_CONSOLE);
 
 		ApplicationContext::SetUrlMakerClass('iTopStandardURLMaker');
 
@@ -59,8 +60,7 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
 			// Create a breadcrumb entry for the current page, but get its title as late as possible (page title could be changed later)
 			$this->bBreadCrumbEnabled = true;
 		}
-		else
-		{
+		else {
 			$this->bBreadCrumbEnabled = false;
 		}
 
@@ -70,7 +70,8 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
 		$this->m_aMessages = array();
 		$this->SetRootUrl(utils::GetAbsoluteUrlAppRoot());
 		$this->add_header("Content-type: text/html; charset=".self::PAGES_CHARSET);
-		$this->add_header("Cache-control: no-cache");
+		$this->no_cache();
+		$this->add_http_headers();
 		$this->add_linked_stylesheet("../css/jquery.treeview.css");
 		$this->add_linked_stylesheet("../css/jquery.autocomplete.css");
 		$this->add_linked_stylesheet("../css/jquery-ui-timepicker-addon.css");
@@ -79,6 +80,7 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
 		$this->add_linked_stylesheet("../css/c3.min.css");
 		$this->add_linked_stylesheet("../css/font-awesome/css/all.min.css");
 		$this->add_linked_stylesheet("../css/font-awesome/css/v4-shims.min.css");
+		$this->add_linked_stylesheet("../js/ckeditor/plugins/codesnippet/lib/highlight/styles/obsidian.css");
 
 		$this->add_linked_script('../js/jquery.layout.min.js');
 		$this->add_linked_script('../js/jquery.ba-bbq.min.js');
@@ -92,6 +94,7 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
 		$this->add_linked_script("../js/swfobject.js");
 		$this->add_linked_script("../js/ckeditor/ckeditor.js");
 		$this->add_linked_script("../js/ckeditor/adapters/jquery.js");
+		$this->add_linked_script("../js/ckeditor/plugins/codesnippet/lib/highlight/highlight.pack.js");
 		$this->add_linked_script("../js/jquery.qtip-1.0.min.js");
 		$this->add_linked_script('../js/property_field.js');
 		$this->add_linked_script('../js/icon_select.js');
@@ -150,6 +153,9 @@ EOF
 		}
 	}
 
+	/**
+	 * @return bool
+	 */
 	protected function IsMenuPaneVisible()
 	{
 		$bLeftPaneOpen = true;
@@ -172,6 +178,9 @@ EOF
 		return $bLeftPaneOpen;
 	}
 
+	/**
+	 *
+	 */
 	protected function PrepareLayout()
 	{
 		if (MetaModel::GetConfig()->Get('demo_mode'))
@@ -343,6 +352,21 @@ JS
 		.magnificPopup({type: 'image', closeOnContentClick: true });
 JS
 		);
+		
+		// Highlight code content created with CKEditor
+		// Note: We check for the <code> tag inside the <pre> tag to only target code from CKEditor, otherwise we might highlight some others things. See N°3810
+		$this->add_ready_script(
+			<<<JS
+		// Highlight code content for HTML AttributeText
+        $("[data-attribute-type='AttributeText'] .HTML pre > code").parent().each(function(i, block) {
+            hljs.highlightBlock(block);
+        });        
+		// Highlight code content for CaseLogs
+		$("[data-attribute-type='AttributeCaseLog'] .caselog_entry_html pre > code").parent().each(function(i, block) {
+            hljs.highlightBlock(block);
+        });
+JS
+		);
 
 		$this->add_init_script(
 			<<< JS
@@ -600,7 +624,7 @@ JS
 	ShowDebug();
 	$('#logOffBtn>ul').popupmenu();
 	
-	$('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry,.caselog_entry_html').toggle(); });
+	$('body').on('click', '.caselog_header', function () { $(this).toggleClass('open').next('.caselog_entry,.caselog_entry_html').toggle(); });
 	
 	$(document).ajaxSend(function(event, jqxhr, options) {
 		jqxhr.setRequestHeader('X-Combodo-Ajax', 'true');
@@ -736,11 +760,22 @@ JS
 		$this->sBreadCrumbEntryIcon = null;
 	}
 
+	/**
+	 * @param string $sHtml
+	 */
 	public function AddToMenu($sHtml)
 	{
 		$this->m_sMenu .= $sHtml;
 	}
 
+	/**
+	 * @return string
+	 * @throws \CoreException
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \OQLException
+	 */
 	public function GetSiloSelectionForm()
 	{
 		// List of visible Organizations
@@ -801,6 +836,9 @@ JS
 		return $sHtml;
 	}
 
+	/**
+	 * @throws \DictExceptionMissingString
+	 */
 	public function DisplayMenu()
 	{
 		// Display the menu
@@ -816,6 +854,8 @@ JS
 	protected function InitNewsroom()
 	{
 		$sNewsroomInitialImage = '';
+		$aProviderParams = array();
+
 		if (MetaModel::GetConfig()->Get('newsroom_enabled') !== false)
 	 	{
 			$oUser = UserRights::GetUserObject();
@@ -823,30 +863,31 @@ JS
 			 * @var iNewsroomProvider[] $aProviders
 			 */
 			$aProviders = MetaModel::EnumPlugins('iNewsroomProvider');
-			$aProviderParams = array();
 			foreach($aProviders as $oProvider)
 			{
 				$oProvider->SetConfig(MetaModel::GetConfig());
-				$bProviderEnabled = appUserPreferences::GetPref('newsroom_provider_'.get_class($oProvider), true);
-			if ($bProviderEnabled && $oProvider->IsApplicable($oUser))
-			{
-				$aProviderParams[] = array(
-					'label' => $oProvider->GetLabel(),
-					'fetch_url' => $oProvider->GetFetchURL(),
-					'view_all_url' => $oProvider->GetViewAllURL(),
-					'mark_all_as_read_url' => $oProvider->GetMarkAllAsReadURL(),
-					'placeholders' => $oProvider->GetPlaceholders(),
-					'ttl' => $oProvider->GetTTL(),
-				);
+				$bProviderEnabled = appUserPreferences::GetPref('newsroom_provider_'.get_class($oProvider),true);
+				if ($bProviderEnabled && $oProvider->IsApplicable($oUser))
+				{
+					$aProviderParams[] = array(
+						'label' => $oProvider->GetLabel(),
+						'fetch_url' => $oProvider->GetFetchURL(),
+						'view_all_url' => $oProvider->GetViewAllURL(),
+						'mark_all_as_read_url' => $oProvider->GetMarkAllAsReadURL(),
+						'placeholders' => $oProvider->GetPlaceholders(),
+						'ttl' => $oProvider->GetTTL(),
+					);
+				}
 			}
 		}
+		// Show newsroom only if there are some providers
 		if (count($aProviderParams) > 0)
 		{
-			$sImageUrl= '../images/newsroom_menu.png';
-			$sPlaceholderImageUrl= '../images/newsroom-message.svg';
+			$sImageUrl= 'fas fa-comment-dots';
+			$sPlaceholderImageUrl= 'far fa-envelope';
 			$aParams = array(
-				'image_url' => $sImageUrl,
-				'placeholder_image_url' => $sPlaceholderImageUrl,
+				'image_icon' => $sImageUrl,
+				'placeholder_image_icon' => $sPlaceholderImageUrl,
 				'cache_uuid' => 'itop-newsroom-'.UserRights::GetUserId().'-'.md5(APPROOT),
 				'providers' => $aProviderParams,
 				'display_limit' => (int)appUserPreferences::GetPref('newsroom_display_size', 7),
@@ -862,20 +903,16 @@ JS
 	$('#top-left-newsroom-cell').newsroom_menu($sParams);
 EOF
 			);
-			$sNewsroomInitialImage = '<img style="opacity:0.4" src="../images/newsroom_menu.png">';
+			$sNewsroomInitialImage = '<i style="opacity:0.4" class="top-right-icon fas fa-comment-dots"></i>';
 		}
-		else
-		{
-			// No newsroom menu at all
-		}
-	}
-	// else no newsroom menu
-	return $sNewsroomInitialImage;
+		// else no newsroom menu
+		return $sNewsroomInitialImage;
 	}
 
 
 	/**
-	 * Outputs (via some echo) the complete HTML page by assembling all its elements
+	 * @inheritDoc
+	 * @throws \Exception
 	 */
 	public function output()
 	{
@@ -1109,7 +1146,7 @@ EOF
 		{
 			$sBodyClass = 'printable-version';
 		}
-		$sHtml .= "<body class=\"$sBodyClass\">\n";
+		$sHtml .= "<body class=\"$sBodyClass\" data-gui-type=\"backoffice\">\n";
 		if ($this->IsPrintableVersion())
 		{
 			$sHtml .= "<div class=\"explain-printable not-printable\">";
@@ -1146,7 +1183,7 @@ EOF;
 		}
 
 		// Render the revision number
-		if (ITOP_REVISION == '$WCREV$')
+		if (ITOP_REVISION == 'svn')
 		{
 			// This is NOT a version built using the buil system, just display the main version
 			$sVersionString = Dict::Format('UI:iTopVersion:Short', ITOP_APPLICATION, ITOP_VERSION);
@@ -1182,7 +1219,7 @@ EOF;
 			{
 				$sLogonMessage = Dict::Format('UI:LoggedAsMessage', $sUserName);
 			}
-			$sLogOffMenu = "<span id=\"logOffBtn\"><ul><li><img src=\"../images/on-off-menu.png\"><ul>";
+			$sLogOffMenu = "<span id=\"logOffBtn\"><ul><li aria-label=\"" . Dict::S("UI:PowerMenu") . "\"><i class=\"top-right-icon icon-additional-arrow fas fa-power-off\"></i><ul>";
 			$sLogOffMenu .= "<li><span>$sLogonMessage</span></li>\n";
 			$aActions = array();
 
@@ -1344,10 +1381,10 @@ EOF;
 			$sHtml .= ' <table id="top-bar-table">';
 			$sHtml .= ' <tr>';
 			$sHtml .= ' <td id="open-left-pane"  class="menu-pane-exclusive" style="'.$GoHomeInitialStyle.'" onclick="$(\'body\').layout().open(\'west\');">';
-			$sHtml .= ' <img src="../images/menu.png">';
+			$sHtml .= ' <i class="fas fa-bars"></i>';
 			$sHtml .= ' </td>';
 			$sHtml .= ' <td id="go-home" class="menu-pane-exclusive" style="'.$GoHomeInitialStyle.'">';
-			$sHtml .= ' <a href="'.utils::GetAbsoluteUrlAppRoot().'pages/UI.php"><img src="../images/home.png"></a>';
+			$sHtml .= ' <a href="'.utils::GetAbsoluteUrlAppRoot().'pages/UI.php"><i class="fas fa-home"></i></a>';
 			$sHtml .= ' </td>';
 			$sHtml .= ' <td class="top-bar-spacer menu-pane-exclusive" style="'.$GoHomeInitialStyle.'">';
 			$sHtml .= ' </td>';
@@ -1357,8 +1394,8 @@ EOF;
 			$sHtml .= ' <td id="top-bar-table-search">';
 			$sHtml .= '		<div id="global-search"><form action="'.utils::GetAbsoluteUrlAppRoot().'pages/UI.php">';
 			$sHtml .= '		<table id="top-left-buttons-area"><tr>';
-			$sHtml .= '			<td id="top-left-global-search-cell"><div id="global-search-area"><input id="global-search-input" type="text" name="text" placeholder="'.$sDefaultPlaceHolder.'" value="'.$sText.'"></input><div '.$sOnClick.' id="global-search-image"><input type="hidden" name="operation" value="full_text"/></div></div></td>';
-			$sHtml .= '     	<td id="top-left-help-cell"><a id="help-link" href="'.$sOnlineHelpUrl.'" target="_blank"><img title="'.Dict::S('UI:Help').'" src="../images/help.png?t='.utils::GetCacheBusterTimestamp().'"/></td>';
+			$sHtml .= '			<td id="top-left-global-search-cell"><div id="global-search-area"><input id="global-search-input" type="text" name="text" placeholder="'.$sDefaultPlaceHolder.'" value="'.$sText.'"></input><div '.$sOnClick.' id="global-search-image"><i class="top-right-icon fa-flip-horizontal fas fa-search"></i><input type="hidden" name="operation" value="full_text"/></div></div></td>';
+			$sHtml .= '     	<td id="top-left-help-cell"><a id="help-link" href="'.$sOnlineHelpUrl.'" target="_blank" title="'.Dict::S('UI:Help').'"><i class="top-right-icon fas fa-question-circle"></i></a></td>';
 			$sHtml .= '		<td id="top-left-newsroom-cell">'.$sNewsRoomInitialImage.'</td>';
 			$sHtml .= '     	<td id="top-left-logoff-cell">'.self::FilterXSS($sLogOffMenu).'</td>';
 			$sHtml .= '     </tr></table></form></div>';
@@ -1413,9 +1450,12 @@ EOF;
 		{
 			if ($this->GetOutputFormat() == 'pdf' && $this->IsOutputFormatAvailable('pdf'))
 			{
+				// Note: Apparently this was a demand from ITOMIG a while back, so it's not "dead code" per say.
+				// The last trace we got is in R-007989. Do not remove this without checking before with the concerned parties if it is still used!
 				if (@is_readable(APPROOT.'lib/MPDF/mpdf.php'))
 				{
 					require_once(APPROOT.'lib/MPDF/mpdf.php');
+					/** @noinspection PhpUndefinedClassInspection Check above comment */
 					$oMPDF = new mPDF('c');
 					$oMPDF->mirroMargins = false;
 					if ($this->a_base['href'] != '')
@@ -1442,59 +1482,68 @@ EOF;
 		ExecutionKPI::ReportStats();
 	}
 
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
 	public function AddTabContainer($sTabContainer, $sPrefix = '')
 	{
 		$this->add($this->m_oTabs->AddTabContainer($sTabContainer, $sPrefix));
 	}
 
-	public function AddToTab($sTabContainer, $sTabLabel, $sHtml)
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
+	public function AddToTab($sTabContainer, $sTabCode, $sHtml)
 	{
-		$this->add($this->m_oTabs->AddToTab($sTabContainer, $sTabLabel, $sHtml));
+		$this->add($this->m_oTabs->AddToTab($sTabContainer, $sTabCode, $sHtml));
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	public function SetCurrentTabContainer($sTabContainer = '')
 	{
 		return $this->m_oTabs->SetCurrentTabContainer($sTabContainer);
 	}
 
-	public function SetCurrentTab($sTabLabel = '')
+	/**
+	 * @inheritDoc
+	 */
+	public function SetCurrentTab($sTabCode = '', $sTabTitle = null)
 	{
-		return $this->m_oTabs->SetCurrentTab($sTabLabel);
+		return $this->m_oTabs->SetCurrentTab($sTabCode, $sTabTitle);
 	}
 
 	/**
-	 * 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.
-	 *
+	 * @inheritDoc
+	 * @throws \Exception
 	 * @since 2.0.3
 	 */
-	public function AddAjaxTab($sTabLabel, $sUrl, $bCache = true)
+	public function AddAjaxTab($sTabCode, $sUrl, $bCache = true, $sTabTitle = null)
 	{
-		$this->add($this->m_oTabs->AddAjaxTab($sTabLabel, $sUrl, $bCache));
+		$this->add($this->m_oTabs->AddAjaxTab($sTabCode, $sUrl, $bCache, $sTabTitle));
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	public function GetCurrentTab()
 	{
 		return $this->m_oTabs->GetCurrentTab();
 	}
 
-	public function RemoveTab($sTabLabel, $sTabContainer = null)
+	/**
+	 * @inheritDoc
+	 */
+	public function RemoveTab($sTabCode, $sTabContainer = null)
 	{
-		$this->m_oTabs->RemoveTab($sTabLabel, $sTabContainer);
+		$this->m_oTabs->RemoveTab($sTabCode, $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
+	 * @inheritDoc
 	 */
 	public function FindTab($sPattern, $sTabContainer = null)
 	{
@@ -1506,12 +1555,19 @@ EOF;
 	 * 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...
+	 *
+	 * @param string $sTabContainer
+	 * @param string $sTabCode
 	 */
-	public function SelectTab($sTabContainer, $sTabLabel)
+	public function SelectTab($sTabContainer, $sTabCode)
 	{
-		$this->add_ready_script($this->m_oTabs->SelectTab($sTabContainer, $sTabLabel));
+		$this->add_ready_script($this->m_oTabs->SelectTab($sTabContainer, $sTabCode));
 	}
 
+	/**
+	 * @inheritDoc
+	 * @throws \Exception
+	 */
 	public function add($sHtml)
 	{
 		if (($this->m_oTabs->GetCurrentTabContainer() != '') && ($this->m_oTabs->GetCurrentTab() != ''))
@@ -1525,9 +1581,7 @@ EOF;
 	}
 
 	/**
-	 * Records the current state of the 'html' part of the page output
-	 *
-	 * @return mixed The current state of the 'html' output
+	 * @inheritDoc
 	 */
 	public function start_capture()
 	{
@@ -1547,12 +1601,7 @@ EOF;
 	}
 
 	/**
-	 * 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
+	 * @inheritDoc
 	 */
 	public function end_capture($offset)
 	{
@@ -1577,6 +1626,8 @@ EOF;
 
 	/**
 	 * Set the message to be displayed in the 'app-banner' section at the top of the page
+	 *
+	 * @param string $sHtmlMessage
 	 */
 	public function SetMessage($sHtmlMessage)
 	{
@@ -1586,6 +1637,10 @@ EOF;
 
 	/**
 	 * Add message to be displayed in the 'app-banner' section at the top of the page
+	 *
+	 * @param string $sHtmlMessage
+	 * @param string|null $sHtmlIcon
+	 * @param string|null $sTip
 	 */
 	public function AddApplicationMessage($sHtmlMessage, $sHtmlIcon = null, $sTip = null)
 	{
@@ -1606,7 +1661,8 @@ EOF;
 	 * @param string $sContent
 	 * @param string $sCssClasses CSS classes to add to the container
 	 *
-	 * @since 2.6
+	 * @throws \Exception
+	 * @since 2.6.0
 	 */
 	public function AddHeaderMessage($sContent, $sCssClasses = 'message_info')
 	{
@@ -1619,6 +1675,8 @@ EOF
 	/**
 	 * Adds a script to be executed when the DOM is ready (typical JQuery use), right before add_ready_script
 	 *
+	 * @param string $sScript
+	 *
 	 * @return void
 	 */
 	public function add_init_script($sScript)

application/loginbasic.class.inc.php

@@ -26,6 +26,10 @@ class LoginBasic extends AbstractLoginFSMExtension
 			{
 				$_SESSION['login_mode'] = 'basic';
 			}
+			elseif (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']))
+			{
+				$_SESSION['login_mode'] = 'basic';
+			}
 			elseif (isset($_SERVER['PHP_AUTH_USER']))
 			{
 				$_SESSION['login_mode'] = 'basic';
@@ -36,7 +40,7 @@ class LoginBasic extends AbstractLoginFSMExtension
 
 	protected function OnReadCredentials(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'basic')
+		if (!isset($_SESSION['login_mode']) || $_SESSION['login_mode'] == 'basic')
 		{
 			list($sAuthUser, $sAuthPwd) = $this->GetAuthUserAndPassword();
 			$_SESSION['login_temp_auth_user'] =  $sAuthUser;
@@ -47,7 +51,7 @@ class LoginBasic extends AbstractLoginFSMExtension
 
 	protected function OnCheckCredentials(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'basic')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'basic')
 		{
 			list($sAuthUser, $sAuthPwd) = $this->GetAuthUserAndPassword();
 			if (!UserRights::CheckCredentials($sAuthUser, $sAuthPwd, $_SESSION['login_mode'], 'internal'))
@@ -55,15 +59,17 @@ class LoginBasic extends AbstractLoginFSMExtension
 				$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
 				return LoginWebPage::LOGIN_FSM_ERROR;
 			}
+			// Save the checked user
+			$_SESSION['auth_user'] = $sAuthUser;
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
 	protected function OnCredentialsOK(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'basic')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'basic')
 		{
-			list($sAuthUser) = $this->GetAuthUserAndPassword();
+			$sAuthUser = $_SESSION['auth_user'];
 			LoginWebPage::OnLoginSuccess($sAuthUser, 'internal', $_SESSION['login_mode']);
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -71,8 +77,13 @@ class LoginBasic extends AbstractLoginFSMExtension
 
 	protected function OnError(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'basic')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'basic')
 		{
+            $iOnExit = LoginWebPage::getIOnExit();
+            if ($iOnExit === LoginWebPage::EXIT_RETURN)
+            {
+                return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM
+            }
 			LoginWebPage::HTTP401Error();
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -80,7 +91,7 @@ class LoginBasic extends AbstractLoginFSMExtension
 
 	protected function OnConnected(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'basic')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'basic')
 		{
 			$_SESSION['can_logoff'] = true;
 			return LoginWebPage::CheckLoggedUser($iErrorCode);
@@ -92,9 +103,19 @@ class LoginBasic extends AbstractLoginFSMExtension
 	{
 		$sAuthUser = '';
 		$sAuthPwd = null;
+		$sAuthorization = '';
 		if (isset($_SERVER['HTTP_AUTHORIZATION']) && !empty($_SERVER['HTTP_AUTHORIZATION']))
 		{
-			list($sAuthUser, $sAuthPwd) = explode(':', base64_decode(substr($_SERVER['HTTP_AUTHORIZATION'], 6)));
+			$sAuthorization = $_SERVER['HTTP_AUTHORIZATION'];
+		}
+		elseif (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && !empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']))
+		{
+			$sAuthorization = $_SERVER['REDIRECT_HTTP_AUTHORIZATION'];
+		}
+
+		if (!empty($sAuthorization))
+		{
+			list($sAuthUser, $sAuthPwd) = explode(':', base64_decode(substr($sAuthorization, 6)));
 		}
 		else
 		{
@@ -121,4 +142,4 @@ class LoginBasic extends AbstractLoginFSMExtension
 		}
 		return array($sAuthUser, $sAuthPwd);
 	}
-}
+}

application/logindefault.class.inc.php

@@ -77,7 +77,7 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
 	{
 		self::ResetLoginSession();
 		$iOnExit = LoginWebPage::getIOnExit();
-		if ($iOnExit == LoginWebPage::EXIT_RETURN)
+		if ($iOnExit === LoginWebPage::EXIT_RETURN)
 		{
 			return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM
 		}
@@ -93,6 +93,12 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
 	{
 		if (!isset($_SESSION['login_mode']))
 		{
+            // N°6358 - if EXIT_RETURN was asked, send an error
+            if (LoginWebPage::getIOnExit() === LoginWebPage::EXIT_RETURN) {
+                $iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
+                return LoginWebPage::LOGIN_FSM_ERROR;
+            }
+
 			// If no plugin validated the user, exit
 			self::ResetLoginSession();
 			exit();
@@ -111,6 +117,11 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
 	protected function OnConnected(&$iErrorCode)
 	{
 		unset($_SESSION['login_temp_auth_user']);
+		if (is_null(UserRights::GetUserObject())){
+			//N°7085 avoid infinite loop
+			IssueLog::Error("No user logged in. exit");
+			exit(-1);
+		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
@@ -126,4 +137,4 @@ class LoginDefaultAfter extends AbstractLoginFSMExtension implements iLogoutExte
 			}
 		}
 	}
-}
+}

application/loginexternal.class.inc.php

@@ -35,7 +35,7 @@ class LoginExternal extends AbstractLoginFSMExtension
 
 	protected function OnCheckCredentials(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'external')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'external')
 		{
 			$sAuthUser = $this->GetAuthUser();
 			if (!UserRights::CheckCredentials($sAuthUser, '', $_SESSION['login_mode'], 'external'))
@@ -43,15 +43,17 @@ class LoginExternal extends AbstractLoginFSMExtension
 				$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
 				return LoginWebPage::LOGIN_FSM_ERROR;
 			}
+			// Save the checked user
+			$_SESSION['auth_user'] = $sAuthUser;
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
 	protected function OnCredentialsOK(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'external')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'external')
 		{
-			$sAuthUser = $this->GetAuthUser();
+			$sAuthUser = $_SESSION['auth_user'];
 			LoginWebPage::OnLoginSuccess($sAuthUser, 'external', $_SESSION['login_mode']);
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -59,7 +61,7 @@ class LoginExternal extends AbstractLoginFSMExtension
 
 	protected function OnConnected(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'external')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'external')
 		{
 			$_SESSION['can_logoff'] = false;
 			return LoginWebPage::CheckLoggedUser($iErrorCode);
@@ -67,6 +69,20 @@ class LoginExternal extends AbstractLoginFSMExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	protected function OnError(&$iErrorCode)
+	{
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'external')
+		{
+            $iOnExit = LoginWebPage::getIOnExit();
+            if ($iOnExit === LoginWebPage::EXIT_RETURN)
+            {
+                return LoginWebPage::LOGIN_FSM_RETURN; // Error, exit FSM
+            }
+			LoginWebPage::HTTP401Error();
+		}
+		return LoginWebPage::LOGIN_FSM_CONTINUE;
+	}
+
 	/**
 	 * @return bool
 	 */

application/loginform.class.inc.php

@@ -1,13 +1,16 @@
 <?php
 
 /**
- * Class LoginForm
- *
  * @copyright   Copyright (C) 2010-2019 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
-class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
+/**
+ * Class LoginForm
+ *
+ * @since 2.7.0
+ */
+class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 {
 	private $bForceFormOnError = false;
 
@@ -21,6 +24,9 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
 		return array('form');
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnReadCredentials(&$iErrorCode)
 	{
 		if (!isset($_SESSION['login_mode']) || ($_SESSION['login_mode'] == 'form'))
@@ -37,6 +43,10 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
 					exit;
 				}
 
+                if (LoginWebPage::getIOnExit() === LoginWebPage::EXIT_RETURN) {
+                    return LoginWebPage::LOGIN_FSM_CONTINUE;
+                }
+
 				// No credentials yet, display the form
 				$oPage = LoginWebPage::NewLoginWebPage();
 				$oPage->DisplayLoginForm($this->bForceFormOnError);
@@ -51,9 +61,12 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnCheckCredentials(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'form')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'form')
 		{
 			$sAuthUser = utils::ReadPostedParam('auth_user', '', 'raw_data');
 			$sAuthPwd = utils::ReadPostedParam('auth_pwd', null, 'raw_data');
@@ -62,41 +75,44 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
 				$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
 				return LoginWebPage::LOGIN_FSM_ERROR;
 			}
+			// Save the checked user
+			$_SESSION['auth_user'] = $sAuthUser;
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnCredentialsOK(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'form')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'form')
 		{
-			if (isset($_SESSION['auth_user']))
-			{
-				// If FSM reenter this state (example 2FA) then the auth_user is not resubmitted
-				$sAuthUser = $_SESSION['auth_user'];
-			}
-			else
-			{
-				$sAuthUser = utils::ReadPostedParam('auth_user', '', 'raw_data');
-			}
+			$sAuthUser = $_SESSION['auth_user'];
 			// Store 'auth_user' in session for further use
 			LoginWebPage::OnLoginSuccess($sAuthUser, 'internal', $_SESSION['login_mode']);
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnError(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'form')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'form')
 		{
 			$this->bForceFormOnError = true;
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnConnected(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'form')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'form')
 		{
 			$_SESSION['can_logoff'] = true;
 			return LoginWebPage::CheckLoggedUser($iErrorCode);
@@ -105,14 +121,14 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
 	}
 
 	/**
-	 * @return LoginTwigData
+	 * @inheritDoc
 	 * @throws \Exception
 	 */
-	public function GetLoginData()
+	public function GetTwigContext()
 	{
-
-		$aPostedVars = array('auth_user', 'auth_pwd');
-		$oLoginData = new LoginTwigData($aPostedVars);
+		$oLoginContext = new LoginTwigContext();
+		$oLoginContext->AddPostedVar('auth_user');
+		$oLoginContext->AddPostedVar('auth_pwd');
 
 		$sAuthUser = utils::ReadParam('auth_user', '', true, 'raw_data');
 		$sAuthPwd = utils::ReadParam('suggest_pwd', '', true, 'raw_data');
@@ -121,19 +137,18 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginDataExtension
 			'sAuthUser' => $sAuthUser,
 			'sAuthPwd' => $sAuthPwd,
 		);
-		$oLoginData->AddBlockData('login_input', new LoginBlockData('loginforminput.html.twig', $aData));
-		$oLoginData->AddBlockData('login_submit', new LoginBlockData('loginformsubmit.html.twig'));
-		$oLoginData->AddBlockData('login_form_footer', new LoginBlockData('loginformfooter.html.twig'));
+		$oLoginContext->AddBlockExtension('login_input', new LoginBlockExtension('extensionblock/loginforminput.html.twig', $aData));
+		$oLoginContext->AddBlockExtension('login_submit', new LoginBlockExtension('extensionblock/loginformsubmit.html.twig'));
+		$oLoginContext->AddBlockExtension('login_form_footer', new LoginBlockExtension('extensionblock/loginformfooter.html.twig'));
 
-		$bEnableResetPassword = empty(MetaModel::GetConfig()->Get('forgot_password')) ? true : MetaModel::GetConfig()->Get('forgot_password');
+		$bEnableResetPassword = MetaModel::GetConfig()->Get('forgot_password');
 		$sResetPasswordUrl = utils::GetAbsoluteUrlAppRoot() . 'pages/UI.php?loginop=forgot_pwd';
-
 		$aData = array(
 			'bEnableResetPassword' => $bEnableResetPassword,
 			'sResetPasswordUrl' => $sResetPasswordUrl,
 		);
-		$oLoginData->AddBlockData('login_links', new LoginBlockData('loginformlinks.html.twig', $aData));
+		$oLoginContext->AddBlockExtension('login_links', new LoginBlockExtension('extensionblock/loginformlinks.html.twig', $aData));
 
-		return $oLoginData;
+		return $oLoginContext;
 	}
 }

application/logintwig.class.inc.php

@@ -9,61 +9,130 @@
 
 use Combodo\iTop\TwigExtension;
 
-class LoginTwigData
+/**
+ * Twig context for modules extending the login screen
+ * Class LoginTwigContext
+ */
+class LoginTwigContext
 {
-	private $aBlockData;
+	/** @var array */
+	private $aBlockExtension;
+	/** @var array */
 	private $aPostedVars;
+	/** @var string  */
 	private $sTwigLoaderPath;
-	private $sCSSFile;
+	/** @var array */
+	private $aCSSFiles;
 	/** @var array */
 	private $aJsFiles;
+	private $sTwigNameSpace;
 
 	/**
-	 * LoginTwigData constructor.
+	 * Build a context to display the twig files used
+	 * to extend the login screens
 	 *
-	 * @param array $aPostedVars
-	 * @param string $sLoaderPath
-	 * @param string $sCSSFile
-	 * @param array $aJsFiles
+	 * LoginTwigContext constructor.
+	 * @api
 	 */
-	public function __construct($aPostedVars = array(), $sLoaderPath = null, $sCSSFile = null, $aJsFiles = array())
+	public function __construct()
 	{
-		$this->aBlockData = array();
-		$this->aPostedVars = $aPostedVars;
-		$this->sTwigLoaderPath = $sLoaderPath;
-		$this->sCSSFile = $sCSSFile;
-		$this->aJsFiles = $aJsFiles;
+		$this->aBlockExtension = array();
+		$this->aPostedVars = array();
+		$this->sTwigLoaderPath = null;
+		$this->aCSSFiles = array();
+		$this->aJsFiles = array();
+		$this->sTwigNameSpace = null;
+	}
+
+	/**
+	 * Set the absolute path on disk of the folder containing the twig templates
+	 *
+	 * @param string $sPath absolute path of twig templates directory
+	 * @api
+	 */
+	public function SetLoaderPath($sPath)
+	{
+		$this->sTwigLoaderPath = $sPath;
+	}
+
+	/**
+	 * Add a Twig block extension
+	 *
+	 * @param string $sBlockName
+	 * @param LoginBlockExtension $oBlockExtension
+	 */
+	public function AddBlockExtension($sBlockName, $oBlockExtension)
+	{
+		$this->aBlockExtension[$sBlockName] = $oBlockExtension;
+	}
+
+	/**
+	 * Add a variable intended to be posted on URL (and managed) by the module.
+	 * Declaring the posted variables will prevent the core engine to manipulate these variables.
+	 *
+	 * @param string $sPostedVar Name of the posted variable
+	 * @api
+	 */
+	public function AddPostedVar($sPostedVar)
+	{
+		$this->aPostedVars[] = $sPostedVar;
+	}
+
+	/**
+	 * Add the URL of a CSS file to link to the login screen
+	 *
+	 * @param string $sFile URL of the CSS file to link
+	 * @api
+	 */
+	public function AddCSSFile($sFile)
+	{
+		$this->aCSSFiles[] = $sFile;
+	}
+
+	/**
+	 * Add the URL of a javascript file to link to the login screen
+	 * @param string $sFile URL of the javascript file to link
+	 * @api
+	 */
+	public function AddJsFile($sFile)
+	{
+		$this->aJsFiles[] = $sFile;
 	}
 
 	/**
 	 * @param string $sBlockName
-	 * @param LoginBlockData $oBlockData
+	 *
+	 * @return \LoginBlockExtension
 	 */
-	public final function AddBlockData($sBlockName, $oBlockData)
+	public function GetBlockExtension($sBlockName)
 	{
-		$this->aBlockData[$sBlockName] = $oBlockData;
+		/** @var LoginBlockExtension $oBlockExtension */
+		$oBlockExtension = isset($this->aBlockExtension[$sBlockName]) ? $this->aBlockExtension[$sBlockName] : null;
+		return $oBlockExtension;
 	}
 
-	public final function GetBlockData($sBlockName)
-	{
-		/** @var LoginBlockData $oBlockData */
-		$oBlockData = isset($this->aBlockData[$sBlockName]) ? $this->aBlockData[$sBlockName] : null;
-		return $oBlockData;
-	}
-
-	public final function GetPostedVars()
+	/**
+	 * @return array
+	 */
+	public function GetPostedVars()
 	{
 		return $this->aPostedVars;
 	}
 
-	public final function GetTwigLoaderPath()
+	/**
+	 * @return string
+	 */
+	public function GetTwigLoaderPath()
 	{
 		return $this->sTwigLoaderPath;
 	}
 
-	public final function GetCSSFile()
+	/**
+	 * @return array
+	 */
+	public function GetCSSFiles()
 	{
-		return $this->sCSSFile;
+		return $this->aCSSFiles;
 	}
 
 	/**
@@ -73,18 +142,33 @@ class LoginTwigData
 	{
 		return $this->aJsFiles;
 	}
+
 }
 
-class LoginBlockData
+/**
+ * Twig block description for login screen extension
+ * The login screen can be extended by adding twig templates
+ * to specific blocks of the login screens
+ *
+ * Class LoginBlockExtension
+ */
+class LoginBlockExtension
 {
 	private $sTwig;
 	private $aData;
 
 	/**
-	 * LoginBlockData constructor.
+	 * Create a new twig extension block
+	 * The given twig template can be HTML, CSS or JavaScript.
+	 * CSS goes to the block named 'css' and is inline in the page.
+	 * JavaScript goes to the blocks named 'script' or 'ready_script' and are inline in the page.
+	 * HTML goes to everywhere else
 	 *
-	 * @param string $sTwig
-	 * @param array $aData
+	 * LoginBlockExtension constructor.
+	 *
+	 * @param string $sTwig name of the twig file relative to the path given to the LoginTwigContext
+	 * @param array $aData Data given to the twig template (into the variable {{ aData }})
+	 * @api
 	 */
 	public function __construct($sTwig, $aData = array())
 	{
@@ -92,18 +176,22 @@ class LoginBlockData
 		$this->aData = $aData;
 	}
 
-	public final function GetTwig()
+	public function GetTwig()
 	{
 		return $this->sTwig;
 	}
 
-	public final function GetData()
+	public function GetData()
 	{
 		return $this->aData;
 	}
 }
 
-class LoginTwigContext
+/**
+ * Used by LoginWebPage to display the login screen
+ * Class LoginTwigRenderer
+ */
+class LoginTwigRenderer
 {
 	private $aLoginPluginList;
 	private $aPluginFormData;
@@ -112,21 +200,27 @@ class LoginTwigContext
 
 	public function __construct()
 	{
-		$this->aLoginPluginList = LoginWebPage::GetLoginPluginList('iLoginDataExtension', false);
+		$this->aLoginPluginList = LoginWebPage::GetLoginPluginList('iLoginUIExtension', false);
 		$this->aPluginFormData = array();
 		$aTwigLoaders = array();
 		$this->aPostedVars = array();
 		foreach ($this->aLoginPluginList as $oLoginPlugin)
 		{
-			/** @var \iLoginDataExtension $oLoginPlugin */
-			$oLoginData = $oLoginPlugin->GetLoginData();
-			$this->aPluginFormData[] = $oLoginData;
-			$sTwigLoaderPath = $oLoginData->GetTwigLoaderPath();
+			/** @var \iLoginUIExtension $oLoginPlugin */
+			$oLoginContext = $oLoginPlugin->GetTwigContext();
+			if (is_null($oLoginContext))
+			{
+				continue;
+			}
+			$this->aPluginFormData[] = $oLoginContext;
+			$sTwigLoaderPath = $oLoginContext->GetTwigLoaderPath();
 			if ($sTwigLoaderPath != null)
 			{
-				$aTwigLoaders[] = new Twig_Loader_Filesystem($sTwigLoaderPath);
+				$oExtensionLoader = new Twig_Loader_Filesystem();
+				$oExtensionLoader->setPaths($sTwigLoaderPath);
+				$aTwigLoaders[] = $oExtensionLoader;
 			}
-			$this->aPostedVars = array_merge($this->aPostedVars, $oLoginData->GetPostedVars());
+			$this->aPostedVars = array_merge($this->aPostedVars, $oLoginContext->GetPostedVars());
 		}
 
 		$oCoreLoader = new Twig_Loader_Filesystem(array(), APPROOT.'templates');
@@ -178,9 +272,9 @@ class LoginTwigContext
 		// Render CSS links
 		foreach ($this->aPluginFormData as $oFormData)
 		{
-			/** @var \LoginTwigData $oFormData */
-			$sCSSFile = $oFormData->GetCSSFile();
-			if (!empty($sCSSFile))
+			/** @var \LoginTwigContext $oFormData */
+			$aCSSFiles = $oFormData->GetCSSFiles();
+			foreach ($aCSSFiles as $sCSSFile)
 			{
 				$oPage->add_linked_stylesheet($sCSSFile);
 			}
@@ -224,4 +318,4 @@ class LoginTwigContext
 	{
 		return $this->oTwig;
 	}
-}
+}

application/loginurl.class.inc.php

@@ -40,7 +40,7 @@ class LoginURL extends AbstractLoginFSMExtension
 
 	protected function OnReadCredentials(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'url')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'url')
 		{
 			$_SESSION['login_temp_auth_user'] =  utils::ReadParam('auth_user', '', false, 'raw_data');
 		}
@@ -49,7 +49,7 @@ class LoginURL extends AbstractLoginFSMExtension
 
 	protected function OnCheckCredentials(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'url')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'url')
 		{
 			$sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data');
 			$sAuthPwd = utils::ReadParam('auth_pwd', null, false, 'raw_data');
@@ -58,15 +58,17 @@ class LoginURL extends AbstractLoginFSMExtension
 				$iErrorCode = LoginWebPage::EXIT_CODE_WRONGCREDENTIALS;
 				return LoginWebPage::LOGIN_FSM_ERROR;
 			}
+			// Save the checked user
+			$_SESSION['auth_user'] = $sAuthUser;
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
 	protected function OnCredentialsOK(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'url')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'url')
 		{
-			$sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data');
+			$sAuthUser = $_SESSION['auth_user'];
 			LoginWebPage::OnLoginSuccess($sAuthUser, 'internal', $_SESSION['login_mode']);
 		}
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
@@ -74,7 +76,7 @@ class LoginURL extends AbstractLoginFSMExtension
 
 	protected function OnError(&$iErrorCode)
 	{
-		if ($_SESSION['login_mode'] == 'url')
+		if (isset($_SESSION['login_mode']) && $_SESSION['login_mode'] == 'url')
 		{
 			$this->bErrorOccurred = true;
 		}

application/loginwebpage.class.inc.php

@@ -32,7 +32,7 @@ class LoginWebPage extends NiceWebPage
 {
 	const EXIT_PROMPT = 0;
 	const EXIT_HTTP_401 = 1;
-	const EXIT_RETURN = 2;
+	const EXIT_RETURN = 2; // Non interactive mode (ajax, rest, ...)
 	
 	const EXIT_CODE_OK = 0;
 	const EXIT_CODE_MISSINGLOGIN = 1;
@@ -78,14 +78,14 @@ class LoginWebPage extends NiceWebPage
 	
 	public function __construct($sTitle = null)
 	{
-	    if($sTitle === null)
-        {
-            $sTitle = Dict::S('UI:Login:Title');
-        }
+		if ($sTitle === null) {
+			$sTitle = Dict::S('UI:Login:Title');
+		}
 
 		parent::__construct($sTitle);
 		$this->SetStyleSheet();
-		$this->add_header("Cache-control: no-cache");
+		$this->no_cache();
+		$this->add_http_headers();
 	}
 	
 	public function SetStyleSheet()
@@ -118,7 +118,7 @@ class LoginWebPage extends NiceWebPage
 
 	public function DisplayLoginForm($bFailedLogin = false)
 	{
-		$oTwigContext = new LoginTwigContext();
+		$oTwigContext = new LoginTwigRenderer();
 		$aPostedVars = array_merge(array('login_mode', 'loginop'), $oTwigContext->GetPostedVars());
 
 		$sMessage = Dict::S('UI:Login:IdentifyYourself');
@@ -171,7 +171,7 @@ class LoginWebPage extends NiceWebPage
 	{
 		$sAuthUser = utils::ReadParam('auth_user', '', true, 'raw_data');
 
-		$oTwigContext = new LoginTwigContext();
+		$oTwigContext = new LoginTwigRenderer();
 		$aVars = $oTwigContext->GetDefaultVars();
 		$aVars['sAuthUser'] = $sAuthUser;
 		$aVars['bFailedToReset'] = $bFailedToReset;
@@ -189,53 +189,54 @@ class LoginWebPage extends NiceWebPage
 			UserRights::Login($sAuthUser); // Set the user's language (if possible!)
             /** @var UserInternal $oUser */
             $oUser = UserRights::GetUserObject();
-			if ($oUser == null)
+
+			if ($oUser != null)
 			{
-				throw new Exception(Dict::Format('UI:ResetPwd-Error-WrongLogin', $sAuthUser));
-			}
-			if (!MetaModel::IsValidAttCode(get_class($oUser), 'reset_pwd_token'))
-			{
-				throw new Exception(Dict::S('UI:ResetPwd-Error-NotPossible'));
-			}
-			if (!$oUser->CanChangePassword())
-			{
-				throw new Exception(Dict::S('UI:ResetPwd-Error-FixedPwd'));
-			}
-			
-			$sTo = $oUser->GetResetPasswordEmail(); // throws Exceptions if not allowed
-			if ($sTo == '')
-			{
-				throw new Exception(Dict::S('UI:ResetPwd-Error-NoEmail'));
+				if (!MetaModel::IsValidAttCode(get_class($oUser), 'reset_pwd_token'))
+				{
+					throw new Exception(Dict::S('UI:ResetPwd-Error-NotPossible'));
+				}
+				if (!$oUser->CanChangePassword())
+				{
+					throw new Exception(Dict::S('UI:ResetPwd-Error-FixedPwd'));
+				}
+
+				$sTo = $oUser->GetResetPasswordEmail(); // throws Exceptions if not allowed
+				if ($sTo == '')
+				{
+					throw new Exception(Dict::S('UI:ResetPwd-Error-NoEmail'));
+				}
+
+				// This token allows the user to change the password without knowing the previous one
+				$sToken = bin2hex(random_bytes(32));
+				$oUser->Set('reset_pwd_token', $sToken);
+				CMDBObject::SetTrackInfo('Reset password');
+				$oUser->AllowWrite(true);
+				$oUser->DBUpdate();
+
+				$oEmail = new Email();
+				$oEmail->SetRecipientTO($sTo);
+				$sFrom = MetaModel::GetConfig()->Get('forgot_password_from');
+				$oEmail->SetRecipientFrom($sFrom);
+				$oEmail->SetSubject(Dict::S('UI:ResetPwd-EmailSubject', $oUser->Get('login')));
+				$sResetUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?loginop=reset_pwd&auth_user='.urlencode($oUser->Get('login')).'&token='.urlencode($sToken);
+				$oEmail->SetBody(Dict::Format('UI:ResetPwd-EmailBody', $sResetUrl, $oUser->Get('login')));
+				$iRes = $oEmail->Send($aIssues, true /* force synchronous exec */);
+				switch ($iRes)
+				{
+					//case EMAIL_SEND_PENDING:
+					case EMAIL_SEND_OK:
+						break;
+
+					case EMAIL_SEND_ERROR:
+					default:
+						IssueLog::Error('Failed to send the email with the NEW password for '.$oUser->Get('friendlyname').': '.implode(', ', $aIssues));
+						throw new Exception(Dict::S('UI:ResetPwd-Error-Send'));
+				}
 			}
 
-			// This token allows the user to change the password without knowing the previous one
-			$sToken = substr(md5(APPROOT.uniqid()), 0, 16);
-			$oUser->Set('reset_pwd_token', $sToken);
-			CMDBObject::SetTrackInfo('Reset password');
-			$oUser->AllowWrite(true);
-			$oUser->DBUpdate();
 
-			$oEmail = new Email();
-			$oEmail->SetRecipientTO($sTo);
-			$sFrom = MetaModel::GetConfig()->Get('forgot_password_from');
-			$oEmail->SetRecipientFrom($sFrom);
-			$oEmail->SetSubject(Dict::S('UI:ResetPwd-EmailSubject', $oUser->Get('login')));
-			$sResetUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?loginop=reset_pwd&auth_user='.urlencode($oUser->Get('login')).'&token='.urlencode($sToken);
-			$oEmail->SetBody(Dict::Format('UI:ResetPwd-EmailBody', $sResetUrl, $oUser->Get('login')));
-			$iRes = $oEmail->Send($aIssues, true /* force synchronous exec */);
-			switch ($iRes)
-			{
-				//case EMAIL_SEND_PENDING:
-				case EMAIL_SEND_OK:
-					break;
-		
-				case EMAIL_SEND_ERROR:
-				default:
-					IssueLog::Error('Failed to send the email with the NEW password for '.$oUser->Get('friendlyname').': '.implode(', ', $aIssues));
-					throw new Exception(Dict::S('UI:ResetPwd-Error-Send'));
-			}
-
-			$oTwigContext = new LoginTwigContext();
+			$oTwigContext = new LoginTwigRenderer();
 			$aVars = $oTwigContext->GetDefaultVars();
 			$oTwigContext->Render($this, 'forgotpwdsent.html.twig', $aVars);
 		}
@@ -245,7 +246,7 @@ class LoginWebPage extends NiceWebPage
 		}
 	}
 
-	public function DisplayResetPwdForm()
+	public function DisplayResetPwdForm($sErrorMessage = null)
 	{
 		$sAuthUser = utils::ReadParam('auth_user', '', false, 'raw_data');
 		$sToken = utils::ReadParam('token', '', false, 'raw_data');
@@ -253,11 +254,13 @@ class LoginWebPage extends NiceWebPage
 		UserRights::Login($sAuthUser); // Set the user's language
 		$oUser = UserRights::GetUserObject();
 
-		$oTwigContext = new LoginTwigContext();
+		$oTwigContext = new LoginTwigRenderer();
 		$aVars = $oTwigContext->GetDefaultVars();
 
 		$aVars['sAuthUser'] = $sAuthUser;
 		$aVars['sToken'] = $sToken;
+		$aVars['sErrorMessage'] = $sErrorMessage;
+
 		if (($oUser == null))
 		{
 			$aVars['bNoUser'] = true;
@@ -265,6 +268,7 @@ class LoginWebPage extends NiceWebPage
 		else
 		{
 			$aVars['bNoUser'] = false;
+			$aVars['sUserName'] = $oUser->GetFriendlyName();
 			$oEncryptedToken = $oUser->Get('reset_pwd_token');
 
 			if (!$oEncryptedToken->CheckPassword($sToken))
@@ -274,7 +278,6 @@ class LoginWebPage extends NiceWebPage
 			else
 			{
 				$aVars['bBadToken'] = false;
-				$aVars['sUserName'] = $oUser->GetFriendlyName();
 			}
 		}
 
@@ -288,9 +291,10 @@ class LoginWebPage extends NiceWebPage
 		$sNewPwd = utils::ReadPostedParam('new_pwd', '', 'raw_data');
 
 		UserRights::Login($sAuthUser); // Set the user's language
+		/** @var \UserLocal $oUser */
 		$oUser = UserRights::GetUserObject();
 
-		$oTwigContext = new LoginTwigContext();
+		$oTwigContext = new LoginTwigRenderer();
 		$aVars = $oTwigContext->GetDefaultVars();
 
 		$aVars['sAuthUser'] = $sAuthUser;
@@ -312,7 +316,7 @@ class LoginWebPage extends NiceWebPage
 			{
 				$aVars['bBadToken'] = false;
 				// Trash the token and change the password
-				$oUser->Set('reset_pwd_token', '');
+				$oUser->Set('reset_pwd_token', new ormPassword());
 				$oUser->AllowWrite(true);
 				$oUser->SetPassword($sNewPwd); // Does record the change into the DB
 				$aVars['sUrl'] = utils::GetAbsoluteUrlAppRoot();
@@ -322,11 +326,12 @@ class LoginWebPage extends NiceWebPage
 		$oTwigContext->Render($this, 'resetpwddone.html.twig', $aVars);
 	}
 
-	public function DisplayChangePwdForm($bFailedLogin = false)
+	public function DisplayChangePwdForm($bFailedLogin = false, $sIssue = null)
 	{
-		$oTwigContext = new LoginTwigContext();
+		$oTwigContext = new LoginTwigRenderer();
 		$aVars = $oTwigContext->GetDefaultVars();
 		$aVars['bFailedLogin'] = $bFailedLogin;
+		$aVars['sIssue'] = $sIssue;
 		$oTwigContext->Render($this, 'changepwdform.html.twig', $aVars);
 	}
 
@@ -337,7 +342,7 @@ class LoginWebPage extends NiceWebPage
 		$sTitle = empty($sTitle) ? Dict::S('UI:LogOff:ThankYou') : $sTitle;
 		$sMessage = Dict::S('UI:LogOff:ClickHereToLoginAgain');
 
-		$oTwigContext = new LoginTwigContext();
+		$oTwigContext = new LoginTwigRenderer();
 		$aVars = $oTwigContext->GetDefaultVars();
 		$aVars['sUrl'] = $sUrl;
 		$aVars['sTitle'] = $sTitle;
@@ -347,14 +352,20 @@ class LoginWebPage extends NiceWebPage
 		$this->output();
 	}
 
-	public static function ResetSession()
+	public static function ResetSession($bFullCleanup = false)
 	{
-		// Unset all of the session variables.
-		unset($_SESSION['auth_user']);
-		unset($_SESSION['login_state']);
-		unset($_SESSION['can_logoff']);
-		unset($_SESSION['archive_mode']);
-		unset($_SESSION['impersonate_user']);
+        if ($bFullCleanup) {
+            // Unset all of the session variables.
+            foreach (array_keys($_SESSION) as $sKey) {
+                unset($_SESSION[$sKey]);
+            }
+        } else {
+            unset($_SESSION['auth_user']);
+            unset($_SESSION['login_state']);
+            unset($_SESSION['can_logoff']);
+            unset($_SESSION['archive_mode']);
+            unset($_SESSION['impersonate_user']);
+        }
 		UserRights::_ResetSessionCache();
 		// If it's desired to kill the session, also delete the session cookie.
 		// Note: This will destroy the session, and not just the session data!
@@ -410,6 +421,7 @@ class LoginWebPage extends NiceWebPage
 		if ($bLoginDebug)
 		{
 			IssueLog::Info("---------------------------------");
+			IssueLog::Info($_SERVER['REQUEST_URI']);
 			IssueLog::Info("--> Entering Login FSM with state: [$sLoginState]");
 			$sSessionLog = session_id().' '.utils::GetSessionLog();
 			IssueLog::Info("SESSION: $sSessionLog");
@@ -494,6 +506,7 @@ class LoginWebPage extends NiceWebPage
 		foreach (MetaModel::EnumPlugins($sInterface) as $oLoginExtensionInstance)
 		{
 			$aLoginModes = $oLoginExtensionInstance->ListSupportedLoginModes();
+			$aLoginModes = (is_array($aLoginModes) ? $aLoginModes : array());
 			foreach ($aLoginModes as $sLoginMode)
 			{
 				// Keep only the plugins for the current login mode + before + after
@@ -678,7 +691,7 @@ class LoginWebPage extends NiceWebPage
 
 	public static function HTTPReload()
 	{
-		$sOriginURL = $_SERVER['REQUEST_SCHEME'] . '://' . $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];
+		$sOriginURL = utils::GetCurrentAbsoluteUrl();
 		if (!utils::StartsWith($sOriginURL, utils::GetAbsoluteUrlAppRoot()))
 		{
 			// If the found URL does not start with the configured AppRoot URL
@@ -783,6 +796,14 @@ class LoginWebPage extends NiceWebPage
 		$oPerson = null;
 		try
 		{
+			CMDBObject::SetTrackOrigin('custom-extension');
+			$sInfo = 'External User provisioning';
+			if (isset($_SESSION['login_mode']))
+			{
+				$sInfo .= " ({$_SESSION['login_mode']})";
+			}
+			CMDBObject::SetTrackInfo($sInfo);
+
 			$oPerson = MetaModel::NewObject('Person');
 			$oPerson->Set('first_name', $sFirstName);
 			$oPerson->Set('name', $sLastName);
@@ -797,17 +818,7 @@ class LoginWebPage extends NiceWebPage
 			{
 				$oPerson->Set($sAttCode, $sValue);
 			}
-			/** @var CMDBChange $oMyChange */
-			$oMyChange = MetaModel::NewObject('CMDBChange');
-			$oMyChange->Set("date", time());
-			$sOrigin = 'External User provisioning';
-			if (isset($_SESSION['login_mode']))
-			{
-				$sOrigin .= " ({$_SESSION['login_mode']})";
-			}
-			$oMyChange->Set('userinfo', $sOrigin);
-			$oMyChange->DBInsert();
-			$oPerson->DBInsertTracked($oMyChange);
+			$oPerson->DBInsert();
 		}
 		catch (Exception $e)
 		{
@@ -839,6 +850,14 @@ class LoginWebPage extends NiceWebPage
 		$oUser = null;
 		try
 		{
+			CMDBObject::SetTrackOrigin('custom-extension');
+			$sInfo = 'External User provisioning';
+			if (isset($_SESSION['login_mode']))
+			{
+				$sInfo .= " ({$_SESSION['login_mode']})";
+			}
+			CMDBObject::SetTrackInfo($sInfo);
+
 			$oUser = MetaModel::GetObjectByName('UserExternal', $sAuthUser, false);
 			if (is_null($oUser))
 			{
@@ -889,19 +908,7 @@ class LoginWebPage extends NiceWebPage
 			$oUser->Set('profile_list', $oProfilesSet);
 			if ($oUser->IsModified())
 			{
-				/** @var \CMDBChange $oMyChange */
-				$oMyChange = MetaModel::NewObject("CMDBChange");
-				$oMyChange->Set("date", time());
-				$oMyChange->Set('userinfo', $sOrigin);
-				$oMyChange->DBInsert();
-				if ($oUser->IsNew())
-				{
-					$oUser->DBInsertTracked($oMyChange);
-				}
-				else
-				{
-					$oUser->DBUpdateTracked($oMyChange);
-				}
+				$oUser->DBWrite();
 			}
 		}
 		catch (Exception $e)
@@ -930,7 +937,7 @@ class LoginWebPage extends NiceWebPage
 		}
 		else
 		{
-			if ($iOnExit == self::EXIT_RETURN)
+			if ($iOnExit === self::EXIT_RETURN)
 			{
 				return self::EXIT_CODE_PORTALUSERNOTAUTHORIZED;
 			}
@@ -938,6 +945,7 @@ class LoginWebPage extends NiceWebPage
 			{
 				// No rights to be here, redirect to the portal
 				header('Location: '.$ret);
+				die();
 			}
 		}
 		return self::EXIT_CODE_OK;
@@ -985,14 +993,14 @@ class LoginWebPage extends NiceWebPage
 		{
 			if ($bMustBeAdmin && !UserRights::IsAdministrator())
 			{
-				if ($iOnExit == self::EXIT_RETURN)
+				if ($iOnExit === self::EXIT_RETURN)
 				{
 					return self::EXIT_CODE_MUSTBEADMIN;
 				}
 				else
 				{
 					require_once(APPROOT.'/setup/setuppage.class.inc.php');
-					$oP = new SetupPage(Dict::S('UI:PageTitle:FatalError'));
+					$oP = new ErrorPage(Dict::S('UI:PageTitle:FatalError'));
 					$oP->add("<h1>".Dict::S('UI:Login:Error:AccessAdmin')."</h1>\n");
 					$oP->p("<a href=\"".utils::GetAbsoluteUrlAppRoot()."pages/logoff.php\">".Dict::S('UI:LogOffMenu')."</a>");
 					$oP->output();
@@ -1001,7 +1009,7 @@ class LoginWebPage extends NiceWebPage
 			}
 			$iRet = call_user_func(array(self::$sHandlerClass, 'ChangeLocation'), $sRequestedPortalId, $iOnExit);
 		}
-		if ($iOnExit == self::EXIT_RETURN)
+		if ($iOnExit === self::EXIT_RETURN)
 		{
 			return $iRet;
 		}
@@ -1044,8 +1052,17 @@ class LoginWebPage extends NiceWebPage
 		}
 		else if ($operation == 'do_reset_pwd')
 		{
-			$oPage = self::NewLoginWebPage();
-			$oPage->DoResetPassword();
+
+			try {
+				$oPage = self::NewLoginWebPage();
+				$oPage->DoResetPassword();
+			}
+			catch (CoreCannotSaveObjectException $e)
+			{
+				$oPage = self::NewLoginWebPage();
+				$oPage->DisplayResetPwdForm($e->getIssue());
+			}
+
 			$oPage->output();
 			exit;
 		}
@@ -1061,6 +1078,24 @@ class LoginWebPage extends NiceWebPage
 				exit;
 			}
 		}
+		else if ($operation == 'check_pwd_policy')
+		{
+			$sAuthUser = $_SESSION['auth_user'];
+			UserRights::Login($sAuthUser); // Set the user's language
+
+			$aPwdMap = array();
+
+			foreach (array('new_pwd', 'retype_new_pwd') as $postedPwd)
+			{
+				$oUser = new UserLocal();
+				$oUser->ValidatePassword($_POST[$postedPwd]);
+
+				$aPwdMap[$postedPwd]['isValid'] = $oUser->IsPasswordValid();
+				$aPwdMap[$postedPwd]['message'] = $oUser->getPasswordValidityMessage();
+			}
+			echo json_encode($aPwdMap);
+			die();
+		}
 		if ($operation == 'do_change_pwd')
 		{
 			if (isset($_SESSION['auth_user']))
@@ -1069,10 +1104,21 @@ class LoginWebPage extends NiceWebPage
 				UserRights::Login($sAuthUser); // Set the user's language
 				$sOldPwd = utils::ReadPostedParam('old_pwd', '', 'raw_data');
 				$sNewPwd = utils::ReadPostedParam('new_pwd', '', 'raw_data');
-				if (UserRights::CanChangePassword() && ((!UserRights::CheckCredentials($sAuthUser, $sOldPwd)) || (!UserRights::ChangePassword($sOldPwd, $sNewPwd))))
+
+				try
+				{
+					if (UserRights::CanChangePassword() && ((!UserRights::CheckCredentials($sAuthUser, $sOldPwd)) || (!UserRights::ChangePassword($sOldPwd, $sNewPwd))))
+					{
+						$oPage = self::NewLoginWebPage();
+						$oPage->DisplayChangePwdForm(true); // old pwd was wrong
+						$oPage->output();
+						exit;
+					}
+				}
+				catch (CoreCannotSaveObjectException $e)
 				{
 					$oPage = self::NewLoginWebPage();
-					$oPage->DisplayChangePwdForm(true); // old pwd was wrong
+					$oPage->DisplayChangePwdForm(true, $e->getIssue()); // password policy was not met.
 					$oPage->output();
 					exit;
 				}

application/maintenancemsg.php

@@ -1,7 +1,20 @@
 <?php
 /**
- * @copyright   Copyright (C) 2010-2019 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * Copyright (C) 2013-2019 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
  */
 
 
@@ -18,12 +31,18 @@
 function _MaintenanceSetupPageMessage($sTitle, $sMessage)
 {
 	// Web Page
-	@include_once(APPROOT.'bootstrap.inc.php');
 	@include_once(APPROOT.'setup/setuppage.class.inc.php');
 	if (class_exists('SetupPage'))
 	{
-		$oP = new SetupPage($sTitle);
-		$oP->p("<h2>$sMessage</h2>");
+		$oP = new ErrorPage($sTitle);
+		$oP->p("<h2 class=\"center\">$sMessage</h2>");
+		$oP->add_ready_script(
+<<<JS
+// Reload in 30s to check if maintenance is over
+setTimeout(function(){ window.location.reload(); }, 30000);
+JS
+
+		);
 		$oP->output();
 	}
 	else
@@ -58,7 +77,6 @@ function _MaintenanceHtmlMessage($sMessage)
  */
 function _MaintenanceJsonMessage($sTitle, $sMessage)
 {
-	@include_once(APPROOT.'bootstrap.inc.php');
 	@include_once(APPROOT."/application/ajaxwebpage.class.inc.php");
 	if (class_exists('ajax_page'))
 	{

application/menunode.class.inc.php

@@ -1,27 +1,20 @@
 <?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/>
-
-
 /**
- * Construction and display of the application's main menu
+ * Copyright (C) 2013-2019 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2016 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 require_once(APPROOT.'/application/utils.inc.php');
@@ -135,7 +128,7 @@ class ApplicationMenu
 		if (is_null($oMenuNode) || !$oMenuNode->IsEnabled())
 		{
 			require_once(APPROOT.'/setup/setuppage.class.inc.php');
-			$oP = new SetupPage(Dict::S('UI:PageTitle:FatalError'));
+			$oP = new ErrorPage(Dict::S('UI:PageTitle:FatalError'));
 			$oP->add("<h1>".Dict::S('UI:Login:Error:AccessRestricted')."</h1>\n");
 			$oP->p("<a href=\"".utils::GetAbsoluteUrlAppRoot()."pages/logoff.php\">".Dict::S('UI:LogOffMenu')."</a>");
 			$oP->output();
@@ -201,7 +194,7 @@ class ApplicationMenu
 
 	/**
 	 * Entry point to display the whole menu into the web page, used by iTopWebPage
-	 * @param \iTopWebPage $oPage
+	 * @param \WebPage $oPage
 	 * @param $aExtraParams
 	 * @throws DictExceptionMissingString
 	 */
@@ -217,7 +210,7 @@ class ApplicationMenu
 		{
 			if (!self::CanDisplayMenu($aMenu)) { continue; }
 			$oMenuNode = self::GetMenuNode($aMenu['index']);
-			$oPage->AddToMenu('<h3 id="'.utils::GetSafeId('AccordionMenu_'.$oMenuNode->GetMenuID()).'">'.$oMenuNode->GetTitle().'</h3>');
+			$oPage->AddToMenu('<h3 id="'.utils::GetSafeId('AccordionMenu_'.$oMenuNode->GetMenuID()).'" class="navigation-menu-group" data-menu-id="'.$oMenuNode->GetMenuId().'">'.$oMenuNode->GetTitle().'</h3>');
 			$oPage->AddToMenu('<div>');
 			$oPage->AddToMenu('<ul>');
 			$aChildren = self::GetChildren($aMenu['index']);
@@ -270,12 +263,15 @@ EOF
 
 	/**
 	 * Handles the display of the sub-menus (called recursively if necessary)
-	 * @param \iTopWebPage $oPage
+	 *
+	 * @param \WebPage $oPage
 	 * @param array $aMenus
 	 * @param array $aExtraParams
 	 * @param int $iActiveMenu
+	 *
 	 * @return true if the currently selected menu is one of the submenus
 	 * @throws DictExceptionMissingString
+	 * @throws \Exception
 	 */
 	static protected function DisplaySubMenu($oPage, $aMenus, $aExtraParams, $iActiveMenu = -1)
 	{
@@ -284,14 +280,22 @@ EOF
 		usort($aMenus, array('ApplicationMenu', 'CompareOnRank'));
 		foreach($aMenus as $aMenu)
 		{
+			if (!self::CanDisplayMenu($aMenu))
+			{
+				continue;
+			}
 			$index = $aMenu['index'];
 			$oMenu = self::GetMenuNode($index);
 			if ($oMenu->IsEnabled())
 			{
 				$aChildren = self::GetChildren($index);
-				$sCSSClass = (count($aChildren) > 0) ? ' class="submenu"' : '';
+				$aCSSClasses = array('navigation-menu-item');
+				if (count($aChildren) > 0)
+				{
+					$aCSSClasses[] = 'submenu';
+				}
 				$sHyperlink = $oMenu->GetHyperlink($aExtraParams);
-				$sItemHtml = '<li id="'.utils::GetSafeId('AccordionMenu_'.$oMenu->GetMenuID()).'" '.$sCSSClass.'>';
+				$sItemHtml = '<li id="'.utils::GetSafeId('AccordionMenu_'.$oMenu->GetMenuID()).'" class="'.implode(' ', $aCSSClasses).'" data-menu-id="'.$oMenu->GetMenuID().'">';
 				if ($sHyperlink != '')
 				{
 					$sLinkTarget = '';
@@ -299,7 +303,9 @@ EOF
 					{
 						$sLinkTarget .= ' target="_blank"';
 					}
-					$sItemHtml .= '<a href="'.$oMenu->GetHyperlink($aExtraParams).'"'.$sLinkTarget.'>'.$oMenu->GetTitle().'</a>';
+					$sURL = '"'.$oMenu->GetHyperlink($aExtraParams).'"'.$sLinkTarget;
+					$sTitle = utils::HtmlEntities($oMenu->GetTitle());
+					$sItemHtml .= "<a href={$sURL}>{$sTitle}</a>";
 				}
 				else
 				{
@@ -607,7 +613,9 @@ abstract class MenuNode
 
 	/**
 	 * @param $aExtraParams
+	 *
 	 * @return string
+	 * @throws \Exception
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -687,8 +695,8 @@ abstract class MenuNode
 	public abstract function RenderContent(WebPage $oPage, $aExtraParams = array());
 
 	/**
-	 * @param $sHyperlink
-	 * @param $aExtraParams
+	 * @param string $sHyperlink
+	 * @param array $aExtraParams
 	 * @return string
 	 */
 	protected function AddParams($sHyperlink, $aExtraParams)
@@ -732,8 +740,7 @@ class MenuGroup extends MenuNode
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param array $aExtraParams
+	 * @inheritDoc
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -771,8 +778,7 @@ class TemplateMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param $aExtraParams
-	 * @return string
+	 * @inheritDoc
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -781,10 +787,8 @@ class TemplateMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param array $aExtraParams
-	 * @return mixed|void
-	 * @throws DictExceptionMissingString
+	 * @inheritDoc
+	 * @throws \Exception
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -873,12 +877,8 @@ class OQLMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param array $aExtraParams
-	 * @return mixed|void
-	 * @throws CoreException
-	 * @throws DictExceptionMissingString
-	 * @throws OQLException
+	 * @inheritDoc
+	 * @throws \Exception
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -897,11 +897,11 @@ class OQLMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param $sOql
-	 * @param $sTitle
-	 * @param $sUsageId
-	 * @param $bSearchPane
-	 * @param $bSearchOpen
+	 * @param string $sOql
+	 * @param string $sTitle
+	 * @param string $sUsageId
+	 * @param bool $bSearchPane
+	 * @param bool $bSearchOpen
 	 * @param WebPage $oPage
 	 * @param array $aExtraParams
 	 * @param bool $bEnableBreadcrumb
@@ -922,7 +922,7 @@ class OQLMenuNode extends MenuNode
 			$oBlock->Display($oPage, 0);
 		}
 		
-		$oPage->add("<p class=\"page-header\">$sIcon ".Dict::S($sTitle)."</p>");
+		$oPage->add("<p class=\"page-header\">$sIcon ".utils::HtmlEntities(Dict::S($sTitle))."</p>");
 		
 		$aParams = array_merge(array('table_id' => $sUsageId), $aExtraParams);
 		$oBlock = new DisplayBlock($oSearch, 'list', false /* Asynchronous */, $aParams);
@@ -974,16 +974,14 @@ class SearchMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param \iTopWebPage $oPage
-	 * @param array $aExtraParams
-	 * @return mixed|void
-	 * @throws DictExceptionMissingString
-	 * @throws Exception
+	 * @inheritDoc
+	 * @throws \DictExceptionMissingString
+	 * @throws \Exception
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
 		ApplicationMenu::CheckMenuIdEnabled($this->GetMenuId());
-		$oPage->SetBreadCrumbEntry("menu-".$this->sMenuId, $this->GetTitle(), '', '', utils::GetAbsoluteUrlAppRoot().'images/search.png');
+		$oPage->SetBreadCrumbEntry("menu-".$this->sMenuId, $this->GetTitle(), '', '', utils::GetAbsoluteUrlAppRoot().'images/breadcrumb-search.png');
 
 		$oSearch = new DBObjectSearch($this->sClass);
 		$aParams = array_merge(array('table_id' => 'Menu_'.utils::GetSafeId($this->GetMenuId())), $aExtraParams);
@@ -1034,8 +1032,7 @@ class WebPageMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param array $aExtraParams
-	 * @return string
+	 * @inheritDoc
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -1043,14 +1040,16 @@ class WebPageMenuNode extends MenuNode
 		return $this->AddParams( $this->sHyperlink, $aExtraParams);
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	public function IsHyperLinkInNewWindow()
 	{
 		return $this->bIsLinkInNewWindow;
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param array $aExtraParams
+	 * @inheritDoc
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -1091,10 +1090,7 @@ class NewObjectMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param string[] $aExtraParams
-	 *
-	 * @return string
-	 * @throws \Exception
+	 * @inheritDoc
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -1128,8 +1124,7 @@ class NewObjectMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param string[] $aExtraParams
+	 * @inheritDoc
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -1167,8 +1162,7 @@ class DashboardMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param string[] $aExtraParams
-	 * @return string
+	 * @inheritDoc
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -1187,10 +1181,8 @@ class DashboardMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param \iTopWebPage $oPage
-	 * @param string[] $aExtraParams
-	 * @throws CoreException
-	 * @throws Exception
+	 * @inheritDoc
+	 * @throws \Exception
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -1198,8 +1190,9 @@ class DashboardMenuNode extends MenuNode
 		$oDashboard = $this->GetDashboard();
 		if ($oDashboard != null)
 		{
-			$sDivId = preg_replace('/[^a-zA-Z0-9_]/', '', $this->sMenuId);
+			$sDivId = utils::Sanitize($this->sMenuId, '', 'element_identifier');
 			$oPage->add('<div class="dashboard_contents" id="'.$sDivId.'">');
+			$aExtraParams['dashboard_div_id'] = $sDivId;
 			$oDashboard->SetReloadURL($this->GetHyperlink($aExtraParams));
 			$oDashboard->Render($oPage, false, $aExtraParams);
 			$oPage->add('</div>');
@@ -1284,8 +1277,7 @@ class DashboardMenuNode extends MenuNode
 class ShortcutContainerMenuNode extends MenuNode
 {
 	/**
-	 * @param string[] $aExtraParams
-	 * @return string
+	 * @inheritDoc
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -1293,15 +1285,14 @@ class ShortcutContainerMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param string[] $aExtraParams
-	 * @return mixed|void
+	 * @inheritDoc
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
 	}
 
 	/**
+	 * @inheritDoc
 	 * @throws CoreException
 	 * @throws Exception
 	 */
@@ -1356,9 +1347,7 @@ class ShortcutMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param string[] $aExtraParams
-	 * @return string
-	 * @throws CoreException
+	 * @inheritDoc
 	 */
 	public function GetHyperlink($aExtraParams)
 	{
@@ -1376,10 +1365,8 @@ class ShortcutMenuNode extends MenuNode
 	}
 
 	/**
-	 * @param WebPage $oPage
-	 * @param string[] $aExtraParams
-	 * @return mixed|void
-	 * @throws DictExceptionMissingString
+	 * @inheritDoc
+	 * @throws \Exception
 	 */
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
@@ -1388,8 +1375,9 @@ class ShortcutMenuNode extends MenuNode
 	}
 
 	/**
-	 * @return string
-	 * @throws CoreException
+	 * @inheritDoc
+	 *
+	 * @throws \Exception
 	 */
 	public function GetTitle()
 	{
@@ -1397,8 +1385,9 @@ class ShortcutMenuNode extends MenuNode
 	}
 
 	/**
-	 * @return string
-	 * @throws CoreException
+	 * @inheritDoc
+	 *
+	 * @throws \Exception
 	 */
 	public function GetLabel()
 	{

application/nicewebpage.class.inc.php

@@ -1,27 +1,20 @@
 <?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 (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2016 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -46,8 +39,7 @@ class NiceWebPage extends WebPage
 		{
 			$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-migrate.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/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
@@ -124,7 +116,7 @@ class NiceWebPage extends WebPage
 	$("table.listResults").tableHover(); // hover tables
 EOF
 		);
-		$this->add_saas("css/light-grey.scss");
+	    $this->LoadTheme();
 
 		$this->m_sRootUrl = $this->GetAbsoluteUrlAppRoot();
      	$sAbsURLAppRoot = addslashes($this->m_sRootUrl);
@@ -257,6 +249,14 @@ EOF
 		}
 		parent::output();
 	}
-}
 
-?>
+	/**
+	 * @throws \Exception
+	 * @since 2.7.0
+	 */
+	protected function LoadTheme()
+	{
+		$sCssThemeUrl = ThemeHandler::GetCurrentThemeUrl();
+		$this->add_linked_stylesheet($sCssThemeUrl);
+	}
+}

application/pdfpage.class.inc.php

@@ -40,7 +40,7 @@ class iTopPDF extends TCPDF
 	 *
 	 * @uses \TCPDF::SetFont()
 	 * @uses \iTopPDF::GetPdfFont()
-	 * @since 2.7
+	 * @since 2.7.0
 	 */
 	public function SetFontParams($style, $size, $fontfile='', $subset='default', $out=true)
 	{

application/startup.inc.php

@@ -35,19 +35,25 @@ register_shutdown_function(function()
 	$sReservedMemory = null;
 	if (!is_null($err = error_get_last()) && ($err['type'] == E_ERROR))
 	{
-		IssueLog::error($err['message']);
-		if (strpos($err['message'], 'Allowed memory size of') !== false)
-		{
+		// Remove stack trace from MySQLException (since 2.7.2 see N°3174)
+		$sMessage = $err['message'];
+		if (strpos($sMessage, 'MySQLException') !== false) {
+			$iStackTracePos = strpos($sMessage, 'Stack trace:');
+			if ($iStackTracePos !== false) {
+				$sMessage = substr($sMessage, 0, $iStackTracePos);
+			}
+		}
+		// Log additional info but message from $err (since 2.7.6 N°4174)
+		$aErrToLog = $err;
+		unset($aErrToLog['message']);
+		IssueLog::error($sMessage, null, $aErrToLog);
+		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";
-		}
-		elseif (strpos($err['message'], 'Maximum execution time') !== false)
-		{
+		} elseif (strpos($err['message'], 'Maximum execution time') !== false) {
 			$sLimit = ini_get('max_execution_time');
 			echo "<p>iTop: Maximum execution time of $sLimit exceeded, contact your administrator to increase 'max_execution_time' in php.ini</p>\n";
-		}
-		else
-		{
+		} else {
 			echo "<p>iTop: An error occurred, check server error log for more information.</p>\n";
 		}
 	}
@@ -85,4 +91,10 @@ else
 	$_SESSION['itop_env'] = ITOP_DEFAULT_ENV;
 }
 $sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE;
-MetaModel::Startup($sConfigFile, false /* $bModelOnly */, $bAllowCache, false /* $bTraceSourceFiles */, $sEnv);
+try {
+    MetaModel::Startup($sConfigFile, false /* $bModelOnly */, $bAllowCache, false /* $bTraceSourceFiles */, $sEnv);
+}
+catch (MySQLException $e) {
+    IssueLog::Debug($e->getMessage());
+    throw new MySQLException('Could not connect to the DB server', []);
+}

application/template.class.inc.php

@@ -1,27 +1,20 @@
 <?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 (C) 2013-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2017 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
 
 require_once(APPROOT.'/application/displayblock.class.inc.php');
@@ -191,7 +184,7 @@ class DisplayTemplate
 			break;
 			
 			case 'itoptab':
-				$oPage->SetCurrentTab(Dict::S(str_replace('_', ' ', $aAttributes['name'])));
+				$oPage->SetCurrentTab($aAttributes['name'], 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>');

application/themehandler.class.inc.php

@@ -0,0 +1,194 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+/**
+ * Class ThemeHandler
+ *
+ * @author Stephen Abello <stephen.abello@combodo.com>
+ * @since 2.7.0
+ */
+class ThemeHandler
+{
+	/**
+	 * Return default theme name and parameters
+	 *
+	 * @return array
+	 * @since 2.7.0
+	 */
+	public static function GetDefaultThemeInformation()
+	{
+		return array(
+			'name' => 'light-grey',
+			'parameters' => array(
+				'variables' => array(),
+				'imports' => array(
+					'css-variables' => '../css/css-variables.scss',
+				),
+				'stylesheets' => array(
+					'jqueryui' => '../css/ui-lightness/jqueryui.scss',
+					'main' => '../css/light-grey.scss',
+				),
+			),
+		);
+	}
+
+	/**
+	 * Return the ID of the theme currently defined in the config. file
+	 *
+	 * @return string
+	 */
+	public static function GetCurrentThemeId()
+	{
+		try
+		{
+			if (is_null(MetaModel::GetConfig()))
+			{
+				throw new CoreException('no config');
+			}
+			$sThemeId = MetaModel::GetConfig()->Get('backoffice_default_theme');
+		}
+		catch(CoreException $oCompileException)
+		{
+			// Fallback on our default theme in case the config. is not available yet
+			$aDefaultTheme =  ThemeHandler::GetDefaultThemeInformation();
+			$sThemeId = $aDefaultTheme['name'];
+		}
+
+		return $sThemeId;
+	}
+
+	/**
+	 * Return the absolute path of the compiled theme folder.
+	 *
+	 * @param string $sThemeId
+	 *
+	 * @return string
+	 */
+	public static function GetCompiledThemeFolderAbsolutePath($sThemeId)
+	{
+		return APPROOT.'env-'.utils::GetCurrentEnvironment().'/branding/themes/'.$sThemeId.'/';
+	}
+	
+	/**
+	 * Return the absolute URL for the current theme CSS file
+	 *
+	 * @return string
+	 * @throws \Exception
+	 */
+	public static function GetCurrentThemeUrl()
+	{
+		try
+		{
+			// Try to compile theme defined in the configuration
+			$sThemeId = static::GetCurrentThemeId();
+			static::CompileTheme($sThemeId);
+		}
+		catch(CoreException $oCompileException)
+		{
+			// Fallback on our default theme (should always be compilable) in case the previous theme doesn't exists
+			$aDefaultTheme =  ThemeHandler::GetDefaultThemeInformation();
+			$sThemeId = $aDefaultTheme['name'];
+			$sDefaultThemeDirPath = static::GetCompiledThemeFolderAbsolutePath($sThemeId);
+			
+			// Create our theme dir if it doesn't exist (XML theme node removed, renamed etc..)
+			if(!is_dir($sDefaultThemeDirPath))
+			{
+				SetupUtils::builddir($sDefaultThemeDirPath);
+			}
+			
+			static::CompileTheme($sThemeId, $aDefaultTheme['parameters']);
+		}
+
+		// Return absolute url to theme compiled css
+		return utils::GetAbsoluteUrlModulesRoot().'/branding/themes/'.$sThemeId.'/main.css';
+	}
+
+	/**
+	 * Compile the $sThemeId theme
+	 *
+	 * @param string $sThemeId
+	 * @param array|null $aThemeParameters Parameters (variables, imports, stylesheets) for the theme, if not passed, will be retrieved from compiled DM
+	 * @param array|null $aImportsPaths Paths where imports can be found. Must end with '/'
+	 * @param string|null $sWorkingPath Path of the folder used during compilation. Must end with a '/'
+	 *
+	 * @throws \CoreException
+	 */
+	public static function CompileTheme($sThemeId, $aThemeParameters = null, $aImportsPaths = null, $sWorkingPath = null)
+	{
+		// Default working path
+		if($sWorkingPath === null)
+		{
+			$sWorkingPath = APPROOT.'env-'.utils::GetCurrentEnvironment().'/';
+		}
+
+		// Default import paths (env-*)
+		if($aImportsPaths === null)
+		{
+			$aImportsPaths = array(
+				APPROOT.'env-'.utils::GetCurrentEnvironment().'/',
+			);
+		}
+
+		// Note: We do NOT check that the folder exists!
+		$sThemeFolderPath = $sWorkingPath.'/branding/themes/'.$sThemeId.'/';
+		$sThemeCssPath = $sThemeFolderPath.'main.css';
+
+		// Save parameters if passed... (typically during DM compilation)
+		if(is_array($aThemeParameters))
+		{
+			file_put_contents($sThemeFolderPath.'/theme-parameters.json', json_encode($aThemeParameters));
+		}
+		// ... Otherwise, retrieve them from compiled DM (typically when switching current theme in the config. file)
+		else
+		{
+			$aThemeParameters = json_decode(@file_get_contents($sThemeFolderPath.'theme-parameters.json'), true);
+			if ($aThemeParameters === null)
+			{
+				throw new CoreException('Could not load "'.$sThemeId.'" theme parameters from file, check that it has been compiled correctly');
+			}
+		}
+
+		$sTmpThemeScssContent = '';
+		$iStyleLastModified = 0;
+		clearstatcache();
+		// Loading files to import and stylesheet to compile, also getting most recent modification time on overall files
+		foreach ($aThemeParameters['imports'] as $sImport)
+		{
+			$sTmpThemeScssContent .= '@import "'.$sImport.'";'."\n";
+
+			$iImportLastModified = @filemtime($sWorkingPath.$sImport);
+			$iStyleLastModified = $iStyleLastModified < $iImportLastModified ? $iImportLastModified : $iStyleLastModified;
+		}
+		foreach ($aThemeParameters['stylesheets'] as $sStylesheet)
+		{
+			$sTmpThemeScssContent .= '@import "'.$sStylesheet.'";'."\n";
+
+			$iStylesheetLastModified = @filemtime($sWorkingPath.$sStylesheet);
+			$iStyleLastModified = $iStyleLastModified < $iStylesheetLastModified ? $iStylesheetLastModified : $iStyleLastModified;
+		}
+
+		// Checking if our compiled css is outdated
+		if (!file_exists($sThemeCssPath) || (is_writable($sThemeFolderPath) && (@filemtime($sThemeCssPath) < $iStyleLastModified)))
+		{
+			$sTmpThemeCssContent = utils::CompileCSSFromSASS($sTmpThemeScssContent, $aImportsPaths, $aThemeParameters['variables']);
+			file_put_contents($sThemeCssPath, $sTmpThemeCssContent);
+		}
+	}
+}
+

application/transaction.class.inc.php

@@ -26,8 +26,6 @@
  * @copyright   Copyright (C) 2010-2012 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
-
-
 class privUITransaction
 {
 	/**
@@ -99,9 +97,10 @@ class privUITransaction
 }
 
 /**
- * The original (and by default) mechanism for storing transaction information
- * as an array in the $_SESSION variable
+ * The original mechanism for storing transaction information as an array in the $_SESSION variable
  *
+ * Warning, since 2.6.0 the session is regenerated on each login (see PR #20) !
+ * Also, we saw some problems when using memcached as the PHP session implementation (see N°1835)
  */
 class privUITransactionSession
 {
@@ -194,9 +193,35 @@ class privUITransactionSession
  */
 class privUITransactionFile
 {
+	/** @var int Value to use when no user logged */
+	const UNAUTHENTICATED_USER_ID = -666;
+
 	/**
+	 * @return int current user id, or {@see self::UNAUTHENTICATED_USER_ID} if no user logged
+	 *
+	 * @since 2.6.5 2.7.6 3.0.0 N°4289 method creation
+	 */
+	private static function GetCurrentUserId()
+	{
+		$iCurrentUserId = UserRights::GetConnectedUserId();
+		if ('' === $iCurrentUserId) {
+			$iCurrentUserId = static::UNAUTHENTICATED_USER_ID;
+		}
+
+		return $iCurrentUserId;
+	}
+
+	/**
+	 * Create a new transaction id, store it in the session and return its id
+	 *
+	 * @param void
+	 *
 	 * @return int The new transaction identifier
+	 *
+	 * @throws \SecurityException
 	 * @throws \Exception
+	 *
+	 * @since 2.6.5 2.7.6 3.0.0 security hardening + throws SecurityException if no user logged
 	 */
 	public static function GetNewTransactionId()
 	{
@@ -213,88 +238,115 @@ class privUITransactionFile
 				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;
+		$iCurrentUserId = static::GetCurrentUserId();
+
+		self::CleanupOldTransactions();
+
+		$sTransactionIdFullPath = tempnam(APPROOT.'data/transactions', static::GetUserPrefix());
+		file_put_contents($sTransactionIdFullPath, $iCurrentUserId, LOCK_EX);
+
+		$sTransactionIdFileName = basename($sTransactionIdFullPath);
+		self::Info('GetNewTransactionId: Created transaction: '.$sTransactionIdFileName);
+
+		return $sTransactionIdFileName;
 	}
 
 	/**
 	 * 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
+	 *
+	 * @since 2.6.5 2.7.6 3.0.0 N°4289 security hardening
 	 */
 	public static function IsTransactionValid($id, $bRemoveTransaction = true)
 	{
-		$sFilepath = APPROOT.'data/transactions/'.$id;
+		// Constraint the transaction file within APPROOT.'data/transactions'
+		$sTransactionDir = realpath(APPROOT.'data/transactions');
+		$sFilepath = utils::RealPath($sTransactionDir.'/'.$id, $sTransactionDir);
+		if (($sFilepath === false) || (strlen($sTransactionDir) == strlen($sFilepath)))
+		{
+			return false;
+		}
+
 		clearstatcache(true, $sFilepath);
 		$bResult = file_exists($sFilepath);
-		if ($bResult)
+
+		if (false === $bResult) {
+			self::Info("IsTransactionValid: Transaction '$id' not found. Pending transactions:\n".implode("\n", self::GetPendingTransactions()));
+			return false;
+		}
+
+		$iCurrentUserId = static::GetCurrentUserId();
+		$sTransactionIdUserId = file_get_contents($sFilepath);
+		if ($iCurrentUserId != $sTransactionIdUserId) {
+			self::Info("IsTransactionValid: Transaction '$id' not existing for current user. Pending transactions:\n".implode("\n", self::GetPendingTransactions()));
+			return false;
+		}
+
+		if ($bRemoveTransaction)
 		{
-			if ($bRemoveTransaction)
+			$bResult = @unlink($sFilepath);
+			if (!$bResult)
 			{
-				$bResult = @unlink($sFilepath);
-				if (!$bResult)
-				{
-					self::Error('IsTransactionValid: FAILED to remove transaction '.$id);
-				}
-				else
-				{
-					self::Info('IsTransactionValid: OK. Removed transaction: '.$id);
-				}
+				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
+	 * @return bool true if the token can be removed
+	 *
+	 * @since 2.6.5 2.7.6 3.0.0 N°4289 security hardening
 	 */
 	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()));
+		/** @noinspection PhpRedundantOptionalArgumentInspection */
+		$bResult = static::IsTransactionValid($id, true);
+		if (false === $bResult) {
+			self::Error("RemoveTransaction: Transaction '$id' is invalid. Pending transactions:\n"
+				.implode("\n", self::GetPendingTransactions()));
+			return false;
 		}
-		$bSuccess = @unlink($sFilepath);
-		if (!$bSuccess)
-		{
-			self::Error('RemoveTransaction: FAILED to remove transaction '.$id);
-		}
-		else
-		{
-			self::Info('RemoveTransaction: OK '.$id);
-		}
-		return $bSuccess;
+
+		return true;
 	}
 
 	/**
 	 * 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()
+	protected static function CleanupOldTransactions($sTransactionDir = null)
 	{
-		$iLimit = time() - 24*3600;
+		$iThreshold = (int) MetaModel::GetConfig()->Get('transactions_gc_threshold');
+		$iThreshold = min(100, $iThreshold);
+		$iThreshold = max(1, $iThreshold);
+		if ((100 != $iThreshold) && (rand(1, 100) > $iThreshold)) {
+			return;
+		}
+
 		clearstatcache();
-		$aTransactions = glob(APPROOT.'data/transactions/*-*');
+		$iLimit = time() - 24*3600;
+		$sPattern = $sTransactionDir ? "$sTransactionDir/*" : APPROOT.'data/transactions/*';
+		$aTransactions = glob($sPattern);
 		foreach($aTransactions as $sFileName)
 		{
 			if (filemtime($sFileName) < $iLimit)
@@ -348,22 +400,35 @@ class privUITransactionFile
 	{
 		self::Write('Error | '.$sText);
 	}
-	
+
+	protected static function IsLogEnabled() {
+		$oConfig = MetaModel::GetConfig();
+		if (is_null($oConfig)) {
+			return false;
+		}
+
+		$bLogTransactions = $oConfig->Get('log_transactions');
+		if (true === $bLogTransactions) {
+			return true;
+		}
+
+		return false;
+	}
+
 	protected static function Write($sText)
 	{
-		$bLogEnabled = MetaModel::GetConfig()->Get('log_transactions');
-		if ($bLogEnabled)
-		{
+		if (false === static::IsLogEnabled()) {
+			return;
+		}
+
 		$hLogFile = @fopen(APPROOT.'log/transactions.log', 'a');
-		if ($hLogFile !== false)
-		{
+		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/twigextension.class.inc.php

@@ -5,7 +5,6 @@ namespace Combodo\iTop;
 use AttributeDateTime;
 use Dict;
 use Exception;
-use MetaModel;
 use Twig_Environment;
 use Twig_SimpleFilter;
 use Twig_SimpleFunction;
@@ -115,12 +114,18 @@ class TwigExtension
 			return utils::IsDevelopmentEnvironment();
 		}));
 
-		// Function to get configuration parameter
-		// Usage in twig: {{ get_config_parameter('foo') }}
-		$oTwigEnv->addFunction(new Twig_SimpleFunction('get_config_parameter', function($sParamName)
+		// Function to get the URL of a static page in a module
+		// Usage in twig: {{ get_static_page_module_url('itop-my-module', 'path-to-my-page') }}
+		$oTwigEnv->addFunction(new Twig_SimpleFunction('get_static_page_module_url', function($sModuleName, $sPage)
 		{
-			$oConfig = MetaModel::GetConfig();
-			return $oConfig->Get($sParamName);
+			return utils::GetAbsoluteUrlModulesRoot().$sModuleName.'/'.$sPage;
+		}));
+
+		// Function to get the URL of a php page in a module
+		// Usage in twig: {{ get_page_module_url('itop-my-module', 'path-to-my-my-page.php') }}
+		$oTwigEnv->addFunction(new Twig_SimpleFunction('get_page_module_url', function($sModuleName, $sPage)
+		{
+			return utils::GetAbsoluteUrlModulePage($sModuleName, $sPage);
 		}));
 	}
-}
+}

application/ui.extkeywidget.class.inc.php

@@ -1,23 +1,28 @@
 <?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/>
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+require_once(APPROOT.'/application/webpage.class.inc.php');
+require_once(APPROOT.'/application/displayblock.class.inc.php');
+
 /**
  * Class UIExtKeyWidget
- * UI wdiget for displaying and editing external keys when
+ * UI widget for displaying and editing external keys when
  * A simple drop-down list is not enough...
  *
  * The layout is the following
@@ -54,13 +59,7 @@
  * | |   +--------+    +-----+                    | |
  * | +--------------------------------------------+ |
  * +------------------------------------------------+
- * @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
 {
 	const ENUM_OUTPUT_FORMAT_CSV = 'csv';
@@ -72,7 +71,11 @@ class UIExtKeyWidget
 	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)
+
+	/**
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 Add default value for $aArgs for PHP 8.0 compat
+	 */
+	public static function DisplayFromAttCode($oPage, $sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName = '', $sFormPrefix = '', $aArgs = [], $bSearchMode = false)
 	{
 		$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
 		$sTargetClass = $oAttDef->GetTargetClass();
@@ -274,7 +277,7 @@ EOF
 
 			// the input for the auto-complete
 			$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>";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\"  id=\"mini_search_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.Search();\"><i class=\"fas fa-search\"></i></div></span>";
 
 			// another hidden input to store & pass the object's Id
 			$sHTMLValue .= "<input type=\"hidden\" id=\"$this->iId\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" />\n";
@@ -298,7 +301,7 @@ EOF
 		}
 		if ($bExtensions && MetaModel::IsHierarchicalClass($this->sTargetClass) !== false)
 		{
-			$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>";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\" id=\"mini_tree_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"><i class=\"fas fa-sitemap\"></i></div></span>";
 			$oPage->add_ready_script(
 <<<EOF
 			if ($('#ac_tree_{$this->iId}').length == 0)
@@ -312,7 +315,7 @@ EOF
 		{
 			$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>";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><div class=\"mini_button\" id=\"mini_add_{$this->iId}\" onClick=\"oACWidget_{$this->iId}.{$sCallbackName}();\"><i class=\"fas fa-plus\"></i></div></span>";
 			$oPage->add_ready_script(
 <<<EOF
 		if ($('#ajax_{$this->iId}').length == 0)
@@ -373,10 +376,10 @@ EOF
 		$sHTML .= "</form>\n";
 		$sHTML .= '</div></div>';
 
-		$sDialogTitle = addslashes($sTitle);
+		$sDialogTitleSanitized = addslashes(utils::HtmlToText($sTitle));
 		$oPage->add_ready_script(
 <<<EOF
-		$('#ac_dlg_{$this->iId}').dialog({ width: $(window).width()*0.8, height: $(window).height()*0.8, autoOpen: false, modal: true, title: '$sDialogTitle', resizeStop: oACWidget_{$this->iId}.UpdateSizes, close: oACWidget_{$this->iId}.OnClose });
+		$('#ac_dlg_{$this->iId}').dialog({ width: $(window).width()*0.8, height: $(window).height()*0.8, autoOpen: false, modal: true, title: '$sDialogTitleSanitized', resizeStop: oACWidget_{$this->iId}.UpdateSizes, close: oACWidget_{$this->iId}.OnClose });
 		$('#fs_{$this->iId}').bind('submit.uiAutocomplete', oACWidget_{$this->iId}.DoSearchObjects);
 		$('#dc_{$this->iId}').resize(oACWidget_{$this->iId}.UpdateSizes);
 EOF
@@ -427,8 +430,10 @@ EOF
      *
      * @throws CoreException
      * @throws OQLException
+     *
+     * @since 2.7.7 3.0.1 3.1.0 N°3129 Remove default value for $oObj for PHP 8.0 compatibility
      */
-	public function AutoComplete(WebPage $oP, $sFilter, $oObj = null, $sContains, $sOutputFormat = self::ENUM_OUTPUT_FORMAT_CSV, $sOperation = null)
+	public function AutoComplete(WebPage $oP, $sFilter, $oObj, $sContains, $sOutputFormat = self::ENUM_OUTPUT_FORMAT_CSV, $sOperation = null)
 	{
 		if (is_null($sFilter))
 		{
@@ -578,8 +583,21 @@ EOF
 		$oNewObj->UpdateObjectFromArg('default');
 
 		$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");
+		$sClassLabel = MetaModel::GetName($this->sTargetClass);
+		$sClassIcon = MetaModel::GetClassIcon($this->sTargetClass);
+		$sObjClass = get_class($oNewObj);
+		$sObjKey = $oNewObj->GetKey();
+		$sHeaderTitle = Dict::Format('UI:CreationTitle_Class', $sClassLabel);
+		$oPage->add(<<<HTML
+<div id="ac_create_{$this->iId}">
+	<!-- Beginning of object-details -->
+	<div class="object-details" data-object-class="$sObjClass" data-object-id="$sObjKey" data-object-mode="create">
+		<!-- Beginning of wizContainer -->
+		<div class="wizContainer" style="vertical-align:top;">
+			<div id="dcr_{$this->iId}">
+				<h1>$sClassIcon&nbsp;$sHeaderTitle</h1>
+HTML
+		);
 		$aFieldsFlags = array();
 		$aFieldsComments = array();
 		foreach(MetaModel::ListAttributeDefs($this->sTargetClass) as $sAttCode => $oAttDef)
@@ -591,7 +609,13 @@ EOF
 			}
 		}
 	 	cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, array(), array('formPrefix' => $this->iId, 'noRelations' => true, 'fieldsFlags' => $aFieldsFlags, 'fieldsComments' => $aFieldsComments));
-		$oPage->add('</div></div></div>');
+		$oPage->add(<<<HTML
+			</div>
+		</div><!-- End of wizContainer -->
+	</div><!-- End of object-details -->
+</div>
+HTML
+		);
 //		$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', maxHeight: $(window).height() - 50, autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
 		$oPage->add_ready_script("$('#dcr_{$this->iId} form').removeAttr('onsubmit');");
@@ -618,15 +642,22 @@ EOF
 		$oSet->SetShowObsoleteData(utils::ShowObsoleteData());
 
 		$sHKAttCode = MetaModel::IsHierarchicalClass($this->sTargetClass);
-		$this->DumpTree($oPage, $oSet, $sHKAttCode, $currValue);
+		$bHasChildLeafs = $this->DumpTree($oPage, $oSet, $sHKAttCode, $currValue);
 
 		$oPage->add('</td></tr></table>');
 		$oPage->add('</div>');
+
+		if ($bHasChildLeafs)
+		{
+			$oPage->add('<div class="treecontrol" id="treecontrolid"><a href="?#">'.Dict::S("UI:Treeview:CollapseAll").'</a> | <a href="?#">'.Dict::S("UI:Treeview:ExpandAll").'</a></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("\$('#tree_$this->iId ul').treeview({ control: '#treecontrolid',	persist: 'false'});\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");
 	}
 
@@ -655,6 +686,18 @@ EOF
 		}
 	}
 
+	/**
+	 * @param WebPage $oP
+	 * @param \DBObjectSet $oSet
+	 * @param string $sParentAttCode
+	 * @param string $currValue
+	 *
+	 * @return bool true if there are at least one child leaf, false if only roots nodes are present
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MySQLException
+	 */
 	function DumpTree($oP, $oSet, $sParentAttCode, $currValue)
 	{
 		$aTree = array();
@@ -683,6 +726,9 @@ EOF
 		{
 			$this->DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue);
 		}
+
+		$bHasOnlyRootNodes = (count($aTree) === 1);
+		return !$bHasOnlyRootNodes;
 	}
 
 	function DumpNodes($oP, $iRootId, $aTree, $aNodes, $currValue)
@@ -710,7 +756,7 @@ EOF
 						$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;';
 					}
 				}
-				$oP->add('<li>'.$sSelect.'<label for="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'">'.$aNodes[$id]->GetName().'</label>');
+				$oP->add('<li class="closed">'.$sSelect.'<label for="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'">'.$aNodes[$id]->GetName().'</label>');
 				$this->DumpNodes($oP, $id, $aTree, $aNodes, $currValue);
 				$oP->add("</li>\n");
 			}

application/ui.linksdirectwidget.class.inc.php

@@ -85,9 +85,15 @@ class UILinksWidgetDirect
 	 * @param array $aArgs
 	 * @param string $sFormPrefix
 	 * @param DBObject $oCurrentObj
+	 *
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 Remove default value for $aArgs for PHP 8.0 compatibility (handling wrong values at method start)
 	 */
-	public function Display(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj)
+	public function Display(WebPage $oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj)
 	{
+		if (empty($aArgs)) {
+			$aArgs = [];
+		}
+
 		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
 		switch($oLinksetDef->GetEditMode())
 		{
@@ -137,8 +143,10 @@ class UILinksWidgetDirect
 	 * @param string $sFormPrefix
 	 * @param DBObject $oCurrentObj
 	 * @param bool $bDisplayMenu
+	 *
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 Remove default value for $aArgs for PHP 8.0 compatibility (protected method, always called with default value)
 	 */
-	protected function DisplayAsBlock(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, $bDisplayMenu)
+	protected function DisplayAsBlock(WebPage $oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj, $bDisplayMenu)
 	{
 		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
 		$sTargetClass = $oLinksetDef->GetLinkedClass();
@@ -239,8 +247,10 @@ class UILinksWidgetDirect
 	 * @param string $sFormPrefix
 	 * @param DBObject $oCurrentObj
 	 * @param array $aButtons
+	 *
+	 * @since 2.7.7 3.0.1 3.1.0 N°3129 Remove default value for $aArgs for PHP 8.0 compatibility (protected method, caller already handles it)
 	 */
-	protected function DisplayEditInPlace(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, $aButtons = array('create', 'delete'))
+	protected function DisplayEditInPlace(WebPage $oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj, $aButtons = array('create', 'delete'))
 	{
 		$aAttribs = $this->GetTableConfig();
 

application/ui.linkswidget.class.inc.php

@@ -346,7 +346,7 @@ EOF
 	 * @throws \CoreException
 	 * @throws \DictExceptionMissingString
 	 */
-	public function Display(WebPage $oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj)
+	public function Display(WebPage $oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj)
 	{
 		$sHtmlValue = '';
 		$sHtmlValue .= "<div id=\"linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix}\">\n";

application/user.preferences.class.inc.php

@@ -34,7 +34,7 @@ require_once(APPROOT.'/core/userrights.class.inc.php');
  */
 class appUserPreferences extends DBObject
 {
-	static $oUserPrefs = null; // Local cache
+	private static $oUserPrefs = null; // Local cache
 	
 	/**
 	 * Get the value of the given property/preference
@@ -43,7 +43,7 @@ class appUserPreferences extends DBObject
 	 * @param string $sDefaultValue The default value
 	 * @return string The value of the property for the current user
 	 */
-	static function GetPref($sCode, $sDefaultValue)
+	public static function GetPref($sCode, $sDefaultValue)
 	{
 		if (self::$oUserPrefs == null)
 		{
@@ -65,7 +65,7 @@ class appUserPreferences extends DBObject
 	 * @param string $sCode Code/Name of the property/preference to set
 	 * @param string $sValue Value to set
 	 */
-	static function SetPref($sCode, $sValue)
+	public static function SetPref($sCode, $sValue)
 	{
 		if (self::$oUserPrefs == null)
 		{
@@ -83,13 +83,13 @@ class appUserPreferences extends DBObject
 			self::Save();
 		}
 	}
-	
+
 	/**
 	 * Clears the value for a given preference (or list of preferences that matches a pattern), and updates the database
-	 * @param string $sPattern Code/Pattern of the properties/preferences to reset
+	 * @param string $sCodeOrPattern Code/Pattern of the properties/preferences to reset
 	 * @param boolean $bPattern Whether or not the supplied code is a PCRE pattern
 	 */
-	static function UnsetPref($sCodeOrPattern, $bPattern = false)
+	public static function UnsetPref($sCodeOrPattern, $bPattern = false)
 	{
 		if (self::$oUserPrefs == null)
 		{
@@ -124,7 +124,7 @@ class appUserPreferences extends DBObject
 	 * Call this function to get all the preferences for the user, packed as a JSON object
 	 * @return string JSON representation of the preferences
 	 */
-	static function GetAsJSON()
+	public static function GetAsJSON()
 	{
 		if (self::$oUserPrefs == null)
 		{
@@ -137,19 +137,19 @@ class appUserPreferences extends DBObject
 	/**
 	 * Call this function if the user has changed (like when doing a logoff...)
 	 */
-	static public function ResetPreferences()
+	public static function ResetPreferences()
 	{
 		self::$oUserPrefs = null;
 	}
 	/**
 	 * Call this function to ERASE all the preferences from the current user
 	 */
-	static public function ClearPreferences()
+	public static function ClearPreferences()
 	{
 		self::$oUserPrefs = null;
 	}
 	
-	static protected function Save()
+	protected static function Save()
 	{
 		if (self::$oUserPrefs != null)
 		{
@@ -166,7 +166,7 @@ class appUserPreferences extends DBObject
 	 * Loads the preferences for the current user, creating the record in the database
 	 * if needed
 	 */
-	static protected function Load()
+	protected static function Load()
 	{
 		if (self::$oUserPrefs != null) return;
 		$oSearch = new DBObjectSearch('appUserPreferences');

application/wizardhelper.class.inc.php

@@ -273,10 +273,6 @@ class WizardHelper
 	static public function FromJSON($sJSON)
 	{
 		$oWizHelper = new WizardHelper();
-		if (get_magic_quotes_gpc())
-		{
-			$sJSON = stripslashes($sJSON);
-		}
 		$aData = json_decode($sJSON, true); // true means hash array instead of object
 		$oWizHelper->m_aData = $aData;
 		return $oWizHelper;

application/xlsxwriter.class.php

@@ -174,7 +174,7 @@ Class XLSXWriter
 			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="n"><v>'.self::convert_date_time($value).'</v></c>');
 		} else if ($value==''){
 			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'"/>');
-		} else if ($value{0}=='='){
+		} else if ($value[0]=='='){
 			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="s"><f>'.self::xmlspecialchars($value).'</f></c>');
 		} else if ($value!==''){
 			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="s"><v>'.self::xmlspecialchars($this->setSharedString($value)).'</v></c>');

application/xmlpage.class.inc.php

@@ -43,9 +43,20 @@ class XMLPage extends WebPage
 		$this->m_bPassThrough = $bPassThrough;
 		$this->m_bHeaderSent = false;
 		$this->add_header("Content-type: text/xml; charset=".self::PAGES_CHARSET);
-		$this->add_header("Cache-control: no-cache");
+		$this->no_cache();
+		$this->add_http_headers();
 		$this->add_header("Content-location: export.xml");
-	}	
+	}
+
+	/**
+	 * Disabling sending the header so that resource won't be blocked by CORB. See parent method documentation.
+	 * @return void
+	 * @since 2.7.10 3.0.4 3.1.2 3.2.0 N°4368 method creation
+	 */
+	public function add_xcontent_type_options()
+	{
+		// Nothing to do !
+	}
 
 	public function output()
 	{

approot.inc.php

@@ -2,67 +2,19 @@
 
 define('APPROOT', dirname(__FILE__).'/');
 define('APPCONF', APPROOT.'conf/');
-define('ITOP_DEFAULT_ENV', 'production');
-define('MAINTENANCE_MODE_FILE', APPROOT.'data/.maintenance');
 
-if (function_exists('microtime'))
-{
-	$fItopStarted = microtime(true); 
-}
-else
-{
-	$fItopStarted = 1000 * time();
-}
-
-//
-// Maintenance mode
-//
-
-// Use 'maintenance' parameter to bypass maintenance mode
-if (!isset($bBypassMaintenance))
-{
-	$bBypassMaintenance = isset($_REQUEST['maintenance']) ? boolval($_REQUEST['maintenance']) : false;
-}
-
-if (file_exists(MAINTENANCE_MODE_FILE) && !$bBypassMaintenance)
-{
-	$sMessage = 'This application is currently under maintenance.';
-	$sTitle = 'Maintenance';
-
-	http_response_code(503);
-	// Display message depending on the request
-	include(APPROOT.'application/maintenancemsg.php');
-
-	switch (true)
-	{
-		case isset($_SERVER['REQUEST_URI']) && EndsWith($_SERVER['REQUEST_URI'], '/pages/ajax.searchform.php'):
-			_MaintenanceHtmlMessage($sMessage);
-			break;
-
-		case array_key_exists('HTTP_X_COMBODO_AJAX', $_SERVER):
-		case isset($_SERVER['REQUEST_URI']) && EndsWith($_SERVER['REQUEST_URI'], '/webservices/soapserver.php'):
-		case isset($_SERVER['REQUEST_URI']) && EndsWith($_SERVER['REQUEST_URI'], '/webservices/rest.php'):
-			_MaintenanceTextMessage($sMessage);
-			break;
-
-		case isset($_SERVER['CONTENT_TYPE']) && ($_SERVER['CONTENT_TYPE'] == 'application/json'):
-			_MaintenanceJsonMessage($sTitle, $sMessage);
-			break;
-
-		default:
-			_MaintenanceSetupPageMessage($sTitle, $sMessage);
-			break;
-	}
-	exit();
-}
 
 /**
- * helper to test if a string ends with another
- * @param $haystack
- * @param $needle
+ * Constant containing the iTop core version, whatever application was built
  *
- * @return bool
+ * Note that in iTop 3.0.0 we used {@see ITOP_DESIGN_LATEST_VERSION} to get core version.
+ * When releasing, both constants should be updated : see `.make/release/update-versions.php` for that !
+ *
+ * @since 2.7.7 3.0.1 3.1.0 N°4714 constant creation
+ * @used-by utils::GetItopVersionWikiSyntax()
+ * @used-by iTopModulesPhpVersionIntegrationTest
  */
-function EndsWith($haystack, $needle) {
-	return substr_compare($haystack, $needle, -strlen($needle)) === 0;
-}
+define('ITOP_CORE_VERSION', '2.7.12');
+
+
+require_once APPROOT.'bootstrap.inc.php';

bootstrap.inc.php

@@ -18,7 +18,70 @@
  * You should have received a copy of the GNU Affero General Public License
  */
 
-require_once __DIR__.'/approot.inc.php';
-require_once APPROOT.'/lib/autoload.php';
+define('ITOP_DEFAULT_ENV', 'production');
+define('MAINTENANCE_MODE_FILE', APPROOT.'data/.maintenance');
+define('READONLY_MODE_FILE', APPROOT.'data/.readonly');
 
-// Require here files containing PHP instructions
+$fItopStarted = microtime(true);
+$iItopInitialMemory = memory_get_usage(true);
+
+if (! isset($GLOBALS['bBypassAutoload']) || $GLOBALS['bBypassAutoload'] == false)
+{
+	require_once APPROOT.'/lib/autoload.php';
+}
+
+//
+// Maintenance mode
+//
+
+// Use 'maintenance' parameter to bypass maintenance mode
+if (!isset($bBypassMaintenance))
+{
+	$bBypassMaintenance = isset($_REQUEST['maintenance']) ? boolval($_REQUEST['maintenance']) : false;
+}
+
+if (file_exists(MAINTENANCE_MODE_FILE) && !$bBypassMaintenance)
+{
+	$sTitle = 'Maintenance';
+	$sMessage = 'This application is currently under maintenance.';
+
+	http_response_code(503);
+	// Display message depending on the request
+	include(APPROOT.'application/maintenancemsg.php');
+	$sSAPIName = strtoupper(trim(PHP_SAPI));
+
+	switch (true)
+	{
+		case isset($_SERVER['REQUEST_URI']) && EndsWith($_SERVER['REQUEST_URI'], '/pages/ajax.searchform.php'):
+			_MaintenanceHtmlMessage($sMessage);
+			break;
+
+		case $sSAPIName == 'CLI':
+		case array_key_exists('HTTP_X_COMBODO_AJAX', $_SERVER):
+		case isset($_SERVER['REQUEST_URI']) && (strpos($_SERVER['REQUEST_URI'], '/webservices/soapserver.php') !== false):
+		case isset($_SERVER['REQUEST_URI']) && (strpos($_SERVER['REQUEST_URI'], '/webservices/export-v2.php') !== false):
+			_MaintenanceTextMessage($sMessage);
+			break;
+
+		case isset($_SERVER['REQUEST_URI']) && (strpos($_SERVER['REQUEST_URI'], '/webservices/rest.php') !== false):
+		case isset($_SERVER['CONTENT_TYPE']) && ($_SERVER['CONTENT_TYPE'] == 'application/json'):
+			_MaintenanceJsonMessage($sTitle, $sMessage);
+			break;
+
+		default:
+			_MaintenanceSetupPageMessage($sTitle, $sMessage);
+			break;
+	}
+	exit();
+}
+
+/**
+ * helper to test if a string ends with another
+ * @param $haystack
+ * @param $needle
+ *
+ * @return bool
+ */
+function EndsWith($haystack, $needle) {
+	return substr_compare($haystack, $needle, -strlen($needle)) === 0;
+}

composer.json

@@ -1,32 +1,40 @@
 {
+  "name": "combodo/itop",
+  "description": "IT Operations Portal",
   "type": "project",
-  "license": "AGPLv3",
+  "license": "AGPL-3.0-only",
   "require": {
-    "php": ">=5.6.0",
-    "ext-soap": "*",
+    "php": ">=7.1.3",
+    "ext-ctype": "*",
+    "ext-dom": "*",
+    "ext-gd": "*",
+    "ext-iconv": "*",
     "ext-json": "*",
     "ext-mysqli": "*",
-    "ext-dom": "*",
-    "ext-iconv": "*",
-    "ext-gd": "*",
-    "ext-ctype": "*",
-
-    "scssphp/scssphp": "1.0.0",
-    "swiftmailer/swiftmailer": "5.4.9",
-    "pelago/emogrifier": "2.1.0",
-    "combodo/tcpdf": "6.3.0",
-    "pear/archive_tar": "1.4.7",
-
-    "symfony/console": "3.4.*",
-    "symfony/dotenv": "3.4.*",
-    "symfony/framework-bundle": "3.4.*",
-    "symfony/twig-bundle": "3.4.*",
-    "symfony/yaml": "3.4.*",
-    "symfony/polyfill-php70": "1.*"
+    "ext-soap": "*",
+    "combodo/tcpdf": "~6.4.4",
+    "firebase/php-jwt": "~6.4.0",
+    "guzzlehttp/guzzle": "^6.5.8",
+    "guzzlehttp/psr7": "~1.9.1",
+    "laminas/laminas-mail": "^2.11",
+    "laminas/laminas-servicemanager": "^3.5",
+    "league/oauth2-google": "^3.0",
+    "nikic/php-parser": "~4.13.2",
+    "pear/archive_tar": "~1.4.14",
+    "pelago/emogrifier": "~3.1.0",
+    "scssphp/scssphp": "1.0.6",
+    "swiftmailer/swiftmailer": "~6.3.0",
+    "symfony/console": "~3.4.47",
+    "symfony/dotenv": "~3.4.47",
+    "symfony/framework-bundle": "~3.4.47",
+    "symfony/twig-bundle": "~3.4.47",
+    "symfony/yaml": "~3.4.47",
+    "thenetworg/oauth2-azure": "^2.0",
+    "twig/twig": "~1.42.5"
   },
   "require-dev": {
-    "symfony/stopwatch": "3.4.*",
-    "symfony/web-profiler-bundle": "3.4.*"
+    "symfony/stopwatch": "~3.4.47",
+    "symfony/web-profiler-bundle": "~3.4.47"
   },
   "suggest": {
     "ext-libsodium": "Required to use the AttributeEncryptedString.",
@@ -38,18 +46,24 @@
   },
   "config": {
     "platform": {
-      "php": "5.6.0"
+      "php": "7.1.3"
     },
     "vendor-dir": "lib",
     "preferred-install": {
       "*": "dist"
     },
-    "sort-packages": true
+    "sort-packages": true,
+    "classmap-authoritative": true
   },
   "autoload": {
     "classmap": [
       "core",
-      "application"
+      "application",
+      "sources/application",
+      "sources/Composer",
+      "sources/Controller",
+      "sources/Service",
+      "sources/Core"
     ],
     "exclude-from-classmap": [
       "core/dbobjectsearch.class.php",
@@ -73,5 +87,10 @@
       "allow-contrib": false,
       "require": "3.4.*"
     }
+  },
+  "scripts": {
+    "post-install-cmd": ["@rmDeniedTestDir"],
+    "post-update-cmd": ["@rmDeniedTestDir"],
+    "rmDeniedTestDir":  "@php .make/composer/rmDeniedTestDir.php"
   }
-}
+}

composer.readme

@@ -0,0 +1,2 @@
+To regenerate the autoload, run:
+composer dump-autoload -a

conf/web.config

@@ -1,8 +1,13 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
-  <system.web>
-          <authorization>
-                  <deny users="*" /> <!-- Denies all users -->
-          </authorization>
-  </system.web>
+  <system.webServer>
+    <security>
+      <requestFiltering>
+         <fileExtensions applyToWebDAV="false" allowUnlisted="false"></fileExtensions>
+      </requestFiltering>
+      <authorization>
+        <deny users="*" /> <!-- Denies all users -->
+      </authorization>
+    </security>
+  </system.webServer>
 </configuration>

core/MyHelpers.class.inc.php

@@ -67,8 +67,7 @@ class MyHelpers
 	// format sss.mmmuuupppnnn 
 	public static function getmicrotime()
 	{ 
-		list($usec, $sec) = explode(" ",microtime()); 
-		return ((float)$usec + (float)$sec); 
+		return microtime(true);
 	}
 
 	/*
@@ -420,6 +419,7 @@ class MyHelpers
 		//}
 		return $sOutput;
 	}
+
 }
 
 /**
@@ -457,7 +457,7 @@ class Str
 	public static function gpc2pure($gpc)
 	{
 		if (ini_get('magic_quotes_sybase')) $pure = str_replace("''", "'", $gpc);
-		else                                $pure = get_magic_quotes_gpc() ? stripslashes($gpc) : $gpc;
+		else                                $pure = $gpc;
 		return $pure;
 	}
 	public static function html2pure($html)
@@ -524,5 +524,3 @@ class Str
 		return (strtolower($sString) == $sString);
 	}
 }
-
-?>

core/action.class.inc.php

@@ -179,7 +179,7 @@ class ActionEmail extends ActionNotification
 	protected function FindRecipients($sRecipAttCode, $aArgs)
 	{
 		$sOQL = $this->Get($sRecipAttCode);
-		if (strlen($sOQL) == '') return '';
+		if (strlen($sOQL) === 0) return '';
 
 		try
 		{
@@ -314,42 +314,58 @@ class ActionEmail extends ActionNotification
 		{
 			$this->m_iRecipients = 0;
 			$this->m_aMailErrors = array();
-			$bRes = false; // until we do succeed in sending the email
-	
+
 			// Determine recicipients
 			//
 			$sTo = $this->FindRecipients('to', $aContextArgs);
 			$sCC = $this->FindRecipients('cc', $aContextArgs);
 			$sBCC = $this->FindRecipients('bcc', $aContextArgs);
-	
+
 			$sFrom = MetaModel::ApplyParams($this->Get('from'), $aContextArgs);
 			$sReplyTo = MetaModel::ApplyParams($this->Get('reply_to'), $aContextArgs);
-	
+
 			$sSubject = MetaModel::ApplyParams($this->Get('subject'), $aContextArgs);
 			$sBody = MetaModel::ApplyParams($this->Get('body'), $aContextArgs);
-			
+
 			$oObj = $aContextArgs['this->object()'];
-			$sMessageId = sprintf('iTop_%s_%d_%f@%s.openitop.org', get_class($oObj), $oObj->GetKey(), microtime(true /* get as float*/), MetaModel::GetEnvironmentId());
+			$sMessageId = sprintf('iTop_%s_%d_%F@%s.openitop.org',
+				get_class($oObj),
+				$oObj->GetKey(),
+				microtime(true /* get as float*/),
+				MetaModel::GetEnvironmentId()
+			);
 			$sReference = '<'.$sMessageId.'>';
 		}
-		catch(Exception $e)
-		{
-  			ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker);
-  			throw $e;
-  		}
-		ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker);
-		
-		if (!is_null($oLog))
-		{
+		catch (Exception $e) {
+			/** @noinspection PhpUnhandledExceptionInspection */
+			throw $e;
+		}
+		finally {
+			ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker);
+		}
+
+		if (!is_null($oLog)) {
 			// Note: we have to secure this because those values are calculated
 			// inside the try statement, and we would like to keep track of as
 			// many data as we could while some variables may still be undefined
-			if (isset($sTo))       $oLog->Set('to', $sTo);
-			if (isset($sCC))       $oLog->Set('cc', $sCC);
-			if (isset($sBCC))      $oLog->Set('bcc', $sBCC);
-			if (isset($sFrom))     $oLog->Set('from', $sFrom);
-			if (isset($sSubject))  $oLog->Set('subject', $sSubject);
-			if (isset($sBody))     $oLog->Set('body', $sBody);
+			if (isset($sTo)) {
+				$oLog->Set('to', $sTo);
+			}
+			if (isset($sCC)) {
+				$oLog->Set('cc', $sCC);
+			}
+			if (isset($sBCC)) {
+				$oLog->Set('bcc', $sBCC);
+			}
+			if (isset($sFrom)) {
+				$oLog->Set('from', $sFrom);
+			}
+			if (isset($sSubject)) {
+				$oLog->Set('subject', $sSubject);
+			}
+			if (isset($sBody)) {
+				$oLog->Set('body', $sBody);
+			}
 		}
 		$sStyles = file_get_contents(APPROOT.'css/email.css');
 		$sStyles .= MetaModel::GetConfig()->Get('email_css');
@@ -439,4 +455,3 @@ class ActionEmail extends ActionNotification
 		}
 	}
 }
-?>

core/apc-service.class.inc.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * Class ApcService
+ * @since 2.7.6 N°4125
+ */
+class ApcService {
+	public function __construct() {
+	}
+
+	/**
+	 * @param string $function_name
+	 * @return bool
+	 * @see function_exists()
+	 */
+	public function function_exists($function_name) {
+		return function_exists($function_name);
+	}
+
+	/**
+	 * @param string|array $key
+	 * @return mixed
+	 * @see apc_fetch()
+	 */
+	function apc_fetch($key)
+	{
+		return apc_fetch($key);
+	}
+
+	/**
+	 * @param array|string $key
+	 * @param $var
+	 * @param int $ttl
+	 * @return array|bool
+	 * @see apc_store()
+	 */
+	function apc_store($key, $var = NULL, $ttl = 0)
+	{
+		return apc_store($key, $var, $ttl);
+	}
+}
+?>

core/asynctask.class.inc.php

@@ -230,7 +230,7 @@ abstract class AsyncTask extends DBObject
 			$this->Set('remaining_retries', $this->GetMaxRetries($iErrorCode));
 		}
 
-		$this->Set('last_error', $sErrorMessage);
+		$this->SetTrim('last_error', $sErrorMessage);
 		$this->Set('last_error_code', $iErrorCode); // Note: can be ZERO !!!
 		$this->Set('last_attempt', time());
 

core/autoload.php

@@ -33,6 +33,7 @@ MetaModel::IncludeModule('core/tagsetfield.class.inc.php');
 MetaModel::IncludeModule('synchro/synchrodatasource.class.inc.php');
 MetaModel::IncludeModule('core/backgroundtask.class.inc.php');
 MetaModel::IncludeModule('core/inlineimage.class.inc.php');
+MetaModel::IncludeModule('core/counter.class.inc.php');
 
 MetaModel::IncludeModule('webservices/webservices.basic.php');
 

core/backgroundprocess.inc.php

@@ -1,29 +1,23 @@
 <?php
-// Copyright (C) 2010-2013 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/>
-
-
 /**
- * interface iProcess
- * Something that can be executed 
+ * Copyright (C) 2010-2020 Combodo SARL
  *
- * @copyright   Copyright (C) 2010-2012 Combodo SARL
- * @license     http://opensource.org/licenses/AGPL-3.0
+ * 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
  */
+
+
 interface iProcess
 {
 	/**
@@ -56,8 +50,9 @@ interface iBackgroundProcess extends iProcess
  * interface iScheduledProcess
  * A variant of process that must be called at specific times
  *
- * @copyright   Copyright (C) 2013 Combodo SARL
+ * @see \AbstractWeeklyScheduledProcess for a bootstrap implementation
  * @license     http://opensource.org/licenses/AGPL-3.0
+ * @copyright   Copyright (C) 2013 Combodo SARL
  */
 interface iScheduledProcess extends iProcess
 {
@@ -67,22 +62,226 @@ interface iScheduledProcess extends iProcess
 	public function GetNextOccurrence();
 }
 
+
 /**
- * Class ProcessException
- * Exception for iProcess implementations.<br>
+ * Implementation of {@link iScheduledProcess}, using config parameters for module
+ *
+ * Use these parameters :
+ *
+ * * enabled
+ * * week_days
+ * * time
+ *
+ * Param names and some of their default values are in constant that can be overridden.
+ *
+ * Other info (module name and time default value) should be provided using a method that needs to be implemented.
+ *
+ * @since 2.7.0 PR #89
+ * @since 2.7.0-2 N°2580 Fix {@link GetNextOccurrence} returning wrong value
+ */
+abstract class AbstractWeeklyScheduledProcess implements iScheduledProcess
+{
+	// param have default names/values but can be overridden
+	const MODULE_SETTING_ENABLED = 'enabled';
+	const DEFAULT_MODULE_SETTING_ENABLED = true;
+	const MODULE_SETTING_WEEKDAYS = 'week_days';
+	const DEFAULT_MODULE_SETTING_WEEKDAYS = 'monday, tuesday, wednesday, thursday, friday, saturday, sunday';
+	const MODULE_SETTING_TIME = 'time';
+
+	/**
+	 * @var Config can be used to mock config for tests
+	 */
+	protected $oConfig;
+
+	/**
+	 * Module must be declared in each implementation
+	 *
+	 * @return string
+	 */
+	abstract protected function GetModuleName();
+
+	/**
+	 * @return string default value for {@link MODULE_SETTING_TIME} config param.
+	 *         example '23:30'
+	 */
+	abstract protected function GetDefaultModuleSettingTime();
+
+	/**
+	 * @return \Config
+	 */
+	public function getOConfig()
+	{
+		if (!isset($this->oConfig))
+		{
+			$this->oConfig = MetaModel::GetConfig();
+		}
+
+		return $this->oConfig;
+	}
+
+
+	/**
+	 * Interpret current setting for the week days
+	 *
+	 * @returns int[] (monday = 1)
+	 * @throws ProcessInvalidConfigException
+	 */
+	public function InterpretWeekDays()
+	{
+		static $aWEEKDAYTON = array(
+			'monday' => 1,
+			'tuesday' => 2,
+			'wednesday' => 3,
+			'thursday' => 4,
+			'friday' => 5,
+			'saturday' => 6,
+			'sunday' => 7,
+		);
+		$aDays = array();
+		$sWeekDays = $this->getOConfig()->GetModuleSetting(
+			$this->GetModuleName(),
+			static::MODULE_SETTING_WEEKDAYS,
+			static::DEFAULT_MODULE_SETTING_WEEKDAYS
+		);
+
+		if ($sWeekDays !== '')
+		{
+			$aWeekDaysRaw = explode(',', $sWeekDays);
+			foreach ($aWeekDaysRaw as $sWeekDay)
+			{
+				$sWeekDay = strtolower(trim($sWeekDay));
+				if (array_key_exists($sWeekDay, $aWEEKDAYTON))
+				{
+					$aDays[] = $aWEEKDAYTON[$sWeekDay];
+				}
+				else
+				{
+					throw new ProcessInvalidConfigException($this->GetModuleName().": wrong format for setting '".static::MODULE_SETTING_WEEKDAYS."' (found '$sWeekDay')");
+				}
+			}
+		}
+		if (count($aDays) === 0)
+		{
+			throw new ProcessInvalidConfigException($this->GetModuleName().': missing setting \''.static::MODULE_SETTING_WEEKDAYS.'\'');
+		}
+		$aDays = array_unique($aDays);
+		sort($aDays);
+
+		return $aDays;
+	}
+
+	/**
+	 * @param string $sCurrentTime Date string to extract time dependency
+	 *      this parameter is not present in the interface but as it is optional it's ok
+	 *
+	 * @return DateTime the exact time at which the process must be run next time
+	 * @throws \ProcessInvalidConfigException
+	 */
+	public function GetNextOccurrence($sCurrentTime = 'now')
+	{
+		$bEnabled = $this->getOConfig()->GetModuleSetting(
+			$this->GetModuleName(),
+			static::MODULE_SETTING_ENABLED,
+			static::DEFAULT_MODULE_SETTING_ENABLED
+		);
+
+		$sItopTimeZone = $this->getOConfig()->Get('timezone');
+		$timezone = new DateTimeZone($sItopTimeZone);
+
+		if (!$bEnabled)
+		{
+			return new DateTime('3000-01-01', $timezone);
+		}
+
+		// 1st - Interpret the list of days as ordered numbers (monday = 1)
+		//
+		$aDays = $this->InterpretWeekDays();
+
+		// 2nd - Find the next active week day
+		//
+		$sProcessTime = $this->getOConfig()->GetModuleSetting(
+			$this->GetModuleName(),
+			static::MODULE_SETTING_TIME,
+			static::GetDefaultModuleSettingTime()
+		);
+		if (!preg_match('/[0-2]\d:[0-5]\d/', $sProcessTime))
+		{
+			throw new ProcessInvalidConfigException($this->GetModuleName().": wrong format for setting '".static::MODULE_SETTING_TIME."' (found '$sProcessTime')");
+		}
+
+		$oNow = new DateTime($sCurrentTime, $timezone);
+		$iNextPos = false;
+		$sDay = $oNow->format('N');
+		for ($iDay = (int) $sDay; $iDay <= 7; $iDay++)
+		{
+			$iNextPos = array_search($iDay, $aDays, true);
+			if ($iNextPos !== false)
+			{
+				if (($iDay > $oNow->format('N')) || ($oNow->format('H:i') < $sProcessTime))
+				{
+					break;
+				}
+				$iNextPos = false; // necessary on sundays
+			}
+		}
+
+		// 3rd - Compute the result
+		//
+		if ($iNextPos === false)
+		{
+			// Jump to the first day within the next week
+			$iFirstDayOfWeek = $aDays[0];
+			$iDayMove = $oNow->format('N') - $iFirstDayOfWeek;
+			$oRet = clone $oNow;
+			$oRet->modify('-'.$iDayMove.' days');
+			$oRet->modify('+1 weeks');
+		}
+		else
+		{
+			$iNextDayOfWeek = $aDays[$iNextPos];
+			$iMove = $iNextDayOfWeek - $oNow->format('N');
+			$oRet = clone $oNow;
+			$oRet->modify('+'.$iMove.' days');
+		}
+		list($sHours, $sMinutes) = explode(':', $sProcessTime);
+		/** @noinspection PhpElementIsNotAvailableInCurrentPhpVersionInspection non used new parameter in PHP 7.1 */
+		$oRet->setTime((int)$sHours, (int)$sMinutes);
+
+		return $oRet;
+	}
+
+	/**
+	 * @see \iProcess
+	 *
+	 * @param int $iUnixTimeLimit
+	 *
+	 * @return string
+	 */
+	abstract public function Process($iUnixTimeLimit);
+}
+
+/**
+ * Exception for {@link iProcess} implementations.<br>
  * An error happened during the processing but we can go on with the next implementations.
+ * @since 2.5.0 N°1195
  */
 class ProcessException extends CoreException
 {
+}
 
+/**
+ * @since 2.7.0 PR #89
+ */
+class ProcessInvalidConfigException extends ProcessException
+{
 }
 
 /**
  * Class ProcessFatalException
  * Exception for iProcess implementations.<br>
  * A big error occurred, we have to stop the iProcess processing.
+ * @since 2.5.0 N°1195
  */
 class ProcessFatalException extends CoreException
 {
-
 }

core/backgroundtask.class.inc.php

@@ -26,6 +26,24 @@
  */
 class BackgroundTask extends DBObject
 {
+	protected $bDebug = false;
+
+	/**
+	 * @return bool
+	 */
+	public function IsDebug()
+	{
+		return $this->bDebug;
+	}
+
+	/**
+	 * @param bool $bDebug
+	 */
+	public function SetDebug($bDebug)
+	{
+		$this->bDebug = $bDebug;
+	}
+
 	public static function Init()
 	{
 		$aParams = array

core/bulkchange.class.inc.php

@@ -309,7 +309,7 @@ class BulkChange
 				$value = $oForeignAtt->MakeValueFromString($aRowData[$iCol], $this->m_bLocalizedValues);
 			}
 			$oReconFilter->AddCondition($sForeignAttCode, $value, '=');
-			$aResults[$iCol] = new CellStatus_Void($aRowData[$iCol]);
+			$aResults[$iCol] = new CellStatus_Void(utils::HtmlEntities($aRowData[$iCol]));
 		}
 
 		$oExtObjects = new CMDBObjectSet($oReconFilter);
@@ -363,6 +363,7 @@ class BulkChange
 				foreach ($aKeyConfig as $sForeignAttCode => $iCol)
 				{
 					// Default reporting
+					// $aRowData[$iCol] is always null
 					$aResults[$iCol] = new CellStatus_Void($aRowData[$iCol]);
 				}
 				if ($oExtKey->IsNullAllowed())
@@ -395,7 +396,7 @@ class BulkChange
 					}
 					$aCacheKeys[] = $value;
 					$oReconFilter->AddCondition($sForeignAttCode, $value, '=');
-					$aResults[$iCol] = new CellStatus_Void($aRowData[$iCol]);
+					$aResults[$iCol] = new CellStatus_Void(utils::HtmlEntities($aRowData[$iCol]));
 				}
 				$sCacheKey = implode('_|_', $aCacheKeys); // Unique key for this query...
 				$iForeignKey = null;
@@ -465,7 +466,7 @@ class BulkChange
 						foreach ($aKeyConfig as $sForeignAttCode => $iCol)
 						{
 							// Report the change on reconciliation values as well
-							$aResults[$iCol] = new CellStatus_Modify($aRowData[$iCol]);
+							$aResults[$iCol] = new CellStatus_Modify(utils::HtmlEntities($aRowData[$iCol]));
 						}
 					}
 				}
@@ -538,7 +539,7 @@ class BulkChange
 		{
 			if ($sAttCode == 'id')
 			{
-				$aResults[$iCol]= new CellStatus_Void($aRowData[$iCol]);
+				$aResults[$iCol]= new CellStatus_Void(utils::HtmlEntities($aRowData[$iCol]));
 			}
 			else
 			{
@@ -554,7 +555,7 @@ class BulkChange
 				}
 				if (isset($aErrors[$sAttCode]))
 				{
-					$aResults[$iCol]= new CellStatus_Issue($aRowData[$iCol], $sOrigValue, $aErrors[$sAttCode]);
+					$aResults[$iCol]= new CellStatus_Issue(utils::HtmlEntities($aRowData[$iCol]), $sOrigValue, $aErrors[$sAttCode]);
 				}
 				elseif (array_key_exists($sAttCode, $aChangedFields))
 				{
@@ -577,7 +578,7 @@ class BulkChange
 					}
 					else
 					{
-						$aResults[$iCol]= new CellStatus_Void($aRowData[$iCol]);
+						$aResults[$iCol]= new CellStatus_Void(utils::HtmlEntities($aRowData[$iCol]));
 					}
 				}
 			}
@@ -654,7 +655,7 @@ class BulkChange
 		return $aResults;
 	}
 
-	
+
 	protected function CreateObject(&$aResult, $iRow, $aRowData, CMDBChange $oChange = null)
 	{
 		$oTargetObj = MetaModel::NewObject($this->m_sClass);
@@ -726,25 +727,38 @@ class BulkChange
 			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue(Dict::Format('UI:CSVReport-Row-Issue-MissingExtKey', $sMissingKeys));
 			return $oTargetObj;
 		}
-	
-		// Optionaly record the results
+
+		// Optionally record the results
 		//
 		if ($oChange)
 		{
-			$newID = $oTargetObj->DBInsertTrackedNoReload($oChange);
-			$aResult[$iRow]["__STATUS__"] = new RowStatus_NewObj();
-			$aResult[$iRow]["finalclass"] = get_class($oTargetObj);
-			$aResult[$iRow]["id"] = new CellStatus_Void($newID);
+			$newID = $oTargetObj->DBInsert();
 		}
 		else
 		{
-			$aResult[$iRow]["__STATUS__"] = new RowStatus_NewObj();
-			$aResult[$iRow]["finalclass"] = get_class($oTargetObj);
-			$aResult[$iRow]["id"] = new CellStatus_Void(0);
+			$newID = 0;
 		}
+
+		$aResult[$iRow]["__STATUS__"] = new RowStatus_NewObj();
+		$aResult[$iRow]["finalclass"] = get_class($oTargetObj);
+		$aResult[$iRow]["id"] = new CellStatus_Void($newID);
+
 		return $oTargetObj;
 	}
-	
+
+	/**
+	 * @param array $aResult
+	 * @param int $iRow
+	 * @param \CMDBObject $oTargetObj
+	 * @param array $aRowData
+	 * @param \CMDBChange $oChange
+	 *
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MissingQueryArgument
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 */
 	protected function UpdateObject(&$aResult, $iRow, $oTargetObj, $aRowData, CMDBChange $oChange = null)
 	{
 		$aResult[$iRow] = $this->PrepareObject($oTargetObj, $aRowData, $aErrors);
@@ -772,7 +786,7 @@ class BulkChange
 			{
 				try
 				{
-					$oTargetObj->DBUpdateTracked($oChange);
+					$oTargetObj->DBUpdate();
 				}
 				catch(CoreException $e)
 				{
@@ -786,6 +800,14 @@ class BulkChange
 		}
 	}
 
+	/**
+	 * @param array $aResult
+	 * @param int $iRow
+	 * @param \CMDBObject $oTargetObj
+	 * @param \CMDBChange $oChange
+	 *
+	 * @throws \BulkChangeException
+	 */
 	protected function UpdateMissingObject(&$aResult, $iRow, $oTargetObj, CMDBChange $oChange = null)
 	{
 		$aResult[$iRow] = $this->PrepareMissingObject($oTargetObj, $aErrors);
@@ -813,7 +835,7 @@ class BulkChange
 			{
 				try
 				{
-					$oTargetObj->DBUpdateTracked($oChange);
+					$oTargetObj->DBUpdate();
 				}
 				catch(CoreException $e)
 				{
@@ -829,6 +851,11 @@ class BulkChange
 	
 	public function Process(CMDBChange $oChange = null)
 	{
+		if ($oChange)
+		{
+			CMDBObject::SetCurrentChange($oChange);
+		}
+
 		// Note: $oChange can be null, in which case the aim is to check what would be done
 
 		// Debug...
@@ -898,7 +925,7 @@ class BulkChange
 								{
 									// Leave the cell unchanged
 									$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-DateFormat'));
-									$aResult[$iRow][$sAttCode] = new CellStatus_Issue(null, $this->m_aData[$iRow][$iCol], Dict::S('UI:CSVReport-Row-Issue-DateFormat'));
+									$aResult[$iRow][$sAttCode] = new CellStatus_Issue(null, utils::HtmlEntities($this->m_aData[$iRow][$iCol]), Dict::S('UI:CSVReport-Row-Issue-DateFormat'));
 								}
 							}
 						}
@@ -1056,7 +1083,7 @@ class BulkChange
 			{
 				if (!array_key_exists($iCol, $aResult[$iRow]))
 				{
-					$aResult[$iRow][$iCol] = new CellStatus_Void($aRowData[$iCol]);
+					$aResult[$iRow][$iCol] = new CellStatus_Void(utils::HtmlEntities($aRowData[$iCol]));
 				}
 			}
 			foreach($this->m_aExtKeys as $sAttCode => $aForeignAtts)
@@ -1070,7 +1097,7 @@ class BulkChange
 					if (!array_key_exists($iCol, $aResult[$iRow]))
 					{
 						// The foreign attribute is one of our reconciliation key
-						$aResult[$iRow][$iCol] = new CellStatus_Void($aRowData[$iCol]);
+						$aResult[$iRow][$iCol] = new CellStatus_Void(utils::HtmlEntities($aRowData[$iCol]));
 					}
 				}
 			}

core/bulkexport.class.inc.php

@@ -1,20 +1,21 @@
 <?php
-// Copyright (C) 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/>
+/**
+ * Copyright (C) 2013-2019 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
+ */
 
 define('EXPORTER_DEFAULT_CHUNK_SIZE', 1000);
 
@@ -109,7 +110,7 @@ class BulkExportResultGC implements iBackgroundProcess
 		{
 			// Next one ?
 			$oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL), array('created' => true) /* order by*/, array(), null, 1 /* limit count */);
-			$oSet->OptimizeColumnLoad(array('temp_file_path'));
+			$oSet->OptimizeColumnLoad(array('BulkExportResult' => array('temp_file_path')));
 			$oResult = $oSet->Fetch();
 			if (is_null($oResult))
 			{
@@ -148,7 +149,9 @@ abstract class BulkExport
 		$this->oSearch = null;
 		$this->iChunkSize = 0;
 		$this->sFormatCode = null;
-		$this->aStatusInfo = array();
+		$this->aStatusInfo = [
+			'show_obsolete_data' => utils::ShowObsoleteData(),
+		];
 		$this->oBulkExportResult = null;
 		$this->sTmpFile = '';
 		$this->bLocalizeOutput = false;
@@ -170,6 +173,7 @@ abstract class BulkExport
 			$oRefClass = new ReflectionClass($sPHPClass);
 			if ($oRefClass->isSubclassOf('BulkExport') && !$oRefClass->isAbstract())
 			{
+				/** @var BulkExport $oBulkExporter */
 				$oBulkExporter = new $sPHPClass();
 				if ($oBulkExporter->IsFormatSupported($sFormatCode, $oSearch))
 				{
@@ -189,7 +193,7 @@ abstract class BulkExport
      *
      * @param int $iPersistentToken The identifier of the BulkExportResult object storing the information
      *
-     * @return iBulkExport|null
+     * @return BulkExport|null
      * @throws ArchivedObjectException
      * @throws CoreException
      * @throws ReflectionException
@@ -201,15 +205,17 @@ abstract class BulkExport
 		if ($oInfo && ($oInfo->Get('user_id') == UserRights::GetUserId()))
 		{
 			$sFormatCode = $oInfo->Get('format');
-			$oSearch = DBObjectSearch::unserialize($oInfo->Get('search'));
+			$aStatusInfo = json_decode($oInfo->Get('status_info'),true);
 
+			$oSearch = DBObjectSearch::unserialize($oInfo->Get('search'));
+			$oSearch->SetShowObsoleteData($aStatusInfo['show_obsolete_data']);
 			$oBulkExporter = self::FindExporter($sFormatCode, $oSearch);
 			if ($oBulkExporter)
 			{
 				$oBulkExporter->SetFormat($sFormatCode);
 				$oBulkExporter->SetObjectList($oSearch);
 				$oBulkExporter->SetChunkSize($oInfo->Get('chunk_size'));
-				$oBulkExporter->SetStatusInfo(json_decode($oInfo->Get('status_info'), true));
+				$oBulkExporter->SetStatusInfo($aStatusInfo);
 
                 $oBulkExporter->SetLocalizeOutput($oInfo->Get('localize_output'));
 
@@ -287,6 +293,7 @@ abstract class BulkExport
 	 */
 	public function SetObjectList(DBSearch $oSearch)
 	{
+		$oSearch->SetShowObsoleteData($this->aStatusInfo['show_obsolete_data']);
 		$this->oSearch = $oSearch;
 	}
 	
@@ -343,10 +350,10 @@ abstract class BulkExport
 			$this->oBulkExportResult->Set('format', $this->sFormatCode);
 			$this->oBulkExportResult->Set('search', $this->oSearch->serialize());
 			$this->oBulkExportResult->Set('chunk_size', $this->iChunkSize);
-            $this->oBulkExportResult->Set('temp_file_path', $this->sTmpFile);
             $this->oBulkExportResult->Set('localize_output', $this->bLocalizeOutput);
         }
 		$this->oBulkExportResult->Set('status_info', json_encode($this->GetStatusInfo()));
+		$this->oBulkExportResult->Set('temp_file_path', $this->sTmpFile);
 		utils::PushArchiveMode(false);
 		$ret = $this->oBulkExportResult->DBWrite();
 		utils::PopArchiveMode();
@@ -418,6 +425,11 @@ abstract class BulkExport
 	public function GetStatistics()
 	{
 		
+	}
+
+	public function SetFields($sFields)
+	{
+
 	}
 	
 	public function GetDownloadFileName()

core/cmdbchangeop.class.inc.php

@@ -63,22 +63,30 @@ class CMDBChangeOp extends DBObject
 
 	/**
 	 * Describe (as a text string) the modifications corresponding to this change
-	 */	 
+	 */
 	public function GetDescription()
 	{
 		return '';
 	}
 
 	/**
-	 * Safety net: in case the change is not given, let's guarantee that it will
-	 * be set to the current ongoing change (or create a new one)	
-	 */	
+	 * Safety net:
+	 * * if change isn't persisted yet, use the current change and persist it if needed
+	 * * in case the change is not given, let's guarantee that it will be set to the current ongoing change (or create a new one)
+	 *
+	 * @since 2.7.7 3.0.2 3.1.0 N°3717 do persist the current change if needed
+	 */
 	protected function OnInsert()
 	{
-		if ($this->Get('change') <= 0)
-		{
-			$this->Set('change', CMDBObject::GetCurrentChange());
+		$iChange = $this->Get('change');
+		if (($iChange <= 0) || (is_null($iChange))) {
+			$oChange = CMDBObject::GetCurrentChange();
+			if ($oChange->IsNew()) {
+				$oChange->DBWrite();
+			}
+			$this->Set('change', $oChange);
 		}
+
 		parent::OnInsert();
 	}
 }
@@ -544,7 +552,7 @@ class CMDBChangeOpSetAttributeEncrypted extends CMDBChangeOpSetAttribute
 				// The attribute was renamed or removed from the object ?
 				$sAttName = $this->Get('attcode');
 			}
-			$sPrevString = $this->Get('prevstring');
+			$sPrevString = $this->GetAsHTML('prevstring');
 			$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sPrevString);
 		}
 		return $sResult;

core/cmdbobject.class.inc.php

@@ -95,15 +95,45 @@ abstract class CMDBObject extends DBObject
 	protected static $m_oCurrChange = null;
 	protected static $m_sInfo = null; // null => the information is built in a standard way
 	protected static $m_sOrigin = null; // null => the origin is 'interactive'
-	
+
 	/**
-	 * Specify another change (this is mainly for backward compatibility)
+	 * Specify the change to be used by the API to attach any CMDBChangeOp* object created
+	 *
+	 * @see SetTrackInfo if CurrentChange is null, then a new one will be create using trackinfo
+	 *
+	 * @param CMDBChange|null $oChange use null so that the API will recreate a new CMDBChange using TrackInfo & TrackOrigin
+	 *     If providing a CMDBChange, you should persist it first ! Indeed the API will automatically create CMDBChangeOp (see
+	 *     \CMDBObject::RecordObjCreation / RecordAttChange / RecordObjDeletion for example) and link them to the current change : in
+	 *     consequence this CMDBChange must have a key set !
+	 *
+	 * @since 2.7.2 N°3219 can now reset CMDBChange by passing null
+	 * @since 2.7.2 N°3218 PHPDoc about persisting the $oChange parameter first
 	 */
-	public static function SetCurrentChange(CMDBChange $oChange)
+	public static function SetCurrentChange($oChange)
 	{
 		self::$m_oCurrChange = $oChange;
 	}
 
+	/**
+	 * @param string $sUserInfo
+	 * @param string $sOrigin
+	 * @param \DateTime $oDate
+	 *
+	 * @throws \CoreException
+	 *
+	 * @since 2.7.7 3.0.2 3.1.0 N°3717 new method to reset current change
+	 */
+	public static function SetCurrentChangeFromParams($sUserInfo, $sOrigin = null, $oDate = null)
+	{
+		static::SetTrackInfo($sUserInfo);
+		static::SetTrackOrigin($sOrigin);
+		static::CreateChange();
+
+		if (!is_null($oDate)) {
+			static::$m_oCurrChange->Set("date", $oDate);
+		}
+	}
+
 	//
 	// Todo: simplify the APIs and do not pass the current change as an argument anymore
 	//       SetTrackInfo to be invoked in very few cases (UI.php, CSV import, Data synchro)
@@ -112,7 +142,11 @@ abstract class CMDBObject extends DBObject
 	//			GetCurrentChange to create a default change if not already done in the current context
 	//
 	/**
-	 * Get a change record (create it if not existing)	 
+	 * @param bool $bAutoCreate if true calls {@link CreateChange} to get a new persisted object
+	 *
+	 * @return \CMDBChange
+	 *
+	 * @uses CreateChange
 	 */
 	public static function GetCurrentChange($bAutoCreate = true)
 	{
@@ -126,11 +160,17 @@ abstract class CMDBObject extends DBObject
 	/**
 	 * Override the additional information (defaulting to user name)
 	 * A call to this verb should replace every occurence of
-	 *    $oMyChange = MetaModel::NewObject("CMDBChange");	  	 
+	 *    $oMyChange = MetaModel::NewObject("CMDBChange");
 	 *    $oMyChange->Set("date", time());
 	 *    $oMyChange->Set("userinfo", 'this is done by ... for ...');
 	 *    $iChangeId = $oMyChange->DBInsert();
-	 */	 	
+	 *
+	 * **warning** : this will do nothing if current change already exists !
+	 *
+	 * @see SetCurrentChange to specify a CMDBObject instance instead
+	 *
+	 * @param string $sInfo
+	 */
 	public static function SetTrackInfo($sInfo)
 	{
 		self::$m_sInfo = $sInfo;
@@ -138,24 +178,28 @@ abstract class CMDBObject extends DBObject
 
 	/**
 	 * Provides information about the origin of the change
-	 * @param $sOrigin String: one of: interactive, csv-interactive, csv-import.php, webservice-soap, webservice-rest, syncho-data-source, email-processing, custom-extension
-	 */	 	
+	 *
+	 * **warning** : this will do nothing if current change already exists !
+	 *
+	 * @see SetTrackInfo
+	 * @see SetCurrentChange to specify a CMDBObject instance instead
+	 *
+	 * @param $sOrigin String: one of: interactive, csv-interactive, csv-import.php, webservice-soap, webservice-rest, syncho-data-source,
+	 *     email-processing, custom-extension
+	 */
 	public static function SetTrackOrigin($sOrigin)
 	{
 		self::$m_sOrigin = $sOrigin;
 	}
-	
+
 	/**
 	 * Get the additional information (defaulting to user name)
-	 */	 	
-	protected static function GetTrackInfo()
+	 */
+	public static function GetTrackInfo()
 	{
-		if (is_null(self::$m_sInfo))
-		{
+		if (is_null(self::$m_sInfo)) {
 			return CMDBChange::GetCurrentUserName();
-		}
-		else
-		{
+		} else {
 			return self::$m_sInfo;
 		}
 	}
@@ -174,17 +218,19 @@ abstract class CMDBObject extends DBObject
 			return self::$m_sOrigin;
 		}
 	}
-	
+
 	/**
-	 * Create a standard change record (done here 99% of the time, and nearly once per page)
-	 */	 	
+	 * Set to {@link $m_oCurrChange} a standard change record (done here 99% of the time, and nearly once per page)
+	 *
+	 * @since 2.7.7 3.0.2 3.1.0 N°3717 {@see CMDBChange} **will be persisted later** in {@see \CMDBChangeOp::OnInsert} (was done previously directly here)
+	 *     This will avoid creating in DB CMDBChange lines without any corresponding CMDBChangeOp
+	 */
 	protected static function CreateChange()
 	{
 		self::$m_oCurrChange = MetaModel::NewObject("CMDBChange");
 		self::$m_oCurrChange->Set("date", time());
 		self::$m_oCurrChange->Set("userinfo", self::GetTrackInfo());
 		self::$m_oCurrChange->Set("origin", self::GetTrackOrigin());
-		self::$m_oCurrChange->DBInsert();
 	}
 
 	/**
@@ -513,7 +559,23 @@ abstract class CMDBObject extends DBObject
 		}
 	}
 
-
+	/**
+	 * @deprecated 2.7.0 N°2361 simply use {@link DBInsert} instead, that will automatically create and persist a CMDBChange object.
+	 *    If you need to persist your own, call {@link CMDBObject::SetCurrentChange} before.
+	 *
+	 * @param \CMDBChange $oChange
+	 * @param null $bSkipStrongSecurity
+	 *
+	 * @return int|null
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \CoreWarning
+	 * @throws \MySQLException
+	 * @throws \OQLException
+	 * @throws \SecurityException
+	 */
 	public function DBInsertTracked(CMDBChange $oChange, $bSkipStrongSecurity = null)
 	{
 		self::SetCurrentChange($oChange);
@@ -521,7 +583,24 @@ abstract class CMDBObject extends DBObject
 		$ret = $this->DBInsertTracked_Internal();
 		return $ret;
 	}
-	
+
+	/**
+	 * @deprecated 2.7.0 N°2361 simply use {@link DBInsertNoReload} instead, that will automatically create and persist a CMDBChange object.
+	 *    If you need to persist your own, call {@link CMDBObject::SetCurrentChange} before.
+	 *
+	 * @param \CMDBChange $oChange
+	 * @param null $bSkipStrongSecurity
+	 *
+	 * @return int
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \CoreWarning
+	 * @throws \MySQLException
+	 * @throws \OQLException
+	 * @throws \SecurityException
+	 */
 	public function DBInsertTrackedNoReload(CMDBChange $oChange, $bSkipStrongSecurity = null)
 	{
 		self::SetCurrentChange($oChange);
@@ -529,13 +608,20 @@ abstract class CMDBObject extends DBObject
 		$ret = $this->DBInsertTracked_Internal(true);
 		return $ret;
 	}
-	
+
 	/**
-	 * To Be Obsoleted: DO NOT rely on an overload of this method since
-	 * DBInsertTracked (resp. DBInsertTrackedNoReload) may call directly
-	 * DBInsert (resp. DBInsertNoReload) in future versions of iTop.
+	 * @deprecated 2.7.0 N°2361 simply use {@link DBInsert} or {@link DBInsertNoReload} instead
+	 *
 	 * @param bool $bDoNotReload
+	 *
 	 * @return integer Identifier of the created object
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \CoreWarning
+	 * @throws \MySQLException
+	 * @throws \OQLException
 	 */
 	protected function DBInsertTracked_Internal($bDoNotReload = false)
 	{
@@ -582,6 +668,18 @@ abstract class CMDBObject extends DBObject
 		return $ret;
 	}
 
+	/**
+	 * @deprecated 2.7.0 N°2361 simply use {@link DBUpdate} instead, that will automatically create and persist a CMDBChange object.
+	 *    If you need to persist your own, call {@link CMDBObject::SetCurrentChange} before.
+	 *
+	 * @param \CMDBChange $oChange
+	 * @param null $bSkipStrongSecurity
+	 *
+	 * @return int|void
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \SecurityException
+	 */
 	public function DBUpdateTracked(CMDBChange $oChange, $bSkipStrongSecurity = null)
 	{
 		self::SetCurrentChange($oChange);
@@ -593,13 +691,38 @@ abstract class CMDBObject extends DBObject
 	 * @param null $oDeletionPlan
 	 *
 	 * @return \DeletionPlan|null
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
 	 * @throws \DeleteException
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \OQLException
 	 */
 	public function DBDelete(&$oDeletionPlan = null)
 	{
 		return $this->DBDeleteTracked_Internal($oDeletionPlan);
 	}
 
+	/**
+	 * @deprecated 2.7.0 N°2361 simply use {@link DBDelete} instead, that will automatically create and persist a CMDBChange object.
+	 *    If you need to persist your own, call {@link CMDBObject::SetCurrentChange} before.
+	 *
+	 * @param \CMDBChange $oChange
+	 * @param null $bSkipStrongSecurity
+	 * @param null $oDeletionPlan
+	 *
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \DeleteException
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \OQLException
+	 * @throws \SecurityException
+	 */
 	public function DBDeleteTracked(CMDBChange $oChange, $bSkipStrongSecurity = null, &$oDeletionPlan = null)
 	{
 		self::SetCurrentChange($oChange);
@@ -611,11 +734,17 @@ abstract class CMDBObject extends DBObject
 	 * @param null $oDeletionPlan
 	 *
 	 * @return \DeletionPlan|null
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreCannotSaveObjectException
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
 	 * @throws \DeleteException
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 * @throws \OQLException
 	 */
 	protected function DBDeleteTracked_Internal(&$oDeletionPlan = null)
 	{
-		$prevkey = $this->GetKey();
 		$ret = parent::DBDelete($oDeletionPlan);
 		return $ret;
 	}

core/cmdbsource.class.inc.php

@@ -39,6 +39,7 @@ class MySQLException extends CoreException
 	 */
 	public function __construct($sIssue, $aContext, $oException = null, $oMysqli = null)
 	{
+
 		if ($oException != null)
 		{
 			$aContext['mysql_errno'] = $oException->getCode();
@@ -58,13 +59,18 @@ class MySQLException extends CoreException
 			$aContext['mysql_error'] = CMDBSource::GetError();
 		}
 		parent::__construct($sIssue, $aContext);
+		//if is connection error, don't log the default message with password in
+		if (mysqli_connect_errno()) {
+			error_log($this->message);
+			error_reporting(0);
+		}
 	}
 }
 
 /**
  * Class MySQLQueryHasNoResultException
  *
- * @since 2.5
+ * @since 2.5.0
  */
 class MySQLQueryHasNoResultException extends MySQLException
 {
@@ -74,7 +80,7 @@ class MySQLQueryHasNoResultException extends MySQLException
 /**
  * Class MySQLHasGoneAwayException
  *
- * @since 2.5
+ * @since 2.5.0
  * @see itop bug 1195
  * @see https://dev.mysql.com/doc/refman/5.7/en/gone-away.html
  */
@@ -89,7 +95,7 @@ class MySQLHasGoneAwayException extends MySQLException
 	{
 		return array(
 			2006,
-			2013
+			2013,
 		);
 	}
 
@@ -107,10 +113,18 @@ class MySQLNoTransactionException extends MySQLException
 
 }
 
+/**
+ * @since 2.7.8 3.0.3 3.1.0 N°5538
+ */
+class MySQLTransactionNotClosedException extends MySQLException
+{
+
+}
+
 
 /**
  * CMDBSource
- * database access wrapper 
+ * database access wrapper
  *
  * @package     iTopORM
  */
@@ -119,24 +133,52 @@ class CMDBSource
 	const ENUM_DB_VENDOR_MYSQL = 'MySQL';
 	const ENUM_DB_VENDOR_MARIADB = 'MariaDB';
 	const ENUM_DB_VENDOR_PERCONA = 'Percona';
-	
+
+	/**
+	 * @since 2.7.10 3.0.4 3.1.2 3.0.2 N°6889 constant creation
+	 * @internal will be removed in a future version
+	 */
+	const MYSQL_DEFAULT_PORT = 3306;
+
+	/**
+	 * Error: 1205 SQLSTATE: HY000 (ER_LOCK_WAIT_TIMEOUT)
+	 *   Message: Lock wait timeout exceeded; try restarting transaction
+	 */
+	const MYSQL_ERRNO_WAIT_TIMEOUT = 1205;
+	/**
+	 * Error: 1213 SQLSTATE: 40001 (ER_LOCK_DEADLOCK)
+	 *   Message: Deadlock found when trying to get lock; try restarting transaction
+	 */
+	const MYSQL_ERRNO_DEADLOCK = 1213;
+
 	protected static $m_sDBHost;
 	protected static $m_sDBUser;
 	protected static $m_sDBPwd;
 	protected static $m_sDBName;
 	/**
 	 * @var boolean
-	 * @since 2.5 N°1260 MySQL TLS first implementation
+	 * @since 2.5.0 N°1260 MySQL TLS first implementation
 	 */
 	protected static $m_bDBTlsEnabled;
 	/**
 	 * @var string
-	 * @since 2.5 N°1260 MySQL TLS first implementation
+	 * @since 2.5.0 N°1260 MySQL TLS first implementation
 	 */
 	protected static $m_sDBTlsCA;
 
 	/** @var mysqli $m_oMysqli */
 	protected static $m_oMysqli;
+	/**
+	 * The mysqli object is really hard to mock ! This attribute is used only in certain methods, so that we can mock only a very little subset of the mysqli object.
+	 * We are setting it in {@see Init}, by default it is a copy of {@see $m_oMysqli}
+	 * The mock can be injected using the setter {@see SetMySQLiForQuery}
+	 *
+	 * @var mysqli $oMySQLiForQuery
+	 * @see GetMySQLiForQuery
+	 * @see SetMySQLiForQuery
+	 * @since 2.7.5 N°3513 new var to allow mock in tests ({@see \Combodo\iTop\Test\UnitTest\Core\TransactionsTest})
+	 */
+	protected static $oMySQLiForQuery;
 
 	/**
 	 * @var int number of level for nested transactions : 0 if no transaction was ever opened, +1 for each 'START TRANSACTION' sent
@@ -203,6 +245,7 @@ class CMDBSource
 		self::$m_sDBTlsCA = empty($sTlsCA) ? null : $sTlsCA;
 
 		self::$m_oMysqli = self::GetMysqliInstance($sServer, $sUser, $sPwd, $sSource, $bTlsEnabled, $sTlsCA, true);
+		self::SetMySQLiForQuery(self::$m_oMysqli);
 	}
 
 	/**
@@ -216,12 +259,12 @@ class CMDBSource
 	 *
 	 * @return \mysqli
 	 * @throws \MySQLException
+	 *
+	 * @uses IsOpenedDbConnectionUsingTls when asking for a TLS connection, to check if it was really opened using TLS
 	 */
 	public static function GetMysqliInstance(
 		$sDbHost, $sUser, $sPwd, $sSource = '', $bTlsEnabled = false, $sTlsCa = null, $bCheckTlsAfterConnection = false
 	) {
-		$oMysqli = null;
-
 		$sServer = null;
 		$iPort = null;
 		self::InitServerAndPort($sDbHost, $sServer, $iPort);
@@ -251,7 +294,7 @@ class CMDBSource
 		}
 		catch(mysqli_sql_exception $e)
 		{
-			throw new MySQLException('Could not connect to the DB server', array('host' => $sServer, 'user' => $sUser), $e);
+			throw new MySQLException('Could not connect to the DB server', array('host' => $sServer, 'user' => $sUser),$e);
 		}
 
 		if ($bTlsEnabled
@@ -282,16 +325,19 @@ class CMDBSource
 	/**
 	 * @param string $sDbHost initial value ("p:domain:port" syntax)
 	 * @param string $sServer server variable to update
-	 * @param int $iPort port variable to update
+	 * @param int|null $iPort port variable to update, will return null if nothing is specified in $sDbHost
+	 *
+	 * @since 2.7.10 3.0.4 3.1.2 3.2.0 N°6889 will return null in $iPort if port isn't present in $sDbHost. Use {@see MYSQL_DEFAULT_PORT} if needed
+	 *
+	 * @link http://php.net/manual/en/mysqli.persistconns.php documentation for the "p:" prefix (persistent connexion)
 	 */
 	public static function InitServerAndPort($sDbHost, &$sServer, &$iPort)
 	{
 		$aConnectInfo = explode(':', $sDbHost);
 
 		$bUsePersistentConnection = false;
-		if (strcasecmp($aConnectInfo[0], 'p') == 0)
+		if (strcasecmp($aConnectInfo[0], 'p') === 0)
 		{
-			// we might have "p:" prefix to use persistent connections (see http://php.net/manual/en/mysqli.persistconns.php)
 			$bUsePersistentConnection = true;
 			$sServer = $aConnectInfo[0].':'.$aConnectInfo[1];
 		}
@@ -309,10 +355,6 @@ class CMDBSource
 		{
 			$iPort = (int)($aConnectInfo[1]);
 		}
-		else
-		{
-			$iPort = 3306;
-		}
 	}
 
 	/**
@@ -320,41 +362,41 @@ class CMDBSource
 	 * parameters were used.<br>
 	 * This method can be called to ensure that the DB connection really uses TLS.
 	 *
-	 * <p>We're using this object connection : {@link self::$m_oMysqli}
+	 * <p>We're using our own mysqli instance to do the check as this check is done when creating the mysqli instance : the consumer
+	 * might want a dedicated object, and if so we don't want to overwrite the one saved in CMDBSource !<br>
+	 * This is the case for example with {@see \iTopMutex} !
 	 *
 	 * @param \mysqli $oMysqli
 	 *
-	 * @return boolean true if the connection was really established using TLS
+	 * @return boolean true if the connection was really established using TLS, false otherwise
 	 * @throws \MySQLException
 	 *
+	 * @used-by GetMysqliInstance
 	 * @uses IsMySqlVarNonEmpty
+	 * @uses 'ssl_version' MySQL var
+	 * @uses 'ssl_cipher' MySQL var
 	 */
 	private static function IsOpenedDbConnectionUsingTls($oMysqli)
 	{
-		if (self::$m_oMysqli == null)
-		{
-			self::$m_oMysqli = $oMysqli;
-		}
-
-		$bNonEmptySslVersionVar = self::IsMySqlVarNonEmpty('ssl_version');
-		$bNonEmptySslCipherVar = self::IsMySqlVarNonEmpty('ssl_cipher');
+		$bNonEmptySslVersionVar = self::IsMySqlVarNonEmpty('ssl_version', $oMysqli);
+		$bNonEmptySslCipherVar = self::IsMySqlVarNonEmpty('ssl_cipher', $oMysqli);
 
 		return ($bNonEmptySslVersionVar && $bNonEmptySslCipherVar);
 	}
 
 	/**
 	 * @param string $sVarName
+	 * @param mysqli $oMysqli connection to use for the query
 	 *
 	 * @return bool
 	 * @throws \MySQLException
-	 *
-	 * @uses SHOW STATUS queries
+	 * @uses 'SHOW SESSION STATUS' queries
 	 */
-	private static function IsMySqlVarNonEmpty($sVarName)
+	private static function IsMySqlVarNonEmpty($sVarName, $oMysqli)
 	{
 		try
 		{
-			$sResult = self::QueryToScalar("SHOW SESSION STATUS LIKE '$sVarName'", 1);
+			$sResult = self::QueryToScalar("SHOW SESSION STATUS LIKE '$sVarName'", 1, $oMysqli);
 		}
 		catch (MySQLQueryHasNoResultException $e)
 		{
@@ -418,6 +460,12 @@ class CMDBSource
 
 	}
 
+	/**
+	 * @return string
+	 * @throws \MySQLException
+	 *
+	 * @uses \CMDBSource::QueryToCol() so needs a connection opened !
+	 */
 	public static function GetDBVersion()
 	{
 		$aVersions = self::QueryToCol('SELECT Version() as version', 'version');
@@ -435,8 +483,10 @@ class CMDBSource
 	/**
 	 * Get the DB vendor between MySQL and its main forks
 	 * @return string
+	 *
+	 * @uses \CMDBSource::GetServerVariable() so needs a connection opened !
 	 */
-	static public function GetDBVendor()
+	public static function GetDBVendor()
 	{
 		$sDBVendor = static::ENUM_DB_VENDOR_MYSQL;
 		
@@ -490,6 +540,7 @@ class CMDBSource
 		{
 			self::$m_sDBName = '';
 		}
+		self::_TablesInfoCacheReset(); // reset the table info cache!
 	}
 
 	public static function CreateTable($sQuery)
@@ -519,6 +570,24 @@ class CMDBSource
 		return self::$m_oMysqli;
 	}
 
+	/**
+	 * @return
+	 */
+	private static function GetMySQLiForQuery()
+	{
+		return self::$oMySQLiForQuery;
+	}
+
+
+	/**
+	 * Used for test purpose (mysqli mock)
+	 * @param $oMySQLi
+	 */
+	private static function SetMySQLiForQuery($oMySQLi)
+	{
+		self::$oMySQLiForQuery = $oMySQLi;
+	}
+
 	public static function GetErrNo()
 	{
 		if (self::$m_oMysqli->errno != 0)
@@ -576,11 +645,6 @@ class CMDBSource
 			return $aRes;
 		}
 
-		// Stripslashes
-		if (get_magic_quotes_gpc())
-		{
-			$value = stripslashes($value);
-		}
 		// Quote if not a number or a numeric string
 		if ($bAlways || is_string($value))
 		{
@@ -589,13 +653,30 @@ class CMDBSource
 		return $value;
 	}
 
+	/**
+	 * MariaDB returns "'value'" for enum, while MySQL returns "value" (without the surrounding single quotes)
+	 *
+	 * @param string $sValue
+	 *
+	 * @return string without the surrounding quotes
+	 * @since 2.7.0 N°2490
+	 */
+	private static function RemoveSurroundingQuotes($sValue)
+	{
+		if (utils::StartsWith($sValue, '\'') && utils::EndsWith($sValue, '\''))
+		{
+			$sValue = substr($sValue, 1, -1);
+		}
+
+		return $sValue;
+	}
+
 	/**
 	 * @param string $sSQLQuery
 	 *
-	 * @return \mysqli_result|null
-	 * @throws \MySQLException
-	 * @throws \MySQLHasGoneAwayException
-	 * @throws \CoreException
+     * @return mysqli_result|null
+     * @throws MySQLException
+     * @throws MySQLHasGoneAwayException
 	 *
 	 * @since 2.7.0 N°679 handles nested transactions
 	 */
@@ -641,33 +722,82 @@ class CMDBSource
 	 */
 	private static function DBQuery($sSql)
 	{
+		$sShortSQL = substr(preg_replace("/\s+/", " ", substr($sSql, 0, 180)), 0, 150);
+		if (substr_compare($sShortSQL, "SELECT", 0, strlen("SELECT")) !== 0) {
+			IssueLog::Trace("$sShortSQL", 'cmdbsource');
+		}
+
 		$oKPI = new ExecutionKPI();
 		try
 		{
-			$oResult = self::$m_oMysqli->query($sSql);
+			$oResult = self::GetMySQLiForQuery()->query($sSql);
 		}
 		catch (mysqli_sql_exception $e)
 		{
+			self::LogDeadLock($e);
 			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql, $e));
-		}
-		$oKPI->ComputeStats('Query exec (mySQL)', $sSql);
+		} finally {
+            $oKPI->ComputeStats('Query exec (mySQL)', $sSql);
+        }
 		if ($oResult === false)
 		{
 			$aContext = array('query' => $sSql);
 
-			$iMySqlErrorNo = self::$m_oMysqli->errno;
+			$iMySqlErrorNo = self::GetMySQLiForQuery()->errno;
 			$aMySqlHasGoneAwayErrorCodes = MySQLHasGoneAwayException::getErrorCodes();
 			if (in_array($iMySqlErrorNo, $aMySqlHasGoneAwayErrorCodes))
 			{
 				throw new MySQLHasGoneAwayException(self::GetError(), $aContext);
 			}
-
-			throw new MySQLException('Failed to issue SQL query', $aContext);
+			$e = new MySQLException('Failed to issue SQL query', $aContext);
+			self::LogDeadLock($e);
+			throw $e;
 		}
 
 		return $oResult;
 	}
 
+	/**
+	 * @param \Exception $e
+	 *
+	 * @since 2.7.1
+	 */
+	private static function LogDeadLock(Exception $e)
+	{
+		// checks MySQL error code
+		$iMySqlErrorNo = self::GetMySQLiForQuery()->errno;
+		if (!in_array($iMySqlErrorNo, array(self::MYSQL_ERRNO_WAIT_TIMEOUT, self::MYSQL_ERRNO_DEADLOCK)))
+		{
+			return;
+		}
+
+		// Get error info
+		$sUser = UserRights::GetUser();
+		$oError = self::GetMySQLiForQuery()->query('SHOW ENGINE INNODB STATUS');
+		if ($oError !== false)
+		{
+			$aData = $oError->fetch_all(MYSQLI_ASSOC);
+			$sInnodbStatus = $aData[0];
+		}
+		else
+		{
+			$sInnodbStatus = 'Get status query cannot execute';
+		}
+
+		// log !
+		$sMessage = "deadlock detected: user= $sUser; errno=$iMySqlErrorNo";
+		$aLogContext = array(
+			'userinfo' => $sUser,
+			'errno' => $iMySqlErrorNo,
+			'ex_msg' => $e->getMessage(),
+			'callstack' => $e->getTraceAsString(),
+			'data' => $sInnodbStatus,
+		);
+		DeadLockLog::Info($sMessage, $iMySqlErrorNo, $aLogContext);
+
+		IssueLog::Error($sMessage, LogChannels::DEADLOCK, $e->getMessage());
+	}
+
 	/**
 	 * If nested transaction, we are not starting a new one : only one global transaction will exist.
 	 *
@@ -681,10 +811,15 @@ class CMDBSource
 	 */
 	private static function StartTransaction()
 	{
+		$aStackTrace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT , 3);
+
 		$bHasExistingTransactions = self::IsInsideTransaction();
 		if (!$bHasExistingTransactions)
 		{
+			IssueLog::Trace("START TRANSACTION was sent to the DB", LogChannels::CMDB_SOURCE, ['stacktrace' => $aStackTrace]);
 			self::DBQuery('START TRANSACTION');
+		} else {
+			IssueLog::Trace("START TRANSACTION ignored as a transaction is already opened", LogChannels::CMDB_SOURCE, ['stacktrace' => $aStackTrace]);
 		}
 
 		self::AddTransactionLevel();
@@ -702,9 +837,12 @@ class CMDBSource
 	 */
 	private static function Commit()
 	{
+		$aStackTrace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT , 3);
+		$sCaller = 'From '.$aStackTrace[1]['file'].'('.$aStackTrace[1]['line'].'): '.$aStackTrace[2]['class'].'->'.$aStackTrace[2]['function'].'()';
 		if (!self::IsInsideTransaction())
 		{
 			// should not happen !
+			IssueLog::Error("No Transaction COMMIT $sCaller", 'cmdbsource');
 			throw new MySQLNoTransactionException('Trying to commit transaction whereas none have been started !', null);
 		}
 
@@ -712,8 +850,10 @@ class CMDBSource
 
 		if (self::IsInsideTransaction())
 		{
+			IssueLog::Trace("Ignore nested (".self::$m_iTransactionLevel.") COMMIT $sCaller", 'cmdbsource');
 			return;
 		}
+		IssueLog::Trace("COMMIT $sCaller", 'cmdbsource');
 		self::DBQuery('COMMIT');
 	}
 
@@ -732,17 +872,22 @@ class CMDBSource
 	 */
 	private static function Rollback()
 	{
+		$aStackTrace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT , 3);
+		$sCaller = 'From '.$aStackTrace[1]['file'].'('.$aStackTrace[1]['line'].'): '.$aStackTrace[2]['class'].'->'.$aStackTrace[2]['function'].'()';
 		if (!self::IsInsideTransaction())
 		{
 			// should not happen !
+			IssueLog::Error("No Transaction ROLLBACK $sCaller", 'cmdbsource');
 			throw new MySQLNoTransactionException('Trying to commit transaction whereas none have been started !', null);
 		}
 		self::RemoveLastTransactionLevel();
 		if (self::IsInsideTransaction())
 		{
+			IssueLog::Trace("Ignore nested (".self::$m_iTransactionLevel.") ROLLBACK $sCaller", 'cmdbsource');
 			return;
 		}
 
+		IssueLog::Trace("ROLLBACK $sCaller", 'cmdbsource');
 		self::DBQuery('ROLLBACK');
 	}
 
@@ -792,7 +937,21 @@ class CMDBSource
 		self::$m_iTransactionLevel = 0;
 	}
 
+	public static function IsDeadlockException(Exception $e)
+	{
+		while ($e instanceof Exception) {
+			if (($e instanceof MySQLException) && ($e->getCode() == 1213)) {
+				return true;
+			}
+			$e = $e->getPrevious();
+		}
+		return false;
+	}
+
 	/**
+	 *
+	 * @deprecated 2.7.0 N°1627 use ItopCounter instead
+	 *
 	 * @param string $sTable
 	 *
 	 * @return int
@@ -842,17 +1001,21 @@ class CMDBSource
 	/**
 	 * @param string $sSql
 	 * @param int $iCol beginning at 0
+	 * @param mysqli $oMysqli if not null will query using this connection, otherwise will use {@see GetMySQLiForQuery}
 	 *
 	 * @return string corresponding cell content on the first line
 	 * @throws \MySQLException
 	 * @throws \MySQLQueryHasNoResultException
+	 * @since 2.7.5-2 2.7.6 3.0.0 N°4215 new optional mysqli param
 	 */
-	public static function QueryToScalar($sSql, $iCol = 0)
+	public static function QueryToScalar($sSql, $iCol = 0, $oMysqli = null)
 	{
+		$oMysqliToQuery = (is_null($oMysqli)) ? self::GetMySQLiForQuery() : $oMysqli;
+
 		$oKPI = new ExecutionKPI();
 		try
 		{
-			$oResult = self::$m_oMysqli->query($sSql);
+			$oResult = $oMysqliToQuery->query($sSql);
 		}
 		catch(mysqli_sql_exception $e)
 		{
@@ -892,7 +1055,7 @@ class CMDBSource
 		$oKPI = new ExecutionKPI();
 		try
 		{
-			$oResult = self::$m_oMysqli->query($sSql);
+			$oResult = self::GetMySQLiForQuery()->query($sSql);
 		}
 		catch(mysqli_sql_exception $e)
 		{
@@ -974,7 +1137,7 @@ class CMDBSource
 	{
 		try
 		{
-			$oResult = self::$m_oMysqli->query($sSql);
+			$oResult = self::GetMySQLiForQuery()->query($sSql);
 		}
 		catch(mysqli_sql_exception $e)
 		{
@@ -1110,6 +1273,134 @@ class CMDBSource
 		return false;
 	}
 
+	/**
+	 * There may have some differences between DB ! For example in :
+	 *   * MySQL 5.7 we have `INT`
+	 *   * MariaDB >= 10.2 you get `int DEFAULT 'NULL'`
+	 *
+	 * We still need to do a case sensitive comparison for enum values !
+	 *
+	 * A better solution would be to generate SQL field definitions ({@link GetFieldSpec} method) based on the DB used... But for
+	 * now (N°2490 / SF #1756 / PR #91) we did implement this simpler solution
+	 *
+	 * @see GetFieldDataTypeAndOptions extracts all info from the SQL field definition
+	 *
+	 * @param string $sDbFieldType
+	 *
+	 * @param string $sItopGeneratedFieldType
+	 *
+	 * @return bool true if same type and options (case sensitive comparison only for type options), false otherwise
+	 *
+	 * @throws \CoreException
+	 * @since 2.7.0 N°2490
+	 */
+	public static function IsSameFieldTypes($sItopGeneratedFieldType, $sDbFieldType)
+	{
+		[$sItopFieldDataType, $sItopFieldTypeOptions, $sItopFieldOtherOptions] = static::GetFieldDataTypeAndOptions($sItopGeneratedFieldType);
+		[$sDbFieldDataType, $sDbFieldTypeOptions, $sDbFieldOtherOptions] = static::GetFieldDataTypeAndOptions($sDbFieldType);
+
+		if (strcasecmp($sItopFieldDataType, $sDbFieldDataType) !== 0)
+		{
+			return false;
+		}
+
+		if (strcmp($sItopFieldTypeOptions, $sDbFieldTypeOptions) !== 0)
+		{
+			// case sensitive comp as we need to check case for enum possible values for example
+			return false;
+		}
+
+		// remove the default value NULL added by MariadDB
+		$sMariaDbDefaultNull = ' DEFAULT \'NULL\'';
+		if (utils::EndsWith($sDbFieldOtherOptions, $sMariaDbDefaultNull))
+		{
+			$sDbFieldOtherOptions = substr($sDbFieldOtherOptions, 0, -strlen($sMariaDbDefaultNull));
+		}
+		// remove quotes around default values (always present in MariaDB)
+		$sDbFieldOtherOptions = preg_replace_callback(
+			'/( DEFAULT )\'([^\']+)\'/',
+			function ($aMatches) use ($sItopFieldDataType) {
+				// ENUM default values should keep quotes, but all other numeric values don't have quotes
+				if (is_numeric($aMatches[2]) && ($sItopFieldDataType !== 'ENUM'))
+				{
+					return $aMatches[1].$aMatches[2];
+				}
+
+				return $aMatches[0];
+			},
+			$sDbFieldOtherOptions);
+
+		if (strcasecmp($sItopFieldOtherOptions, $sDbFieldOtherOptions) !== 0)
+		{
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @see \self::GetEnumOptions() specific processing for ENUM fields
+	 *
+	 * @param string $sCompleteFieldType sql field type, for example `VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT 0`
+	 *
+	 * @return string[] consisting of 3 items :
+	 *      1. data type : for example `VARCHAR`
+	 *      2. type value : for example `255`
+	 *      3. other options : for example `CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT 0`
+	 *
+	 * @throws \CoreException
+	 */
+	private static function GetFieldDataTypeAndOptions($sCompleteFieldType)
+	{
+		preg_match('/^([a-zA-Z]+)(\(([^\)]+)\))?( .+)?/', $sCompleteFieldType, $aMatches);
+
+		$sDataType = isset($aMatches[1]) ? $aMatches[1] : '';
+
+		if (strcasecmp($sDataType, 'ENUM') === 0){
+			try{
+				return self::GetEnumOptions($sDataType, $sCompleteFieldType);
+			}catch(CoreException $e){
+				//do nothing ; especially do not block setup.
+				IssueLog::Warning("enum was not parsed properly: $sCompleteFieldType. it should not happen during setup.");
+			}
+		}
+
+		$sTypeOptions = isset($aMatches[2]) ? $aMatches[3] : '';
+		$sOtherOptions = isset($aMatches[4]) ? $aMatches[4] : '';
+
+		return array($sDataType, $sTypeOptions, $sOtherOptions);
+	}
+
+	/**
+	 * @param string $sDataType for example `ENUM`
+	 * @param string $sCompleteFieldType Example:
+	 *     `ENUM('CSP A','CSP (aaaa) M','NA','OEM(ROC)','OPEN(VL)','RETAIL (Boite)') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci`
+	 *
+	 * @return string[] consisting of 3 items :
+	 *      1. data type : ENUM or enum here
+	 *      2. type value : in-between EUM parenthesis
+	 *      3. other options : for example ' CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT 0'
+	 * @throws \CoreException
+	 * @since 2.7.4 N°3065 specific processing for enum fields : fix no alter table when enum values containing parenthesis
+	 * Handle ENUM options
+	 */
+	private static function GetEnumOptions($sDataType, $sCompleteFieldType)
+	{
+		$iFirstOpeningParenthesis = strpos($sCompleteFieldType, '(');
+		$iLastEndingParenthesis = strrpos($sCompleteFieldType, ')');
+
+		if ($iFirstOpeningParenthesis === false || $iLastEndingParenthesis === false ){
+			//should never happen as GetFieldDataTypeAndOptions regexp matched.
+			//except if regexp is modiied/broken somehow one day...
+			throw new CoreException("GetEnumOptions issue with $sDataType parsing : " . $sCompleteFieldType);
+		}
+
+		$sTypeOptions = substr($sCompleteFieldType, $iFirstOpeningParenthesis + 1, $iLastEndingParenthesis - 1);
+		$sOtherOptions = substr($sCompleteFieldType, $iLastEndingParenthesis + 1);
+
+		return array($sDataType, $sTypeOptions, $sOtherOptions);
+	}
+
 	/**
 	 * @param string $sTable
 	 * @param string $sField
@@ -1161,7 +1452,8 @@ class CMDBSource
 		}
 		elseif (is_string($aFieldData["Default"]) == 'string')
 		{
-			$sRet .= ' DEFAULT '.self::Quote($aFieldData["Default"]);
+			$sDefaultValue = static::RemoveSurroundingQuotes($aFieldData["Default"]);
+			$sRet .= ' DEFAULT '.self::Quote($sDefaultValue);
 		}
 
 		return $sRet;
@@ -1296,7 +1588,7 @@ class CMDBSource
 	 * @return string query to upgrade table charset and collation if needed, null if not
 	 * @throws \MySQLException
 	 *
-	 * @since 2.5 N°1001 switch to utf8mb4
+	 * @since 2.5.0 N°1001 switch to utf8mb4
 	 * @see https://dev.mysql.com/doc/refman/5.7/en/charset-table.html
 	 */
 	public static function DBCheckTableCharsetAndCollation($sTableName)
@@ -1332,7 +1624,7 @@ class CMDBSource
 		$sSql = "SELECT * FROM `$sTable`";
 		try
 		{
-			$oResult = self::$m_oMysqli->query($sSql);
+			$oResult = self::GetMySQLiForQuery()->query($sSql);
 		}
 		catch(mysqli_sql_exception $e)
 		{
@@ -1442,11 +1734,23 @@ class CMDBSource
 		return false;
 	}
 
-	/**
-	 * @return string query to upgrade database charset and collation if needed, null if not
+    public static function GetClusterNb()
+    {
+        $result = 0;
+        $sSql = "SHOW STATUS LIKE 'wsrep_cluster_size';";
+        $aRows = self::QueryToArray($sSql);
+        if (count($aRows) > 0)
+        {
+            $result = $aRows[0]['Value'];
+        }
+        return intval($result);
+    }
+
+    /**
+     * @return string query to upgrade database charset and collation if needed, null if not
 	 * @throws \MySQLException
 	 *
-	 * @since 2.5 N°1001 switch to utf8mb4
+	 * @since 2.5.0 N°1001 switch to utf8mb4
 	 * @see https://dev.mysql.com/doc/refman/5.7/en/charset-database.html
 	 */
 	public static function DBCheckCharsetAndCollation()

core/computing.inc.php

@@ -1,35 +1,44 @@
 <?php
-// Copyright (C) 2010-2014 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/>
+/**
+ * Copyright (C) 2010-2020 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/>
+ */
 
 
 /**
- * Any extension to compute things like a stop watch deadline or working hours 
+ * Any extension to compute things like a stop watch deadline or working hours
  *
  * @copyright   Copyright (C) 2010-2012 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 /**
- * Metric computing for stop watches
+ * Metric computing for stop watches.
+ * Can be used for AttributeStopWatch goal (iTop XML node xpath: /itop_design/classes/class/fields/field/goal)
  */ 
 interface iMetricComputer
 {
 	public static function GetDescription();
+
+	/**
+	 * @param \DBObject $oObject
+	 *
+	 * @return float number of seconds for the time limit
+	 */
 	public function ComputeMetric($oObject);
 }
 
@@ -41,21 +50,21 @@ interface iWorkingTimeComputer
 	public static function GetDescription();
 
 	/**
-	 * Get the date/time corresponding to a given delay in the future from the present
-	 * considering only the valid (open) hours for a specified object
-	 * @param $oObject DBObject The object for which to compute the deadline
-	 * @param $iDuration integer The duration (in seconds) in the future
-	 * @param $oStartDate DateTime The starting point for the computation
-	 * @return DateTime The date/time for the deadline
+	 * @param DBObject $oObject The object for which to compute the deadline
+	 * @param integer $iDuration The duration (in seconds) in the future
+	 * @param DateTime $oStartDate The starting point for the computation
+	 *
+	 * @return DateTime The date/time corresponding to a given delay in the future from the present
+	 *      considering only the valid (open) hours for a specified object
 	 */
 	public function GetDeadline($oObject, $iDuration, DateTime $oStartDate);
 	
 	/**
-	 * Get duration (considering only open hours) elapsed bewteen two given DateTimes
-	 * @param $oObject DBObject The object for which to compute the duration
-	 * @param $oStartDate DateTime The starting point for the computation (default = now)
-	 * @param $oEndDate DateTime The ending point for the computation (default = now)
-	 * @return integer The duration (number of seconds) of open hours elapsed between the two dates
+	 * @param DBObject $oObject The object for which to compute the duration
+	 * @param DateTime $oStartDate The starting point for the computation (default = now)
+	 * @param DateTime $oEndDate The ending point for the computation (default = now)
+	 *
+	 * @return integer The duration (number of seconds) elapsed between two given dates, considering only open hours
 	 */
 	public function GetOpenDuration($oObject, DateTime $oStartDate, DateTime $oEndDate);
 }
@@ -87,12 +96,7 @@ class DefaultWorkingTimeComputer implements iWorkingTimeComputer
 	}
 
 	/**
-	 * Get the date/time corresponding to a given delay in the future from the present
-	 * considering only the valid (open) hours for a specified object
-	 * @param $oObject DBObject The object for which to compute the deadline
-	 * @param $iDuration integer The duration (in seconds) in the future
-	 * @param $oStartDate DateTime The starting point for the computation
-	 * @return DateTime The date/time for the deadline
+	 * @inheritDoc
 	 */
 	public function GetDeadline($oObject, $iDuration, DateTime $oStartDate)
 	{
@@ -113,11 +117,7 @@ class DefaultWorkingTimeComputer implements iWorkingTimeComputer
 	}
 	
 	/**
-	 * Get duration (considering only open hours) elapsed bewteen two given DateTimes
-	 * @param $oObject DBObject The object for which to compute the duration
-	 * @param $oStartDate DateTime The starting point for the computation (default = now)
-	 * @param $oEndDate DateTime The ending point for the computation (default = now)
-	 * @return integer The duration (number of seconds) of open hours elapsed between the two dates
+	 * @inheritDoc
 	 */
 	public function GetOpenDuration($oObject, DateTime $oStartDate, DateTime $oEndDate)
 	{
@@ -134,6 +134,3 @@ class DefaultWorkingTimeComputer implements iWorkingTimeComputer
 		return $iDuration;
 	}
 }
-
-
-?>