sugoi-mail 0.3.0 → 0.3.2

data/CHANGELOG

@@ -0,0 +1,38 @@
+New features for version 0.3.x
+
+- MailinglistClass has recieved many changes
+    - duplicate mailinglist_class names are dissallowed (throws error)
+    - deleting a mailinglist_class that still has mailing lists assigned to it is dissallowed (throws error)
+    - blank mailinglist class name is dissalowed (what a shame..)
+    - help/gui functions added:
+        MailinglistClass.get_param_names: 
+            prints string-array of all param/setting names
+        MailinglistClass.get_param_description(param_name, html=false):
+            prints description of the parameter (for gui/helpfile use). if html is true, all newlines are replaced with line-breaks <br/>
+    - a mailinglist class controller & views have been created 
+        reuses the same form for Show, Edit, and New, with detailed info
+
+New features for version 0.3.0
+
+- improved maild daemon:
+    - implemented cleanup features (removes socketfile & pidfile on kill)
+    - uses a non-blocking socket
+    - catches kill -2 (SIGINT) and kill -15 (SIGTERM) and cleans up
+- added a bash bootscript:
+    - located in script/boot/
+    - allows start, stop, cleanup, status, and help
+    - cleanup restores any error state to a stopped state
+- message.rb's deliver method rewritten:
+    - uses only envelope_to, and envelope_from data
+    - envelope data is generated in a separate method (generate_envelope_data)
+    - envelope_to is now a serialized array in the DB (why wasn't it before?)
+- Mailinglist.subscribe now accepts address objects and strings
+
+- fixed sugoi_admin's create_user function. Now the default mailinglist has the user's address subscribed, so a confirmation code is created and an email is sent to the user
+
+- mailinglist.rb disallows subscribing a private address to more than one forwarding address (so Address.proxy_address doesn't get confused)
+
+- updated everything to rails 2.0 syntax (no more depreciation warnings)
+- the 'dumptofile' debug script has been added to script (for mailjail setup)
+- gurgitate rules updated to new changes
+- a significant amount of test fixtures & unit-tests updates

data/app/apis/mailservice_api.rb

@@ -165,6 +165,12 @@ class MailserviceApi < ActionWebService::API::Base
                     { :address => :string }
                 ]
 
+    api_method  :mailinglist_unsubscribe_quiet, :returns => [ :bool ],
+                :expects => [
+                    { :mailinglist_id => :integer },
+                    { :address => :string }
+                ]
+
 ## TODO: Implement message handling functionality
 ##     api_method  :mailinglist_messages, :returns => [ [ :integer ] ],
 ##                 :expects => [

data/app/controllers/account_controller.rb

@@ -1,55 +1,50 @@
 class AccountController < ApplicationController
-  include LoginSystem
+    include LoginSystem
   
-  def signup
-    if request.post? 
-        @user = User.new(params[:user])
-        if @user.save
-            session[:user] = User.authenticate(@user.login, params[:user][:password])
-            flash['notice']  = "Signup successful"
-            redirect_back_or_default :action => "welcome"
-        end      
+    def index
+        redirect_to :action => "welcome"
     end
-  end  
+
+    def signup
+        if request.post? 
+            @user = User.new(params[:user])
+            if @user.save
+                session[:user_id] = User.authenticate(@user.login, params[:user][:password]).id
+                flash['notice']  = "Signup successful"
+                redirect_back_or_default :action => "welcome"
+            end      
+        end
+    end  
   
-  def logout
-    session[:navList] = :logout
-    session[:user] = nil
-    redirect_back_or_default :action => "login"
-  end
+    def logout
+        session[:navList] = :logout
+        session[:user_id] = nil
+        redirect_back_or_default :action => "login"
+        flash.now['notice'] = "Logout successfully"
+    end
     
-  def login
-    case request.method
-      when :post
-      if session[:user] = User.authenticate(params[:user_login], params[:user_password])
-        session[:user_id] = :id # THIS MIGHT BE WRONG, SUPPOSED TO BE ABLE TO ACCESS USER'S BY ID STORED IN SESSION
-        flash['notice']  = "Login successful"
-        redirect_back_or_default :action => "welcome"
-      else
-        flash.now['notice']  = "Login unsuccessful"
+    def login
+        case request.method
+        when :post
+            if usr=User.authenticate(params[:user_login], params[:user_password])
+                session[:user_id] = usr.id 
+                flash['notice']  = usr.login "'s login successful"
+                redirect_back_or_default :action => "welcome"
+            else
+                flash.now['notice']  = "Login unsuccessful"
 
-        @login = params[:user_login]
-      end
+            end
+        end
     end
-  end
   
-	def welcome
-		@controller_name = controller_name
-		@action_name = action_name
-		session[:user] = User.find session[:user].id
-
-		@mailinglists = session[:user].mailinglists
-
-		@mailinglist_classes = MailinglistClass.find(:all)
-
-		domain_name = session[:domain]
-		domain = Domain.find_by_name domain_name
-		if domain then
-			@users = User.find_all_by_domain_id domain.id
-		else
-			# error "Domain \"#{domain_name}\" does not exist."
-		end
-    	#session[:navList] = :welcome //not needed??
-  end
+    def welcome
+        if session[:user_id] then 
+		    @user = User.find(session[:user_id])
+		    @mailinglists = @user.mailinglists
+		    @users = User.find_all_by_domain_id @user.domain.id
+        else    
+            redirect_back_or_default :action => "login" 
+        end
+    end
   
 end

data/app/controllers/{root_admin_controller.rb → admin_controller.rb}

@@ -1,7 +1,6 @@
-class RootAdminController < MailserviceController
+class AdminController < ApplicationController
 
     def admin_user_new
-    
     end
 
     # Returns true if the user is an administrator and false otherwise

data/app/controllers/application.rb

@@ -1,15 +1,15 @@
 # Filters added to this controller will be run for all controllers in the application.
 # Likewise, all the methods added will be available for all controllers.
 class ApplicationController < ActionController::Base
-  before_filter :initialize_variables
-  
-  protected 
+    before_filter :initialize_variables
 
-  def initialize_variables
-    @controller_name = controller_name
-    @action_name = action_name
-    @users = User.find(:all)
-	 @mailinglist_classes = MailinglistClass.find(:all)
-  end 
+    protected 
+
+    def initialize_variables
+        @controller_name = controller_name
+        @action_name = action_name
+        @users = User.find(:all)
+	    @mailinglist_classes = MailinglistClass.find(:all)
+    end 
 
 end

data/app/controllers/mailinglist_class_controller.rb

@@ -0,0 +1,63 @@
+class MailinglistClassController < ApplicationController
+    verify :session => :user_id,
+        :add_flash => { :notice => 'You are not logged in!'},
+        :redirect_to => { :controller => 'account', :action => 'welcome' }
+    verify :only => [ 'show', 'edit', 'remove' ],
+        :params => :id,
+        :add_flash => { :notice => 'Missing mailinglist class ID.' },
+        :redirect_to => { :action => 'list' }
+
+
+    def new
+        @domain = User.find(session[:user_id]).domain
+    
+        if request.post?
+            @mailinglist_class = MailinglistClass.new(params[:mailinglist_class])
+            if @mailinglist_class.save
+                flash[:notice] = 'The mailinglist class was successfully added.'
+                redirect_to :controller => "account", :action => "welcome"
+            else
+                flash[:notice] = 'ERR: the class could not be created'
+            end
+        end
+    end
+    
+    def remove
+        if request.post?
+            begin
+                MailinglistClass.find(params[:id]).destroy
+            rescue MlClassInUseException
+                flash[:notice] = 'Cannot remove a mailinglist class that is currently in use.'
+                redirect_to :controller => 'account', :action => 'welcome'
+                return
+            end
+
+            flash[:notice] = 'The mailinglist class was successfully removed.'
+            redirect_to :controller => 'account', :action => 'welcome'
+            
+        else
+            flash[:notice] = 'Click Delete to remove the mailinglist class.'
+            redirect_to :action => 'edit', :id => params[:id]
+        end
+    end
+
+    def edit
+        @user = User.find(session[:user_id])
+        @mailinglist_class = MailinglistClass.find(params[:id])
+        
+
+        if request.post?
+            if @mailinglist_class.update_attributes(params[:mailinglist_class])
+                if @mailinglist_class.save
+                    flash[:notice] = 'The mailinglist class was successfully edited.'
+                    redirect_to :controller => 'account', :action => 'welcome'
+                end
+            end
+        end
+    end
+
+    def show
+        @mailinglist_class = MailinglistClass.find(params[:id])
+    end
+
+end

data/app/controllers/mailinglist_controller.rb

@@ -1,15 +1,17 @@
 class MailinglistController < ApplicationController
+    verify :session => :user_id,
+        :add_flash => { :notice => 'You are not logged in!'},
+        :redirect_to => { :controller => 'account', :action => 'welcome' }
     verify :only => [ 'show', 'edit', 'remove' ],
         :params => :id,
         :add_flash => { :notice => 'Missing mailinglist ID.' },
         :redirect_to => { :action => 'list' }
 
     def remove
-        flash[:notice] = 'The mailing list was successfully destroyed.'
         if request.post?
             Mailinglist.find(params[:id]).destroy
             flash[:notice] = 'The mailinglist was successfully destroyed.'
-            redirect_to :controller => "account", :action => 'welcome'
+            redirect_to :controller => 'account', :action => 'welcome'
         else
             flash[:notice] = 'Click Destroy to destroy the mailinglist.'
             redirect_to :action => 'edit', :id => params[:id]
@@ -17,51 +19,44 @@ class MailinglistController < ApplicationController
     end
 
     def edit
-        #session[:mailinglist_id] = params[:id]
+        @mailinglist = Mailinglist.find(params[:id])
         if request.post?
-            @mailinglist = Mailinglist.find(params[:id])
             if @mailinglist.update_attributes(params[:mailinglist])
 					@mailinglist.mailinglist_class = MailinglistClass.find_by_id params[:mailinglist_class_id]
-               if @mailinglist.save
-               	flash[:notice] = 'The mailinglist was successfully edited.'
-               	session[:user] = User.find session[:user].id
-               	redirect_to :action => 'show', :id => @mailinglist
-               end
+                if @mailinglist.save
+                    flash[:notice] = 'The mailinglist was successfully edited.'
+               	    redirect_to :action => 'show', :id => @mailinglist
+                end
             end
-        else
-          @mailinglist = Mailinglist.find(params[:id])
         end
     end
 
     def list
-        session[:user] = User.find session[:user].id
-        @mailinglists = session[:user].mailinglists
+        @user = User.find session[:user_id]
+        @mailinglists = @user.mailinglists
         # @mailinglist_pages, @mailinglists = paginate(:mailinglists)
     end
 
     def new
-        session[:domain] = Domain.find(session[:domain_id])
+        @user = User.find(session[:user_id])
+        @domain = @user.domain
+        
         if request.post?
             @mailinglist = Mailinglist.new(params[:mailinglist])
-				domain = session[:domain]
-				if domain then
-					@mailinglist.user = User.find_by_login_and_domain_id params[:user], domain.id
-					@mailinglist.mailinglist_class = MailinglistClass.find_by_id params[:mailinglist_class_id]
-					if @mailinglist.save
-						flash[:notice] = 'A new mailinglist was successfully added.'
-						session[:user] = User.find session[:user].id
-						redirect_to :action => 'list'
-					end
-				else
-					flash[:notice] = 'Mailinglist could not be added - domain is nil'
-				end
+		    @mailinglist.user = @user
+			@mailinglist.mailinglist_class = MailinglistClass.find_by_id params[:mailinglist_class_id]
+			if @mailinglist.save
+				flash[:notice] = @mailinglist.name + ' was successfully added.'
+				redirect_to :action => 'list'
+			else
+                flash[:error] = 'ERR: The mailing list could not be added'
+            end
         else
             #@mailinglist = Mailinglist.new
         end
     end
 
     def show
-        session[:user] = User.find session[:user].id
         @mailinglist = Mailinglist.find(params[:id])
     end
     
@@ -84,22 +79,4 @@ class MailinglistController < ApplicationController
         end
     end
 
-	def new_mailinglist_class
-		session[:domain] = Domain.find(session[:domain_id])
-        if request.post?
-            @mailinglist_class = MailinglistClass.new(params[:mailinglist_class])
-				domain = session[:domain]
-				if domain then
-					#@mailinglist.user = User.find_by_login_and_domain_id params[:user], domain.id
-					#@mailinglist.mailinglist_class = MailinglistClass.find_by_id params[:mailinglist_class_id]
-					if @mailinglist_class.save
-						flash[:notice] = 'A new mailinglist class was successfully added.'
-						session[:user] = User.find session[:user].id
-						redirect_to :controller => "account", :action => "welcome"
-					end
-				else
-					flash[:notice] = 'Mailinglist class could not be added - domain is nil'
-				end
-        end
-	end
 end

data/app/controllers/mailservice_controller.rb

@@ -487,6 +487,13 @@ class MailserviceController < ApplicationController
         end
     end
 
+    # Removes an address from a mailing list without sending the
+    # farewell message
+    def mailinglist_unsubscribe_quiet mailinglist_id, address
+        if my_mailing_list(mailinglist_id).unsubscribe(address, false)
+            true
+        end
+    end
 end
 
 ## TODO: implement message-handling functionality properly

data/app/models/mailinglist_class.rb

@@ -34,7 +34,47 @@
 #           mailing list archives online)
 #  false:   Messages will be discarded after delivery (probably what
 #           people who want to use sugoi-mail for forwarding want)
+class MlClassInUseException < Exception; end
+
 class MailinglistClass < ActiveRecord::Base
     has_many :mailinglists
+    validates_presence_of :name
+    validates_uniqueness_of :name
+    
+    def before_destroy
+        if ml = Mailinglist.find_by_mailinglist_class_id(self.id)
+            raise MlClassInUseException
+        end
+    end
+    
+    public
+
+    def self.get_param_names
+        return %w{public closed moderated confirmation joinable archived}
+    end
 
+    def self.get_param_description(param, html = false)    
+        case param
+        when 'public'
+            param_desc = "Whether the list is open to the public or not.\nIf checked, anyone can post to the list.\nIf unchecked, only members of the mailing list can post to it."
+        when 'closed'
+            param_desc = "Determines who can send mail to the mailing list.\nIf checked, only the owner can send mail.\nIf unchecked, other people can post to it as determined by the \"Public\" parameter."
+        when 'moderated'
+            param_desc = "Determines if the owner has to approve every message posted to the mailing list.\nIf checked, all posted messages go to owner first.\nIf unchecked, all posted messages are sent to the list immediately."
+        when 'confirmation'
+            param_desc = "Determines whether a newly subscribed address requires subscription-confirmation from the user (via e-mail).\nIf checked, subscriptions have to be confirmed by the subscriber.\nIf unchecked, subscriptions will happen automatically."
+        when 'joinable'
+            param_desc = "Determines whether the general public can join this mailinglist.\nIf checked, anyone can subscribe to the list at will by sending email to _listname_-request@_domain_.\nIf unchecked, then only the owner can subscribe/unsubscribe people."
+        when 'archived'
+            param_desc = "Determines whether the messages are retained after delivery.\nIf checked, then messages are archived (useful for viewing online archives).\nIf unchecked, then messages are discarded after delivery (recommended for the mail-forwarding feature, for privacy concerns)."
+        else
+            param_desc = "'" + param.to_s + "' is not a valid mailing class parameter"
+        end
+  
+        if html then
+            param_desc.gsub!(/\n/, '<br/>')
+        end
+  
+        return param_desc
+    end
 end

data/app/models/message.rb

@@ -240,7 +240,9 @@ class Message < ActiveRecord::Base
         else
             self.envelope_to = mailinglist.expand_addresses.map { |a| a.address }
         end
-        self.envelope_from = mailinglist.name + SysConfig.address_separator + SysConfig.bounce_suffix + "@" + mailinglist.user.domain.name
+        self.envelope_from = mailinglist.name + 
+            SysConfig.address_separator + 
+            SysConfig.bounce_suffix + "@" + mailinglist.user.domain.name
 
     end
 
@@ -257,7 +259,7 @@ class Message < ActiveRecord::Base
         if mailinglist.canonical_address? or mailinglist.closed? then
             proxify_addresses
         else
-            @mess.to_s
+            to_s
         end
     end
 
@@ -272,7 +274,7 @@ class Message < ActiveRecord::Base
             smtpdetails = {}
         end
 
-                # Hm, not sure why this is *here* instead of somewhere
+        # Hm, not sure why this is *here* instead of somewhere
         # else.  Fix later.
         #
         # (This should actually be in the database somewhere, I'm thinking.)
@@ -288,7 +290,9 @@ class Message < ActiveRecord::Base
         end
 
         if mailinglist.closed?
-            unless mailinglist.user.mailinglist.has_address? self.envelope_from or mailinglist.user.address == self.envelope_from then
+            unless mailinglist.user.mailinglist.has_address? \
+                self.envelope_from or \
+                mailinglist.user.address == self.envelope_from then
                 return bounce
             end
         end
@@ -299,9 +303,6 @@ class Message < ActiveRecord::Base
             return bounce
         end
 
-        #Good debugging thingy:
-        #pp self
-
         Net::SMTP.start(smtpserver, smtpport, mysmtpname) do |smtp|
             smtp.send_message messagetext(smtpdetails), self.envelope_from, self.envelope_to
         end