iwla/plugins/display/referers.py

import time
import gettext as g

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

#
# Display hook
# 
# Create Referers page
#
# Plugin requirements :
#     post_analysis/referers
#
# Conf values needed :
#     max_referers_displayed*
#     create_all_referers_page*
#     max_key_phrases_displayed*
#     create_all_key_phrases_page*
#
# Output files :
#     OUTPUT_ROOT/year/month/referers.html
#     OUTPUT_ROOT/year/month/key_phrases.html
#     OUTPUT_ROOT/year/month/index.html
#
# Statistics creation :
#     None
#
# Statistics update :
#     None
#
# Statistics deletion :
#     None
#

class IWLADisplayReferers(IPlugin):
    def __init__(self, iwla):
        super(IWLADisplayReferers, self).__init__(iwla)
        self.API_VERSION = 1
        self.requires = ['IWLAPostAnalysisReferers']
        self.max_referers = self.iwla.getConfValue('max_referers_displayed', 0)
        self.create_all_referers = self.iwla.getConfValue('create_all_referers_page', True)
        self.max_key_phrases = self.iwla.getConfValue('max_key_phrases_displayed', 0)
        self.create_all_key_phrases = self.iwla.getConfValue('create_all_key_phrases_page', True)

    def hook(self):
        display = self.iwla.getDisplay()
        month_stats = self.iwla.getMonthStats()
        referers = month_stats.get('referers', {})
        robots_referers = month_stats.get('robots_referers', {})
        search_engine_referers = month_stats.get('search_engine_referers', {})
        key_phrases = month_stats.get('key_phrases', {})

        top_referers = [(k, referers[k]['pages']) for k in referers.keys()]
        top_referers = sorted(top_referers, key=lambda t: t[1], reverse=True)

        top_robots_referers = [(k, robots_referers[k]['pages']) for k in robots_referers.keys()]
        top_robots_referers = sorted(top_robots_referers, key=lambda t: t[1], reverse=True)

        top_search_engine_referers = [(k, search_engine_referers[k]['pages']) for k in search_engine_referers.keys()]
        top_search_engine_referers = sorted(top_search_engine_referers, key=lambda t: t[1], reverse=True)

        top_key_phrases = key_phrases.items()
        top_key_phrases = sorted(top_key_phrases, key=lambda t: t[1], reverse=True)

        cur_time = self.iwla.getCurTime()
        index = self.iwla.getDisplayIndex()

        # All referers in a file
        if self.create_all_referers:
            title = time.strftime(g.gettext('Connexion from') + ' - %B %Y', cur_time)

            filename = 'referers.html'
            path = self.iwla.getCurDisplayPath(filename)

            page = display.createPage(title, path, self.iwla.getConfValue('css_path', []))
            table = display.createBlock(DisplayHTMLBlockTable, g.gettext('Connexion from'), [g.gettext('Origin'), g.gettext('Pages'), g.gettext('Hits')])
            table.setColsCSSClass(['', 'iwla_page', 'iwla_hit'])

            total_search = [0]*3
            table.appendRow(['<b>%s</b>' % (g.gettext('Search Engine')), '', ''])
            new_list = self.max_referers and top_search_engine_referers[:self.max_referers] or top_search_engine_referers
            for r,_ in new_list:
                row = [r, search_engine_referers[r]['pages'], search_engine_referers[r]['hits']]
                total_search[1] += search_engine_referers[r]['pages']
                total_search[2] += search_engine_referers[r]['hits']
                table.appendRow(row)

            total_external = [0]*3
            table.appendRow(['<b>%s</b>' % (g.gettext('External URL')), '', ''])
            new_list = self.max_referers and top_referers[:self.max_referers] or top_referers
            for r,_ in new_list:
                row = [generateHTMLLink(r), referers[r]['pages'], referers[r]['hits']]
                total_external[1] += referers[r]['pages']
                total_external[2] += referers[r]['hits']
                table.appendRow(row)

            total_robot = [0]*3
            table.appendRow(['<b>%s</b>' % (g.gettext('External URL (robot)')), '', ''])
            new_list = self.max_referers and top_robots_referers[:self.max_referers] or top_robots_referers
            for r,_ in new_list:
                row = [generateHTMLLink(r), robots_referers[r]['pages'], robots_referers[r]['hits']]
                total_robot[1] += robots_referers[r]['pages']
                total_robot[2] += robots_referers[r]['hits']
                table.appendRow(row)

            page.appendBlock(table)

            display.addPage(page)

        title = g.gettext('Top Referers')
        if self.create_all_referers:
            link = '<a href=\'%s\'>%s</a>' % (filename, g.gettext('All Referers'))
            title = '%s - %s' % (title, link)

        # Top referers in index
        table = display.createBlock(DisplayHTMLBlockTable, title, [g.gettext('Origin'), g.gettext('Pages'), g.gettext('Hits')])
        table.setColsCSSClass(['', 'iwla_page', 'iwla_hit'])

        table.appendRow(['<b>%s</b>' % (g.gettext('Search Engine')), '', ''])
        for r,_ in top_search_engine_referers[:10]:
            row = [r, search_engine_referers[r]['pages'], search_engine_referers[r]['hits']]
            total_search[1] -= search_engine_referers[r]['pages']
            total_search[2] -= search_engine_referers[r]['hits']
            table.appendRow(row)
        if total_search[1] or total_search[2]:
            total_search[0] = g.gettext('Others')
            table.appendRow(total_search)
            table.setCellCSSClass(table.getNbRows()-1, 0, 'iwla_others')

        table.appendRow(['<b>%s</b>' % (g.gettext('External URL')), '', ''])
        for r,_ in top_referers[:10]:
            row = [generateHTMLLink(r), referers[r]['pages'], referers[r]['hits']]
            total_external[1] -= referers[r]['pages']
            total_external[2] -= referers[r]['hits']            
            table.appendRow(row)
        if total_external[1] or total_external[2]:
            total_external[0] = g.gettext('Others')
            table.appendRow(total_external)
            table.setCellCSSClass(table.getNbRows()-1, 0, 'iwla_others')

        table.appendRow(['<b>%s</b>' % (g.gettext('External URL (robot)')), '', ''])
        for r,_ in top_robots_referers[:10]:
            row = [generateHTMLLink(r), robots_referers[r]['pages'], robots_referers[r]['hits']]
            total_robot[1] -= robots_referers[r]['pages']
            total_robot[2] -= robots_referers[r]['hits']
            table.appendRow(row)
        if total_robot[1] or total_robot[2]:
            total_robot[0] = g.gettext('Others')
            table.appendRow(total_robot)
            table.setCellCSSClass(table.getNbRows()-1, 0, 'iwla_others')

        index.appendBlock(table)

        # All key phrases in a file
        if self.create_all_key_phrases:
            title = time.strftime(g.gettext('Key Phrases') + ' - %B %Y', cur_time)

            filename = 'key_phrases.html'
            path = self.iwla.getCurDisplayPath(filename)

            total_search = [0]*2
            page = display.createPage(title, path, self.iwla.getConfValue('css_path', []))
            table = display.createBlock(DisplayHTMLBlockTable, g.gettext('Top key phrases'), [g.gettext('Key phrase'), g.gettext('Search')])
            table.setColsCSSClass(['', 'iwla_search'])
            new_list = self.max_key_phrases and top_key_phrases[:self.max_key_phrases] or top_key_phrases
            for phrase in new_list:
                table.appendRow([phrase[0], phrase[1]])
                total_search[1] += phrase[1]
            page.appendBlock(table)

            display.addPage(page)

        title = g.gettext('Top key phrases')
        if self.create_all_key_phrases:
            link = '<a href=\'%s\'>%s</a>' % (filename, g.gettext('All key phrases'))
            title = '%s - %s' % (title, link)

        # Top key phrases in index
        table = display.createBlock(DisplayHTMLBlockTable, title, [g.gettext('Key phrase'), g.gettext('Search')])
        table.setColsCSSClass(['', 'iwla_search'])
        for phrase in top_key_phrases[:10]:
            table.appendRow([phrase[0], phrase[1]])
            total_search[1] -= phrase[1]
        if total_search[1]:
            total_search[0] = g.gettext('Others')
            table.appendRow(total_search)
            table.setCellCSSClass(table.getNbRows()-1, 0, 'iwla_others')
        index.appendBlock(table)