prosody-modules
13070c6a7ce8
mod_http_muc_log/README.markdown
Software / code / prosody-modules
File
mod_http_muc_log/README.markdown @ 4930:13070c6a7ce8
mod_http_muc_log: Fix exception on lack of trailing slash in room path
A request to /room leads to the match call returning nil which in turn
calls nodeprep(nil). In Prosody 0.11.x this does nothing and simply
returns the nil, while in 0.12 it is an error.
Now it redirects to the calendar view at /room/ - even for non-existant
rooms.
Discovered at a deployment with http_paths = { muc_log = "/" } and
requests to /robots.txt and similar, which now result in a uses redirect
before returning 404.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 22 Apr 2022 14:29:32 +0200 |
| parent | 4677:823370bc2e4c |
| child | 4970:8c7b7db69f5b |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Provides a web interface to stored chatroom logs rockspec: build: copy_directories: - res ... Introduction ============ This module provides a built-in web interface to view chatroom logs stored by [mod\_mam\_muc]. Installation ============ Same as any other module, be sure to include the HTML template `http_muc_log.html` alongside `mod_http_muc_log.lua`. Configuration ============= For example: ``` lua Component "conference.example.com" "muc" modules_enabled = { "mam_muc"; "http_muc_log"; } storage = { muc_log = "sql"; -- for example } ``` The web interface would then be reachable at the address: http://conference.example.com:5280/muc_log/ See [the page about Prosodys HTTP server][doc:http] for info about the address. ## Styling The default HTML template lives in `http_muc_log.html` in the same directory as the module, but can be changed by setting `http_muc_log_template` to point to a different file. The same template, with different input is used for every view. The module uses [util.interpolation][doc:developers:util:interpolation] for rendering templates, with the pattern `"%b{}"` and HTML / XML escaping enabled. ## Default view To link to the latest day instead of calendar from the room listing page: ```lua http_muc_log_default_view = "latest" ``` ## Inline images Inline images can optionally be shown. This is disabled by default for privacy reasons. ``` {.lua} http_muc_log_show_images = true ``` ## Calendar optimization The calendar view relies on an optional part of the Prosody archive storage API that provides a list of every valid date. If this is unavailable then the module queries for the first and the last messages and assumes that every date between those is valid. This may lead to many empty pages in case the logs are sparse. This optimization can be turned off, to get a more accurate calendar view, but it will likely be very slow. ``` {.lua} http_muc_log_lazy_calendar = false ``` ## Pinned chatrooms The room list page is normally sorted by address, rooms having a description before those that don't. To override this, or pin certain rooms to the top: ``` lua http_muc_log_list_order = { "general@channels.example.com", "support@channels.example.com", } ``` Compatibility ============= Requires Prosody 0.10 or above and a storage backend with support for stanza archives. See [mod\_storage\_muc\_log] for using legacy data from [mod\_muc\_log].
