qwikdoc 0.0.1

data/vendor/qwik/site-rrefs.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2009 AIST, 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-rrefs'
+
+module Qwik
+  class Site
+    def rrefs(k = 'FronPage')
+      page = self[k]
+      return nil if page.nil?
+      page.rrefs = PageRRefs.new(@path.to_s, k) if page.rrefs.nil?
+      return page.rrefs
+    end
+  end
+end

data/vendor/qwik/site-search.rb

@@ -0,0 +1,180 @@
+# 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/db-searchwords.rb'
+
+module Qwik
+  class Site
+    COMMENT = /^#.*$/
+
+=begin
+    def init_site_search
+      @search_words_db = SearchWordsDB.new(@path, @config)
+    end
+
+    def get_search_words
+      @search_words_db.get_normalized
+    end
+
+    def delete_search_word(word)
+      @search_words_db.delete(word)
+    end
+=end
+
+    def search(query, obfuscate = true)
+      queries = search_parse_query(query)
+#      @search_words_db.put(queries)
+      
+      all_snippet_length = 120
+      pre_snippet_length = all_snippet_length / queries.size / 2
+
+      ar = []
+      self.each {|page|
+	str = page.load
+	str = str.gsub(COMMENT, '')
+	str = wiki_to_string(str)
+	matched = true
+
+	mds = []
+	snippet = ""
+
+	queries.each {|query|
+	  regexp = Regexp.new(Regexp.escape(query),
+                              Regexp::IGNORECASE|Regexp::MULTILINE)
+	  md = regexp.match(str)
+	  if ! md
+	    matched = false
+	    break
+	  else
+	    mds.push(md)
+	  end
+	}
+
+	if matched
+	  snippet = create_snippet(mds)
+	  snippet = MailAddress.obfuscate_str(snippet) if obfuscate
+	  ar << [page.key, snippet]
+	end
+      }
+
+      ar
+    end
+
+    def search_parse_query(query)
+      return query.strip.split.map{|e| e.downcase }.uniq
+    end
+
+    private
+
+    def wiki_to_string(wiki)
+      tokens = Qwik::TextTokenizer.tokenize(wiki, true)
+      wabisabi = Qwik::TextParser.make_tree(tokens)
+      return wabisabi.flatten.select{|a| a.class == String}.join(" ")
+    end
+
+    def create_snippet(mds)
+      #sort as first hit keyword goes first
+      mds = mds.sort {|i, j| i.begin(0) <=> j.begin(0) }
+      max_width = 400
+
+      # merge snippets of each search key
+      #
+      #        snip[s,      e] 
+      #|============|1st key|=============|
+      snip = [mds[0].begin(0), mds[0].end(0)]
+
+      mds[1..-1].each {|md|
+        #|=====|1st key|==...==|last key|========|a key|===..===|
+        # snip[s,                      e]        ^
+	#                                        |md.begin(0)
+	#       <-------------------------.......----->
+	#                     max_width
+	#            this is the length of bytes, not characters
+	if md.begin(0) < snip[0] + max_width
+	  # extends snip end
+          # snip[s,                                     e]
+          #|====|1st key|==...==|last key|========|a key|===..===|
+	  snip[1] = md.end(0) 
+	end
+      }
+
+      #all md(MatchData) has same input string
+      all_string = mds[0].string
+
+      snippet = all_string[snip[0]...snip[1]]
+      len = snippet.mb_length # character length
+      rest = (max_width - len) / 2
+      if 0 < rest
+        # we have shot snippet, adding additional strings
+	pre = all_string[0...snip[0]]
+	post = all_string[snip[1]..-1]
+
+        if rest < pre.size
+	  pre = pre.mb_substring(-rest, pre.length)
+	end
+
+        if rest < post.size
+	  post = post.mb_substring(0, rest)
+	end
+	snippet = pre + snippet + post
+      end
+      
+      return snippet
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-common'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteSearch < Test::Unit::TestCase
+    include TestSession
+
+    def test_dummy
+    end
+
+    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.')
+
+      res = @site.search('test')
+      ok_eq([['1', 'This is a test.'],
+	      ['2', 'This is a test, too.']], res)
+
+      # test_obfuscate
+      page.store('user@example.com')
+      res = @site.search('@')
+      is [["2", "user@e..."]], res
+
+      res = @site.search('@', false)
+      is [["2", "user@example.com"]], res
+    end
+
+    def test_skip_sharp
+      page = @site.create_new
+      page.store('This is a test.')
+      page = @site.create_new
+      page.store('# This is a test start with sharp.')
+      page = @site.create_new
+      page.store("This is a test which have `#' in a middle of line.")
+      page = @site.create_new
+      page.store('This is a test, too.')
+
+      res = @site.search('test')
+      ok_eq([["1", "This is a test."],
+             ["3", "This is a test which have `# '  in a middle of line."],
+             ["4", "This is a test, too."]], res)
+    end
+
+  end
+end

data/vendor/qwik/site-timeline.rb

@@ -0,0 +1,153 @@
+# 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 last_modified
+      return self.map {|page|
+	page.mtime
+      }.max
+    end
+
+    # called from act-chronology
+    def timeline
+      @timeline = SiteTimeLine.new(self) unless defined? @timeline
+      return @timeline
+    end
+  end
+
+  class SiteTimeLine
+    def initialize(site)
+      @site = site
+      @times = nil
+      @days = nil
+      @site_min = nil
+      @site_max = nil
+      @page_min = nil
+      @page_max = nil
+      @pages_history = nil
+      @site_duration = nil
+      @site_last_modified = nil
+    end
+    attr_reader :times, :days
+    attr_reader :site_min, :site_max, :page_min, :page_max
+    attr_reader :pages_history, :site_duration
+
+    def calc_history
+      if_sites_update? {
+	@times, @days, @page_min, @page_max, @site_min, @site_max,
+	@pages_history, @site_duration = calc_history_internal(@site)
+      }
+    end
+
+    def if_sites_update?
+      # Check last update from pages
+      last_modified = @site.last_modified
+      return if last_modified.nil?	# No page.
+      if @site_last_modified.nil? || @site_last_modified < last_modified
+	yield
+      end
+      @site_last_modified = last_modified
+    end
+
+    def calc_history_internal(site)
+      keys = site.map {|page| page.key }
+      return nil if keys.empty?
+
+      times = Hash.new {|h, k| h[k] = []}
+      days = Hash.new {|h, k| h[k] = []}
+      site_min = nil	# FIXME: site_min should be cached.
+      site_max = nil
+      page_min = {}	# FIXME: page_min should be cached.
+      page_max = {}
+
+      site.backupdb.each {|key, v, time|
+	next if times[key].nil?	# Calc only for existing pages.
+	times[key] << time
+	days[time.ymd_s] << [key, time]
+	site_min = time if site_min.nil? || time < site_min
+	site_max = time if site_max.nil? || site_max < time
+	page_min[key] = time if page_min[key].nil? || time < page_min[key]
+	page_max[key] = time if page_max[key].nil? || page_max[key] < time
+      }
+
+      page_min_days = Hash.new {|h, k| h[k] = []}
+      page_min.each {|key, time|
+	page_min_days[time.ymd_s] << [key, time]
+	
+
+
+      }
+
+
+      # Calc history from older to newer.
+      pages_history = page_min.to_a.sort {|a, b|
+	a[1] <=> b[1]
+      }.map {|a|
+	a[0]
+      }
+
+      # Count second when the page is created to the last update.
+      site_max = Time.at(1) if site_max.nil?
+      site_min = Time.at(0) if site_min.nil?
+
+      site_duration = site_max - site_min
+
+      return times, days, page_min, page_max, site_min, site_max, pages_history, site_duration
+    end
+
+    def get_keys_by_day(ymd)
+      day = @days[ymd]
+      return nil if day.empty?
+      day = day.sort_by {|key, time| time }
+      keys = day.map {|key, time| key }.uniq
+      return keys
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-common'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteTimeLine < Test::Unit::TestCase
+    include TestSession
+
+    def test_all
+      page = @site.create_new
+      page.put_with_time('* t1', 0)	# store the first
+      page.put_with_time('* t2', 1)	# store the second
+
+      # test_last_modified
+      eq(1, @site.last_modified.to_i)
+
+      tl = @site.timeline
+
+      # test_calc_history
+      tl.calc_history
+      #pp tl
+
+      # test_times
+      times = tl.times
+      eq ['1'], times.keys
+      eq 0, times['1'][0].to_i
+      eq 1, times['1'][1].to_i
+
+      # test_days
+      days = tl.days
+      day = days['19700101']
+      eq [['1', Time.at(0)], ['1', Time.at(1)]], day
+
+      # test_site_min, page_min, pages_history, site_duration
+      eq Time.at(0), tl.site_min
+      eq({'1'=>Time.at(0)}, tl.page_min)
+      eq ['1'], tl.pages_history
+      assert(0 < tl.site_duration)
+    end
+  end
+end

data/vendor/qwik/site-url.rb

@@ -0,0 +1,189 @@
+# 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.
+
+require 'uri'
+
+$LOAD_PATH.unshift '..' unless $LOAD_PATH.include? '..'
+
+module Qwik
+  class Site
+    def host_url
+      host_url =  self.siteconfig['siteurl']
+      if ! host_url.nil? && host_url.empty?
+	host_url = @config.public_url
+      end
+      uri = URI(host_url)
+      uri.path = ""
+      return uri.to_s
+    end
+
+    def site_url
+      siteurl = self.siteconfig['siteurl']
+      return siteurl if ! siteurl.nil? && ! siteurl.empty?
+      return "#{@config.public_url}#{self.url_path}"
+    end
+
+    def page_url(k)
+      return "#{self.site_url}#{k}.html"
+    end
+
+    def url_path
+      siteurl = self.siteconfig['siteurl']
+      return '' if siteurl.nil?
+      return '' if ! siteurl.empty? || self.top_site?
+      return "#{@sitename}/"
+    end
+
+    def ml_address
+      siteml = self.siteconfig['siteml']
+      return siteml if ! siteml.nil? && ! siteml.empty?
+      return "#{@sitename}@#{@config.ml_domain}"
+    end
+
+    def title
+      sitetitle = self.siteconfig['sitename']
+      if ! sitetitle.nil? && sitetitle.empty?
+	return '' if @config.test
+	sitetitle = self.site_url.sub(%r|\Ahttp://|, "").sub(%r|/\z|, "")
+	#sitetitle = sitetitle.sub(%r|\Awww\.|, "")
+      end
+      return sitetitle
+    end
+
+    def get_page_title(pagename)
+      page = self[pagename]
+      return '' if page.nil?
+      page_title = page.get_title
+
+      sitetitle = self.title
+      if ! sitetitle.empty?
+	if self.siteconfig['page_title_first'] == 'true'
+	  return "#{page_title} - #{sitetitle}"
+	else
+	  return "#{sitetitle} - #{page_title}"
+	end
+      end
+
+      return page_title
+    end
+
+    def top_site?
+      return (@sitename == @config.default_sitename)
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-module-session'
+  require 'qwik/farm'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestSiteUrl < Test::Unit::TestCase
+    include TestSession
+
+    def test_url_test
+      site = @site
+      page = site.create_new
+      eq 'http://example.com', site.host_url
+      eq 'http://example.com/test/', site.site_url
+      eq 'http://example.com/test/1.html', site.page_url('1')
+      eq 'test@q.example.com', site.ml_address
+      t_without_testmode {
+	eq 'example.com/test', site.title
+	eq '1 - example.com/test', site.get_page_title('1')
+      }
+
+      siteconfig = site.create('_SiteConfig')
+      siteconfig.store(":sitename:t\n")
+      t_without_testmode {
+	eq 't', site.title
+	eq '1 - t', site.get_page_title('1')
+      }
+    end
+
+    def test_get_page_title
+      site = @site
+      page = site.create_new
+      t_without_testmode {
+	eq '1 - example.com/test', site.get_page_title('1')
+      }
+
+      siteconfig = site.create('_SiteConfig')
+      siteconfig.store(":page_title_first:true\n")
+      t_without_testmode {
+	eq '1 - example.com/test', site.get_page_title('1')
+      }
+
+      siteconfig.store(":page_title_first:false\n")
+      t_without_testmode {
+	eq 'example.com/test - 1', site.get_page_title('1')
+      }
+    end
+
+    def test_url_top_site
+      site = @memory.farm.get_top_site
+      page = site.create_new
+      eq true, site.top_site?
+      eq 'http://example.com', site.host_url
+      eq 'http://example.com/', site.site_url
+      eq 'http://example.com/1.html', site.page_url('1')
+      eq 'www@q.example.com', site.ml_address
+      t_without_testmode {
+	eq 'example.com', site.title
+	eq '1 - example.com', site.get_page_title('1')
+      }
+    end
+
+    def test_url_siteurl
+      page = @site.create_new
+      t_with_siteurl {
+	eq 'http://example.org', @site.host_url
+	eq 'http://example.org/q/', @site.site_url
+	eq 'http://example.org/q/1.html', @site.page_url('1')
+	eq 'test@q.example.com', @site.ml_address		# FIXME: Umm.
+	siteconfig = @site['_SiteConfig']
+	siteconfig.add(":siteml:info@example.org\n")
+	eq 'info@example.org', @site.ml_address
+	t_without_testmode {
+	  eq 'example.org/q', @site.title
+	  eq '1 - example.org/q', @site.get_page_title('1')
+	}
+      }
+    end
+
+    def test_https
+      site = @site
+      page = site.create_new
+      siteconfig = site.create('_SiteConfig')
+      siteconfig.store(":siteurl:https://example.net/\n")
+      eq 'https://example.net', site.host_url
+      eq 'https://example.net/', site.site_url
+      eq 'https://example.net/1.html', site.page_url('1')
+      eq 'test@q.example.com', site.ml_address		# FIXME: Umm.
+      siteconfig.add(":siteml:info@example.net\n")
+      eq 'info@example.net', site.ml_address
+      t_without_testmode {
+	eq 'https://example.net', site.title
+	eq '1 - https://example.net', site.get_page_title('1')
+      }
+    end
+
+    def test_url_example_org_with_path
+      t_with_path {
+	site = @site
+	page = site.create_new
+	eq 'http://www.example.org', site.host_url
+	eq 'http://www.example.org/qwik/test/', site.site_url
+	eq 'http://www.example.org/qwik/test/1.html', site.page_url('1')
+	eq 'test@q.example.com', site.ml_address
+	t_without_testmode {
+	  eq 'www.example.org/qwik/test', site.title
+	  eq '1 - www.example.org/qwik/test', site.get_page_title('1')
+	}
+      }
+    end
+  end
+end