annotate mod_muclogging.wiki @ 55:4604930cc085

mod_muclogging initial wiki
author t.ephraim
date Fri, 16 Oct 2009 21:46:37 +0000
parents
children 1dd6406d8fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
55
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
1 #summary Module which logs muc conversations to a file
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
2 #labels Stage-Alpha
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
3
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
4 = Introduction =
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
5
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
6 This module logs the conversation of muc running on this server to a daily changing file.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
7 There is a file per room.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
8
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
9 = Details =
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
10
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
11 To enable it, you will need to configure a logFolder at the muc component, which should log.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
12 e.g.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
13 {{{
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
14 Component "rooms.example.com" "muc"
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
15 logFolder = "/var/log/prosody/rooms"
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
16 }}}
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
17
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
18 In this folder will then created files in form of YearMonthDay_RoomJid.log
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
19 e.g.:
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
20 {{{
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
21 091015_foobar@rooms.example.com.log
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
22 }}}
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
23
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
24 The content of the logfile are the presence and message stanza's which depend to this room.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
25 They are wrapped around by a <stanza> tag with an additional time attribute.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
26 That should make it possible to create nice output in every way.
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
27 e.g.:
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
28 {{{
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
29 <stanza time="23:41:14"><message type='groupchat' from='foobar@rooms.example.com/ephraim' id='aae4a' xmlns='jabber:client'>
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
30 <body>test</body>
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
31 <nick xmlns='http://jabber.org/protocol/nick'>Ephraim</nick>
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
32 </message></stanza>
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
33 }}}
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
34
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
35 = TODO =
4604930cc085 mod_muclogging initial wiki
t.ephraim
parents:
diff changeset
36 * create a simple php script to format the log so the output is more human readable