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

equal deleted inserted replaced

-:e135ccae6783
+:23c7f5c8ee39
 #!/usr/bin/ruby
 # vim: set nosta noet ts=4 sw=4:
+# A Ruby interface to a single Ezmlm-idx mailing list directory.
 #
-# A Ruby interface to a single Ezmlm-idx mailing list directory.
+#    list = Ezmlm::List.new( '/path/to/listdir' )
+#
 #
 # == Version
 #
 #  $Id$
 #
 	### Create a new Ezmlm::List object for the specified +listdir+, which should be
 	### an ezmlm-idx mailing list directory.
 	###
 	def initialize( listdir )
 		listdir = Pathname.new( listdir ) unless listdir.is_a?( Pathname )
+		unless listdir.directory? && ( listdir + 'mailinglist' ).exist?
+			raise ArgumentError, "%p doesn't appear to be an ezmlm-idx list." % [ listdir.to_s ]
+		end
 		@listdir = listdir
 	end
 	# The Pathname object for the list directory
 	attr_reader :listdir
 	def remove_allowed( *addr )
 		return self.unsubscribe( *addr, section: 'allow' )
 	end
-	### Returns +true+ if message threading is enabled.
-	###
-	def threaded?
-		return ( self.listdir + 'threaded' ).exist?
-	end
-	### Disable or enable message threading.
-	###
-	### This automatically builds message indexes and thread
-	### information on an incoming message.
-	###
-	def threaded=( enable=true )
-		if enable
-			self.touch( 'threaded' )
-		else
-			self.unlink( 'threaded' )
-		end
-	end
-	alias_method :threaded, :threaded=
 	### Returns +true+ if the list is configured to respond
 	### to remote management requests.
 	###
 	def public?
 		return ( self.listdir + 'public' ).exist?
 	### Returns +true+ if message archival is enabled.
 	###
 	def archived?
-		return ( self.listdir + 'archived' ).exist? || ( self.listdir + 'indexed' ).exist?
+		test = %w[ archived indexed threaded ].each_with_object( [] ) do |f, acc|
-	end
+			acc << self.listdir + f
+		end
-	### Disable or enable message archiving (and indexing.)
-	###
+		return test.all?( &:exist? )
-	def archive=( enable=true )
+	end
-		if enable
-			self.touch( 'archived' )
+	### Disable or enable message archiving (and indexing/threading.)
-			self.touch( 'indexed' )
+	###
-		else
+	def archived=( enable=true )
-			self.unlink( 'archived' )
+		if enable
-			self.unlink( 'indexed' )
+			self.touch( 'archived', 'indexed', 'threaded' )
-		end
+		else
-	end
+			self.unlink( 'archived', 'indexed', 'threaded' )
-	alias_method :archive, :archive=
+		end
+	end
+	alias_method :archived, :archived=
 	### Returns +true+ if the message archive is accessible only to
 	### moderators.
 	###
 	def private_archive?
 	end
 	### Returns an individual message if archiving was enabled.
 	###
 	def message( message_id )
-		raise "Archiving is not enabled." unless self.archived?
 		raise "Message archive is empty." if self.message_count.zero?
-		return Ezmlm::List::Message.new( self, message_id )
+		return Ezmlm::List::Message.new( self, message_id ) rescue nil
 	end
 	### Lazy load each message ID as a Ezmlm::List::Message,
 	### yielding it to the block.
 	###
 	### 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 ) rescue nil
-		return Ezmlm::List::Thread.new( self, thread_id )
 	end
 	### Return an Author object for the given +author_id+, which
 	### could also be an email address.
 	###
 	def author( author_id )
-		raise "Archiving is not enabled." unless self.archived?
 		author_id = Ezmlm::Hash.address(author_id) if author_id.index( '@' )
-		return Ezmlm::List::Author.new( self, author_id )
+		return Ezmlm::List::Author.new( self, author_id ) rescue nil
 	end
 	### Parse all thread indexes into a single array that can be used
 	### as a lookup table.
 		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|
+			index.open( 'r', encoding: Encoding::ISO8859_1 ) do |fh|
-				match = message[0].match( /^(?<message_id>\d+): (?<thread_id>\w+)/ )
+				fh.each_line.lazy.slice_before( /^\d+:/ ).each do |message|
-				next unless match
-				thread_id  = match[ :thread_id ]
+					match = message[0].match( /^(?<message_id>\d+): (?<thread_id>\w+)/ )
+					next unless match
-				match = message[1].match( /^(?<date>[^;]+);(?<author_id>\w+) / )
+					thread_id  = match[ :thread_id ]
-				next unless match
-				author_id  = match[ :author_id ]
+					match = message[1].match( /^(?<date>[^;]+);(?<author_id>\w+) / )
-				date       = match[ :date ]
+					next unless match
+					author_id  = match[ :author_id ]
-				metadata = {
+					date       = match[ :date ]
-					date:   Time.parse( date ),
-					thread: thread_id,
+					metadata = {
-					author: author_id
+						date:   Time.parse( date ),
-				}
+						thread: thread_id,
-				acc << metadata
+						author: author_id
+					}
+					acc << metadata
+				end
 			end
 		end
 		return idx
 	end
 	end
 	### Simply create an empty file, safely.
 	###
-	def touch( file )
+	def touch( *file )
-		self.write( file ) {}
+		self.with_safety do
+			Array( file ).flatten.each do |f|
+				f = self.listdir + f unless f.is_a?( Pathname )
+				f.open( 'w' ) {}
+			end
+		end
 	end
 	### Delete +file+ safely.
 	###
-	def unlink( file )
+	def unlink( *file )
-		file = self.listdir + file unless file.is_a?( Pathname )
-		return unless file.exist?
 		self.with_safety do
-			file.unlink
+			Array( file ).flatten.each do |f|
+				f = self.listdir + f unless f.is_a?( Pathname )
+				next unless f.exist?
+				f.unlink
+			end
 		end
 	end
 	### Return a Pathname to a subscription directory.

changeset 17	23c7f5c8ee39
parent 16	e135ccae6783
child 20	9d59d30685cb