sugoi-mail 0.1.0 → 0.1.5

data/INSTALL

@@ -63,3 +63,97 @@ you already have) and say:
 $ sugoi-mail install sugoi
 
 This should, all being well, set up and start a sugoi-mail installation.
+
+
+LUNAR LINUX
+
+# lin rubygems sqlite3
+# gem install -y sugoi-mail
+$ sugoi-mail install <your-directory>
+
+This is part of why I like Lunar Linux so much.
+
+
+POSTFIX CONFIGURATION (with optional mail-jail) ------------------------------
+- send questions to aavdacev@invio.co.jp before bothering dagbrown :)
+
+1. Ensure Postfix is installed: --- 
+Postfix is the SMTP mail-server with which sugoi-mail will interface. Before proceeding you must ensure you have postfix installed. If it is not installed, run "sudo apt-get install postfix". When the installer asks for configuration types, select the "Internet" configuration and follow the prompts. By default postfix is installed into "/etc/postfix/", which is where you will find the configuration files (master.cf, main.cf).
+
+2. Setup the transport for the sugoi-mail domain(s): ---
+A transport specification tells the mail-server to pass an outgoing mail message to a client software. The default transport is SMTP (which sends mail to the Internet). All of the mail addressed to the domain(s) specified in this step will be directed into sugoi-mail's client (mailc) and then be processed by sugoi-mail. The transport files are to be put into the postfix directory (/etc/postfix/)
+
+a) Configure postfix to recognize sugoi-mail and it's client (mailc). In the code below, replace USERNAME with the unix user account that will be running the application, and ensure this user exists on the system. A good default setting is your own username. Do not forget to specify the filepath of your sugoi-mail installation. Append the following into master.cf, as two lines: the first starting with "sugoi..." and the second, indented 2 spaces, starting with "flags..". This is the same format as already existing in master.cf
+
+sugoi   unix    -       n       n       -       -       pipe
+  flags=FDRq  user=USERNAME  argv=/[sugoi-mail-installpath]/bin/mailc --sender $sender $recipient
+
+b) Create a file called "transport" in /etc/postfix/, to assign the domains for transports. This every entry in this file is formatted like so: "[domain] (whitespace) [transport]:[nexthop]" where [nexthop] is often left blank. A suggested 'transport' for sugoi-mail can look like so:
+
+"my.domain.jp     sugoi:"  
+
+where my.domain.jp can be changed to your liking, and "sugoi" is the name specified in step 2a. This would mean that all mail to xxx@my.domain.jp will be handled by sugoi mail's mailc client. You may add more domains on separate lines in the same format.
+
+c) Postfix reads transport configuration files in binary format, text. This means you need to convert the file you just created into the proper format. Run the following to create 'transport.db', a postfix-readable file:
+
+"sudo postmap transport"
+
+d) Finally, Postfix need to know where to look for your transport specification. Append the following into the main.cf file (this is the configuration file you generated during installation):
+
+"transport_maps = hash:/etc/postfix/transport"
+
+NOTE: if this fails saying main.cf is missing, you may have skipped configuration and need to run "sudo dpkg-reconfigure postfix" to generate the default main.cf
+
+e) Reload postfix to accept the new cofiguration by running:
+
+"sudo postfix reload"
+
+If postfix wasn't running, try "sudo postfix start"
+
+f) Congratulations, (in theory) all mail sent to the domains you specified should now be handled by sugoi-mail. If something fails, checking /var/log/mail.log is a good idea
+
+
+
+3. Optional 'Mail-Jail' Configuration For Testing:---
+When testing a mail-software installating (such as sugoi-mail) it is a good idea to set up a mail-jail. A mail-jail is simply a mail-server configuration that prevents all outgoing mail to ever make it to the internet. Instead it dumps all of the mail sent to a folder on the system to use for testing. To configure the mail-jail on Postfix, follow these steps:
+
+a) Create the text-file '/root/bin/dumpintofile', which is script that will create a new textfile for every email message that is forwarded to it. This file can be placed anywhere, the /root/bin/ is a good default location. This file will contain the following:
+--------------------
+
+#!/bin/sh
+
+mkdir -p /tmp/maildumps
+echo "$@" > /tmp/maildumps/dumptofile.$$
+cat >> /tmp/maildumps/dumptofile.$$
+
+--------------------
+b) The permissions on this file must be set to read, write, and execute. Use the chmod command to set the permissions:
+
+"sudo chmod a=rwx dumpintofile"
+
+c) Now the transport for dumpintofile needs to be set up. Brief instructions are provided. For verbose instructions on setting up a transport read section 2 of this document.
+
+i. Add the dumptofile catch-all entry to master.cf. Don't forget to set the username, change the filepath (if you created dumpintofile in something other than /root/bin, and indent "flags.." by two spaces:
+     
+dumpintofile   unix    -       n       n       -       -       pipe
+  flags=FDRq  user=USERNAME  argv=/root/bin/dumpintofile --sender $sender $recipient
+
+ii. Now set it such that all the mail not that does not have a specified transport in the transport.db file, will go to the file-dumping script, instead of SMPT (send to internet). Append the following to /etc/postfix/main.cf
+
+“default_transport = dumpintofile:”
+     
+IMPORTANT: This will disable all outgoing mail from the server. Comment this line out to re-set SMTP as the default transport.
+
+iii. Finally, if postfix was set up for a local-delivery system, reduce the number of aliases by commenting out the line in /etc/postfix/main.cf that looks like:
+
+"mydestination = somedomain.com, sub.domain.com, localhost, localhost.localdomain ..."
+
+This change will prevent mail to be delivered if it is sent to the current server's hostname. However, mail sent to user@localhost will still be delivered, so beware of this during testing.
+
+d) Reload postfix for changes to take effect:
+
+"sudo postfix reload"
+
+e) Congratulations, your mail-jail is set up. Now all mail sent to domains not specified in the transport you set up in section 2 of this document will be sent into a file. You can find the messages in the directory: /tmp/maildumps/ , they will be text-files with the name "dumptofile.####". If the mail does not appear in that directory, try running "mailq" or viewing the logs found in /var/log/mail.log.
+
+------------------------------------------------------------------------

data/app/apis/mailservice_api.rb

@@ -30,12 +30,18 @@ class MailserviceApi < ActionWebService::API::Base
 
     api_method  :admin_user_signup, :returns => [ :bool ],
                 :expects => [ { :login => :string },
+                              { :description => :string },
                               { :password => :string },
-                              { :password_confirmation => :string } ]
+                              { :password_confirmation => :string },
+                              { :mailinglist_admin => :boolean },
+                              { :domain_admin => :boolean } ]
 
     api_method  :admin_user_list, :returns => [ [ [:string, :string] ] ],
                 :expects => [ ]
 
+    api_method  :admin_user_collection, :returns => [ [ User ] ], 
+                :expects => [ ]
+
     api_method  :admin_user_reset_password, :returns => [ :bool ],
                 :expects => [ 
                     { :login                 => :string },
@@ -51,6 +57,9 @@ class MailserviceApi < ActionWebService::API::Base
                 :expects => [ { :mailinglist_name => :string },
                               { :address => :string } ]
 
+    api_method  :admin_mailinglists_all, :returns => [ [ Mailinglist ]],
+                :expects => [ ]
+
 #------------------------------------------------------------------------
 # user methods
 #------------------------------------------------------------------------
@@ -64,7 +73,7 @@ class MailserviceApi < ActionWebService::API::Base
     api_method  :user_logged_in, :returns => [ :bool ], :expects => []
     api_method  :user_name, :returns => [ :string ], :expects => []
 
-    api_method  :user_mailinglists, :returns => [ [ :integer ] ], 
+    api_method  :user_mailinglists, :returns => [ [ Mailinglist ] ], 
         :expects => []
 
     api_method  :user_email_address, :returns => [ :string ], :expects => []
@@ -108,7 +117,7 @@ class MailserviceApi < ActionWebService::API::Base
 # mailing list methods
 #------------------------------------------------------------------------
 
-    api_method  :mailinglist_create, :returns => [ :string ],
+    api_method  :mailinglist_create, :returns => [ :boolean ],
                 :expects => [ { :name => :string }, 
                               { :mailinglist_class => :string } ]
 
@@ -156,23 +165,24 @@ class MailserviceApi < ActionWebService::API::Base
                     { :address => :string }
                 ]
 
-    api_method  :mailinglist_messages, :returns => [ [ :integer ] ],
-                :expects => [
-                    { :mailinglist_id => :integer }
-                ]
-
-    api_method  :message, :returns => [ Message ],
-                :expects => [
-                    { :message_id => :integer }
-                ]
-
-    api_method  :message_parent, :returns => [ :integer ],
-                :expects => [
-                    { :message_id => :integer }
-                ]
-
-    api_method  :message_responses, :returns => [ [ :integer ] ],
-                :expects => [
-                    { :message_id => :integer }
-                ]
+## TODO: Implement message handling functionality
+##     api_method  :mailinglist_messages, :returns => [ [ :integer ] ],
+##                 :expects => [
+##                     { :mailinglist_id => :integer }
+##                 ]
+##
+##     api_method  :message, :returns => [ Message ],
+##                 :expects => [
+##                     { :message_id => :integer }
+##                 ]
+## 
+##     api_method  :message_parent, :returns => [ :integer ],
+##                 :expects => [
+##                     { :message_id => :integer }
+##                 ]
+## 
+##     api_method  :message_responses, :returns => [ [ :integer ] ],
+##                 :expects => [
+##                     { :message_id => :integer }
+##                 ]
 end

data/app/controllers/account_controller.rb

@@ -1,28 +1,11 @@
 class AccountController < ApplicationController
-  layout  'scaffold'
-
   include LoginSystem
-
-  def login
-    case @request.method
-      when :post
-      if @session[:user] = User.authenticate(@params[:user_login], @params[:user_password])
-
-        flash['notice']  = "Login successful"
-        redirect_back_or_default :action => "welcome"
-      else
-        flash.now['notice']  = "Login unsuccessful"
-
-        @login = @params[:user_login]
-      end
-    end
-  end
   
   def signup
-    if @request.post? 
-        @user = User.new(@params[:user])
+    if request.post? 
+        @user = User.new(params[:user])
         if @user.save
-            @session[:user] = User.authenticate(@user.login, @params[:user][:password])
+            session[:user] = User.authenticate(@user.login, params[:user][:password])
             flash['notice']  = "Signup successful"
             redirect_back_or_default :action => "welcome"
         end      
@@ -30,10 +13,43 @@ class AccountController < ApplicationController
   end  
   
   def logout
-    @session[:user] = nil
+    session[:navList] = :logout
+    session[:user] = nil
+    redirect_back_or_default :action => "login"
   end
     
-  def welcome
+  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"
+
+        @login = params[:user_login]
+      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
   
 end

data/app/controllers/address_controller.rb

@@ -28,7 +28,9 @@ class AddressController < ApplicationController
   end
 
   def list
+    session[:navList] = :logout
     @address_pages, @addresses = paginate(:addresses)
+ 
   end
 
   def new

data/app/controllers/application.rb

@@ -1,4 +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
-end
+  before_filter :initialize_variables
+  
+  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/base_user_controller.rb

@@ -0,0 +1,29 @@
+class BaseUserController < ApplicationController
+
+  def edit_user_list
+    @mailinglists = session[:user].mailinglists
+  end
+  
+  def list_mailinglists
+  end
+  
+  def unsubscribe_self
+  end
+  
+  def add_address
+  end
+  
+  def remove_address
+  end
+  
+  def show_address
+  end
+  
+  def edit_address
+  end
+  
+  def show_mailinglist
+    
+  end
+
+end

data/app/controllers/domain_controller.rb

@@ -1,34 +1,33 @@
 class DomainController < ApplicationController
     include DomainSystem
-    layout  'scaffold'
 
     def login
-        case @request.method
+        case request.method
         when :post
-            if @session[:domain] = Domain.authenticate(@params[:domain_name], @params[:domain_password])
+            if session[:domain] = Domain.authenticate(params[:domain_name], params[:domain_password])
 
                 flash['notice']  = "Login successful"
                 redirect_back_or_default :action => "welcome"
             else
                 flash.now['notice']  = "Login unsuccessful"
 
-                @login = @params[:domain_login]
+                @login = params[:domain_login]
             end
         end
     end
 
     def signup
-        @domain = Domain.new(@params[:domain])
+        @domain = Domain.new(params[:domain])
 
-        if @request.post? and @domain.save
-            @session[:domain] = Domain.authenticate(@domain.name, @params[:domain][:password])
+        if request.post? and @domain.save
+            session[:domain] = Domain.authenticate(@domain.name, params[:domain][:password])
             flash['notice']  = "Signup successful"
             redirect_back_or_default :action => "welcome"
         end      
     end  
 
     def logout
-        @session[:domain] = nil
+        session[:domain] = nil
     end
 
     def welcome

data/app/controllers/mail_admin_controller.rb

@@ -0,0 +1,275 @@
+class MailAdminController < ApplicationController
+	def list_admin_messages
+		@mailinglist = Mailinglist.find_by_id(params[:id])
+		@adminmessages = AdminMessage.find(@mailinglist.welcome_admin_message_id, @mailinglist.confirmed_admin_message_id, @mailinglist.sayonara_admin_message_id)
+	end
+
+	def edit_admin_message
+		if request.post?
+            @adminmessage = AdminMessage.find(params[:id])
+            if @adminmessage.update_attributes(params[:adminmessage])
+               if @adminmessage.save
+               	flash[:notice] = 'The admin message was successfully edited.'
+               	session[:user] = User.find session[:user].id
+               	redirect_to :controller => 'mailinglist', 
+                            :action => 'show', 
+                            :id => params[:id]
+               end
+            end
+        else
+          @adminmessage = AdminMessage.find(params[:id])
+     end
+	end
+
+	def new_admin_message
+		
+	end
+
+	def remove_admin_message
+	end
+
+# 
+#     private
+#     def get_password
+#         password = ask "Password: " do |q| q.echo = false end
+#         confirmation = ask "Confirm: " do |q| q.echo = false end
+#         
+#         return [ password, confirmation ]
+#     end
+# 
+#     def format_errors errors
+#         errors.map do |facility, text|
+#             "    #{facility}: #{text}\n"
+#         end
+#     end
+# 
+#     def error(error_text)
+#         callername = caller[0].gsub(/.*\`(\w+)\'.*/, '\1')
+#         @error = "#{callername}: #{error_text}"
+#         nil
+#     end
+# 
+#     def message(message_text)
+#         callername = caller[0].gsub(/.*\`(\w+)\'.*/, '\1')
+#         @messages ||= []
+#         @messages << "#{callername}: #{message_text}"
+#     end
+# 
+#     def ask_description(thing)
+#         description = ask "Description for #{thing}: "
+#         if description == "" then description = nil end
+#         description
+#     end
+# 
+#     public
+# 
+#     def init
+#         @alreadythere = []
+#         [ MailinglistClass, AdminMessage, SysConfig, Help ].each do |table|
+#             fixture = YAML.load(File.read(File.join(RAILS_ROOT,
+#                                                     "test",
+#                                                     "fixtures",
+#                                                     table.name.tableize + 
+#                                                         ".yml")))
+#             fixture.values.sort_by do |values| values["id"].to_i end . 
+#                 each do |values|
+#                 begin
+#                     table.find values["id"]
+#                     @alreadythere << "%s[%s]" % [ table.name, values["id"] ]
+#                 rescue ActiveRecord::RecordNotFound
+#                     configvar = table.new values
+#                     configvar.id = values["id"].to_i # hohoho
+#                     configvar.save
+#                 end
+#             end
+#         end
+#     end
+# 
+#     def show_config(var_name=nil)
+#         unless var_name
+#             @config_vars = SysConfig.find_all
+#         else
+#             @config_vars = SysConfig.find_all_by_name(var_name)
+#         end
+#     end
+# 
+#     def set_config(var_name, new_value)
+#         @config_var = SysConfig.find_by_name(var_name)
+#         @config_var.value = new_value
+#         @config_var.save
+#     end
+# 
+#     def list_domains
+#         @domains = Domain.find_all
+#     end
+# 
+#     def list_mailinglists(domain_name)
+#         domain = Domain.find_by_name(domain_name)
+#         if domain then
+#             @mailinglists = domain.mailinglists
+#         else
+#             error "#{domain_name}: not found"
+#         end
+#     end
+# 
+#     def list_addresses(mailinglist_address)
+#         @mailinglist = Mailinglist.find_by_address(mailinglist_address)
+#         if @mailinglist then 
+#             @mailinglist=@mailinglist[0]
+#             @addresses = @mailinglist.addresses
+#         else
+#             error "#{mailinglist_address}: not found"
+#         end
+#     end
+# 
+#     def create_domain(domain_name)
+#         @messages = []
+# 
+#         domain = Domain.find_by_name domain_name
+#         if domain == nil then
+#             password, confirmation = get_password 
+#             domain = Domain.new
+#             domain.name = domain_name
+#             domain.password = password
+#             domain.password_confirmation = confirmation
+#             if domain.save then
+#                 message "Domain \"#{domain_name}\" created successfully."
+#             else
+#                 error "Could not create domain \"#{domain_name}\":\n" +
+#                     format_errors(domain.errors).join
+#             end
+#         else 
+#             error "Domain \"#{domain_name}\" already exists."
+#         end
+#     end
+# 
+#     def create_user domain_name, username, 
+#                     email_address = nil, 
+#                     description = nil
+#         domain = Domain.find_by_name domain_name
+#         if domain then
+#             password, password_confirmation = get_password
+# 
+#             if email_address == nil then
+#                 email_address = ask "Address to forward #{username}'s email to: "
+#                 if email_address == "" then email_address = nil end
+#             end
+# 
+#             description ||= ask_description(username)
+# 
+#             user = User.new
+#             user.domain = domain
+#             user.login = username
+#             user.password = password
+#             user.password_confirmation = password_confirmation
+#             user.description = description
+#             user.domainadmin = false
+#             user.mailadmin = false
+#             
+#             if user.save then
+#                 message "User \"#{username}@#{domain_name}\" created successfully"
+#                 if email_address then
+#                     addr=Address.find_or_create_by_address(email_address)
+#                     user.addresses << addr
+#                 end
+#             else
+#                 error "User \"#{username}@#{domain_name}\" was not created:\n" + 
+#                     format_errors(user.errors).join("\n")
+#             end
+#         else
+#             error "Domain \"#{domain_name}\" does not exist."
+#         end
+#     end
+# 
+#     def list_users domain_name
+#         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
+#     end
+# 
+#     def list_mailinglist_classes
+#         @mailinglist_classes = MailinglistClass.find :all, :order => :id
+#     end
+# 
+#     def list_mlclasses
+#         list_mailinglist_classes
+#         render "sugoi_admin/list_mailinglist_classes"
+#     end
+# 
+#     def create_list mailinglist_name, 
+#         domain_name, user_name, description = nil, mailinglist_class_id = 2
+# 
+#         mlclass = begin 
+#                       MailinglistClass.find mailinglist_class_id.to_i
+#                   rescue ActiveRecord::RecordNotFound
+#                       nil
+#                   end
+#         unless mlclass
+#             return error("Invalid mailing list class: #{mailinglist_class_id}")
+#         end
+# 
+#         domain = Domain.find_by_name domain_name 
+#         unless domain
+#             return error("Domain \"#{domain_name}\" not found.")
+#         end
+# 
+#         user = User.find_by_login_and_domain_id user_name, domain.id 
+#         unless user
+#             return error("User \"#{user_name}\" not found "+
+#                          "in domain \"#{domain_name}\".")
+#         end
+# 
+#         ml=Mailinglist.new
+#         ml.user = user
+#         ml.description = description
+#         ml.mailinglist_class = mlclass
+#         ml.name = mailinglist_name
+# 
+#         if ml.save then
+#             message "Mailing list \"#{ml.address}\" created successfully."
+#         end
+#     end
+# 
+#     def subscribe(mailinglist_address, new_address)
+#        address=Address.find_or_create_by_address new_address
+#        ml=Mailinglist.find_by_address(mailinglist_address)
+#        unless ml
+#            return error("Mailing list \"#{mailinglist_address}\" not found.")
+#        end
+#        ml=ml[0]
+#        ml.addresses << address
+#        message "Subscribed \"#{new_address}\" to \"#{mailinglist_address}\"" 
+#     end
+# 
+#     def unsubscribe(mailinglist_address, address_to_remove)
+#         address = Address.find_by_address address_to_remove
+#         unless address
+#             return error("Address \"#{address_to_remove}\" unknown.")
+#         end
+# 
+#         mailinglist = Mailinglist.find_by_address mailinglist_address
+#         unless mailinglist
+#             return error("Mailing list \"#{mailinglist_address}\" unknown.")
+#         end
+# 
+#         @mailinglist = mailinglist[0]
+# 
+#         unless @mailinglist.addresses.member? address
+#             return error("Address \"#{address}\" not in " + "
+#                 mailing list \"#{mailinglist_address}\"")
+#         end
+# 
+#         @removed_addresses=@mailinglist.remove_addresses address
+#     end
+# 
+#     def help(command=nil)
+#         if command
+#             @help = Help.find_by_facility_and_command self.class.name, command
+#         else
+#             @help = Help.find_all_by_facility self.class.name
+#         end
+#     end
+end