pimpmylog

minimal web UI for IRC logs

Overview

This is a simple viewer for IRC log. I'm coding my own, because:

• I want a minimalist UI, simple and clean look
• I want it to be simple but functional
• I want it to be written in Racket

Usage :

raco pimpmylog -h
pimpmylog [ <option> ... ] <filename>
 where <option> is one of
/ -w, --weechat : input file is in weechat log format
\ -r, --racket-org : input file is in format as files on http://racket-lang.org/irc-logs/racket/
  -n <cn>, --name <cn> : Name of the channel
  -p <p>, --port <p> : Listening port
  --help, -h : Show this help
  -- : Do not treat any remaining argument as a switch (at this level)
 /|\ Brackets indicate mutually exclusive options.
 Multiple single-letter switches can be combined after one `-'; for
  example: `-h-' is the same as `-h --'

Example :

raco pimpmylog -r -n '#racket' logs/racket-logs/racket.log

Features

• handy navigation (day, week, month, ...)
• timeline
• stupid search (a grep -i)
• a specific line in history can be shared (simply copy/paste the link to that line)
• works fine with proxy cache (tested with varnish default conf) as it sets Cache-Control HTTP header
• easy interface to support other log formats. Supported log formats :
  • #racket@freenode archives
  • weechat
• HTML5

Quick Start

Install

1. Install Racket
2. Install pimpmylog package :

   raco pkg install --deps search-auto git://github.com/fridim/pimpmylog

3. Start using it

   raco pimpmylog -h

Or build from the sources

You can produce a standalone binary :

git clone https://github.com/fridim/pimpmylog.git
cd pimpmylog
raco exe main.rkt -o pimpmylog
./pimpmylog -h

Easy update

Prerequisite : you installed pimpmylog via raco.

raco pkg update pimpmylog

This will fetch the latest version from github.

Run the demo

./tools/fetch_racket-lang.org.sh
raco pimpmylog -r -n '#racket' logs/racket.log

Configure a proxy

Varnish

The default Varnish configuration will work ; you just have to set the right host/port for the pimpmylog instance :

backend default {
     .host = "127.0.0.1";
     .port = "8000";
}

Pimpmylog sets a Cache-Control header, so caching with Varnish should work well out of the box.

Cache-Control header

The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. The directives specify behavior intended to prevent caches from adversely interfering with the request or response. These directives typically override the default caching algorithms. Cache directives are unidirectional in that the presence of a directive in a request does not imply that the same directive is to be given in the response.

In pimpmylog the Cache-Control max-age value depends on the page visited:

Page	time cached
last day	1 minute
search results	1 day
everything in the past (won't change)	forever

Nginx

location / {
  proxy_pass        http://localhost:8000;
}

Nginx can act as a proxy cache, please refer to the documentation. Here is an example :

http {
  proxy_cache_path  /data/nginx/cache  levels=1:2   keys_zone=pimpmylog:100m
                    inactive=100d      max_size=1g;

  server {
    listen       80;
    server_name  localhost;

    location / {
      proxy_pass        http://localhost:8000;
      proxy_cache       pimpmylog;
      add_header X-Cache $upstream_cache_status;
    }
  }
}

Tests

raco test .

See Rackunit.

TODO (contrib?)

• add a previous day and next day links (« & »)
• add a checkbox to enable/disable JOIN/LEAVE/...
• add a checkbox to enable RAW format
• add irssi log format
• add a converter interface to translate from one format to another
• support mobile/pad
• add a calendar to go to a specific day/week/month
• add current topic next to title
• enable multi-word search
• IDEA: support multiple files ?
• add real-time update when lastlogs are displayed
• add a « links » panel with #tag support
• display next day when there is no log for current day
• speed: create a map date/fileposition and use file-position
• make it a command line tool
• add structure for a msg
• a new log-format support should be as simple as a procedure string -> struct msg
• add structure for a msg
• find a way to put command-line in module main (in a clean way) AKA fix tests
• add color for nicknames
• add listening port as option
• log format definitions should be in a separate forlder
• highlight searched word(s) in search result
• make « 1 day » the homepage
• make the navigation bar sticky
• homepage: jump to bottom (lastlog)
• HTML5
• validate HTML and CSS
• make search case-insensitive
• fix color for date and nickname when row is highlighted
• add ajax fetch on scrolling (faster)
• create a package and use raco to install pimpmylog binary
• use lang rackjure