1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
# == Schema Information
# Schema version: 56
#
# Table name: info_request_events
#
# id :integer not null, primary key
# info_request_id :integer not null
# event_type :text not null
# params_yaml :text not null
# created_at :datetime not null
# described_state :string(255)
# calculated_state :string(255)
# last_described_at :datetime
# incoming_message_id :integer
# outgoing_message_id :integer
#
# models/info_request_event.rb:
#
# Copyright (c) 2007 UK Citizens Online Democracy. All rights reserved.
# Email: francis@mysociety.org; WWW: http://www.mysociety.org/
#
# $Id: info_request_event.rb,v 1.46 2008-05-21 10:51:24 francis Exp $
class InfoRequestEvent < ActiveRecord::Base
belongs_to :info_request
validates_presence_of :info_request
belongs_to :outgoing_message
belongs_to :incoming_message
has_many :user_info_request_sent_alerts
has_many :track_things_sent_emails
validates_presence_of :event_type
validates_inclusion_of :event_type, :in => [
'sent',
'resent',
'followup_sent',
'edit', # title etc. edited in admin interface
'edit_outgoing', # outgoing message edited in admin interface
'destroy_incoming', # deleted an incoming message
'manual', # you did something in the db by hand
'response'
]
# user described state (also update in info_request)
validates_inclusion_of :described_state, :in => [
nil,
'waiting_response',
'waiting_clarification',
'not_held',
'rejected',
'successful',
'partially_successful',
'requires_admin'
]
# Full text search indexing
acts_as_xapian :texts => [ :search_text_main, :title ],
:values => [ [ :created_at, 0, "created_at", :date ],
[ :described_at_numeric, 1, "described_at", :number ], # XXX using :number for lack of :datetime support in Xapian values
[ :request, 2, "request_collapse", :string ]
],
:terms => [ [ :calculated_state, 'S', "status" ],
[ :requested_by, 'B', "requested_by" ],
[ :requested_from, 'F', "requested_from" ],
[ :request, 'R', "request" ],
[ :variety, 'V', "variety" ]
],
:if => :indexed_by_search,
:eager_load => [ { :incoming_message => { :info_request => :public_body }}, :outgoing_message, { :info_request => [ :user, :public_body ] } ]
def requested_by
self.info_request.user.url_name
end
def requested_from
self.info_request.public_body.url_name
end
def request
self.info_request.url_title
end
def described_at
# For responses, people might have RSS feeds on searches for type of
# response (e.g. successful) in which case we want to date sort by
# when the responses was described as being of the type. For other
# types, just use the create at date.
return self.last_described_at || self.created_at
end
def described_at_numeric
# format it here as no datetime support in Xapian's value ranges
return self.described_at.strftime("%Y%m%d%H%M%S")
end
def search_text_main
text = ''
if self.event_type == 'sent'
text = text + self.outgoing_message.body_without_salutation + "\n\n"
elsif self.event_type == 'followup_sent'
text = text + self.outgoing_message.body_without_salutation + "\n\n"
elsif self.event_type == 'response'
text = text + self.incoming_message.get_text_for_indexing + "\n\n"
else
# nothing
end
return text
end
def title
if self.event_type == 'sent'
return self.info_request.title
end
return ''
end
def indexed_by_search
if ['sent', 'followup_sent', 'response'].include?(self.event_type)
if info_request.prominence == 'backpage'
return false
end
return true
else
return false
end
end
def variety
self.event_type
end
# We store YAML version of parameters in the database
def params=(params)
# XXX should really set these explicitly, and stop storing them in
# here, but keep it for compatibility with old way for now
if not params[:incoming_message_id].nil?
self.incoming_message_id = params[:incoming_message_id]
end
if not params[:outgoing_message_id].nil?
self.outgoing_message_id = params[:outgoing_message_id]
end
self.params_yaml = params.to_yaml
end
def params
YAML.load(self.params_yaml)
end
# Find related incoming message
# XXX search for the find below and call this function more instead
# XXX deprecated, remove it
def incoming_message_via_params
if not ['response'].include?(self.event_type)
return nil
end
if not self.params[:incoming_message_id]
raise "internal error, no incoming message id for response event"
end
return IncomingMessage.find(self.params[:incoming_message_id].to_i)
end
# Find related outgoing message
# XXX search for the find below and call this function more instead
# XXX deprecated, remove it
def outgoing_message_via_params
if not [ 'edit_outgoing', 'sent', 'resent', 'followup_sent' ].include?(self.event_type)
return nil
end
if not self.params[:outgoing_message_id]
raise "internal error, no outgoing message id for event type which expected one"
end
return OutgoingMessage.find(self.params[:outgoing_message_id].to_i)
end
# Display version of status
def display_status
if incoming_message.nil?
raise "display_status only works for incoming messages right now"
end
status = self.calculated_state
if status == 'waiting_response'
"Acknowledgement"
elsif status == 'waiting_clarification'
"Clarification required"
elsif status == 'not_held'
"Information not held"
elsif status == 'rejected'
"Rejection"
elsif status == 'partially_successful'
"Some information sent"
elsif status == 'successful'
"All information sent"
elsif status == 'requires_admin'
"Unusual response"
else
raise "unknown status " + status
end
end
end
|
