iwla/plugins/display/top_visitors.py

import time

from iwla import IWLA
from iplugin import IPlugin
from display import *

#
# Display hook
# 
# Create TOP visitors block
#
# Plugin requirements :
#     None
#
# Conf values needed :
#     display_visitor_ip*
#
# Output files :
#     OUTPUT_ROOT/year/month/index.html
#
# Statistics creation :
#     None
#
# Statistics update :
#     None
#
# Statistics deletion :
#     None
#
class IWLADisplayTopVisitors(IPlugin):
    def __init__(self, iwla):
        super(IWLADisplayTopVisitors, self).__init__(iwla)
        self.API_VERSION = 1

    def hook(self):
        hits = self.iwla.getValidVisitors()
        display = self.iwla.getDisplay()
        display_visitor_ip = self.iwla.getConfValue('display_visitor_ip', False)

        total = [0]*5
        for super_hit in hits.values():
            total[1] += super_hit['viewed_pages']
            total[2] += super_hit['viewed_hits']
            total[3] += super_hit['bandwidth']

        top_bandwidth = [(k,v['bandwidth']) for (k,v) in hits.items()]
        top_bandwidth = sorted(top_bandwidth, key=lambda t: t[1], reverse=True)
        top_visitors = [hits[h[0]] for h in top_bandwidth[:10]]

        index = self.iwla.getDisplayIndex()
        table = display.createBlock(DisplayHTMLBlockTable, 'Top visitors', ['Host', 'Pages', 'Hits', 'Bandwidth', 'Last seen'])
        table.setColsCSSClass(['', 'iwla_page', 'iwla_hit', 'iwla_bandwidth', ''])
        for super_hit in top_visitors:
            address = super_hit['remote_addr']
            if display_visitor_ip and\
                    super_hit.get('dns_name_replaced', False):
                address = '%s [%s]' % (address, super_hit['remote_ip'])

            row = [
                address,
                super_hit['viewed_pages'],
                super_hit['viewed_hits'],
                bytesToStr(super_hit['bandwidth']),
                time.asctime(super_hit['last_access'])
                ]
            total[1] -= super_hit['viewed_pages']
            total[2] -= super_hit['viewed_hits']
            total[3] -= super_hit['bandwidth']
            table.appendRow(row)
        if total[1] or total[2] or total[3]:
            total[0] = 'Others'
            total[3] = bytesToStr(total[3])
            total[4] = ''
            table.appendRow(total)
            table.setCellCSSClass(table.getNbRows()-1, 0, 'iwla_others')
        index.appendBlock(table)