qwikdoc 0.0.1

data/vendor/qwik/site-event.rb

@@ -0,0 +1,162 @@
+# 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? '..'
+
+module Qwik
+  class ListenerMaxExceed < StandardError; end
+
+  class Site
+    def event
+      @event = SiteEvent.new(@config, @memory, self) unless defined? @event
+      @event
+    end
+  end
+
+  class ServerMemory
+    def listener
+      @listener = EventListener.new(@config) unless defined? @listener
+      @listener
+    end
+  end
+
+  class EventListener
+    MAX_LISTENER = 5
+    TIMEOUT = 60*60
+
+    def initialize(config)
+      @config = config
+      @listener = []
+    end
+
+    def add_listener(action)
+      check_timeout
+      if MAX_LISTENER <= @listener.length
+	kickout(@listener[0], 'max_exceed')
+	raise ListenerMaxExceed		# failed to add
+      end
+      @listener << action
+    end
+
+    def kickout(action, reason)
+      @listener.delete(action)
+      action.event_disconnect(reason)
+    end
+
+    def success(action)
+      @listener.delete(action)
+    end
+
+    def each_listener(target_sitename)
+      check_timeout
+      @listener.each {|action|
+	if action.get_sitename == target_sitename
+	  yield(action)
+	end
+      }
+    end
+
+    def check_timeout
+      now = Time.now
+      now = Time.at(0) if $test
+      check_timeout_internal(@listener, now)
+    end
+
+    def check_timeout_internal(listener, now)
+      listener.each {|action|
+	time = action.get_start_time
+	if TIMEOUT < (now - time)
+	  kickout(action, 'timeout')
+	end
+      }
+    end
+  end
+
+  class SiteEvent
+    def initialize(config, memory, site)
+      @config = config
+      @memory = memory
+      @site = site
+      # @sitename = @site.sitename
+      @listener = memory.listener
+    end
+
+    def add_listener(action)
+      #return @listener.add_listener(@sitename, action)
+      return @listener.add_listener(action)
+    end
+
+    def occurred(event)
+      sitename = @site.sitename
+
+      kickout = []
+
+      @listener.each_listener(sitename) {|listener|
+	listener.event_occurred(event)
+	kickout << listener
+      }
+
+      kickout.each {|listener|
+	@listener.success(listener)
+      }
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-common'
+  $test = true
+end
+
+if defined?($test) && $test
+  class MockAction
+    def initialize
+      @event = nil
+    end
+    attr_reader :event
+
+    def get_start_time
+      #return Time.at(0)
+      return Time.now
+    end
+
+    def get_sitename
+      return 'test'
+    end
+
+    def event_occurred(event)
+      @event = event
+    end
+
+    def event_disconnect(reason)
+      if @event.nil?
+	@event = reason
+      end
+    end
+  end
+
+  class TestSiteEvent < Test::Unit::TestCase
+    include TestSession
+
+    def test_all
+      mock = MockAction.new
+
+      event = @site.event
+
+      # listener
+      event.add_listener(mock)
+      t = Thread.new {
+	while mock.event.nil?
+	  sleep 0.1
+	end
+	ok_eq(1, mock.event)
+      }
+
+      # producer
+      event.occurred(1)
+
+      t.join
+    end
+  end
+end

data/vendor/qwik/site-files.rb

@@ -0,0 +1,86 @@
+# 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'
+require 'qwik/page-files'
+
+module Qwik
+  class Site
+    def files(k = 'FrontPage')
+      page = self[k]
+      return nil if page.nil?
+      page.files = PageFiles.new(@path.to_s, k) if page.files.nil?
+      return page.files
+    end
+
+    def files_total
+      t = 0
+      self.each {|page|
+        # force to create page.files object for each page
+	# to count files in unaccecced pages after server rebooted
+        t+= files(page.key).total
+      }
+      return t
+    end
+
+    # obsolete
+    def attach
+      @attach = SiteAttach.new(@path.to_s) unless defined? @attach
+      return @attach
+    end
+  end
+
+  # obsolete
+  class SiteAttach
+    include Enumerable
+    include AttachModule
+
+    def initialize(site_dir)
+      @attach_path = site_dir.path+'.attach'
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/testunit'
+  require 'qwik/test-module-path'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteAttach < Test::Unit::TestCase
+    def test_site_attach
+      dir = '.test/'.path
+      dir.setup
+      attach = Qwik::SiteAttach.new(dir)
+
+      d = dir+'.attach'
+      d.teardown if d.exist?
+
+      ok_eq(false, attach.exist?('t.txt'))
+
+      # test put
+      attach.fput('t.txt', 't')
+      ok_eq(true, attach.exist?('t.txt'))
+
+      # test get
+      path = attach.path('t.txt')
+      ok_eq('.test/.attach/t.txt', path.to_s)
+      ok_eq('t', path.read)
+
+      # test delete
+      attach.delete('t.txt')
+      ok_eq(false, attach.exist?('t.txt'))
+
+      # test_security
+#      path = attach.path('t/t.txt') # ok
+#      assert_raise(Qwik::CanNotAccessParentDirectory) {
+#	path = attach.path('../t.txt') # bad
+#      }
+
+      dir.teardown
+    end
+  end
+end

data/vendor/qwik/site-group.rb

@@ -0,0 +1,103 @@
+# 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/group-db'
+require 'qwik/group-config'
+
+module Qwik
+  class Site
+    ML_LIFE_TIME_ALLOWANCE = 60*60*24*31*2 # 2 months
+
+    def forward?
+      return @group_config.forward?
+    end
+
+    def permanent?
+      return @group_config.permanent?
+    end
+
+    def inactive?(now = Time.now)
+      return false if @group_config.forward? || @group_config.permanent?
+
+      log = @memory[:bury_log]
+
+      last_article_time = @pages.last_article_time
+      if last_article_time.nil?		# No file here.
+	unless $test
+	  log.info("site #{@sitename}: last_article_time is nil") if log
+	end
+	return true
+      end
+
+      ml_life_time = self.siteconfig['ml_life_time'].to_i
+      ml_life_time += ML_LIFE_TIME_ALLOWANCE
+
+      result = last_article_time.to_i + ml_life_time.to_i <= now.to_i
+      if result
+	ymdhms = last_article_time.strftime("%Y-%m-%d %H:%M:%S") 
+	unless $test
+	  log.info("site #{@sitename}: last_article_time is #{ymdhms}") if log
+	end
+      end
+      return result
+    end
+
+    def unconfirmed?
+      member.list.empty? &&
+	@pages.exist?('_GroupWaitingMembers') &&
+        @pages.exist?('_GroupWaitingMessage')
+    end
+
+    private
+
+    def init_group_config
+      # in group-db.rb
+      db = QuickML::GroupDB.new(@config.sites_dir.to_s, @sitename)
+      db.set_site(self)
+      # in group-config.rb
+      @group_config = QuickML::GroupConfig.new(db)
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-module-session'
+  require 'qwik/farm'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteML < Test::Unit::TestCase
+    include TestSession
+
+    def check_a_site(site)
+      # At the first, there is no file here.
+      ok_eq(true, site.inactive?(Time.at(0)))
+
+      # Create a new page with time 0.
+      page = site.create_new
+      page.put_with_time('a', 0)
+      ok_eq(false, site.inactive?(Time.at(0)))
+
+      # Change the life time to 0.
+      page = site['_SiteConfig']
+      page.put_with_time(':ml_life_time:0', 0)	# Die soon.
+      ok_eq(true, site.inactive?(Time.at(0 + Qwik::Site::ML_LIFE_TIME_ALLOWANCE)))
+
+      # Set GroupConfig to forward mode.
+      page = site.create('_GroupConfig')
+      page.put_with_time(':forward:true', 0)	# forward mode.
+      ok_eq(false, site.inactive?(Time.at(0)))
+    end
+
+    def test_all
+      # test_inactive
+      check_a_site(@site)
+
+      # test_inactive_top_site
+      check_a_site(@memory.farm.get_top_site)
+    end
+  end
+end

data/vendor/qwik/site-index.rb

@@ -0,0 +1,47 @@
+# 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? '..'
+
+module Qwik
+  class Site
+    def index
+      return @pages.index
+    end
+
+    def isearch(query)
+      index = self.index
+      return if index.nil?
+      return index.search(query)
+    end
+
+    def isearch_parse_query(query)
+      return query.strip.split
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-common'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteIndex < Test::Unit::TestCase
+    include TestSession
+
+    def test_all
+      res = session
+
+      page = @site.create_new
+      page.store('This is a test.')
+      page = @site.create_new
+      page.store('This is a test, too.')
+
+#      ok_eq(['1', '2'], @site.isearch('test'))
+#      ok_eq(['2'], @site.isearch('too'))
+#      ok_eq([], @site.isearch('nosuch'))
+    end
+  end
+end

data/vendor/qwik/site-log.rb

@@ -0,0 +1,64 @@
+# 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? '..'
+
+module Qwik
+  class Site
+    def sitelog
+      @sitelog = SiteLog.new(@config, self) unless defined? @sitelog
+      @sitelog
+    end
+
+    def log(time, user, cmd, pagename)
+      sitelog.add(time, user, cmd, pagename)
+    end
+  end
+
+  class SiteLog
+    def initialize(config, site)
+      @config = config
+      @site = site
+    end
+
+    def add(t, user, cmd, pagename)
+      dbkey('_SiteLog'    ).add(t, user, cmd, pagename)
+      dbkey('_SiteChanged').add(t, user, cmd, pagename)
+    end
+
+    def list
+      dbkey('_SiteLog').hash.sort
+    end
+
+    private
+
+    def dbkey(key)
+      page = @site[key]
+      page = @site.create(key) if page.nil?
+      page.wikidb
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-module-session'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteLog < Test::Unit::TestCase
+    include TestSession
+
+    def test_sitelog_unit
+      sitelog = @site.sitelog
+      sitelog.add(0, 'user@e.com', 'save', '1')
+      ok_eq(",0,user@e.com,save,1\n", @site['_SiteLog'].load)
+      sitelog.add(0, nil, 'save', '1')
+      ok_eq(",0,user@e.com,save,1\n,0,,save,1\n", @site['_SiteLog'].load)
+
+      # test_sitelog_session
+      # not yet
+    end
+  end
+end