IRC Collective software contains a parser, with a modular architecture that makes it flexible in the way it can process input...
Version: 0.1.4IRC Collective software contains a parser, with a modular architecture that makes it flexible in the way it can process input and handle output. The output of the parser is primarily used to add to an SQL database that can in turn be queried by, e.g., a Web application (also provided).
Operating System: Linux
The parser can be extended by defining new input formats and output handlers. It can help you stay up to date on the IRC channels that you visit regularly. You can write your own applications on top of the SQL database. You can search past conversations using the Web interface (results will be paged).
1.2. Installing Perl modules
Most perl modules can be installed from CPAN directly using the CPAN shell.
(walkthrough using CPAN shell...)
2. Installing the parser
If you haven't already, download the latest stable from the irc collective
Unpack the archive:
tar xvzf irc-collective-0.1.0.tar.gz
This will create a new directory called 'irc-collective'.
Change dir into this directory and continue with the next section.
2.1. Configuration file
Create a new configuration file, alternatively you can use the default one
as a reference.
You must enter the name of the channel, the location of the logfiles and the
If you want to use the SQL outputhandler module you must also enter the
hostname or IP address of the database server, the type of database (mysql),
the name of the database and the username and password.
2.2. Adding the parser to the system scheduler
On most linux installation you can schedule a command using cron.
Create a crontab.user file in your home directory, where user is your
username. Open the file in an editor and add a line similar to the one below:
10 * * * * * $HOME/collective/parselog
If you created a new configuration file, use the --with-config directive:
10 * * * * * $HOME/collective/parselog --with-config=your.conf
On windows you can accomplish the same result by using the 'at'
command, see 'at /?' for more information.
3. Installing the database
At the time of writing only MySQL is supported. For the following
instructions you can use your favorite MySQL client, although this
manual will use the standard CLI (command line interface).
3.1. Creating the database
Connect to the database server using an account that can create new databases:
$ mysql -u username -p
This will enter the mysql CLI:
MySQL version etc...
Now create the database:
mysql> create database name_of_database;
Type quit to leave the CLI:
3.2. Creating the tables
The tables are defined in the file called create.sql inside the ./db
$ mysql -u username -p database_name < db/create.sql
4. Installing the web application
The web application has been implemented as a CGI application. The scripts
are written in Perl and make extensive use of the CGI.pm module.
Note: In the future it is likely that the web application will be rewritten
using mod_perl instead of CGI.pm.
4.1. Copying scripts
Copy the scripts to a directory inside the cgi-bin, like so:
cp -R cgi-bin/* /var/www/localhost/cgi-bin/collective
4.2. Chaning configuration file
Edit the configuration file and enter the settings needed.
What's New in This Release:
Â· This release adds paging of log files and search results. Links displayed are now hyperlinked, and contents displayed from log files are now HTML encoded to prevent tags from being parsed by the user's browser.
Â· This release adds --yesterday and --today for easier automated parsing using utilities like cron.