matrix-docker-ansible-deploy/roles/custom/matrix-bridge-mautrix-telegram/tasks/setup_install.yml

# SPDX-FileCopyrightText: 2018 - 2026 Slavi Pantaleev
# SPDX-FileCopyrightText: 2018 Hugues Morisset
# SPDX-FileCopyrightText: 2019 Aaron Raimist
# SPDX-FileCopyrightText: 2019 Dan Arnfield
# SPDX-FileCopyrightText: 2019 Jan Christian Grünhage
# SPDX-FileCopyrightText: 2020 - 2022 MDAD project contributors
# SPDX-FileCopyrightText: 2020 Chris van Dijk
# SPDX-FileCopyrightText: 2020 Stuart Mumford
# SPDX-FileCopyrightText: 2021 Panagiotis Georgiadis
# 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-License-Identifier: AGPL-3.0-or-later

---

- ansible.builtin.set_fact:
    matrix_mautrix_telegram_migration_requires_restart: false

# The legacy Python bridge stored its SQLite DB at `{base_path}/mautrix-telegram.db` (the role's
# root). Later, we started relocating it to `{base_path}/data/mautrix-telegram.db`. The sqlite→
# postgres migration below only knows about the new path, so if the DB is still at the legacy
# location, move it to the new location first — otherwise users who follow the changelog and
# switch to Postgres wouldn't actually get their data imported before the service starts.
- name: Check if a legacy-location SQLite database exists
  ansible.builtin.stat:
    path: "{{ matrix_mautrix_telegram_base_path }}/mautrix-telegram.db"
  register: matrix_mautrix_telegram_stat_database_legacy_location

- when: matrix_mautrix_telegram_stat_database_legacy_location.stat.exists | bool
  block:
    - name: Ensure matrix-mautrix-telegram.service is stopped before relocating legacy SQLite DB
      ansible.builtin.service:
        name: matrix-mautrix-telegram
        state: stopped
        enabled: false
        daemon_reload: true
      failed_when: false

    - name: Ensure data directory exists for legacy SQLite DB relocation
      ansible.builtin.file:
        path: "{{ matrix_mautrix_telegram_data_path }}"
        state: directory
        mode: '0750'
        owner: "{{ matrix_user_name }}"
        group: "{{ matrix_group_name }}"

    - name: (Data relocation) Move mautrix-telegram SQLite DB from legacy location to data directory
      ansible.builtin.command:
        cmd: "mv {{ matrix_mautrix_telegram_base_path }}/mautrix-telegram.db {{ matrix_mautrix_telegram_data_path }}/mautrix-telegram.db"
        creates: "{{ matrix_mautrix_telegram_data_path }}/mautrix-telegram.db"
        removes: "{{ matrix_mautrix_telegram_base_path }}/mautrix-telegram.db"

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

    - when: "matrix_mautrix_telegram_sqlite_database_path_local_stat_result.stat.exists | bool"
      block:
        - ansible.builtin.include_role:
            name: galaxy/postgres
            tasks_from: migrate_db_to_postgres
          vars:
            postgres_db_migration_request:
              src: "{{ matrix_mautrix_telegram_sqlite_database_path_local }}"
              dst: "{{ matrix_mautrix_telegram_database_connection_string }}"
              caller: "{{ role_path | basename }}"
              engine_variable_name: 'matrix_mautrix_telegram_database_engine'
              engine_old: 'sqlite'
              systemd_services_to_stop: ['matrix-mautrix-telegram.service']
              pgloader_options: ['--with "quote identifiers"']

        - ansible.builtin.set_fact:
            matrix_mautrix_telegram_migration_requires_restart: true

- name: Ensure Mautrix Telegram paths exist
  ansible.builtin.file:
    path: "{{ item.path }}"
    state: directory
    mode: '0750'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  with_items:
    - {path: "{{ matrix_mautrix_telegram_base_path }}", when: true}
    - {path: "{{ matrix_mautrix_telegram_config_path }}", when: true}
    - {path: "{{ matrix_mautrix_telegram_data_path }}", when: true}
    - {path: "{{ matrix_mautrix_telegram_container_src_files_path }}", when: "{{ matrix_mautrix_telegram_container_image_self_build }}"}
  when: item.when | bool

- name: Ensure Mautrix Telegram image is pulled
  community.docker.docker_image:
    name: "{{ matrix_mautrix_telegram_container_image }}"
    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
    force_source: "{{ matrix_mautrix_telegram_container_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_mautrix_telegram_container_image_force_pull }}"
  when: "not matrix_mautrix_telegram_container_image_self_build | bool"
  register: matrix_mautrix_telegram_container_image_pull_result
  retries: "{{ devture_playbook_help_container_retries_count }}"
  delay: "{{ devture_playbook_help_container_retries_delay }}"
  until: matrix_mautrix_telegram_container_image_pull_result is not failed

- name: Ensure Mautrix Telegram repository is present on self-build
  ansible.builtin.git:
    repo: "{{ matrix_mautrix_telegram_container_image_self_build_repo }}"
    dest: "{{ matrix_mautrix_telegram_container_src_files_path }}"
    version: "{{ matrix_mautrix_telegram_container_image_self_build_branch }}"
    force: "yes"
  become: true
  become_user: "{{ matrix_user_name }}"
  register: matrix_mautrix_telegram_git_pull_results
  when: "matrix_mautrix_telegram_container_image_self_build | bool"

- name: Ensure Mautrix Telegram Docker image is built
  community.docker.docker_image:
    name: "{{ matrix_mautrix_telegram_container_image }}"
    source: build
    force_source: "{{ matrix_mautrix_telegram_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_mautrix_telegram_git_pull_results.changed }}"
    build:
      dockerfile: Dockerfile
      path: "{{ matrix_mautrix_telegram_container_src_files_path }}"
      pull: true
  when: "matrix_mautrix_telegram_container_image_self_build | bool"

- name: Ensure mautrix-telegram config.yaml installed
  ansible.builtin.copy:
    content: "{{ matrix_mautrix_telegram_configuration | to_nice_yaml(indent=2, width=999999) }}"
    dest: "{{ matrix_mautrix_telegram_config_path }}/config.yaml"
    mode: '0644'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  register: matrix_mautrix_telegram_config_result

- name: Ensure mautrix-telegram registration.yaml installed
  ansible.builtin.copy:
    content: "{{ matrix_mautrix_telegram_registration | to_nice_yaml(indent=2, width=999999) }}"
    dest: "{{ matrix_mautrix_telegram_config_path }}/registration.yaml"
    mode: '0644'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  register: matrix_mautrix_telegram_registration_result

- name: Ensure mautrix-telegram support files installed
  ansible.builtin.template:
    src: "{{ role_path }}/templates/{{ item }}.j2"
    dest: "{{ matrix_mautrix_telegram_base_path }}/{{ item }}"
    mode: '0640'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  with_items:
    - labels
  register: matrix_mautrix_telegram_support_files_result

- name: Ensure matrix-mautrix-telegram container network is created
  community.general.docker_network:
    enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
    name: "{{ matrix_mautrix_telegram_container_network }}"
    driver: bridge
    driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"

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

- name: Determine whether matrix-mautrix-telegram needs a restart
  ansible.builtin.set_fact:
    matrix_mautrix_telegram_restart_necessary: >-
      {{
        matrix_mautrix_telegram_migration_requires_restart | default(false)
        or matrix_mautrix_telegram_config_result.changed | default(false)
        or matrix_mautrix_telegram_registration_result.changed | default(false)
        or matrix_mautrix_telegram_support_files_result.changed | default(false)
        or matrix_mautrix_telegram_systemd_service_result.changed | default(false)
        or matrix_mautrix_telegram_container_image_pull_result.changed | default(false)
      }}

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