Mercurial > prosody-modules
comparison mod_export_skeletons/README.md @ 4815:9c2af2146ee2
mod_export_skeletons: Command to aid in analysis of archive contents
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Thu, 09 Dec 2021 23:48:25 +0100 |
| parents | |
| children | e7d1d68f0279 |
comparison
equal
deleted
inserted
replaced
| 4814:5f12c75fd210 | 4815:9c2af2146ee2 |
|---|---|
| 1 --- | |
| 2 summary: Export message archives in sanitized minimal form for analysis | |
| 3 --- | |
| 4 | |
| 5 Exports message archives in a format stripped from private information | |
| 6 and message content. | |
| 7 | |
| 8 # Usage | |
| 9 | |
| 10 prosodyctl mod_export_skeletons [options] user@host* | |
| 11 | |
| 12 Multiple user JIDs can be given. | |
| 13 | |
| 14 Some storage drivers such as [SQL][doc:modules:mod_storage_sql] allows | |
| 15 exporting all users at once by giving the special username `*`, i.e. | |
| 16 `prosodyctl mod_export_skeletons \*@example.com`. | |
| 17 | |
| 18 `--start=timestamp` | |
| 19 : Start of time span to export in [XEP-0082] format | |
| 20 | |
| 21 `--end=timestamp` | |
| 22 : End of time span to export in [XEP-0082] format | |
| 23 | |
| 24 # Output | |
| 25 | |
| 26 All content is stripped, leaving only the basic XML structure, with | |
| 27 child tags sorted. | |
| 28 | |
| 29 Top level attributes are given special treatment since they carry | |
| 30 protocol semantics. Notably the `@to` and `@from` JIDs are replaced by | |
| 31 symbolic labels to convey what form (bare, full or host) they had. The | |
| 32 `@id` attribute is replaced with a string of the same length. | |
| 33 | |
| 34 ## Example | |
| 35 | |
| 36 ```xml | |
| 37 <message from='full' id='xxxxxxxxxxxxxxxx' type='chat' to='bare'><body/><x xmlns='jabber:x:oob'><url/></x></message> | |
| 38 <message from='bare' id='xxxxxxxxxxxxxxxx' type='error' to='full'><error><remote-server-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/><text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/></error></message> | |
| 39 <message from='full' id='xxxxxxxxxxxxxxxx' type='chat' to='bare'><body/><x xmlns='jabber:x:oob'><url/></x></message> | |
| 40 <message from='full' id='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' type='normal' to='bare'><x xmlns='jabber:x:conference'/></message> | |
| 41 ``` |