Software / code / prosody-modules
File
mod_storage_ldap/mod_storage_ldap.lua @ 6302:06fbbd45ba75
mod_cloud_notify: Readme: fix links and labels that were removed in the last commit
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,3 +1,9 @@
+----
+-labels:
+-- 'Stage-Beta'
+-summary: 'XEP-0357: Cloud push notifications'
+----
+
# Introduction
This module enables support for sending "push notifications" to clients
@@ -32,15 +38,15 @@ notification to your device. When your d
it will display it or wake up the app so it can connect to XMPP and
receive any pending messages.
-This protocol is described for developers in \[XEP-0357: Push
-Notifications\].
+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.
+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\].
+these clients, see [mod_cloud_notify_extensions].
# Configuration
@@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex
# 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
+[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:
+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
+[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`.
+[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
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:44:37 +0200 |
| parent | 2299:e099586f9de5 |
line wrap: on
line source
-- vim:sts=4 sw=4 -- Prosody IM -- Copyright (C) 2008-2010 Matthew Wild -- Copyright (C) 2008-2010 Waqas Hussain -- Copyright (C) 2012 Rob Hoelz -- -- This project is MIT/X11 licensed. Please see the -- COPYING file in the source package for more information. -- ---------------------------------------- -- Constants and such -- ---------------------------------------- local setmetatable = setmetatable; local ldap = module:require 'ldap'; local vcardlib = module:require 'ldap/vcard'; local st = require 'util.stanza'; local gettime = require 'socket'.gettime; if not ldap then return; end local CACHE_EXPIRY = 300; local params = module:get_option('ldap'); ---------------------------------------- -- Utility Functions -- ---------------------------------------- local function ldap_record_to_vcard(record) return vcardlib.create { record = record, format = params.vcard_format, } end local get_alias_for_user; do local user_cache; local last_fetch_time; local function populate_user_cache() local ld = ldap.getconnection(); local usernamefield = params.user.usernamefield; local namefield = params.user.namefield; user_cache = {}; for _, attrs in ld:search { base = params.user.basedn, scope = 'onelevel', filter = params.user.filter } do user_cache[attrs[usernamefield]] = attrs[namefield]; end last_fetch_time = gettime(); end function get_alias_for_user(user) if last_fetch_time and last_fetch_time + CACHE_EXPIRY < gettime() then user_cache = nil; end if not user_cache then populate_user_cache(); end return user_cache[user]; end end ---------------------------------------- -- General Setup -- ---------------------------------------- local ldap_store = {}; ldap_store.__index = ldap_store; local adapters = { roster = {}, vcard = {}, } for k, v in pairs(adapters) do setmetatable(v, ldap_store); v.__index = v; v.name = k; end function ldap_store:get(username) return nil, "get method unimplemented on store '" .. tostring(self.name) .. "'" end function ldap_store:set(username, data) return nil, "LDAP storage is currently read-only"; end ---------------------------------------- -- Roster Storage Implementation -- ---------------------------------------- function adapters.roster:get(username) local ld = ldap.getconnection(); local contacts = {}; local memberfield = params.groups.memberfield; local namefield = params.groups.namefield; local filter = memberfield .. '=' .. tostring(username); local groups = {}; for _, config in ipairs(params.groups) do groups[ config[namefield] ] = config.name; end -- XXX this kind of relies on the way we do groups at INOC for _, attrs in ld:search { base = params.groups.basedn, scope = 'onelevel', filter = filter } do if groups[ attrs[namefield] ] then local members = attrs[memberfield]; for _, user in ipairs(members) do if user ~= username then local jid = user .. '@' .. module.host; local record = contacts[jid]; if not record then record = { subscription = 'both', groups = {}, name = get_alias_for_user(user), }; contacts[jid] = record; end record.groups[ groups[ attrs[namefield] ] ] = true; end end end end return contacts; end ---------------------------------------- -- vCard Storage Implementation -- ---------------------------------------- function adapters.vcard:get(username) if not params.vcard_format then return nil, ''; end local ld = ldap.getconnection(); local filter = params.user.usernamefield .. '=' .. tostring(username); local match = ldap.singlematch { base = params.user.basedn, filter = filter, }; if match then match.jid = username .. '@' .. module.host return st.preserialize(ldap_record_to_vcard(match)); else return nil, 'not found'; end end ---------------------------------------- -- Driver Definition -- ---------------------------------------- local driver = {}; function driver:open(store, typ) local adapter = adapters[store]; if adapter and typ == nil or typ == "keyval" then return adapter; end return nil, "unsupported-store"; end module:provides("storage", driver);