ClickSpotter 0.1.1

data/lib/GlobalSettings.rb

@@ -0,0 +1,237 @@
+#
+# GlobalSettings.rb - ClickSpotter
+#
+# Copyright (c) 2005, 2006 by Chris Schlaeger <cs@kde.org>
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# $Id: GlobalSettings.rb 13 2006-01-23 20:50:55Z cs $
+#
+
+require 'Qt'
+require 'GSServerLogSettings'
+require 'yaml'
+require 'set'
+
+class GlobalSettings
+
+  attr_accessor :browserCmd, :serverLogFiles, :currentLogFile
+  attr_reader :robotPatterns
+
+  def initialize(loadOnStartLog)
+    @logFile = nil
+    @browserCmd = 'kfmclient exec'
+    @loadOnStartLog = loadOnStartLog
+    @currentLogFile = nil
+    @serverLogFiles = []
+    @auxFileExtensions = Set.new [ ".jpg", ".gif", ".png", ".bmp", ".js",
+                                   ".css", ".ico" ]
+    @robotPatterns = [
+    { "name" => "MSB", "ip" => ".*", "browser" => "^msnbot/.*" },
+    { "name" => "Yahoo", "ip" => ".*", "browser" => ".*Yahoo\! Slurp.*" },
+    { "name" => "Google", "ip" => ".*",
+      "browser" => ".*Googlebot/.*" },
+    { "name" => "Google Image", "ip" => ".*",
+      "browser" => ".*Googlebot-Image/.*" },
+    { "name" => "ASK.com", "ip" => ".*",
+      "browser" => ".*Ask Jeeves/Teoma.*\.ask\.com" },
+    { "name" => "Rambler", "ip" => ".*",
+      "browser" => "^StackRambler/2.0 \(MSIE incompatible\).*" },
+    { "name" => "Exabot", "ip" => ".*", "browser" => "^NG/.*" },
+    { "name" => "NimbleCrawler", "ip" => ".*",
+      "browser" => ".*NimbleCrawler .* obeys UserAgent NimbleCrawler.*" },
+    { "name" => "ConveraCrawler", "ip" => ".*",
+      "browser" => "ConveraCrawler.*" },
+    { "name" => "Voyager", "ip" => ".*", "browser" => "voyager/.*" },
+    { "name" => "Omni-Explorer", "ip" => ".*",
+      "browser" => "OmniExplorer_Bot/.* WorldIndexer" },
+    { "name" => "YahooMMCrawler", "ip" => ".*",
+      "browser" => "Yahoo-MMCrawler/.*" },
+    { "name" => "Alexa Crawler", "ip" => ".*", "browser" => "ia_archiver" },
+    { "name" => "QuickFinder.*", "ip" => ".*",
+      "browser" => "QuickFinder Crawler" },
+    { "name" => "Noxtrum", "ip" => ".*", "browser" => "noxtrumbot/.*" },
+    { "name" => "Exabot", "ip" => ".*", "browser" => "Exabot/.*" },
+    { "name" => "Picsearch", "ip" => ".*", "browser" => "psbot/.*" }
+    ]
+
+    @persistentSettings = {
+      "DNSResolver" => true,
+      "Geolocator" => true,
+      "TraceRouter" => true,
+      "MainWindowW" => 0,
+      "MainWindowH" => 1,
+      "LargeMapW" => 0,
+      "LargeMapH" => 0,
+      "CurrentStatusSplitter" => [],
+      "VisitorWindowW" => 0,
+      "VisitorWindowH" => 0,
+      "PageWindowW" => 0,
+      "PageWindowH" => 0,
+      "RefererWindowW" => 0,
+      "RefererWindowH" => 0,
+      "MonitorWindow" => 10,
+      "ShowSurfers" => 1,
+      "ShowRobots" => 0,
+      "ShowRegularPages" => 1,
+      "ShowAuxPages" => 0,
+      "BrowserCommand" => "kfmclient exec",
+      "DNSCache" => {},
+      "GeoLocatorCache" => {},
+      "TraceRouterCache" => {},
+      "LogFileDataTimeout" => 24,
+      "DNSTimeout" => 7,
+      "GeolocTimeout" => 30,
+      "TracerTimeout" => 48,
+      "GeolocHost" => "api.hostip.info",
+      "GeolocPort" => 80,
+      "WMShowIPs" => false,
+      "WMShowHostNames" => false,
+      "WMShowCityNames" => false,
+      "WMShowRouters" => false,
+      "WMShowRoutes" => false,
+      "WMShowLast" => false,
+      "WMLastMinutes" => 1
+    }
+
+    @mainWindowW = 0
+    @mainWindowH = 0
+    @currentStatusSplitter = []
+
+    loadSettings()
+  end
+
+  def setSetting(name, value)
+    if !@persistentSettings.has_key?(name)
+      raise "Unknown setting #{name}"
+    end
+    vClass = @persistentSettings[name].class
+    unless ((vClass == FalseClass || vClass == TrueClass) &&
+            (value.class != FalseClass || value.class != TrueClass)) ||
+           vClass == value.class
+      raise "Bad setting type for #{name}!  " +
+            "#{@persistentSettings[name].class()} != #{value.class()}"
+    end
+    @persistentSettings[name] = value
+  end
+
+  def getSetting(name)
+    if !@persistentSettings.has_key?(name)
+      raise "Unknown setting #{name}"
+    end
+    return @persistentSettings[name]
+  end
+
+  def loadSettings
+    qs = Qt::Settings.new()
+    qs.setPath("ClickSpotterProject", "ClickSpotter")
+    qs.beginGroup("/clickspotter");
+    ok = Qt::Boolean.new
+    @persistentSettings.each do |name, value|
+      if value.class == Fixnum
+        val = Qt::Integer.new(value)
+        newValue = qs.readNumEntry("/#{name}", val, ok)
+      elsif value.class == String
+        newValue = qs.readEntry("/#{name}", value, ok)
+      elsif value.class == FalseClass || value.class == TrueClass
+        val = Qt::Integer.new(value ? 1 : 0)
+        newValue = qs.readNumEntry("/#{name}", val, ok) != 0
+      elsif value.class == Array || value.class == Hash
+        data = qs.readEntry("/#{name}", YAML.dump(value), ok)
+        newValue = YAML.load(data) if data && ok
+      else
+        raise "#{name} has unsupported type #{value.class()}"
+      end
+      @persistentSettings[name] = newValue if ok
+    end
+    data = qs.readEntry('/ServerLogFiles', nil, ok)
+    @serverLogFiles = YAML.load(data) if data && ok
+    @serverLogFiles.each do |sl|
+      if sl.name == @loadOnStartLog
+        @currentLogFile = sl
+        break;
+      end
+    end
+    qs.endGroup()
+  end
+
+  def saveSettings
+    qs = Qt::Settings.new()
+    qs.setPath("ClickSpotterProject", "ClickSpotter")
+    qs.beginGroup("/clickspotter");
+    @persistentSettings.each do |name, value|
+      if value.class == Fixnum || value.class == String
+        qs.writeEntry("/#{name}", value)
+      elsif value.class == FalseClass || value.class == TrueClass
+        qs.writeEntry("/#{name}", value ? 1 : 0)
+      elsif value.class == Array || value.class == Hash
+        qs.writeEntry("/#{name}", YAML.dump(value))
+      end
+    end
+    qs.writeEntry('/ServerLogFiles', YAML.dump(@serverLogFiles))
+    qs.endGroup()
+    qs.sync
+    qs.dispose
+  end
+
+  def readEntryList(qs, name, list)
+    i = 0
+    ok = Qt::Boolean.new
+    while true
+      value = qs.readEntry("#{name}_#{i}", nil, ok)
+      break if not !ok.nil?
+      list.push(value) if
+      i += 1
+    end
+  end
+
+  def writeEntryList(qs, name, list)
+    i = 0
+    list.each do |value|
+      qs.writeEntry("/#{name}_#{i}", value)
+      i += 1
+    end
+  end
+
+  def addServerLogFile(slf)
+    @serverLogFiles << slf
+  end
+
+  def setAsCurrentLogFile(name)
+    @currentLogFile = @serverLogFiles.find { |sl| sl.name == name }
+  end
+
+  def defaultServerURL
+    @currentLogFile.default
+  end
+
+  def serverNames
+    @currentLogFile.hostNames
+  end
+
+  def isAuxFile(fn)
+    return false unless dot = fn.rindex('.')
+    ext = fn[dot .. -1]
+    return false if ext.empty?
+    @auxFileExtensions.include?(ext)
+  end
+
+  def logFile
+    return nil unless @currentLogFile
+    @currentLogFile.logFile
+  end
+
+  def isRobot(ip, browser, url)
+    @robotPatterns.each do |rp|
+      if Regexp.new(rp["ip"]) =~ ip &&
+         Regexp.new(rp["browser"]) =~ browser
+        return rp["name"]
+      end
+    end
+    return 'Unknown' if url == '/robots.txt'
+    return nil
+  end
+
+end
+

data/lib/HitRecord.rb

@@ -0,0 +1,39 @@
+#
+# HitRecord.rb - ClickSpotter
+#
+# Copyright (c) 2005, 2006 by Chris Schlaeger <cs@kde.org>
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# $Id: HitRecord.rb 8 2006-01-22 15:19:51Z cs $
+#
+
+class HitRecord
+
+  attr_reader :timeStamp, :bytes, :code, :request
+  attr_accessor :visitor, :page, :referer, :entry, :exit
+
+  def initialize(rec)
+    @uid = rec['uid']
+    @timeStamp = rec['timeStamp']
+    @request = rec['request']
+    @code = rec['code']
+    @bytes = rec['bytes']
+    @visitor = nil
+    @page = nil
+    @referer = nil 
+    @entry = false
+    @exit = false
+  end
+  
+  def to_s
+    puts "#{@timeStamp} Request: '#{@request}' Bytes: #{@bytes}"
+  end
+
+  def url
+    return page.url
+  end
+  
+end
+

data/lib/HostNameDlg.rb

@@ -0,0 +1,83 @@
+# Form implementation generated from reading ui file 'HostNameDlg.ui'
+#
+# Created: Mon Jan 23 23:21:52 2006
+#      by: The QtRuby User Interface Compiler (rbuic)
+#
+# WARNING! All changes made in this file will be lost!
+
+
+require 'Qt'
+
+class HostNameDlg < Qt::Dialog
+
+    attr_reader :okBtn
+    attr_reader :cancelBtn
+    attr_reader :textLabel7
+    attr_reader :hostName
+    attr_reader :textLabel8
+
+
+    def initialize(parent = nil, name = nil, modal = false, fl = 0)
+        super
+
+        if name.nil?
+        	setName("HostNameDlg")
+        end
+        setSizeGripEnabled(true)
+
+        @HostNameDlgLayout = Qt::GridLayout.new(self, 1, 1, 11, 6, 'HostNameDlgLayout')
+
+        @Layout1 = Qt::HBoxLayout.new(nil, 0, 6, 'Layout1')
+        @Horizontal_Spacing2 = Qt::SpacerItem.new(20, 20, Qt::SizePolicy::Expanding, Qt::SizePolicy::Minimum)
+        @Layout1.addItem(@Horizontal_Spacing2)
+
+        @okBtn = Qt::PushButton.new(self, "okBtn")
+        @okBtn.setAutoDefault( true )
+        @okBtn.setDefault( true )
+        @Layout1.addWidget(@okBtn)
+
+        @cancelBtn = Qt::PushButton.new(self, "cancelBtn")
+        @cancelBtn.setAutoDefault( true )
+        @Layout1.addWidget(@cancelBtn)
+
+        @HostNameDlgLayout.addLayout(@Layout1, 3, 0)
+
+        @textLabel7 = Qt::Label.new(self, "textLabel7")
+
+        @HostNameDlgLayout.addWidget(@textLabel7, 2, 0)
+
+        @hostName = Qt::LineEdit.new(self, "hostName")
+
+        @HostNameDlgLayout.addWidget(@hostName, 1, 0)
+
+        @textLabel8 = Qt::Label.new(self, "textLabel8")
+
+        @HostNameDlgLayout.addWidget(@textLabel8, 0, 0)
+        languageChange()
+        resize( Qt::Size.new(295, 126).expandedTo(minimumSizeHint()) )
+        clearWState( WState_Polished )
+
+        Qt::Object.connect(@okBtn, SIGNAL("clicked()"), self, SLOT("accept()") )
+        Qt::Object.connect(@cancelBtn, SIGNAL("clicked()"), self, SLOT("reject()") )
+
+        setTabOrder(@hostName, @okBtn)
+        setTabOrder(@okBtn, @cancelBtn)
+    end
+
+    #
+    #  Sets the strings of the subwidgets using the current
+    #  language.
+    #
+    def languageChange()
+        setCaption(trUtf8("Enter Server URL"))
+        @okBtn.setText( trUtf8("&OK") )
+        @okBtn.setAccel( Qt::KeySequence.new(trUtf8("Alt+O")) )
+        @cancelBtn.setText( trUtf8("&Cancel") )
+        @cancelBtn.setAccel( Qt::KeySequence.new(trUtf8("Alt+C")) )
+        @textLabel7.setText( trUtf8("e.g. http://www.mydomain.org") )
+        @textLabel8.setText( trUtf8("Please enter a base URL of your server.") )
+    end
+    protected :languageChange
+
+
+end

data/lib/LogFileSelector.rb

@@ -0,0 +1,65 @@
+#
+# LogFileSelector.rb - ClickSpotter
+#
+# Copyright (c) 2005, 2006 by Chris Schlaeger <cs@kde.org>
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# $Id: LogFileSelector.rb 8 2006-01-22 15:19:51Z cs $
+#
+
+require 'LogFileSelectorDlg'
+require 'CSListView'
+require 'GlobalSettings'
+
+class LogFileSelector < LogFileSelectorDlg
+
+  slots 'selectionChanged(QListViewItem*)', 'clicked(QListViewItem*)'
+
+  def initialize(parent = nil, name = nil)
+    super(parent, name)
+
+    @fileListCSLV = CSListView.new(@fileList)
+    @fileList.setSorting(1, true)
+
+    addLogsToList
+
+    connect(@fileList, SIGNAL('selectionChanged(QListViewItem*)'),
+        SLOT('selectionChanged(QListViewItem*)'))
+    connect(@fileList, SIGNAL('clicked(QListViewItem*)'),
+        SLOT('clicked(QListViewItem*)'))
+
+    show
+  end
+
+  def addLogsToList
+    @fileListCSLV.startUpdate
+    $globals.serverLogFiles.each do |slf|
+      @fileListCSLV.insertItem(slf, slf.name, slf.logFile)
+    end
+    @fileListCSLV.finishUpdate
+  end
+
+  def selectedLogFile
+    @fileListCSLV.selectedItemList[0]
+  end
+
+  def selectionChanged(item)
+    @monitorBtn.setEnabled(item != nil)
+  end
+
+  def clicked(item)
+    @monitorBtn.setEnabled(false) unless item
+  end
+
+  def otherLogBtnClicked
+    settings = GSServerLogSettings.new
+    if ServerLogSettings.new(settings, self).exec() == Qt::Dialog.Accepted
+      $globals.addServerLogFile(settings)
+      addLogsToList
+    end
+  end
+
+end
+

data/lib/LogFileSelectorDlg.rb

@@ -0,0 +1,97 @@
+# Form implementation generated from reading ui file 'LogFileSelectorDlg.ui'
+#
+# Created: Mon Jan 23 23:21:52 2006
+#      by: The QtRuby User Interface Compiler (rbuic)
+#
+# WARNING! All changes made in this file will be lost!
+
+
+require 'Qt'
+
+class LogFileSelectorDlg < Qt::Dialog
+
+    slots 'languageChange()',
+    'otherLogBtnClicked()'
+
+    attr_reader :fileList
+    attr_reader :textLabel1
+    attr_reader :otherLogBtn
+    attr_reader :monitorBtn
+    attr_reader :cancelBtn
+
+
+    def initialize(parent = nil, name = nil, modal = false, fl = 0)
+        super
+
+        if name.nil?
+        	setName("LogFileSelectorDlg")
+        end
+        setSizeGripEnabled(true)
+
+        @LogFileSelectorDlgLayout = Qt::GridLayout.new(self, 1, 1, 11, 6, 'LogFileSelectorDlgLayout')
+
+        @fileList = Qt::ListView.new(self, "fileList")
+        @fileList.addColumn(trUtf8("Name"))
+        @fileList.addColumn(trUtf8("File"))
+        @fileList.setAllColumnsShowFocus( true )
+
+        @LogFileSelectorDlgLayout.addWidget(@fileList, 1, 0)
+
+        @textLabel1 = Qt::Label.new(self, "textLabel1")
+
+        @LogFileSelectorDlgLayout.addWidget(@textLabel1, 0, 0)
+
+        @layout2 = Qt::HBoxLayout.new(nil, 0, 6, 'layout2')
+
+        @otherLogBtn = Qt::PushButton.new(self, "otherLogBtn")
+        @layout2.addWidget(@otherLogBtn)
+        @Horizontal_Spacing2 = Qt::SpacerItem.new(230, 20, Qt::SizePolicy::Expanding, Qt::SizePolicy::Minimum)
+        @layout2.addItem(@Horizontal_Spacing2)
+
+        @monitorBtn = Qt::PushButton.new(self, "monitorBtn")
+        @monitorBtn.setEnabled( false )
+        @monitorBtn.setAutoDefault( true )
+        @monitorBtn.setDefault( true )
+        @layout2.addWidget(@monitorBtn)
+
+        @cancelBtn = Qt::PushButton.new(self, "cancelBtn")
+        @cancelBtn.setAutoDefault( true )
+        @layout2.addWidget(@cancelBtn)
+
+        @LogFileSelectorDlgLayout.addLayout(@layout2, 2, 0)
+        languageChange()
+        resize( Qt::Size.new(511, 282).expandedTo(minimumSizeHint()) )
+        clearWState( WState_Polished )
+
+        Qt::Object.connect(@fileList, SIGNAL("doubleClicked(QListViewItem*)"), self, SLOT("accept()") )
+        Qt::Object.connect(@cancelBtn, SIGNAL("clicked()"), self, SLOT("reject()") )
+        Qt::Object.connect(@otherLogBtn, SIGNAL("clicked()"), self, SLOT("otherLogBtnClicked()") )
+        Qt::Object.connect(@monitorBtn, SIGNAL("clicked()"), self, SLOT("accept()") )
+    end
+
+    #
+    #  Sets the strings of the subwidgets using the current
+    #  language.
+    #
+    def languageChange()
+        setCaption(trUtf8("Log File Selector"))
+        @fileList.header().setLabel( 0, trUtf8("Name") )
+        @fileList.header().setLabel( 1, trUtf8("File") )
+        @textLabel1.setText( trUtf8("Please select the log file that you want to monitor. In case the file that \n" +
+        "you want to monitor is not yet defined, please select \"Cancel\" and then\n" +
+        "you can define the log file first.") )
+        @otherLogBtn.setText( trUtf8("&Other Log File") )
+        @otherLogBtn.setAccel( Qt::KeySequence.new(trUtf8("Alt+O")) )
+        @monitorBtn.setText( trUtf8("&Monitor") )
+        @monitorBtn.setAccel( Qt::KeySequence.new(trUtf8("Alt+M")) )
+        @cancelBtn.setText( trUtf8("&Quit") )
+        @cancelBtn.setAccel( Qt::KeySequence.new(trUtf8("Alt+Q")) )
+    end
+    protected :languageChange
+
+
+    def otherLogBtnClicked(*k)
+        print("LogFileSelectorDlg.otherLogBtnClicked(): Not implemented yet.\n")
+    end
+
+end