dansguardian 0.0.2

data/Changelog

@@ -0,0 +1,5 @@
+
+0.0.1
+
+* first release
+

data/README.rdoc

@@ -0,0 +1,38 @@
+===DansGuardian
+
+A Ruby library to manage DansGuardian configuration. Based on ConfigFiles by 
+the same author.
+
+  require 'rubygems'
+  require 'pp'
+  require 'configfiles'
+  require 'dansguardian'
+
+  file = '/etc/dansguardian/dansguardian.conf'
+
+  #dgm = DansGuardian::Config::Main.new 
+  #dgp = DansGuardian::Parser.read_file file
+  #dgm.load dgp
+  #pp dgm
+
+  dgconf = DansGuardian::Config.new(:mainfile => file)
+
+  dgconf.main
+
+  dgconf.filtergroup(1, :cached => true) 
+
+  wfl = dgconf.filtergroup(1)[:weightedphraselist]
+
+  p wfl
+
+  pp DansGuardian::Inclusion.get(wfl) 
+
+  #dg.config.filtergroup(1).inclusiontree('weightedphraselist')
+
+== License
+
+Same of Ruby
+
+Copyright (c) 2010 Guido De Rosa <guido.derosa at vemarsas.it>
+
+

data/example.rb

@@ -0,0 +1,38 @@
+$dg_library_path = File.expand_path File.join File.dirname(__FILE__), 'lib'
+
+unless $LOAD_PATH.include? $dg_library_path
+  $LOAD_PATH.unshift $dg_library_path
+end
+
+require 'rubygems'
+require 'pp'
+require 'configfiles'
+require 'dansguardian'
+
+file = '/etc/dansguardian/dansguardian.conf'
+
+#dgm = DansGuardian::Config::Main.new 
+#dgp = DansGuardian::Parser.read_file file
+#dgm.load dgp
+#pp dgm
+
+dgconf = DansGuardian::Config.new(:mainfile => file)
+
+dgconf.main
+
+dgconf.filtergroup(1, :cached => true) 
+
+wfl = dgconf.filtergroup(1)[:weightedphraselist]
+
+p wfl
+
+pp DansGuardian::Inclusion.get(wfl) 
+
+
+
+
+
+#dg.config.filtergroup(1).inclusiontree('weightedphraselist')
+
+
+

data/lib/dansguardian.rb

@@ -0,0 +1,13 @@
+autoload :IPAddr, 'ipaddr'
+autoload :URI,    'uri'
+autoload :Set,    'set'
+
+require 'configfiles'
+
+module DansGuardian
+  VERSION = '0.0.2'
+
+  autoload :Config,     'dansguardian/config'
+  autoload :Parser,     'dansguardian/parser'
+  autoload :Inclusion,  'dansguardian/inclusion'
+end

data/lib/dansguardian/config.rb

@@ -0,0 +1,69 @@
+require 'dansguardian/config/main'
+require 'dansguardian/config/filtergroup'
+
+module DansGuardian
+  class Config
+    # +arg+ May be +String+-like (the main config file name) or +Hash+-like :
+    #
+    #   DansGuardian::Config.new('path/to/dansguardian.conf')
+    #
+    #   DansGuardian::Config.new(:mainfile => '/path/to/dansguardian.conf')
+    #
+    def initialize(arg='/etc/dansguardian/dansguardian.conf')
+      h = {}
+      if arg.respond_to? :[]
+        h = arg
+      else # String-like assumed
+        h = {:mainfile => arg}
+      end
+      @mainfile = h[:mainfile] 
+      @mainconfig = nil
+      @filtergroups = []
+    end
+
+    # get data from the main configuration file
+    def main(opt_h={:cached => false})
+      if opt_h[:cached]
+        if @mainconfig
+          return @mainconfig
+        else
+          get_main
+        end
+      else
+        get_main
+      end
+    end
+
+    # get filtergroup configuration data
+    def filtergroup(n=1, opt_h={:cached => false})
+      if opt_h[:cached]
+        if @filtergroups[n]
+          return @filtergroups[n]
+        else
+          get_filtergroup n
+        end
+      else
+        get_filtergroup n
+      end
+    end
+
+    def filtergroupfile(n=1)
+      File.join File.dirname(@mainfile), "dansguardianf#{n}.conf"
+    end
+
+    protected
+    
+    def get_main
+      dgmain = DansGuardian::Config::Main.new
+      parsedata = DansGuardian::Parser.read_file @mainfile
+      @mainconfig = dgmain.load parsedata
+    end
+
+    def get_filtergroup(n)
+      dgf = DansGuardian::Config::FilterGroup.new
+      parsedata = DansGuardian::Parser.read_file filtergroupfile(n)
+      @filtergroups[n] = dgf.load parsedata
+    end
+
+  end
+end

data/lib/dansguardian/config/constants.rb

@@ -0,0 +1,27 @@
+require 'configfiles'
+
+module DansGuardian
+  class Config
+
+      # Useful constants
+      INFINITY = ::Float::INFINITY
+
+      # Recurring converters
+      BOOL = {
+        'on'  => true, 
+        'off' => false
+      }
+      REPORTING_LEVEL = {
+       '-1'   =>    :log_only,
+        '0'   =>    :access_denied_only,
+        '1'   =>    :why_but_not_what,
+        '2'   =>    :full,
+        '3'   =>    :html_template        
+      }
+
+      # Exceptions
+      class ValidationFailed < ::ConfigFiles::Base::ValidationFailed; end
+
+  end
+end
+

data/lib/dansguardian/config/filtergroup.rb

@@ -0,0 +1,181 @@
+autoload :URI, 'uri'
+
+require 'dansguardian/config/constants'
+
+module DansGuardian
+  class Config
+    class FilterGroup < ::ConfigFiles::Base
+
+      on :unknown_parameter do |s|
+        "FIXME: unknown parameter: value = #{s}"  
+      end
+
+      parameter :groupmode,
+        '0' => :banned,
+        '1' => :filtered,
+        '2' => :unfiltered
+
+      parameter :groupname
+
+      [
+        :bannedphraselist,
+        :bannedsitelist,
+        :bannedurllist,
+        :bannedregexpurllist,
+        :bannedextensionlist,
+        :bannedregexpheaderlist,
+        :bannedmimetypelist,
+        :headerregexplist, # ban
+
+        :weightedphraselist,
+
+        :greysitelist,
+        :greyurllist,
+
+        :contentregexplist, # modify
+        :urlregexplist,     # modify
+
+        :exceptionextensionlist,
+        :exceptionmimetypelist,
+        :exceptionfilesitelist,
+        :exceptionfileurllist,
+        :exceptionphraselist,
+        :exceptionsitelist,
+        :exceptionurllist,
+        :exceptionregexpurllist,
+ 
+        :logsitelist,
+        :logurllist,
+        :logregexpurllist,
+
+        :picsfile,
+
+      ].each do |name|
+        parameter name 
+      end
+
+      parameter :naughtynesslimit, :to_i
+
+      virtual   :naughtyness do |confdata|
+        case confdata[:naughtynesslimit]
+        when 0..50
+          :young_children
+        when 51..100
+          :old_children
+        when 101..150       # sure of 150 ?
+          :young_adults
+        when 150..INFINITY
+          :adults
+        end
+      end
+
+      parameter :categorydisplaythreshold do |str|
+        case str
+        when '-1'
+          :highest_only
+        when '0'
+          :all
+        else
+          n = str.to_i
+          if n > 0
+            n
+          else
+            # 'eager' validation ;-)
+            raise ValidationFailed, "found an invalid value '#{str}' for parameter :categorydisplaythreshold"
+          end
+        end
+      end
+      default   :categorydisplaythreshold,  :all
+
+      parameter :embeddedurlweight,         :to_i
+      default   :embeddedurlweight,         0
+
+      parameter :blockdownloads,            BOOL
+      default   :blockdownloads,            false
+
+      parameter :enablepics,                BOOL
+      default   :blockdownloads,            false
+
+      [:bypass, :infectionbypass].each do |name|
+        parameter name do |str|
+          case str
+          when '-1'
+            :require_separate_program
+          when '0'
+            :disable
+          else
+            seconds = str.to_i
+            if seconds > 0
+              seconds
+            else
+              # 'eager' validation...
+              raise ValidationFailed, "found an invalid value '#{str}' for parameter '#{name}'"
+            end
+          end
+        end
+        default   name, :disable
+      end
+
+      [:bypasskey, :infectionbypasskey].each do |name|
+        parameter name do |str|
+          case str
+          when /^\s*$/
+            :generate_random
+          else
+            str
+          end
+        end
+        default   name, :generate_random
+      end
+
+      parameter :infectionbypasserrorsonly, BOOL
+      default   :infectionbypasserrorsonly, true
+
+      parameter :disablecontentscan,        BOOL
+      default   :disablecontentscan,        false
+      virtual(:contentscan) {|conf| !conf[:disablecontentscan]} 
+
+      parameter :deepurlanalysis,           BOOL
+      default   :deepurlanalysis,           false
+
+      parameter :reportinglevel,            REPORTING_LEVEL
+
+      parameter(:accessdeniedaddress)       {|s| URI.parse s} 
+
+      parameter :htmltemplate
+
+      parameter :usesmtp,                   BOOL
+      default   :usesmtp,                   false
+
+      [:mailfrom, :avadmin, :contentadmin, :avsubject, :contentsubject].each do |name|
+        parameter name do |str|
+          case str
+          when /^\s*$/
+            nil
+          else
+            str
+          end
+        end
+      end
+
+      [:notifyav, :notifycontent, :thresholdbyuser].each do |name|
+        parameter name,                     BOOL
+      end
+
+      parameter :violations,                :to_i
+      virtual   :violations_before_notification do |cfdata|
+        case cfdata[:violations]
+        when 0
+          :never
+        else
+          cfdata[:violations]
+        end
+      end
+
+      parameter :threshold,                 :to_i
+
+    end 
+  end
+end
+
+

data/lib/dansguardian/config/main.rb

@@ -0,0 +1,268 @@
+autoload :IPAddr, 'ipaddr'
+autoload :URI,    'uri'
+autoload :Set,    'set'
+
+require 'dansguardian/extensions/float'
+require 'dansguardian/config/constants'
+
+module DansGuardian
+  class Config
+    class Main < ::ConfigFiles::Base
+
+      # Useful constants
+      INFINITY = ::Float::INFINITY
+
+      # Recurring converters
+      BOOL = {'on'  => true, 'off' => false} 
+
+      # Exceptions
+      class ValidationFailed < ValidationFailed; end
+
+      on :unknown_parameter do |s|
+        "FIXME: unknown parameter: value = #{s}"  
+      end
+
+      parameter   :reportinglevel,              REPORTING_LEVEL
+
+      parameter   :languagedir
+
+      parameter   :language
+
+      parameter   :loglevel, 
+        '0'   =>    :none,
+        '1'   =>    :just_denied,
+        '2'   =>    :all_text_based,
+        '3'   =>    :all_requests
+
+      parameter   :logexceptionhits,
+        '0'   =>    :never,
+        '1'   =>    :log,
+        '2'   =>    :log_and_mark
+      default     :logexceptionhits,            :log_and_mark
+      
+      parameter   :logfileformat,
+        '1'   =>    :dansguardian,
+        '2'   =>    :csv,
+        '3'   =>    :squid,
+        '4'   =>    :tabs
+      
+      parameter   :maxlogitemlength,            :to_i
+      
+      parameter   :anonymizelogs,               BOOL
+      
+      parameter   :syslog,                      BOOL
+      
+      parameter   :loglocation
+      
+      parameter   :statlocation
+      
+      parameter   :filterip do |str|
+        if str == ''
+          :any
+        else
+          IPAddr.new str # in case of invalid str, rely on IPAddr exceptions
+        end
+      end
+      
+      parameter   :filterport,                  :to_i
+      
+      parameter   :proxyip do |str| 
+        IPAddr.new str
+      end
+      default     :proxyip,                     IPAddr.new('127.0.0.1')
+      
+      parameter   :proxyport,                   :to_i
+      
+      parameter   :accessdeniedaddress do |str|
+        URI.parse str
+      end
+      
+      parameter   :nonstandarddelimiter,        BOOL
+      default     :nonstandarddelimiter,        true
+      
+      parameter   :usecustombannedimage,        BOOL
+      default     :usecustombannedimage,        true
+      
+      parameter   :custombannedimagefile
+      
+      parameter   :filtergroups,                :to_i
+      
+      parameter   :filtergroupslist
+      
+      parameter   :bannediplist
+      
+      parameter   :exceptioniplist
+      
+      parameter   :showweightedfound,           BOOL
+      
+      parameter   :weightedphrasemode,
+        '0'   => false,
+        '1'   => :normal,
+        '2'   => :singular
+      
+      parameter   :urlcachenumber,              :to_i
+      
+      parameter   :urlcacheage,                 :to_i 
+          # seconds, TODO: class Time::Interval ?
+      
+      parameter   :scancleancache,              BOOL
+      default     :scancleancache,              true
+      
+      parameter   :phrasefiltermode,
+        '0'   =>  Set.new([:meta,  :title,         :raw]),
+        '1'   =>  Set.new([:meta,  :title, :smart      ]),
+        '2'   =>  Set.new([:meta,  :title, :smart, :raw]),
+        '3'   =>  Set.new([:meta,  :title              ])
+      default     :phrasefiltermode,  
+                  Set.new([:meta,  :title, :smart, :raw])
+      
+      parameter   :preservecase,
+        '0'   =>  Set.new([:lower             ]),
+        '1'   =>  Set.new([         :original ]),
+        '2'   =>  Set.new([:lower,  :original ]) 
+      default     :preservecase, 
+                  Set.new([:lower             ])
+      
+      parameter   :hexdecodecontent,            BOOL
+      default     :hexdecodecontent,            false
+      
+      parameter   :forcequicksearch,            BOOL
+      default     :forcequicksearch,            false
+
+      parameter   :reverseaddresslookups,       BOOL
+
+      parameter   :reverseclientiplookups,      BOOL
+
+      parameter   :logclienthostnames,          BOOL
+
+      parameter   :createlistcachefiles,        BOOL
+
+      parameter   :maxuploadsize do |str|
+        case str
+        when '-1'
+          INFINITY
+        else
+          str.to_i * 1024
+        end
+      end
+
+      parameter   :maxcontentfiltersize do |str|
+        case str
+        when '0'
+          lambda {|confdata| confdata[:maxcontentramcachescansize]} 
+        else
+          str.to_i * 1024
+        end
+      end
+
+      parameter   :maxcontentramcachescansize do |str|
+        case str
+        when '0'
+          lambda {|confdata| confdata[:maxcontentfilecachescansize]}
+        else
+          str.to_i * 1024
+        end
+      end
+
+      parameter   :maxcontentfilecachescansize do |str| 
+        str.to_i * 1024
+      end
+
+      parameter   :filecachedir
+
+      parameter   :deletedownloadedtempfiles,   BOOL
+      default     :deletedownloadedtempfiles,   true
+
+      parameter   :initialtrickledelay,         :to_i
+
+      parameter   :trickledelay,                :to_i
+
+      # You don't really need to lazy-evaluate (short) Arrays
+      #
+      parameter   :downloadmanager              # Array    
+      parameter   :contentscanner               # Array
+      parameter   :authplugin                   # Array
+
+      parameter   :contentscannertimeout,       :to_i
+      default     :contentscannertimeout,       60
+
+      parameter   :contentscanexceptions,       BOOL
+      default     :contentscanexceptions,       false
+
+      parameter   :recheckreplacedurls,         BOOL
+      default     :recheckreplacedurls,         false
+
+      [
+        :forwardedfor, 
+        :usexforwardedfor, 
+        :logconnectionhandlingerrors
+      ].each do |par|
+        parameter par,                          BOOL
+      end
+
+      parameter   :logchildprocesshandling,     BOOL
+
+      [
+        :maxchildren, 
+        :minchildren, 
+        :minsparechildren, 
+        :preforkchildren, 
+        :maxsparechildren, 
+        :maxagechildren
+      ].each do |par|
+        parameter par,                          :to_i
+      end
+
+      parameter   :maxips do |str|
+        if str == '0'
+          INFINITY
+        else
+          str.to_i
+        end
+      end
+
+      [:ipcfilename, :urlipcfilename, :ipipcfilename, :pidfilename].each do |p|
+        parameter p
+      end
+      default     :pidfilename,                 '/var/run/dansguardian.pid'
+
+      [:nodaemon, :nologger, :logadblocks, :loguseragent].each do |p|
+        parameter p,                            BOOL
+        default   p,                            false
+      end
+
+      [:daemon, :logger].each do |name|
+        virtual     name do |confdata|
+          not(confdata["no#{name}".to_sym]) 
+        end
+      end
+
+      [:daemonuser, :daemongroup].each do |name|
+        parameter name
+        default   name, :set_at_compile_time
+      end
+
+      parameter   :softrestart,                 BOOL
+      default     :softrestart,                 false
+
+      parameter   :mailer
+
+      validate do |conf|
+        raise ValidationFailed, "maxcontentfiltersize must be not higher than maxcontentramcachescansize" unless
+            conf[:maxcontentfiltersize] <= 
+                conf[:maxcontentramcachescansize]
+
+        raise ValidationFailed, "maxcontentramcachescansize must be not higher than maxcontentfilecachescansize" unless
+            conf[:maxcontentramcachescansize] <= 
+                conf[:maxcontentfilecachescansize]
+
+        raise ValidationFailed, "maxcontentfilecachescansize must be greater or equal to maxcontentramcachescansize" unless
+            conf[:maxcontentfilecachescansize] >= 
+                conf[:maxcontentramcachescansize]
+      end
+
+    end 
+  end
+end
+
+

data/lib/dansguardian/extensions/float.rb

@@ -0,0 +1,3 @@
+class Float
+  INFINITY ||= 1.0/0.0 # Introduced in Ruby 1.9.2
+end

data/lib/dansguardian/inclusion.rb

@@ -0,0 +1,16 @@
+module DansGuardian
+  module Inclusion
+    # no distinction between text parser and ConfigFile conversion here ...
+    def self.get(filename)
+      all = {}
+      File.foreach filename do |line|
+        if line =~ /^\s*\.Include\s*<(.*)>/
+          all[$1] = {:active => true}
+        elsif line =~ /^\s*#+\s*\.Include\s*<(.*)>/
+          all[$1] = {:active => false}
+        end
+      end
+      return all
+    end
+  end
+end

data/lib/dansguardian/parser.rb

@@ -0,0 +1,43 @@
+module DansGuardian
+  module Parser
+
+    def self.read(io)
+      h = {}
+      may_appear_multiple_times = [
+        :downloadmanager, :contentscanner, :authplugin]
+      io.each_line do |line|
+        line.sub! /#.*$/, ''
+        line.strip!
+        match = false
+        case line
+        when /^([^=\s]+)\s*=\s*([^=\s']*)$/ 
+          key = $1.to_sym
+          value = $2
+          match = true
+        when /^([^=\s]+)\s*=\s*'(.*)'$/
+          key = $1.to_sym
+          value = $2.gsub(/\\'/, "'")
+          match = true
+        end
+        if match
+          if may_appear_multiple_times.include? key 
+            h[key] ||= []
+            h[key] << value
+          else
+            h[key] = value
+          end
+        end
+      end
+      return h
+    end
+
+    def self.read_file(filepath)
+      File.open filepath, 'r' do |f|
+        read f
+      end
+    end
+
+  end
+end
+
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: dansguardian
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Guido De Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-03 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: configfiles
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Manage DansGuardian configuration from Ruby -- http:/dansguardian.org/
+email: guido.derosa@vemarsas.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Changelog
+- README.rdoc
+- example.rb
+- lib/dansguardian.rb
+- lib/dansguardian/config/constants.rb
+- lib/dansguardian/config/filtergroup.rb
+- lib/dansguardian/config/main.rb
+- lib/dansguardian/extensions/float.rb
+- lib/dansguardian/config.rb
+- lib/dansguardian/inclusion.rb
+- lib/dansguardian/parser.rb
+has_rdoc: true
+homepage: http://github.com/gderosa/dansguardian.rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Manage DansGuardian configuration from Ruby -- http:/dansguardian.org/
+test_files: []
+