meetingLocalConfig.py configuration

This is the non-supybot method of configuration, and allows the most flexibility. It works for configuring supybot, too, but requires shell access and a MeetBot reload to change.

Configuration is done by creating a file meetingLocalConfig.py in the plugin directory, or somewhere in your PYTHONPATH. It works by (automatically, not user-visible) subclassing the Config class.

Here is a minimal usage example. You need at least this much to make it run. Put this in meetingLocalConfig.py before you first start supybot:

class Config(object):
    # These two are **required**:
    logFileDir = '/home/richard/meetbot/'
    logUrlPrefix = 'http://rkd.zgib.net/meetbot/'

Two other more commonly used options are:

filenamePattern = '%(channel)s/%%Y/%(channel)s.%%F-%%H.%%M'
MeetBotInfoURL = 'http://some_other_side.tld'

Place all of the configuration variables inside of the class body like this.

meetingLocalConfig.py is imported via python, so all the usual benefits and caveats of that apply. It causes a subclass of the main Config object. Thus, you can do some advanced (or just crazy) things like add a new meeting command, meeting agenda item type, or more. Some of these ideas are documented under the "Advanced configuration" section below.

To reload a configuration in a running supybot, you can just reload the plugin in supybot --- the module is reloaded. Specifically, /msg YourBotName reload MeetBot.

Supybot-based config

This is the system that configures MeetBot based on the supybot registry system. Thus, it can be adjusted by anyone with the proper supybot capabilities. However, the configuration in the supybot registry won't be used if the replay functionality is used (see above). Thus, for example, if you configure the MediaWiki writer using supybot.plugins.MeetBot.writer_map, and then replay the meeting, the MediaWiki output will not be updated.

To enable this system, first the supybot.plugins.MeetBot.enableSupybotBasedConfig variable must be set to True. Then the MeetBot plugin must be reloaded:

/msg YourBot config supybot.plugins.MeetBot.enableSupybotBasedConfig True
/msg YourBot reload MeetBot

Now you can list the values available for configuration (the list below may not be up to date):

/msg YourBot config list supybot.plugins.MeetBot
----> #endMeetingMessage, #filenamePattern, #input_codec,
      #logFileDir, #logUrlPrefix, #MeetBotInfoURL, #output_codec,
      #pygmentizeStyle, #specialChannelFilenamePattern,
      #startMeetingMessage, #timeZone, #usefulCommands,
      enableSupybotBasedConfig, and public

Setting a value for a variable:

/msg YourBot config supybot.plugins.MeetBot.logUrlPrefix http://meetings.yoursite.net/

Most variables (those with # prepended) can be set on a per-channel basis (they are set up as channel-specific variables).

At present, not all variables are exported to supybot. All string and boolean variables are, as well certain other variables for which a wrapper has been written (writer_map in particular). If a variable doesn't appear in the supybot registry, it can't be set via the registry.

If you want to disable supybot-based config for security reasons, set dontBotConfig to True in your custom configuration class in meetingLocalConfig.py.

Required or important configuration

These variables are set either in meetingLocalConfig.py (in the Config class) or in the supybot registry.

logFileDir

The filesystem directory in which the meeting outputs are stored, defaulting to ".". Required.

logUrlPrefix

The URL corresponding to logFileDir. This is prepended to filenames when giving end-of-meeting links in the channel. Required or supybot's URLs will be missing.

filenamePattern

This defaults to '%(channel)s/%%Y/%(channel)s.%%F-%%H.%%M', and is the pattern used for replacements to identify the name of the file basename (including possible sub-directories) in which to store the meeting output files. This is the suffix to logFileDir and logUrlPrefix.

Variables available for replacement using %(name)s include: channel, network, meetingname. Double percent signs (e.g.: %%Y are time formats, from time.strftime.

You should not include filename extensions here. Those are found from the writers, via the variable writer_map.

Putting these all together, a set of variables could be:

1. logFileDir  =  /srv/www/meetings/
2. %(channel)s/%%Y/%(channel)s.%%F-%%H.%%M
3. (.html, .txt, etc, extensions come from writers_map)

MeetBotInfoURL

This is a URL given in beginning and ending messages and minutes files as a "go here for more information" link.

writer_map configuration

writer_map tells how we want to output the results of the meeting. It is, as you can guess, a mapping from filename extensions (.html, .log.html, ...) to what we want to output to that file (writers.HTML, writers.HTMLlog, ...)

Using meetingLocalConfig.py, it is python dictionary listing what output formats will be used to write our final results to a file, along with extensions to use. For example, in meetingLocalConfig.py:

import writers

class Config:
    writer_map = {
        '.log.html':writers.HTMLlog,
        '.html': writers.HTML,
        '.txt': writers.RST,
        '.mw':writers.MediaWiki,
        }

If an extension begins in .none the output will not be written to a file. Note that you can't have the same extension multiple times due to the way python dictionaries work: use .none1, .none2, etc.

This can be configured through supybot. To do this, set supybot.plugins.MeetBot.writer_map to a space-separated list of WriterName:.extension pairs (note the different ordering from the python dictionary). For example, to list the current setting (in private message with the bot):

<MrBeige> config plugins.MeetBot.writer_map
<MeetBot> HTML2:.html MediaWiki:.mw HTMLlog2:.log.html Text:.txt

And to set it (again, in private message with the bot):

<MrBeige> config plugins.MeetBot.writer_map HTML2:.html MediaWiki:.mw HTMLlog2:.log.html Text:.txt

There is a special way to pass arguments to writers. Learn by example:

writer_map = {
    '.mw|mwsite=http://site.net|mwpath=Meetings':writers.MediaWiki,
}

or via supybot:

config plugins.MeetBot.writer_map MediaWiki:.mw|mwsite=http://site.net|mwpath=Meetings

The available writers are (with default extensions, if enabled by default):

TextLog (.log.txt)

Plain-text logs suitable for replaying. This does not have to be explicitly enabled listed-- it is automatically enabled whenever it is needed (currently, only when a meeting comes realtime from supybot, not when being replayed)

HTMLlog (.log.html)

Alias for the current default HTML-pretty logs output format, currently HTMLlog2.

HTMLlog2

Writes the logs in a HTML-pretty, CSS-customizable way (see section below).

HTML (.html)

Alias for the current default HTML output format for the meeting notes, currently HTML2.

HTML2

Meeting notes, in a numbered list HTML output format. Configurable via CSS (see section below).

Text (.txt)

A meeting notes format, as a plain text file

MediaWiki

MediaWiki output.

The MediaWiki writer has the ability to upload to a MediaWiki site directly. You use the custom variables mwsite: site name to upload to, mwpath: subpage to upload to (final location is %(mwpath)/%(file_basename)), ``mwusername and mwpassword: username and password to log in as.

An upload is attempted if mwsite is given. A login is attempted if mwusername is given. An example configuration:

writer_map = {
    '.mw|mwsite=http://site.net|mwpath=Meetings':writers.MediaWiki,
    }

PmWiki

PmWiki output. This doesn't upload to a PmWiki instance, but that could be added later.

Template

This writer allows a user-defined template to used to output the meeting logs. This allows complete control of the output by embedding special tags into templates. This writer depends on the Genshi templating engine. For information on how the templating engine works, please see its website or the example templates provided.

To use the templating engine, you must specify the template file to use. This is done via a special argument syntax. Instead of an file extension name, the extension should be specified as .EXTENSION_NAME|template=TEMPLATE_FILE, with the metavariables explaining what the parts do. For example, in meetingLocalConfig.py one would do:

class Config:
    writer_map = {
        ...
        '.tmpl.txt|template=+template.txt' = writers.Template,
        }

When setting a template writer by the suybot registry, one would do:

/msg YourBot config plugins.MeetBot.writer_map <other writers> Template:.EXTENSION_NAME|template=TEMPLATE_FILE ...

TEMPLATE_FILE is an absolute or relative filename. As a special case, +TEMPLATE_NAME can be used to specify a path relative to the MeetBot source directory. This is used to include the default templates: +template.html or +template.txt .

Obsolete writers are:

HTMLlog1

Old HTML writer. This one requires the Python module pygments to be installed. HTMLlog2 was written to remove this dependency. HTMLlog2 is just as pretty as this is, and HTMLlog2 is configurable via CSS.

HTML1

Old, table-based HTML writer.

ReST

ReStructured Text output. Since ReStructured Text is a bit strict in it's parser, user input from the IRC meeting will often mess up the conversion, and thus this isn't recommended for true use until better escape functions can be written. (There is no security risk from this plugin, ReST is run in secure mode).

HTMLfromReST

This runs the ReStructured Text writer, and uses docutils to convert it to HTML. This requires the docutils package of Python to be installed.

Other config variables

These variables are set either in meetingLocalConfig.py (in the Config class) or in the supybot registry.

RestrictPerm

An int listing which permissions to remove when using the #restrictlogs command. It is best to use the python stat module to set it:

RestrictPerm = stat.S_IRWXO|stat.S_IRWXG

specialChannels and specialChannelFilenamePattern

When you are doing MeetBot testing, you would rather not have nonstop different filenames each time you do a test meeting. If a channel is in specialChannels, it will use specialChannelFilenamePattern instead of filenamePattern when storing logs. specialChannels is a tuple listing channel names. Example: the defaults are ("#meetbot-test", "#meetbot-test2") and '%(channel)s/%(channel)s' (note that there is no time-dependence in the name).

UrlProtocols

Tuple of protocols to use to automatically detect link. Example: the default tuple is ('http:', 'https:', 'irc:', 'ftp:', 'mailto:', 'ssh:').

command_RE

How commands are detected. See code.

pygmentizeStyle

Style for the Pygments module to use to colorize the IRC logs. The default is "friendly".

timeZone

Timezone used in the bot. Note: This will not yet work on a per-channel basis. The default is "UTC"

update_realtime

If this is set to true (default false), then upon each line being input, the Text writer will rewrite the data. This means that people joining the meeting late can catch up on what they have missed. It doesn't play will with the #meetingname command, since the filename would then change during the meeting, and it doesn't delete the old filename(s).

startMeetingMessage

endMeetingMessage

Message printed at the beginning/end of the meetings. Some %(name)s replacements are available: chair, starttime, timeZone, endtime, MeetBotInfoURL, urlBasename.

input_codec

output_codec

Input and output character set encodings.

writer_map

See the description in the section above.

cssFile_minutes and cssFile_log

If given, this is a file containing CSS for the .html and .log.html outputs (HTML2 and HTMLlog2 writers). Embedding control is described below.

If this value is the null string or 'default', then the default CSS is used (see css-*-default.css in the MeetBot distribution). If this value is 'none', then no stylesheet information is written whatsoever.

Note that for when embedded (see below), cssFile should be a filesystem path readable locally. When you are not embedding, cssFile should be the URL to the stylesheet, and this value given is included literally to the output.

cssEmbed_minutes and cssEmbed_log

If these are True, then the contents of cssFile (above) are read and embedded into the HTML document. If these are False, then a stylesheet link is written.

Advanced configuration

This gives a few examples of things you can do via meetingLocalConfig.py. Most people probably won't need these things, and they aren't thoroughly explained here.

You can make a per-channel config:

class Config(object):
    def init_hook(self):
        if self.M.channel == '#some-channel':
            self.logFileDir = '/some/directory'
        else:
            self.logFileDir = '/some/other/directory'

Make a per-channel writer_map (note that you shouldn't change writer_map in place):

import writers
class Config(object):
    def init_hook(self):
        if self.M.channel == '#some-channel':
            self.writer_map = self.writer_map.copy()
            self.writer_map['.mw'] = writers.MediaWiki

The display styles (in html writers) can be modified also, by using the starthtml and endhtml attributes (put this in meetingLocalConfig.py:

import items
items.Agreed.starthtml = '<font color="red">'
items.Agreed.endhtml = '</font>'

Adding a new custom command via meetingLocalConfig.py. (This likely won't make sense unless you examine the code a bit and know esoteric things about python method types):

import types
class Config(object):
    def init(self):
        def do_party(self, nick, time_, **kwargs):
            self.reply("We're having a party in this code!")
            self.reply(("Owner, Chairs: %s %s"%(
                                 self.owner,sorted(self.chairs.keys()))))
        self.M.do_party = types.MethodType(
                                       do_party, self.M, self.M.__class__)

Make a command alias. Make #weagree an alias for #agreed:

class Config(object):
    def init(self):
        self.M.do_weagree = self.M.do_agreed