Quassel IRC

h1. Quassel Logging

{{toc}}

Quassel saves all logs into the database, it never forgets backlogs unless you delete a buffer. You can either scroll back in chat windows as far as you like, or you can use a tool to dump or view the logs in plaintext format. You can of course perform database queries against your database manually, but this is annoying and possibly impractical (if you are using a shared core and don't have access to the database). This page lists a handful of tools that can allow you to view your logs. It is current as of 2017.

None of these tools are maintained by the quassel maintainers, but are maintained by active community members. The authors' IRC usernames (for #quassel in chat.freenode.net) are listed in each section. For bugs, feature requests, etc. either contact the authors on IRC or use the linked github pages.

h2. quasselgrep Tools

quasselgrep is a command line for searching quassel logs. It supports both SQLite and PostgreSQL and can be run on a local database or in client-server mode. quasselgrep can run as a server on the same machine running your quassel core, sitting on top of your database. Then users can use quasselgrep in client mode to connect to h3. dumplog

this server and access their logs remotely.

quasselgrep is written tool (written in Python and is available on github here, along with documentation: https://github.com/fish-face/quasselgrep. It is written by Fish-Face.

h2. quassel-rest-search

quassel-rest-search is a web application for searching Python) dumps quassel logs. It provides both a HTTP API and a web application.

quassel-rest-search is a PHP and JavaScript application available on github here: https://github.com/justjanne/quassel-rest-search. It is written by justJanne.

h2. dumplog

dumplog is an older tool for dumping logs to the command line. (Unlike quasselgrep, a file. Currently it cannot be used to search-- exports mIRC format.
You can get it simply dumps logs). The original version only supported SQLite databases, but a newer version now supports PostgreSQL. The new version may *not* support SQLite without some tinkering, so both are provided here. at

The original version is available as an attachment here, and was written by Gentle.

> attachment:dumplog-0.0.1.tar.gz

The newer version it is available on github here: https://github.com/rikai/Quassel-DumpLog-Mirror. It was written by rikai. rather self-explanatory, telling you if something went wrong. you can run it with

Some documentation for the original version follows:

Default *default database path (ok for most unixes): unixes)*
<pre>python dumplog.py -u username -n network -c "#channel" -o channel.log</pre>

Custom *custom database path (Windows etc.): etc.)*
<pre>python dumplog.py -d "C:\Quassel\quassel-storage.sqlite"</pre>

Examples:

**Examples:**
>*show users in quasseldb*
><pre>python dumplog.py</pre>
>
>*show networks for quassel user john*
><pre>python dumplog.py -u john</pre>
>
>*show channels for network Freenode for user john*
><pre>python dumplog.py -u john -n Freenode</pre>
>
>*dump channel #quassel on network Freenode for user john to file quassel.log*
><pre>python dumplog.py -u john -n Freenode -c "#quassel" -o quassel.log</pre>

There are apparently some *Limitations / Known Issues*
nasty charset conversion issues, and takes place, gonna be fixed soon
topics are will only be properly parsed properly with English logs. logs, need to talk with Sput/EgS about that ;P
dumplog currently only handles sqlite databases, for postgres support, a somewhat hacky but working script is available at "this github mirror":https://github.com/rikai/Quassel-DumpLog-Mirror

h1. Legacy Tools *Note*
this tool is not maintained by quassel staff, contact Gentle on Freenode for bugs or feature requests

We recommend you _don't_ use these and instead use one of the above.

h2. h3. quasselsuche

*WARNING: WARNING: there are security vulnerabilities in quasselsuche, we strongly recommend not using it. If you want a web interface instead, please look at quassel-rest-search above.*



A webbased Quassel-Search-Engine for Quassel IRC

!quassel_backlog_search.png!

*Download*
Snapshots and git version tracker can be found here: http://m4yer.minad.de/quassel/

*Note*
this tool is not maintained by quassel staff, contact m4yer on Freenode for bugs or feature requests

h3. Windows - Portable quasselsuche

This is the same quasselsuche as above, pre-packaged for Windows with a web server ("mongoose":https://github.com/valenok/mongoose) and php. Just "extract":http://7-zip.org and *run start-search-server.bat*. No install required and no traces are left outside the extracted directory. Further info and instructions are available at readme.txt in that package.

* Note - If you don't know your username/password, run show-password.bat

*Download*
Current version is 1.1 (updated 2012-08-19): "portable-quassel-backlog-search-v1.1.7z":http://share.minad.de/mtUC.1.7z

* Note - The above package is 9 MB since it includes php. If you already have a local copy of php (zipped package for windows), you can download a smaller package (180 KB) to which you would need to extract php yourself: "portable-quassel-backlog-search-v1.1-NO-PHP.7z":http://share.minad.de/1phm.1-no-php.7z

*Note*
this tool is not maintained by quassel staff, contact Avi Halachmi (avih on Freenode) for bugs or feature requests

h2. h3. Quasselsearch

*quasselsearch only supports sqlite databases; tools that support command line searches both are available above, like quasselgrep.*

With this bash script you can search your quassel database from the command line and get the output as a csv file/right in your terminal. You can get the script at "Github":https://github.com/karan42/quasselsearch

Requirements: Gnu awk, sqlite3 backend
How to use: Add yourself to the group "quasselcore" and then just run the script normally by doing "./quasselsearch <options>"

The available options are :
Usage : quasselsearch.sh (n|c|t|e|s|o|q|d|f)
-n nick
-c channel
-t start date in the format "YYYY-MM-DD HH:MM:SS"
-e end date in the same format as above
-s search term
-o output file
-q quassel user defaults to $USER
-d quassel database location , defaults to /var/lib/quassel/quassel-storage.sqlite
-f Change the time format, all formats that are accepted by the "date" command are allowed.

All the arguments are optional. Although if you run it without any arguments you would print out your whole backlog from all buffers.

Example:

><pre>./quasselsearch.sh -n karan -c #quassel -t 2015-04-20 -e 2015-04-30 -o logs.txt -s quasseldroid </pre>

*Note*
this tool is not maintained by quassel staff, use the github page for bugs or feature requests

*Note*
Since the tool uses sql to extract stuff, it could possibly work on postgresql cores too, if you do give it a try please inform me at karan 90 at g mail.c om (no spaces) so i can update the code. Thanks.