ezmlm 1.0.0

data/lib/ezmlm/list/author.rb

@@ -0,0 +1,119 @@
+#!/usr/bin/ruby
+# vim: set nosta noet ts=4 sw=4:
+
+
+# A collection of messages authored from a unique user.
+#
+# Note that Ezmlm uses the "real name" part of an address
+# to identify an author.
+#
+#    author = Ezmlm::List::Author.new( list, 'acgcbmbmeapgpfckcdol' )
+#    author.name            #=> "Help - navigate on interface?"
+#    author.first.date.to_s #=> "2017-05-07T14:55:05-07:00"
+#
+#
+# == Version
+#
+#  $Id: author.rb,v 23c7f5c8ee39 2017/05/16 20:58:34 mahlon $
+#
+#---
+
+require 'pathname'
+require 'ezmlm' unless defined?( Ezmlm )
+
+
+### A collection of messages for a specific author.
+###
+class Ezmlm::List::Author
+	include Enumerable
+
+	### Instantiate a new list of messages given
+	### a +list+ and an +author_id+.
+	###
+	def initialize( list, author_id )
+		raise ArgumentError, "Unknown list object." unless list.respond_to?( :listdir )
+		raise ArgumentError, "Malformed Author ID." unless author_id =~ /^\w{20}$/
+		raise "Archiving is not enabled." unless list.archived?
+
+		@list     = list
+		@id       = author_id
+		@messages = nil
+
+		self.load_index
+	end
+
+
+	# The list object this message is stored in.
+	attr_reader :list
+
+	# The author's identifier.
+	attr_reader :id
+
+	# The author's name.
+	attr_reader :name
+
+	# An array of messages this author has sent.
+	attr_reader :messages
+
+	# An array of threads this author has participated in.
+	attr_reader :threads
+
+
+	### Enumerable API:  Lazy load each message ID as a
+	### Ezmlm::List::Message, yielding it to the block.
+	###
+	def each
+		self.load_index # refresh for any updates since object was created
+		self.messages.each do |id|
+			yield Ezmlm::List::Message.new( self.list, id )
+		end
+	end
+	alias_method :each_message, :each
+
+
+	### Lazy load each thread ID as a Ezmlm::List::Thread, yielding it to the block.
+	###
+	def each_thread
+		self.load_index # refresh for any updates since object was created
+		self.threads.each do |id|
+			yield Ezmlm::List::Thread.new( self.list, id )
+		end
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Parse the author index into an array of Messages.
+	###
+	def load_index
+		@messages = []
+		@threads  = []
+
+		path = self.author_path
+		raise "Unknown author: %p" % [ self.id ] unless path.exist?
+
+		path.open( 'r', encoding: Encoding::ISO8859_1 ) do |fh|
+			fh.each_line.with_index do |line, i|
+				if i.zero?
+					@name = line.match( /^\w+ (.+)/ )[1]
+				else
+					match = line.match( /^(\d+):\d+:(\w+) / ) or next
+					self.messages << match[1].to_i
+					self.threads  << match[2]
+				end
+			end
+		end
+	end
+
+
+	### Return the path on disk for the author index.
+	###
+	def author_path
+		prefix = self.id[ 0 ..  1 ]
+		hash   = self.id[ 2 .. -1 ]
+		return self.list.listdir + 'archive' + 'authors' + prefix + hash
+	end
+
+end # class Ezmlm::List::Author

data/lib/ezmlm/list/message.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/ruby
+# vim: set nosta noet ts=4 sw=4:
+
+
+# An individual list message.
+#
+#    message = Ezmlm::List::Message.new( list, 24 )
+#    message.thread    #=> (a thread object this message is part of)
+#    message.from      #=> ["jalon.hermann@example.com"]
+#    puts message.to_s #=> (raw email)
+#
+# This class passes all heavy lifting to the Mail::Message library.
+# Please see it for specifics on usage.
+#
+# == Version
+#
+#  $Id: message.rb,v 23c7f5c8ee39 2017/05/16 20:58:34 mahlon $
+#
+#---
+
+require 'pathname'
+require 'ezmlm' unless defined?( Ezmlm )
+require 'mail'
+
+
+### A Ruby interface to an individual list message.
+###
+class Ezmlm::List::Message
+
+	### Instantiate a new messag from a +list+ and a +message_number+.
+	###
+	def initialize( list, message_number=0 )
+		raise ArgumentError, "Unknown list object." unless list.respond_to?( :listdir )
+		raise ArgumentError, "Invalid message number (impossible)" if message_number < 1
+		raise "Archiving is not enabled." unless list.archived?
+		raise ArgumentError, "Invalid message number (out of list bounds)" if message_number > list.message_count
+
+		@list = list
+		@id   = message_number
+		@post = self.load_message
+	end
+
+
+	# The list object this message is stored in.
+	attr_reader :list
+
+	# The list message delivery identifier.
+	attr_reader :id
+
+	# The Mail::Message object for this post.
+	attr_reader :post
+
+
+	### Return the thread object this message is
+	### a member of.
+	###
+	def thread
+		unless @thread_id
+			idx = self.list.index
+			@thread_id = idx[ self.id - 1 ][ :thread ]
+		end
+
+		return Ezmlm::List::Thread.new( self.list, @thread_id )
+	end
+
+
+	### Return the author object this message is
+	### a member of.
+	###
+	def author
+		unless @author_id
+			idx = self.list.index
+			@author_id = idx[ self.id - 1 ][ :author ]
+		end
+
+		return Ezmlm::List::Author.new( self.list, @author_id )
+	end
+
+
+	### Render the message as a string.
+	###
+	def to_s
+		return self.post.to_s
+	end
+
+	### Provide implicit arrays (Mail::Message does not.)
+	###
+	def to_ary
+		return [ self.post ]
+	end
+
+
+	### Pass all unknown methods to the underlying Mail::Message object.
+	###
+	def method_missing( meth, *args )
+		return self.post.method( meth ).call( *args )
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Parse the message into a Mail::Message.
+	###
+	def load_message
+		path = self.message_path
+		raise "Unable to determine message path: %p" % [ path ] unless path.exist?
+		return Mail.read( path.to_s )
+	end
+
+
+	### Return the path on disk for the message.
+	###
+	def message_path
+		hashdir = self.id / 100
+		message = "%02d" % [ self.id % 100 ]
+		return self.list.listdir + 'archive' + hashdir.to_s + message.to_s
+	end
+
+end # class Ezmlm::List::Message

data/lib/ezmlm/list/thread.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/ruby
+# vim: set nosta noet ts=4 sw=4:
+
+
+# A collection of messages for a specific archive thread.
+#
+#    thread = Ezmlm::List::Thread.new( list, 'acgcbmbmeapgpfckcdol' )
+#    thread.subject         #=> "Help - navigate on interface?"
+#    thread.first.date.to_s #=> "2017-05-07T14:55:05-07:00"
+#
+#
+# == Version
+#
+#  $Id: thread.rb,v 23c7f5c8ee39 2017/05/16 20:58:34 mahlon $
+#
+#---
+
+require 'pathname'
+require 'ezmlm' unless defined?( Ezmlm )
+
+
+### A collection of messages for a specific archive thread.
+###
+class Ezmlm::List::Thread
+	include Enumerable
+
+	### Instantiate a new thread of messages given
+	### a +list+ and a +thread_id+.
+	###
+	def initialize( list, thread_id )
+		raise ArgumentError, "Unknown list object." unless list.respond_to?( :listdir )
+		raise ArgumentError, "Malformed Thread ID." unless thread_id =~ /^\w{20}$/
+		raise "Archiving is not enabled." unless list.archived?
+
+		@list     = list
+		@id       = thread_id
+		@subject  = nil
+		@messages = nil
+
+		self.load_thread
+	end
+
+
+	# The list object this message is stored in.
+	attr_reader :list
+
+	# The thread's identifier.
+	attr_reader :id
+
+	# The subject line of the thread.
+	attr_reader :subject
+
+	# An array of member messages.
+	attr_reader :messages
+
+	# An array of member authors.
+	attr_reader :authors
+
+
+	### Enumerable API:  Lazy load each message ID as a
+	### Ezmlm::List::Message, yielding it to the block.
+	###
+	def each
+		self.load_thread # refresh for any thread updates since object was created
+		self.messages.each do |id|
+			yield Ezmlm::List::Message.new( self.list, id )
+		end
+	end
+	alias_method :each_message, :each
+
+
+	### Lazy load each author ID as a Ezmlm::List::Author, yielding it
+	### to the block.
+	###
+	def each_author
+		self.load_thread # refresh for any thread updates since object was created
+		self.authors.each do |id|
+			yield Ezmlm::List::Author.new( self.list, id )
+		end
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Parse the subject index into an array of Messages.
+	###
+	def load_thread
+		@messages = []
+		@authors  = []
+		path = self.thread_path
+		raise "Unknown thread: %p" % [ self.id ] unless path.exist?
+
+		path.open( 'r', encoding: Encoding::ISO8859_1 ) do |fh|
+			fh.each_line.with_index do |line, i|
+				if i.zero?
+					@subject = line.match( /^\w+ (.+)/ )[1]
+				else
+					match = line.match( /^(\d+):\d+:(\w+) / ) or next
+					self.messages << match[1].to_i
+					self.authors  << match[2]
+				end
+			end
+		end
+	end
+
+
+	### Return the path on disk for the thread index.
+	###
+	def thread_path
+		prefix = self.id[ 0 ..  1 ]
+		hash   = self.id[ 2 .. -1 ]
+		return self.list.listdir + 'archive' + 'subjects' + prefix + hash
+	end
+
+end # class Ezmlm::List::Thread

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ezmlm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mahlon E. Smith <mahlon@martini.nu>
+- Michael Granger <ged@faeriemud.org>
+- Jeremiah Jordan <jeremiah.m.jordan@gmail.com>
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  This is a ruby interface for interacting with ezmlm-idx, an email list
+  manager for use with the Qmail MTA, and the messages contained therein.
+  (The -idx provides an extended feature set over the original ezmlm
+  environment.)
+email: mahlon@martini.nu
+executables: []
+extensions:
+- ext/ezmlm/hash/extconf.rb
+extra_rdoc_files: []
+files:
+- ext/ezmlm/hash/extconf.rb
+- ext/ezmlm/hash/hash.c
+- ext/ezmlm/hash/hash.h
+- lib/ezmlm.rb
+- lib/ezmlm/list.rb
+- lib/ezmlm/list/author.rb
+- lib/ezmlm/list/message.rb
+- lib/ezmlm/list/thread.rb
+homepage: https://bitbucket.org/mahlon/Ruby-Ezmlm
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Interact with Ezmlm-IDX mailing lists.
+test_files: []