Start big comments (post analysis / referers)

plugins/post_analysis/referers.py

@@ -6,6 +6,32 @@ from iplugin import IPlugin
 
 import awstats_data
 
+#
+# Post analysis hook
+# 
+# Extract referers and key phrases from requests
+#
+# Plugin requirements : None
+#
+# Conf values needed :
+#     page_to_hit_conf*
+#     hit_to_page_conf*
+#
+# Output files :
+#     None
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+# visits :
+#    remote_addr =>
+#        robot
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLAPostAnalysisReferers(IPlugin):
     def __init__(self, iwla):
         super(IWLAPostAnalysisReferers, self).__init__(iwla)

plugins/pre_analysis/page_to_hit.py

@@ -3,7 +3,30 @@ import re
 from iwla import IWLA
 from iplugin import IPlugin
 
-# Basic rule to detect robots
+#
+# Pre analysis hook
+# Change page into hit and hit into page into statistics
+#
+# Plugin requirements : None
+#
+# Conf values needed :
+#     page_to_hit_conf*
+#     hit_to_page_conf*
+#
+# Output files :
+#     None
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+# visits :
+#    remote_addr =>
+#        is_page
+#
+# Statistics deletion :
+#     None
+#
 
 class IWLAPreAnalysisPageToHit(IPlugin):
 

plugins/pre_analysis/robots.py

@@ -5,6 +5,32 @@ from iplugin import IPlugin
 
 import awstats_data
 
+#
+# Pre analysis hook
+# 
+# Filter robots
+#
+# Plugin requirements : None
+#
+# Conf values needed :
+#     page_to_hit_conf*
+#     hit_to_page_conf*
+#
+# Output files :
+#     None
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+# visits :
+#    remote_addr =>
+#        robot
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLAPreAnalysisRobots(IPlugin):
     def __init__(self, iwla):
         super(IWLAPreAnalysisRobots, self).__init__(iwla)