Add matrix-appservice-kakaotalk support

Adds support for: https://src.miscworks.net/fair/matrix-appservice-kakaotalk

This is pretty similar to
https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1977
which just appeared, but has mostly been done independently.

I've taken some inspiration and did some fixups based on that PR.
Thanks to https://github.com/hnarjis for taking the time to contribute!

Notable differences between this branch compared to that PR:

- better naming and documentation around the "configuration" variables
- no unnecessary (5 sec.) intentional delay when starting `matrix-appservice-kakaotalk-node.service`
- stores configuration in `config/`, not in `data/`
- passes configuration as read-only and starts the bridge with (`--no-update`) to ensure no changes are made to it
- starts containers more securely - with `matrix:matrix` user:group (not `root`) and
  reduced capabilities (`--cap-drop=ALL`)
- uses `tcp` for communication between the "node" and the appservice (simpler than sharing unix sockets)
- `registration.yaml` which is closer to the one generated by `matrix-appservice-kakaotalk` (no `de.sorunome.msc2409.push_ephemeral` stuff, etc.)
- `registration.yaml` which is more customizable (customizable bot username and prefix for puppets - see `matrix_appservice_kakaotalk_appservice_bot_username` and `matrix_appservice_kakaotalk_user_prefix`)
- less fragile and more extensible bridge permissions configuration via `matrix_appservice_kakaotalk_bridge_permissions`. Doing `{% if matrix_admin %}` in the bridge configuration sometimes causes syntax problems (I hit some myself) and is not ideal. Other bridges should be redone as well.
- configurable command prefix for the bridge, instead of hardcoding `!kt` (see `matrix_appservice_kakaotalk_command_prefix`)
- logging that is more consistent with the rest of the playbook (console / journald only, no logging to files), as well as configurable log level (via `matrix_appservice_kakaotalk_logging_level`)
- somewhat more detailed documentation (`docs/configuring-playbook-bridge-appservice-kakaotalk.md`)
- removed some dead code (data relocation tasks from `tasks/setup_install.yml`, as well as likely unnecessary SQLite -> Postgres migration)

roles/matrix-bridge-appservice-kakaotalk/tasks/init.yml

@@ -0,0 +1,28 @@
+---
+# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
+# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
+- name: Fail if trying to self-build on Ansible < 2.8
+  ansible.builtin.fail:
+    msg: "To self-build the appservice-kakaotalk image, you should use Ansible 2.8 or higher. See docs/ansible.md"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_kakaotalk_container_image_self_build and matrix_appservice_kakaotalk_enabled"
+
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-appservice-kakaotalk.service', 'matrix-appservice-kakaotalk-node.service'] }}"
+  when: matrix_appservice_kakaotalk_enabled | bool
+
+# If the matrix-synapse role is not used, these variables may not exist.
+- ansible.builtin.set_fact:
+    matrix_synapse_container_extra_arguments: >
+      {{
+        matrix_synapse_container_extra_arguments | default([])
+        +
+        ["--mount type=bind,src={{ matrix_appservice_kakaotalk_config_path }}/registration.yaml,dst=/matrix-appservice-kakaotalk-registration.yaml,ro"]
+      }}
+
+    matrix_synapse_app_service_config_files: >
+      {{
+        matrix_synapse_app_service_config_files | default([])
+        +
+        ["/matrix-appservice-kakaotalk-registration.yaml"]
+      }}
+  when: matrix_appservice_kakaotalk_enabled | bool

roles/matrix-bridge-appservice-kakaotalk/tasks/main.yml

@@ -0,0 +1,23 @@
+---
+
+- 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_appservice_kakaotalk_enabled | bool"
+  tags:
+    - setup-all
+    - setup-appservice-kakaotalk
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup | bool and matrix_appservice_kakaotalk_enabled | bool"
+  tags:
+    - setup-all
+    - setup-appservice-kakaotalk
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup | bool and not matrix_appservice_kakaotalk_enabled | bool"
+  tags:
+    - setup-all
+    - setup-appservice-kakaotalk

roles/matrix-bridge-appservice-kakaotalk/tasks/setup_install.yml

@@ -0,0 +1,125 @@
+---
+
+# 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-matrix-appservice-kakaotalk role needs to execute before the matrix-synapse role.
+  when: "matrix_synapse_role_executed | default(False)"
+
+- name: Ensure matrix-appservice-kakaotalk image is pulled
+  docker_image:
+    name: "{{ matrix_appservice_kakaotalk_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_appservice_kakaotalk_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_appservice_kakaotalk_docker_image_force_pull }}"
+  when: not matrix_appservice_kakaotalk_container_image_self_build
+  register: result
+  retries: "{{ matrix_container_retries_count }}"
+  delay: "{{ matrix_container_retries_delay }}"
+  until: result is not failed
+
+- name: Ensure matrix-appservice-kakaotalk-node image is pulled
+  docker_image:
+    name: "{{ matrix_appservice_kakaotalk_node_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_appservice_kakaotalk_node_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_appservice_kakaotalk_node_docker_image_force_pull }}"
+  when: not matrix_appservice_kakaotalk_container_image_self_build
+  register: result
+  retries: "{{ matrix_container_retries_count }}"
+  delay: "{{ matrix_container_retries_delay }}"
+  until: result is not failed
+
+- name: Ensure matrix-appservice-kakaotalk paths exist
+  ansible.builtin.file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - {path: "{{ matrix_appservice_kakaotalk_base_path }}", when: true}
+    - {path: "{{ matrix_appservice_kakaotalk_config_path }}", when: true}
+    - {path: "{{ matrix_appservice_kakaotalk_data_path }}", when: true}
+    - {path: "{{ matrix_appservice_kakaotalk_docker_src_files_path }}", when: "{{ matrix_appservice_kakaotalk_container_image_self_build }}"}
+  when: item.when | bool
+
+- name: Ensure matrix-appservice-kakaotalk repository is present on self-build
+  ansible.builtin.git:
+    repo: "{{ matrix_appservice_kakaotalk_container_image_self_build_repo }}"
+    dest: "{{ matrix_appservice_kakaotalk_docker_src_files_path }}"
+    version: "{{ matrix_appservice_kakaotalk_container_image_self_build_repo_version }}"
+    force: "yes"
+  become: true
+  become_user: "{{ matrix_user_username }}"
+  register: matrix_appservice_kakaotalk_git_pull_results
+  when: "matrix_appservice_kakaotalk_container_image_self_build | bool"
+
+- name: Ensure matrix-appservice-kakaotalk-node Docker image is built
+  docker_image:
+    name: "{{ matrix_appservice_kakaotalk_node_docker_image }}"
+    source: build
+    force_source: "{{ matrix_appservice_kakaotalk_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_appservice_kakaotalk_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_appservice_kakaotalk_docker_src_files_path }}/node"
+      pull: true
+  when: "matrix_appservice_kakaotalk_container_image_self_build | bool"
+
+- name: Ensure matrix-appservice-kakaotalk Docker image is built
+  docker_image:
+    name: "{{ matrix_appservice_kakaotalk_docker_image }}"
+    source: build
+    force_source: "{{ matrix_appservice_kakaotalk_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_appservice_kakaotalk_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_appservice_kakaotalk_docker_src_files_path }}"
+      pull: true
+  when: "matrix_appservice_kakaotalk_container_image_self_build | bool"
+
+- name: Ensure matrix-appservice-kakaotalk-node config.json installed
+  ansible.builtin.copy:
+    content: "{{ matrix_appservice_kakaotalk_node_configuration | to_nice_json }}"
+    dest: "{{ matrix_appservice_kakaotalk_config_path }}/node-config.json"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-appservice-kakaotalk config.yaml installed
+  ansible.builtin.copy:
+    content: "{{ matrix_appservice_kakaotalk_configuration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_appservice_kakaotalk_config_path }}/config.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-appservice-kakaotalk registration.yaml installed
+  ansible.builtin.copy:
+    content: "{{ matrix_appservice_kakaotalk_registration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_appservice_kakaotalk_config_path }}/registration.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-appservice-kakaotalk-node.service installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/matrix-appservice-kakaotalk-node.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-appservice-kakaotalk-node.service"
+    mode: 0644
+  register: matrix_appservice_kakaotalk_node_systemd_service_result
+
+- name: Ensure matrix-appservice-kakaotalk.service installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/matrix-appservice-kakaotalk.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-appservice-kakaotalk.service"
+    mode: 0644
+  register: matrix_appservice_kakaotalk_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-appservice-kakaotalk.service or matrix-appservice-kakaotalk-node.service installation
+  ansible.builtin.service:
+    daemon_reload: true
+  when: matrix_appservice_kakaotalk_node_systemd_service_result.changed or matrix_appservice_kakaotalk_systemd_service_result.changed

roles/matrix-bridge-appservice-kakaotalk/tasks/setup_uninstall.yml

@@ -0,0 +1,41 @@
+---
+
+- name: Check existence of matrix-appservice-kakaotalk service
+  ansible.builtin.stat:
+    path: "{{ matrix_systemd_path }}/matrix-appservice-kakaotalk.service"
+  register: matrix_appservice_kakaotalk_service_stat
+
+- name: Ensure matrix-appservice-kakaotalk is stopped
+  ansible.builtin.service:
+    name: matrix-appservice-kakaotalk
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  when: "matrix_appservice_kakaotalk_service_stat.stat.exists"
+
+- name: Check existence of matrix-appservice-kakaotalk-node service
+  ansible.builtin.stat:
+    path: "{{ matrix_systemd_path }}/matrix-appservice-kakaotalk-node.service"
+  register: matrix_appservice_kakaotalk_node_service_stat
+
+- name: Ensure matrix-appservice-kakaotalk-node is stopped
+  ansible.builtin.service:
+    name: matrix-appservice-kakaotalk-node
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  when: "matrix_appservice_kakaotalk_node_service_stat.stat.exists"
+
+- name: Ensure matrix-appservice-kakaotalk.service files don't exist
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: absent
+  with_items:
+    - "{{ matrix_systemd_path }}/matrix-appservice-kakaotalk-node.service"
+    - "{{ matrix_systemd_path }}/matrix-appservice-kakaotalk.service"
+  when: "matrix_appservice_kakaotalk_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-appservice-kakaotalk service files removal
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_appservice_kakaotalk_service_stat.stat.exists or matrix_appservice_kakaotalk_node_service_stat.stat.exists"

roles/matrix-bridge-appservice-kakaotalk/tasks/validate_config.yml

@@ -0,0 +1,10 @@
+---
+
+- 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_appservice_kakaotalk_appservice_token"
+    - "matrix_appservice_kakaotalk_homeserver_token"