matrix-docker-ansible-deploy/roles/custom/matrix-ma1sd/tasks/validate_config.yml

# SPDX-FileCopyrightText: 2020 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2020 Marcel Partap
# SPDX-FileCopyrightText: 2021 boris runakov
# SPDX-FileCopyrightText: 2025 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---

- name: (Deprecation) Warn about ma1sd variables that are not used anymore
  ansible.builtin.fail:
    msg: >
      The `{{ item }}` variable defined in your configuration is not used by this playbook anymore!
      You'll need to adapt to the new way of extending ma1sd configuration.
      See the CHANGELOG and the `matrix_ma1sd_configuration_extension_yaml` variable for more information and examples.
  when: "lookup('ansible.builtin.varnames', ('^' + item + '$'), wantlist=True) | length > 0"
  with_items:
    - 'matrix_ma1sd_ldap_enabled'
    - 'matrix_ma1sd_ldap_connection_host'
    - 'matrix_ma1sd_ldap_connection_tls'
    - 'matrix_ma1sd_ldap_connection_port'
    - 'matrix_ma1sd_ldap_connection_baseDn'
    - 'matrix_ma1sd_ldap_connection_baseDns'
    - 'matrix_ma1sd_ldap_connection_bindDn'
    - 'matrix_ma1sd_ldap_connection_bindPassword'
    - 'matrix_ma1sd_ldap_filter'
    - 'matrix_ma1sd_ldap_attribute_uid_type'
    - 'matrix_ma1sd_ldap_attribute_uid_value'
    - 'matrix_ma1sd_ldap_connection_bindPassword'
    - 'matrix_ma1sd_ldap_attribute_name'
    - 'matrix_ma1sd_ldap_attribute_threepid_email'
    - 'matrix_ma1sd_ldap_attribute_threepid_msisdn'
    - 'matrix_ma1sd_ldap_identity_filter'
    - 'matrix_ma1sd_ldap_identity_medium'
    - 'matrix_ma1sd_ldap_auth_filter'
    - 'matrix_ma1sd_ldap_directory_filter'
    - 'matrix_ma1sd_template_config'
    - 'matrix_ma1sd_architecture'

- name: Ensure ma1sd configuration does not contain any dot-notation keys
  ansible.builtin.fail:
    msg: >
      Since version 1.3.0, ma1sd will not accept property-style configuration keys.
      You have defined a key (`{{ item.key }}`) which contains a dot.
      Instead, use nesting. See: https://github.com/ma1uta/ma1sd/wiki/Upgrade-Notes#v130
  when: "'.' in item.key"
  with_dict: "{{ matrix_ma1sd_configuration }}"

- name: Fail if required ma1sd settings not defined
  ansible.builtin.fail:
    msg: >
      You need to define a required configuration setting (`{{ item.name }}`).
  when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
  with_items:
    - {'name': 'matrix_ma1sd_hostname', when: true}
    - {'name': 'matrix_ma1sd_threepid_medium_email_connectors_smtp_host', when: true}
    - {'name': 'matrix_ma1sd_dns_overwrite_homeserver_client_value', when: true}
    - {'name': 'matrix_ma1sd_database_hostname', when: "{{ matrix_ma1sd_database_engine == 'postgres' }}"}
    - {'name': 'matrix_ma1sd_container_network', when: true}
    - {'name': 'matrix_ma1sd_container_labels_matrix_identity_hostname', when: "{{ matrix_ma1sd_container_labels_matrix_identity_enabled }}"}
    - {'name': 'matrix_ma1sd_container_labels_matrix_identity_path_prefix', when: "{{ matrix_ma1sd_container_labels_matrix_identity_enabled }}"}
    - {'name': 'matrix_ma1sd_container_labels_matrix_client_user_directory_search_hostname', when: "{{ matrix_ma1sd_container_labels_matrix_client_user_directory_search_enabled }}"}
    - {'name': 'matrix_ma1sd_container_labels_matrix_client_user_directory_search_path_regexp', when: "{{ matrix_ma1sd_container_labels_matrix_client_user_directory_search_enabled }}"}
    - {'name': 'matrix_ma1sd_container_labels_matrix_client_3pid_registration_path_regexp', when: "{{ matrix_ma1sd_container_labels_matrix_client_3pid_registration_enabled }}"}

- name: (Deprecation) Catch and report renamed ma1sd variables
  ansible.builtin.fail:
    msg: >-
      Your configuration contains a variable, which now has a different name.
      Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
  when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
  with_items:
    - {'old': 'matrix_ma1sd_container_expose_port', 'new': '<superseded by matrix_ma1sd_container_http_host_bind_port>'}
    - {'old': 'matrix_ma1sd_threepid_medium_email_custom_unbind_fraudulent_template', 'new': 'matrix_ma1sd_threepid_medium_email_custom_session_unbind_notification_template'}
    - {'old': 'matrix_ma1sd_default_port', 'new': 'matrix_ma1sd_container_port'}
    - {'old': 'matrix_ma1sd_container_labels_matrix_client_user_directory_search_path', 'new': 'matrix_ma1sd_container_labels_matrix_client_user_directory_search_path_regexp'}
    - {'old': 'matrix_ma1sd_container_labels_matrix_client_3pid_registration_path', 'new': 'matrix_ma1sd_container_labels_matrix_client_3pid_registration_path_regexp'}
    - {'old': 'matrix_ma1sd_docker_image_name_prefix', 'new': 'matrix_ma1sd_docker_image_registry_prefix'}

- name: (Deprecation) Catch and report mxisd variables
  ansible.builtin.fail:
    msg: >-
      mxisd is deprecated and has been replaced with ma1sd (https://github.com/ma1uta/ma1sd), a compatible fork.
      The playbook will migrate your existing mxisd configuration and data automatically, but you need to adjust variable names.
      Please rename these variables (`matrix_mxisd_*` -> `matrix_ma1sd_*`) on your configuration file (vars.yml): {{ lookup('ansible.builtin.varnames', '^matrix_mxisd_.+', wantlist=True) | join(', ') }}
  when: "lookup('ansible.builtin.varnames', '^matrix_mxisd_.+', wantlist=True) | length > 0"