Mercurial > prosody-modules
annotate mod_pubsub_stats/mod_pubsub_stats.lua @ 6261:1c62edeb9147
mod_pastebin: Update Readme
diff --git a/mod_pastebin/README.md b/mod_pastebin/README.md
--- a/mod_pastebin/README.md
+++ b/mod_pastebin/README.md
@@ -37,12 +37,14 @@ For example:
Pastes will be available by default at
`http://<your-prosody>:5280/pastebin/` by default.
-In Prosody 0.9 and later this can be changed with [HTTP
-settings](https://prosody.im/doc/http).
+Ports and path can be changed with [HTTP
+settings](https://prosody.im/doc/http), for example like:
-In 0.8 and older this can be changed with `pastebin_ports` (see below),
-or you can forward another external URL from your web server to Prosody,
-use `pastebin_url` to set that URL.
+``` {.lua}
+ http_paths = {
+ pastebin = "/$host-paste";
+ }
+```
# Discovery
@@ -82,27 +84,16 @@ The line and character tresholds are adv
pastebin_line_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
pastebin_trigger A string of characters (e.g. "!paste ") which if detected at the start of a message, always sends the message to the pastebin, regardless of length. (default: not set)
pastebin_expire_after Number of hours after which to expire (remove) a paste, defaults to 24. Set to 0 to store pastes permanently on disk.
- pastebin_ports List of ports to run the HTTP server on, same format as mod_httpserver's http_ports[^1]
- pastebin_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
# Compatibility
- ------ -------
- trunk Works
+ ------ ---------------------
+ trunk Works as of 25-06-13
+ 13 Works
0.12 Works
- 0.11 Works
- 0.10 Works
- 0.9 Works
- 0.8 Works
- ------ -------
+ ------ ---------------------
# Todo
- Maximum paste length
- Web interface to submit pastes?
-
-[^1]: As of Prosody 0.9, `pastebin_ports` is replaced by `http_ports`,
- see [Prosody HTTP server documentation](https://prosody.im/doc/http)
-
-[^2]: See also
- [http_external_url](https://prosody.im/doc/http#external_url)
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 11:39:58 +0200 |
| parents | b2ce818ec19c |
| children |
| rev | line source |
|---|---|
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 local st = require "util.stanza"; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 local pubsub = module:depends"pubsub"; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 local actor = module.host .. "/modules/" .. module.name; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 |
|
3160
330e8c81f6af
mod_pubsub_stats: Include namespace on pubsub items (fixes use with trunk)
Kim Alvefur <zash@zash.se>
parents:
3157
diff
changeset
|
7 local pubsub_xmlns = "http://jabber.org/protocol/pubsub" |
|
330e8c81f6af
mod_pubsub_stats: Include namespace on pubsub items (fixes use with trunk)
Kim Alvefur <zash@zash.se>
parents:
3157
diff
changeset
|
8 |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
9 local node = module:get_option_string(module.name .. "_node", "stats"); |
|
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
10 |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 local function publish_stats(stats, stats_extra) |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 local id = "current"; |
|
3160
330e8c81f6af
mod_pubsub_stats: Include namespace on pubsub items (fixes use with trunk)
Kim Alvefur <zash@zash.se>
parents:
3157
diff
changeset
|
13 local xitem = st.stanza("item", { xmlns = pubsub_xmlns, id = id }) |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 :tag("query", { xmlns = "http://jabber.org/protocol/stats" }); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 for name, value in pairs(stats) do |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 local stat_extra = stats_extra[name]; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 local unit = stat_extra and stat_extra.units; |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 xitem:tag("stat", { name = name, unit = unit, value = tostring(value) }):up(); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
22 local ok, err = pubsub.service:publish(node, actor, id, xitem); |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 if not ok then |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 module:log("error", "Error publishing stats: %s", err); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 function module.load() |
|
3175
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
29 pubsub.service:create(node, true, { |
|
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
30 persistent_items = false; |
|
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
31 max_items = 1; |
|
44c5d7310c33
mod_pubsub_stats: Pass configuration to disable persistence and limit number of items
Kim Alvefur <zash@zash.se>
parents:
3160
diff
changeset
|
32 }); |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
33 pubsub.service:set_affiliation(node, true, actor, "publisher"); |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 end |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 module:hook_global("stats-updated", function (event) |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 publish_stats(event.stats, event.stats_extra); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
38 end); |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 |
|
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 function module.unload() |
|
3068
380f92276e57
mod_pubsub_stats: Make the node used configurable
Kim Alvefur <zash@zash.se>
parents:
3067
diff
changeset
|
41 pubsub.service:delete(node, true); |
|
3067
b01ef74c9fc0
mod_pubsub_stats: Simple module that publishes stats in XEP-0039 format
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
42 end |
|
3407
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
43 |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
44 module:hook("pubsub-summary/http://jabber.org/protocol/stats", function (event) |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
45 local payload = event.payload; |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
46 local summary = {}; |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
47 for stat in payload:childtags("stat") do |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
48 if stat.attr.name and stat.attr.value then |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
49 table.insert(summary, string.format("%s: %g %s", stat.attr.name, tonumber(stat.attr.value), stat.attr.units or "")); |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
50 end |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
51 end |
| 3408 | 52 table.sort(summary); |
|
3407
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
53 return table.concat(summary, "\n"); |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
54 end); |
|
26ae3b6a8a57
mod_pubsub_stats: Generate a textual summary for notifications
Kim Alvefur <zash@zash.se>
parents:
3175
diff
changeset
|
55 |
