parlement 0.6 → 0.7

data/CHANGES

@@ -1,5 +1,18 @@
 - parlement changelog
 
+== Version 0.7
+
+Avatars
+
+* avatar initial upload
+* correcting an automatic elt id generation, now removing all non characters
+* avatar upload, reception and emission by mail
+* addition of a "people" page listing all current and past avatars
+* logout now possible in text based browsers
+* attachments now derive their id from their element's subject
+* >> for one liners now better placed as floats
+* going from pluging output_compress to output_compression
+
 == Version 0.6
 
 Voting using V and Λ buttons (picturing -1 and +1 values, down and up).

data/README

@@ -1,4 +1,11 @@
-I am using debian, so here are a few commands I use:
+                                 _                           _   
+                _ __   __ _ _ __| | ___ _ __ ___   ___ _ __ | |_ 
+               | '_ \ / _` | '__| |/ _ \ '_ ` _ \ / _ \ '_ \| __|
+               | |_) | (_| | |  | |  __/ | | | | |  __/ | | | |_ 
+               | .__/ \__,_|_|  |_|\___|_| |_| |_|\___|_| |_|\__|
+               |_|                                               
+
+I use debian, here are the commands I use to setup my machine for parlement:
 # apt-get install postgresql
 # sudo su - postgres
 # createuser /your_login/
@@ -7,12 +14,16 @@ I am using debian, so here are a few commands I use:
 # apt-get install irb
 # apt-get install rdoc
 
--> why???
-# ln -s /sbin/ifconfig /bin/
+Basically this install postgresql, ruby and the ruby driver to psql. Ruby on
+Rails is database agnostic, parlement will be sometimes in the near future.
 
+You need to install "ruby gems":http://docs.rubygems.org
+
+And then:
 # gem install rails
 # gem install redcloth
-Only if you expect to develop and release:
+
+Only if you expect to develop and do any release:
 # gem install meta_project
 
 
@@ -20,49 +31,51 @@ The database is setup for user "manu", you may need to change the file
 config/database.yml for your own settings.
 
 Change config/environment.rb to set the domain, default is something like
-'leparlement.org', define it as your web site or email domain.
+'leparlement.org', use your web site or email domain.
 
-In procmail, define a rule to redirect the relevant mail to parlement, I use:
-:0 c
-* ^TO parlement|leparlement.org
-| /home/manu/parlement/trunk/script/runner 'Mailman.receive STDIN.read'
+When you want to setup your server as a node in the graph of servers, redirect
+your incoming mails to *your* parlement. In procmail (or any other mail
+filtering tool), define this kind of rule:
+	:0 c
+	* ^TO parlement|leparlement.org
+	| /home/manu/parlement/trunk/script/runner 'Mailman.receive STDIN.read'
 
 
 Once you have everything set up (ruby, postgresql, redcloth, irb), you can
-launch parlement thus:
-~ cd parlement
+initialise and launch parlement this way:
+
+Go into the right folder
+~ cd parlement/trunk
+
+Create the db
 ~ psql -q template1 -f db/schema.sql
+
+Populate the db
 ~ ruby lib/data_import.rb
+
+Migrate the db to its last version
+~ rake migrate
+
+Launch the developement web server
 ~ ruby ./script/server
 
+Now you can go to http://localhost:3000 with your browser.
+
+You can check that everything works all right on your machine with the testing suite:
+~ rake
+
+
+                   __        __   _                          
+                   \ \      / /__| | ___ ___  _ __ ___   ___ 
+                    \ \ /\ / / _ \ |/ __/ _ \| '_ ` _ \ / _ \
+                     \ V  V /  __/ | (_| (_) | | | | | |  __/
+                      \_/\_/ \___|_|\___\___/|_| |_| |_|\___|
+                                                             
+
+
+
 
-Now you can go to localhost:3000
-
-
-The problem: "how to display conversations"
-The entities involved:
-	- element
-	- ancestor
-	- children
-	- children number
-	- author
-	- element's size
-	- title
-	- body
-The possibilities
-	- show one element and its children closed
-	- show one element opened and its children closed
-	- show one element and its children opened, its grand children closed
-	- show one element opened, its children and grand children opened
-	- when an element is closed, also show its children?
-Limits
-	- can not display all elements at once
-	- can not display one element and all its direct children at once
-Parameters
-	- ordering
-	- date
-	- number of children displayed
-	- votes
+What is below is just for future personal reference...
 
 
 # Here is my console code to reset threads from their original mails:

data/app/controllers/account_controller.rb

@@ -5,7 +5,7 @@ class AccountController < UserController
 	model :person
   model :user
 
-  def login
+	def login
 		# Cleaning up
 		session[:person] = session[:user] = nil
 
@@ -21,11 +21,9 @@ class AccountController < UserController
 			# Create the pseudo
 			begin
 				Person.transaction(@person) do
-					@person = Person.new
-					@person.name = login
+					@person = Person.new :id => login.gsub(/\s/, '_'), :name => login
 					if @person.save
-						logger.info "person: "+@person.to_s
-						logger.info "person.id: "+@person.id.to_s
+						logger.info "person.id: #{@person.id}, name: #{@person.name}"
 						flash.now[:notice]  = "Pseudo created"
 						session[:person] = @person
 					else
@@ -105,7 +103,7 @@ class AccountController < UserController
 
 				elsif email == @person.email
 					# User protected by password and with the same email as entered
-          key = @user.generate_security_token
+					key = @user.generate_security_token
 					url =  url_for(:action => 'check_key')
 					url += "?user[id]=#{@user.id}&key=#{key}"
 					UserNotify::deliver_forgot_password(@user, url)
@@ -116,17 +114,17 @@ class AccountController < UserController
 
 		render :partial => 'show', :locals => {
 			:divId => params[:divId], :choices => getAllVotes }
-  end
+	end
 
 
-  def logout
-    session[:person] = @person = nil
-    session[:user] = @user = nil
+	def logout
+		session[:person] = @person = nil
+		session[:user] = @user = nil
 		render :partial => 'show', :locals => {
 			:divId => params[:divId], :choices => getAllVotes }
-  end
+	end
 
-  def check_key
+	def check_key
 		if @user = User.authenticate_by_token(@params[:user][:id], @params[:key])
 			#@user = User.find(:first, :conditions => "security_token = '#{params[:key]}'")
 			@person = Person.find_by_name(@user.login) if @user
@@ -139,7 +137,7 @@ class AccountController < UserController
 				<br/> \
 				<a href='#{url_for :controller => 'elt', :action => 'show', :id => nil }'>\
 					Back</a>",
-				:layout => 'top'
+					:layout => 'top'
 		else
 			render :text => "<h3>Sorry, no corresponding check key :-(</h3> \
 					<br/> \
@@ -149,41 +147,71 @@ class AccountController < UserController
 		end
 	end
 
+	def setAvatar
+		logger.info "Setting up an avatar for person #{session[:person].name}"
+
+		@elt = Elt.find_by_id 'people'
+		if !@elt
+			@elt = Elt.new :parent_id => 'ROOT', :subject => 'people', :body => ''
+			@elt.save!
+			@elt.publish
+			@elt.parent.add_child @elt
+		end
+		avatar = @elt.children.build :person => session[:person], :body => ""
+		att = avatar.attachments.build :file => params[:person][:image],
+			:content_type => params[:person][:image].content_type
+
+		avatar.subject = att.file.gsub /^.*public.*\//, ''
+		avatar.publish
+		@elt.add_child avatar
+
+		@person = session[:person]
+		@person.image = "/attachment/file/#{att.file_relative_path}"
+		@person.save!
+
+		responds_to_parent do
+			render :update do |page|
+				page << "$('person_avatar').src = '#{@person.image}';"
+			end
+		end
+	end
+
 
-	# Mostly copied from the login engine
 	protected
-  def signup
+
+	# Mostly copied from the login engine
+	def signup
 		if @person and not @user
 			@user = User.new
 			@user.login = @person.name
 		end
 
 		@user.email = @params[:person][:email]
-    begin
-      User.transaction(@user) do
-        unless LoginEngine.config(:use_email_notification)
-          @user.verified = 1
-        end
-        if @user.save
-          key = @user.generate_security_token
-          #url = url_for(:action => 'home', 'user[id]' => @user.id, :key => key)
+		begin
+			User.transaction(@user) do
+				unless LoginEngine.config(:use_email_notification)
+					@user.verified = 1
+				end
+				if @user.save
+					key = @user.generate_security_token
+					#url = url_for(:action => 'home', 'user[id]' => @user.id, :key => key)
 					url =  url_for(:action => 'check_key')
 					url += "?user[id]=#{@user.id}&key=#{key}"
-          #flash[:notice] = 'Signup successful!'
+					#flash[:notice] = 'Signup successful!'
 					flash.now['notice 3']  = 'Confirmation email sent to '+@user.email
-          if LoginEngine.config(:use_email_notification)
-            UserNotify.deliver_signup(@user, params[:user][:password], url)                               
-            flash['notice 4'] = ' Please check your registered email account to verify your account registration.'
-          end
-          #redirect_to :action => 'login'
-        end
-      end
-    rescue Exception => e 
-      flash.now[:notice] = nil
-      flash.now[:warning] = 'Error creating account: confirmation email not sent'
-      logger.error e
-    end
-  end
+					if LoginEngine.config(:use_email_notification)
+						UserNotify.deliver_signup(@user, params[:user][:password], url)                               
+						flash['notice 4'] = ' Please check your registered email account to verify your account registration.'
+					end
+					#redirect_to :action => 'login'
+				end
+			end
+		rescue Exception => e 
+			flash.now[:notice] = nil
+			flash.now[:warning] = 'Error creating account: confirmation email not sent'
+			logger.error e
+		end
+	end
 
 	def getAllVotes
 		return if !params[:divId]

data/app/controllers/application.rb

@@ -9,7 +9,7 @@ class ApplicationController < ActionController::Base
 
   before_filter :set_charset
 	after_filter :fix_unicode_for_safari
-	after_filter :compress_output
+	after_filter OutputCompressionFilter
 
 	# automatically and transparently fixes utf-8 bug 
 	# with Safari when using xmlhttp

data/app/controllers/elt_controller.rb

@@ -115,6 +115,7 @@ class EltController < ApplicationController
 
 		vote.publish
 		@elt.add_child vote
+		expire_fragment :action => 'show', :id => @elt.id
 
 		render :partial => '/elt/choice', :locals => { :elt => @elt }
 	end

data/app/models/elt.rb

@@ -4,21 +4,27 @@
 # It holds all posts, that's mostly a subject and a body, plus their
 # relationships in a tree of elements
 #
+# An element is linked to:
+# - mail
+# - person
+# - voters
+# - choices
+# - attachments
+# - subscribers
+#
+# The element id is generated from the subject for better readability (but only
+# normal characters are used)
+#
 class Elt < ActiveRecord::Base
-	usesguid
-
-	acts_as_nested_set :order => "position is not null, position, created_on"
-	acts_as_tree :order => "position is not null, position, created_on", :counter_cache => true
-
 	has_one :mail, :dependent => true
-	has_many :attachments, :dependent => true
-
 	belongs_to :person
-
+	has_many :voters, :through => :choices, :source => :person
+	has_many :choices, :dependent => true, :order => "choices.created_on"
+	has_many :attachments, :dependent => true
 	has_and_belongs_to_many :subscribers, :class_name => "Person", :join_table => "subscribers"
 
-	has_many :choices, :dependent => true, :order => "choices.created_on"
-	has_many :voters, :through => :choices, :source => :person
+	acts_as_nested_set :order => "position is not null, position, created_on"
+	acts_as_tree :order => "position is not null, position, created_on", :counter_cache => true
 
 	# Just a quick method to get all subscribers as a simple list
 	def all_recipients
@@ -53,7 +59,7 @@ class Elt < ActiveRecord::Base
 		save!
 
 		parent.vote Regexp.last_match(1), person if body =~ /^\s*(-1|0|\+1)(\s|$)/
-		if self.body.gsub(/(-1|0|\+1)/, '').strip.empty?
+		if Regexp.last_match(1) and self.body.gsub(/(-1|0|\+1)/, '').strip.empty?
 			# Hide simple votes
 			vote -1
 		else
@@ -63,12 +69,17 @@ class Elt < ActiveRecord::Base
 	end
 
 	def save
-		if new_record? and subject and not subject.empty?
+		if new_record?
 			# Let's generate a nice looking id
-			self.id = new_id = subject.gsub(/\[[\w-]*\]/, '').strip.gsub(/[\s\?\&\#\\\/:]+/, '_')
+			self.id = new_id = subject.gsub(/\[[\w-]*\]/, '').strip \
+				.gsub(/\s/, '_').gsub(/[^\w]+/, '').gsub(/_+/, '_') \
+				.gsub(/(^_|_$)/, '') \
+				if subject
+			self.id ||= "elt"
 
 			discrim = 0
-			self.id = "#{new_id}_#{discrim}" while discrim += 1 and self.class.find_by_id self.id
+			self.id = "#{new_id}_#{discrim}" \
+				while discrim += 1 and self.class.find_by_id self.id
 		end
 
 		super

data/app/models/mail.rb

@@ -2,7 +2,7 @@
 # Receive a mail from which an elt is created.
 #
 # An associated mail is kept to make sure we don't lose any data. Attachments
-# are also created in an associated table
+# are also managed in an associated table
 #
 class Mail < ActiveRecord::Base
 	usesguid
@@ -24,9 +24,7 @@ class Mail < ActiveRecord::Base
 			logger.info "Already received (id: #{mail.message_id})...\n"
 
 		else
-			m = Mail.new
-			m.receive mail
-			m
+			Mail.new.receive mail
 		end
 	end
 
@@ -46,24 +44,10 @@ class Mail < ActiveRecord::Base
 	#
 	def receive(mail)
 		logger.info "Receive mail #{mail.message_id}"
-		if mail['X-Leparlement-Elt-Id'] then
-			build_elt :id => mail['X-Leparlement-Elt-Id'].to_s,
-				:created_on => mail.date,
-				:subject => unquote(mail.subject),
-				:body => '',
-				:mail => self
-		else
-			build_elt :created_on => mail.date,
-				:subject => unquote(mail.subject),
-				:body => '',
-				:mail => self
-		end
-
-		elt.person = Person.find_by_email(mail.from) \
-			|| Person.find_by_name(unquote(mail.friendly_from)) \
-			|| elt.build_person
-		elt.person.name = unquote mail.friendly_from
-		elt.person.email = mail.from.first
+		build_elt :created_on => mail.date,
+			:subject => unquote(mail.subject),
+			:body => '',
+			:mail => self
 
 		# Try to find its mail parent in the db
 		if mail.in_reply_to and Mail.find_by_message mail.in_reply_to
@@ -110,11 +94,24 @@ class Mail < ActiveRecord::Base
 
 		mngAttachment(mail) if mail
 
-		self.message = mail.message_id
+		elt.person = Person.find_by_email(mail.from) \
+			|| Person.find_by_name(unquote(mail.friendly_from)) \
+			|| elt.build_person(:id =>  unquote(mail.friendly_from).gsub(/\s/, '_'),
+													:name => unquote(mail.friendly_from),
+													:email => mail.from.first)
+
 		self.mail_parents = mail.references
+		self.message = mail.message_id
 		self.file = mail.encoded
 		elt.publish
+
+		if mail.to.to_s.match(/people@#{ActionMailer::Base.server_settings[:domain]}/)
+			elt.person.image = "/attachment/file/#{elt.attachments.first.file_relative_path}"
+			elt.person.save
+		end
+
 		elt.parent.add_child elt
+		self
 	end
 
 	"""            _     _ _     _     
@@ -172,7 +169,6 @@ class Mail < ActiveRecord::Base
 
 		# Added to make sure it is not lost, but not modified if already existant
 		mail['X-Message-Id'] = mail.message_id if not mail['X-Message-Id']
-		mail['X-leparlement-elt-Id'] = elt.id
 
 		MailNotify::deliver(mail) if mail.destinations and not mail.destinations.empty?
 
@@ -194,7 +190,20 @@ class Mail < ActiveRecord::Base
 
 	# Get and store the attachments
 	def mngAttachment(attachment)
-		if attachment.content_type == 'text/plain'
+		if attachment.multipart?
+			attachment.parts.each { |part| mngAttachment part }
+		elsif attachment.disposition_param 'filename'
+			File.open("/tmp/#{attachment.disposition_param('filename')}", 'w') { |file|
+				file << attachment.body
+				elt.attachments.build :file => file, :content_type => attachment.content_type
+			}
+		elsif attachment.type_param 'name'
+			File.open("/tmp/#{attachment.type_param('name')}", 'w') { |file|
+				file << attachment.body
+				elt.attachments.build :file => file, :content_type => attachment.content_type
+			}
+		elsif attachment.content_type.match(/text\/plain/) \
+			or (!attachment.content_type and attachment.parts.size == 0)
 			charset = attachment.type_param 'charset'
 			if charset and !charset.empty?
 				if attachment.transfer_encoding == 'quoted-printable'
@@ -206,17 +215,9 @@ class Mail < ActiveRecord::Base
 					elt.body += Iconv.new(charset, 'utf-8').iconv(attachment.body)
 				end
 			else
-				elt.body += attachment.body
+				# Here too have to remove any eventual null character!
+				elt.body += attachment.body.gsub(/\0/, '')
 			end
-
-		elsif attachment.multipart?
-			attachment.parts.each { |part| mngAttachment part }
-
-		elsif attachment.type_param 'name'
-			File.open('/tmp/'+attachment.type_param('name'), 'w') { |file|
-				file << attachment.body
-				elt.attachments.build :file => file
-			}
 		end
 	end
 end

data/app/models/mail_notify.rb

@@ -23,6 +23,29 @@ class MailNotify < ActionMailer::Base
 		# Try to render the element as html
 		body :elt => elt
 
+		templates = Dir.glob("#{template_path}/#{@template}.*")
+		templates.each do |path|
+			# TODO: don't hardcode rhtml|rxml
+			basename = File.basename(path)
+			next unless md = /^([^\.]+)\.([^\.]+\.[^\+]+)\.(rhtml|rxml)$/.match(basename)
+			template_name = basename
+			content_type = md.captures[1].gsub('.', '/')
+			@parts << ActionMailer::Part.new(:content_type => content_type,
+																			 :disposition => "inline", :charset => charset,
+																			 :body => render_message(template_name, @body))
+		end
+		unless @parts.empty?
+			@content_type = "multipart/alternative"
+			@parts = sort_parts(@parts, @implicit_parts_order)
+		end
+
+		elt.attachments.each { |att|
+			attachment(att.content_type ? att.content_type : "") { |a|
+				a.filename = att.file.gsub /^.*public.*\//, ''
+				a.body = File.read(att.file)
+			}
+		}
+
 		# This is the essential of a mailing list, you reply to the mailing list,
 		# where every body sends their mail.
 		# This very mail can be a mailing list all by itself...

data/app/views/account/_login.rhtml

@@ -2,7 +2,7 @@
 	:update => divId,
 	:url => { :controller => 'account', :action => 'login', :divId => divId },
 	:before => visual_effect(:SwitchOff, divId)+";resetChoices();",
-	:complete => visual_effect(:BlindDown, divId)) %>
+	:loaded => visual_effect(:BlindDown, divId)) %>
 
 	<%= hidden_field 'elt', 'id' if @elt %>
 

data/app/views/account/_show.rhtml

@@ -18,13 +18,14 @@
 	</div>
 <% end %>
 
-<% if session[:person] %>
+<% if @person = session[:person] %>
 	<span class="logout">
 		<%= link_to_remote('[X]',
-			:update => divId,
-			:url => { :controller => 'account', :action => 'logout', :divId => divId },
-			:before => visual_effect(:SwitchOff, divId)+";resetChoices();",
-			:complete => visual_effect(:BlindDown, divId)) %>
+			{ :update => divId,
+				:url => { :controller => 'account', :action => 'logout', :divId => divId },
+				:before => visual_effect(:SwitchOff, divId)+";resetChoices();",
+				:complete => visual_effect(:BlindDown, divId) },
+			{ :href => url_for(:controller => 'account', :action => 'logout') }) %>
 	</span>
 
 	<% if session[:person].name and session[:person].name != '' %>
@@ -35,6 +36,22 @@
 				:id => session[:person] %>&gt;
 		</span>
 	<% end %>
+
+	<div>
+		<%= image_tag (@person.image ? @person.image : "/javascripts/blank.gif"),
+				:id => "person_avatar", :class => "avatar" %>
+	</div>
+
+	<%= form_tag( { :controller => "account", :action => "setAvatar"},
+			:multipart => true, :target => "avatar", :class => "setAvatar") %>
+		<label>
+			Avatar:
+			<%= file_field "person", "image", :onchange => "submit()" %>
+		</label>
+		<%= submit_tag 'Ok' %>
+	<%= end_form_tag %>
+
+	<iframe id="avatar" name="avatar" style="display: none"></iframe>
 <% else %>
 
 	<%= render :partial => '/account/login', :locals => { :divId => divId } %>