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

# SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
# SPDX-FileCopyrightText: 2022 Jim Myhrberg
# SPDX-FileCopyrightText: 2022 Jip J. Dekker
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2022 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 Sebastian Gumprich
# SPDX-FileCopyrightText: 2023 Isaiah Becker-Mayer
# SPDX-FileCopyrightText: 2024 David Mehren
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
- name: Ensure Dendrite paths exist
  ansible.builtin.file:
    path: "{{ item.path }}"
    state: directory
    mode: '0750'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  with_items:
    - path: "{{ matrix_dendrite_config_dir_path }}"
      when: true
    - path: "{{ matrix_dendrite_bin_path }}"
      when: true
    - path: "{{ matrix_dendrite_ext_path }}"
      when: true
    - path: "{{ matrix_dendrite_nats_storage_path }}"
      when: true
    - path: "{{ matrix_dendrite_container_src_files_path }}"
      when: "{{ matrix_dendrite_container_image_self_build }}"
  when: "item.when | bool"

# This will throw a Permission Denied error if already mounted using fuse
- name: Check Dendrite media store path
  ansible.builtin.stat:
    path: "{{ matrix_dendrite_media_store_path }}"
  register: local_path_media_store_stat
  ignore_errors: true

# This is separate and conditional, to ensure we don't execute it
# if the path already exists or we failed to check, because it's mounted using fuse.
- name: Ensure Dendrite media store path exists
  ansible.builtin.file:
    path: "{{ matrix_dendrite_media_store_path }}"
    state: directory
    mode: '0750'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  when: "not local_path_media_store_stat.failed and not local_path_media_store_stat.stat.exists"

- name: Ensure Dendrite Docker image is pulled
  community.docker.docker_image_pull:
    name: "{{ matrix_dendrite_container_image }}"
    pull: always
  when: "not matrix_dendrite_container_image_self_build | bool"
  register: matrix_dendrite_container_image_pull_result
  retries: "{{ devture_playbook_help_container_retries_count }}"
  delay: "{{ devture_playbook_help_container_retries_delay }}"
  until: matrix_dendrite_container_image_pull_result is not failed

# We do this so that the signing key would get generated.
# We don't use the `docker_container` module, because using it with `cap_drop` requires
# a very recent version, which is not available for a lot of people yet.
- name: Generate Dendrite signing key
  ansible.builtin.command:
    cmd: |
      docker run
      --rm
      --name=matrix-dendrite-config
      --entrypoint=generate-keys
      --mount type=bind,src={{ matrix_dendrite_config_dir_path }},dst=/data
      {{ matrix_dendrite_container_image }} --private-key=/data/{{ matrix_server_fqn_matrix }}.signing.pem
      generate
    creates: "{{ matrix_dendrite_config_dir_path }}/{{ matrix_server_fqn_matrix }}.signing.pem"

- name: Ensure Dendrite server key exists
  ansible.builtin.file:
    path: "{{ matrix_dendrite_config_dir_path }}/{{ matrix_server_fqn_matrix }}.signing.pem"
    mode: '0644'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"

- name: Ensure Dendrite configuration installed
  ansible.builtin.copy:
    content: "{{ matrix_dendrite_configuration | to_nice_yaml(indent=2, width=999999) }}"
    dest: "{{ matrix_dendrite_config_dir_path }}/dendrite.yaml"
    mode: '0644'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  register: matrix_dendrite_config_result

- when: "matrix_dendrite_container_image_self_build | bool"
  block:
    # A checkout owned by a different user (a uid change, an earlier clone by another user, etc.) would make the git task below fail on ownership or permissions.
    - name: Ensure Dendrite repository ownership is correct on self-build
      ansible.builtin.file:
        path: "{{ matrix_dendrite_container_src_files_path }}"
        state: directory
        owner: "{{ matrix_user_name }}"
        group: "{{ matrix_group_name }}"
        recurse: true

    - name: Ensure Dendrite repository is present on self-build
      ansible.builtin.git:
        repo: "{{ matrix_dendrite_container_image_self_build_repo }}"
        dest: "{{ matrix_dendrite_container_src_files_path }}"
        version: "{{ matrix_dendrite_container_image.split(':')[1] }}"
        force: "yes"
      become: true
      become_user: "{{ matrix_user_name }}"
      # Keep this even though the task above normalizes ownership. Git may still see an ownership mismatch when Ansible becomes an unprivileged user (see #5065).
      environment:
        GIT_CONFIG_COUNT: "1"
        GIT_CONFIG_KEY_0: safe.directory
        GIT_CONFIG_VALUE_0: "{{ matrix_dendrite_container_src_files_path }}"
      register: matrix_dendrite_git_pull_results

    - name: Check if Dendrite Docker image exists
      ansible.builtin.command: "{{ devture_systemd_docker_base_host_command_docker }} images --quiet --filter 'reference={{ matrix_dendrite_container_image }}'"
      register: matrix_dendrite_container_image_check_result
      changed_when: false

    # Invoking the `docker build` command here, instead of calling the `docker_image` Ansible module,
    # because the latter does not support BuildKit.
    # See: https://github.com/ansible-collections/community.general/issues/514
    - name: Ensure Dendrite Docker image is built
      ansible.builtin.command:
        cmd: "{{ devture_systemd_docker_base_host_command_docker }} build -t {{ matrix_dendrite_container_image }} {{ matrix_dendrite_container_src_files_path }}"
      environment:
        DOCKER_BUILDKIT: 1
      changed_when: true
      when: "matrix_dendrite_git_pull_results.changed | bool or matrix_dendrite_container_image_check_result.stdout == ''"

- name: Ensure Dendrite container network is created
  when: matrix_dendrite_container_network != 'host'
  community.general.docker_network:
    enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
    name: "{{ matrix_dendrite_container_network }}"
    driver: bridge
    driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"

- name: Ensure Dendrite support files installed
  ansible.builtin.template:
    src: "{{ item.src }}"
    dest: "{{ item.dest }}"
    mode: "{{ item.mode }}"
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  with_items:
    - src: labels.j2
      dest: "{{ matrix_dendrite_base_path }}/labels"
      mode: "0640"
    - src: bin/create-account.j2
      dest: "{{ matrix_dendrite_bin_path }}/create-account"
      mode: "0750"
  register: matrix_dendrite_support_files_result

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

- name: Determine whether Dendrite needs a restart
  ansible.builtin.set_fact:
    matrix_dendrite_restart_necessary: >-
      {{
        matrix_dendrite_config_result.changed | default(false)
        or matrix_dendrite_support_files_result.changed | default(false)
        or matrix_dendrite_systemd_service_result.changed | default(false)
        or matrix_dendrite_container_image_pull_result.changed | default(false)
      }}