Comparer les révisions

{

    "parser": "@typescript-eslint/parser",

    "plugins": ["@typescript-eslint"],

    "parserOptions": {

        "ecmaVersion": 9,

        "ecmaFeatures": {

            "jsx": false

        },

        "project": "tsconfig.json"

    },

    "env": {

        "node": true,

        "jasmine": true

    },

    "extends": ["plugin:@typescript-eslint/recommended"],

    "rules": {

        "ordered-imports": "off",

        "no-trailing-spaces": "error",

        "max-classes-per-file": ["warn", 1],

        "object-literal-sort-keys": "off",

        "@typescript-eslint/naming-convention": "warn",

        "@typescript-eslint/no-explicit-any": "error",

        "@typescript-eslint/prefer-for-of": "error",

        "@typescript-eslint/typedef": "warn",

        "@typescript-eslint/no-floating-promises": "error",

        "curly": "error",

        "no-empty": "off",

        "no-invalid-this": "error",

        "@typescript-eslint/no-throw-literal": "warn",

        "prefer-const": "error",

        "indent": ["error", 4],

        "max-lines": ["warn", 500],

        "no-duplicate-imports": "error",

        "@typescript-eslint/array-type": "error",

        "@typescript-eslint/promise-function-async": "error",

        "no-bitwise": "error",

        "no-console": "error",

        "no-debugger": "error",

        "prefer-template": "error",

        // Disable these as they were introduced by @typescript-eslint/recommended

        "@typescript-eslint/no-use-before-define": "off",

        "@typescript-eslint/no-inferrable-types": "off",

        "@typescript-eslint/member-delimiter-style": "off",

        "@typescript-eslint/no-unused-expressions": "off",

        "@typescript-eslint/interface-name-prefix": "off"

    },

    "overrides": [

        {

            "files": [

                "test/**/*"

            ],

            "rules": {

                "@typescript-eslint/no-empty-function": "off",

                "@typescript-eslint/no-explicit-any": "off"

            }

        }

    ]

}

* @matrix-org/bridges

 No newline at end of file

<!--

Hi there 👋, please check you've read the [CONTRIBUTING](../CONTRIBUTING.md) guide before submitting a PR (it's worth it, honestly).

-->

name: Container Image

on:

  push:

    branches: [ develop ]

    tags: [ 'v*' ]

  pull_request:

    branches: [ develop ]

env:

  IMAGE_NAME: ${{ github.repository }}

  REGISTRY: ghcr.io

jobs:

  push:

    runs-on: ubuntu-latest

    permissions:

      contents: read

      packages: write

    steps:

      - name: Checkout repository

        uses: actions/checkout@v2

      - name: Log into registry ${{ env.REGISTRY }}

        uses: docker/login-action@v1

        with:

          registry: ${{ env.REGISTRY }}

          username: ${{ github.actor }}

          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Extract Docker metadata

        id: meta

        uses: docker/metadata-action@v3

        with:

          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

      - name: Build and push Docker image

        uses: docker/build-push-action@v3

        with:

          push: ${{ github.event_name != 'pull_request' }}

          tags: ${{ steps.meta.outputs.tags }}

          labels: ${{ steps.meta.outputs.labels }}

name: Newsfile

on:

  push:

    branches: ["develop", "release-*"]

  pull_request:

  workflow_dispatch:

jobs:

  changelog:

    if: ${{ github.base_ref == 'develop'  || contains(github.base_ref, 'release-') }}

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

        with:

          ref: ${{ github.event.pull_request.head.sha }}

          fetch-depth: 0

      - uses: actions/setup-python@v2

      - run: pip install towncrier==21.9.0

      - run: scripts/check-newsfragment

        env:

          PULL_REQUEST_NUMBER: ${{ github.event.number }}

name: Contribution requirements

on:

  pull_request:

    types: [opened, edited, synchronize]

jobs:

  signoff:

    uses: matrix-org/backend-meta/.github/workflows/sign-off.yml@v1.4.0

name: CI

on: [push, pull_request]

jobs:

  lint:

   runs-on: ubuntu-latest

   steps:

    - uses: actions/checkout@v2

    - name: Use Node.js

      uses: actions/setup-node@v1

      with:

        node-version: 16

    - run: yarn

    - run: yarn lint

  test:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        node_version: [16, 18]

    steps:

      - uses: actions/checkout@v2

      - name: Use Node.js ${{ matrix.node_version }}

        uses: actions/setup-node@v1

        with:

          node-version: ${{ matrix.node_version }}

      - run: yarn

      - run: yarn test

# Optional npm cache directory

.npm

# Optional local Yarn settings

.yarn

.yarnrc

# Optional REPL history

.node_repl_history

*.db

*.db.backup

.vscode/

*.code-workspace

# Local History for Visual Studio Code

.history/

reporter: list

ui: bdd

require: 

  - "ts-node/register"

  - "source-map-support/register"

recursive: true

 No newline at end of file

engine-strict = true

@mx-puppet:registry="https://gitlab.com/api/v4/packages/npm/"

{

    "extends": "@istanbuljs/nyc-config-typescript",

    "reporter": ["text", "text-summary", "lcov"],

    "all": true

}

language: node_js

install: npm install && npm run build

node_js:

    - "10"

    - "12"

jobs:

    - script: npm run test

      name: "Unit - Node 10"

      node_js: "10"

    - script: npm run test

      name: "Unit - Node 12"

      node_js: "12"

    - script: npm run lint

      name: "Linting"

      node_js: "12"

    - script: npm run coverage

      name: "Coverage"

      node_js: "12"

notifications:

    webhooks:

        urls:

            - "https://scalar.vector.im/api/neb/services/hooks/dHJhdmlzLWNpLyU0MEhhbGYtU2hvdCUzQWhhbGYtc2hvdC51ay8lMjFxUE5PblVzTnNaclRvRlpxeEIlM0FoYWxmLXNob3QudWs"

        on_success: change  # always|never|change

        on_failure: always

        on_start: never

3.1.1 (2022-11-10)

==================

Bugfixes

--------

- Fix a crash caused by processing metrics for Matrix events. ([\#869](https://github.com/matrix-org/matrix-appservice-discord/issues/869))

3.1.0 (2022-11-03)

==================

Features

--------

- Adds a config value, in order to disable forwarding room topic changes from Matrix to Discord (`disableRoomTopicNotifications`, false by default). ([\#836](https://github.com/matrix-org/matrix-appservice-discord/issues/836))

Bugfixes

--------

- Include the domain name in the regular expression. ([\#834](https://github.com/matrix-org/matrix-appservice-discord/issues/834))

- Remove usage of unreliable field `age` on events, allowing the bridge to work with non-Synapse homeserver implementations. ([\#842](https://github.com/matrix-org/matrix-appservice-discord/issues/842))

- Prevent crashes when handling messages sent to voice channels. ([\#858](https://github.com/matrix-org/matrix-appservice-discord/issues/858))

3.0.0 (2022-08-12)

==================

Bugfixes

--------

- Make sure we don't lose errors thrown when checking usage limits. ([\#823](https://github.com/matrix-org/matrix-appservice-discord/issues/823))

- Fix Docker instances not starting due to being unable to load a dynamic library in the latest unstable image. ([\#828](https://github.com/matrix-org/matrix-appservice-discord/issues/828))

- Remove matrix.to hyperlinks when relaying non-Discord user mentions to Discord.

  Fix mentioning Matrix users in Discord. ([\#829](https://github.com/matrix-org/matrix-appservice-discord/issues/829))

Deprecations and Removals

-------------------------

- Minimum required Node.js version is now 16. ([\#825](https://github.com/matrix-org/matrix-appservice-discord/issues/825))

Internal Changes

----------------

- Remove unused variables. ([\#657](https://github.com/matrix-org/matrix-appservice-discord/issues/657))

- Add workflow for building docker images, and push new docker images to ghcr.io. ([\#826](https://github.com/matrix-org/matrix-appservice-discord/issues/826))

- Remove `git config` workaround to pull a dependency from github.com. ([\#830](https://github.com/matrix-org/matrix-appservice-discord/issues/830))

2.0.0 (2022-08-05)

==================

Improved Documentation

----------------------

- Update `CONTRIBUTING.md` guide to reference the newly-updated guide for all of the matrix.org bridge repos. ([\#794](https://github.com/matrix-org/matrix-appservice-discord/issues/794))

Deprecations and Removals

-------------------------

- Node.JS 12 is now unsupported, please upgrade to Node.JS 14 or later. Node.JS 16 becomes the new default version. ([\#811](https://github.com/matrix-org/matrix-appservice-discord/issues/811))

Internal Changes

----------------

- Add automatic changelog generation via [Towncrier](https://github.com/twisted/towncrier). ([\#787](https://github.com/matrix-org/matrix-appservice-discord/issues/787))

- Use `yarn` instead of `npm` for package management and scripts. ([\#796](https://github.com/matrix-org/matrix-appservice-discord/issues/796))

- Add new CI workflow to check for signoffs. ([\#818](https://github.com/matrix-org/matrix-appservice-discord/issues/818))

Hi there! Please read the [CONTRIBUTING.md](https://github.com/matrix-org/matrix-appservice-bridge/blob/develop/CONTRIBUTING.md) guide for all matrix.org bridge

projects.

## matrix-appservice-discord Guidelines

* Discussion of ideas for the bridge and work items should be in [#discord:half-shot.uk](https://matrix.to/#/#discord:half-shot.uk).

* Everything submitted as a PR should have at least one test, the only exception being non-code items.

## Overview of the Bridge

The bridge runs as a standalone server that connects to both the Discord API

network and a local Matrix homeserver over the [application service

protocol](https://matrix.org/docs/spec/application_service/unstable.html).

Primarily it syncs events and users from Matrix to Discord and vice versa.

While the bridge is constantly evolving and we can't keep this section updated

with each component, we follow the principle of handler and processor classes

and each part of the functionality of the bridge will be in a seperate class.

For example, the processing of Matrix events destined for Discord are handled

inside the `MatrixEventProcessor` class.

## Setting up

* You will need to [setup the bridge](https://github.com/Half-Shot/matrix-appservice-discord/tree/develop#setup-the-bridge) similarly to how we describe,

  but you should setup a homeserver locally on your development machine. We would recommend [Synapse](https://github.com/matrix-org/synapse).

* The bridge uses `yarn` for dependency management and package scripts instead of `npm`.

  For details, view the full setup instructions in the [README](README.md#set-up-the-bridge).

## Testing

CI will lint and test your code automatically,

but you can save yourself some time by checking locally before submitting code.

Refer to the main matrix.org bridge contributing guide for instructions on how to

[lint](https://github.com/matrix-org/matrix-appservice-bridge/blob/develop/CONTRIBUTING.md#%EF%B8%8F-code-style) and

[test](https://github.com/matrix-org/matrix-appservice-bridge/blob/develop/CONTRIBUTING.md#-tests--ci).

Please bear in mind that you will need to cover the whole, or a reasonable

degree of your code. You can check to see if you have with `yarn coverage`.

FROM node:alpine AS BUILD

FROM node:16-slim AS BUILD

COPY . /tmp/src

# install some dependencies needed for the build process

RUN apk add --no-cache -t build-deps make gcc g++ python ca-certificates libc-dev wget

RUN apt update && apt install -y build-essential make gcc g++ python3 ca-certificates libc-dev wget git

RUN cd /tmp/src \

    && npm install \

    && npm run build

    && yarn

FROM node:alpine

FROM node:16-slim

ENV NODE_ENV=production

COPY --from=BUILD /tmp/src/build /build

COPY --from=BUILD /tmp/src/config /config

# Matrix Discord Bridge

A bridge between [Matrix](http://matrix.org/) and [Discord](https://discordapp.com/).

A bridge between [Matrix](http://matrix.org/) and [Discord](https://discord.com/).

Currently the bridge is in **Beta** and quite usable for everyday

bridging, with one or two bugs cropping up.

![Screenshot of Riot and Discord working together](screenshot.png)

![Screenshot of Element and Discord working together](screenshot.png)

## Helping out

[![Build Status](https://travis-ci.org/Half-Shot/matrix-appservice-discord.svg?branch=develop)](https://travis-ci.org/Half-Shot/matrix-appservice-discord)

[![Docker Automated build](https://img.shields.io/docker/builds/halfshot/matrix-appservice-discord.svg)](https://hub.docker.com/r/halfshot/matrix-appservice-discord)

[![#discord:half-shot.uk](https://img.shields.io/matrix/discord:half-shot.uk.svg?server_fqdn=matrix.half-shot.uk&label=%23discord:half-shot.uk&logo=matrix)](https://matrix.to/#/#discord:half-shot.uk)

### PRs

### Issues

You can also file bug reports/ feature requests on Github Issues which also helps a ton. Please remember to include logs.

Please also be aware that this is an unoffical project worked on in my (Half-Shot) spare time.

Please also be aware that this is an unoffical project worked on in our spare time.

## Setting up

The bridge has been tested against the [Synapse](https://github.com/matrix-org/synapse) homeserver, although any homeserver

that implements the [AS API](https://matrix.org/docs/spec/application_service/r0.1.0.html) should work with this bridge.

The bridge supports any version of Node.js >= v10.X, including all [current releases](https://nodejs.org/en/about/releases/).

The bridge supports any version of Node.js between v14.X - v18.X. View the [releases](https://nodejs.org/en/about/releases/) for more details.

The bridge uses Yarn for dependency management and package scripts.

For the time being, **only Yarn Classic / v1 is supported.** To install it, follow [these instructions](https://classic.yarnpkg.com/en/docs/install).

If you already have Yarn 2+ installed, you may configure just this project to use Yarn Classic

by running ``yarn set version classic`` in the directory where you cloned this repository.

### Set up the bridge

* Run ``npm install`` to grab the dependencies.

* Run ``npm run build`` to build the typescript into javascript.

* Run ``yarn`` to grab the dependencies.

* Copy ``config/config.sample.yaml`` to ``config.yaml`` and edit it to reflect your setup.

  * Note that you are expected to set ``domain`` and ``homeserverURL`` to your **public** host name.

  While localhost would work, it does not resolve correctly with Webhooks/Avatars.

# Run the container

docker run -v /matrix-appservice-discord:/data -p 9005:9005 halfshot/matrix-appservice-discord

```

#### Metrics

The bridge supports reporting metrics via Prometheus. You can configure metrics support in the config

file. The metrics will be reported under the URL provided in the registration file, on the `/metrics` endpoint.

#### 3PID Protocol Support

This bridge support searching for rooms within networks via the 3pid system

used in clients like [Riot](https://riot.im). Any new servers/guilds you bridge

should show up in the network list on Riot and other clients.

used in clients like [Element](https://element.io). Any new servers/guilds you bridge

should show up in the network list on Element and other clients.

### Setting up Discord

* Create a new application via https://discordapp.com/developers/applications

* Create a new application via https://discord.com/developers/applications

* Make sure to create a bot user. Fill in ``config.yaml``

* Run ``npm run addbot`` to get a authorisation link.

* Run ``yarn addbot`` to get a authorisation link.

* Give this link to owners of the guilds you plan to bridge.

* Finally, you can join a room with ``#_discord_guildid_channelid``

  * These can be taken from the url ("/$GUILDID/$CHANNELID") when you are in a channel.

  * Riot (and other clients with third party protocol support) users can directly join channels from the room directory.

  * Element (and other clients with third party protocol support) users can directly join channels from the room directory.

* You can use Webhooks to make messages relayed by the bridge not nested by the bot user. This will also display the avatar of the user speaking on matrix with their messages.

  * The bot should create this automatically, but if not perform the following:

    * Enable ``Manage Webhooks`` on the role added by the bot.

### Running the Bridge

* For the bot to appear online on Discord you need to run the bridge itself.

* ``npm start``

* ``yarn start``

* Particular configuration keys can be overridden by defining corresponding environment variables. For instance, `auth.botToken` can be set with `APPSERVICE_DISCORD_AUTH_BOT_TOKEN`.

[Howto](./docs/howto.md)

## End User Documentation

### Bridging a Room

You must get an authorization link from bridge owner. You must be a server admin or get

help from server admin on Discord side.

* Invite the Matrix side bot to your room and wait for it to join.

* On Discord side use the authorization link to invite bot to Discord server.

* Find out a serverid and channelid for your server/channel you want to bridge. Search the web for instructions.

* In Matrix room give command ``!discord bridge ServerID ChannelID``

* The bridge will ask for confirmation from the Discord server admins to complete the bridge. Once approved, you're all set.

### Unbridging a Room

* In Matrix room give command ``!discord unbridge``

## Features and Roadmap

In a vague order of what is coming up next

# This is a sample of the config file showing all avaliable options.

# This is a sample of the config file showing all available options.

# Where possible we have documented what they do, and all values are the

# default values.

bridge:

  # Domain part of the bridge, e.g. matrix.org

  domain: "localhost"

  # This should be your publically facing URL because Discord may use it to

  # This should be your publicly-facing URL because Discord may use it to

  # fetch media from the media store.

  homeserverUrl: "http://localhost:8008"

  # The TCP port on which the appservice runs on.

  port: 9005

  # Interval at which to process users in the 'presence queue'. If you have

  # 5 users, one user will be processed every 500 milliseconds according to the

  # value below. This has a minimum value of 250.

  disableTypingNotifications: false

  # Disable deleting messages on Discord if a message is redacted on Matrix.

  disableDeletionForwarding: false

  # Disable portal bridging, where Matrix users can search for unbridged Discord

  # rooms on their Matrix server.

  disablePortalBridging: false

  # Enable users to bridge rooms using !discord commands. See

  # https://t2bot.io/discord for instructions.

  enableSelfServiceBridging: false

  disableReadReceipts: false

  # Disable Join Leave echos from matrix

  disableJoinLeaveNotifications: false

  # Disable Invite echos from matrix

  disableInviteNotifications: false

  # Disable Room Topic echos from matrix

  disableRoomTopicNotifications: false

  # Auto-determine the language of code blocks (this can be CPU-intensive)

  determineCodeLanguage: false

  # MXID of an admin user that will be PMd if the bridge experiences problems. Optional

  adminMxid: '@admin:localhost'

  # The message to send to the bridge admin if the Discord token is not valid

  invalidTokenMessage: 'Your Discord bot token seems to be invalid, and the bridge cannot function. Please update it in your bridge settings and restart the bridge'

# Authentication configuration for the discord bot.

auth:

  # This MUST be a string (wrapped in quotes)

  clientID: "12345"

  botToken: "foobar"

  # You must enable "Privileged Gateway Intents" in your bot settings on discord.com (e.g. https://discord.com/developers/applications/12345/bot)

  # for this to work

  usePrivilegedIntents: false

logging:

  # What level should the logger output to the console at.

  console: "warn" #silly, verbose, info, http, warn, error, silent

      enable:

        - "DiscordBot"

database:

  userStorePath: "user-store.db"

  roomStorePath: "room-store.db"

  # You may either use SQLite or Postgresql for the bridge database, which contains

  # important mappings for events and user puppeting configurations.

  # Use the filename option for SQLite, or connString for Postgresql.

       unsetRoomAlias: true

       # Remove the room from the directory.

       unlistFromDirectory: true

       # Set the room to be unavaliable for joining without an invite.

       # Set the room to be unavailable for joining without an invite.

       setInviteOnly: true

       # Make all the discord users leave the room.

       ghostsLeave: true

limits:

    # Delay in milliseconds between discord users joining a room.

    roomGhostJoinDelay: 6000

    # Delay in milliseconds before sending messages to discord to avoid echos.

    # (Copies of a sent message may arrive from discord before we've

    # Lock timeout in milliseconds before sending messages to discord to avoid

    # echos. Default is rather high as the lock will most likely time out

    # before anyways.

    # echos = (Copies of a sent message may arrive from discord before we've

    # fininished handling it, causing us to echo it back to the room)

    discordSendDelay: 750

    discordSendDelay: 1500

    # Set a maximum of rooms to be bridged.

    # roomCount: 20

ghosts:

    # Pattern for the ghosts nick, available is :nick, :username, :tag and :id

    nickPattern: ":nick"

    # Pattern for the ghosts username, available is :username, :tag and :id

    usernamePattern: ":username#:tag"

# Prometheus-compatible metrics endpoint

metrics:

    enable: false

    port: 9001

    host: "127.0.0.1"

            type: "string"

          homeserverUrl:

            type: "string"

          port:

            type: "number"

          presenceInterval:

            type: "number"

          disablePresence:

            type: "boolean"

          disableDeletionForwarding:

            type: "boolean"

          disablePortalBridging:

            type: "boolean"

          enableSelfServiceBridging:

            type: "boolean"

          disableReadReceipts:

            type: "boolean"

          disableJoinLeaveNotifications:

            type: "boolean"

          disableInviteNotifications:

            type: "boolean"

          disableRoomTopicNotifications:

            type: "boolean"

          userActivity:

            type: "object"

            required: ["minUserActiveDays", "inactiveAfterDays"]

            properties:

              minUserActiveDays:

                type: "number"

              inactiveAfterDays:

                type: "number"

          userLimit:

            type: "number"

    auth:

        type: "object"

        required: ["botToken", "clientID"]

            type: "string"

          botToken:

            type: "string"

          usePrivilegedIntents:

            type: "boolean"

    logging:

        type: "object"

        properties:

                type: "number"

            discordSendDelay:

                type: "number"

            roomCount:

                type: "number"

    channel:

        type: "object"

        properties:

                type: "string"

            usernamePattern:

                type: "string"

    metrics:

        type: "object"

        properties:

            enable:

                type: "boolean"

            port:

                type: "number"

            host:

                type: "string"

# 1.0 Migration (from 0.5.1 or lower)

If you have been linked here, there is an issue with your config on your bridge.

Please follow the following steps:

1. If you have just created a new install OR were previously running 0.5.X,

   please remove `roomDataStore` and `userDataStore` from your config file.

2. If this is a existing install but you have not run 0.5.X (0.4.X or lower),

   please downgrade to 0.5.X to migrate your database across and then run

   this version of the bridge again.

You can find these on discord in the browser where:

``https://discordapp.com/channels/282616294245662720/282616372591329281``

``https://discord.com/channels/282616294245662720/282616372591329281``

is formatted as https://discordapp.com/channels/``guildid``/``channelid``

is formatted as https://discord.com/channels/``guildid``/``channelid``

### Set privileges on bridge managed rooms

* The ``adminme`` script is provided to set Admin/Moderator or any other custom power level to a specific user.

* e.g. To set Alice to Admin on her ``example.com`` HS on default config. (``config.yaml``)

  * ``npm run adminme -- -r '!AbcdefghijklmnopqR:example.com' -u '@Alice:example.com' -p '100'``

  * Run ``npm run adminme -- -h`` for usage.

  * ``yarn adminme -r '!AbcdefghijklmnopqR:example.com' -u '@Alice:example.com' -p '100'``

  * Run ``yarn adminme -h`` for usage.

Please note that `!AbcdefghijklmnopqR:example.com` is the internal room id and will always begin with `!`.

You can find this internal id in the room settings in Riot.

You can find this internal id in the room settings in Element.

### Migrate to postgres from sqlite

* Stop the bridge.