= IRC Logs Plugin = == Description == Display logs of an IRC channel in trac == Bugs/Feature Requests == Existing bugs and feature requests for IrcLogsPlugin are [query:status!=closed&component=IrcLogsPlugin&order=priority here]. If you have any issues, create a [/newticket?component=IrcLogsPlugin&owner=pacopablo new ticket]. == Download and Source == Download the [download:irclogsplugin zipped source], check out [/svn/irclogsplugin using Subversion], or [source:irclogsplugin browse the source] with Trac. == Installation == Run "easy_install http://trac-hacks.org/svn/irclogsplugin/0.10/" for 0.10.4 trac installations (not supported) Run "easy_install http://trac-hacks.org/svn/irclogsplugin/0.11/" for 0.11+ trac installations Run "easy_install http://trac-hacks.org/svn/irclogsplugin/parsing_refactor/" for cutting edge beta version (0.11+ trac) The IrcLogsPlugin 0.11 depends on the http://swapoff.org/wiki/pyndexter python indexer. The beta version doesn't require pyndexter, but it will be needed for search capability. (It is installed automatically by easy_install) == Configuration 0.11 == In your trac.ini file add these: Under [Components], add: {{{ irclogs.irclogsplugin = enabled }}} Under [irclogs], add: {{{ path = /path/to/log/file/ChannelLogger indexer = builtin:///var/www/trac/indexer/irclogs.idx?cache=true prefix = #roomname }}} For 0.11 add this to [irclogs]: {{{ path = /path/to/log/file/ChannelLogger indexer = builtin:///var/www/trac/indexer/irclogs.idx?cache=true file_format = #roomname.%Y%m%d.log navigation_button = irclogs }}} This module was written assuming the use of [http://supybot.com/ supybot] logs. You will need to configure your supybot to output in the correct format (these are not the default for supybot): {{{ config supybot.log.timestampformat %Y-%m-%d %H:%M:%S | config supybot.plugins.channellogger true config supybot.plugins.channellogger.directories false config supybot.plugins.channellogger.filenametimestamp %Y%m%d config supybot.plugins.channellogger.rotatelogs true }}} The 0.11 version of the plugin expects a different `timestampformat`: {{{ config supybot.log.timestampformat %Y-%m-%dT%H:%M:%S }}} To (re)index your log files, use this [attachment:"indexer.py" pydexter indexing python script]. Be sure to edit the two variables for file locations in the script. '''Note:''' In order to enable indexing for 0.11, you'll currently need a patch, see comment:ticket:1183:6. == Wiki Macros 0.11 == === Quote === Show conversation excerpts from IRC logs: {{{ [[IrcLogQuote(UTC2008-02-11T18:03:27,5)]] }}} This macro takes two arguments: a UTC date formatted to ''UTCYYYY-MM-DDTHH:MM:SS'', and (optional) the number of lines to display relative to the first message. === Trac Links === Link to an IRC conversation: {{{ [irclog:UTC2008-02-11T18:03:27 View this conversation] }}} === "Live" Log === Show a "live" AJAX log display. '''Note:''' This macro should be used sparingly; it should not be on the front page of a project in most cases. {{{ [[IrcLogLive]] }}} This macro optionally takes two arguments: the first argument is the polling frequency in seconds (default is 60), the second argument is the number of lines to display (default is 10). {{{ [[IrcLogLive(60,10)]] }}} == Recent Changes == [[ChangeLog(irclogsplugin, 3)]] == Author/Contributors == '''Maintainer:''' [wiki:doki_pen][[br]] '''Author:''' [wiki:mitsuhiko] [[BR]] '''Contributors:''' [wiki:pacopablo] == Comments == {{{ [23:42] Someone know the IRCLogs plugin ? [23:43] (and have some info about it... nothing interresting on the wiki page...) Should the log be available before processing ? or Does the plugin connect to some channels ? [23:43] Rica|Coding: it just renders logs [23:43] specifically supy bot logs [23:44] ^^ok [23:44] you'll need a bot to creat the logs before the plugin is sueful }}}