sugoi-mail 0.0.0

data/db/schema.postgresql.sql

@@ -0,0 +1,104 @@
+-- This file is autogenerated by the Rail schema generator, using
+-- the schema defined in db/migration/*.rb
+--
+-- Do not edit this file.  Instead, add a new migration using
+-- ./script/generate migration <name>, and then run
+-- ./script/generate schema
+
+-- tables 
+
+CREATE TABLE addresses (
+  "id" serial primary key,
+  "address" text,
+  "active" boolean DEFAULT 't',
+  "delivery_attempts" integer DEFAULT 0,
+  "bounces" integer DEFAULT 0
+);
+
+CREATE TABLE addresses_mailinglists (
+  "address_id" integer,
+  "mailinglist_id" integer
+);
+
+CREATE TABLE admin_messages (
+  "id" serial primary key,
+  "message" text NOT NULL
+);
+
+CREATE TABLE confirmationcodes (
+  "id" serial primary key,
+  "mailinglist_id" integer,
+  "address_id" integer,
+  "code" text NOT NULL,
+  "confirmed" boolean DEFAULT 'f'
+);
+
+CREATE TABLE domains (
+  "id" serial primary key,
+  "name" character varying(255) NOT NULL,
+  "password" text NOT NULL
+);
+
+CREATE TABLE mailinglist_classes (
+  "id" serial primary key,
+  "name" text NOT NULL,
+  "description" text,
+  "public" boolean DEFAULT 'f' NOT NULL,
+  "closed" boolean DEFAULT 'f' NOT NULL,
+  "moderated" boolean DEFAULT 'f' NOT NULL,
+  "confirmation" boolean DEFAULT 't' NOT NULL,
+  "joinable" boolean DEFAULT 't' NOT NULL,
+  "archived" boolean DEFAULT 'f',
+  "proxify" boolean DEFAULT 'f'
+);
+
+CREATE TABLE mailinglists (
+  "id" serial primary key,
+  "user_id" integer,
+  "name" text NOT NULL,
+  "description" text,
+  "welcome_admin_message_id" integer DEFAULT 1,
+  "confirmed_admin_message_id" integer DEFAULT 2,
+  "sayonara_admin_message_id" integer DEFAULT 3,
+  "mailinglist_class_id" integer
+);
+
+CREATE TABLE messages (
+  "id" serial primary key,
+  "mailinglist_id" integer,
+  "address_id" integer,
+  "parent_id" integer,
+  "subject" character varying(255),
+  "messageid" character varying(255),
+  "timestamp" timestamp,
+  "headers" text,
+  "body" text,
+  "envelope_from" text,
+  "envelope_to" text
+);
+
+CREATE TABLE proxy_links (
+  "id" serial primary key,
+  "mailinglist_id" integer NOT NULL,
+  "address_id" integer NOT NULL
+);
+
+CREATE TABLE users (
+  "id" serial primary key,
+  "login" text NOT NULL,
+  "password" text NOT NULL,
+  "mailinglist_id" integer,
+  "domainadmin" boolean DEFAULT 'f',
+  "domain_id" integer,
+  "mailinglistadmin" boolean DEFAULT 'f',
+  "virtual" boolean DEFAULT 'f'
+);
+
+
+-- schema version meta-info 
+
+CREATE TABLE schema_info (
+  "version" integer
+);
+
+insert into schema_info (version) values (25);

data/db/schema.rb

@@ -0,0 +1,85 @@
+# This file is autogenerated. Instead of editing this file, please use the
+# migrations feature of ActiveRecord to incrementally modify your database, and
+# then regenerate this schema definition.
+
+ActiveRecord::Schema.define(:version => 25) do
+
+  create_table "addresses", :force => true do |t|
+    t.column "address", :text
+    t.column "active", :boolean, :default => true
+    t.column "delivery_attempts", :integer, :default => 0
+    t.column "bounces", :integer, :default => 0
+  end
+
+  create_table "addresses_mailinglists", :id => false, :force => true do |t|
+    t.column "address_id", :integer
+    t.column "mailinglist_id", :integer
+  end
+
+  create_table "admin_messages", :force => true do |t|
+    t.column "message", :text, :null => false
+  end
+
+  create_table "confirmationcodes", :force => true do |t|
+    t.column "mailinglist_id", :integer
+    t.column "address_id", :integer
+    t.column "code", :text, :null => false
+    t.column "confirmed", :boolean, :default => false
+  end
+
+  create_table "domains", :force => true do |t|
+    t.column "name", :string, :null => false
+    t.column "password", :text, :null => false
+  end
+
+  create_table "mailinglist_classes", :force => true do |t|
+    t.column "name", :text, :null => false
+    t.column "description", :text
+    t.column "public", :boolean, :default => false, :null => false
+    t.column "closed", :boolean, :default => false, :null => false
+    t.column "moderated", :boolean, :default => false, :null => false
+    t.column "confirmation", :boolean, :default => true, :null => false
+    t.column "joinable", :boolean, :default => true, :null => false
+    t.column "archived", :boolean, :default => false, :null => false
+    t.column "proxify", :boolean, :default => false
+  end
+
+  create_table "mailinglists", :force => true do |t|
+    t.column "user_id", :integer
+    t.column "name", :text, :null => false
+    t.column "description", :text
+    t.column "welcome_admin_message_id", :integer, :default => 1
+    t.column "confirmed_admin_message_id", :integer, :default => 2
+    t.column "sayonara_admin_message_id", :integer, :default => 3
+    t.column "mailinglist_class_id", :integer
+  end
+
+  create_table "messages", :force => true do |t|
+    t.column "mailinglist_id", :integer
+    t.column "address_id", :integer
+    t.column "parent_id", :integer
+    t.column "subject", :string
+    t.column "messageid", :string
+    t.column "timestamp", :datetime
+    t.column "headers", :text
+    t.column "body", :text
+    t.column "envelope_from", :text
+    t.column "envelope_to", :text
+  end
+
+  create_table "proxy_links", :force => true do |t|
+    t.column "mailinglist_id", :integer, :null => false
+    t.column "address_id", :integer, :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.column "login", :text, :null => false
+    t.column "password", :text, :null => false
+    t.column "mailinglist_id", :integer
+    t.column "domainadmin", :boolean, :default => false
+    t.column "domain_id", :integer
+    t.column "mailinglistadmin", :boolean, :default => false
+    t.column "virtual", :boolean, :default => false
+  end
+
+end

data/db/schema.sqlite.sql

@@ -0,0 +1,104 @@
+-- This file is autogenerated by the Rail schema generator, using
+-- the schema defined in db/migration/*.rb
+--
+-- Do not edit this file.  Instead, add a new migration using
+-- ./script/generate migration <name>, and then run
+-- ./script/generate schema
+
+-- tables 
+
+CREATE TABLE addresses (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "address" text,
+  "active" boolean DEFAULT 't',
+  "delivery_attempts" integer DEFAULT 0,
+  "bounces" integer DEFAULT 0
+);
+
+CREATE TABLE addresses_mailinglists (
+  "address_id" integer,
+  "mailinglist_id" integer
+);
+
+CREATE TABLE admin_messages (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "message" text NOT NULL
+);
+
+CREATE TABLE confirmationcodes (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "mailinglist_id" integer,
+  "address_id" integer,
+  "code" text NOT NULL,
+  "confirmed" boolean DEFAULT 'f'
+);
+
+CREATE TABLE domains (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "name" varchar(255) NOT NULL,
+  "password" text NOT NULL
+);
+
+CREATE TABLE mailinglist_classes (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "name" text NOT NULL,
+  "description" text,
+  "public" boolean DEFAULT 'f' NOT NULL,
+  "closed" boolean DEFAULT 'f' NOT NULL,
+  "moderated" boolean DEFAULT 'f' NOT NULL,
+  "confirmation" boolean DEFAULT 't' NOT NULL,
+  "joinable" boolean DEFAULT 't' NOT NULL,
+  "archived" boolean DEFAULT 'f',
+  "proxify" boolean DEFAULT 'f'
+);
+
+CREATE TABLE mailinglists (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "user_id" integer,
+  "name" text NOT NULL,
+  "description" text,
+  "welcome_admin_message_id" integer DEFAULT 1,
+  "confirmed_admin_message_id" integer DEFAULT 2,
+  "sayonara_admin_message_id" integer DEFAULT 3,
+  "mailinglist_class_id" integer
+);
+
+CREATE TABLE messages (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "mailinglist_id" integer,
+  "address_id" integer,
+  "parent_id" integer,
+  "subject" varchar(255),
+  "messageid" varchar(255),
+  "timestamp" datetime,
+  "headers" text,
+  "body" text,
+  "envelope_from" text,
+  "envelope_to" text
+);
+
+CREATE TABLE proxy_links (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "mailinglist_id" integer NOT NULL,
+  "address_id" integer NOT NULL
+);
+
+CREATE TABLE users (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "login" text NOT NULL,
+  "password" text NOT NULL,
+  "mailinglist_id" integer,
+  "domainadmin" boolean DEFAULT 'f',
+  "domain_id" integer,
+  "mailinglistadmin" boolean DEFAULT 'f',
+  "virtual" boolean DEFAULT 'f'
+);
+
+
+-- schema version meta-info 
+
+CREATE TABLE schema_info (
+  "version" integer
+);
+
+insert into schema_info (version) values (25);

data/db/schema.sqlserver.sql

@@ -0,0 +1,113 @@
+-- This file is autogenerated by the Rail schema generator, using
+-- the schema defined in db/migration/*.rb
+--
+-- Do not edit this file.  Instead, add a new migration using
+-- ./script/generate migration <name>, and then run
+-- ./script/generate schema
+
+-- tables 
+
+CREATE TABLE addresses (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [address] text,
+  [active] bit DEFAULT 1,
+  [delivery_attempts] int DEFAULT 0,
+  [bounces] int DEFAULT 0
+);
+
+CREATE TABLE addresses_mailinglists (
+  [address_id] int,
+  [mailinglist_id] int
+);
+
+CREATE TABLE admin_messages (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [message] text NOT NULL
+);
+
+CREATE TABLE confirmationcodes (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [mailinglist_id] int,
+  [address_id] int,
+  [code] text NOT NULL,
+  [confirmed] bit DEFAULT 0
+);
+
+CREATE TABLE domains (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [name] varchar(255) NOT NULL,
+  [password] text NOT NULL
+);
+
+CREATE TABLE mailinglist_classes (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [name] text NOT NULL,
+  [description] text,
+  [public] bit DEFAULT 0 NOT NULL,
+  [closed] bit DEFAULT 0 NOT NULL,
+  [moderated] bit DEFAULT 0 NOT NULL,
+  [confirmation] bit DEFAULT 1 NOT NULL,
+  [joinable] bit DEFAULT 1 NOT NULL,
+  [archived] bit DEFAULT 0,
+  [proxify] bit DEFAULT 0
+);
+
+CREATE TABLE mailinglists (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [user_id] int,
+  [name] text NOT NULL,
+  [description] text,
+  [welcome_admin_message_id] int DEFAULT 1,
+  [confirmed_admin_message_id] int DEFAULT 2,
+  [sayonara_admin_message_id] int DEFAULT 3,
+  [mailinglist_class_id] int
+);
+
+CREATE TABLE messages (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [mailinglist_id] int,
+  [address_id] int,
+  [parent_id] int,
+  [subject] varchar(255),
+  [messageid] varchar(255),
+  [timestamp] datetime,
+  [headers] text,
+  [body] text,
+  [envelope_from] text,
+  [envelope_to] text
+);
+
+CREATE TABLE proxy_links (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [mailinglist_id] int NOT NULL,
+  [address_id] int NOT NULL
+);
+
+CREATE TABLE users (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [login] text NOT NULL,
+  [password] text NOT NULL,
+  [mailinglist_id] int,
+  [domainadmin] bit DEFAULT 0,
+  [domain_id] int,
+  [mailinglistadmin] bit DEFAULT 0,
+  [virtual] bit DEFAULT 0
+);
+
+
+-- schema version meta-info 
+
+CREATE TABLE schema_info (
+  [version] int
+);
+
+insert into schema_info (version) values (25);

data/db/schema_version

@@ -0,0 +1 @@
+25

data/doc/README_FOR_APP

@@ -0,0 +1,179 @@
+= Welcome to Sugoi-Mail: an introduction to mailing lists and the mail proxy
+
+Sugoi-Mail is a new kind of mailing list manager, which combines a
+whole class of different email distribution schemes into one
+common thing.
+
+= Mailing Lists
+
+== First things first: what's a mailing list?
+
+A mailing list is, at its most basic, a single email address that
+redirects email sent to it to multiple email addresses.
+
+Exactly how it does this can happen in a number of different ways.
+There are different kinds of behaviours regarding whether it
+accepts mail for delivery or not.  Have a look at the
+MailinglistClass class for some examples of different kinds of
+behaviour.
+
+== A couple of basic mailing list types
+
+Let's have a look at a couple of basic kinds of mailing lists, to
+illustrate.
+
+_List type name_::   Description
+Distribution list::  A personal list of addresses that one
+                     person can send mail to.
+Discussion list::    A collection of addresses where people on the
+                     list can send email to the list address and
+                     it's broadcast to all of them.
+
+Those are both almost the same thing, where the only difference is
+in who's allowed to send email to the list.  Expressed as
+MailinglistClass classes, a distribution list looks like this:
+
+    MailinglistClass.new do |distrib| 
+        # Identification details
+        distrib.name         = "Distribution List"
+        distrib.description  = 'Personal distribution list'
+
+        # Mailing details
+        distrib.public       = false
+        distrib.closed       = true
+        distrib.moderated    = false
+        distrib.archived     = false
+
+        # Modification details
+        distrib.joinable     = false
+        distrib.confirmation = false
+    end
+
+This is a private, closed, unmoderated, non-joinable,
+non-confirmation mailing list.
+
+The key detail is "closed" here--in a closed mailing list, only
+the owner is permitted to send mail to it.
+
+Let's compare that to a discussion list, whose class may be
+defined as follows:
+
+    MailinglistClass.new do |discussion|
+        distrib.name         = "Discussion List"
+        distrib.description  = "An unmoderated discussion list"
+
+        distrib.public       = false
+        distrib.closed       = false
+        distrib.moderated    = false
+        distrib.archive      = true
+        
+        distrib.joinable     = true
+        distrib.confirmation = true
+    end
+
+The difference in delivery details is that where a distribution
+list is closed, a discussion list is _open_--anyone on the mailing
+list can send email to the mailing list's email address and it
+will be delivered to everyone.
+
+The other difference is in modification details--where a
+distribution list can only be modified by the owner, the
+discussion list is _joinable_.  This means that people can send
+email to the mailing list's "request" address asking the system to
+automatically subscribe them to the mailing list.
+
+Also, the "confirmation" parameter is set to true to prevent
+abuse.  When a subscription request is received, an email message
+is sent to the address the subscription request was made for with
+a confirmation code in it, asking the person at that email address
+to verify that it's a genuine email address and that a request
+really was made.
+
+You may know of services with names like "pobox.com", which allow
+you to keep a single email address which forwards your email to
+whatever email address your ISP's given you this week.  Anyone
+who's had their ISP be bought out from underneath them and then
+had their email address change from myname@smallisp.boulder.co.us to
+myname27@hugeisp.com will understand how this could be handy.
+
+== More interesting mailing list classes 1: Mail Proxy
+
+Okay, suppose that you want to set up a service like this up?  How
+would you do the email forwarding?  It's a kind of mailing list,
+of course!
+
+    MailinglistClass.new do |forward|
+        forward.name         = 'LTMA'
+        forward.description  = 'Lifetime Mail Address'
+
+        forward.public       = true
+        forward.closed       = false
+        forward.moderated    = false
+        forward.archive      = false
+
+        forward.joinable     = false
+        forward.confirmation = true
+    end
+
+Indeed, it was for this very reason that Sugoi-Mail originally had
+a User class in the first place, so be sure to check that out.
+You'll notice that every User has a Mailinglist which has the same
+name as the User--that's their forwarding address.
+
+== More interesting mailing list classes 2: Web Bulletin Board
+
+You see that +archive+ parameter in all those mailing list class
+declarations?  Those say whether the the mail system should save
+messages that are sent to the mailing list or not.  In the case of
+a forwarding address, it doesn't make very much sense to archive
+all messages coming through (although one could very easily set up
+a webmail system simply by not letting users add any email
+addresses to their mailing list--see the User section below--and
+letting them access their email messages via the web).
+
+If you have a mailing list with no subscribers, that people are
+allowed to send messages to via some sort of a web interface--what
+you have is a web bulletin board!
+
+And if you add email subscribers to the bulletin board, you also
+gain the ability for people to participate via email.  I, for one
+don't much like posting messages to the Internet via web forms (I
+even update my blog offline), so the ability to participate by
+email would be a nice feature.  By the same token, others find
+that email is a big pain to configure and get working correctly,
+so they prefer to participate in online communities through a web
+interface.  Well, with Sugoi-Mail, you can have both at the same
+time!  (On my TODO list, in the distant future, is an NNTP
+interface, to support people who prefer USENET clients.)
+
+= Users
+
+Now that we have the introduction to mailing lists out of the way,
+I should talk about users.  Users are the reason that this entire
+project was started in the first place--I wanted to make some sort
+of a replacement for pobox.com that didn't depend on a really busy
+sysadmin.
+
+This meant letting users be able to manage their own email
+aliases, and if possible, their own mailing lists.  Quite a lot of
+the code you'll find in this project grew directly out of
+real-world requirements.  (Any limitations in the existing system
+are most likely a direct result of the feature being outside the
+scope of the problems I was trying to solve.  If I overlooked
+something, please contact me!)
+
+So Users are pretty central to the whole Sugoi-Mail system--they
+caused it to happen.  Make sure you have a look at the
+documentation for the User class, otherwise you might be confused
+by the next bit.
+
+== Proxy address
+
+Every User has a proxy address, which is actually the name of
+their Mailinglist.  (A user could potentially change their
+Sugoi-Mail email address without changing their userid.)  If you
+look at the code for User, you'll notice that the user's address
+comes straight from the User's Mailinglist, and is completely
+separate from his login credentials.  Likewise, when you add
+addresses to a User, you're actually modifying that user's
+Mailinglist.

data/doc/mailinglist_classes description.txt

@@ -0,0 +1,28 @@
+MAILING LIST CLASSES
+
+There are a bunch of flags that are used to describe the different attributes
+of mailing lists.  Since these flags are by necessity rather short (a flag
+called anyone_can_send_to_the_mailing_list would certainly be clearer, but I
+feel it'd clutter up the code unnecessarily), here's a list of them and what
+they're for.
+
+
+FLAG          MEANING
+public:       true  -> anyone can post to it (spammy!)
+              false -> only members can post to it   <-- DEFAULT
+
+closed:       true  -> only the owner can post to it
+              false -> other people can post to it   <-- DEFAULT
+
+moderated:    true  -> posted messages go to the owner first
+              false -> posted messages are broadcast <-- DEFAULT
+
+confirmation: true  -> subscriptions have to be confirmed <-- DEFAULT
+              false -> subscriptions happen automatically
+
+joinable:     true  -> people can subscribe to the list at will <- DEFAULT
+              false -> only the owner can subscribe or unsubscribe people
+
+archived:     true  -> all email sent to this address is stored
+              false -> all email sent to this address is discarded after being
+                       processed

data/installer/rails_installer_defaults.yml

@@ -0,0 +1,5 @@
+---
+rails-environment: production
+database: postgres
+web-server: mongrel
+threads: 2

data/lib/daemonize.rb

@@ -0,0 +1,56 @@
+module Daemonize
+  VERSION = "0.1.2"
+
+  # Try to fork if at all possible retrying every 5 sec if the
+  # maximum process limit for the system has been reached
+  def safefork
+    tryagain = true
+
+    while tryagain
+      tryagain = false
+      begin
+        if pid = fork
+          return pid
+        end
+      rescue Errno::EWOULDBLOCK
+        sleep 5
+        tryagain = true
+      end
+    end
+  end
+
+  # This method causes the current running process to become a daemon
+  # If closefd is true, all existing file descriptors are closed
+  def daemonize(oldmode=0, closefd=false)
+    srand # Split rand streams between spawning and daemonized process
+    safefork and exit # Fork and exit from the parent
+
+    # Detach from the controlling terminal
+    unless sess_id = Process.setsid
+      raise 'Cannot detach from controlled terminal'
+    end
+
+    # Prevent the possibility of acquiring a controlling terminal
+    if oldmode.zero?
+      trap 'SIGHUP', 'IGNORE'
+      exit if pid = safefork
+    end
+
+    Dir.chdir "/"   # Release old working directory
+    File.umask 0000 # Insure sensible umask
+
+    if closefd
+      # Make sure all file descriptors are closed
+      ObjectSpace.each_object(IO) do |io|
+        unless [STDIN, STDOUT, STDERR].include?(io)
+          io.close rescue nil
+        end
+      end
+    end
+
+    STDIN.reopen "/dev/null"       # Free file descriptors and
+    STDOUT.reopen "/dev/null", "a" # point them somewhere sensible
+    STDERR.reopen STDOUT           # STDOUT/STDERR should go to a logfile
+    return oldmode ? sess_id : 0   # Return value is mostly irrelevant
+  end
+end