ruby-ezmlm: comparison lib/ezmlm/list.rb

equal deleted inserted replaced

-:cba9fb39bcdb
+:a38e6916504c
 #  $Id$
 #
 #---
 require 'pathname'
+require 'time'
 require 'etc'
-require 'ezmlm'
+require 'ezmlm' unless defined?( Ezmlm )
-require 'mail'
 ### A Ruby interface to an ezmlm-idx mailing list directory
 ###
 class Ezmlm::List
 	# Quick address space detection, to (hopefully)
 	# match the overflow size on this machine.
-	#
+	ADDRESS_SPACE = [ 'i' ].pack( 'p' ).size * 8
-	ADDRESS_SPACE = case [ 'i' ].pack( 'p' ).size
-					when 4
-						32
-					when 8
-						64
-					end
 	# Valid subdirectories/sections for subscriptions.
 	SUBSCRIPTION_DIRS = %w[ deny mod digest allow ]
 			self.touch( 'threaded' )
 		else
 			self.unlink( 'threaded' )
 		end
 	end
+	alias_method :threaded, :threaded=
 	### Returns +true+ if the list is configured to respond
-	### to remote mangement requests.
+	### to remote management requests.
 	###
 	def public?
 		return ( self.listdir + 'public' ).exist?
 	end
 			self.touch( 'public' )
 		else
 			self.unlink( 'public' )
 		end
 	end
+	alias_method :public, :public=
 	### Returns +true+ if the list is not configured to respond
-	### to remote mangement requests.
+	### to remote management requests.
 	###
 	def private?
 		return ! self.public?
 	end
 	### Disable or enable remote management requests.
 	###
 	def private=( enable=false )
 		self.public = ! enable
 	end
+	alias_method :private, :private=
 	### Returns +true+ if the list supports remote administration
 	### subscribe/unsubscribe requests from moderators.
 	###
 			self.touch( 'remote' )
 		else
 			self.unlink( 'remote' )
 		end
 	end
+	alias_method :remote_subscriptions, :remote_subscriptions=
 	### Returns +true+ if list subscription requests require moderator
 	### approval.
 	###
 			self.touch( 'modsub' )
 		else
 			self.unlink( 'modsub' )
 		end
 	end
+	alias_method :moderated_subscriptions, :moderated_subscriptions=
 	### Returns +true+ if message moderation is enabled.
 	###
 	def moderated?
 		return ( self.listdir + 'modpost' ).exist?
 	end
 	### Disable or enable message moderation.
 	###
-	### This has special meaning when combined with user_post_only setting.
+	### This has special meaning when combined with user_posts_only setting.
 	### Lists act as unmoderated for subscribers, and posts from unknown
 	### addresses go to moderation.
 	###
 	def moderated=( enable=false )
 		if enable
 		else
 			self.unlink( 'modpost' )
 			self.unlink( 'noreturnposts' ) if self.user_posts_only?
 		end
 	end
+	alias_method :moderated, :moderated=
 	### Returns +true+ if posting is only allowed by moderators.
 	###
 	def moderator_posts_only?
 			self.touch( 'modpostonly' )
 		else
 			self.unlink( 'modpostonly' )
 		end
 	end
+	alias_method :moderator_posts_only, :moderator_posts_only=
 	### Returns +true+ if posting is only allowed by subscribers.
 	###
 	def user_posts_only?
 		else
 			self.unlink( 'subpostonly' )
 			self.unlink( 'noreturnposts' ) if self.moderated?
 		end
 	end
+	alias_method :user_posts_only, :user_posts_only=
 	### Returns +true+ if message archival is enabled.
 	###
 	def archived?
 		else
 			self.unlink( 'archived' )
 			self.unlink( 'indexed' )
 		end
 	end
+	alias_method :archive, :archive=
 	### Returns +true+ if the message archive is accessible only to
 	### moderators.
 	###
 	def private_archive?
 			self.touch( 'modgetonly' )
 		else
 			self.unlink( 'modgetonly' )
 		end
 	end
+	alias_method :private_archive, :private_archive=
 	### Returns +true+ if the message archive is accessible to anyone.
 	###
 	def public_archive?
 		return ! self.private_archive?
 	end
+	### Disable or enable private access to the archive.
+	###
+	def public_archive=( enable=true )
+		self.private_archive = ! enable
+	end
+	alias_method :public_archive, :public_archive=
 	### Returns +true+ if the message archive is accessible only to
 	### list subscribers.
 	###
 	def guarded_archive?
 		return ( self.listdir + 'subgetonly' ).exist?
 			self.touch( 'subgetonly' )
 		else
 			self.unlink( 'subgetonly' )
 		end
 	end
+	alias_method :guarded_archive, :guarded_archive=
 	### Returns +true+ if message digests are enabled.
 	###
 	def digested?
 			self.touch( 'digested' )
 		else
 			self.unlink( 'digested' )
 		end
 	end
+	alias_method :digest, :digest=
 	### If the list is digestable, trigger the digest after this amount
 	### of message body since the latest digest, in kbytes.
 	###
 	### See: ezmlm-tstdig(1)
 			self.unlink( 'nosubconfirm' )
 		else
 			self.touch( 'nosubconfirm' )
 		end
 	end
+	alias_method :confirm_subscriptions, :confirm_subscriptions=
 	### Returns +true+ if the list requires unsubscriptions to be
 	### confirmed.  AKA "jump" mode.
 	###
 	def confirm_unsubscriptions?
 			self.unlink( 'nounsubconfirm' )
 		else
 			self.touch( 'nounsubconfirm' )
 		end
 	end
+	alias_method :confirm_unsubscriptions, :confirm_unsubscriptions=
 	### Returns +true+ if the list requires regular message postings
 	### to be confirmed by the original sender.
 	###
 			self.touch( 'confirmpost' )
 		else
 			self.unlink( 'confirmpost' )
 		end
 	end
+	alias_method :confirm_postings, :confirm_postings=
 	### Returns +true+ if the list allows moderators to
 	### fetch a subscriber list remotely.
 	###
 			self.touch( 'modcanlist' )
 		else
 			self.unlink( 'modcanlist' )
 		end
 	end
+	alias_method :allow_remote_listing, :allow_remote_listing=
 	### Returns +true+ if the list automatically manages
 	### bouncing subscriber addresses.
 	###
 			self.unlink( 'nowarn' )
 		else
 			self.touch( 'nowarn' )
 		end
 	end
+	alias_method :bounce_warnings, :bounce_warnings=
 	### Return the maximum message size, in bytes.  Messages larger than
 	### this size will be rejected.
 	###
 		size = self.read( 'msgsize' )
 		return size ? size.split( ':' ).first.to_i : 0
 	end
 	### Set the maximum message size, in bytes.  Messages larger than
-	### this size will be rejected.
+	### this size will be rejected.  Defaults to 300kb.
 	###
 	### See: ezmlm-reject(1)
 	###
 	def maximum_message_size=( size=307200 )
 		if size.to_i.zero?
 			self.write( 'msgsize' ) {|f| f.puts "#{size.to_i}:0" }
 		end
 	end
 	### Return the number of messages in the list archive.
 	###
 	def message_count
 		count = self.read( 'archnum' )
 		return count ? Integer( count ) : 0
 	end
-	### Returns the last message to the list as a Mail::Message, if
+	### Returns an individual message if archiving was enabled.
-	### archiving was enabled.
+	###
-	###
+	def message( message_id )
-	def last_post
+		raise "Archiving is not enabled." unless self.archived?
-		num = self.message_count
+		raise "Message archive is empty." if self.message_count.zero?
-		return if num.zero?
+		return Ezmlm::List::Message.new( self, message_id )
+	end
-		hashdir = num / 100
-		message = "%02d" % [ num % 100 ]
+	### Lazy load each message ID as a Ezmlm::List::Message,
+	### yielding it to the block.
-		post = self.listdir + 'archive' + hashdir.to_s + message.to_s
+	###
-		return unless post.exist?
+	def each_message
+		( 1 .. self.message_count ).each do |id|
-		return Mail.read( post.to_s )
+			yield self.message( id )
+		end
+	end
+	### Return a Thread object for the given +thread_id+.
+	###
+	def thread( thread_id )
+		raise "Archiving is not enabled." unless self.archived?
+		return Ezmlm::List::Thread.new( self, thread_id )
+	end
+	### Return an Author object for the given +author_id+.
+	###
+	def author( author_id )
+		raise "Archiving is not enabled." unless self.archived?
+		return Ezmlm::List::Author.new( self, author_id )
+	end
+	### Parse all thread indexes into a single array that can be used
+	### as a lookup table.
+	###
+	### These are not expanded into objects, use #message, #thread,
+	### and #author to do so.
+	###
+	def index
+		raise "Archiving is not enabled." unless self.archived?
+		archivedir = listdir + 'archive'
+		idx = ( 0 .. self.message_count / 100 ).each_with_object( [] ) do |dir, acc|
+			index = archivedir + dir.to_s + 'index'
+			next unless index.exist?
+			index.each_line.lazy.slice_before( /^\d+:/ ).each do |message|
+				match = message[0].match( /^(?<message_id>\d+): (?<thread_id>\w+)/ )
+				next unless match
+				thread_id  = match[ :thread_id ]
+				match = message[1].match( /^(?<date>[^;]+);(?<author_id>\w+) / )
+				next unless match
+				author_id  = match[ :author_id ]
+				date       = match[ :date ]
+				metadata = {
+					date:   Time.parse( date ),
+					thread: thread_id,
+					author: author_id
+				}
+				acc << metadata
+			end
+		end
+		return idx
 	end
 	#########
 	protected
 	###
 	def subhash( addr )
 		h = 5381
 		over = 2 ** ADDRESS_SPACE
-		addr = 'T' + addr
+		addr = 'T' + addr.downcase
 		addr.each_char do |c|
 			h = ( h + ( h << 5 ) ) ^ c.ord
 			h = h % over if h > over # emulate integer overflow
 		end
 		return h % 53
 	end
-	### Given an email address, return the ascii character.
+	### Given an email address, return the ascii hash prefix.
 	###
 	def hashchar( addr )
 		return ( self.subhash(addr) + 64 ).chr
 	end

changeset 15	a38e6916504c
parent 14	cba9fb39bcdb
child 16	e135ccae6783