Class: Journal

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Redmine::SafeAttributes
Defined in:
app/models/journal.rb

Overview

Redmine - project management software Copyright (C) 2006-2017 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.

Since:

  • 0.4.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::SafeAttributes

#delete_unsafe_attributes, #safe_attribute?, #safe_attribute_names, #safe_attributes=

Constructor Details

#initialize(*args) ⇒ Journal

Returns a new instance of Journal

Since:

  • 3.0.0



68
69
70
71
72
73
74
75
76
77
 
# File 'app/models/journal.rb', line 68

def initialize(*args)
  super
  if journalized
    if journalized.new_record?
      self.notify = false
    else
      start
    end
  end
end

Instance Attribute Details

#indice ⇒ Object

Returns the value of attribute indice

Since:

  • 0.7.0



28
29
30
 
# File 'app/models/journal.rb', line 28

def indice
  @indice
end

Class Method Details

.preload_journals_details_custom_fields(journals) ⇒ Object

Sets @custom_field instance variable on journals details using a single query

Since:

  • 2.4.0



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'app/models/journal.rb', line 181

def self.preload_journals_details_custom_fields(journals)
  field_ids = journals.map(&:details).flatten.select {|d| d.property == 'cf'}.map(&:prop_key).uniq
  if field_ids.any?
    fields_by_id = CustomField.where(:id => field_ids).inject({}) {|h, f| h[f.id] = f; h}
    journals.each do |journal|
      journal.details.each do |detail|
        if detail.property == 'cf'
          detail.instance_variable_set "@custom_field", fields_by_id[detail.prop_key.to_i]
        end
      end
    end
  end
  journals
end

.visible_notes_condition(user = User.current, options = {}) ⇒ Object

Returns a SQL condition to filter out journals with notes that are not visible to user

Since:

  • 3.4.0



63
64
65
66
 
# File 'app/models/journal.rb', line 63

def self.visible_notes_condition(user=User.current, options={})
  private_notes_permission = Project.allowed_to_condition(user, :view_private_notes, options)
  sanitize_sql_for_conditions(["(#{table_name}.private_notes = ? OR #{table_name}.user_id = ? OR (#{private_notes_permission}))", false, user.id])
end

Instance Method Details

#attachments ⇒ Object

Since:

  • 0.7.0



135
136
137
 
# File 'app/models/journal.rb', line 135

def attachments
  journalized.respond_to?(:attachments) ? journalized.attachments : []
end

#css_classes ⇒ Object

Returns a string of css classes

Since:

  • 1.0.2



140
141
142
143
144
145
146
 
# File 'app/models/journal.rb', line 140

def css_classes
  s = 'journal'
  s << ' has-notes' unless notes.blank?
  s << ' has-details' unless details.blank?
  s << ' private-notes' if private_notes?
  s
end

#detail_for_attribute(attribute) ⇒ Object

Returns the JournalDetail for the given attribute, or nil if the attribute was not updated

Since:

  • 2.6.0



113
114
115
 
# File 'app/models/journal.rb', line 113

def detail_for_attribute(attribute)
  details.detect {|detail| detail.prop_key == attribute}
end

#each_notification(users, &block) ⇒ Object

Deprecated.

Removed at 4.0.0

Since:

  • 2.4.0



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'app/models/journal.rb', line 98

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

#editable_by?(usr) ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.7.0



127
128
129
 
# File 'app/models/journal.rb', line 127

def editable_by?(usr)
  usr && usr.logged? && (usr.allowed_to?(:edit_issue_notes, project) || (self.user == usr && usr.allowed_to?(:edit_own_issue_notes, project)))
end

#journalize_attachment(attachment, added_or_removed) ⇒ Object

Adds a journal detail for an attachment that was added or removed

Since:

  • 3.0.0



212
213
214
215
216
217
218
219
 
# File 'app/models/journal.rb', line 212

def journalize_attachment(attachment, added_or_removed)
  key = (added_or_removed == :removed ? :old_value : :value)
  details << JournalDetail.new(
      :property => 'attachment',
      :prop_key => attachment.id,
      key => attachment.filename
    )
end

#journalize_relation(relation, added_or_removed) ⇒ Object

Adds a journal detail for an issue relation that was added or removed

Since:

  • 3.0.0



222
223
224
225
226
227
228
229
 
# File 'app/models/journal.rb', line 222

def journalize_relation(relation, added_or_removed)
  key = (added_or_removed == :removed ? :old_value : :value)
  details << JournalDetail.new(
      :property  => 'relation',
      :prop_key  => relation.relation_type_for(journalized),
      key => relation.other_issue(journalized).try(:id)
    )
end

#new_status ⇒ Object

Returns the new status if the journal contains a status change, otherwise nil

Since:

  • 0.6.1



118
119
120
121
 
# File 'app/models/journal.rb', line 118

def new_status
  s = new_value_for('status_id')
  s ? IssueStatus.find_by_id(s.to_i) : nil
end

#new_value_for(prop) ⇒ Object

Since:

  • 0.7.0



123
124
125
 
# File 'app/models/journal.rb', line 123

def new_value_for(prop)
  detail_for_attribute(prop).try(:value)
end

#notified_users ⇒ Object

Since:

  • 2.4.0



156
157
158
159
160
161
162
 
# File 'app/models/journal.rb', line 156

def notified_users
  notified = journalized.notified_users
  if private_notes?
    notified = notified.select {|user| user.allowed_to?(:view_private_notes, journalized.project)}
  end
  notified
end

#notified_watchers ⇒ Object

Since:

  • 2.4.0



168
169
170
171
172
173
174
 
# File 'app/models/journal.rb', line 168

def notified_watchers
  notified = journalized.notified_watchers
  if private_notes?
    notified = notified.select {|user| user.allowed_to?(:view_private_notes, journalized.project)}
  end
  notified
end

#notify=(arg) ⇒ Object

Since:

  • 1.2.0



152
153
154
 
# File 'app/models/journal.rb', line 152

def notify=(arg)
  @notify = arg
end

#notify? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 1.2.0



148
149
150
 
# File 'app/models/journal.rb', line 148

def notify?
  @notify != false
end

#project ⇒ Object

Since:

  • 0.7.0



131
132
133
 
# File 'app/models/journal.rb', line 131

def project
  journalized.respond_to?(:project) ? journalized.project : nil
end

#recipients ⇒ Object

Since:

  • 2.2.0



164
165
166
 
# File 'app/models/journal.rb', line 164

def recipients
  notified_users.map(&:mail)
end

#save(*args) ⇒ Object

Since:

  • 0.6.0



79
80
81
82
83
 
# File 'app/models/journal.rb', line 79

def save(*args)
  journalize_changes
  # Do not save an empty journal
  (details.empty? && notes.blank?) ? false : super
end

#start ⇒ Object

Stores the values of the attributes and custom fields of the journalized object

Since:

  • 3.0.0



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'app/models/journal.rb', line 197

def start
  if journalized
    @attributes_before_change = journalized.journalized_attribute_names.inject({}) do |h, attribute|
      h[attribute] = journalized.send(attribute)
      h
    end
    @custom_values_before_change = journalized.custom_field_values.inject({}) do |h, c|
      h[c.custom_field_id] = c.value
      h
    end
  end
  self
end

#visible_details(user = User.current) ⇒ Object

Returns journal details that are visible to user

Since:

  • 2.4.0



86
87
88
89
90
91
92
93
94
95
96
 
# File 'app/models/journal.rb', line 86

def visible_details(user=User.current)
  details.select do |detail|
    if detail.property == 'cf'
      detail.custom_field && detail.custom_field.visible_by?(project, user)
    elsif detail.property == 'relation'
      Issue.find_by_id(detail.value || detail.old_value).try(:visible?, user)
    else
      true
    end
  end
end

#watcher_recipients ⇒ Object

Since:

  • 2.2.0



176
177
178
 
# File 'app/models/journal.rb', line 176

def watcher_recipients
  notified_watchers.map(&:mail)
end