aboutsummaryrefslogtreecommitdiffstats
path: root/app/models/info_request_event.rb
blob: e07d645ddb70a3db2675e69e48768f75ca6b2aad (plain)
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
# == Schema Information
# Schema version: 49
#
# 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        
#

# 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.33 2008-04-01 16:40:37 francis Exp $

class InfoRequestEvent < ActiveRecord::Base
    belongs_to :info_request
    validates_presence_of :info_request

    belongs_to :info_request_event_id

    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
        '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_solr :fields => [ 
        { :solr_text_main => :text },
        { :title => :text },
        { :status => :string },
        { :requested_by => :string },
        { :requested_from => :string },
        { :request => :string },
        { :created_at => :date },
        { :last_described_at => :date },
        { :variety => :string }
    ], :if => "$do_solr_index"
    def status # for name in Solr queries
        self.calculated_state
    end
    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 solr_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_solr
        if ['sent', 'followup_sent', 'response'].include?(self.event_type)
            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)
        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
    def incoming_message
        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
    def outgoing_message
        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 by"
        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