Move mautrix-sack role files to new roles/custom path

roles/custom/matrix-bridge-mautrix-slack/tasks/init.yml

@@ -0,0 +1,21 @@
+---
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-slack.service'] }}"
+  when: matrix_mautrix_slack_enabled | bool
+
+# If the matrix-synapse role is not used, these variables may not exist.
+- ansible.builtin.set_fact:
+    matrix_homeserver_container_runtime_injected_arguments: >
+      {{
+        matrix_homeserver_container_runtime_injected_arguments | default([])
+        +
+        ["--mount type=bind,src={{ matrix_mautrix_slack_config_path }}/registration.yaml,dst=/matrix-mautrix-slack-registration.yaml,ro"]
+      }}
+
+    matrix_homeserver_app_service_runtime_injected_config_files: >
+      {{
+        matrix_homeserver_app_service_runtime_injected_config_files | default([])
+        +
+        ["/matrix-mautrix-slack-registration.yaml"]
+      }}
+  when: matrix_mautrix_slack_enabled | bool

roles/custom/matrix-bridge-mautrix-slack/tasks/main.yml

@@ -0,0 +1,22 @@
+---
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup | bool and matrix_mautrix_slack_enabled | bool"
+  tags:
+    - setup-all
+    - setup-mautrix-slack
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup and matrix_mautrix_slack_enabled"
+  tags:
+    - setup-all
+    - setup-mautrix-slack
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup and not matrix_mautrix_slack_enabled"
+  tags:
+    - setup-all
+    - setup-mautrix-slack

roles/custom/matrix-bridge-mautrix-slack/tasks/setup_install.yml

@@ -0,0 +1,121 @@
+---
+
+# If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
+# We don't want to fail in such cases.
+- name: Fail if matrix-synapse role already executed
+  ansible.builtin.fail:
+    msg: >-
+      The matrix-bridge-mautrix-slack role needs to execute before the matrix-synapse role.
+  when: "matrix_synapse_role_executed | default(False)"
+
+- ansible.builtin.set_fact:
+    matrix_mautrix_slack_requires_restart: false
+
+- when: "matrix_mautrix_slack_database_engine == 'postgres'"
+  block:
+    - name: Check if an SQLite database already exists
+      ansible.builtin.stat:
+        path: "{{ matrix_mautrix_slack_sqlite_database_path_local }}"
+      register: matrix_mautrix_slack_sqlite_database_path_local_stat_result
+
+    - when: "matrix_mautrix_slack_sqlite_database_path_local_stat_result.stat.exists | bool"
+      block:
+        - ansible.builtin.set_fact:
+            matrix_postgres_db_migration_request:
+              src: "{{ matrix_mautrix_slack_sqlite_database_path_local }}"
+              dst: "{{ matrix_mautrix_slack_database_connection_string }}"
+              caller: "{{ role_path | basename }}"
+              engine_variable_name: 'matrix_mautrix_slack_database_engine'
+              engine_old: 'sqlite'
+              systemd_services_to_stop: ['matrix-mautrix-slack.service']
+              pgloader_options: ['--with "quote identifiers"']
+
+        - ansible.builtin.import_role:
+            name: matrix-postgres
+            tasks_from: migrate_db_to_postgres
+
+        - ansible.builtin.set_fact:
+            matrix_mautrix_slack_requires_restart: true
+
+- name: Ensure Mautrix Slack paths exists
+  ansible.builtin.file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - {path: "{{ matrix_mautrix_slack_base_path }}", when: true}
+    - {path: "{{ matrix_mautrix_slack_config_path }}", when: true}
+    - {path: "{{ matrix_mautrix_slack_data_path }}", when: true}
+    - {path: "{{ matrix_mautrix_slack_docker_src_files_path }}", when: "{{ matrix_mautrix_slack_container_image_self_build }}"}
+  when: item.when | bool
+
+- name: Ensure Mautrix Slack image is pulled
+  community.docker.docker_image:
+    name: "{{ matrix_mautrix_slack_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_mautrix_slack_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_mautrix_slack_docker_image_force_pull }}"
+  when: not matrix_mautrix_slack_container_image_self_build
+  register: result
+  retries: "{{ matrix_container_retries_count }}"
+  delay: "{{ matrix_container_retries_delay }}"
+  until: result is not failed
+
+- name: Ensure Mautrix slack repository is present on self-build
+  ansible.builtin.git:
+    repo: "{{ matrix_mautrix_slack_container_image_self_build_repo }}"
+    dest: "{{ matrix_mautrix_slack_docker_src_files_path }}"
+    version: "{{ matrix_mautrix_slack_container_image_self_build_branch }}"
+    force: "yes"
+  become: true
+  become_user: "{{ matrix_user_username }}"
+  register: matrix_mautrix_slack_git_pull_results
+  when: "matrix_mautrix_slack_container_image_self_build | bool"
+
+- name: Ensure Mautrix slack Docker image is built
+  community.docker.docker_image:
+    name: "{{ matrix_mautrix_slack_docker_image }}"
+    source: build
+    force_source: "{{ matrix_mautrix_slack_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_slack_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_mautrix_slack_docker_src_files_path }}"
+      pull: true
+  when: "matrix_mautrix_slack_container_image_self_build | bool"
+
+- name: Ensure mautrix-slack config.yaml installed
+  ansible.builtin.copy:
+    content: "{{ matrix_mautrix_slack_configuration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_mautrix_slack_config_path }}/config.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure mautrix-slack registration.yaml installed
+  ansible.builtin.copy:
+    content: "{{ matrix_mautrix_slack_registration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_mautrix_slack_config_path }}/registration.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-mautrix-slack.service installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/matrix-mautrix-slack.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-mautrix-slack.service"
+    mode: 0644
+  register: matrix_mautrix_slack_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-mautrix-slack.service installation
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_mautrix_slack_systemd_service_result.changed"
+
+- name: Ensure matrix-mautrix-slack.service restarted, if necessary
+  ansible.builtin.service:
+    name: "matrix-mautrix-slack.service"
+    state: restarted
+  when: "matrix_mautrix_slack_requires_restart | bool"

roles/custom/matrix-bridge-mautrix-slack/tasks/setup_uninstall.yml

@@ -0,0 +1,25 @@
+---
+
+- name: Check existence of matrix-mautrix-slack service
+  ansible.builtin.stat:
+    path: "{{ matrix_systemd_path }}/matrix-mautrix-slack.service"
+  register: matrix_mautrix_slack_service_stat
+
+- name: Ensure matrix-mautrix-slack is stopped
+  ansible.builtin.service:
+    name: matrix-mautrix-slack
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  when: "matrix_mautrix_slack_service_stat.stat.exists"
+
+- name: Ensure matrix-mautrix-slack.service doesn't exist
+  ansible.builtin.file:
+    path: "{{ matrix_systemd_path }}/matrix-mautrix-slack.service"
+    state: absent
+  when: "matrix_mautrix_slack_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-mautrix-slack.service removal
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_mautrix_slack_service_stat.stat.exists"

roles/custom/matrix-bridge-mautrix-slack/tasks/validate_config.yml

@@ -0,0 +1,19 @@
+---
+
+- name: Fail if required settings not defined
+  ansible.builtin.fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`).
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_mautrix_slack_appservice_token"
+    - "matrix_mautrix_slack_homeserver_token"
+
+- name: Fail if appservice-slack and mautrix-slack have conflicting bot usernames
+  when: matrix_appservice_slack_enabled | default(False) | bool and matrix_mautrix_slack_appservice_bot_username == matrix_appservice_slack_bot_name | default ('')
+  ansible.builtin.fail:
+    msg: |
+      The appservice-slack and mautrix-slack components are both enabled and use the same bot username ({{ matrix_mautrix_slack_appservice_bot_username }}), as per their default configuration, which causes a conflcit.
+      To resolve the conflict, make one of these components use a different username.
+      Consider either changing `matrix_mautrix_slack_appservice_bot_username` (the bot username for the mautrix-slack component) or `matrix_appservice_slack_bot_name` (the bot username for the appservice-slack component).
+      We recommend that you change the username for the newly-added (and yet unused) component.