File

mod_pubsub_forgejo/webhook-examples/pull_request_rejected/content.json @ 6301:fa45ae704b79

mod_cloud_notify: Update Readme diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md --- a/mod_cloud_notify/README.md +++ b/mod_cloud_notify/README.md @@ -1,109 +1,106 @@ ---- -labels: -- 'Stage-Beta' -summary: 'XEP-0357: Cloud push notifications' ---- +# Introduction -Introduction -============ +This module enables support for sending "push notifications" to clients +that need it, typically those running on certain mobile devices. -This module enables support for sending "push notifications" to clients that -need it, typically those running on certain mobile devices. +As well as this module, your client must support push notifications (the +apps that need it generally do, of course) and the app developer's push +gateway must be reachable from your Prosody server (this happens over a +normal XMPP server-to-server 's2s' connection). -As well as this module, your client must support push notifications (the apps -that need it generally do, of course) and the app developer's push gateway -must be reachable from your Prosody server (this happens over a normal XMPP -server-to-server 's2s' connection). - -Details -======= +# Details Some platforms, notably Apple's iOS and many versions of Android, impose -limits that prevent applications from running or accessing the network in the -background. This makes it difficult or impossible for an XMPP application to -remain reliably connected to a server to receive messages. - -In order for messaging and other apps to receive notifications, the OS vendors -run proprietary servers that their OS maintains a permanent connection to in -the background. Then they provide APIs to application developers that allow -sending notifications to specific devices via those servers. +limits that prevent applications from running or accessing the network +in the background. This makes it difficult or impossible for an XMPP +application to remain reliably connected to a server to receive +messages. -When you connect to your server with an app that requires push notifications, -it will use this module to set up a "push registration". When you receive -a message but your device is not connected to the server, this module will -generate a notification and send it to the push gateway operated by your -application's developers). Their gateway will then connect to your device's -OS vendor and ask them to forward the notification to your device. When your -device receives the notification, it will display it or wake up the app so it -can connect to XMPP and receive any pending messages. +In order for messaging and other apps to receive notifications, the OS +vendors run proprietary servers that their OS maintains a permanent +connection to in the background. Then they provide APIs to application +developers that allow sending notifications to specific devices via +those servers. -This protocol is described for developers in [XEP-0357: Push Notifications]. +When you connect to your server with an app that requires push +notifications, it will use this module to set up a "push registration". +When you receive a message but your device is not connected to the +server, this module will generate a notification and send it to the push +gateway operated by your application's developers). Their gateway will +then connect to your device's OS vendor and ask them to forward the +notification to your device. When your device receives the notification, +it will display it or wake up the app so it can connect to XMPP and +receive any pending messages. -For this module to work reliably, you must have [mod_smacks], [mod_mam] and -[mod_carbons] also enabled on your server. +This protocol is described for developers in \[XEP-0357: Push +Notifications\]. + +For this module to work reliably, you must have \[mod_smacks\], +\[mod_mam\] and \[mod_carbons\] also enabled on your server. -Some clients, notably Siskin and Snikket iOS need some additional extensions -that are not currently defined in a standard XEP. To support these clients, -see [mod_cloud_notify_extensions]. +Some clients, notably Siskin and Snikket iOS need some additional +extensions that are not currently defined in a standard XEP. To support +these clients, see \[mod_cloud_notify_extensions\]. -Configuration -============= +# Configuration - Option Default Description - ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- - `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty - `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled - `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) - `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) - `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended. - `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended. + Option Default Description + -------------------------------------- ---------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty + `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled + `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) + `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) + `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended. + `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended. -(\*) There are privacy implications for enabling these options. +(\*) There are privacy implications for enabling these options.[^1] -Internal design notes -===================== +# Internal design notes -App servers are notified about offline messages, messages stored by [mod_mam] -or messages waiting in the smacks queue. -The business rules outlined [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) are all honored[^2]. +App servers are notified about offline messages, messages stored by +\[mod_mam\] or messages waiting in the smacks queue. The business rules +outlined +[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) +are all honored[^2]. -To cooperate with [mod_smacks] this module consumes some events: -`smacks-ack-delayed`, `smacks-hibernation-start` and `smacks-hibernation-end`. -These events allow this module to send out notifications for messages received -while the session is hibernated by [mod_smacks] or even when smacks -acknowledgements for messages are delayed by a certain amount of seconds -configurable with the [mod_smacks] setting `smacks_max_ack_delay`. +To cooperate with \[mod_smacks\] this module consumes some events: +`smacks-ack-delayed`, `smacks-hibernation-start` and +`smacks-hibernation-end`. These events allow this module to send out +notifications for messages received while the session is hibernated by +\[mod_smacks\] or even when smacks acknowledgements for messages are +delayed by a certain amount of seconds configurable with the +\[mod_smacks\] setting `smacks_max_ack_delay`. -The `smacks_max_ack_delay` setting allows to send out notifications to clients -which aren't already in smacks hibernation state (because the read timeout or -connection close didn't already happen) but also aren't responding to acknowledgement -request in a timely manner. This setting thus allows conversations to be smoother -under such circumstances. +The `smacks_max_ack_delay` setting allows to send out notifications to +clients which aren't already in smacks hibernation state (because the +read timeout or connection close didn't already happen) but also aren't +responding to acknowledgement request in a timely manner. This setting +thus allows conversations to be smoother under such circumstances. -The new event `cloud-notify-ping` can be used by any module to send out a cloud -notification to either all registered endpoints for the given user or only the endpoints -given in the event data. +The new event `cloud-notify-ping` can be used by any module to send out +a cloud notification to either all registered endpoints for the given +user or only the endpoints given in the event data. -The config setting `push_notification_important_body` can be used to specify an alternative -body text to send to the remote pubsub node if the stanza is encrypted or has a body. -This way the real contents of the message aren't revealed to the push appserver but it -can still see that the push is important. -This is used by Chatsecure on iOS to send out high priority pushes in those cases for example. +The config setting `push_notification_important_body` can be used to +specify an alternative body text to send to the remote pubsub node if +the stanza is encrypted or has a body. This way the real contents of the +message aren't revealed to the push appserver but it can still see that +the push is important. This is used by Chatsecure on iOS to send out +high priority pushes in those cases for example. -Compatibility -============= - -**Note:** This module should be used with Lua 5.2 and higher. Using it with -Lua 5.1 may cause push notifications to not be sent to some clients. +# Compatibility ------- ----------------------------------------------------------------------------- - trunk Works - 0.12 Works - 0.11 Works - 0.10 Works - 0.9 Support dropped, use last supported version [675726ab06d3](//hg.prosody.im/prosody-modules/raw-file/675726ab06d3/mod_cloud_notify/mod_cloud_notify.lua) ------- ----------------------------------------------------------------------------- +**Note:** This module should be used with Lua 5.2 and higher. Using it +with Lua 5.1 may cause push notifications to not be sent to some +clients. + ------- ----------------------------------------------------------------- + trunk Works as of 25-06-13 + 13 Works + 0.12 Works + ------- ----------------------------------------------------------------- -[^1]: The service which is expected to forward notifications to something like Google Cloud Messaging or Apple Notification Service -[^2]: [business_rules.markdown](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.markdown) +[^1]: The service which is expected to forward notifications to + something like Google Cloud Messaging or Apple Notification Service + +[^2]: [business_rules.md](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.md)
author Menel <menel@snikket.de>
date Fri, 13 Jun 2025 10:36:52 +0200
parent 6203:131b8bfbefb4
line wrap: on
line source

{
  "action": "reviewed",
  "number": 3591,
  "pull_request": {
    "id": 289137,
    "url": "https://codeberg.org/poezio/slixmpp/pulls/3591",
    "number": 3591,
    "user": {
      "id": 102461,
      "login": "mathieui",
      "login_name": "",
      "source_id": 0,
      "full_name": "",
      "email": "mathieui@noreply.codeberg.org",
      "avatar_url": "https://codeberg.org/avatars/921cd14ed81b453b5eab40840af709a256e4fcb2d0c19ff47a7a33948978c3c4",
      "html_url": "https://codeberg.org/mathieui",
      "language": "",
      "is_admin": false,
      "last_login": "0001-01-01T00:00:00Z",
      "created": "2023-06-17T14:34:13Z",
      "restricted": false,
      "active": false,
      "prohibit_login": false,
      "location": "",
      "pronouns": "",
      "website": "",
      "description": "",
      "visibility": "public",
      "followers_count": 1,
      "following_count": 0,
      "starred_repos_count": 1,
      "username": "mathieui"
    },
    "title": "XEP-0410: add support",
    "body": "This commit introduces an automated monitoring of MUC presence based on\r\nXEP-0410. An invisible background job is tasked with pinging inactive\r\nMUCs.",
    "labels": [],
    "milestone": null,
    "assignee": null,
    "assignees": null,
    "requested_reviewers": [
      {
        "id": 64076,
        "login": "nicoco",
        "login_name": "",
        "source_id": 0,
        "full_name": "",
        "email": "nicoco@noreply.codeberg.org",
        "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
        "html_url": "https://codeberg.org/nicoco",
        "language": "",
        "is_admin": false,
        "last_login": "0001-01-01T00:00:00Z",
        "created": "2022-09-12T11:13:13Z",
        "restricted": false,
        "active": false,
        "prohibit_login": false,
        "location": "Nice, France",
        "pronouns": "",
        "website": "https://nicoco.fr",
        "description": "wannabe-hacker",
        "visibility": "public",
        "followers_count": 2,
        "following_count": 0,
        "starred_repos_count": 4,
        "username": "nicoco"
      }
    ],
    "requested_reviewers_teams": null,
    "state": "open",
    "draft": false,
    "is_locked": false,
    "comments": 0,
    "review_comments": 1,
    "additions": 407,
    "deletions": 0,
    "changed_files": 7,
    "html_url": "https://codeberg.org/poezio/slixmpp/pulls/3591",
    "diff_url": "https://codeberg.org/poezio/slixmpp/pulls/3591.diff",
    "patch_url": "https://codeberg.org/poezio/slixmpp/pulls/3591.patch",
    "mergeable": true,
    "merged": false,
    "merged_at": null,
    "merge_commit_sha": null,
    "merged_by": null,
    "allow_maintainer_edit": false,
    "base": {
      "label": "master",
      "ref": "master",
      "sha": "e344947180bbfd667ac572176727f799349815db",
      "repo_id": 123634,
      "repo": {
        "id": 123634,
        "owner": {
          "id": 102463,
          "login": "poezio",
          "login_name": "",
          "source_id": 0,
          "full_name": "",
          "email": "",
          "avatar_url": "https://codeberg.org/avatars/b9b08e0933aaa3579fb616166718292652ae8b70457e50de3a46c1e412f99631",
          "html_url": "https://codeberg.org/poezio",
          "language": "",
          "is_admin": false,
          "last_login": "0001-01-01T00:00:00Z",
          "created": "2023-06-17T14:35:46Z",
          "restricted": false,
          "active": false,
          "prohibit_login": false,
          "location": "cyberspace",
          "pronouns": "",
          "website": "",
          "description": "Organization for poezio \u0026 slixmpp",
          "visibility": "public",
          "followers_count": 3,
          "following_count": 0,
          "starred_repos_count": 0,
          "username": "poezio"
        },
        "name": "slixmpp",
        "full_name": "poezio/slixmpp",
        "description": "Modern python XMPP library using asyncio.",
        "empty": false,
        "private": false,
        "fork": false,
        "template": false,
        "parent": null,
        "mirror": false,
        "size": 12914,
        "language": "",
        "languages_url": "https://codeberg.org/api/v1/repos/poezio/slixmpp/languages",
        "html_url": "https://codeberg.org/poezio/slixmpp",
        "url": "https://codeberg.org/api/v1/repos/poezio/slixmpp",
        "link": "",
        "ssh_url": "git@codeberg.org:poezio/slixmpp.git",
        "clone_url": "https://codeberg.org/poezio/slixmpp.git",
        "original_url": "https://lab.louiz.org/poezio/slixmpp",
        "website": "",
        "stars_count": 14,
        "forks_count": 9,
        "watchers_count": 6,
        "open_issues_count": 51,
        "open_pr_counter": 12,
        "release_counter": 10,
        "default_branch": "master",
        "archived": false,
        "created_at": "2023-07-06T09:10:25Z",
        "updated_at": "2025-02-13T22:17:56Z",
        "archived_at": "1970-01-01T00:00:00Z",
        "permissions": {
          "admin": true,
          "push": true,
          "pull": true
        },
        "has_issues": true,
        "internal_tracker": {
          "enable_time_tracker": true,
          "allow_only_contributors_to_track_time": true,
          "enable_issue_dependencies": true
        },
        "has_wiki": true,
        "wiki_branch": "master",
        "globally_editable_wiki": false,
        "has_pull_requests": true,
        "has_projects": true,
        "has_releases": true,
        "has_packages": true,
        "has_actions": false,
        "ignore_whitespace_conflicts": false,
        "allow_merge_commits": true,
        "allow_rebase": true,
        "allow_rebase_explicit": true,
        "allow_squash_merge": true,
        "allow_fast_forward_only_merge": false,
        "allow_rebase_update": true,
        "default_delete_branch_after_merge": false,
        "default_merge_style": "merge",
        "default_allow_maintainer_edit": false,
        "default_update_style": "merge",
        "avatar_url": "",
        "internal": false,
        "mirror_interval": "",
        "object_format_name": "sha1",
        "mirror_updated": "0001-01-01T00:00:00Z",
        "repo_transfer": null,
        "topics": [
          "python",
          "library",
          "xmpp",
          "jabber",
          "asyncio"
        ]
      }
    },
    "head": {
      "label": "add-xep-0410",
      "ref": "add-xep-0410",
      "sha": "d768dfdc4b2f52570adfd0cdfc5480eafd5b258b",
      "repo_id": 123634,
      "repo": {
        "id": 123634,
        "owner": {
          "id": 102463,
          "login": "poezio",
          "login_name": "",
          "source_id": 0,
          "full_name": "",
          "email": "",
          "avatar_url": "https://codeberg.org/avatars/b9b08e0933aaa3579fb616166718292652ae8b70457e50de3a46c1e412f99631",
          "html_url": "https://codeberg.org/poezio",
          "language": "",
          "is_admin": false,
          "last_login": "0001-01-01T00:00:00Z",
          "created": "2023-06-17T14:35:46Z",
          "restricted": false,
          "active": false,
          "prohibit_login": false,
          "location": "cyberspace",
          "pronouns": "",
          "website": "",
          "description": "Organization for poezio \u0026 slixmpp",
          "visibility": "public",
          "followers_count": 3,
          "following_count": 0,
          "starred_repos_count": 0,
          "username": "poezio"
        },
        "name": "slixmpp",
        "full_name": "poezio/slixmpp",
        "description": "Modern python XMPP library using asyncio.",
        "empty": false,
        "private": false,
        "fork": false,
        "template": false,
        "parent": null,
        "mirror": false,
        "size": 12914,
        "language": "",
        "languages_url": "https://codeberg.org/api/v1/repos/poezio/slixmpp/languages",
        "html_url": "https://codeberg.org/poezio/slixmpp",
        "url": "https://codeberg.org/api/v1/repos/poezio/slixmpp",
        "link": "",
        "ssh_url": "git@codeberg.org:poezio/slixmpp.git",
        "clone_url": "https://codeberg.org/poezio/slixmpp.git",
        "original_url": "https://lab.louiz.org/poezio/slixmpp",
        "website": "",
        "stars_count": 14,
        "forks_count": 9,
        "watchers_count": 6,
        "open_issues_count": 51,
        "open_pr_counter": 12,
        "release_counter": 10,
        "default_branch": "master",
        "archived": false,
        "created_at": "2023-07-06T09:10:25Z",
        "updated_at": "2025-02-13T22:17:56Z",
        "archived_at": "1970-01-01T00:00:00Z",
        "permissions": {
          "admin": true,
          "push": true,
          "pull": true
        },
        "has_issues": true,
        "internal_tracker": {
          "enable_time_tracker": true,
          "allow_only_contributors_to_track_time": true,
          "enable_issue_dependencies": true
        },
        "has_wiki": true,
        "wiki_branch": "master",
        "globally_editable_wiki": false,
        "has_pull_requests": true,
        "has_projects": true,
        "has_releases": true,
        "has_packages": true,
        "has_actions": false,
        "ignore_whitespace_conflicts": false,
        "allow_merge_commits": true,
        "allow_rebase": true,
        "allow_rebase_explicit": true,
        "allow_squash_merge": true,
        "allow_fast_forward_only_merge": false,
        "allow_rebase_update": true,
        "default_delete_branch_after_merge": false,
        "default_merge_style": "merge",
        "default_allow_maintainer_edit": false,
        "default_update_style": "merge",
        "avatar_url": "",
        "internal": false,
        "mirror_interval": "",
        "object_format_name": "sha1",
        "mirror_updated": "0001-01-01T00:00:00Z",
        "repo_transfer": null,
        "topics": [
          "python",
          "library",
          "xmpp",
          "jabber",
          "asyncio"
        ]
      }
    },
    "merge_base": "e344947180bbfd667ac572176727f799349815db",
    "due_date": null,
    "created_at": "2025-02-13T22:18:10Z",
    "updated_at": "2025-02-14T16:33:20Z",
    "closed_at": null,
    "pin_order": 0
  },
  "requested_reviewer": {
    "id": 64076,
    "login": "nicoco",
    "login_name": "",
    "source_id": 0,
    "full_name": "",
    "email": "nicoco@noreply.codeberg.org",
    "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
    "html_url": "https://codeberg.org/nicoco",
    "language": "",
    "is_admin": false,
    "last_login": "0001-01-01T00:00:00Z",
    "created": "2022-09-12T11:13:13Z",
    "restricted": false,
    "active": false,
    "prohibit_login": false,
    "location": "Nice, France",
    "pronouns": "",
    "website": "https://nicoco.fr",
    "description": "wannabe-hacker",
    "visibility": "public",
    "followers_count": 2,
    "following_count": 0,
    "starred_repos_count": 4,
    "username": "nicoco"
  },
  "repository": {
    "id": 123634,
    "owner": {
      "id": 102463,
      "login": "poezio",
      "login_name": "",
      "source_id": 0,
      "full_name": "",
      "email": "",
      "avatar_url": "https://codeberg.org/avatars/b9b08e0933aaa3579fb616166718292652ae8b70457e50de3a46c1e412f99631",
      "html_url": "https://codeberg.org/poezio",
      "language": "",
      "is_admin": false,
      "last_login": "0001-01-01T00:00:00Z",
      "created": "2023-06-17T14:35:46Z",
      "restricted": false,
      "active": false,
      "prohibit_login": false,
      "location": "cyberspace",
      "pronouns": "",
      "website": "",
      "description": "Organization for poezio \u0026 slixmpp",
      "visibility": "public",
      "followers_count": 3,
      "following_count": 0,
      "starred_repos_count": 0,
      "username": "poezio"
    },
    "name": "slixmpp",
    "full_name": "poezio/slixmpp",
    "description": "Modern python XMPP library using asyncio.",
    "empty": false,
    "private": false,
    "fork": false,
    "template": false,
    "parent": null,
    "mirror": false,
    "size": 12914,
    "language": "",
    "languages_url": "https://codeberg.org/api/v1/repos/poezio/slixmpp/languages",
    "html_url": "https://codeberg.org/poezio/slixmpp",
    "url": "https://codeberg.org/api/v1/repos/poezio/slixmpp",
    "link": "",
    "ssh_url": "git@codeberg.org:poezio/slixmpp.git",
    "clone_url": "https://codeberg.org/poezio/slixmpp.git",
    "original_url": "https://lab.louiz.org/poezio/slixmpp",
    "website": "",
    "stars_count": 14,
    "forks_count": 9,
    "watchers_count": 6,
    "open_issues_count": 51,
    "open_pr_counter": 12,
    "release_counter": 10,
    "default_branch": "master",
    "archived": false,
    "created_at": "2023-07-06T09:10:25Z",
    "updated_at": "2025-02-13T22:17:56Z",
    "archived_at": "1970-01-01T00:00:00Z",
    "permissions": {
      "admin": true,
      "push": true,
      "pull": true
    },
    "has_issues": true,
    "internal_tracker": {
      "enable_time_tracker": true,
      "allow_only_contributors_to_track_time": true,
      "enable_issue_dependencies": true
    },
    "has_wiki": true,
    "wiki_branch": "master",
    "globally_editable_wiki": false,
    "has_pull_requests": true,
    "has_projects": true,
    "has_releases": true,
    "has_packages": true,
    "has_actions": false,
    "ignore_whitespace_conflicts": false,
    "allow_merge_commits": true,
    "allow_rebase": true,
    "allow_rebase_explicit": true,
    "allow_squash_merge": true,
    "allow_fast_forward_only_merge": false,
    "allow_rebase_update": true,
    "default_delete_branch_after_merge": false,
    "default_merge_style": "merge",
    "default_allow_maintainer_edit": false,
    "default_update_style": "merge",
    "avatar_url": "",
    "internal": false,
    "mirror_interval": "",
    "object_format_name": "sha1",
    "mirror_updated": "0001-01-01T00:00:00Z",
    "repo_transfer": null,
    "topics": [
      "python",
      "library",
      "xmpp",
      "jabber",
      "asyncio"
    ]
  },
  "sender": {
    "id": 64076,
    "login": "nicoco",
    "login_name": "",
    "source_id": 0,
    "full_name": "",
    "email": "nicoco@noreply.codeberg.org",
    "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
    "html_url": "https://codeberg.org/nicoco",
    "language": "",
    "is_admin": false,
    "last_login": "0001-01-01T00:00:00Z",
    "created": "2022-09-12T11:13:13Z",
    "restricted": false,
    "active": false,
    "prohibit_login": false,
    "location": "Nice, France",
    "pronouns": "",
    "website": "https://nicoco.fr",
    "description": "wannabe-hacker",
    "visibility": "public",
    "followers_count": 2,
    "following_count": 0,
    "starred_repos_count": 4,
    "username": "nicoco"
  },
  "commit_id": "",
  "review": {
    "type": "pull_request_review_rejected",
    "content": "I spotted one typo, that review was not completely useless, YEAH!\r\n\r\nYou mentioned oob that you'd like more integration tests, maybe that plugin is a good candidate for them? Testing silent kick is probably near-impossible without a custom muc component, but the \"you're still joined\" path looks like it would be doable?"
  }
}