sync with previous repo

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

@@ -0,0 +1,31 @@
+# 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
+  fail:
+    msg: "To self-build the Element 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_irc_container_self_build and matrix_appservice_irc_enabled"
+
+# 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
+  fail:
+    msg: >-
+      The matrix-bridge-appservice-irc role needs to execute before the matrix-synapse role.
+  when: "matrix_appservice_irc_enabled|bool and matrix_synapse_role_executed|default(False)"
+
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-appservice-irc.service'] }}"
+  when: matrix_appservice_irc_enabled|bool
+
+# If the matrix-synapse role is not used, these variables may not exist.
+- set_fact:
+    matrix_synapse_container_extra_arguments: >
+      {{ matrix_synapse_container_extra_arguments|default([]) }}
+      +
+      ["--mount type=bind,src={{ matrix_appservice_irc_config_path }}/registration.yaml,dst=/matrix-appservice-irc-registration.yaml,ro"]
+
+    matrix_synapse_app_service_config_files: >
+      {{ matrix_synapse_app_service_config_files|default([]) }}
+      +
+      {{ ["/matrix-appservice-irc-registration.yaml"] }}
+  when: matrix_appservice_irc_enabled|bool

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

@@ -0,0 +1,21 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup|bool and matrix_appservice_irc_enabled|bool"
+  tags:
+    - setup-all
+    - setup-appservice-irc
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_appservice_irc_enabled|bool"
+  tags:
+    - setup-all
+    - setup-appservice-irc
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_appservice_irc_enabled|bool"
+  tags:
+    - setup-all
+    - setup-appservice-irc

roles/matrix-bridge-appservice-irc/tasks/migrate_nedb_to_postgres.yml

@@ -0,0 +1,70 @@
+- name: Fail if Postgres not enabled
+  fail:
+    msg: "Postgres via the matrix-postgres role is not enabled (`matrix_postgres_enabled`). Cannot migrate."
+  when: "not matrix_postgres_enabled|bool"
+
+# Defaults
+
+- name: Set postgres_start_wait_time, if not provided
+  set_fact:
+    postgres_start_wait_time: 15
+  when: "postgres_start_wait_time|default('') == ''"
+
+# Actual import work
+
+- name: Ensure matrix-postgres is started
+  service:
+    name: matrix-postgres
+    state: started
+    daemon_reload: yes
+  register: matrix_postgres_service_start_result
+
+- name: Wait a bit, so that Postgres can start
+  wait_for:
+    timeout: "{{ postgres_start_wait_time }}"
+  delegate_to: 127.0.0.1
+  become: false
+  when: "matrix_postgres_service_start_result.changed|bool"
+
+- name: Check existence of matrix-appservice-irc service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-appservice-irc.service"
+  register: matrix_appservice_irc_service_stat
+
+- name: Ensure matrix-appservice-irc is stopped
+  service:
+    name: matrix-appservice-irc
+    state: stopped
+  when: "matrix_appservice_irc_service_stat.stat.exists"
+
+- name: Import appservice-irc NeDB database into Postgres
+  command:
+    cmd: >-
+      {{ matrix_host_command_docker }} run
+      --rm
+      --user={{ matrix_user_uid }}:{{ matrix_user_gid }}
+      --cap-drop=ALL
+      --network={{ matrix_docker_network }}
+      --mount type=bind,src={{ matrix_appservice_irc_data_path }},dst=/data
+      --entrypoint=/bin/sh
+      {{ matrix_appservice_irc_docker_image }}
+      -c
+      '/usr/local/bin/node /app/lib/scripts/migrate-db-to-pgres.js --dbdir /data --privateKey /data/passkey.pem --connectionString {{ matrix_appservice_irc_database_connection_string }}'
+
+- name: Archive NeDB database files
+  command:
+    cmd: "mv {{ matrix_appservice_irc_data_path }}/{{ item }} {{ matrix_appservice_irc_data_path }}/{{ item }}.backup"
+  with_items:
+    - rooms.db
+    - users.db
+
+- name: Inject result
+  set_fact:
+    matrix_playbook_runtime_results: |
+      {{
+        matrix_playbook_runtime_results|default([])
+        +
+        [
+          "NOTE: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_irc_data_path }}/*.db` to `{{ matrix_appservice_irc_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
+        ]
+      }}

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

@@ -0,0 +1,194 @@
+---
+
+- name: Ensure Appservice IRC paths exist
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_appservice_irc_base_path }}", when: true }
+    - { path: "{{ matrix_appservice_irc_config_path }}", when: true }
+    - { path: "{{ matrix_appservice_irc_data_path }}", when: true }
+    - { path: "{{ matrix_appservice_irc_docker_src_files_path }}", when: "{{ matrix_appservice_irc_container_self_build }}" }
+  when: item.when|bool
+
+- name: Check if an old passkey file already exists
+  stat:
+    path: "{{ matrix_appservice_irc_base_path }}/passkey.pem"
+  register: matrix_appservice_irc_stat_passkey
+
+- block:
+    - name: (Data relocation) Ensure matrix-appservice-irc.service is stopped
+      service:
+        name: matrix-appservice-irc
+        state: stopped
+        daemon_reload: yes
+      failed_when: false
+
+    - name: (Data relocation) Move AppService IRC passkey.pem file to ./data directory
+      command: "mv {{ matrix_appservice_irc_base_path }}/passkey.pem {{ matrix_appservice_irc_data_path }}/passkey.pem"
+
+    - name: (Data relocation) Move AppService IRC database files to ./data directory
+      command: "mv {{ matrix_appservice_irc_base_path }}/{{ item }} {{ matrix_appservice_irc_data_path }}/{{ item }}"
+      with_items:
+        - rooms.db
+        - users.db
+      failed_when: false
+  when: "matrix_appservice_irc_stat_passkey.stat.exists"
+
+- set_fact:
+    matrix_appservice_irc_requires_restart: false
+
+- block:
+    - name: Check if a nedb database already exists
+      stat:
+        path: "{{ matrix_appservice_irc_data_path }}/users.db"
+      register: matrix_appservice_irc_nedb_database_path_local_stat_result
+
+    - block:
+        - import_tasks: "{{ role_path }}/tasks/migrate_nedb_to_postgres.yml"
+
+        - set_fact:
+            matrix_appservice_irc_requires_restart: true
+      when: "matrix_appservice_irc_nedb_database_path_local_stat_result.stat.exists|bool"
+  when: "matrix_appservice_irc_database_engine == 'postgres'"
+
+- name: Ensure Appservice IRC image is pulled
+  docker_image:
+    name: "{{ matrix_appservice_irc_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_appservice_irc_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_irc_docker_image_force_pull }}"
+  when: "matrix_appservice_irc_enabled|bool and not matrix_appservice_irc_container_self_build|bool"
+
+- name: Ensure matrix-appservice-irc repository is present when self-building
+  git:
+    repo: "{{ matrix_appservice_irc_docker_repo }}"
+    dest: "{{ matrix_appservice_irc_docker_src_files_path }}"
+    force: "yes"
+  register: matrix_appservice_irc_git_pull_results
+  when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_self_build|bool"
+
+- name: Ensure matrix-appservice-irc Docker image is built
+  docker_image:
+    name: "{{ matrix_appservice_irc_docker_image }}"
+    source: build
+    force_source: "{{ matrix_appservice_irc_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_irc_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_appservice_irc_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_self_build|bool and matrix_appservice_irc_git_pull_results.changed"
+
+- name: Ensure Matrix Appservice IRC config installed
+  copy:
+    content: "{{ matrix_appservice_irc_configuration|to_nice_yaml }}"
+    dest: "{{ matrix_appservice_irc_config_path }}/config.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Check if Appservice IRC passkey exists
+  stat:
+    path: "{{ matrix_appservice_irc_data_path }}/passkey.pem"
+  register: irc_passkey_file
+
+- name: Generate Appservice IRC passkey if it doesn't exist
+  shell: "{{ matrix_host_command_openssl }} genpkey -out {{ matrix_appservice_irc_data_path }}/passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048"
+  become: true
+  become_user: "{{ matrix_user_username }}"
+  when: "not irc_passkey_file.stat.exists"
+
+# In the past, we used to generate the passkey.pem file with root, so permissions may not be okay.
+# Fix it.
+- name: (Migration) Ensure Appservice IRC passkey permissions are okay
+  file:
+    path: "{{ matrix_appservice_irc_data_path }}/passkey.pem"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+# Ideally, we'd like to generate the final registration.yaml file by ourselves.
+#
+# However, the IRC bridge supports multiple servers, which leads to multiple
+# users/aliases/rooms rules in the registration file.
+#
+# Generating a proper file by ourselves is complicated and may lead to deviation
+# from what the bridge is doing.
+#
+# Instead, we do another hacky thing - asking the bridge to generate a template,
+# and then we parse it and fix it up with our own AS/HS token.
+# We need to do this, because:
+# - we'd like to have an up-to-date registration file
+# - we can achieve this by asking the bridge to rebuild it each time
+# - however, the bridge insists on regenerating all tokens each time
+# - .. which is not friendly for integrating with the homeserver
+#
+# So we have a hybrid approach. We ask the bridge to always generate
+# an up-to-date file, and we fix it up with some static values later on,
+# to produce a final registration.yaml file, as we desire.
+- name: Generate Appservice IRC registration-template.yaml
+  shell: >-
+    {{ matrix_host_command_docker }} run --rm --name matrix-appservice-irc-gen
+    --user={{ matrix_user_uid }}:{{ matrix_user_gid }}
+    --cap-drop=ALL
+    -v {{ matrix_appservice_irc_config_path }}:/config:z
+    -v {{ matrix_appservice_irc_data_path }}:/data:z
+    --entrypoint=/bin/bash
+    {{ matrix_appservice_irc_docker_image }}
+    -c
+    'node app.js
+    -r
+    -f /config/registration-template.yaml
+    -u "http://matrix-appservice-irc:9999"
+    -c /config/config.yaml
+    -l irc_bot'
+  changed_when: false
+
+- name: Read Appservice IRC registration-template.yaml
+  slurp:
+    src: "{{ matrix_appservice_irc_config_path }}/registration-template.yaml"
+  register: matrix_appservice_irc_registration_template_slurp
+
+- name: Remove unnecessary Appservice IRC registration-template.yaml
+  file:
+    path: "{{ matrix_appservice_irc_config_path }}/registration-template.yaml"
+    state: absent
+  changed_when: false
+
+- name: Parse registration-template.yaml
+  set_fact:
+    matrix_appservice_irc_registration_template: "{{ matrix_appservice_irc_registration_template_slurp['content'] | b64decode | from_yaml }}"
+
+- name: Combine registration-template.yaml and own registration override config
+  set_fact:
+    matrix_appservice_irc_registration: "{{ matrix_appservice_irc_registration_template|combine(matrix_appservice_irc_registration_override, recursive=True) }}"
+
+- name: Ensure Appservice IRC registration.yaml installed
+  copy:
+    content: "{{ matrix_appservice_irc_registration|to_nice_yaml }}"
+    dest: "{{ matrix_appservice_irc_config_path }}/registration.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-appservice-irc.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-appservice-irc.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-appservice-irc.service"
+    mode: 0644
+  register: matrix_appservice_irc_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-appservice-irc.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_appservice_irc_systemd_service_result.changed"
+
+- name: Ensure matrix-appservice-irc.service restarted, if necessary
+  service:
+    name: "matrix-appservice-irc.service"
+    state: restarted
+  when: "matrix_appservice_irc_requires_restart|bool"

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

@@ -0,0 +1,24 @@
+---
+
+- name: Check existence of matrix-appservice-irc service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-appservice-irc.service"
+  register: matrix_appservice_irc_service_stat
+
+- name: Ensure matrix-appservice-irc is stopped
+  service:
+    name: matrix-appservice-irc
+    state: stopped
+    daemon_reload: yes
+  when: "matrix_appservice_irc_service_stat.stat.exists"
+
+- name: Ensure matrix-appservice-irc.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-appservice-irc.service"
+    state: absent
+  when: "matrix_appservice_irc_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-appservice-irc.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_appservice_irc_service_stat.stat.exists"

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

@@ -0,0 +1,35 @@
+---
+
+- name: Fail if required settings not defined
+  fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`).
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_appservice_irc_appservice_token"
+    - "matrix_appservice_irc_homeserver_token"
+
+# Our base configuration (`matrix_appservice_irc_configuration_yaml`) is not enough to
+# let the playbook run without errors.
+#
+# Unless the final configuration (`matrix_appservice_irc_configuration`) contains an `ircService` definition,
+# we'd fail generating the registration.yaml file with a non-helpful error.
+#
+# This is a safety check to ensure we fail earlier and in a nicer way.
+- name: Fail if no additional configuration provided
+  fail:
+    msg: >-
+      Your Appservice IRC configuration is incomplete (lacking an `ircService.servers` configuration).
+      You need to define one or more servers by either using `matrix_appservice_irc_ircService_servers`
+      or by extending the base configuration with additional configuration in `matrix_appservice_irc_configuration_extension_yaml`.
+      Overriding the whole bridge's configuration (`matrix_appservice_irc_configuration`) is yet another possibility.
+  when: "matrix_appservice_irc_configuration.ircService.servers|length == 0"
+
+- name: (Deprecation) Catch and report renamed appservice-irc variables
+  fail:
+    msg: >-
+      Your configuration contains a variable, which now has a different name.
+      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
+  when: "item.old in vars"
+  with_items:
+    - {'old': 'matrix_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_appservice_irc_container_http_host_bind_port>'}