commit aa97bb15d166e0ce963c5b2fcd38c7a80044f099 Author: Christian P. MOMON Date: Sun Sep 13 01:28:27 2020 +0200 First commit. diff --git a/.classpath b/.classpath new file mode 100644 index 0000000..8830980 --- /dev/null +++ b/.classpath @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9a75992 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/bin +/build +/dist +*~ diff --git a/.project b/.project new file mode 100644 index 0000000..610e8d9 --- /dev/null +++ b/.project @@ -0,0 +1,30 @@ + + + StatoolInfos + + + + + + org.eclipse.wst.common.project.facet.core.builder + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.wst.validation.validationbuilder + + + + + + org.eclipse.jem.workbench.JavaEMFNature + org.eclipse.wst.common.modulecore.ModuleCoreNature + org.eclipse.jdt.core.javanature + org.eclipse.wst.common.project.facet.core.nature + + diff --git a/.settings/com.wdev91.eclipse.copyright.xml b/.settings/com.wdev91.eclipse.copyright.xml new file mode 100644 index 0000000..7683676 --- /dev/null +++ b/.settings/com.wdev91.eclipse.copyright.xml @@ -0,0 +1,59 @@ + + + + .]]> +
+
+
+
+
+
+ + + ]]> + ]]> +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + +
+
+
+
+ + + +
+ diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 0000000..5406c7c --- /dev/null +++ b/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,398 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled +org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate +org.eclipse.jdt.core.compiler.codegen.targetPlatform=11 +org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve +org.eclipse.jdt.core.compiler.compliance=11 +org.eclipse.jdt.core.compiler.debug.lineNumber=generate +org.eclipse.jdt.core.compiler.debug.localVariable=generate +org.eclipse.jdt.core.compiler.debug.sourceFile=generate +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning +org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.source=11 +org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false +org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 +org.eclipse.jdt.core.formatter.align_type_members_on_columns=false +org.eclipse.jdt.core.formatter.align_variable_declarations_on_columns=false +org.eclipse.jdt.core.formatter.align_with_spaces=false +org.eclipse.jdt.core.formatter.alignment_for_additive_operator=16 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression=16 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation=0 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant=16 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call=16 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation=16 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression=16 +org.eclipse.jdt.core.formatter.alignment_for_assignment=0 +org.eclipse.jdt.core.formatter.alignment_for_bitwise_operator=16 +org.eclipse.jdt.core.formatter.alignment_for_compact_if=16 +org.eclipse.jdt.core.formatter.alignment_for_compact_loops=16 +org.eclipse.jdt.core.formatter.alignment_for_conditional_expression=80 +org.eclipse.jdt.core.formatter.alignment_for_conditional_expression_chain=0 +org.eclipse.jdt.core.formatter.alignment_for_enum_constants=49 +org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer=16 +org.eclipse.jdt.core.formatter.alignment_for_expressions_in_for_loop_header=0 +org.eclipse.jdt.core.formatter.alignment_for_logical_operator=16 +org.eclipse.jdt.core.formatter.alignment_for_method_declaration=0 +org.eclipse.jdt.core.formatter.alignment_for_module_statements=16 +org.eclipse.jdt.core.formatter.alignment_for_multiple_fields=16 +org.eclipse.jdt.core.formatter.alignment_for_multiplicative_operator=16 +org.eclipse.jdt.core.formatter.alignment_for_parameterized_type_references=0 +org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_record_components=16 +org.eclipse.jdt.core.formatter.alignment_for_relational_operator=0 +org.eclipse.jdt.core.formatter.alignment_for_resources_in_try=80 +org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation=16 +org.eclipse.jdt.core.formatter.alignment_for_shift_operator=0 +org.eclipse.jdt.core.formatter.alignment_for_string_concatenation=16 +org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_record_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_type_arguments=0 +org.eclipse.jdt.core.formatter.alignment_for_type_parameters=0 +org.eclipse.jdt.core.formatter.alignment_for_union_type_in_multicatch=16 +org.eclipse.jdt.core.formatter.blank_lines_after_imports=1 +org.eclipse.jdt.core.formatter.blank_lines_after_last_class_body_declaration=0 +org.eclipse.jdt.core.formatter.blank_lines_after_package=1 +org.eclipse.jdt.core.formatter.blank_lines_before_abstract_method=1 +org.eclipse.jdt.core.formatter.blank_lines_before_field=0 +org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration=0 +org.eclipse.jdt.core.formatter.blank_lines_before_imports=1 +org.eclipse.jdt.core.formatter.blank_lines_before_member_type=1 +org.eclipse.jdt.core.formatter.blank_lines_before_method=1 +org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk=1 +org.eclipse.jdt.core.formatter.blank_lines_before_package=0 +org.eclipse.jdt.core.formatter.blank_lines_between_import_groups=1 +org.eclipse.jdt.core.formatter.blank_lines_between_statement_group_in_switch=0 +org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations=1 +org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration=next_line +org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration=next_line +org.eclipse.jdt.core.formatter.brace_position_for_array_initializer=end_of_line +org.eclipse.jdt.core.formatter.brace_position_for_block=next_line +org.eclipse.jdt.core.formatter.brace_position_for_block_in_case=next_line +org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration=next_line +org.eclipse.jdt.core.formatter.brace_position_for_enum_constant=next_line +org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration=next_line +org.eclipse.jdt.core.formatter.brace_position_for_lambda_body=end_of_line +org.eclipse.jdt.core.formatter.brace_position_for_method_declaration=next_line +org.eclipse.jdt.core.formatter.brace_position_for_record_constructor=next_line +org.eclipse.jdt.core.formatter.brace_position_for_record_declaration=next_line +org.eclipse.jdt.core.formatter.brace_position_for_switch=next_line +org.eclipse.jdt.core.formatter.brace_position_for_type_declaration=next_line +org.eclipse.jdt.core.formatter.comment.align_tags_descriptions_grouped=false +org.eclipse.jdt.core.formatter.comment.align_tags_names_descriptions=false +org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment=false +org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment=false +org.eclipse.jdt.core.formatter.comment.count_line_length_from_starting_position=false +org.eclipse.jdt.core.formatter.comment.format_block_comments=false +org.eclipse.jdt.core.formatter.comment.format_header=false +org.eclipse.jdt.core.formatter.comment.format_html=true +org.eclipse.jdt.core.formatter.comment.format_javadoc_comments=true +org.eclipse.jdt.core.formatter.comment.format_line_comments=true +org.eclipse.jdt.core.formatter.comment.format_source_code=true +org.eclipse.jdt.core.formatter.comment.indent_parameter_description=true +org.eclipse.jdt.core.formatter.comment.indent_root_tags=true +org.eclipse.jdt.core.formatter.comment.indent_tag_description=false +org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags=insert +org.eclipse.jdt.core.formatter.comment.insert_new_line_between_different_tags=do not insert +org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter=insert +org.eclipse.jdt.core.formatter.comment.line_length=80 +org.eclipse.jdt.core.formatter.comment.new_lines_at_block_boundaries=true +org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries=true +org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments=false +org.eclipse.jdt.core.formatter.compact_else_if=true +org.eclipse.jdt.core.formatter.continuation_indentation=2 +org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer=2 +org.eclipse.jdt.core.formatter.disabling_tag=@formatter\:off +org.eclipse.jdt.core.formatter.enabling_tag=@formatter\:on +org.eclipse.jdt.core.formatter.format_guardian_clause_on_one_line=false +org.eclipse.jdt.core.formatter.format_line_comment_starting_on_first_column=true +org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header=true +org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header=true +org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header=true +org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_record_header=true +org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header=true +org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases=false +org.eclipse.jdt.core.formatter.indent_empty_lines=false +org.eclipse.jdt.core.formatter.indent_statements_compare_to_block=true +org.eclipse.jdt.core.formatter.indent_statements_compare_to_body=true +org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases=true +org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch=true +org.eclipse.jdt.core.formatter.indentation.size=4 +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_enum_constant=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_label=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_after_type_annotation=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement=insert +org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement=insert +org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement=insert +org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_annotation_declaration=insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_anonymous_type_declaration=insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_block=insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_constant=insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_declaration=insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_method_body=insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_type_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_after_additive_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter=insert +org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_case=insert +org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_default=insert +org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_bitwise_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments=insert +org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters=insert +org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block=insert +org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast=insert +org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert=insert +org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case=insert +org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional=insert +org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for=insert +org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_record_components=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_switch_case_expressions=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments=insert +org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters=insert +org.eclipse.jdt.core.formatter.insert_space_after_ellipsis=insert +org.eclipse.jdt.core.formatter.insert_space_after_lambda_arrow=insert +org.eclipse.jdt.core.formatter.insert_space_after_logical_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_multiplicative_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_not_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer=insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_record_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_try=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional=insert +org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_relational_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for=insert +org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources=insert +org.eclipse.jdt.core.formatter.insert_space_after_shift_operator=insert +org.eclipse.jdt.core.formatter.insert_space_after_string_concatenation=insert +org.eclipse.jdt.core.formatter.insert_space_after_unary_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_additive_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter=insert +org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_case=insert +org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_default=insert +org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_bitwise_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer=insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_record_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_try=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert=insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional=insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for=insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_record_components=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_switch_case_expressions=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_ellipsis=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_lambda_arrow=insert +org.eclipse.jdt.core.formatter.insert_space_before_logical_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_multiplicative_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_constructor=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_record_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_try=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while=insert +org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return=insert +org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw=insert +org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional=insert +org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_relational_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_semicolon=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_try_resources=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_shift_operator=insert +org.eclipse.jdt.core.formatter.insert_space_before_string_concatenation=insert +org.eclipse.jdt.core.formatter.insert_space_before_unary_operator=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation=do not insert +org.eclipse.jdt.core.formatter.join_lines_in_comments=true +org.eclipse.jdt.core.formatter.join_wrapped_lines=false +org.eclipse.jdt.core.formatter.keep_annotation_declaration_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_anonymous_type_declaration_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_code_block_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line=false +org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line=false +org.eclipse.jdt.core.formatter.keep_enum_constant_declaration_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_enum_declaration_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_if_then_body_block_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line=false +org.eclipse.jdt.core.formatter.keep_lambda_body_block_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_loop_body_block_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_method_body_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_record_constructor_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_record_declaration_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.keep_simple_do_while_body_on_same_line=false +org.eclipse.jdt.core.formatter.keep_simple_for_body_on_same_line=false +org.eclipse.jdt.core.formatter.keep_simple_getter_setter_on_one_line=false +org.eclipse.jdt.core.formatter.keep_simple_while_body_on_same_line=false +org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line=false +org.eclipse.jdt.core.formatter.keep_type_declaration_on_one_line=one_line_never +org.eclipse.jdt.core.formatter.lineSplit=200 +org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column=false +org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column=false +org.eclipse.jdt.core.formatter.number_of_blank_lines_after_code_block=0 +org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_code_block=0 +org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body=0 +org.eclipse.jdt.core.formatter.number_of_blank_lines_at_end_of_code_block=0 +org.eclipse.jdt.core.formatter.number_of_blank_lines_at_end_of_method_body=0 +org.eclipse.jdt.core.formatter.number_of_blank_lines_before_code_block=0 +org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve=1 +org.eclipse.jdt.core.formatter.parentheses_positions_in_annotation=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_catch_clause=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_enum_constant_declaration=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_for_statment=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_if_while_statement=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_lambda_declaration=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_method_delcaration=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_method_invocation=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_record_declaration=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_switch_statement=common_lines +org.eclipse.jdt.core.formatter.parentheses_positions_in_try_clause=common_lines +org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line=true +org.eclipse.jdt.core.formatter.tabulation.char=space +org.eclipse.jdt.core.formatter.tabulation.size=4 +org.eclipse.jdt.core.formatter.text_block_indentation=0 +org.eclipse.jdt.core.formatter.use_on_off_tags=false +org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations=false +org.eclipse.jdt.core.formatter.wrap_before_additive_operator=true +org.eclipse.jdt.core.formatter.wrap_before_assignment_operator=false +org.eclipse.jdt.core.formatter.wrap_before_bitwise_operator=true +org.eclipse.jdt.core.formatter.wrap_before_conditional_operator=true +org.eclipse.jdt.core.formatter.wrap_before_logical_operator=true +org.eclipse.jdt.core.formatter.wrap_before_multiplicative_operator=true +org.eclipse.jdt.core.formatter.wrap_before_or_operator_multicatch=true +org.eclipse.jdt.core.formatter.wrap_before_relational_operator=true +org.eclipse.jdt.core.formatter.wrap_before_shift_operator=true +org.eclipse.jdt.core.formatter.wrap_before_string_concatenation=true +org.eclipse.jdt.core.formatter.wrap_outer_expressions_when_nested=true +org.eclipse.jdt.core.javaFormatter=org.eclipse.jdt.core.defaultJavaFormatter diff --git a/.settings/org.eclipse.jdt.ui.prefs b/.settings/org.eclipse.jdt.ui.prefs new file mode 100644 index 0000000..b79f8cb --- /dev/null +++ b/.settings/org.eclipse.jdt.ui.prefs @@ -0,0 +1,130 @@ +cleanup.add_default_serial_version_id=false +cleanup.add_generated_serial_version_id=true +cleanup.add_missing_annotations=true +cleanup.add_missing_deprecated_annotations=true +cleanup.add_missing_methods=false +cleanup.add_missing_nls_tags=false +cleanup.add_missing_override_annotations=true +cleanup.add_missing_override_annotations_interface_methods=true +cleanup.add_serial_version_id=true +cleanup.always_use_blocks=true +cleanup.always_use_parentheses_in_expressions=false +cleanup.always_use_this_for_non_static_field_access=true +cleanup.always_use_this_for_non_static_method_access=false +cleanup.convert_functional_interfaces=false +cleanup.convert_to_enhanced_for_loop=false +cleanup.convert_to_enhanced_for_loop_if_loop_var_used=false +cleanup.correct_indentation=true +cleanup.format_source_code=true +cleanup.format_source_code_changes_only=false +cleanup.insert_inferred_type_arguments=false +cleanup.lazy_logical_operator=false +cleanup.make_local_variable_final=false +cleanup.make_parameters_final=true +cleanup.make_private_fields_final=false +cleanup.make_type_abstract_if_missing_method=false +cleanup.make_variable_declarations_final=true +cleanup.merge_conditional_blocks=false +cleanup.never_use_blocks=false +cleanup.never_use_parentheses_in_expressions=true +cleanup.number_suffix=false +cleanup.organize_imports=false +cleanup.push_down_negation=false +cleanup.qualify_static_field_accesses_with_declaring_class=false +cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true +cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true +cleanup.qualify_static_member_accesses_with_declaring_class=true +cleanup.qualify_static_method_accesses_with_declaring_class=false +cleanup.remove_private_constructors=true +cleanup.remove_redundant_modifiers=false +cleanup.remove_redundant_semicolons=false +cleanup.remove_redundant_type_arguments=true +cleanup.remove_trailing_whitespaces=true +cleanup.remove_trailing_whitespaces_all=true +cleanup.remove_trailing_whitespaces_ignore_empty=false +cleanup.remove_unnecessary_array_creation=false +cleanup.remove_unnecessary_casts=true +cleanup.remove_unnecessary_nls_tags=true +cleanup.remove_unused_imports=true +cleanup.remove_unused_local_variables=false +cleanup.remove_unused_private_fields=true +cleanup.remove_unused_private_members=false +cleanup.remove_unused_private_methods=true +cleanup.remove_unused_private_types=true +cleanup.simplify_lambda_expression_and_method_ref=false +cleanup.sort_members=true +cleanup.sort_members_all=false +cleanup.use_anonymous_class_creation=false +cleanup.use_autoboxing=false +cleanup.use_blocks=true +cleanup.use_blocks_only_for_return_and_throw=false +cleanup.use_directly_map_method=false +cleanup.use_lambda=true +cleanup.use_parentheses_in_expressions=false +cleanup.use_this_for_non_static_field_access=true +cleanup.use_this_for_non_static_field_access_only_if_necessary=false +cleanup.use_this_for_non_static_method_access=false +cleanup.use_this_for_non_static_method_access_only_if_necessary=true +cleanup.use_unboxing=false +cleanup.use_var=false +cleanup_profile=_StatoolInfos +cleanup_settings_version=2 +eclipse.preferences.version=1 +editor_save_participant_org.eclipse.jdt.ui.postsavelistener.cleanup=true +formatter_profile=_StatoolInfos +formatter_settings_version=19 +jautodoc.cleanup.add_header=false +jautodoc.cleanup.javadoc=false +jautodoc.cleanup.replace_header=false +sp_cleanup.add_default_serial_version_id=true +sp_cleanup.add_generated_serial_version_id=false +sp_cleanup.add_missing_annotations=true +sp_cleanup.add_missing_deprecated_annotations=true +sp_cleanup.add_missing_methods=false +sp_cleanup.add_missing_nls_tags=false +sp_cleanup.add_missing_override_annotations=true +sp_cleanup.add_missing_override_annotations_interface_methods=true +sp_cleanup.add_serial_version_id=false +sp_cleanup.always_use_blocks=true +sp_cleanup.always_use_parentheses_in_expressions=false +sp_cleanup.always_use_this_for_non_static_field_access=true +sp_cleanup.always_use_this_for_non_static_method_access=false +sp_cleanup.convert_to_enhanced_for_loop=false +sp_cleanup.correct_indentation=true +sp_cleanup.format_source_code=true +sp_cleanup.format_source_code_changes_only=false +sp_cleanup.make_local_variable_final=false +sp_cleanup.make_parameters_final=true +sp_cleanup.make_private_fields_final=false +sp_cleanup.make_type_abstract_if_missing_method=false +sp_cleanup.make_variable_declarations_final=true +sp_cleanup.never_use_blocks=false +sp_cleanup.never_use_parentheses_in_expressions=true +sp_cleanup.on_save_use_additional_actions=true +sp_cleanup.organize_imports=true +sp_cleanup.qualify_static_field_accesses_with_declaring_class=false +sp_cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true +sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true +sp_cleanup.qualify_static_member_accesses_with_declaring_class=false +sp_cleanup.qualify_static_method_accesses_with_declaring_class=false +sp_cleanup.remove_private_constructors=true +sp_cleanup.remove_trailing_whitespaces=false +sp_cleanup.remove_trailing_whitespaces_all=true +sp_cleanup.remove_trailing_whitespaces_ignore_empty=false +sp_cleanup.remove_unnecessary_casts=true +sp_cleanup.remove_unnecessary_nls_tags=true +sp_cleanup.remove_unused_imports=true +sp_cleanup.remove_unused_local_variables=false +sp_cleanup.remove_unused_private_fields=true +sp_cleanup.remove_unused_private_members=false +sp_cleanup.remove_unused_private_methods=true +sp_cleanup.remove_unused_private_types=true +sp_cleanup.sort_members=true +sp_cleanup.sort_members_all=false +sp_cleanup.use_blocks=true +sp_cleanup.use_blocks_only_for_return_and_throw=false +sp_cleanup.use_parentheses_in_expressions=false +sp_cleanup.use_this_for_non_static_field_access=true +sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=false +sp_cleanup.use_this_for_non_static_method_access=false +sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=true diff --git a/.settings/org.eclipse.wst.common.component b/.settings/org.eclipse.wst.common.component new file mode 100644 index 0000000..8557b74 --- /dev/null +++ b/.settings/org.eclipse.wst.common.component @@ -0,0 +1,6 @@ + + + + + + diff --git a/.settings/org.eclipse.wst.common.project.facet.core.xml b/.settings/org.eclipse.wst.common.project.facet.core.xml new file mode 100644 index 0000000..138bbd1 --- /dev/null +++ b/.settings/org.eclipse.wst.common.project.facet.core.xml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/CONCEPT.md b/CONCEPT.md new file mode 100644 index 0000000..03bab92 --- /dev/null +++ b/CONCEPT.md @@ -0,0 +1,47 @@ +# Concepts de StatoolInfos + +## Principe générale + +StatoolInfos s'appuie sur StatoolInfos qui utilise des fichiers publics disponibles via des liens web : + +- 1 fichier web public pour décrire la fédération ; +- 1 fichier web public par organisation membre de la fédération ; +- 1 fichier web public par service d'organisation. + +Chaque fichier web public étant acessible via un lien web, chaque fichier public peut se trouver sur un site web différent. + +Chaque fichier web public contient des informations descriptives et potentiellement des métriques d'activité. + +Il suffit de récupérer tous les fichiers web publics afin de pouvoir générer des pages web, des statistiques, des graphiques… + + +## Format des fichiers web publics + +Dans StatoolInfos, ce sont des fichiers « properties », c'est à dire ne contenant que des lignes de texte au format « clé/valeur ». La clé consiste en un chemin de mots séparés par des points. Le premier mot est appelé la section. + +Donc chaque fichier web public est une liste de sections. + +Les lignes vides et les lignes commençant par un « # » sont ignorées. + +Exemple : + +''' +# [Organisation] +organization.name=Chapril +organization.description=Chapril est le chaton de l\'April. +organization.website=https://www.chapril.org/ +organization.logo.url= +organization.owner.name=April +organization.owner.website=https://www.april.org/ +organization.owner.logo= +organization.geography= +organization.contact.url=https://www.chapril.org/contact.xhtml +organization.contact.email=contact@chapril.org +organization.legal.url= +organization.technical.url= +organization.startDate= +organization.endDate= + +''' + +La liste des chemins est normalisée dans une ontologie. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/ONTOLOGY.md b/ONTOLOGY.md new file mode 100644 index 0000000..96da418 --- /dev/null +++ b/ONTOLOGY.md @@ -0,0 +1,202 @@ +# StatoolInfos + +StatoolInfos is… + +Data are stored in property files. Each entry line uses key defined by convention. + +## Primitive Types + +| Type | Description | Pattern | Example | +| ------ | ------ | ------ | ------ | +| DATE | A date in ISO format | ISO_DATE | 2020-07-06 | +| DATETIME | A date and time in ISO format | ISO_DATETIME | 2020-07-06T14:23:20 | +| DAYS | List of 366 NUMERIC separated by SEPARATOR | STU | 1;2;3;4;5;…;365 | +| EMAIL | An electronic address. | ^.+@.+$ | christian@momon.org | +| MONTHS | List of 12 NUMERIC separated by SEPARATOR | STU | 1;2;3;4;5;6;7;9;10;11;12 | +| NUMERIC | A numeric value | STU | -1234.567 | +| NUMERICS | List of NUMERIC separated by SEPARATOR | STU | 12.34;56.78;9 | +| SEPARATOR | The default separator character | `;` | Foo;foo;;foo | +| STATUS | A status. | ON/MAINTENANCE/DOWN/OFF/DRAFT | ON | +| STRING | Foo string. With `
` or `\n`. | ^.*$ | Foo is foo. | +| URL | A web link | ^https?://.+\..+/+$ | https://foo.foo/ | +| VALUE | String not containg SEPARATOR character | Foo | +| VALUES | List of VALUE separated by SEPARATOR | STU | foo1;foo2;foo3 | +| WEEKS | List of 52 NUMERIC separated by SEPARATOR | STU | 1;2;3;4;5;…;51;52 | + +Note for list: +* empty value or null value are available; +* shorter list designs empty values. + + + +## Sections + +### Federation section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------| ------ | ------ | +| federation.name | STRING | Yes | Name of federation | CHATONS | +| federation.description | STRING | Yes | Desciption of the federation | Collectif CHATONS | +| federation.website | URL | Yes | Official website URL of the federation | https://www.chatons.org/ | +| federation.logo | URL | Wished | URL of the organization logo | https://chatons.org/logo_chatons_v2.png | +| federation.favicon | URL | Wished | URL of the organization favicon | https://chatons.org/sites/default/files/chatons_logo_tiny.png | +| federation.contact.url | URL | No | Contact webpage of the federation | https://www.chatons.org/contact | +| federation.contact.email | EMAIL | Yes | Contact email of the federation | contact@chatons.org | +| federation.legal.url | URL | No | Legal webpage of the federation | https://www.chatons.org/page/mentions-l%C3%A9gales | +| federation.documentation.url | URL | No | Documentation webpage of the federation | https://wiki.chatons.org/ | +| federation.documentation.technical.url | URL | No | Technical documentation webpage of the federation | | +| federation.documentation.tutorial.url | URL | No | Tutorial documentation webpage of the federation | | +| federation.birthdate | DATE | No | Date of birth of the federation | 09/02/2016 | + + +### File section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| file.class | Federation/Organization/Service/Device | Yes | Class of the content | Service | +| file.protocol | STRING | Yes | Version of the StatoolInfos schema | StatoolInfos-0.1 | +| file.datetime | DATETIME | Yes | Date and time of the file build. | 2020-07-06T14:23:20 | +| file.generator | STRING | Yes | Generator of the file. | Cpm hands | +| file.url | URL | Yes | Origin URL of the file. | Cpm hands | + + +### Host section (dratf) + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| host.name | STRING | Yes | Name of the host | foo | +| host.provider | STRING | Yes | Provider of the host | foo | +| host.description | STRING | Wished | Description of the host | The virtual machine called foo | +| host.type | VPS / CLOUD / LOCATEDSERVER / HOSTSERVER / HOMESERVER / RASPERRY | Wished | Type of the host | HOMESERVER | +| host.country.name | STRING | Wished | Country name of the host | France | +| host.country.code | STRING | Wished | ISO country code of the host | FR | + + +### Metrics section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| metrics.foo1.foo2.name | STRING | Wished | Name of metric | visitor Ip | +| metrics.foo1.foo2.description | STRING | Wished | Description of metric | Nombre d'ip ayant visitées | +| metrics.foo1.foo2.2020 | NUMERIC | No | Count of foo1.foo2 | 123 | +| metrics.foo1.foo2.2020.months | MONTHS | No | Month count of foo1.foo2 for year 2020 | 100;200;300;;;; | +| metrics.foo1.foo2.2020.weeks | WEEKS | No | Week count of foo1.foo2 for year 2020 | 100;200;300;;;; | +| metrics.foo1.foo2.2020.days | DAYS | No | Day count of foo1.foo2 for year 2020 | 100;200;300;;;; | + +Examples: +``` +metrics.visitors.ipv4.2020=123 +metrics.visitors.ipv6.2020=123 +metrics.visitors.total.2020=246 + +metrics.visitors.ipv4.2020.months=12;34;56; +metrics.visitors.ipv6.2020.months=12;34;56; +metrics.visitors.total.2020.months=24;68;112; + +metrics.visitors.ipv4.2020.weeks=123;456; +metrics.visitors.ipv6.2020.weeks=123;456; +metrics.visitors.total.2020.weeks=246;912; + +metrics.visitors.ipv4.2020.days=123;456; +metrics.visitors.ipv6.2020.days=123;456; +metrics.visitors.total.2020.days=246;912; +``` + + +### Organization section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| organization.name | STRING | Yes | Name of the organization | Chapril | +| organization.description | STRING | Wished | Description of the organization | Chapril est le chaton de l'April | +| organization.website | URL | Y | Official website of the organization | httsp://www.chapril.org/ | +| organization.logo | URL | Wished | Logo URL of the organization | https://date.chapril.org/Chapril-banner/v1/chapril-logo-small.png | +| organization.favicon | URL | Wished | Favicon URL of the organization | https://date.chapril.org/favicon.png | +| organization.owner.name | STRING | No | Name of the organization owner | April | +| organization.owner.website | URL | No | Official website of the organization owner | https://www.april.org/ | +| organization.owner.logo | URL | No | Logo URL of the organization owner | https://www.april.org/sites/default/themes/zen_april/logo.png | +| organization.owner.favicon | URL | No | Favicon URL of the organization owner | https://www.april.org/sites/default/themes/zen_april/favicon.ico | +| organization.contact.url | URL | Wished | Contact webpage of the organization | https://www.chapril.org/contact.html | +| organization.contact.email | EMAIL | Contact email of the organization | contact@chapril.org | +| organization.legal.url | URL | Wished | Legal webpage of the organization | https://www.chapril.org/cgu.html | +| organization.documentation.technical.url | URL | Wished | Technical documentation webpage of the organization | https://admin.chapril.org/ | +| organization.birthdate | DATE | Wished | Birth date of the organization | 08/11/2018 | + + +### Service section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| service.name | STRING | Yes | Service name. | MumbleChaprilOrg | +| service.description | STRING | Yes | Service description. | Service libre de conférence audio | +| service.organization.name | STRING | Yes | Organization name. | Chapril | +| service.website.url | URL | Wished | Website of the service | https://mumble.chapril.org/ | +| service.legal.url | URL | Wished | URL | Legal webpage of the organization | https://www.chapril.org/cgu.html | +| service.documentation.technical.url | URL | No | Technical documentation webpage of the service | https://admin.chapril.org/doku.php?id=admin:services:mumble.chapril.org | +| service.documentation.tutorial.url | URL | No | Tutorial documentation webpage of the service | https://www.chapril.org/Mumble.html | +| service.contact.url | URL | Wished | Contact webpage of the service | contact@chapril.org | +| service.contact.email | EMAIL | Wished | Contact email of the service | mumble-support@chapril.org | +| service.birthdate | DATETIME | Wished | Birth date of the service | 20/03/2020 | +| service.deathdate | DATETIME | No | Death date of the service | | +| service.status | STATUS | Yes | Service status. | ON | +| service.registration | None;Free;Member;Client | Yes | Registration requirement | Free; Member| + +### Subs section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| subs.foo | URL | No | URL of a sub node. | Firefox Send | + +Example: +``` +subs.datechaprilorg=https://date.chapril.org/.well-known/datechaprilorg.properties +subs.pastechaprilorg=https://paste.chapril.org/.well-known/pastechaprilorg.properties +subs.dropchaprilorg=https://drop.chapril.org/.well-known/dropchaprilorg.properties +``` + + + +### Software section + +| Field | Type | Mandatory | Description | Example | +| ------ | ------ | ------ | ------ | ------ | +| software.name | STRING | Yes | Name of the software | Firefox Send | +| software.website | URL | Yes | Offical website of the software | https://send.firefox.com/ | +| software.license.url | URL | Yes | Webpage of the software license | https://forge.april.org/Chapril/drop.chapril.org-firefoxsend/src/branch/chapril-v3.0.21/LICENSE | +| software.license.name | STRING | Yes | Name of the license | Mozilla Public License Version 2.0 | +| software.version | STRING | Yes | Version of the software | Chapril-3.0.21 | +| software.source.url | URL | Yes | URL of the software source | https://forge.april.org/Chapril/drop.chapril.org-firefoxsend/ | + + + + + +## Classes + +### Federation class + +Federation = file + federation + subs + metrics + +### Organization class + +Organization = file + organization + subs + metrics + +### Service class + +Service = file + service + host + software + metrics + extras + +### Device class + +Device = file + device + system + + + +# Draft + +| Field | Type | Mandatory | Description | +| ------ | ------ | ------ | ------ | +| services.* | URL | Y | URL of the Statool file of the service | + +| Field | Type | Mandatory | Description | +| ------ | ------ | ------ | ------ | +| services.urls.* | URL | Y | URL of services | diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f502d8 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# StatoolInfos + +StatoolInfos is a simple statistic tool software. + + +## LICENSE + +StatoolInfos is released under the GNU AGPL+ license. Enjoy! + +## AUTHOR + +Christian Pierre MOMON + +## DOCUMENTATION + +Read CONCEPT.md and ONTOLOGY.md files. + +## INSTALL + +TODO + +### Unit test environment +For unit tests, install the TestNG: +* https://marketplace.eclipse.org/content/testng-eclipse +* Eclipse menu > Help > Eclipse Marketplace > Find "TestNG" > TestNG for Eclipse: Install button + +## LOGO +Author: Christian Pierre MOMON + +License: Creative Commons CC-BY-SA last version. diff --git a/build-appjar.xml b/build-appjar.xml new file mode 100644 index 0000000..9bcf0a2 --- /dev/null +++ b/build-appjar.xml @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Done. + + + + + Type ant -p + + + + + + + + + + + + + + + + + classpath=${toString:project.libs} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/build-local.xml b/build-local.xml new file mode 100644 index 0000000..42599df --- /dev/null +++ b/build-local.xml @@ -0,0 +1,6 @@ + + + + + + diff --git a/build-snapshot.xml b/build-snapshot.xml new file mode 100644 index 0000000..3c68374 --- /dev/null +++ b/build-snapshot.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/build-tagandpush.xml b/build-tagandpush.xml new file mode 100644 index 0000000..326d0e4 --- /dev/null +++ b/build-tagandpush.xml @@ -0,0 +1,6 @@ + + + + + + diff --git a/build.num b/build.num new file mode 100644 index 0000000..3201934 --- /dev/null +++ b/build.num @@ -0,0 +1,3 @@ +#Build Number for ANT. Do not edit! +#Wed Mar 25 02:52:42 CET 2020 +build.number=0 diff --git a/build.properties b/build.properties new file mode 100644 index 0000000..22573d3 --- /dev/null +++ b/build.properties @@ -0,0 +1,3 @@ +product.name=statoolinfos +product.revision.major=0 +product.revision.minor=1 diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..04c308a --- /dev/null +++ b/build.sh @@ -0,0 +1,168 @@ +#/bin/bash + +# +# Display help. +# +function help +{ + echo "StatoolInfos build script." + echo "Usage: build.sh [ -h | -help | --help | -snapshot | -local | -full ]" + echo " -h, -help, --help display this help." + echo " -snapshot, --snapshot build a snapshot." + echo " -local, --local build a new version without tag nor version number commit nor Git push." + echo " -tagandpush, --tagandpush build a new version with tag, version number commit and Git push." + echo "" +} + +# +# Build snapshot. +# +function build_snapshot +{ + okCount=0 + + # Ant check. + antCheck=`which ant` + if [[ "$antCheck" =~ ^/.* ]]; then + echo "Ant requirement................ OK" + let "okCount+=1" + else + echo "Ant requirement................ MISSING" + fi + + # Javac check. + javacCheck=`which javac` + if [[ "$javacCheck" =~ ^/.* ]]; then + echo "Javac requirement.............. OK" + let "okCount+=1" + else + echo "Javac requirement.............. MISSING" + fi + + # Java version check. + javaVersionCheck=`javac -version 2>&1` + if [[ "$javaVersionCheck" =~ ^.*\ 1.11 ]]; then + echo "Java 11 version requirement..... OK" + let "okCount+=1" + else + echo "Java 11 version requirement..... MISSING" + fi + + if [ "$okCount" == 3 ]; then + echo "Requirement OK" + ant -f build-snapshot.xml + else + echo "Requirement MISSING, build abort" + fi +} + +# +# Build local. +# +function build_local +{ + okCount=0 + + # Ant check. + antCheck=`which ant` + if [[ "$antCheck" =~ ^/.* ]]; then + echo "Ant requirement................ OK" + let "okCount+=1" + else + echo "Ant requirement................ MISSING" + fi + + # Javac check. + javacCheck=`which javac` + if [[ "$javacCheck" =~ ^/.* ]]; then + echo "Javac requirement.............. OK" + let "okCount+=1" + else + echo "Javac requirement.............. MISSING" + fi + + # Java version check. + javaVersionCheck=`javac -version 2>&1` + if [[ "$javaVersionCheck" =~ ^.*\ 1.11 ]]; then + echo "Java 11 version requirement..... OK" + let "okCount+=1" + else + echo "Java 11 version requirement..... MISSING" + fi + + if [ "$okCount" == 3 ]; then + echo "Requirement OK" + ant -f build-local.xml + else + echo "Requirement MISSING, build abort" + fi +} + +# +# Build tagandpush. +# +function build_tagandpush +{ + okCount=0 + + # Ant check. + antCheck=`which ant` + if [[ "$antCheck" =~ ^/.* ]]; then + echo "Ant requirement................ OK" + let "okCount+=1" + else + echo "Ant requirement................ MISSING" + fi + + # Javac check. + javacCheck=`which javac` + if [[ "$javacCheck" =~ ^/.* ]]; then + echo "Javac requirement.............. OK" + let "okCount+=1" + else + echo "Javac requirement.............. MISSING" + fi + + # Java version check. + javaVersionCheck=`javac -version 2>&1` + if [[ "$javaVersionCheck" =~ ^.*\ 1.11 ]]; then + echo "Java 11 version requirement..... OK" + let "okCount+=1" + else + echo "Java 11 version requirement..... MISSING" + fi + + # Git check. + gitCheck=`which git 2>&1` + if [[ "$gitCheck" =~ ^/.* ]]; then + echo "GIT requirement................ OK" + let "okCount+=1" + else + echo "GIT requirement................ MISSING" + fi + + if [ "$okCount" == 4 ]; then + echo "Requirement OK" + ant -f build-tagandpush.xml + else + echo "Requirement MISSING, build abort" + fi +} + +# +# Main. +# +if [ "$#" -eq 0 ] || [ "$1" == "-h" ] || [ "$1" == "-help" ] || [ "$1" == "--help" ]; then + help +elif [ "$1" == "-snapshot" ] || [ "$1" == "--snapshot" ] ; then + build_snapshot +elif [ "$1" == "-local" ] || [ "$1" == "--local" ] ; then + build_local +elif [ "$1" == "-tagandpush" ] || [ "$1" == "--tagandpush" ] ; then + build_tagandpush +else + echo "Invalid parameters." + help +fi + + diff --git a/lib/Logs/log4j-1.2.17-source.zip b/lib/Logs/log4j-1.2.17-source.zip new file mode 100644 index 0000000..2a9a7f4 Binary files /dev/null and b/lib/Logs/log4j-1.2.17-source.zip differ diff --git a/lib/Logs/log4j-1.2.17.jar b/lib/Logs/log4j-1.2.17.jar new file mode 100644 index 0000000..068867e Binary files /dev/null and b/lib/Logs/log4j-1.2.17.jar differ diff --git a/lib/Logs/slf4j-api-1.7.25-sources.jar b/lib/Logs/slf4j-api-1.7.25-sources.jar new file mode 100644 index 0000000..b2a3d83 Binary files /dev/null and b/lib/Logs/slf4j-api-1.7.25-sources.jar differ diff --git a/lib/Logs/slf4j-api-1.7.25.jar b/lib/Logs/slf4j-api-1.7.25.jar new file mode 100644 index 0000000..7e62f13 Binary files /dev/null and b/lib/Logs/slf4j-api-1.7.25.jar differ diff --git a/lib/Logs/slf4j-log4j12-1.7.25-sources.jar b/lib/Logs/slf4j-log4j12-1.7.25-sources.jar new file mode 100644 index 0000000..0cd5be7 Binary files /dev/null and b/lib/Logs/slf4j-log4j12-1.7.25-sources.jar differ diff --git a/lib/Logs/slf4j-log4j12-1.7.25.jar b/lib/Logs/slf4j-log4j12-1.7.25.jar new file mode 100644 index 0000000..4a44e06 Binary files /dev/null and b/lib/Logs/slf4j-log4j12-1.7.25.jar differ diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..2f0835d --- /dev/null +++ b/lib/README @@ -0,0 +1,20 @@ +Description of used libraries: + +- Logs/ + - log4j log API + - slf4j-api facade log API + - slf4j-log4j12 adaptation layer between slf4j and log4j + +- UnitTesting/ + - hamcrest-core required by junit + - hsqldb SQL Database for unit test. + - junit unit tests API + +- other: + - commons-codec digest tools + - commons-io + - commons-lang useful tools (StringUtils...) + - devinsy-strings + - devinsy-xml + - hsqldb + - mysql-jdbc \ No newline at end of file diff --git a/lib/UnitTesting/hamcrest-core-1.3-sources.jar b/lib/UnitTesting/hamcrest-core-1.3-sources.jar new file mode 100644 index 0000000..c3c110b Binary files /dev/null and b/lib/UnitTesting/hamcrest-core-1.3-sources.jar differ diff --git a/lib/UnitTesting/hamcrest-core-1.3.jar b/lib/UnitTesting/hamcrest-core-1.3.jar new file mode 100644 index 0000000..9d5fe16 Binary files /dev/null and b/lib/UnitTesting/hamcrest-core-1.3.jar differ diff --git a/lib/UnitTesting/junit-4.12-sources.jar b/lib/UnitTesting/junit-4.12-sources.jar new file mode 100644 index 0000000..884f92f Binary files /dev/null and b/lib/UnitTesting/junit-4.12-sources.jar differ diff --git a/lib/UnitTesting/junit-4.12.jar b/lib/UnitTesting/junit-4.12.jar new file mode 100644 index 0000000..3a7fc26 Binary files /dev/null and b/lib/UnitTesting/junit-4.12.jar differ diff --git a/lib/commons-cli-1.4-javadoc.jar b/lib/commons-cli-1.4-javadoc.jar new file mode 100644 index 0000000..6b21f98 Binary files /dev/null and b/lib/commons-cli-1.4-javadoc.jar differ diff --git a/lib/commons-cli-1.4-sources.jar b/lib/commons-cli-1.4-sources.jar new file mode 100644 index 0000000..b747279 Binary files /dev/null and b/lib/commons-cli-1.4-sources.jar differ diff --git a/lib/commons-cli-1.4.jar b/lib/commons-cli-1.4.jar new file mode 100644 index 0000000..22deb30 Binary files /dev/null and b/lib/commons-cli-1.4.jar differ diff --git a/lib/commons-codec-1.8-sources.jar b/lib/commons-codec-1.8-sources.jar new file mode 100644 index 0000000..900af03 Binary files /dev/null and b/lib/commons-codec-1.8-sources.jar differ diff --git a/lib/commons-codec-1.8.jar b/lib/commons-codec-1.8.jar new file mode 100644 index 0000000..32f84c9 Binary files /dev/null and b/lib/commons-codec-1.8.jar differ diff --git a/lib/commons-io-2.7-sources.jar b/lib/commons-io-2.7-sources.jar new file mode 100644 index 0000000..d019235 Binary files /dev/null and b/lib/commons-io-2.7-sources.jar differ diff --git a/lib/commons-io-2.7.jar b/lib/commons-io-2.7.jar new file mode 100644 index 0000000..5889458 Binary files /dev/null and b/lib/commons-io-2.7.jar differ diff --git a/lib/commons-lang3-3.7-sources.jar b/lib/commons-lang3-3.7-sources.jar new file mode 100644 index 0000000..a83c661 Binary files /dev/null and b/lib/commons-lang3-3.7-sources.jar differ diff --git a/lib/commons-lang3-3.7.jar b/lib/commons-lang3-3.7.jar new file mode 100644 index 0000000..f37ded6 Binary files /dev/null and b/lib/commons-lang3-3.7.jar differ diff --git a/lib/devinsy-strings-0.11.0-javadoc.zip b/lib/devinsy-strings-0.11.0-javadoc.zip new file mode 100644 index 0000000..5dcfbe1 Binary files /dev/null and b/lib/devinsy-strings-0.11.0-javadoc.zip differ diff --git a/lib/devinsy-strings-0.11.0-sources.zip b/lib/devinsy-strings-0.11.0-sources.zip new file mode 100644 index 0000000..eb31276 Binary files /dev/null and b/lib/devinsy-strings-0.11.0-sources.zip differ diff --git a/lib/devinsy-strings-0.11.0.jar b/lib/devinsy-strings-0.11.0.jar new file mode 100644 index 0000000..1926831 Binary files /dev/null and b/lib/devinsy-strings-0.11.0.jar differ diff --git a/lib/hsqldb-2.3.0.jar b/lib/hsqldb-2.3.0.jar new file mode 100644 index 0000000..de45eda Binary files /dev/null and b/lib/hsqldb-2.3.0.jar differ diff --git a/lib/mysql-jdbc-5.0.8.jar b/lib/mysql-jdbc-5.0.8.jar new file mode 100644 index 0000000..0170c3e Binary files /dev/null and b/lib/mysql-jdbc-5.0.8.jar differ diff --git a/lib/xidyn-1.11.0-sources.zip b/lib/xidyn-1.11.0-sources.zip new file mode 100644 index 0000000..12d2d67 Binary files /dev/null and b/lib/xidyn-1.11.0-sources.zip differ diff --git a/lib/xidyn-1.11.0.jar b/lib/xidyn-1.11.0.jar new file mode 100644 index 0000000..42daf6c Binary files /dev/null and b/lib/xidyn-1.11.0.jar differ diff --git a/log4j.properties b/log4j.properties new file mode 100644 index 0000000..68a334f --- /dev/null +++ b/log4j.properties @@ -0,0 +1,12 @@ +# Log configuration +# ################# + +# priority setting: DEBUG < INFO < WARN < ERROR +log4j.rootLogger = DEBUG, console +log4j.logger.org.april.tatoolinfos = INFO +log4j.logger.fr.devinsy.xidyn = WARN + +#-- +log4j.appender.console = org.apache.log4j.ConsoleAppender +log4j.appender.console.layout = org.apache.log4j.PatternLayout +log4j.appender.console.layout.ConversionPattern = %d{ISO8601} - StatoolInfos [%-5p] %34.34c.%25M - %m%n diff --git a/resources/conf/log4j-default.properties b/resources/conf/log4j-default.properties new file mode 100644 index 0000000..1a427e7 --- /dev/null +++ b/resources/conf/log4j-default.properties @@ -0,0 +1,21 @@ +# Log configuration +# ################# + +# priority setting: DEBUG < INFO < WARN < ERROR +log4j.rootLogger = INFO, stdout, LogWriter +log4j.logger.org.april.statoolinfos = INFO +log4j.logger.fr.devinsy.xidyn = INFO + +#-- +log4j.appender.stdout = org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout = org.apache.log4j.PatternLayout +log4j.appender.stdout.layout.ConversionPattern = %m%n + + +#-- +log4j.appender.LogWriter = org.apache.log4j.RollingFileAppender +log4j.appender.LogWriter.File = /srv/StatoolInfos/tatoolinfos.log +log4j.appender.LogWriter.MaxFileSize = 100000KB +log4j.appender.LogWriter.MaxBackupIndex = 5 +log4j.appender.LogWriter.layout = org.apache.log4j.PatternLayout +log4j.appender.LogWriter.layout.ConversionPattern = %d{ISO8601} - InfosStatool [%-5p] %34.34c.%-25M - %m%n diff --git a/resources/conf/statoolinfos-sample.conf b/resources/conf/statoolinfos-sample.conf new file mode 100644 index 0000000..fbd45c8 --- /dev/null +++ b/resources/conf/statoolinfos-sample.conf @@ -0,0 +1,12 @@ +# +# Sample StatoolInfos config file. +# +# Note: move this file outside the git directory. + +database.url=jdbc:mysql://localhost/ +database.name=agir2020 +database.login=admin +database.password=suko7Gun + +targetDirectory=/home/cpm/Projets/StatoolInfos/TestZone/www + diff --git a/resources/conf/statoolinfos.cron b/resources/conf/statoolinfos.cron new file mode 100644 index 0000000..1c7189a --- /dev/null +++ b/resources/conf/statoolinfos.cron @@ -0,0 +1,3 @@ +LANGUAGE=fr_FR.UTF8 +LC_ALL=fr_FR.UTF-8 +/5 * * * * root /srv/statoolinfos/bin/statoolinfo.sh > /srv/statoolinfos/statoolinfos-cron.log diff --git a/resources/scripts/statoolinfos.sh b/resources/scripts/statoolinfos.sh new file mode 100755 index 0000000..32eedcd --- /dev/null +++ b/resources/scripts/statoolinfos.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +# Java check. +javaCheck=`which java` +if [[ "$javaCheck" =~ ^/.* ]]; then + echo "Java requirement............... OK" + java -jar "$(dirname "$0")"/statoolinfos.jar $@ +else + echo "Java requirement............... MISSING" +fi diff --git a/src/META-INF/MANIFEST.MF b/src/META-INF/MANIFEST.MF new file mode 100644 index 0000000..5e94951 --- /dev/null +++ b/src/META-INF/MANIFEST.MF @@ -0,0 +1,3 @@ +Manifest-Version: 1.0 +Class-Path: + diff --git a/src/META-INF/context.xml b/src/META-INF/context.xml new file mode 100644 index 0000000..e7fe6fb --- /dev/null +++ b/src/META-INF/context.xml @@ -0,0 +1,9 @@ + + + + + diff --git a/src/fr/devinsy/statoolinfos/StatoolInfosLauncher.java b/src/fr/devinsy/statoolinfos/StatoolInfosLauncher.java new file mode 100644 index 0000000..b8174d5 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/StatoolInfosLauncher.java @@ -0,0 +1,70 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos; + +import java.io.File; + +import org.apache.log4j.BasicConfigurator; +import org.apache.log4j.ConsoleAppender; +import org.apache.log4j.EnhancedPatternLayout; +import org.apache.log4j.PropertyConfigurator; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.statoolinfos.cli.StatoolInfosCLI; + +/** + * The Class StatoolInfosLauncher. + */ +public final class StatoolInfosLauncher +{ + private static Logger logger = LoggerFactory.getLogger(StatoolInfosLauncher.class); + + /** + * Instantiates a new statool infos launcher. + */ + private StatoolInfosLauncher() + { + } + + /** + * The main method. + * + * @param args + * the arguments + */ + public static void main(final String[] args) + { + // Configure log. + File loggerConfig = new File("log4j.peroperties"); + if (loggerConfig.exists()) + { + PropertyConfigurator.configure(loggerConfig.getAbsolutePath()); + logger.info("Dedicated log configuration done."); + logger.info("Configuration file was found in [{}].", loggerConfig.getAbsoluteFile()); + } + else + { + BasicConfigurator.configure(new ConsoleAppender(new EnhancedPatternLayout("%m%n"))); + } + + // Run. + StatoolInfosCLI.run(args); + } +} diff --git a/src/fr/devinsy/statoolinfos/cli/StatoolInfosCLI.java b/src/fr/devinsy/statoolinfos/cli/StatoolInfosCLI.java new file mode 100644 index 0000000..156190b --- /dev/null +++ b/src/fr/devinsy/statoolinfos/cli/StatoolInfosCLI.java @@ -0,0 +1,297 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.cli; + +import java.io.File; +import java.time.LocalDateTime; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.statoolinfos.core.StatoolInfos; +import fr.devinsy.statoolinfos.utils.Files; +import fr.devinsy.strings.StringList; +import utils.BuildInformation; + +/** + * The Class StatoolInfosCLI manages a Command Line Interface for + * StatoolInfos. + * + */ +public final class StatoolInfosCLI +{ + private static Logger logger = LoggerFactory.getLogger(StatoolInfosCLI.class); + + /** + * Instantiates a new statool infos CLI. + */ + private StatoolInfosCLI() + { + } + + /** + * Convert path. + * + * @param path + * the path + * @return the files + */ + public static Files convertPath(final String path) + { + Files result; + + result = new Files(); + + if (StringUtils.isNotBlank(path)) + { + File input = new File(path); + + if (input.exists()) + { + if (input.isFile()) + { + result.add(input); + } + else + { + for (File file : input.listFiles()) + { + if ((file.isFile()) && (file.getName().endsWith(".properties"))) + { + result.add(file); + } + } + } + } + else + { + result.add(input); + } + } + + // + return result; + } + + /** + * Display help. + */ + public static void displayHelp() + { + StringList message = new StringList(); + + message.append("StatoolInfos CLI version ").appendln(BuildInformation.instance().version()); + message.appendln("Usage:"); + message.appendln(" statoolinfos [ -h | -help | --help ]"); + message.appendln(" statoolinfos [ -v | -version | --version ]"); + message.appendln(" statoolinfos [ build | crawl | htmlize ] [ directory | file ]"); + message.appendln(" statoolinfos clear"); + + logger.info(message.toString()); + } + + /** + * Display version. + */ + public static void displayVersion() + { + StringList message = new StringList(); + + message.appendln(BuildInformation.instance().version()); + + logger.info(message.toString()); + } + + /** + * Checks if is matching. + * + * @param args + * the args + * @param regexps + * the regexps + * @return true, if is matching + */ + public static boolean isMatching(final String[] args, final String... regexps) + { + boolean result; + + if ((args.length == 0) && (regexps == null)) + { + result = true; + } + else if ((args.length != 0) && (regexps == null)) + { + result = false; + } + else if (args.length != regexps.length) + { + result = false; + } + else + { + boolean ended = false; + int index = 0; + result = false; + while (!ended) + { + if (index < args.length) + { + String arg = args[index]; + String regexp = regexps[index]; + + if (arg.matches(regexp)) + { + index += 1; + } + else + { + ended = true; + result = false; + } + } + else + { + ended = true; + result = true; + } + } + } + + // + return result; + } + + /** + * + * This method launch CLI. + * + * @param args + * necessary arguments + */ + public static void run(final String[] args) + { + // Set default catch. + Thread.setDefaultUncaughtExceptionHandler(new Thread.UncaughtExceptionHandler() + { + @Override + public void uncaughtException(final Thread thread, final Throwable exception) + { + String message; + if (exception instanceof OutOfMemoryError) + { + message = "Java ran out of memory!\n\n"; + } + else + { + message = String.format("An error occured: %1s(%2s)", exception.getClass(), exception.getMessage()); + } + + logger.error("uncaughtException ", exception); + logger.error(message); + logger.info("Oups, an unexpected error occured. Please try again."); + } + }); + + logger.info("{} StatoolInfos call: {}", LocalDateTime.now(), new StringList(args).toStringSeparatedBy(" ")); + + if (isMatching(args)) + { + logger.info("No parameter."); + displayHelp(); + } + else if (isMatching(args, "(-h|--h|--help)")) + { + displayHelp(); + } + else if (isMatching(args, "(-v|-version|--version)")) + { + displayVersion(); + } + else if (isMatching(args, "clear", "\\s*.+\\s*")) + { + Files inputs = convertPath(StringUtils.trim(args[1])); + for (File input : inputs) + { + try + { + StatoolInfos.clear(input); + } + catch (Exception exception) + { + logger.error("Error with [{}]: {}", input.getAbsoluteFile(), exception.getMessage()); + } + } + } + else if (isMatching(args, "build", "\\s*.+\\s*")) + { + Files inputs = convertPath(StringUtils.trim(args[1])); + for (File input : inputs) + { + try + { + StatoolInfos.build(input); + } + catch (Exception exception) + { + logger.error("Error with [{}]: {}", input.getAbsoluteFile(), exception.getMessage()); + } + } + } + else if (isMatching(args, "crawl", "\\s*.+\\s*")) + { + Files inputs = convertPath(StringUtils.trim(args[1])); + for (File input : inputs) + { + try + { + StatoolInfos.crawl(input); + } + catch (Exception exception) + { + logger.error("Error with [{}]: {}", input.getAbsoluteFile(), exception.getMessage()); + exception.printStackTrace(); + } + } + } + else if (isMatching(args, "htmlize", "\\s*.+\\s*")) + { + Files inputs = convertPath(StringUtils.trim(args[1])); + for (File input : inputs) + { + try + { + StatoolInfos.htmlize(input); + } + catch (Exception exception) + { + logger.error("Error with [{}]: {}", input.getAbsoluteFile(), exception.getMessage()); + } + } + } + else + { + logger.info("Bad usage."); + displayHelp(); + } + + // + logger.info("Finished."); + } +} diff --git a/src/fr/devinsy/statoolinfos/cli/StatoolInfosCLIException.java b/src/fr/devinsy/statoolinfos/cli/StatoolInfosCLIException.java new file mode 100644 index 0000000..513b58b --- /dev/null +++ b/src/fr/devinsy/statoolinfos/cli/StatoolInfosCLIException.java @@ -0,0 +1,72 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.cli; + +import fr.devinsy.statoolinfos.core.StatoolInfosException; + +/** + * The Class StatoolInfosCLIException. + */ +public class StatoolInfosCLIException extends StatoolInfosException +{ + private static final long serialVersionUID = 2986878456227891377L; + + /** + * Instantiates a new statool infos CLI exception. + */ + public StatoolInfosCLIException() + { + super(); + } + + /** + * Instantiates a new statool infos CLI exception. + * + * @param message + * the message + */ + public StatoolInfosCLIException(final String message) + { + super(message); + } + + /** + * Instantiates a new statool infos CLI exception. + * + * @param message + * the message + * @param cause + * the cause + */ + public StatoolInfosCLIException(final String message, final Throwable cause) + { + super(message, cause); + } + + /** + * Instantiates a new statool infos CLI exception. + * + * @param cause + * the cause + */ + public StatoolInfosCLIException(final Throwable cause) + { + super(cause); + } +} \ No newline at end of file diff --git a/src/fr/devinsy/statoolinfos/core/CrawlCache.java b/src/fr/devinsy/statoolinfos/core/CrawlCache.java new file mode 100644 index 0000000..adddbcf --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/CrawlCache.java @@ -0,0 +1,139 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import java.io.File; +import java.io.IOException; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * The Class CrawlCache. + */ +public class CrawlCache +{ + private static Logger logger = LoggerFactory.getLogger(CrawlCache.class); + + private File directory; + + /** + * Instantiates a new crawl cache. + * + * @param cacheDirectory + * the cache directory + * @throws StatoolInfosException + */ + public CrawlCache(final File directory) throws StatoolInfosException + { + if (directory == null) + { + throw new IllegalArgumentException("Null parameter."); + } + else if (StringUtils.isBlank(directory.getName())) + { + throw new IllegalArgumentException("Blank directory."); + } + else if (!directory.exists()) + { + throw new IllegalArgumentException("Directory does not exist."); + } + else + { + this.directory = directory; + } + } + + /** + * Builds the file. + * + * @param url + * the url + * @return the file + */ + private File buildFile(final String url) + { + File result; + + // result = new File(this.directory, DigestUtils.sha1Hex(url)); + + String normalizeUrl = StringUtils.removeAll(url, "^https*://").replace('/', '+'); + result = new File(this.directory, normalizeUrl); + + // + return result; + } + + /** + * Clear file in cache. Only files ending with ".property" are deleted. + */ + public void clear() + { + for (File file : this.directory.listFiles()) + { + if ((file.isFile()) && (file.getName().endsWith(".properties"))) + { + logger.info("Deleting " + file.getName()); + file.delete(); + } + } + } + + /** + * Load. + * + * @param url + * the url + * @return the path property list + * @throws IOException + */ + public PathPropertyList load(final String url) throws IOException + { + PathPropertyList result; + + File file = buildFile(url); + + result = PathPropertyUtils.load(file); + + // + return result; + } + + /** + * Store. + * + * @param url + * the url + * @param properties + * the properties + * @throws IOException + */ + public File store(final String url, final PathPropertyList properties) throws IOException + { + File result; + + result = buildFile(url); + + PathPropertyUtils.save(result, properties); + + // + return result; + } +} diff --git a/src/fr/devinsy/statoolinfos/core/PathProperties.java b/src/fr/devinsy/statoolinfos/core/PathProperties.java new file mode 100644 index 0000000..84dcf7c --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/PathProperties.java @@ -0,0 +1,140 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import fr.devinsy.strings.StringList; +import fr.devinsy.strings.StringSet; + +/** + * The Interface PathProperties. + */ +interface PathProperties +{ + /** + * Gets the. + * + * @param path + * the path + * @return the string + */ + String get(final String path); + + /** + * Gets the by prefix. + * + * @param prefix + * the prefix + * @return the by prefix + */ + public PathProperties getByPrefix(String prefix); + + /** + * Gets the keys. + * + * @return the keys + */ + StringList getPaths(); + + /** + * Gets the prefixes. + * + * @return the prefixes + */ + StringSet getPrefixes(); + + /** + * Gets the prefix list. + * + * @return the prefix list + */ + StringList getPrefixList(); + + /** + * Gets the property. + * + * @param path + * the path + * @return the property + */ + PathProperty getProperty(final String path); + + /** + * Put. + * + * @param key + * the key + * @param value + * the value + */ + void put(final String key, final String value); + + /** + * Delete path. + * + * @param path + * the path + */ + void removePath(final String path); + + /** + * Removes the prefix. + * + * @param prefix + * the prefix + */ + void removeSection(final String prefix); + + /** + * Size. + * + * @return the int + */ + int size(); + + /** + * To string list. + * + * @return the string list + */ + StringList toStringList(); + + /** + * To string list formatted. + * + * @return the string list + */ + StringList toStringListFormatted(); + + /** + * Gets the prefix. + * + * @param source + * the source + * @return the prefix + */ + static String getPrefix(final String source) + { + String result; + + result = source.substring(source.indexOf(".")); + + // + return result; + } +} diff --git a/src/fr/devinsy/statoolinfos/core/PathProperty.java b/src/fr/devinsy/statoolinfos/core/PathProperty.java new file mode 100644 index 0000000..577a21b --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/PathProperty.java @@ -0,0 +1,81 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import org.apache.commons.lang3.StringUtils; + +/** + * The Class PathProperty. + */ +public class PathProperty +{ + private String path; + private String value; + + /** + * Instantiates a new path property. + * + * @param path + * the key + * @param value + * the value + */ + public PathProperty(final String path, final String value) + { + if (StringUtils.isAllBlank(path)) + { + throw new IllegalArgumentException("Path is blank."); + } + else + { + this.path = path; + this.value = value; + } + } + + public String getLeaf() + { + String result; + + result = this.path.substring(this.path.lastIndexOf('.') + 1); + + // + return result; + } + + public String getPath() + { + return this.path; + } + + public String getValue() + { + return this.value; + } + + public void setPath(final String path) + { + this.path = path; + } + + public void setValue(final String value) + { + this.value = value; + } +} diff --git a/src/fr/devinsy/statoolinfos/core/PathPropertyList.java b/src/fr/devinsy/statoolinfos/core/PathPropertyList.java new file mode 100644 index 0000000..00a5fae --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/PathPropertyList.java @@ -0,0 +1,468 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import java.util.ArrayList; +import java.util.Iterator; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.strings.StringList; +import fr.devinsy.strings.StringSet; + +/** + * The Class StatoolsInfosProperties. + */ +public class PathPropertyList extends ArrayList implements PathProperties +{ + private static final long serialVersionUID = -8491243013973609457L; + private static final Logger logger = LoggerFactory.getLogger(PathPropertyList.class); + + /** + * Instantiates a new path property list. + */ + public PathPropertyList() + { + super(); + } + + /** + * Instantiates a new path property list. + * + * @param initialCapacity + * the initial capacity + */ + public PathPropertyList(final int initialCapacity) + { + super(initialCapacity); + } + + /** + * Instantiates a new path property list. + * + * @param source + * the source + */ + public PathPropertyList(final PathPropertyList source) + { + super(); + if (source != null) + { + this.ensureCapacity(source.size()); + + for (PathProperty property : source) + { + this.add(property); + } + } + } + + /** + * Gets the. + * + * @param path + * the path. + * @return the string + */ + @Override + public String get(final String path) + { + String result; + + PathProperty property = getProperty(path); + + if (property == null) + { + result = null; + } + else + { + result = property.getValue(); + } + + // + return result; + } + + /** + * Gets the by prefix. + * + * @param prefix + * the prefix + * @return the by prefix + */ + @Override + public PathPropertyList getByPrefix(final String prefix) + { + PathPropertyList result; + + result = new PathPropertyList(); + + if (StringUtils.isNotBlank(prefix)) + { + String pattern; + if (prefix.endsWith(".")) + { + pattern = prefix; + } + else + { + pattern = prefix + "."; + } + + boolean ended = false; + Iterator iterator = iterator(); + while (!ended) + { + if (iterator.hasNext()) + { + PathProperty current = iterator.next(); + if (StringUtils.startsWith(current.getPath(), pattern)) + { + result.add(current); + } + } + else + { + ended = true; + } + } + } + + // + return result; + } + + /** + * Gets the index property. + * + * @param path + * the path + * @return the index property + */ + public int getIndexProperty(final String path) + { + int result; + + boolean ended = false; + int index = 0; + result = -1; + while (!ended) + { + if (index < size()) + { + PathProperty current = this.get(index); + + if (StringUtils.equals(current.getPath(), path)) + { + ended = true; + result = index; + } + else + { + index += 1; + } + } + else + { + ended = true; + result = -1; + } + } + + // + return result; + } + + /** + * Gets the keys. + * + * @return the keys + */ + @Override + public StringList getPaths() + { + StringList result; + + result = new StringList(); + + for (PathProperty property : this) + { + result.add(property.getPath()); + } + + // + return result; + } + + /** + * Gets the prefixes. + * + * @return the prefixes + */ + @Override + public StringSet getPrefixes() + { + StringSet result; + + result = new StringSet(); + + for (PathProperty property : this) + { + result.add(getPrefix(property.getPath())); + } + + // + return result; + } + + /** + * Gets the prefix list. + * + * @return the prefix list + */ + @Override + public StringList getPrefixList() + { + StringList result; + + result = new StringList(); + + for (PathProperty property : this) + { + String prefix = getPrefix(property.getPath()); + + if (!result.contains(prefix)) + { + result.add(prefix); + } + } + + // + return result; + } + + /** + * Gets the property. + * + * @param path + * the path + * @return the property + */ + @Override + public PathProperty getProperty(final String path) + { + PathProperty result; + + boolean ended = false; + Iterator iterator = this.iterator(); + result = null; + while (!ended) + { + if (iterator.hasNext()) + { + PathProperty current = iterator.next(); + + if (StringUtils.equals(current.getPath(), path)) + { + ended = true; + result = current; + } + } + else + { + ended = true; + result = null; + } + } + + // + return result; + } + + /** + * Put. + * + * @param path + * the path + * @param value + * the value + */ + @Override + public void put(final String path, final String value) + { + if (StringUtils.isNotBlank(path)) + { + PathProperty property = getProperty(path); + if (property == null) + { + add(new PathProperty(path, value)); + } + else + { + property.setValue(property.getValue()); + } + } + } + + /** + * Delete path. + * + * @param path + * the path + */ + @Override + public void removePath(final String path) + { + String result; + + boolean ended = false; + Iterator iterator = this.iterator(); + result = null; + while (!ended) + { + if (iterator.hasNext()) + { + PathProperty current = iterator.next(); + + if (StringUtils.equals(current.getPath(), path)) + { + ended = true; + iterator.remove(); + } + } + else + { + ended = true; + result = null; + } + } + } + + /** + * Removes the section. + * + * @param prefix + * the prefix + */ + @Override + public void removeSection(final String prefix) + { + if (StringUtils.isNotBlank(prefix)) + { + String pattern; + if (prefix.endsWith(".")) + { + pattern = prefix; + } + else + { + pattern = prefix + "."; + } + + boolean ended = false; + Iterator iterator = iterator(); + while (!ended) + { + if (iterator.hasNext()) + { + PathProperty current = iterator.next(); + if (StringUtils.startsWith(current.getPath(), pattern)) + { + iterator.remove(); + } + } + else + { + ended = true; + } + } + } + } + + /** + * To string list. + * + * @return the string list + */ + @Override + public StringList toStringList() + { + StringList result; + + result = new StringList(); + + for (String path : getPaths()) + { + String value = get(path); + result.add(path + "=" + value); + } + + // + return result; + } + + /** + * To string list formatted. + * + * @return the string list + */ + @Override + public StringList toStringListFormatted() + { + StringList result; + + result = new StringList(); + + StringList prefixes = getPrefixList(); + + // sort prefixes. + for (String prefix : prefixes) + { + result.add("# [" + StringUtils.capitalize(prefix) + "]"); + + PathPropertyList section = getByPrefix(prefix); + result.addAll(section.toStringList()); + + result.add(""); + } + + // + return result; + } + + /** + * Gets the prefix. + * + * @param source + * the source + * @return the prefix + */ + private static String getPrefix(final String source) + { + String result; + + result = source.substring(0, source.indexOf(".")); + + // + return result; + } +} diff --git a/src/fr/devinsy/statoolinfos/core/PathPropertySet.java b/src/fr/devinsy/statoolinfos/core/PathPropertySet.java new file mode 100644 index 0000000..4a4d628 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/PathPropertySet.java @@ -0,0 +1,277 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import java.util.Hashtable; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.strings.StringList; +import fr.devinsy.strings.StringSet; + +/** + * The Class StatoolsInfosProperties. + */ +public class PathPropertySet +{ + private static final Logger logger = LoggerFactory.getLogger(PathPropertySet.class); + + private Hashtable data; + + /** + * Instantiates a new path properties. + * + * @throws StatoolInfosException + * the statool infos exception + */ + public PathPropertySet() + { + this.data = new Hashtable(); + } + + /** + * Instantiates a new path properties. + * + * @param initialCapacity + * the initial capacity + * @throws StatoolInfosException + * the statool infos exception + */ + public PathPropertySet(final int initialCapacity) + { + this.data = new Hashtable(initialCapacity); + } + + /** + * Instantiates a new path properties. + * + * @param source + * the source + */ + public PathPropertySet(final PathPropertySet source) + { + this.data = new Hashtable(source.size()); + for (String path : source.getPaths()) + { + this.data.put(path, source.get(path)); + } + } + + /** + * Adds the. + * + * @param key + * the key + * @param value + * the value + */ + public void add(final String key, final String value) + { + this.data.put(key, value); + } + + /** + * Gets the. + * + * @param path + * the path + * @return the string + */ + public String get(final String path) + { + String result; + + result = this.data.get(path); + + // + return result; + } + + /** + * Gets the keys. + * + * @return the keys + */ + public StringList getPaths() + { + StringList result; + + result = new StringList(); + + for (Object key : this.data.keySet()) + { + result.add((String) key); + } + + // + return result; + } + + /** + * Gets the prefixes. + * + * @return the prefixes + */ + public StringSet getPrefixes() + { + StringSet result; + + result = new StringSet(); + + for (Object key : this.data.keySet()) + { + result.add(getPrefix((String) key)); + } + + // + return result; + } + + /** + * Gets the prefix list. + * + * @return the prefix list + */ + public StringList getPrefixList() + { + StringList result; + + result = new StringList(); + + for (Object key : this.data.keySet()) + { + result.add(getPrefix((String) key)); + } + + // + return result; + } + + /** + * Put. + * + * @param key + * the key + * @param value + * the value + */ + public void put(final String key, final String value) + { + this.data.put(key, value); + } + + /** + * Delete path. + * + * @param path + * the path + */ + public String removePath(final String path) + { + String result; + + result = this.data.remove(path); + + // + return result; + } + + /** + * Size. + * + * @return the int + */ + public int size() + { + int result; + + result = this.data.size(); + + // + return result; + } + + /** + * To string list. + * + * @return the string list + */ + public StringList toStringList() + { + StringList result; + + result = new StringList(); + + for (String path : getPaths()) + { + String value = get(path); + result.add(path + "=" + value); + } + + // + return result; + } + + /** + * To string list formatted. + * + * @return the string list + */ + public StringList toStringListFormatted() + { + StringList result; + + result = new StringList(); + StringList lines = toStringList(); + + StringList prefixes = getPrefixList(); + + // sort prefixes. + for (String prefix : prefixes) + { + result.add("# [" + prefix + "]"); + + StringList sectionLines = lines.filter("^" + prefix + "\\..*"); + result.addAll(sectionLines); + + result.add(""); + } + + // + return result; + } + + /** + * Gets the prefix. + * + * @param source + * the source + * @return the prefix + */ + private static String getPrefix(final String source) + { + String result; + + result = source.substring(source.indexOf(".")); + + // + return result; + } +} diff --git a/src/fr/devinsy/statoolinfos/core/PathPropertyUtils.java b/src/fr/devinsy/statoolinfos/core/PathPropertyUtils.java new file mode 100644 index 0000000..969548d --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/PathPropertyUtils.java @@ -0,0 +1,337 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.OutputStreamWriter; +import java.io.PrintWriter; +import java.net.URL; + +import org.apache.commons.io.IOUtils; +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.strings.StringList; +import fr.devinsy.strings.StringsUtils; + +/** + * The Class StatoolsInfosProperties. + */ +public class PathPropertyUtils +{ + private static final Logger logger = LoggerFactory.getLogger(PathPropertyUtils.class); + + public static final String DEFAULT_CHARSET_NAME = "UTF-8"; + + /** + * Checks if is property line. + * + * @param line + * the line + * @return true, if is property line + */ + public static boolean isPropertyLine(final String line) + { + boolean result; + + if (StringUtils.isAllBlank(line)) + { + result = false; + } + else + { + result = line.matches("^[^#].*[^\s].*=.*$"); + } + + // + return result; + } + + /** + * Load. + * + * @param source + * the source + * @return the path properties + * @throws IOException + */ + public static PathPropertyList load(final File file) throws IOException + { + PathPropertyList result; + + result = load(file, DEFAULT_CHARSET_NAME); + + // + return result; + } + + /** + * Load. + * + * @param file + * the file + * @param charsetName + * the charset name + * @return the path properties + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static PathPropertyList load(final File file, final String charsetName) throws IOException + { + PathPropertyList result; + + result = new PathPropertyList(); + + BufferedReader in = null; + try + { + in = new BufferedReader(new InputStreamReader(new FileInputStream(file), charsetName)); + result = read(in); + } + finally + { + IOUtils.closeQuietly(in); + } + + // + return result; + } + + /** + * Load. + * + * @param url + * the url + * @return the path property list + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static PathPropertyList load(final URL url) throws IOException + { + PathPropertyList result; + + StringList lines = StringsUtils.load(url); + + result = read(lines); + + // + return result; + } + + /** + * @param in + * @return + * @throws IOException + */ + public static PathPropertyList read(final BufferedReader in) throws IOException + { + PathPropertyList result; + + result = new PathPropertyList(); + + boolean ended = false; + while (!ended) + { + PathProperty property = readPathProperty(in); + + if (property == null) + { + ended = true; + } + else + { + result.add(property); + } + } + + // + return result; + } + + /** + * Load. + * + * @param url + * the url + * @return the path property list + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static PathPropertyList read(final StringList source) throws IOException + { + PathPropertyList result; + + result = new PathPropertyList(); + + for (String line : source) + { + if (isPropertyLine(line)) + { + PathProperty property = valueOf(line); + + result.add(property); + } + } + + // + return result; + } + + /** + * Read not empty line. + * + * @param in + * the in + * @return the string + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static String readActiveLine(final BufferedReader in) throws IOException + { + String result; + + boolean ended = false; + result = null; + while (!ended) + { + String line = in.readLine(); + + if (line == null) + { + ended = true; + result = null; + } + else if ((StringUtils.isNotBlank(line)) && (!line.startsWith("#"))) + { + ended = true; + result = line; + } + } + + // + return result; + } + + /** + * Read path property. + * + * @param in + * the in + * @return the path property + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static PathProperty readPathProperty(final BufferedReader in) throws IOException + { + PathProperty result; + + String line = readActiveLine(in); + + if (line == null) + { + result = null; + } + else + { + result = valueOf(line); + } + + // + return result; + } + + /** + * Save. + * + * @param file + * the file + * @param source + * the source + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static void save(final File file, final PathPropertyList source) throws IOException + { + PrintWriter out = null; + try + { + out = new PrintWriter(new OutputStreamWriter(new FileOutputStream(file), "UTF-8")); + write(out, source); + } + finally + { + // + IOUtils.closeQuietly(out); + } + } + + /** + * Value of. + * + * @param line + * the line + * @return the path property + */ + public static PathProperty valueOf(final String line) + { + PathProperty result; + + if (line == null) + { + result = null; + } + else + { + String[] tokens = line.split("=", 2); + result = new PathProperty(tokens[0].trim(), tokens[1].trim()); + } + + // + return result; + } + + /** + * Write. + * + * @param out + * the out + * @param source + * the source + * @throws IOException + */ + public static void write(final PrintWriter out, final PathPropertyList source) throws IOException + { + if (source != null) + { + StringList lines = source.toStringListFormatted(); + + for (String string : lines) + { + out.write(string); + out.write("\n"); + } + } + } +} diff --git a/src/fr/devinsy/statoolinfos/core/StatoolInfos.java b/src/fr/devinsy/statoolinfos/core/StatoolInfos.java new file mode 100644 index 0000000..88f1580 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/StatoolInfos.java @@ -0,0 +1,265 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.time.LocalDateTime; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * The Class StatoolInfos. + */ +public class StatoolInfos +{ + private static Logger logger = LoggerFactory.getLogger(StatoolInfos.class); + + /** + * Builds the. + * + * @param inputs + * the inputs + * @throws IOException + */ + public static void build(final File input) throws StatoolInfosException, IOException + { + PathPropertyList inputProperties = PathPropertyUtils.load(input); + + String buildDirectoryName = inputProperties.get("conf.build.directory"); + if (StringUtils.isBlank(buildDirectoryName)) + { + throw new StatoolInfosException("Build directory target is undefined."); + } + else + { + File targetDirectory = new File(buildDirectoryName); + + if (targetDirectory.exists()) + { + // Load configuration file. + File targetFile = new File(targetDirectory, input.getName()); + + // + PathPropertyList targetProperties = new PathPropertyList(); + + // Add generator paths. + PathPropertyList fileSection = new PathPropertyList(); + fileSection.put("file.class", inputProperties.get("conf.class")); + fileSection.put("file.generator", "StatoolInfos"); + fileSection.put("file.datetime", LocalDateTime.now().toString()); + fileSection.put("file.protocol", inputProperties.get("conf.protocol")); + targetProperties.addAll(fileSection); + + // + targetProperties.addAll(inputProperties); + + // Clear configuration paths. + targetProperties.removeSection("conf"); + + // Save target file. + PathPropertyUtils.save(targetFile, targetProperties); + } + else + { + throw new StatoolInfosException("Build directory target does not exist."); + } + } + } + + /** + * Clear. + * + * @param input + * the input + */ + public static void clear(final File input) throws StatoolInfosException, IOException + { + PathPropertyList inputProperties = PathPropertyUtils.load(input); + + { + String crawlCacheName = inputProperties.get("conf.crawl.cache"); + if (StringUtils.isBlank(crawlCacheName)) + { + throw new StatoolInfosException("Crawl cache directory is undefined."); + } + else + { + File crawlCacheDirectory = new File(crawlCacheName); + + if (crawlCacheDirectory.exists()) + { + CrawlCache cache = new CrawlCache(crawlCacheDirectory); + cache.clear(); + } + else + { + throw new StatoolInfosException("Crawl cache directory does not exist."); + } + } + } + + { + String buildDirectoryName = inputProperties.get("conf.build.directory"); + if (StringUtils.isBlank(buildDirectoryName)) + { + throw new StatoolInfosException("Build directory is undefined."); + } + else + { + File buildDirectory = new File(buildDirectoryName); + + if (buildDirectory.exists()) + { + CrawlCache cache = new CrawlCache(buildDirectory); + cache.clear(); + } + else + { + throw new StatoolInfosException("Crawl cache directory does not exist."); + } + } + } + } + + /** + * Crawl. + * + * @param input + * the input + */ + public static void crawl(final File input) throws StatoolInfosException, IOException + { + PathPropertyList configuration = PathPropertyUtils.load(input); + + String crawlCachePath = configuration.get("conf.crawl.cache"); + logger.info("Cache setting: {}", configuration.get("conf.crawl.cache")); + CrawlCache cache = new CrawlCache(new File(crawlCachePath)); + + PathPropertyList section = configuration.getByPrefix("subs"); + for (PathProperty property : section) + { + URL url = new URL(property.getValue()); + crawl(url, cache); + } + } + + /** + * Crawl. + * + * @param url + * the input + * @param cache + * the cache + * @throws StatoolInfosException + * the statool infos exception + * @throws IOException + * Signals that an I/O exception has occurred. + */ + public static void crawl(final URL url, final CrawlCache cache) throws StatoolInfosException, IOException + { + PathPropertyList inputProperties = PathPropertyUtils.load(url); + + logger.info("Crawling " + url); + + PathPropertyList target = PathPropertyUtils.load(url); + + PathPropertyList crawlSection = new PathPropertyList(); + crawlSection.put("crawl.crawler", "StatoolInfos"); + crawlSection.put("crawl.datetime", LocalDateTime.now().toString()); + crawlSection.put("crawl.url", url.toString()); + target.addAll(crawlSection); + + PathPropertyList section = inputProperties.getByPrefix("subs"); + for (PathProperty property : section) + { + URL subUrl = new URL(property.getValue()); + crawl(subUrl, cache); + } + } + + /** + * Htmlize. + * + * @param input + * the input + */ + public static void htmlize(final File input) throws StatoolInfosException, IOException + { + PathPropertyList inputProperties = PathPropertyUtils.load(input); + + String crawlCachePath = inputProperties.get("conf.crawl.cache"); + logger.info("Cache setting: {}", inputProperties.get("conf.crawl.cache")); + CrawlCache cache = new CrawlCache(new File(crawlCachePath)); + + String className = inputProperties.get("conf.class"); + if (StringUtils.equals(className, "federation")) + { + htmlizeFederation(inputProperties, cache); + } + else if (StringUtils.equals(className, "organization")) + { + htmlizeOrganization(inputProperties, cache); + } + else if (StringUtils.equals(className, "service")) + { + htmlizeService(inputProperties, cache); + } + else + { + } + } + + /** + * Htmlize federation. + * + * @param federation + * the federation + * @param cache + * the cache + */ + public static void htmlizeFederation(final PathPropertyList federation, final CrawlCache cache) + { + + } + + public static void htmlizeOrganization(final PathPropertyList federation, final CrawlCache cache) + { + // Copy commons files (index, images, favicon, css…). + + // Download federation stuff (favicon, logo…). + // Build the federation page. + + // For each organization + // Download organization stuff (favicon, logo…). + // Build organization page. + // for each service + // Download service stuff (favicon, logo…). + // Build service page. + + } + + public static void htmlizeService(final PathPropertyList federation, final CrawlCache cache) + { + + } +} diff --git a/src/fr/devinsy/statoolinfos/core/StatoolInfosException.java b/src/fr/devinsy/statoolinfos/core/StatoolInfosException.java new file mode 100644 index 0000000..5e66126 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/StatoolInfosException.java @@ -0,0 +1,72 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +/** + * The Class JugaException. + * + * @author Christian Pierre MOMON (christian.momon@devinsy.fr) + */ +public class StatoolInfosException extends Exception +{ + private static final long serialVersionUID = 8323299610751708972L; + + /** + * Instantiates a new Juga exception. + */ + public StatoolInfosException() + { + super(); + } + + /** + * Instantiates a new Juga exception. + * + * @param message + * the message + */ + public StatoolInfosException(final String message) + { + super(message); + } + + /** + * Instantiates a new Juga exception. + * + * @param message + * the message + * @param cause + * the cause + */ + public StatoolInfosException(final String message, final Throwable cause) + { + super(message, cause); + } + + /** + * Instantiates a new Juga exception. + * + * @param cause + * the cause + */ + public StatoolInfosException(final Throwable cause) + { + super(cause); + } +} diff --git a/src/fr/devinsy/statoolinfos/core/StatoolInfosUtils.java b/src/fr/devinsy/statoolinfos/core/StatoolInfosUtils.java new file mode 100644 index 0000000..6c49644 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/core/StatoolInfosUtils.java @@ -0,0 +1,350 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.format.DateTimeFormatter; +import java.util.Date; +import java.util.Iterator; +import java.util.Locale; + +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.commons.io.FileUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.math.NumberUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.strings.StringList; +import fr.devinsy.strings.StringsUtils; + +/** + * The Class StatoolInfosUtils. + */ +public class StatoolInfosUtils +{ + private static Logger logger = LoggerFactory.getLogger(StatoolInfosUtils.class); + + public static final DateTimeFormatter PATTERN_SHORTDATE = DateTimeFormatter.ofPattern("dd/MM/yyyy", Locale.FRANCE); + public static final DateTimeFormatter PATTERN_LONGDATE = DateTimeFormatter.ofPattern("dd/MM/yyyy HH':'mm", Locale.FRANCE); + + /** + * Generate cat logo. + * + * @param seed + * the seed + * @param target + * the target + * @throws IOException + */ + public static void generateCatLogo(final String seed, final File target) throws IOException + { + URL source = new URL("https://www.peppercarrot.com/extras/html/2016_cat-generator/avatar.php?seed=" + seed); + + FileUtils.copyURLToFile(source, target); + } + + /** + * Gets the current time in long format. + * + * @return the long + */ + public static long now() + { + return new Date().getTime(); + } + + /** + * To human long. + * + * @param value + * the value + * @return the string + */ + public static String toHumanLong(final LocalDateTime value) + { + String result; + + result = toHumanLong(value, null); + + // + return result; + } + + /** + * To human long. + * + * @param value + * the value + * @param defaultValue + * the default value + * @return the string + */ + public static String toHumanLong(final LocalDateTime value, final String defaultValue) + { + String result; + + if (value == null) + { + result = null; + } + else + { + result = value.format(PATTERN_LONGDATE); + } + + // + return result; + } + + /** + * To human short. + * + * @param value + * the value + * @return the string + */ + public static String toHumanShort(final LocalDateTime value) + { + String result; + + result = toHumanShort(value, null); + + // + return result; + } + + /** + * To human short. + * + * @param value + * the value + * @param defaultValue + * the default value + * @return the string + */ + public static String toHumanShort(final LocalDateTime value, final String defaultValue) + { + String result; + + if (value == null) + { + result = null; + } + else + { + result = value.format(PATTERN_SHORTDATE); + } + + // + return result; + } + + public static Integer toInteger(final String value) + { + Integer result; + + if ((value == null) || (!NumberUtils.isDigits(value))) + { + result = null; + } + else + { + result = Integer.parseInt(value); + } + + // + return result; + } + + /** + * To Json numbers. + * + * @param source + * the source + * @return the string + */ + public static String toJSonNumbers(final StringList source) + { + String result; + + result = StringsUtils.toString(source, "[", ",", "]"); + + // + return result; + } + + /** + * To J son numbers. + * + * @param labels + * the labels + * @param values + * the source + * @return the string + */ + public static String toJSonNumbers(final StringList labels, final StringList values) + { + String result; + + Iterator labelIterator = labels.iterator(); + Iterator valueIterator = values.iterator(); + + StringList buffer = new StringList(); + while (labelIterator.hasNext()) + { + String label = labelIterator.next(); + String value = valueIterator.next(); + + // buffer.append("{t: new Date('" + label + "'), y: " + value + + // "}"); + buffer.append("{t: '" + label + "', y: " + value + "}"); + } + result = StringsUtils.toString(buffer, "[", ",", "]"); + + // + return result; + } + + /** + * To Json strings. + * + * @param source + * the source + * @return the string + */ + public static String toJSonStrings(final StringList source) + { + String result; + + StringList target = new StringList(); + + target.append("["); + for (String string : source) + { + target.append("'"); + target.append(string); + target.append("'"); + target.append(","); + } + target.removeLast(); + target.append("]"); + + result = target.toString(); + + // + return result; + } + + /** + * To technical name. + * + * @param source + * the source + * @return the string + */ + public static String toTechnicalName(final String source) + { + String result; + + if (source == null) + { + result = null; + } + else + { + result = StringUtils.stripAccents(source).replaceAll("[^A-Za-z0-9]+", ""); + } + + // + return result; + } + + /** + * To year week. + * + * @param source + * the source + * @return the string + */ + public static String toYearWeek(final LocalDate source) + { + String result; + + if (source == null) + { + result = null; + } + else + { + result = source.format(DateTimeFormatter.ofPattern("YYYYww", Locale.FRANCE)); + } + + // + return result; + } + + /** + * Unactivate SSL check. + */ + public static void unactivateSSLCheck() + { + // Create a trust manager that does not validate certificate chains. + TrustManager[] trustAllCerts = new TrustManager[] { + new X509TrustManager() + { + @Override + public void checkClientTrusted(final java.security.cert.X509Certificate[] certs, final String authType) + { + } + + @Override + public void checkServerTrusted(final java.security.cert.X509Certificate[] certs, final String authType) + { + } + + @Override + public java.security.cert.X509Certificate[] getAcceptedIssuers() + { + return null; + } + } + }; + + // Install the all-trusting trust manager. + try + { + // SSLContext context = SSLContext.getInstance("SSL"); + SSLContext context = SSLContext.getInstance("TLS"); + context.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(context.getSocketFactory()); + } + catch (Exception exception) + { + } + } +} diff --git a/src/fr/devinsy/statoolinfos/utils/CompareUtils.java b/src/fr/devinsy/statoolinfos/utils/CompareUtils.java new file mode 100644 index 0000000..4d99b61 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/utils/CompareUtils.java @@ -0,0 +1,253 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.utils; + +import java.time.LocalDateTime; + +import org.apache.commons.lang3.StringUtils; + +/** + * The Class CompareUtils. + */ +public class CompareUtils +{ + /** + * Compare. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compare(final Boolean alpha, final Boolean bravo) + { + int result; + + if ((alpha == null) && (bravo == null)) + { + result = 0; + } + else if (alpha == null) + { + result = -1; + } + else if (bravo == null) + { + result = +1; + } + else + { + result = alpha.compareTo(bravo); + } + + // + return result; + } + + /** + * Compare. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compare(final Double alpha, final Double bravo) + { + int result; + + if ((alpha == null) && (bravo == null)) + { + result = 0; + } + else if (alpha == null) + { + result = -1; + } + else if (bravo == null) + { + result = +1; + } + else + { + result = alpha.compareTo(bravo); + } + + // + return result; + } + + /** + * Compare. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compare(final Integer alpha, final Integer bravo) + { + int result; + + if ((alpha == null) && (bravo == null)) + { + result = 0; + } + else if (alpha == null) + { + result = -1; + } + else if (bravo == null) + { + result = +1; + } + else + { + result = alpha.compareTo(bravo); + } + + // + return result; + } + + /** + * Compare. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compare(final LocalDateTime alpha, final LocalDateTime bravo) + { + int result; + + if ((alpha == null) && (bravo == null)) + { + result = 0; + } + else if (alpha == null) + { + result = -1; + } + else if (bravo == null) + { + result = +1; + } + else + { + result = alpha.compareTo(bravo); + } + + // + return result; + } + + /** + * Compare. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compare(final Long alpha, final Long bravo) + { + int result; + + if ((alpha == null) && (bravo == null)) + { + result = 0; + } + else if (alpha == null) + { + result = -1; + } + else if (bravo == null) + { + result = +1; + } + else + { + result = alpha.compareTo(bravo); + } + + // + return result; + } + + /** + * Compare. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compare(final String alpha, final String bravo) + { + int result; + + result = StringUtils.compare(alpha, bravo); + + // + return result; + } + + /** + * Compare reverse. + * + * @param alpha + * the alpha + * @param bravo + * the bravo + * @return the int + */ + public static int compareReverse(final Integer alpha, final Integer bravo) + { + int result; + + if ((alpha == null) && (bravo == null)) + { + result = 0; + } + else if (alpha == null) + { + result = +1; + } + else if (bravo == null) + { + result = -1; + } + else + { + result = alpha.compareTo(bravo); + } + + // + return result; + } + +} \ No newline at end of file diff --git a/src/fr/devinsy/statoolinfos/utils/Files.java b/src/fr/devinsy/statoolinfos/utils/Files.java new file mode 100644 index 0000000..cd164c9 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/utils/Files.java @@ -0,0 +1,49 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.utils; + +import java.io.File; +import java.util.ArrayList; + +/** + * The Class Files. + */ +public class Files extends ArrayList +{ + private static final long serialVersionUID = -8116253751377991944L; + + /** + * Instantiates a new files. + */ + public Files() + { + super(); + } + + /** + * Instantiates a new files. + * + * @param initialCapacity + * the initial capacity + */ + public Files(final int initialCapacity) + { + super(initialCapacity); + } +} diff --git a/src/fr/devinsy/statoolinfos/utils/SQLUtils.java b/src/fr/devinsy/statoolinfos/utils/SQLUtils.java new file mode 100644 index 0000000..36ad7b2 --- /dev/null +++ b/src/fr/devinsy/statoolinfos/utils/SQLUtils.java @@ -0,0 +1,272 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.utils; + +import java.sql.Connection; +import java.sql.DriverManager; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.time.LocalDateTime; +import java.time.ZoneOffset; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import fr.devinsy.statoolinfos.core.StatoolInfosException; + +/** + * The Class SQLUtils. + */ +public final class SQLUtils +{ + private static Logger logger = LoggerFactory.getLogger(SQLUtils.class); + + /** + * Instantiates a new SQL utils. + */ + private SQLUtils() + { + } + + /** + * Close quietly. + * + * @param connection + * the connection + */ + public static void closeQuietly(final Connection connection) + { + if (connection != null) + { + try + { + connection.close(); + } + catch (SQLException exception) + { + exception.printStackTrace(); + } + } + } + + /** + * Close quietly. + * + * @param connection + * the connection + * @param statement + * the statement + * @param resultSet + * the result set + */ + public static void closeQuietly(final Connection connection, final Statement statement, final ResultSet resultSet) + { + // + if (connection != null) + { + try + { + connection.close(); + } + catch (SQLException exception) + { + exception.printStackTrace(); + } + } + + // + if (statement != null) + { + try + { + statement.close(); + } + catch (SQLException exception) + { + exception.printStackTrace(); + } + } + + // + if (resultSet != null) + { + try + { + resultSet.close(); + } + catch (SQLException exception) + { + exception.printStackTrace(); + } + } + } + + /** + * Close quietly. + * + * @param statement + * the statement + * @param resultSet + * the result set + */ + public static void closeQuietly(final Statement statement, final ResultSet resultSet) + { + // + if (statement != null) + { + try + { + statement.close(); + } + catch (SQLException exception) + { + exception.printStackTrace(); + } + } + + // + if (resultSet != null) + { + try + { + resultSet.close(); + } + catch (SQLException exception) + { + exception.printStackTrace(); + } + } + } + + /** + * Gets the connexion. + * + * @param serverUrl + * the server url + * @param databaseName + * the database name + * @param login + * the login + * @param password + * the password + * @return the connexion + * @throws StatoolInfosException + * the agir statool exception + */ + public static Connection getConnexion(final String serverUrl, final String databaseName, final String login, final String password) throws StatoolInfosException + { + Connection result; + + try + { + if (StringUtils.isBlank(serverUrl)) + { + throw new IllegalArgumentException("Undefined server URL."); + } + else if (StringUtils.isBlank(databaseName)) + { + throw new IllegalArgumentException("Undefined database name."); + } + else if (StringUtils.isBlank(login)) + { + throw new IllegalArgumentException("Undefined database login."); + } + else + { + Class.forName("com.mysql.jdbc.Driver").newInstance(); + result = DriverManager.getConnection(serverUrl + databaseName + "?useUnicode=true&amp;characterEncoding=utf8", login, password); + } + } + catch (SQLException exception) + { + throw new StatoolInfosException("Database connection failed: " + exception.getMessage(), exception); + } + catch (InstantiationException exception) + { + throw new StatoolInfosException("Database connection failed: " + exception.getMessage(), exception); + } + catch (IllegalAccessException exception) + { + throw new StatoolInfosException("Database connection failed: " + exception.getMessage(), exception); + } + catch (ClassNotFoundException exception) + { + throw new StatoolInfosException("Database connection failed: " + exception.getMessage(), exception); + } + + // + return result; + } + + /** + * Gets the nullable long. + * + * @param resultSet + * the result set + * @param index + * the index + * @return the nullable long + * @throws SQLException + * the SQL exception + */ + public static Long getNullableLong(final ResultSet resultSet, final int index) throws SQLException + { + Long result; + + if (resultSet.getObject(index) == null) + { + result = null; + } + else + { + result = resultSet.getLong(index); + } + + // + return result; + } + + /** + * To date time. + * + * @param source + * the source + * @return the local date time + */ + public static LocalDateTime toLocalDateTime(final java.sql.Timestamp source) + { + LocalDateTime result; + + if (source == null) + { + result = null; + } + else + { + long seconds = source.getTime() / 1000; + long nanos = (source.getTime() - seconds * 1000) * 1000000; + result = LocalDateTime.ofEpochSecond(seconds, (int) nanos, ZoneOffset.UTC); + } + + // + return result; + } +} diff --git a/src/utils/BuildInformation.java b/src/utils/BuildInformation.java new file mode 100644 index 0000000..55c70ab --- /dev/null +++ b/src/utils/BuildInformation.java @@ -0,0 +1,223 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple service statistics tool. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package utils; + +import java.io.IOException; +import java.net.URL; +import java.util.Properties; + +import org.apache.commons.lang3.exception.ExceptionUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * The Class BuildInformation. + */ +public class BuildInformation +{ + private static class SingletonHolder + { + private static final BuildInformation instance = new BuildInformation(); + } + + private static final Logger logger = LoggerFactory.getLogger(BuildInformation.class); + + private static String BUILD_INFORMATION_FILE = "/org/april/statoolinfos/build_information.properties"; + + private String productName; + private String majorRevision; + private String minorRevision; + private String buildNumber; + private String buildDate; + private String generator; + private String buildAuthor; + + /** + * Instantiates a new builds the information. + */ + private BuildInformation() + { + Properties build = new Properties(); + + try + { + // + URL buildInformationFile = BuildInformation.class.getResource(BUILD_INFORMATION_FILE); + + if (buildInformationFile != null) + { + build.load(BuildInformation.class.getResource(BUILD_INFORMATION_FILE).openStream()); + } + + // + this.productName = build.getProperty("product.name", "DevInProgress"); + this.majorRevision = build.getProperty("product.revision.major", "d"); + this.minorRevision = build.getProperty("product.revision.minor", "e"); + this.buildNumber = build.getProperty("product.revision.build", "v"); + this.buildDate = build.getProperty("product.revision.date", "today"); + this.generator = build.getProperty("product.revision.generator", "n/a"); + this.buildAuthor = build.getProperty("product.revision.author", "n/a"); + + } + catch (IOException exception) + { + logger.error("Error loading the build.properties file: " + exception.getMessage()); + logger.error(ExceptionUtils.getStackTrace(exception)); + + this.productName = "n/a"; + this.majorRevision = "n/a"; + this.minorRevision = "n/a"; + this.buildNumber = "n/a"; + this.buildDate = "n/a"; + this.generator = "n/a"; + this.buildAuthor = "n/a"; + } + } + + /** + * Builds the author. + * + * @return the string + */ + public String buildAuthor() + { + return this.buildAuthor; + } + + /** + * Builds the date. + * + * @return the string + */ + public String buildDate() + { + return this.buildDate; + } + + /** + * Builds the number. + * + * @return the string + */ + public String buildNumber() + { + return this.buildNumber; + } + + /** + * Generator. + * + * @return the string + */ + public String generator() + { + return this.generator; + } + + /** + * Major revision. + * + * @return the string + */ + public String majorRevision() + { + return this.majorRevision; + } + + /** + * Minor revision. + * + * @return the string + */ + public String minorRevision() + { + return this.minorRevision; + } + + /** + * Product name. + * + * @return the string + */ + public String productName() + { + return this.productName; + } + + /* (non-Javadoc) + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + String result; + + result = String.format("%s %s.%s.%s built on %s by %s", this.productName, this.majorRevision, this.minorRevision, this.buildNumber, this.buildDate, this.buildAuthor); + + // + return result; + } + + /** + * Version. + * + * @return the string + */ + public String version() + { + String result; + + result = String.format("%s.%s.%s", this.majorRevision, this.minorRevision, this.buildNumber); + + // + return result; + } + + /** + * Instance. + * + * @return the builds the information + */ + public static BuildInformation instance() + { + return SingletonHolder.instance; + } + + /** + * Checks if is defined. + * + * @return true, if is defined + */ + public static boolean isDefined() + { + boolean result; + + if (BuildInformation.class.getResource(BUILD_INFORMATION_FILE) == null) + { + result = false; + } + else + { + result = true; + } + + // + return result; + } +} diff --git a/test/fr/devinsy/statoolinfos/core/StatoolInfosTest.java b/test/fr/devinsy/statoolinfos/core/StatoolInfosTest.java new file mode 100644 index 0000000..f652af3 --- /dev/null +++ b/test/fr/devinsy/statoolinfos/core/StatoolInfosTest.java @@ -0,0 +1,66 @@ +/* + * Copyright (C) 2020 Christian Pierre MOMON + * + * This file is part of StatoolInfos, simple key value database. + * + * StatoolInfos 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. + * + * StatoolInfos 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 StatoolInfos. If not, see . + */ +package fr.devinsy.statoolinfos.core; + +import org.apache.log4j.BasicConfigurator; +import org.apache.log4j.Level; +import org.apache.log4j.Logger; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.Test; + +/** + * The Class JugaTest. + * + * @author Christian Pierre MOMON + */ +public class StatoolInfosTest +{ + private static org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(StatoolInfosTest.class); + + @Test + public void testFoo() throws Exception + { + // + } + + /** + * After class. + * + * @throws StatoolInfosException + * the Juga exception + */ + @AfterClass + public static void afterClass() throws StatoolInfosException + { + } + + /** + * Before class. + * + * @throws StatoolInfosException + * the Juga exception + */ + @BeforeClass + public static void beforeClass() throws StatoolInfosException + { + BasicConfigurator.configure(); + Logger.getRootLogger().setLevel(Level.DEBUG); + } +}