iwla/plugins/post_analysis/feeds.py

113 lines
3.5 KiB
Python
Raw Normal View History

2015-02-17 19:11:04 +01:00
# -*- 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/>.
#
import re
from iwla import IWLA
from iplugin import IPlugin
"""
Post analysis hook
Find feeds parsers (first hit in feeds conf value and no viewed pages if it's a robot)
If there is ony one hit per day to a feed, merge feeds parsers with the same user agent
as it must be the same person with a different IP address.
2015-02-17 19:11:04 +01:00
Plugin requirements :
None
Conf values needed :
feeds
2015-02-18 20:56:03 +01:00
merge_one_hit_only_feeds_parsers*
2015-02-17 19:11:04 +01:00
Output files :
None
Statistics creation :
remote_addr =>
feed_parser
Statistics update :
None
Statistics deletion :
None
"""
class IWLAPostAnalysisFeeds(IPlugin):
2015-02-18 20:56:03 +01:00
NOT_A_FEED_PARSER = 0
FEED_PARSER = 1
MERGED_FEED_PARSER = 2
2015-02-17 19:11:04 +01:00
def __init__(self, iwla):
super(IWLAPostAnalysisFeeds, self).__init__(iwla)
self.API_VERSION = 1
2015-02-18 20:56:03 +01:00
self.conf_requires = ['feeds']
2015-02-17 19:11:04 +01:00
def load(self):
feeds = self.iwla.getConfValue('feeds', None)
2015-02-18 20:56:03 +01:00
self.merge_one_hit_only_feeds_parsers = self.iwla.getConfValue('merge_one_hit_only_feeds_parsers', True)
2015-02-17 19:11:04 +01:00
if feeds is None: return False
self.feeds_re = []
for f in feeds:
self.feeds_re.append(re.compile(r'.*%s.*' % (f)))
return True
def mergeOneHitOnlyFeedsParsers(self, isFeedParser, one_hit_only, hit):
if isFeedParser and (hit['viewed_hits'] + hit['not_viewed_hits']) == 1:
user_agent = hit['requests'][0]['http_user_agent'].lower()
if one_hit_only.get(user_agent, None) is None:
2015-02-18 20:56:03 +01:00
# Merged
isFeedParser = self.MERGED_FEED_PARSER
one_hit_only[user_agent] = (hit)
else:
2015-02-18 20:56:03 +01:00
isFeedParser = self.NOT_A_FEED_PARSER
hit['feed_parser'] = isFeedParser
2015-02-17 19:11:04 +01:00
def hook(self):
hits = self.iwla.getCurrentVisits()
one_hit_only = {}
2015-02-17 19:11:04 +01:00
for hit in hits.values():
isFeedParser = hit.get('feed_parser', None)
2015-02-18 20:56:03 +01:00
if isFeedParser == self.FEED_PARSER and\
self.merge_one_hit_only_feeds_parsers:
2015-02-19 20:13:55 +01:00
self.mergeOneHitOnlyFeedsParsers(isFeedParser, one_hit_only, hit)
if not isFeedParser is None: continue
2015-02-18 20:56:03 +01:00
isFeedParser = self.NOT_A_FEED_PARSER
2015-02-17 19:11:04 +01:00
uri = hit['requests'][0]['extract_request']['extract_uri'].lower()
for regexp in self.feeds_re:
if regexp.match(uri):
2015-02-18 20:56:03 +01:00
isFeedParser = self.FEED_PARSER
2015-02-17 19:11:04 +01:00
# Robot that views pages -> bot
if hit['robot']:
if hit['viewed_pages']:
2015-02-18 20:56:03 +01:00
isFeedParser = self.NOT_A_FEED_PARSER
2015-02-17 19:11:04 +01:00
break
2015-02-18 20:56:03 +01:00
if self.merge_one_hit_only_feeds_parsers:
self.mergeOneHitOnlyFeedsParsers(isFeedParser, one_hit_only, hit)
else:
hit['feed_parser'] = isFeedParser