qwikdoc 0.0.1

data/vendor/qwik/group-mail.rb

@@ -0,0 +1,195 @@
+#
+# Copyright (C) 2002-2004 Satoru Takabayashi <satoru@namazu.org> 
+# 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 General Public License version 2.
+#
+
+$LOAD_PATH.unshift '..' unless $LOAD_PATH.include? '..'
+require 'qwik/group'
+
+module QuickML
+  class Group
+    private
+
+    def rewrite_body (mail)
+      # body header
+      header = generate_header(@address, @added_members) if member_added?
+
+      # body footer
+      footer = generate_footer
+
+      if mail.multipart?
+	parts = mail.parts
+	sub_mail = Mail.new
+	sub_mail.read(parts.first)
+	cte = sub_mail['Content-Transfer-Encoding']
+	if sub_mail.content_type == 'text/plain' and cte.nil? or cte.empty? or cte =~ /^[78]bit$/
+	  sub_mail.body = header + sub_mail.body if header
+	  sub_mail.body += footer
+	end
+	parts[0] = sub_mail.to_s
+	mail.body = Mail.join_parts(parts, mail.boundary)
+	return mail.body
+      end
+
+      cte = mail['Content-Transfer-Encoding']
+      if mail.plain_text_body? and cte.nil? or cte.empty? or cte =~ /^[78]bit$/
+	mail.body = header + mail.body if header
+	mail.body += footer
+	return mail.body
+      end
+
+      return mail.body	# abandon
+    end
+
+    def generate_header(address, added_members)
+      header = "ML: #{address}\n"
+      header << generate_new_member_list(added_members)
+      header << "\n"
+      return header
+    end
+
+    def generate_new_member_list(added_members)
+      return added_members.map {|address|
+	_("New Member: %s\n", MailAddress.obfuscate(address))
+      }.join
+    end
+
+    def generate_footer(member_list_p = false)
+      pu = page_url
+      sf = site_footer
+
+      footer = ''
+      footer << "\n-- \n"
+      footer << _('archive')+"-> " + pu + " \n"
+      footer << "ML-> #{@address}\n"
+      if sf && ! sf.empty?
+	footer << "\n" + sf
+      end
+      if member_added?
+	footer << generate_unsubscribe_info(@address)
+      end
+      if member_added? || member_list_p
+	footer << "\n" + generate_member_list(@address, @members.list)
+      end
+      if total_file_size_exceeded?
+        footer << generate_total_file_size_exceeded_info
+      elsif total_file_size_reaching?
+        footer << generate_total_file_size_reaching_info
+      end
+      return footer
+    end
+
+    def generate_unsubscribe_info(address)
+      return "\n" +
+        _("How to unsubscribe from the ML:\n") +
+        _("- Just send an empty message to <%s>.\n", address) +
+        _("- Alternatively, if you cannot send an empty message for some reason,\n") +
+        _("  please send a message just saying 'unsubscribe' to <%s>.\n", address) +
+        _("  (e.g., hotmail's advertisement, signature, etc.)\n") #'
+    end
+
+    def generate_member_list(address, list)
+      return _("Members of <%s>:\n", address) + list + "\n"
+    end
+
+    def generate_total_file_size_exceeded_info
+        return "\n" + 
+	_('WARNING: Total attached file size exceeded.')  + " " +
+	_('Files are not attached on the web.') + "\n"
+    end
+
+    def generate_total_file_size_reaching_info
+	return "\n" +
+	_("WARNING: Total attached file size is reaching to the limit.") +
+	" "  +
+	_("%s left", (@config[:max_total_file_size] - @site.files_total).byte_format) +
+	"\n"
+    end
+    
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-module-ml'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestGroupMail < Test::Unit::TestCase
+    include TestModuleML
+
+    def setup_group
+      return QuickML::Group.new(@ml_config, 'test@example.com')
+    end
+
+    def test_all
+      group = setup_group
+
+      # test_generate_header
+      t_make_public(QuickML::Group, :generate_header)
+      ok_eq("ML: test@example.com\n\n",
+	    group.generate_header('test@example.com', []))
+      ok_eq("ML: test@example.com\nNew Member: user@e...\n\n",
+	    group.generate_header('test@example.com', ['user@example.net']))
+
+      # test_generate_footer
+      t_make_public(QuickML::Group, :generate_footer)
+      ok_eq("
+-- 
+archive-> http://example.com/test/ 
+ML-> test@example.com
+",
+	    group.generate_footer)
+
+      # test_generate_member_list
+      t_make_public(QuickML::Group, :generate_member_list)
+      ok_eq("Members of <test@example.com>:\nlist\n",
+	    group.generate_member_list('test@example.com', 'list'))
+
+      # test_generate_unsubscribe_info
+      t_make_public(QuickML::Group, :generate_unsubscribe_info)
+      ok_eq("\nHow to unsubscribe from the ML:\n- Just send an empty message to <test@example.com>.\n- Alternatively, if you cannot send an empty message for some reason,\n  please send a message just saying 'unsubscribe' to <test@example.com>.\n  (e.g., hotmail's advertisement, signature, etc.)\n",
+	    group.generate_unsubscribe_info('test@example.com'))
+
+    end
+
+    def test_footer_with_file_limits
+      group = setup_group
+
+      t_make_readable(QuickML::Group,:groupsite)
+      groupsite = group.groupsite
+
+      t_make_writable(QuickML::GroupSite,:total_file_size_exceeded)
+      t_make_writable(QuickML::GroupSite,:total_file_size_reaching)
+
+      # test if generate_footer generates warning message 
+      # when total file size exceeded
+      groupsite.total_file_size_exceeded = true
+      ok_eq("
+-- 
+archive-> http://example.com/test/ 
+ML-> test@example.com
+
+WARNING: Total attached file size exceeded. Files are not attached on the web.
+" , group.generate_footer)
+
+      # test if generate_footer generates warning message 
+      # when total file size reaching to the limit
+      groupsite.total_file_size_exceeded = false
+      groupsite.total_file_size_reaching = true
+      ok_eq("
+-- 
+archive-> http://example.com/test/ 
+ML-> test@example.com
+
+WARNING: Total attached file size is reaching to the limit. #{(@config[:max_total_file_size]-@site.files.total).byte_format} left
+", group.generate_footer)
+
+    end
+  end
+end

data/vendor/qwik/group-member.rb

@@ -0,0 +1,307 @@
+#
+# Copyright (C) 2002-2004 Satoru Takabayashi <satoru@namazu.org> 
+# 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 General Public License version 2.
+#
+
+$LOAD_PATH.unshift '..' unless $LOAD_PATH.include? '..'
+require 'qwik/group'
+
+module QuickML
+  class Group
+    def active_members_include?(address)
+      return @members.active_include?(address)
+    end
+
+    def former_members_include?(address)
+      return @members.former_include?(address)
+    end
+
+    def add_member (address)
+      if Group.exclude?(address, @config.ml_domain)
+	@logger.vlog "Excluded: #{address}"
+	return
+      end
+      return if @members.active_include?(address)	# Already included.
+      @members.add_member(address)
+      @added_members.push(address)
+      @logger.log "[#{@name}]: Add: #{address}"
+    end
+
+    def self.exclude?(address, config_domain)
+      name, domain = address.split('@')
+      return true if domain.nil?
+      return Mail.address_of_domain?(address, config_domain)
+    end
+
+    def remove_member (address)
+      return if ! @members.active_include?(address)
+      @members.remove_member(address)
+      @logger.log "[#{@name}]: Remove: #{address}"
+      close if @members.active_empty?
+    end
+
+    def add_error_member (address)
+      return if ! @members.active_include?(address)
+      prev_count = @members.error_count(address)
+      count = @members.inc_error_count(address)
+      if prev_count == count
+	@logger.log "[#{@name}]: AddError: #{address} (not counted)"
+      else
+	@logger.log "[#{@name}]: AddError: #{address} #{count}"
+      end
+      @members.save
+
+      if @group_config[:auto_unsubscribe_count] <= @members.error_count(address)
+	remove_member(address)
+	report_removed_member(address)
+      end
+    end
+
+    private
+
+    def reset_error_member (address)
+      return unless @members.error_include?(address)
+      @members.error_delete(address)
+      @logger.log "[#{@name}]: ResetError: #{address}"
+      @members.save
+    end
+
+    def init_members
+      @members = GroupMembers.new(@config, self, @db, @group_config)
+    end
+
+    def member_added?
+      return ! @added_members.empty?
+    end
+
+    def get_active_members
+      return @members.get_active
+    end
+  end
+
+  class GroupMembers
+    def initialize(config, group, db, group_config)
+      @config = config
+      @group = group
+      @db = db
+      @group_config = group_config
+
+      @active = IcaseArray.new
+      @former = IcaseArray.new
+      @error  = IcaseHash.new
+
+      load
+    end
+
+    def save
+      str = GroupMembers.generate(@active, @former, @error)
+      @db.put(:Members, str)
+    end
+
+    def add_member(address)
+      raise TooManyMembers if too_many?
+      former_delete(address)
+      active_push(address)
+      save
+    end
+
+    def remove_member(address)
+      active_delete(address)
+      former_push(address)
+      error_delete(address)
+      save
+    end
+
+    # active
+    def get_active
+      return @active
+    end
+    def active_empty?
+      return @active.empty?
+    end
+    def active_include?(address)
+      return @active.include?(address)
+    end
+    def active_push(address)
+      @active.push(address)
+    end
+    def active_delete(address)
+      @active.delete(address)
+    end
+
+    # former
+    def former_include?(address)
+      return @former.include?(address)
+    end
+    def former_push(address)
+      @former.push(address)
+    end
+    def former_delete(address)
+      @former.delete(address)
+    end
+
+    # error
+    def error_include?(address)
+      return @error.include?(address)
+    end
+    def error_delete(address)
+      @error.delete(address)
+    end
+
+    # Old methods.
+    def too_many?
+      return false if @group_config.unlimited?
+      return @group_config[:max_members] <= @active.length
+    end
+
+    def list
+      return @active.map {|x| MailAddress.obfuscate(x) }.join("\n")
+    end
+
+    def inc_error_count (address)
+      if ! @error.include?(address)
+	@error[address] = ErrorInfo.new
+      end
+      if ! allowable_error_interval?(@error[address].last_error_time)
+	@error[address].inc_count
+      end
+      @error[address].count
+    end
+
+    def error_count (address)
+      return @error[address].count if @error.include?(address)
+      return 0
+    end
+
+    private
+
+    def load
+      content = @db.get(:Members) || ''
+      GroupMembers.parse(@active, @former, @error, content)
+    end
+
+    def self.parse(active, former, error, content)
+      content.each {|line| 
+	line.chomp!
+	next if line.empty?
+	if /^# (.*)/ =~ line	# removed address
+	  former.push($1) if ! former.include?($1)
+	elsif /^; (.*?) (\d+)(?: (\d+))?/ =~ line
+	  address = $1
+	  count= $2.to_i
+	  last_error_time = if $3 then Time.at($3.to_i) else Time.at(0) end
+	  error[address]= ErrorInfo.new(count, last_error_time)
+	else
+	  active.push(line) if ! active.include?(line)
+	end
+      }
+    end
+
+    def self.generate(active, former, error)
+      c = ''
+      active.each {|address| c << address+"\n" }
+      former.each {|address| c << "# "+address+"\n" }
+      error.each {|address, error_info|
+	t = error_info.last_error_time.to_i
+	c << "; #{address} #{error_info.count} #{t}\n"
+      }
+      return c
+    end
+
+    def allowable_error_interval? (time)
+      now  = Time.now
+      past = now - @config.allowable_error_interval
+      return past < time && time <= now
+    end
+  end
+
+  class ErrorInfo
+    def initialize (count = 0, last_error_time = Time.at(0))
+      @count = count
+      @last_error_time = last_error_time
+    end
+    attr_reader :count
+    attr_reader :last_error_time
+
+    def inc_count
+      @count += 1
+      t = Time.now
+      t = Time.at(0) if defined?($test) && $test
+      @last_error_time = t
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'qwik/test-module-ml'
+  $test = true
+end
+
+if defined?($test) && $test
+  class TestGroup_members < Test::Unit::TestCase
+    include TestModuleML
+
+    def setup_group
+      return QuickML::Group.new(@ml_config, 'test@example.com')
+    end
+
+    def test_class_method
+      c = QuickML::Group
+
+      # test_exclude?
+      ok_eq(true, c.exclude?('user', 'example.net'))
+      ok_eq(true,  c.exclude?('user@example.net', 'example.net'))
+      ok_eq(false, c.exclude?('user@example.com', 'example.net'))
+    end
+
+  end
+
+  class TestGroupMembers < Test::Unit::TestCase
+    include TestModuleML
+
+    def setup_group
+      return QuickML::Group.new(@ml_config, 'test@example.com')
+    end
+
+    def test_class_method
+      c = QuickML::GroupMembers
+
+      # test_generate
+      ok_eq('', c.generate([], [], []))
+
+      # test_parse
+      active, former, error = [], [], []
+      c.parse(active, former, error, "\n")
+      eq([[], [], []], [active, former, error])
+    end
+
+    def test_all
+      group = setup_group	# init_members is already called here.
+
+      t_make_readable(QuickML::Group, :members)
+      members = group.members
+
+      members.save
+
+      t_make_readable(QuickML::Group, :db)
+      ok_eq(true, group.db.exist?(:Members))
+      ok_eq('', group.db.get(:Members))
+
+      group.add_member('user@e.com')
+      str = group.db.get(:Members)
+      ok_eq("user@e.com\n", str)
+
+      group.add_error_member('user@e.com')
+      str = group.db.get(:Members)
+      ok_eq("user@e.com\n; user@e.com 1 0\n", str)
+
+      ok_eq(true, group.db.exist?(:Members))
+      group.remove_member('user@e.com')
+    end
+  end
+end