jro_apps/redmine Commit - r527:bca5bd9c6276

Added watchers for message boards (watchers controller modified to support any watchable model)....

Jean-Philippe Lang -

r527:bca5bd9c6276

parent child

Context file:

r527:bca5bd9c6276

Collapse all files

app/controllers/boards_controller.rb +2 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class BoardsController < ApplicationController
               layout 'base'
               before_filter :find_project
               before_filter :authorize, :except => [:index, :show]
               before_filter :check_project_privacy, :only => [:index, :show]
               helper :messages
               include MessagesHelper
               helper :sort
               include SortHelper
+              helper :watchers
+              include WatchersHelper
               def index
                 @boards = @project.boards
                 # show the board if there is only one
                 if @boards.size == 1
                   @board = @boards.first
                   show
                   render :action => 'show'
                 end
               end
               def show
                 sort_init "#{Message.table_name}.updated_on", "desc"
                 sort_update
                 @topic_count = @board.topics.count
                 @topic_pages = Paginator.new self, @topic_count, 25, params['page']
                 @topics =  @board.topics.find :all, :order => sort_clause,
                                               :include => [:author, {:last_reply => :author}],
                                               :limit  =>  @topic_pages.items_per_page,
                                               :offset =>  @topic_pages.current.offset
                 render :action => 'show', :layout => false if request.xhr?
               end
               verify :method => :post, :only => [ :destroy ], :redirect_to => { :action => :index }
               def new
                 @board = Board.new(params[:board])
                 @board.project = @project
                 if request.post? && @board.save
                   flash[:notice] = l(:notice_successful_create)
                   redirect_to :controller => 'projects', :action => 'settings', :id => @project, :tab => 'boards'
                 end
               end
               def edit
                 if request.post? && @board.update_attributes(params[:board])
                   case params[:position]
                   when 'highest'; @board.move_to_top
                   when 'higher'; @board.move_higher
                   when 'lower'; @board.move_lower
                   when 'lowest'; @board.move_to_bottom
                   end if params[:position]
                   redirect_to :controller => 'projects', :action => 'settings', :id => @project, :tab => 'boards'
                 end
               end
               def destroy
                 @board.destroy
                 redirect_to :controller => 'projects', :action => 'settings', :id => @project, :tab => 'boards'
               end
             private
               def find_project
                 @project = Project.find(params[:project_id])
                 @board = @project.boards.find(params[:id]) if params[:id]
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

app/controllers/issues_controller.rb +2 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class IssuesController < ApplicationController
               layout 'base', :except => :export_pdf
               before_filter :find_project, :authorize
               cache_sweeper :issue_sweeper, :only => [ :edit, :change_status, :destroy ]
               helper :custom_fields
               include CustomFieldsHelper
               helper :ifpdf
               include IfpdfHelper
               helper :issue_relations
               include IssueRelationsHelper
+              helper :watchers
+              include WatchersHelper
               def show
                 @status_options = @issue.status.find_new_statuses_allowed_to(logged_in_user.role_for_project(@project), @issue.tracker) if logged_in_user
                 @custom_values = @issue.custom_values.find(:all, :include => :custom_field)
                 @journals_count = @issue.journals.count
                 @journals = @issue.journals.find(:all, :include => [:user, :details], :limit => 15, :order => "#{Journal.table_name}.created_on desc")
               end
               def history
                 @journals = @issue.journals.find(:all, :include => [:user, :details], :order => "#{Journal.table_name}.created_on desc")
                 @journals_count = @journals.length
               end
               def export_pdf
                 @custom_values = @issue.custom_values.find(:all, :include => :custom_field)
                 @options_for_rfpdf ||= {}
                 @options_for_rfpdf[:file_name] = "#{@project.name}_#{@issue.id}.pdf"
               end
               def edit
                 @priorities = Enumeration::get_values('IPRI')
                 if request.get?
                   @custom_values = @project.custom_fields_for_issues(@issue.tracker).collect { |x| @issue.custom_values.find_by_custom_field_id(x.id) || CustomValue.new(:custom_field => x, :customized => @issue) }
                 else
                   begin
                     @issue.init_journal(self.logged_in_user)
                     # Retrieve custom fields and values
                     @custom_values = @project.custom_fields_for_issues(@issue.tracker).collect { |x| CustomValue.new(:custom_field => x, :customized => @issue, :value => params["custom_fields"][x.id.to_s]) }
                     @issue.custom_values = @custom_values
                     @issue.attributes = params[:issue]
                     if @issue.save
                       flash[:notice] = l(:notice_successful_update)
                       redirect_to :action => 'show', :id => @issue
                     end
                   rescue ActiveRecord::StaleObjectError
                     # Optimistic locking exception
                     flash[:notice] = l(:notice_locking_conflict)
                   end
                 end
               end
               def add_note
                 unless params[:notes].empty?
                   journal = @issue.init_journal(self.logged_in_user, params[:notes])
                   if @issue.save
                     flash[:notice] = l(:notice_successful_update)
                     Mailer.deliver_issue_edit(journal) if Permission.find_by_controller_and_action(params[:controller], params[:action]).mail_enabled?
                     redirect_to :action => 'show', :id => @issue
                     return
                   end
                 end
                 show
                 render :action => 'show'
               end
               def change_status
                 @status_options = @issue.status.find_new_statuses_allowed_to(logged_in_user.role_for_project(@project), @issue.tracker) if logged_in_user
                 @new_status = IssueStatus.find(params[:new_status_id])
                 if params[:confirm]
                   begin
                     journal = @issue.init_journal(self.logged_in_user, params[:notes])
                     @issue.status = @new_status
                     if @issue.update_attributes(params[:issue])
                       # Save attachments
                       params[:attachments].each { |file|
                         next unless file.size > 0
                         a = Attachment.create(:container => @issue, :file => file, :author => logged_in_user)
                         journal.details << JournalDetail.new(:property => 'attachment',
                                                              :prop_key => a.id,
                                                              :value => a.filename) unless a.new_record?
                       } if params[:attachments] and params[:attachments].is_a? Array
                       flash[:notice] = l(:notice_successful_update)
                       Mailer.deliver_issue_edit(journal) if Permission.find_by_controller_and_action(params[:controller], params[:action]).mail_enabled?
                       redirect_to :action => 'show', :id => @issue
                     end
                   rescue ActiveRecord::StaleObjectError
                     # Optimistic locking exception
                     flash[:notice] = l(:notice_locking_conflict)
                   end
                 end
                 @assignable_to = @project.members.find(:all, :include => :user).collect{ |m| m.user }
               end
               def destroy
                 @issue.destroy
                 redirect_to :controller => 'projects', :action => 'list_issues', :id => @project
               end
               def add_attachment
                 # Save the attachments
                 @attachments = []
                 journal = @issue.init_journal(self.logged_in_user)
                 params[:attachments].each { |file|
                   next unless file.size > 0
                   a = Attachment.create(:container => @issue, :file => file, :author => logged_in_user)
                   @attachments << a unless a.new_record?
                   journal.details << JournalDetail.new(:property => 'attachment',
                                                        :prop_key => a.id,
                                                        :value => a.filename) unless a.new_record?
                 } if params[:attachments] and params[:attachments].is_a? Array
                 journal.save if journal.details.any?
                 Mailer.deliver_attachments_add(@attachments) if !@attachments.empty? and Permission.find_by_controller_and_action(params[:controller], params[:action]).mail_enabled?
                 redirect_to :action => 'show', :id => @issue
               end
               def destroy_attachment
                 a = @issue.attachments.find(params[:attachment_id])
                 a.destroy
                 journal = @issue.init_journal(self.logged_in_user)
                 journal.details << JournalDetail.new(:property => 'attachment',
                                                      :prop_key => a.id,
                                                      :old_value => a.filename)
                 journal.save
                 redirect_to :action => 'show', :id => @issue
               end
               # Send the file in stream mode
               def download
                 @attachment = @issue.attachments.find(params[:attachment_id])
                 send_file @attachment.diskfile, :filename => @attachment.filename
               rescue
                 render_404
               end
             private
               def find_project
                 @issue = Issue.find(params[:id], :include => [:project, :tracker, :status, :author, :priority, :category])
                 @project = @issue.project
                 @html_title = "#{@project.name} - #{@issue.tracker.name} ##{@issue.id}"
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

app/controllers/watchers_controller.rb +18 -7

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class WatchersController < ApplicationController
               layout 'base'
               before_filter :require_login, :find_project, :check_project_privacy
               def add
-                @issue.add_watcher(logged_in_user)
+                user = logged_in_user
-                redirect_to :controller => 'issues', :action => 'show', :id => @issue
+                @watched.add_watcher(user)
+                respond_to do |format|
+                  format.html { render :text => 'Watcher added.', :layout => true }
+                  format.js { render(:update) {|page| page.replace_html 'watcher', watcher_link(@watched, user)} }
+                end
               end
               def remove
-                @issue.remove_watcher(logged_in_user)
+                user = logged_in_user
-                redirect_to :controller => 'issues', :action => 'show', :id => @issue
+                @watched.remove_watcher(user)
+                respond_to do |format|
+                  format.html { render :text => 'Watcher removed.', :layout => true }
+                  format.js { render(:update) {|page| page.replace_html 'watcher', watcher_link(@watched, user)} }
+                end
               end
             private
               def find_project
-                @issue = Issue.find(params[:issue_id])
+                klass = Object.const_get(params[:object_type].camelcase)
-                @project = @issue.project
+                return false unless klass.respond_to?('watched_by')
+                @watched = klass.find(params[:object_id])
+                @project = @watched.project
+              rescue
+                render_404
               end
             end

app/helpers/watchers_helper.rb +17 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             module WatchersHelper
+              def watcher_tag(object, user)
+                content_tag("span", watcher_link(object, user), :id => 'watcher')
+              end
+              def watcher_link(object, user)
+                return '' unless user && object.respond_to?('watched_by?')
+                watched = object.watched_by?(user)
+                url = {:controller => 'watchers',
+                       :action => (watched ? 'remove' : 'add'),
+                       :object_type => object.class.to_s.underscore,
+                       :object_id => object.id}
+                link_to_remote((watched ? l(:button_unwatch) : l(:button_watch)),
+                               {:url => url},
+                               :href => url_for(url),
+                               :class => (watched ? 'icon icon-fav' : 'icon icon-fav-off'))
+              end
             end

app/models/board.rb +1 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class Board < ActiveRecord::Base
               belongs_to :project
               has_many :topics, :class_name => 'Message', :conditions => "#{Message.table_name}.parent_id IS NULL", :order => "#{Message.table_name}.created_on DESC"
               has_many :messages, :dependent => :delete_all, :order => "#{Message.table_name}.created_on DESC"
               belongs_to :last_message, :class_name => 'Message', :foreign_key => :last_message_id
               acts_as_list :scope => :project_id
+              acts_as_watchable
               validates_presence_of :name, :description
               validates_length_of :name, :maximum => 30
               validates_length_of :description, :maximum => 255
             end

app/views/boards/show.rhtml +1 0

             <div class="contextual">
             <%= link_to l(:label_message_new), {:controller => 'messages', :action => 'new', :board_id => @board}, :class => "icon icon-add" %>
+            <%= watcher_tag(@board, @logged_in_user) %>
             </div>
             <h2><%=h @board.name %></h2>
             <table class="list">
               <thead><tr>
                 <th><%= l(:field_subject) %></th>
                 <th><%= l(:field_author) %></th>
                 <%= sort_header_tag("#{Message.table_name}.created_on", :caption => l(:field_created_on)) %>
                 <th><%= l(:label_reply_plural) %></th>
                 <%= sort_header_tag("#{Message.table_name}.updated_on", :caption => l(:label_message_last)) %>
               </tr></thead>
               <tbody>
               <% @topics.each do |topic| %>
                 <tr class="<%= cycle 'odd', 'even' %>">
                   <td><%= link_to h(topic.subject), :controller => 'messages', :action => 'show', :board_id => @board, :id => topic %></td>
                   <td align="center"><%= link_to_user topic.author %></td>
                   <td align="center"><%= format_time(topic.created_on) %></td>
                   <td align="center"><%= topic.replies_count %></td>
                   <td>
                   <small>
                     <% if topic.last_reply %>
                     <%= topic.last_reply.author.name %>, <%= format_time(topic.last_reply.created_on) %><br />
                     <%= link_to_message topic.last_reply %>
                     <% end %>
                   </small>
                   </td>
                 </tr>
               <% end %>
               </tbody>
             </table>
             <p><%= pagination_links_full @topic_pages %>
             [ <%= @topic_pages.current.first_item %> - <%= @topic_pages.current.last_item %> / <%= @topic_count %> ]</p>

app/views/issues/show.rhtml +1 -7

             <div class="contextual">
             <%= l(:label_export_to) %><%= link_to 'PDF', {:action => 'export_pdf', :id => @issue}, :class => 'icon icon-pdf' %>
             </div>
             <h2><%= @issue.tracker.name %> #<%= @issue.id %> - <%=h @issue.subject %></h2>
             <div class="box">
             <table width="100%">
             <tr>
                 <td style="width:15%"><b><%=l(:field_status)%> :</b></td><td style="width:35%"><%= @issue.status.name %></td>
                 <td style="width:15%"><b><%=l(:field_priority)%> :</b></td><td style="width:35%"><%= @issue.priority.name %></td>
             </tr>
             <tr>
                 <td><b><%=l(:field_assigned_to)%> :</b></td><td><%= @issue.assigned_to ? link_to_user(@issue.assigned_to) : "-" %></td>
                 <td><b><%=l(:field_category)%> :</b></td><td><%=h @issue.category ? @issue.category.name : "-" %></td>
             </tr>
             <tr>
                 <td><b><%=l(:field_author)%> :</b></td><td><%= link_to_user @issue.author %></td>
                 <td><b><%=l(:field_start_date)%> :</b></td><td><%= format_date(@issue.start_date) %></td>
             </tr>
             <tr>
                 <td><b><%=l(:field_created_on)%> :</b></td><td><%= format_date(@issue.created_on) %></td>
                 <td><b><%=l(:field_due_date)%> :</b></td><td><%= format_date(@issue.due_date) %></td>
             </tr>
             <tr>
                 <td><b><%=l(:field_updated_on)%> :</b></td><td><%= format_date(@issue.updated_on) %></td>
                 <td><b><%=l(:field_done_ratio)%> :</b></td><td><%= @issue.done_ratio %> %</td>
             </tr>
             <tr>
                 <td><b><%=l(:field_fixed_version)%> :</b></td><td><%= @issue.fixed_version ? @issue.fixed_version.name : "-" %></td>
                 <td><b><%=l(:label_spent_time)%> :</b></td>
                 <td><%= @issue.spent_hours > 0 ? (link_to lwr(:label_f_hour, @issue.spent_hours), {:controller => 'timelog', :action => 'details', :issue_id => @issue}, :class => 'icon icon-time') : "-" %></td>
             </tr>
             <tr>
             <% n = 0
             for custom_value in @custom_values %>
                 <td><b><%= custom_value.custom_field.name %> :</b></td><td><%= h(show_value(custom_value)) %></td>
             <% n = n + 1
                if (n > 1)
                     n = 0 %>
                     </tr><tr>
              <%end
             end %>
             </tr>
             </table>
             <hr />
             <% if @issue.changesets.any? %>
             <div style="float:right;">
               <em><%= l(:label_revision_plural) %>: <%= @issue.changesets.collect{|changeset| link_to(changeset.revision, :controller => 'repositories', :action => 'revision', :id => @project, :rev => changeset.revision)}.join(", ") %></em>
             </div>
             <% end %>
             <b><%=l(:field_description)%> :</b><br /><br />
             <%= textilizable @issue.description %>
             <br />
             <div class="contextual">
             <%= link_to_if_authorized l(:button_edit), {:controller => 'issues', :action => 'edit', :id => @issue}, :class => 'icon icon-edit' %>
             <%= link_to_if_authorized l(:button_log_time), {:controller => 'timelog', :action => 'edit', :issue_id => @issue}, :class => 'icon icon-time' %>
-            <% if @logged_in_user %>
+            <%= watcher_tag(@issue, @logged_in_user) %>
-              <% if @issue.watched_by?(@logged_in_user) %>
-            <%= link_to l(:button_unwatch), {:controller => 'watchers', :action => 'remove', :issue_id => @issue}, :class => 'icon icon-fav' %>
-              <% else %>
-            <%= link_to l(:button_watch), {:controller => 'watchers', :action => 'add', :issue_id => @issue}, :class => 'icon icon-fav-off' %>
-              <% end %>
-            <% end %>
             <%= link_to_if_authorized l(:button_move), {:controller => 'projects', :action => 'move_issues', :id => @project, "issue_ids[]" => @issue.id }, :class => 'icon icon-move' %>
             <%= link_to_if_authorized l(:button_delete), {:controller => 'issues', :action => 'destroy', :id => @issue}, :confirm => l(:text_are_you_sure), :method => :post, :class => 'icon icon-del' %>
             </div>
             <% if authorize_for('issues', 'change_status') and @status_options and !@status_options.empty? %>
               <% form_tag({:controller => 'issues', :action => 'change_status', :id => @issue}) do %>
               <%=l(:label_change_status)%> :
               <select name="new_status_id">
               <%= options_from_collection_for_select @status_options, "id", "name" %>
               </select>
               <%= submit_tag l(:button_change) %>
               <% end %>
             <% end %>
             &nbsp;
             </div>
             <% if authorize_for('issue_relations', 'new') || @issue.relations.any? %>
             <div id="relations" class="box">
             <%= render :partial => 'relations' %>
             </div>
             <% end %>
             <div id="history" class="box">
             <h3><%=l(:label_history)%>
             <% if @journals_count > @journals.length %>(<%= l(:label_last_changes, @journals.length) %>)<% end %></h3>
             <%= render :partial => 'history', :locals => { :journals => @journals } %>
             <% if @journals_count > @journals.length %>
                 <p><center><small><%= link_to l(:label_change_view_all), :action => 'history', :id => @issue %></small></center></p>
             <% end %>
             </div>
             <div class="box">
             <h3><%=l(:label_attachment_plural)%></h3>
             <table width="100%">
             <% for attachment in @issue.attachments %>
             <tr>
             <td><%= link_to attachment.filename, { :action => 'download', :id => @issue, :attachment_id => attachment }, :class => 'icon icon-attachment' %> (<%= number_to_human_size(attachment.filesize) %>)</td>
             <td><%= format_date(attachment.created_on) %></td>
             <td><%= attachment.author.display_name %></td>
             <td><div class="contextual"><%= link_to_if_authorized l(:button_delete), {:controller => 'issues', :action => 'destroy_attachment', :id => @issue, :attachment_id => attachment }, :confirm => l(:text_are_you_sure), :method => :post, :class => 'icon icon-del' %></div></td>
             </tr>
             <% end %>
             </table>
             <br />
             <% if authorize_for('issues', 'add_attachment') %>
               <% form_tag({ :controller => 'issues', :action => 'add_attachment', :id => @issue }, :multipart => true, :class => "tabular") do %>
               <p id="attachments_p"><label><%=l(:label_attachment_new)%>
               <%= image_to_function "add.png", "addFileField();return false" %></label>
               <%= file_field_tag 'attachments[]', :size => 30  %> <em>(<%= l(:label_max_size) %>: <%= number_to_human_size(Setting.attachment_max_size.to_i.kilobytes) %>)</em></p>
               <%= submit_tag l(:button_add) %>
               <% end %>
             <% end %>
             </div>
             <% if authorize_for('issues', 'add_note') %>
               <div class="box">
               <h3><%= l(:label_add_note) %></h3>
               <% form_tag({:controller => 'issues', :action => 'add_note', :id => @issue}, :class => "tabular" ) do %>
               <p><label for="notes"><%=l(:field_notes)%></label>
                 <%= text_area_tag 'notes', '', :cols => 60, :rows => 10, :class => 'wiki-edit'  %></p>
               <%= submit_tag l(:button_add) %>
               <% end %>
               </div>
             <% end %>

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages