Update LinkedIn to Go version

Author: tulir

api/gitlab/build.go

@@ -70,7 +70,7 @@ func getRefFromBridge(bridge string) (string, error) {
 	switch bridge {
 	case "imessage":
 		return "master", nil
-	case "whatsapp", "discord", "slack", "gmessages", "gvoice", "signal", "imessagego", "meta", "twitter", "bluesky":
+	case "whatsapp", "discord", "slack", "gmessages", "gvoice", "signal", "imessagego", "meta", "twitter", "bluesky", "linkedin":
 		return "main", nil
 	default:
 		return "", fmt.Errorf("unknown bridge %s", bridge)
@@ -165,7 +165,7 @@ func downloadFile(ctx context.Context, artifactURL, path string) error {
 
 func needsLibolmDylib(bridge string) bool {
 	switch bridge {
-	case "imessage", "whatsapp", "discord", "slack", "gmessages", "gvoice", "signal", "imessagego", "meta", "twitter", "bluesky":
+	case "imessage", "whatsapp", "discord", "slack", "gmessages", "gvoice", "signal", "imessagego", "meta", "twitter", "bluesky", "linkedin":
 		return runtime.GOOS == "darwin"
 	default:
 		return false

bridgeconfig/linkedin.tpl.yaml

@@ -1,351 +1,23 @@
-# Homeserver details
-homeserver:
-    # The address that this appservice can use to connect to the homeserver.
-    address: {{ .HungryAddress }}
-    # The domain of the homeserver (for MXIDs, etc).
-    domain: beeper.local
-    # Whether or not to verify the SSL certificate of the homeserver.
-    # Only applies if address starts with https://
-    verify_ssl: true
-    # What software is the homeserver running?
-    # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
-    software: hungry
-    # Number of retries for all HTTP requests if the homeserver isn't reachable.
-    http_retry_count: 4
-    # The URL to push real-time bridge status to.
-    # If set, the bridge will make POST requests to this URL whenever a user's Signal connection state changes.
-    # The bridge will use the appservice as_token to authorize requests.
-    status_endpoint: null
-    # Endpoint for reporting per-message status.
-    message_send_checkpoint_endpoint: null
-    # Whether asynchronous uploads via MSC2246 should be enabled for media.
-    # Requires a media repo that supports MSC2246.
-    async_media: true
-
-# Application service host/registration related details
-# Changing these values requires regeneration of the registration.
-appservice:
-    # The address that the homeserver can use to connect to this appservice.
-    address: "http://{{ .ListenAddr }}:{{ .ListenPort }}"
-
-    # The hostname and port where this appservice should listen.
-    hostname: {{ .ListenAddr }}
-    port: {{ .ListenPort }}
-    # The maximum body size of appservice API requests (from the homeserver) in mebibytes
-    # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s
-    max_body_size: 1
-
-    # The full URI to the database. SQLite and Postgres are supported.
-    # Format examples:
-    #   SQLite:   sqlite:filename.db
-    #   Postgres: postgres://username:password@hostname/dbname
-    database: sqlite:{{.DatabasePrefix}}beeper-linkedin.db
-    # Additional arguments for asyncpg.create_pool() or sqlite3.connect()
-    # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool
-    # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect
-    # For sqlite, min_size is used as the connection thread pool size and max_size is ignored.
-    # Additionally, SQLite supports init_commands as an array of SQL queries to run on connect (e.g. to set PRAGMAs).
-    database_opts:
-        min_size: 1
-        max_size: 1
-
-    # Provisioning API part of the web server for automated portal creation and fetching information.
-    # Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager).
-    provisioning:
-        # Whether or not the provisioning API should be enabled.
-        enabled: true
-        # The prefix to use in the provisioning API endpoints.
-        prefix: /_matrix/provision
-        # The shared secret to authorize users of the API.
-        # Set to "generate" to generate and save a new token.
-        shared_secret: {{ .ProvisioningSecret }}
-
-    # The unique ID of this appservice.
-    id: {{ .AppserviceID }}
-    # Username of the appservice bot.
-    bot_username: {{ .BridgeName }}bot
-    # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
-    # to leave display name/avatar as-is.
-    bot_displayname: LinkedIn bridge bot
-    bot_avatar: mxc://nevarro.space/cwsWnmeMpWSMZLUNblJHaIvP
-
-    # Whether or not to receive ephemeral events via appservice transactions.
-    # Requires MSC2409 support (i.e. Synapse 1.22+).
-    # You should disable bridge -> sync_with_custom_puppets when this is enabled.
-    ephemeral_events: true
-
-    # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
-    as_token: {{ .ASToken }}
-    hs_token: {{ .HSToken }}
-
-# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
-analytics:
-    # Hostname of the tracking server. The path is hardcoded to /v1/track
-    host: api.segment.io
-    # API key to send with tracking requests. Tracking is disabled if this is null.
-    token: null
-    # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
-    user_id: null
-
-# Prometheus telemetry config. Requires prometheus-client to be installed.
-metrics:
-    enabled: false
-    listen_port: 8000
-
-# Manhole config.
-manhole:
-    # Whether or not opening the manhole is allowed.
-    enabled: false
-    # The path for the unix socket.
-    path: /var/tmp/linkedin-matrix.manhole
-    # The list of UIDs who can be added to the whitelist.
-    # If empty, any UIDs can be specified in the open-manhole command.
-    whitelist:
-    - 0
-
-# Bridge config
-bridge:
-    # Localpart template of MXIDs for LinkedIn users.
-    # {userid} is replaced with the user ID of the LinkedIn user.
-    username_template: "{{ .BridgeName }}_{userid}"
-    # Settings for creating a space for every user.
-    space_support:
-        # Whether or not to enable creating a space per user and inviting the
-        # user (as well as all of the puppets) to that space.
-        enable: false
-        # The name of the space
-        name: "LinkedIn"
+# Network-specific config options
+network:
     # Displayname template for LinkedIn users.
-    # {displayname} is replaced with the display name of the LinkedIn user
-    #               as defined below in displayname_preference.
-    # Keys available for displayname_preference are also available here.
-    displayname_template: "{displayname} (LinkedIn)"
-    # Available keys:
-    # "name" (full name)
-    # "first_name"
-    # "last_name"
-    displayname_preference:
-    - name
-    - first_name
-
-    # Whether or not to set the topic on DMs to the user's occupation and a
-    # link to their profile.
-    set_topic_on_dms: true
-
-    # The prefix for commands. Only required in non-management rooms.
-    command_prefix: "!li"
-
-    # Number of chats to sync (and create portals for) on startup/login.
-    # Set 0 to disable automatic syncing.
-    initial_chat_sync: 20
-    # Whether or not the LinkedIn users of logged in Matrix users should be
-    # invited to private chats when the user sends a message from another client.
-    invite_own_puppet_to_pm: false
-    # Whether or not to use /sync to get presence, read receipts and typing notifications
-    # when double puppeting is enabled
-    sync_with_custom_puppets: false
-    # Whether or not to update the m.direct account data event when double puppeting is enabled.
-    # Note that updating the m.direct event is not atomic (except with mautrix-asmux)
-    # and is therefore prone to race conditions.
-    sync_direct_chat_list: false
-    # Servers to always allow double puppeting from
-    double_puppet_server_map:
-        {{ .BeeperDomain }}: {{ .HungryAddress }}
-    # Allow using double puppeting from any server with a valid client .well-known file.
-    double_puppet_allow_discovery: false
-    # Shared secrets for https://github.com/devture/matrix-synapse-shared-secret-auth
-    #
-    # If set, custom puppets will be enabled automatically for local users
-    # instead of users having to find an access token and run `login-matrix`
-    # manually.
-    # If using this for other servers than the bridge's server,
-    # you must also set the URL in the double_puppet_server_map.
-    login_shared_secret_map:
-        {{ .BeeperDomain }}: "as_token:{{ .ASToken }}"
-    # Whether or not to bridge presence in both directions. LinkedIn allows users not to broadcast
-    # presence, but then it won't send other users' presence to the client.
-    presence: false
-    # Whether or not to update avatars when syncing all contacts at startup.
-    update_avatar_initial_sync: true
-    # Whether or not created rooms should have federation enabled.
-    # If false, created portal rooms will never be federated.
-    federate_rooms: false
-    # Whether to explicitly set the avatar and room name for private chat portal rooms.
-    # If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms.
-    # If set to `always`, all DM rooms will have explicit names and avatars set.
-    # If set to `never`, DM rooms will never have names and avatars set.
-    private_chat_portal_meta: never
-
-    # End-to-bridge encryption support options.
-    #
-    # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
-    encryption:
-        # Allow encryption, work in group chat rooms with e2ee enabled
-        allow: true
-        # Default to encryption, force-enable encryption in all portals the bridge creates
-        # This will cause the bridge bot to be in private chats for the encryption to work properly.
-        default: true
-        # Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data.
-        appservice: true
-        # Require encryption, drop any unencrypted messages.
-        require: true
-        # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
-        # You must use a client that supports requesting keys from other users to use this feature.
-        allow_key_sharing: true
-        # Options for deleting megolm sessions from the bridge.
-        delete_keys:
-            # Beeper-specific: delete outbound sessions when hungryserv confirms
-            # that the user has uploaded the key to key backup.
-            delete_outbound_on_ack: true
-            # Don't store outbound sessions in the inbound table.
-            dont_store_outbound: false
-            # Ratchet megolm sessions forward after decrypting messages.
-            ratchet_on_decrypt: true
-            # Delete fully used keys (index >= max_messages) after decrypting messages.
-            delete_fully_used_on_decrypt: true
-            # Delete previous megolm sessions from same device when receiving a new one.
-            delete_prev_on_new_session: true
-            # Delete megolm sessions received from a device when the device is deleted.
-            delete_on_device_delete: true
-            # Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
-            periodically_delete_expired: true
-            # Delete inbound megolm sessions that don't have the received_at field used for
-            # automatic ratcheting and expired session deletion. This is meant as a migration
-            # to delete old keys prior to the bridge update.
-            delete_outdated_inbound: true
-        # What level of device verification should be required from users?
-        #
-        # Valid levels:
-        #   unverified - Send keys to all device in the room.
-        #   cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
-        #   cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
-        #   cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
-        #                           Note that creating user signatures from the bridge bot is not currently possible.
-        #   verified - Require manual per-device verification
-        #              (currently only possible by modifying the `trust` column in the `crypto_device` database table).
-        verification_levels:
-            # Minimum level for which the bridge should send keys to when bridging messages from Telegram to Matrix.
-            receive: cross-signed-tofu
-            # Minimum level that the bridge should accept for incoming Matrix messages.
-            send: cross-signed-tofu
-            # Minimum level that the bridge should require for accepting key requests.
-            share: cross-signed-tofu
-        # Options for Megolm room key rotation. These options allow you to
-        # configure the m.room.encryption event content. See:
-        # https://spec.matrix.org/v1.3/client-server-api/#mroomencryption for
-        # more information about that event.
-        rotation:
-            # Enable custom Megolm room key rotation settings. Note that these
-            # settings will only apply to rooms created after this option is
-            # set.
-            enable_custom: true
-            # The maximum number of milliseconds a session should be used
-            # before changing it. The Matrix spec recommends 604800000 (a week)
-            # as the default.
-            milliseconds: 2592000000
-            # The maximum number of messages that should be sent with a given a
-            # session before changing it. The Matrix spec recommends 100 as the
-            # default.
-            messages: 10000
-
-            # Disable rotating keys when a user's devices change?
-            # You should not enable this option unless you understand all the implications.
-            disable_device_change_key_rotation: true
-
-    # Whether or not the bridge should send a read receipt from the bridge bot when a message has
-    # been sent to LinkedIn.
-    delivery_receipts: true
-    # Whether to allow inviting arbitrary mxids to portal rooms
-    allow_invites: false
-    # Settings for backfilling messages from LinkedIn.
-    backfill:
-        # Whether or not the LinkedIn users of logged in Matrix users should be
-        # invited to private chats when backfilling history from LinkedIn. This is
-        # usually needed to prevent rate limits and to allow timestamp massaging.
-        invite_own_puppet: false
-        # Maximum number of messages to backfill initially.
-        # Set to 0 to disable backfilling when creating portal.
-        initial_limit: 1
-        # Maximum number of messages to backfill if messages were missed while
-        # the bridge was disconnected.
-        # Set to 0 to disable backfilling missed messages.
-        missed_limit: 50
-        # If using double puppeting, should notifications be disabled
-        # while the initial backfill is in progress?
-        disable_notifications: true
-        # If this value is greater than 0, then (on backfill) if the
-        # conversation's last message was more than this number of hours ago,
-        # then the conversation will automatically be marked it as read.
-        unread_hours_threshold: 0
-    periodic_reconnect:
-        # Interval in seconds in which to automatically reconnect all users.
-        # This can be used to automatically mitigate the bug where Linkedin stops sending messages.
-        # Set to -1 to disable periodic reconnections entirely.
-        interval: 21600
-        # What to do in periodic reconnects. Either "refresh" or "reconnect"
-        mode: refresh
-        # Should even disconnected users be reconnected?
-        always: true
-    # The number of seconds that a disconnection can last without triggering an automatic re-sync
-    # and missed message backfilling when reconnecting.
-    # Set to 0 to always re-sync, or -1 to never re-sync automatically.
-    resync_max_disconnected_time: 5
-    # Whether or not temporary disconnections should send notices to the notice room.
-    # If this is false, disconnections will never send messages and connections will only send
-    # messages if it was disconnected for more than resync_max_disconnected_time seconds.
-    temporary_disconnect_notices: false
-    # Whether or not the bridge should try to "refresh" the connection if a normal reconnection
-    # attempt fails.
-    refresh_on_reconnection_fail: true
-    # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
-    # This field will automatically be changed back to false after it,
-    # except if the config file is not writable.
-    resend_bridge_info: false
-    # When using double puppeting, should muted chats be muted in Matrix?
-    mute_bridging: true
-    # Whether or not mute status and tags should only be bridged when the portal room is created.
-    tag_only_on_create: true
-
-    # Permissions for using the bridge.
-    # Permitted values:
-    #       user - Use the bridge with puppeting.
-    #      admin - Use and administrate the bridge.
-    # Permitted keys:
-    #        * - All Matrix users
-    #   domain - All users on that homeserver
-    #     mxid - Specific user
-    permissions:
-        "{{ .UserID }}": "admin"
-
-# Python logging configuration.
-#
-# See section 16.7.2 of the Python documentation for more info:
-# https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema
-logging:
-    version: 1
-    formatters:
-        colored:
-            (): mautrix.util.logging.color.ColorFormatter
-            format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
-        normal:
-            format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
-    handlers:
-        file:
-            class: logging.handlers.RotatingFileHandler
-            formatter: normal
-            filename: ./logs/beeper-linkedin.log
-            maxBytes: 10485760
-            backupCount: 10
-        console:
-            class: logging.StreamHandler
-            formatter: colored
-    loggers:
-        mau:
-            level: DEBUG
-        paho.mqtt:
-            level: INFO
-        aiohttp:
-            level: INFO
-    root:
-        level: DEBUG
-        handlers: [file, console]
+    # .FirstName is replaced with the first name
+    # .LastName is replaced with the last name
+    # .Organization is replaced with the organization name
+    displayname_template: {{ `"{{ with .Organization }}{{ . }}{{ else }}{{ .FirstName }} {{ .LastName }}{{ end }}"` }}
+
+    sync:
+        # Number of most recently active dialogs to check when syncing chats.
+        # Set to 0 to remove limit.
+        update_limit: 0
+        # Number of most recently active dialogs to create portals for when syncing
+        # chats.
+        # Set to 0 to remove limit.
+        create_limit: 10
+
+{{ setfield . "CommandPrefix" "!linkedin" -}}
+{{ setfield . "DatabaseFileName" "mautrix-linkedin" -}}
+{{ setfield . "BridgeTypeName" "LinkedIn" -}}
+{{ setfield . "BridgeTypeIcon" "mxc://nevarro.space/cwsWnmeMpWSMZLUNblJHaIvP" -}}
+{{ setfield . "DefaultPickleKey" "mautrix.bridge.e2ee" -}}
+{{ template "bridgev2.tpl.yaml" . }}

cmd/bbctl/bridgeutil.go

@@ -52,6 +52,7 @@ var websocketBridges = map[string]bool{
 	"meta":         true,
 	"twitter":      true,
 	"bluesky":      true,
+	"linkedin":     true,
 }
 
 func doOutputFile(ctx *cli.Context, name, data string) error {