qwikdoc 0.0.1

data/vendor/qwik/db-filesystem.rb

@@ -0,0 +1,305 @@
+# Copyright (C) 2003-2006 Kouichirou Eto, All rights reserved.
+# This is free software with ABSOLUTELY NO WARRANTY.
+# You can redistribute it and/or modify it under the terms of the GNU GPL 2.
+
+$LOAD_PATH.unshift '..' unless $LOAD_PATH.include? '..'
+require 'qwik/util-pathname'
+
+module Qwik
+  class FileSystemDB
+    def initialize(path, spath)
+      @path = path
+      @path_h = {}
+      @spath = spath
+      @spath_h = {}
+
+      @observer = []
+    end
+
+    # FIXME: Obsolete this method.
+    def backupdb
+      # FIXME: Check if it is the backupdb.
+      return @observer[0]
+    end
+
+    def check_integrity(ob)
+      self.each {|k|
+	v = self.get(k)
+	ob.check(k, v)
+      }
+    end
+
+    def register_observer(ob)
+      check_integrity(ob)
+      @observer << ob
+    end
+
+    def close
+      # do nothing
+    end
+
+    def exist?(k)
+      begin
+	return true if baseexist?(k)
+	return true if spath(k).exist?
+      rescue
+	return false
+      end
+      return false
+    end
+
+    def baseexist?(k)
+      begin
+	return true if path(k).exist?
+      rescue
+	return false
+      end
+      return false
+    end
+
+    def create(k)
+      touch(k) unless exist?(k)
+    end
+
+    def get(k)
+      if  path(k).exist?
+	return path(k).read
+      end
+      return spath(k).read if spath(k).exist?
+      return ''		# Not nil.
+    end
+
+    def size(k)
+      return  path(k).size if  path(k).exist?
+      return 0
+    end
+
+    def mtime(k)
+      return  path(k).mtime if  path(k).exist?
+      return spath(k).mtime if spath(k).exist?
+      return Time.at(0)		# Not nil.  The file is already deleted.
+    end
+
+    def add(k, v)
+      put(k, get(k)+v)
+    end
+
+    def put(k, v, time=nil)
+      # FIXME: Should make it atomic.  Use mutex.
+      path(k).put(v)
+      if time
+	time = Time.at(time) if time.is_a?(Integer)
+	path(k).utime(time, time)
+      else
+	time = Time.now
+      end
+
+    # @backupdb.put(k, time, v)
+      @observer.each {|ob|
+	ob.put(k, v, time)
+      }
+    end
+    alias set put
+
+    def touch(k)
+      add(k, '')	# add null String
+    end
+
+    def delete(k)
+      path(k).unlink if path(k).exist?
+    end
+
+    def list(with_super = false)
+      ar =  get_dir_list(@path.to_s)
+      ar += get_dir_list(@spath.to_s) if with_super
+      return ar.sort
+    end
+
+    def each(with_super = false)
+      list(with_super).each {|b|
+	yield(b)
+      }
+    end
+
+    def each_all(&b)
+      each(true, &b)
+    end
+
+    def nu_last_page_time # mtime of the newest page
+      t = map {|k| mtime(k) }.max
+      t = Time.at(0) if t.nil?
+      return t
+    end
+
+    def last_page_time # mtime of the newest page
+      max = 0
+      list().each {|pagename|
+        t = mtime(pagename).to_i
+        max = t if max < t
+      }
+      return Time.at(max)
+    end
+
+    # QuickML support
+    def last_article_time # mtime of the newest file
+      max = maxfile = nil
+      @path.each_entry {|file|
+	f = @path+file
+	next unless f.file?
+	base = file.to_s
+	next if ignore_on_last_article_time?(base)
+
+	mt = f.mtime
+	if max.nil? || max < mt
+	  max = mt 
+	  maxfile = f
+	end
+      }
+      return max # return nil if there is no file.
+    end
+
+    private
+
+    IGNORE_ON_LAST_ARTICLE_TIME =
+      [
+       ',config', '_GroupConfig.txt',
+       ',charset', '_GroupCharset.txt',
+       ',alerted', '_GroupAlerted.txt',
+       /\A\./,
+       /\A_counter_[a-zA-Z0-9_]+\.txt\z/,
+      ]
+    def ignore_on_last_article_time?(base)
+      IGNORE_ON_LAST_ARTICLE_TIME.detect { |entry| entry === base }
+    end
+
+    def path(k)
+      return gen_path(@path, @path_h, k)
+    end
+
+    def spath(k)
+      return gen_path(@spath, @spath_h, k)
+    end
+
+    def gen_path(path, h, k)
+      pa = h[k]
+      return pa if pa
+      raise 'Character type error '+k unless /\A([_A-Za-z0-9]+)\z/ =~ k
+      h[k] = path+(k+'.txt')
+      return h[k]
+    end
+
+    # FIXME: I don't know why this method doesn't use Pathname.
+    def get_dir_list(dir)
+      ar = []
+      Dir.foreach(dir) {|file|
+	f = dir+'/'+file
+	next unless FileTest.file?(f)
+	base = file.to_s
+	if /\A([_A-Za-z0-9]+)\.txt\z/ =~ base
+	  b = $1
+	  ar << b
+	end
+      } 
+      return ar
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'test/unit'
+  require 'qwik/config'
+  require 'qwik/test-module-path'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestFileSystemDB < Test::Unit::TestCase
+    def test_fsdb
+      # setup
+      config = Qwik::Config.new
+      config.update Qwik::Config::DebugConfig
+      config.update Qwik::Config::TestConfig
+      spath = config.super_dir.path
+      path = '.test/'.path
+      path.setup
+      db = Qwik::FileSystemDB.new(path, spath)
+
+      # test_exist?
+      assert_equal false, db.exist?('1')
+
+      # test_create
+      db.create('1')
+      assert_equal true, db.exist?('1')
+      assert_equal '', db.get('1')
+
+      # test_put
+      db.put('1', 't')
+      assert_equal 't', db.get('1')
+
+      # test_size
+      assert_equal 1, db.size('1')
+
+      # test_put_with_time
+      db.put('1', 't', Time.at(0))
+      assert_equal 0, db.mtime('1').to_i	# test_mtime
+      # test_put_with_time_num
+      db.put('1', 't', 1)
+      assert_equal 1, db.mtime('1').to_i
+
+      # test_last_page_time
+      assert_equal Time.at(1), db.last_page_time
+      # test_last_article_time
+      assert_equal Time.at(1), db.last_article_time
+
+      # test_add
+      db.add('1', 's')
+      assert_equal 'ts', db.get('1')
+
+      # test_get_dir_list
+      ar = []
+      db.instance_eval {
+	dir = @path.to_s
+	ar += get_dir_list(dir)
+      }
+      assert_equal ['1'], ar
+
+      # test_get_dir_list_spath
+      ar = []
+      db.instance_eval {
+	dir = @spath.to_s
+	ar += get_dir_list(dir)
+      }
+      assert_equal true, ar.include?('FrontPage')
+
+      # test_each
+      db.each {|f|
+	assert_instance_of(String, f)
+      }
+
+      # test_each_all
+      db.each(true) {|f|
+	assert_instance_of(String, f)
+      }
+      db.each_all {|f|
+	assert_instance_of(String, f)
+      }
+
+      # test_backup_db
+     #assert_instance_of(Qwik::BackupDB, db.backup_db('1'))
+
+      # test_touch
+      db.touch('1')
+
+      # test_delete
+      db.delete('1')
+      assert_equal false, db.exist?('1')
+
+      # test_super_pages
+      assert_equal true,  db.exist?('_SideMenu')
+      assert_equal false, db.baseexist?('_SideMenu')
+
+      # teardown
+      path.teardown
+    end
+  end
+end

data/vendor/qwik/db-indexer.rb

@@ -0,0 +1,154 @@
+# Copyright (C) 2003-2006 Kouichirou Eto, All rights reserved.
+# This is free software with ABSOLUTELY NO WARRANTY.
+# You can redistribute it and/or modify it under the terms of the GNU GPL 2.
+
+begin
+#  require 'senna'
+#  $have_senna_so = true
+rescue LoadError
+  $have_senna_so = false
+end
+$have_senna_so = false
+
+$LOAD_PATH.unshift '..' unless $LOAD_PATH.include? '..'
+require 'qwik/util-pathname'
+
+module Qwik
+  class DBIndexer
+    def initialize(path)
+      @path = path
+
+      @index = nil
+      return if ! $have_senna_so
+
+      @cache_path = @path+'.cache'
+      @index_path = @cache_path+'index'
+      check_directory
+
+      @index = Senna::Index.new((@cache_path+'index').to_s)
+    end
+
+    def check(k, v)
+      return update(k, v)
+    end
+
+    def put(k, v, time=nil)
+      return update(k, v)
+    end
+
+    def update(k, v)
+      return if @index.nil?
+
+      # Try to read old content.
+      pa = path(k)
+      old = nil
+      old = pa.get if pa.exist?
+
+      # Avoid \0 from its contents.
+      v = v.gsub("\0", '')if v.include?("\0")	# FIXME: Too ad hoc.
+
+      return false if v == old		# Not necessary to update.
+
+      result = @index.upd(k, old, v)	# FIXME: Take care of result?
+
+      # Store new value to cached content.
+      check_directory
+      pa.open('wb') {|f| f.print(v) }
+
+      return result
+    end
+
+    def search(key)
+      return nil if @index.nil?
+
+      records = @index.sel(key)
+      return [] if records.nil? || records.nhits == 0
+
+      ar = []
+      while res = records.next
+	ar << res
+      end
+      return ar
+    end
+
+    private
+
+    def check_directory
+      @cache_path.check_directory
+      @index_path.check_directory
+    end
+
+    def path(k)
+      return @index_path+(k+'.txt')
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/testunit'
+  require 'qwik/config'
+  require 'qwik/test-module-path'
+  require 'qwik/db-filesystem'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestDBIndexer < Test::Unit::TestCase
+    def setup_db
+      config = Qwik::Config.new
+      spath = config.super_dir.path
+      path = './.test/'.path
+      path.setup
+      db = Qwik::FileSystemDB.new(path, spath)
+      return path, db
+    end
+
+    def teardown_db(path)
+      path.teardown
+    end
+
+    def test_all
+      # setup
+      path, db = setup_db
+
+      # Initialize DBIndexer.
+      indexer = Qwik::DBIndexer.new(path)
+      db.register_observer(indexer)	# Regist to the DB.
+
+      # Put test contents.
+      db.put('a', 'This is a test.')
+      db.put('b', 'This is a test, too.')
+
+      # test_search
+      if $have_senna_so
+        ok_eq(['a', 'b'], indexer.search('test'))
+        ok_eq(['b'], indexer.search('too'))
+        ok_eq([], indexer.search('nosuch'))
+      end
+
+      teardown_db(path)
+    end
+
+    def test_pre_content
+      # Setup db
+      path, db = setup_db
+
+      # Put test contents before to setup indexer.
+      db.put('a', 'This is a test.')
+      db.put('b', 'This is a test, too.')
+
+      # Initialize DBIndexer.
+      indexer = Qwik::DBIndexer.new(path)
+      db.register_observer(indexer)	# Regist to the DB.
+
+      # test_search
+      if $have_senna_so
+        ok_eq(['a', 'b'], indexer.search('test'))
+        ok_eq(['b'], indexer.search('too'))
+        ok_eq([], indexer.search('nosuch'))
+      end
+
+      teardown_db(path)
+    end
+  end
+end