amqpclient.go 9.17 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/** AMQP package, client.
*
* @author Sonja Happ <sonja.happ@eonerc.rwth-aachen.de>
* @copyright 2014-2019, Institute for Automation of Complex Power Systems, EONERC
* @license GNU General Public License (version 3)
*
* VILLASweb-backend-go
*
* 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 3 of the License, or
* 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, see <http://www.gnu.org/licenses/>.
*********************************************************************************/
22
package amqp
23
24
25
26

import (
	"encoding/json"
	"fmt"
27
	infrastructure_component "git.rwth-aachen.de/acs/public/villas/web-backend-go/routes/infrastructure-component"
28
	"github.com/gin-gonic/gin"
29
	"github.com/google/uuid"
30
	"github.com/jinzhu/gorm"
31
	"github.com/streadway/amqp"
32
	"log"
33
34
35
36
37
38
39
40
41
42
43
44
	"time"
)

const VILLAS_EXCHANGE = "villas"

type AMQPclient struct {
	connection *amqp.Connection
	channel    *amqp.Channel
	replies    <-chan amqp.Delivery
}

type Action struct {
Sonja Happ's avatar
Sonja Happ committed
45
46
47
	Act        string   `json:"action"`
	When       float32  `json:"when"`
	Parameters struct{} `json:"parameters"`
Sonja Happ's avatar
Sonja Happ committed
48
49
50
	UUID       *string  `json:"uuid"`
	//Model      struct{} `json:"model"`
	//Results    struct{} `json:"results"`
51
52
}

53
type ICUpdate struct {
54
	State      *string `json:"state"`
55
	Properties struct {
Sonja Happ's avatar
Sonja Happ committed
56
57
58
59
60
61
62
63
		UUID        string  `json:"uuid"`
		Name        *string `json:"name"`
		Category    *string `json:"category"`
		Type        *string `json:"type"`
		Location    *string `json:"location"`
		WS_url      *string `json:"ws_url"`
		API_url     *string `json:"api_url"`
		Description *string `json:"description"`
64
	} `json:"properties"`
Sonja Happ's avatar
Sonja Happ committed
65
	// TODO add JSON start parameter scheme
66
67
}

68
69
70
71
72
73
74
75
76
var client AMQPclient

func ConnectAMQP(uri string) error {

	var err error

	// connect to broker
	client.connection, err = amqp.Dial(uri)
	if err != nil {
77
		return fmt.Errorf("AMQP: failed to connect to RabbitMQ broker %v, error: %v", uri, err)
78
79
80
81
82
	}

	// create channel
	client.channel, err = client.connection.Channel()
	if err != nil {
83
		return fmt.Errorf("AMQP: failed to open a channel, error: %v", err)
84
85
86
87
88
89
90
91
92
93
	}
	// declare exchange
	err = client.channel.ExchangeDeclare(VILLAS_EXCHANGE,
		"headers",
		true,
		false,
		false,
		false,
		nil)
	if err != nil {
94
		return fmt.Errorf("AMQP: failed to declare the exchange, error: %v", err)
95
96
	}

97
98
	// add a queue for the ICs
	ICQueue, err := client.channel.QueueDeclare("infrastructure_components",
99
100
101
102
103
104
		true,
		false,
		false,
		false,
		nil)
	if err != nil {
105
		return fmt.Errorf("AMQP: failed to declare the queue, error: %v", err)
106
107
	}

108
	err = client.channel.QueueBind(ICQueue.Name, "", VILLAS_EXCHANGE, false, nil)
109
	if err != nil {
110
		return fmt.Errorf("AMQP: failed to bind the queue, error: %v", err)
111
112
113
	}

	// consume deliveries
114
	client.replies, err = client.channel.Consume(ICQueue.Name,
115
		"",
116
		true,
117
118
119
120
121
		false,
		false,
		false,
		nil)
	if err != nil {
122
		return fmt.Errorf("AMQP: failed to consume deliveries, error: %v", err)
123
124
125
126
	}

	// consuming queue
	go func() {
127
128
129
		for {
			for message := range client.replies {
				processMessage(message)
130
			}
131
			time.Sleep(2) // sleep for 2 sek
132
133
134
		}
	}()

135
136
	log.Printf(" AMQP: Waiting for messages... ")

137
138
139
	return nil
}

Sonja Happ's avatar
Sonja Happ committed
140
func SendActionAMQP(action Action) error {
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

	payload, err := json.Marshal(action)
	if err != nil {
		return err
	}

	msg := amqp.Publishing{
		DeliveryMode:    2,
		Timestamp:       time.Now(),
		ContentType:     "application/json",
		ContentEncoding: "utf-8",
		Priority:        0,
		Body:            payload,
	}

Sonja Happ's avatar
Sonja Happ committed
156
157
158
	err = CheckConnection()
	if err != nil {
		return err
159
160
	}

Sonja Happ's avatar
Sonja Happ committed
161
	log.Println("AMQP: Sending message", string(msg.Body))
162
163
164
165
166
167
168
169
170
171
	err = client.channel.Publish(VILLAS_EXCHANGE,
		"",
		false,
		false,
		msg)
	return err

}

func PingAMQP() error {
172
	log.Println("AMQP: sending ping command to all ICs")
173
174
175

	var a Action
	a.Act = "ping"
Sonja Happ's avatar
Sonja Happ committed
176
	*a.UUID = ""
177

Sonja Happ's avatar
Sonja Happ committed
178
	err := SendActionAMQP(a)
179
180
	return err
}
181
182
183

func CheckConnection() error {

184
185
186
187
188
189
	if client.connection != nil {
		if client.connection.IsClosed() {
			return fmt.Errorf("connection to broker is closed")
		}
	} else {
		return fmt.Errorf("connection is nil")
190
191
192
193
	}

	return nil
}
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

func StartAMQP(AMQPurl string, api *gin.RouterGroup) error {
	if AMQPurl != "" {
		log.Println("Starting AMQP client")

		err := ConnectAMQP(AMQPurl)
		if err != nil {
			return err
		}

		// register IC action endpoint only if AMQP client is used
		RegisterAMQPEndpoint(api.Group("/ic"))

		// Periodically call the Ping function to check which ICs are still there
		ticker := time.NewTicker(10 * time.Second)
		go func() {

			for {
				select {
				case <-ticker.C:
214
215
216
217
218
219
220
					//TODO Add a useful regular event here
					/*
						err = PingAMQP()
						if err != nil {
							log.Println("AMQP Error: ", err.Error())
						}
					*/
221
222
223
224
225
226
227
228
229
230
				}
			}

		}()

		log.Printf("Connected AMQP client to %s", AMQPurl)
	}

	return nil
}
231
232
233

func processMessage(message amqp.Delivery) {

Sonja Happ's avatar
Sonja Happ committed
234
	log.Println("Processing AMQP message: ", string(message.Body))
Sonja Happ's avatar
Sonja Happ committed
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
	var payload ICUpdate
	err := json.Unmarshal(message.Body, &payload)
	if err != nil {
		log.Println("AMQP: Could not unmarshal message to JSON:", string(message.Body), "err: ", err)
		return
	}

	ICUUID := payload.Properties.UUID
	_, err = uuid.Parse(ICUUID)

	if err != nil {
		log.Printf("AMQP: UUID not valid: %v, message ignored: %v \n", ICUUID, string(message.Body))
		return
	}

	var sToBeUpdated infrastructure_component.InfrastructureComponent
	err = sToBeUpdated.ByUUID(ICUUID)

	if err == gorm.ErrRecordNotFound {
		// create new record
		var newICReq infrastructure_component.AddICRequest
		newICReq.InfrastructureComponent.UUID = payload.Properties.UUID
		if payload.Properties.Name == nil ||
			payload.Properties.Category == nil ||
			payload.Properties.Type == nil {
			// cannot create new IC because required information (name, type, and/or category missing)
			log.Println("AMQP: Cannot create new IC, required field(s) is/are missing: name, type, category")
			return
		}
		newICReq.InfrastructureComponent.Name = *payload.Properties.Name
		newICReq.InfrastructureComponent.Category = *payload.Properties.Category
		newICReq.InfrastructureComponent.Type = *payload.Properties.Type

		// add optional params
		if payload.State != nil {
			newICReq.InfrastructureComponent.State = *payload.State
		} else {
			newICReq.InfrastructureComponent.State = "unknown"
		}
275
		if payload.Properties.WS_url != nil {
Sonja Happ's avatar
Sonja Happ committed
276
			newICReq.InfrastructureComponent.WebsocketURL = *payload.Properties.WS_url
277
278
		}
		if payload.Properties.API_url != nil {
Sonja Happ's avatar
Sonja Happ committed
279
			newICReq.InfrastructureComponent.APIURL = *payload.Properties.API_url
280
		}
281
		if payload.Properties.Location != nil {
Sonja Happ's avatar
Sonja Happ committed
282
			newICReq.InfrastructureComponent.Location = *payload.Properties.Location
283
		}
Sonja Happ's avatar
Sonja Happ committed
284
285
286
287
		if payload.Properties.Description != nil {
			newICReq.InfrastructureComponent.Description = *payload.Properties.Description
		}
		// TODO add JSON start parameter scheme
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

		// Validate the new IC
		err = newICReq.Validate()
		if err != nil {
			log.Println("AMQP: Validation of new IC failed:", err)
			return
		}

		// Create the new IC
		newIC := newICReq.CreateIC()

		// save IC
		err = newIC.Save()
		if err != nil {
			log.Println("AMQP: Saving new IC to DB failed:", err)
			return
		}

		log.Println("AMQP: Created IC ", newIC.Name)

	} else if err != nil {
		log.Println("AMQP: Database error for IC", ICUUID, " DB error message: ", err)
		return
	} else {

		var updatedICReq infrastructure_component.UpdateICRequest
		if payload.State != nil {
			updatedICReq.InfrastructureComponent.State = *payload.State
		}
		if payload.Properties.Type != nil {
			updatedICReq.InfrastructureComponent.Type = *payload.Properties.Type
		}
		if payload.Properties.Category != nil {
			updatedICReq.InfrastructureComponent.Category = *payload.Properties.Category
		}
		if payload.Properties.Name != nil {
			updatedICReq.InfrastructureComponent.Name = *payload.Properties.Name
		}
326
		if payload.Properties.WS_url != nil {
Sonja Happ's avatar
Sonja Happ committed
327
			updatedICReq.InfrastructureComponent.WebsocketURL = *payload.Properties.WS_url
328
329
		}
		if payload.Properties.API_url != nil {
Sonja Happ's avatar
Sonja Happ committed
330
			updatedICReq.InfrastructureComponent.APIURL = *payload.Properties.API_url
331
		}
332
		if payload.Properties.Location != nil {
Sonja Happ's avatar
Sonja Happ committed
333
334
335
336
337
			//postgres.Jsonb{json.RawMessage(`{"location" : " ` + *payload.Properties.Location + `"}`)}
			updatedICReq.InfrastructureComponent.Location = *payload.Properties.Location
		}
		if payload.Properties.Description != nil {
			updatedICReq.InfrastructureComponent.Description = *payload.Properties.Description
338
		}
Sonja Happ's avatar
Sonja Happ committed
339
		// TODO add JSON start parameter scheme
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

		// Validate the updated IC
		if err = updatedICReq.Validate(); err != nil {
			log.Println("AMQP: Validation of updated IC failed:", err)
			return
		}

		// Create the updated IC from old IC
		updatedIC := updatedICReq.UpdatedIC(sToBeUpdated)

		// Finally update the IC in the DB
		err = sToBeUpdated.Update(updatedIC)
		if err != nil {
			log.Println("AMQP: Unable to update IC", sToBeUpdated.Name, "in DB: ", err)
			return
		}

		log.Println("AMQP: Updated IC ", sToBeUpdated.Name)
	}
}