journal.rb
179 lines
| 5.9 KiB
| text/x-ruby
|
RubyLexer
|
r5022 | # Redmine - project management software | ||
|
r10939 | # Copyright (C) 2006-2013 Jean-Philippe Lang | ||
|
r52 | # | ||
# 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. | ||||
|
r6735 | # | ||
|
r52 | # 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. | ||||
|
r6735 | # | ||
|
r52 | # 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 Journal < ActiveRecord::Base | ||||
belongs_to :journalized, :polymorphic => true | ||||
|
r336 | # added as a quick fix to allow eager loading of the polymorphic association | ||
# since always associated to an issue, for now | ||||
belongs_to :issue, :foreign_key => :journalized_id | ||||
|
r6735 | |||
|
r52 | belongs_to :user | ||
|
r120 | has_many :details, :class_name => "JournalDetail", :dependent => :delete_all | ||
|
r1183 | attr_accessor :indice | ||
|
r6735 | |||
|
r1491 | acts_as_event :title => Proc.new {|o| status = ((s = o.new_status) ? " (#{s})" : nil); "#{o.issue.tracker} ##{o.issue.id}#{status}: #{o.issue.subject}" }, | ||
|
r874 | :description => :notes, | ||
|
r879 | :author => :user, | ||
|
r10724 | :group => :issue, | ||
|
r1553 | :type => Proc.new {|o| (s = o.new_status) ? (s.is_closed? ? 'issue-closed' : 'issue-edit') : 'issue-note' }, | ||
|
r1140 | :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.issue.id, :anchor => "change-#{o.id}"}} | ||
|
r874 | |||
|
r1692 | acts_as_activity_provider :type => 'issues', | ||
|
r2064 | :author_key => :user_id, | ||
|
r1692 | :find_options => {:include => [{:issue => :project}, :details, :user], | ||
:conditions => "#{Journal.table_name}.journalized_type = 'Issue' AND" + | ||||
" (#{JournalDetail.table_name}.prop_key = 'status_id' OR #{Journal.table_name}.notes <> '')"} | ||||
|
r6735 | |||
|
r10336 | before_create :split_private_notes | ||
|
r11791 | after_create :send_notification | ||
|
r10336 | |||
scope :visible, lambda {|*args| | ||||
user = args.shift || User.current | ||||
includes(:issue => :project). | ||||
where(Issue.visible_condition(user, *args)). | ||||
where("(#{Journal.table_name}.private_notes = ? OR (#{Project.allowed_to_condition(user, :view_private_notes, *args)}))", false) | ||||
} | ||||
|
r6735 | |||
|
r2539 | def save(*args) | ||
|
r840 | # Do not save an empty journal | ||
(details.empty? && notes.blank?) ? false : super | ||||
end | ||||
|
r6735 | |||
|
r11784 | # Returns journal details that are visible to user | ||
|
r11782 | def visible_details(user=User.current) | ||
details.select do |detail| | ||||
if detail.property == 'cf' | ||||
field_id = detail.prop_key | ||||
field = CustomField.find_by_id(field_id) | ||||
field && field.visible_by?(project, user) | ||||
|
r11784 | elsif detail.property == 'relation' | ||
Issue.find_by_id(detail.value || detail.old_value).try(:visible?, user) | ||||
|
r11782 | else | ||
true | ||||
end | ||||
end | ||||
end | ||||
|
r11785 | def each_notification(users, &block) | ||
if users.any? | ||||
users_by_details_visibility = users.group_by do |user| | ||||
visible_details(user) | ||||
end | ||||
users_by_details_visibility.each do |visible_details, users| | ||||
if notes? || visible_details.any? | ||||
yield(users) | ||||
end | ||||
end | ||||
end | ||||
end | ||||
|
r879 | # Returns the new status if the journal contains a status change, otherwise nil | ||
def new_status | ||||
c = details.detect {|detail| detail.prop_key == 'status_id'} | ||||
(c && c.value) ? IssueStatus.find_by_id(c.value.to_i) : nil | ||||
end | ||||
|
r6735 | |||
|
r1065 | def new_value_for(prop) | ||
c = details.detect {|detail| detail.prop_key == prop} | ||||
c ? c.value : nil | ||||
end | ||||
|
r6735 | |||
|
r1091 | def editable_by?(usr) | ||
|
r1138 | usr && usr.logged? && (usr.allowed_to?(:edit_issue_notes, project) || (self.user == usr && usr.allowed_to?(:edit_own_issue_notes, project))) | ||
|
r1091 | end | ||
|
r6735 | |||
|
r1147 | def project | ||
journalized.respond_to?(:project) ? journalized.project : nil | ||||
end | ||||
|
r6735 | |||
|
r1147 | def attachments | ||
journalized.respond_to?(:attachments) ? journalized.attachments : nil | ||||
end | ||||
|
r3948 | |||
# Returns a string of css classes | ||||
def css_classes | ||||
s = 'journal' | ||||
s << ' has-notes' unless notes.blank? | ||||
s << ' has-details' unless details.blank? | ||||
|
r10336 | s << ' private-notes' if private_notes? | ||
|
r3948 | s | ||
end | ||||
|
r6735 | |||
|
r5482 | def notify? | ||
@notify != false | ||||
end | ||||
|
r6735 | |||
|
r5482 | def notify=(arg) | ||
@notify = arg | ||||
end | ||||
|
r10336 | |||
|
r11782 | def notified_users | ||
|
r10336 | notified = journalized.notified_users | ||
if private_notes? | ||||
notified = notified.select {|user| user.allowed_to?(:view_private_notes, journalized.project)} | ||||
end | ||||
|
r11782 | notified | ||
|
r10336 | end | ||
|
r11782 | def recipients | ||
notified_users.map(&:mail) | ||||
end | ||||
def notified_watchers | ||||
|
r10567 | notified = journalized.notified_watchers | ||
if private_notes? | ||||
notified = notified.select {|user| user.allowed_to?(:view_private_notes, journalized.project)} | ||||
end | ||||
|
r11782 | notified | ||
end | ||||
def watcher_recipients | ||||
notified_watchers.map(&:mail) | ||||
|
r10567 | end | ||
|
r10336 | private | ||
def split_private_notes | ||||
if private_notes? | ||||
if notes.present? | ||||
if details.any? | ||||
# Split the journal (notes/changes) so we don't have half-private journals | ||||
journal = Journal.new(:journalized => journalized, :user => user, :notes => nil, :private_notes => false) | ||||
journal.details = details | ||||
journal.save | ||||
self.details = [] | ||||
self.created_on = journal.created_on | ||||
end | ||||
else | ||||
# Blank notes should not be private | ||||
self.private_notes = false | ||||
end | ||||
end | ||||
true | ||||
end | ||||
|
r11791 | |||
def send_notification | ||||
if notify? && (Setting.notified_events.include?('issue_updated') || | ||||
(Setting.notified_events.include?('issue_note_added') && notes.present?) || | ||||
(Setting.notified_events.include?('issue_status_updated') && new_status.present?) || | ||||
(Setting.notified_events.include?('issue_priority_updated') && new_value_for('priority_id').present?) | ||||
) | ||||
Mailer.deliver_issue_edit(self) | ||||
end | ||||
end | ||||
|
r52 | end | ||