/
rest_devicereport.go
399 lines (339 loc) · 10.3 KB
/
rest_devicereport.go
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
/*******************************************************************************
* Copyright 2017 Dell Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*******************************************************************************/
package metadata
import (
"encoding/json"
"net/http"
"net/url"
"github.com/edgexfoundry/edgex-go/internal/core/metadata/config"
"github.com/edgexfoundry/edgex-go/internal/core/metadata/interfaces"
"github.com/edgexfoundry/edgex-go/internal/pkg/errorconcept"
"github.com/edgexfoundry/go-mod-core-contracts/clients"
"github.com/edgexfoundry/go-mod-core-contracts/clients/logger"
"github.com/edgexfoundry/go-mod-core-contracts/models"
"github.com/gorilla/mux"
)
func restGetAllDeviceReports(
w http.ResponseWriter,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler,
configuration *config.ConfigurationStruct) {
res, err := dbClient.GetAllDeviceReports()
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.RetrieveError_StatusInternalServer)
return
}
// Check max limit
if err = checkMaxLimit(len(res), configuration); err != nil {
errorHandler.Handle(w, err, errorconcept.Common.LimitExceeded)
return
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
json.NewEncoder(w).Encode(&res)
}
// Add a new device report
// Referenced objects (Device, Schedule event) must already exist
// 404 If any of the referenced objects aren't found
func restAddDeviceReport(
w http.ResponseWriter,
r *http.Request,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
defer r.Body.Close()
var dr models.DeviceReport
if err := json.NewDecoder(r.Body).Decode(&dr); err != nil {
errorHandler.Handle(w, err, errorconcept.Common.InvalidRequest_StatusBadRequest)
return
}
// Check if the device exists
if _, err := dbClient.GetDeviceByName(dr.Device); err != nil {
errorHandler.HandleOneVariant(
w,
err,
errorconcept.DeviceReport.DeviceNotFound,
errorconcept.Default.InternalServerError)
return
}
// Add the device report
var err error
dr.Id, err = dbClient.AddDeviceReport(dr)
if err != nil {
errorHandler.HandleOneVariant(
w,
err,
errorconcept.DeviceReport.NotUnique,
errorconcept.Default.InternalServerError)
return
}
// Notify associates
if err := notifyDeviceReportAssociates(dr, http.MethodPost, lc, dbClient); err != nil {
lc.Error(err.Error())
}
w.WriteHeader(http.StatusOK)
w.Write([]byte(dr.Id))
}
func restUpdateDeviceReport(
w http.ResponseWriter,
r *http.Request,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
defer r.Body.Close()
var from models.DeviceReport
if err := json.NewDecoder(r.Body).Decode(&from); err != nil {
errorHandler.Handle(w, err, errorconcept.Common.InvalidRequest_StatusBadRequest)
return
}
// Check if the device report exists
// First try ID
to, err := dbClient.GetDeviceReportById(from.Id)
if err != nil {
// Try by name
to, err = dbClient.GetDeviceReportByName(from.Name)
if err != nil {
errorHandler.HandleOneVariant(
w,
err,
errorconcept.Database.NotFound,
errorconcept.Default.InternalServerError)
return
}
}
if err := updateDeviceReportFields(from, &to, w, dbClient, errorHandler); err != nil {
lc.Error(err.Error())
return
}
if err := dbClient.UpdateDeviceReport(to); err != nil {
errorHandler.Handle(w, err, errorconcept.Common.UpdateError_StatusInternalServer)
return
}
// Notify Associates
if err := notifyDeviceReportAssociates(to, http.MethodPut, lc, dbClient); err != nil {
lc.Error(err.Error())
}
w.WriteHeader(http.StatusOK)
w.Write([]byte("true"))
}
// Update the relevant fields for the device report
func updateDeviceReportFields(
from models.DeviceReport,
to *models.DeviceReport,
w http.ResponseWriter,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) error {
if from.Device != "" {
to.Device = from.Device
if err := validateDevice(to.Device, w, dbClient, errorHandler); err != nil {
return err
}
}
if from.Action != "" {
to.Action = from.Action
}
if from.Expected != nil {
to.Expected = from.Expected
// TODO: Someday find a way to check the value descriptors
}
if from.Name != "" {
to.Name = from.Name
}
if from.Origin != 0 {
to.Origin = from.Origin
}
return nil
}
// Validate that the device exists
func validateDevice(
d string,
w http.ResponseWriter,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) error {
if _, err := dbClient.GetDeviceByName(d); err != nil {
errorHandler.HandleOneVariant(
w,
err,
errorconcept.DeviceReport.DeviceNotFound,
errorconcept.Default.ServiceUnavailable)
return err
}
return nil
}
func restGetReportById(
w http.ResponseWriter,
r *http.Request,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
vars := mux.Vars(r)
var did string = vars[ID]
res, err := dbClient.GetDeviceReportById(did)
if err != nil {
errorHandler.HandleOneVariant(w, err, errorconcept.Database.NotFound, errorconcept.Default.InternalServerError)
return
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
json.NewEncoder(w).Encode(res)
}
func restGetReportByName(
w http.ResponseWriter,
r *http.Request,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
vars := mux.Vars(r)
n, err := url.QueryUnescape(vars[NAME])
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.InvalidRequest_StatusBadRequest)
return
}
res, err := dbClient.GetDeviceReportByName(n)
if err != nil {
errorHandler.HandleOneVariant(w, err, errorconcept.Database.NotFound, errorconcept.Default.InternalServerError)
return
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
json.NewEncoder(w).Encode(res)
}
// Get a list of value descriptor names
// The names are a union of all the value descriptors from the device reports for the given device
func restGetValueDescriptorsForDeviceName(
w http.ResponseWriter,
r *http.Request,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
vars := mux.Vars(r)
n, err := url.QueryUnescape(vars[DEVICENAME])
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.InvalidRequest_StatusBadRequest)
return
}
// Get all the associated device reports
reports, err := dbClient.GetDeviceReportByDeviceName(n)
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.RetrieveError_StatusInternalServer)
return
}
valueDescriptors := []string{}
for _, report := range reports {
for _, e := range report.Expected {
valueDescriptors = append(valueDescriptors, e)
}
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
json.NewEncoder(w).Encode(valueDescriptors)
}
func restGetDeviceReportByDeviceName(
w http.ResponseWriter,
r *http.Request,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
vars := mux.Vars(r)
n, err := url.QueryUnescape(vars[DEVICENAME])
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.InvalidRequest_StatusBadRequest)
return
}
res, err := dbClient.GetDeviceReportByDeviceName(n)
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.RetrieveError_StatusInternalServer)
return
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
json.NewEncoder(w).Encode(res)
}
func restDeleteReportById(
w http.ResponseWriter,
r *http.Request,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
vars := mux.Vars(r)
var id string = vars[ID]
// Check if the device report exists
dr, err := dbClient.GetDeviceReportById(id)
if err != nil {
errorHandler.HandleOneVariant(w, err, errorconcept.Database.NotFound, errorconcept.Default.InternalServerError)
return
}
if err := deleteDeviceReport(dr, w, lc, dbClient, errorHandler); err != nil {
lc.Error(err.Error())
return
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
w.WriteHeader(http.StatusOK)
w.Write([]byte("true"))
}
func restDeleteReportByName(
w http.ResponseWriter,
r *http.Request,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) {
vars := mux.Vars(r)
n, err := url.QueryUnescape(vars[NAME])
if err != nil {
errorHandler.Handle(w, err, errorconcept.Common.InvalidRequest_StatusBadRequest)
return
}
// Check if the device report exists
dr, err := dbClient.GetDeviceReportByName(n)
if err != nil {
errorHandler.HandleOneVariant(w, err, errorconcept.Database.NotFound, errorconcept.Default.InternalServerError)
return
}
if err = deleteDeviceReport(dr, w, lc, dbClient, errorHandler); err != nil {
lc.Error(err.Error())
return
}
w.Header().Set(clients.ContentType, clients.ContentTypeJSON)
w.WriteHeader(http.StatusOK)
w.Write([]byte("true"))
}
func deleteDeviceReport(
dr models.DeviceReport,
w http.ResponseWriter,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
errorHandler errorconcept.ErrorHandler) error {
if err := dbClient.DeleteDeviceReportById(dr.Id); err != nil {
errorHandler.Handle(w, err, errorconcept.Common.DeleteError)
return err
}
// Notify Associates
if err := notifyDeviceReportAssociates(dr, http.MethodDelete, lc, dbClient); err != nil {
return err
}
return nil
}
// Notify the associated device services to the device report
func notifyDeviceReportAssociates(
dr models.DeviceReport,
action string,
lc logger.LoggingClient,
dbClient interfaces.DBClient) error {
// Get the device of the report
d, err := dbClient.GetDeviceByName(dr.Device)
if err != nil {
return err
}
// Get the device service for the device
ds, err := dbClient.GetDeviceServiceById(d.Service.Id)
if err != nil {
return err
}
// Notify the associating device services
if err = notifyAssociates([]models.DeviceService{ds}, dr.Id, action, models.REPORT, lc); err != nil {
return err
}
return nil
}