Class: Perus::Server::System

Inherits:
Sequel::Model
  • Object
show all
Defined in:
lib/perus/server/models/system.rb

Instance Method Summary collapse

Instance Method Details

#action_hashesObject



38
39
40
41
42
43
# File 'lib/perus/server/models/system.rb', line 38

def action_hashes
    # actions referring to a command_config return a hash when calling
    # config_hashes, actions referring to scripts return an array.
    # flatten is needed to merge the two response types together.
    pending_actions.collect(&:config_hashes).flatten
end

#after_destroyObject



21
22
23
24
25
26
27
28
29
30
31
32
# File 'lib/perus/server/models/system.rb', line 21

def after_destroy
    super

    # remove dependent records
    metrics.each(&:destroy)
    values.each(&:destroy)
    actions.each(&:destroy)
    collection_errors.each(&:destroy)

    # remove any uploaded files
    FileUtils.rm_rf([uploads_dir], secure: true)
end

#latest(name) ⇒ Object



96
97
98
# File 'lib/perus/server/models/system.rb', line 96

def latest(name)
    values_dataset.where(metric: name).order_by('timestamp desc').first
end

#pending_actionsObject



34
35
36
# File 'lib/perus/server/models/system.rb', line 34

def pending_actions
    actions_dataset.where(timestamp: nil).all
end

#save_actions(params, timestamp) ⇒ Object


actions




104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/perus/server/models/system.rb', line 104

def save_actions(params, timestamp)
    actions = JSON.parse(params['actions'])

    actions.each do |id, result|
        # JSON.dump turns integer keys into strings
        action = Action.with_pk!(id.to_i)
        action.timestamp = timestamp

        if result == true
            action.success = true
        elsif result.is_a?(Hash)
            action.success = true
            action.file = save_file(params, result, action.id)
        else
            action.success = false
            action.response = result.to_s
        end

        action.save
    end
end

#save_file(params, entry, name) ⇒ Object



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/perus/server/models/system.rb', line 134

def save_file(params, entry, name)
    # entry should be a hash with a single key 'file', which is the
    # key name used to find the file in params
    raise 'Invalid file upload' unless entry.is_a?(Hash) && entry.include?('file')

    # ensure the uploads directory exists for this system
    FileUtils.mkdir_p(uploads_dir)

    # files are sent as top level parameters. metrics rename files
    # with their own name (i.e 'screenshot' saves a file called
    # 'screenshot'), while actions rename files to the action id
    upload = params[entry['file']]

    # store the file
    name = name.to_s + File.extname(upload[:filename])
    File.open(File.join(uploads_dir, name.to_s), 'wb') do |f|
        f.write(upload[:tempfile].read)
    end

    # return details of the file so it can be served with the correct
    # original filename and mimetype
    {filename: name, original_name: upload[:filename], mimetype: upload[:type]}
end

#save_metric_errors(params, timestamp) ⇒ Object


metrics




49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/perus/server/models/system.rb', line 49

def save_metric_errors(params, timestamp)
    errors = JSON.parse(params['metric_errors'])

    errors.each do |module_name, module_errors|
        module_errors.each do |error|
            Error.create(
                system_id: id,
                timestamp: timestamp,
                module: module_name,
                description: error
            )
        end
    end
end

#save_values(params, timestamp) ⇒ Object



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
# File 'lib/perus/server/models/system.rb', line 64

def save_values(params, timestamp)
    # store the set of known metrics for this system. metrics have either
    # str or num values.
    values = JSON.parse(params['metrics'])

    values.each do |(metric_name, value)|
        # file uploads are treated specially and don't need a value
        # record created for them
        if value.kind_of?(Hash)
            file_data = save_file(params, value, metric_name)
            Metric.add_file(metric_name, id, file_data)
            next
        end

        attrs = {
            system_id: id,
            timestamp: timestamp,
            metric: metric_name
        }

        if value.kind_of?(Numeric)
            attrs[:num_value] = value
            Metric.add_numeric(metric_name, id)
        else
            attrs[:str_value] = value
            Metric.add_string(metric_name, id)
        end

        Value.create(attrs)
    end
end

#screenshot_urlObject



168
169
170
171
# File 'lib/perus/server/models/system.rb', line 168

def screenshot_url
    screenshot = metrics_dataset.where(name: 'screenshot').first
    screenshot ? screenshot.url : ''
end

#upload_urlsObject



158
159
160
161
162
163
164
165
166
# File 'lib/perus/server/models/system.rb', line 158

def upload_urls
    file_metrics = metrics_dataset.where(type: 'file').all
    pairs = file_metrics.collect do |metric|
        [metric.name, metric.url]
    end

    # convert to name => url hash
    Hash[pairs]
end

#uploads_dirObject


files




130
131
132
# File 'lib/perus/server/models/system.rb', line 130

def uploads_dir
    @uploads_dir ||= File.join(Server.options.uploads_dir, id.to_s)
end

#validateObject



15
16
17
18
19
# File 'lib/perus/server/models/system.rb', line 15

def validate
    super
    validates_presence  :name
    validates_unique    :name
end