iwla/plugins/display/feeds.py

# -*- coding: utf-8 -*-
#
# Copyright Grégory Soutadé 2015

# This file is part of iwla

# iwla is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# iwla is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with iwla.  If not, see <http://www.gnu.org/licenses/>.
#

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

"""
Display hook

Display feeds parsers

Plugin requirements :
    post_analysis/feeds

Conf values needed :
    create_all_feeds_page*

Output files :
    OUTPUT_ROOT/year/month/index.html
    OUTPUT_ROOT/year/month/all_feeds.html

Statistics creation :
    None

Statistics update :
    None

Statistics deletion :
    None
"""

class IWLADisplayFeeds(IPlugin):
    def __init__(self, iwla):
        super(IWLADisplayFeeds, self).__init__(iwla)
        self.API_VERSION = 1
        self.requires = ['IWLAPostAnalysisFeeds']

    def load(self):
        self.create_all_feeds_page = self.iwla.getConfValue('create_all_feeds_page', True)

        return True

    def hook(self):
        from plugins.post_analysis.feeds import IWLAPostAnalysisFeeds

        display = self.iwla.getDisplay()
        hits = self.iwla.getCurrentVisits()
        nb_feeds_parsers = 0

        # All in a page
        if self.create_all_feeds_page:
            title = createCurTitle(self.iwla, self.iwla._(u'All Feeds parsers'))
            filename = 'all_feeds.html'
            path = self.iwla.getCurDisplayPath(filename)
            display_visitor_ip = self.iwla.getConfValue('display_visitor_ip', False)

            page = display.createPage(title, path, self.iwla.getConfValue('css_path', []))
            table = display.createBlock(DisplayHTMLBlockTable, self.iwla._(u'All feeds parsers'), [self.iwla._(u'Host'), self.iwla._(u'Pages'), self.iwla._(u'Hits')])
            table.setColsCSSClass(['', 'iwla_page', 'iwla_hit'])
            for super_hit in hits.values():
                if not super_hit['feed_parser']: continue
                nb_feeds_parsers += 1
                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'])
                if super_hit['feed_parser'] == IWLAPostAnalysisFeeds.MERGED_FEED_PARSER:
                    address += '*'
                if super_hit['robot']:
                    table.appendRow([address, super_hit['not_viewed_pages'], super_hit['not_viewed_hits']])
                else:
                    table.appendRow([address, super_hit['viewed_pages'], super_hit['viewed_hits']])
            page.appendBlock(table)
            note = DisplayHTMLRaw(self.iwla, ('<small>*%s</small>' % (self.iwla._(u'Merged feeds parsers'))))
            page.appendBlock(note)
            display.addPage(page)

        # Found in index
        title = self.iwla._(u'Feeds parsers')
        if self.create_all_feeds_page:
            link = '<a href=\'%s\'>%s</a>' % (filename, self.iwla._(u'Details'))
            title = '%s - %s' % (title, link)

        index = self.iwla.getDisplayIndex()
        
        table = display.createBlock(DisplayHTMLBlockTable, title, [self.iwla._(u'Found')])
        table.appendRow([nb_feeds_parsers])
        index.appendBlock(table)