matrix-docker-ansible-deploy/roles/custom/matrix-dimension/tasks/setup_install.yml

# SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev
# SPDX-FileCopyrightText: 2020 Stuart Mumford
# SPDX-FileCopyrightText: 2021 MDAD project contributors
# SPDX-FileCopyrightText: 2021 Yannick Goossens
# SPDX-FileCopyrightText: 2022 Jim Myhrberg
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2022 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 Sebastian Gumprich
# SPDX-FileCopyrightText: 2024 David Mehren
# SPDX-FileCopyrightText: 2025 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---

- ansible.builtin.set_fact:
    matrix_dimension_requires_restart: false

- when: "matrix_dimension_database_engine == 'postgres'"
  block:
    - name: Check if an SQLite database already exists
      ansible.builtin.stat:
        path: "{{ matrix_dimension_sqlite_database_path_local }}"
      register: matrix_dimension_sqlite_database_path_local_stat_result

    - when: "matrix_dimension_sqlite_database_path_local_stat_result.stat.exists | bool"
      block:
        # pgloader makes a few columns `smallint`, instead of `boolean`.
        # We need to fix them up.
        - ansible.builtin.set_fact:
            matrix_dimension_pgloader_additional_psql_statements_list: []

        - ansible.builtin.set_fact:
            matrix_dimension_pgloader_additional_psql_statements_list: |
              {{
                matrix_dimension_pgloader_additional_psql_statements_list
                +
                ([] if item.default == '' else ['ALTER TABLE ' + item.table + ' ALTER COLUMN "' + item.column + '" DROP default;'])
                +
                (['ALTER TABLE ' + item.table + ' ALTER COLUMN "' + item.column + '" TYPE BOOLEAN USING("' + item.column + '"::text::boolean);'])
                +
                ([] if item.default == '' else ['ALTER TABLE ' + item.table + ' ALTER COLUMN "' + item.column + '" SET default ' + item.default + ';'])
              }}
          with_items:
            - {'table': 'dimension_widgets', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_widgets', 'column': 'isPublic', 'default': ''}
            - {'table': 'dimension_webhook_bridges', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_user_sticker_packs', 'column': 'isSelected', 'default': ''}
            - {'table': 'dimension_scalar_tokens', 'column': 'isDimensionToken', 'default': ''}
            - {'table': 'dimension_users', 'column': 'isSelfBot', 'default': 'false'}
            - {'table': 'dimension_telegram_bridges', 'column': 'allowTgPuppets', 'default': ''}
            - {'table': 'dimension_telegram_bridges', 'column': 'allowMxPuppets', 'default': ''}
            - {'table': 'dimension_telegram_bridges', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_sticker_packs', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_sticker_packs', 'column': 'isPublic', 'default': ''}
            - {'table': 'dimension_slack_bridges', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_neb_integrations', 'column': 'isPublic', 'default': ''}
            - {'table': 'dimension_neb_integrations', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_irc_bridges', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_irc_bridge_networks', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_gitter_bridges', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_custom_simple_bots', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_custom_simple_bots', 'column': 'isPublic', 'default': ''}
            - {'table': 'dimension_bridges', 'column': 'isEnabled', 'default': ''}
            - {'table': 'dimension_bridges', 'column': 'isPublic', 'default': ''}

        - ansible.builtin.include_role:
            name: galaxy/postgres
            tasks_from: migrate_db_to_postgres
          vars:
            postgres_db_migration_request:
              src: "{{ matrix_dimension_sqlite_database_path_local }}"
              dst: "{{ matrix_dimension_database_connection_string }}"
              caller: "{{ role_path | basename }}"
              engine_variable_name: 'matrix_dimension_database_engine'
              engine_old: 'sqlite'
              systemd_services_to_stop: ['matrix-dimension.service']
              pgloader_options: ['--with "quote identifiers"']
              additional_psql_statements_list: "{{ matrix_dimension_pgloader_additional_psql_statements_list }}"
              additional_psql_statements_db_name: "{{ matrix_dimension_database_name }}"

        - ansible.builtin.set_fact:
            matrix_dimension_requires_restart: true

- name: Ensure Dimension base path exists
  ansible.builtin.file:
    path: "{{ matrix_dimension_base_path }}"
    state: directory
    mode: 0770
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_dimension_user_gid }}"

- name: Ensure Dimension config installed
  ansible.builtin.copy:
    content: "{{ matrix_dimension_configuration | to_nice_yaml(indent=2, width=999999) }}"
    dest: "{{ matrix_dimension_base_path }}/config.yaml"
    mode: 0640
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_dimension_user_gid }}"

- name: Ensure Dimension labels installed
  ansible.builtin.template:
    src: "{{ role_path }}/templates/labels.j2"
    dest: "{{ matrix_dimension_base_path }}/labels"
    mode: 0640
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"

- name: Ensure Dimension image is pulled
  community.docker.docker_image:
    name: "{{ matrix_dimension_docker_image }}"
    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
    force_source: "{{ matrix_dimension_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_dimension_docker_image_force_pull }}"
  when: "not matrix_dimension_container_image_self_build | bool"
  register: matrix_dimension_pull_results
  retries: "{{ devture_playbook_help_container_retries_count }}"
  delay: "{{ devture_playbook_help_container_retries_delay }}"
  until: matrix_dimension_pull_results is not failed

- name: Ensure Dimension repository is present on self-build
  ansible.builtin.git:
    repo: "{{ matrix_dimension_container_image_self_build_repo }}"
    dest: "{{ matrix_dimension_docker_src_files_path }}"
    version: "{{ matrix_dimension_container_image_self_build_branch }}"
    force: "yes"
  become: true
  become_user: "{{ matrix_user_name }}"
  when: "matrix_dimension_container_image_self_build | bool"
  register: matrix_dimension_git_pull_results

- name: Ensure Dimension Docker image is built
  community.docker.docker_image:
    name: "{{ matrix_dimension_docker_image }}"
    source: build
    force_source: "{{ matrix_dimension_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_dimension_git_pull_results.changed }}"
    build:
      dockerfile: Dockerfile
      path: "{{ matrix_dimension_docker_src_files_path }}"
      pull: true
  when: "matrix_dimension_container_image_self_build | bool"

- name: Ensure Dimension container network is created
  community.general.docker_network:
    enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
    name: "{{ matrix_dimension_container_network }}"
    driver: bridge
    driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"

- name: Ensure matrix-dimension.service installed
  ansible.builtin.template:
    src: "{{ role_path }}/templates/systemd/matrix-dimension.service.j2"
    dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-dimension.service"
    mode: 0644

- name: Ensure matrix-dimension.service restarted, if necessary
  ansible.builtin.service:
    name: "matrix-dimension.service"
    state: restarted
    daemon_reload: true
  when: "matrix_dimension_requires_restart | bool"