mirror of
https://github.com/eclipse-mosquitto/mosquitto.git
synced 2026-02-05 18:50:06 +08:00
Plugin persistence interface.
This commit is contained in:
Roger A. Light
327
src/plugin_persist.c
Normal file
327
src/plugin_persist.c
Normal file
@@ -0,0 +1,327 @@
|
||||
/*
|
||||
Copyright (c) 2021 Roger Light <roger@atchoo.org>
|
||||
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are made available under the terms of the Eclipse Public License 2.0
|
||||
and Eclipse Distribution License v1.0 which accompany this distribution.
|
||||
|
||||
The Eclipse Public License is available at
|
||||
https://www.eclipse.org/legal/epl-2.0/
|
||||
and the Eclipse Distribution License is available at
|
||||
http://www.eclipse.org/org/documents/edl-v10.php.
|
||||
|
||||
SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
|
||||
|
||||
Contributors:
|
||||
Roger Light - initial implementation and documentation.
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "mosquitto_broker_internal.h"
|
||||
#include "mosquitto_internal.h"
|
||||
#include "mosquitto_broker.h"
|
||||
#include "memory_mosq.h"
|
||||
#include "mqtt_protocol.h"
|
||||
#include "send_mosq.h"
|
||||
#include "util_mosq.h"
|
||||
#include "utlist.h"
|
||||
#include "lib_load.h"
|
||||
#include "will_mosq.h"
|
||||
|
||||
|
||||
void plugin_persist__handle_restore(void)
|
||||
{
|
||||
struct mosquitto_evt_persist_restore event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_restore, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_RESTORE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_client_add(struct mosquitto *context)
|
||||
{
|
||||
struct mosquitto_evt_persist_client event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
struct mosquitto_message_v5 will;
|
||||
|
||||
UNUSED(will); /* FIXME */
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
event_data.client_id = context->id;
|
||||
event_data.username = context->username;
|
||||
event_data.will_delay_time = context->will_delay_time;
|
||||
event_data.session_expiry_time = context->session_expiry_time;
|
||||
event_data.will_delay_interval = context->will_delay_interval;
|
||||
event_data.session_expiry_interval = context->session_expiry_interval;
|
||||
if(context->listener){
|
||||
event_data.listener_port = context->listener->port;
|
||||
}else{
|
||||
event_data.listener_port = 0;
|
||||
}
|
||||
event_data.max_qos = context->max_qos;
|
||||
event_data.retain_available = context->retain_available;
|
||||
event_data.max_packet_size = context->maximum_packet_size;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_client_add, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_CLIENT_ADD, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_client_update(struct mosquitto *context)
|
||||
{
|
||||
struct mosquitto_evt_persist_client event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
struct mosquitto_message_v5 will;
|
||||
|
||||
UNUSED(will); /* FIXME */
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
event_data.client_id = context->id;
|
||||
event_data.username = context->username;
|
||||
event_data.will_delay_time = context->will_delay_time;
|
||||
event_data.session_expiry_time = context->session_expiry_time;
|
||||
event_data.will_delay_interval = context->will_delay_interval;
|
||||
event_data.session_expiry_interval = context->session_expiry_interval;
|
||||
if(context->listener){
|
||||
event_data.listener_port = context->listener->port;
|
||||
}else{
|
||||
event_data.listener_port = 0;
|
||||
}
|
||||
event_data.max_qos = context->max_qos;
|
||||
event_data.retain_available = context->retain_available;
|
||||
event_data.max_packet_size = context->maximum_packet_size;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_client_update, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_CLIENT_UPDATE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_client_remove(struct mosquitto *context)
|
||||
{
|
||||
struct mosquitto_evt_persist_client event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
if(context->session_expiry_interval > 0 || context->id == NULL || context->state == mosq_cs_duplicate){
|
||||
return;
|
||||
}
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
event_data.client_id = context->id;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_client_remove, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_CLIENT_REMOVE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_subscription_add(struct mosquitto *context, const char *sub, uint8_t subscription_options, uint32_t subscription_identifier)
|
||||
{
|
||||
struct mosquitto_evt_persist_subscription event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
event_data.client_id = context->id;
|
||||
event_data.topic = sub;
|
||||
event_data.subscription_identifier = subscription_identifier;
|
||||
event_data.subscription_options = subscription_options;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_subscription_add, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_SUBSCRIPTION_ADD, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_subscription_remove(struct mosquitto *context, const char *sub)
|
||||
{
|
||||
struct mosquitto_evt_persist_subscription event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
event_data.client_id = context->id;
|
||||
event_data.topic = sub;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_subscription_remove, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_SUBSCRIPTION_REMOVE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_client_msg_add(struct mosquitto *context, const struct mosquitto_client_msg *cmsg)
|
||||
{
|
||||
struct mosquitto_evt_persist_client_msg event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
if(context->session_expiry_interval == 0
|
||||
|| (cmsg->qos == 0 && db.config->queue_qos0_messages == false)){
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
event_data.client_id = context->id;
|
||||
event_data.cmsg_id = cmsg->cmsg_id;
|
||||
event_data.store_id = cmsg->store->db_id;
|
||||
event_data.mid = cmsg->mid;
|
||||
event_data.qos = cmsg->qos;
|
||||
event_data.retain = cmsg->retain;
|
||||
event_data.dup = cmsg->dup;
|
||||
event_data.direction = cmsg->direction;
|
||||
event_data.state = cmsg->state;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_client_msg_add, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_CLIENT_MSG_ADD, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_client_msg_remove(struct mosquitto *context, const struct mosquitto_client_msg *cmsg)
|
||||
{
|
||||
struct mosquitto_evt_persist_client_msg event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
event_data.client_id = context->id;
|
||||
event_data.cmsg_id = cmsg->cmsg_id;
|
||||
event_data.mid = cmsg->mid;
|
||||
event_data.state = cmsg->state;
|
||||
event_data.qos = cmsg->qos;
|
||||
event_data.store_id = cmsg->store->db_id;
|
||||
event_data.direction = cmsg->direction;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_client_msg_remove, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_CLIENT_MSG_REMOVE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_client_msg_update(struct mosquitto *context, const struct mosquitto_client_msg *cmsg)
|
||||
{
|
||||
struct mosquitto_evt_persist_client_msg event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
event_data.client_id = context->id;
|
||||
event_data.cmsg_id = cmsg->cmsg_id;
|
||||
event_data.store_id = cmsg->store->db_id;
|
||||
event_data.state = cmsg->state;
|
||||
event_data.dup = cmsg->dup;
|
||||
event_data.direction = cmsg->direction;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_client_msg_update, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_CLIENT_MSG_UPDATE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_msg_add(struct mosquitto_msg_store *msg)
|
||||
{
|
||||
struct mosquitto_evt_persist_msg event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
if(msg->stored) return;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
event_data.store_id = msg->db_id;
|
||||
event_data.expiry_time = msg->message_expiry_time;
|
||||
event_data.topic = msg->topic;
|
||||
event_data.payload = msg->payload;
|
||||
event_data.source_id = msg->source_id;
|
||||
event_data.source_username = msg->source_username;
|
||||
event_data.properties = msg->properties;
|
||||
event_data.payloadlen = msg->payloadlen;
|
||||
event_data.source_mid = msg->source_mid;
|
||||
if(msg->source_listener){
|
||||
event_data.source_port = msg->source_listener->port;
|
||||
}else{
|
||||
event_data.source_port = 0;
|
||||
}
|
||||
event_data.qos = msg->qos;
|
||||
event_data.retain = msg->retain;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_msg_add, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_MSG_ADD, &event_data, cb_base->userdata);
|
||||
}
|
||||
msg->stored = true;
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_msg_remove(struct mosquitto_msg_store *msg)
|
||||
{
|
||||
struct mosquitto_evt_persist_msg event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
if(msg->stored == false) return;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
event_data.store_id = msg->db_id;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_msg_remove, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_MSG_REMOVE, &event_data, cb_base->userdata);
|
||||
}
|
||||
msg->stored = false;
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_retain_add(struct mosquitto_msg_store *msg)
|
||||
{
|
||||
struct mosquitto_evt_persist_retain event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
event_data.store_id = msg->db_id;
|
||||
event_data.topic = msg->topic;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_retain_add, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_MSG_ADD, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void plugin_persist__handle_retain_remove(struct mosquitto_msg_store *msg)
|
||||
{
|
||||
struct mosquitto_evt_persist_retain event_data;
|
||||
struct mosquitto__callback *cb_base;
|
||||
struct mosquitto__security_options *opts;
|
||||
|
||||
opts = &db.config->security_options;
|
||||
memset(&event_data, 0, sizeof(event_data));
|
||||
|
||||
event_data.topic = msg->topic;
|
||||
|
||||
DL_FOREACH(opts->plugin_callbacks.persist_retain_remove, cb_base){
|
||||
cb_base->cb(MOSQ_EVT_PERSIST_MSG_REMOVE, &event_data, cb_base->userdata);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user