ubusd_event.c

   1 /*
   2  * Copyright (C) 2011 Felix Fietkau <nbd@openwrt.org>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License version 2.1
   6  * as published by the Free Software Foundation
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #include <arpa/inet.h>
  15 #include "ubusd.h"
  16
  17 static struct avl_tree patterns;
  18 static struct ubus_object *event_obj;
  19 static int event_seq = 0;
  20 static int obj_event_seq = 1;
  21
  22 struct event_source {
  23         struct list_head list;
  24         struct ubus_object *obj;
  25         struct avl_node avl;
  26         bool partial;
  27 };
  28
  29 static void ubusd_delete_event_source(struct event_source *evs)
  30 {
  31         list_del(&evs->list);
  32         avl_delete(&patterns, &evs->avl);
  33         free(evs);
  34 }
  35
  36 void ubusd_event_cleanup_object(struct ubus_object *obj)
  37 {
  38         struct event_source *ev;
  39
  40         while (!list_empty(&obj->events)) {
  41                 ev = list_first_entry(&obj->events, struct event_source, list);
  42                 ubusd_delete_event_source(ev);
  43         }
  44 }
  45
  46 enum {
  47         EVREG_PATTERN,
  48         EVREG_OBJECT,
  49         EVREG_LAST,
  50 };
  51
  52 static struct blobmsg_policy evr_policy[] = {
  53         [EVREG_PATTERN] = { .name = "pattern", .type = BLOBMSG_TYPE_STRING },
  54         [EVREG_OBJECT] = { .name = "object", .type = BLOBMSG_TYPE_INT32 },
  55 };
  56
  57 static int ubusd_alloc_event_pattern(struct ubus_client *cl, struct blob_attr *msg)
  58 {
  59         struct event_source *ev;
  60         struct ubus_object *obj;
  61         struct blob_attr *attr[EVREG_LAST];
  62         char *pattern, *name;
  63         uint32_t id;
  64         bool partial = false;
  65         int len;
  66
  67         blobmsg_parse(evr_policy, EVREG_LAST, attr, blob_data(msg), blob_len(msg));
  68         if (!attr[EVREG_OBJECT] || !attr[EVREG_PATTERN])
  69                 return UBUS_STATUS_INVALID_ARGUMENT;
  70
  71         id = blobmsg_get_u32(attr[EVREG_OBJECT]);
  72         if (id < UBUS_SYSTEM_OBJECT_MAX)
  73                 return UBUS_STATUS_PERMISSION_DENIED;
  74
  75         obj = ubusd_find_object(id);
  76         if (!obj)
  77                 return UBUS_STATUS_NOT_FOUND;
  78
  79         if (obj->client != cl)
  80                 return UBUS_STATUS_PERMISSION_DENIED;
  81
  82         pattern = blobmsg_data(attr[EVREG_PATTERN]);
  83
  84         len = strlen(pattern);
  85         if (pattern[len - 1] == '*') {
  86                 partial = true;
  87                 pattern[len - 1] = 0;
  88                 len--;
  89         }
  90
  91         if (pattern[0] && ubusd_acl_check(cl, pattern, NULL, UBUS_ACL_LISTEN))
  92                 return UBUS_STATUS_PERMISSION_DENIED;
  93
  94         ev = calloc(1, sizeof(*ev) + len + 1);
  95         if (!ev)
  96                 return UBUS_STATUS_NO_DATA;
  97
  98         list_add(&ev->list, &obj->events);
  99         ev->obj = obj;
 100         ev->partial = partial;
 101         name = (char *) (ev + 1);
 102         strcpy(name, pattern);
 103         ev->avl.key = name;
 104         avl_insert(&patterns, &ev->avl);
 105
 106         return 0;
 107 }
 108
 109 static void ubusd_send_event_msg(struct ubus_msg_buf **ub, struct ubus_client *cl,
 110                                  struct ubus_object *obj, const char *id,
 111                                  event_fill_cb fill_cb, void *cb_priv)
 112 {
 113         uint32_t *objid_ptr;
 114
 115         /* do not loop back events */
 116         if (obj->client == cl)
 117             return;
 118
 119         /* do not send duplicate events */
 120         if (obj->event_seen == obj_event_seq)
 121                 return;
 122
 123         obj->event_seen = obj_event_seq;
 124
 125         if (!*ub) {
 126                 *ub = fill_cb(cb_priv, id);
 127                 (*ub)->hdr.type = UBUS_MSG_INVOKE;
 128                 (*ub)->hdr.peer = 0;
 129         }
 130
 131         objid_ptr = blob_data(blob_data((*ub)->data));
 132         *objid_ptr = htonl(obj->id.id);
 133
 134         (*ub)->hdr.seq = ++event_seq;
 135         ubus_msg_send(obj->client, *ub);
 136 }
 137
 138 int ubusd_send_event(struct ubus_client *cl, const char *id,
 139                      event_fill_cb fill_cb, void *cb_priv)
 140 {
 141         struct ubus_msg_buf *ub = NULL;
 142         struct event_source *ev;
 143         int match_len = 0;
 144
 145         if (ubusd_acl_check(cl, id, NULL, UBUS_ACL_SEND))
 146                 return UBUS_STATUS_PERMISSION_DENIED;
 147
 148         obj_event_seq++;
 149
 150         /*
 151          * Since this tree is sorted alphabetically, we can only expect to find
 152          * matching entries as long as the number of matching characters
 153          * between the pattern string and our string is monotonically increasing.
 154          */
 155         avl_for_each_element(&patterns, ev, avl) {
 156                 const char *key = ev->avl.key;
 157                 int cur_match_len;
 158                 bool full_match;
 159
 160                 full_match = ubus_strmatch_len(id, key, &cur_match_len);
 161                 if (cur_match_len < match_len)
 162                         break;
 163
 164                 match_len = cur_match_len;
 165
 166                 if (!full_match) {
 167                         if (!ev->partial)
 168                                 continue;
 169
 170                         if (match_len != (int) strlen(key))
 171                                 continue;
 172                 }
 173
 174                 ubusd_send_event_msg(&ub, cl, ev->obj, id, fill_cb, cb_priv);
 175         }
 176
 177         if (ub)
 178                 ubus_msg_free(ub);
 179
 180         return 0;
 181 }
 182
 183 enum {
 184         EVMSG_ID,
 185         EVMSG_DATA,
 186         EVMSG_LAST,
 187 };
 188
 189 static struct blobmsg_policy ev_policy[] = {
 190         [EVMSG_ID] = { .name = "id", .type = BLOBMSG_TYPE_STRING },
 191         [EVMSG_DATA] = { .name = "data", .type = BLOBMSG_TYPE_TABLE },
 192 };
 193
 194 static struct ubus_msg_buf *
 195 ubusd_create_event_from_msg(void *priv, const char *id)
 196 {
 197         struct blob_attr *msg = priv;
 198
 199         blob_buf_init(&b, 0);
 200         blob_put_int32(&b, UBUS_ATTR_OBJID, 0);
 201         blob_put_string(&b, UBUS_ATTR_METHOD, id);
 202         blob_put(&b, UBUS_ATTR_DATA, blobmsg_data(msg), blobmsg_data_len(msg));
 203
 204         return ubus_msg_new(b.head, blob_raw_len(b.head), true);
 205 }
 206
 207 static int ubusd_forward_event(struct ubus_client *cl, struct blob_attr *msg)
 208 {
 209         struct blob_attr *data;
 210         struct blob_attr *attr[EVMSG_LAST];
 211         const char *id;
 212
 213         blobmsg_parse(ev_policy, EVMSG_LAST, attr, blob_data(msg), blob_len(msg));
 214         if (!attr[EVMSG_ID] || !attr[EVMSG_DATA])
 215                 return UBUS_STATUS_INVALID_ARGUMENT;
 216
 217         id = blobmsg_data(attr[EVMSG_ID]);
 218         data = attr[EVMSG_DATA];
 219
 220         if (!strncmp(id, "ubus.", 5))
 221                 return UBUS_STATUS_PERMISSION_DENIED;
 222
 223         return ubusd_send_event(cl, id, ubusd_create_event_from_msg, data);
 224 }
 225
 226 static int ubusd_event_recv(struct ubus_client *cl, struct ubus_msg_buf *ub, const char *method, struct blob_attr *msg)
 227 {
 228         if (!strcmp(method, "register"))
 229                 return ubusd_alloc_event_pattern(cl, msg);
 230
 231         if (!strcmp(method, "send"))
 232                 return ubusd_forward_event(cl, msg);
 233
 234         return UBUS_STATUS_INVALID_COMMAND;
 235 }
 236
 237 static struct ubus_msg_buf *
 238 ubusd_create_object_event_msg(void *priv, const char *id)
 239 {
 240         struct ubus_object *obj = priv;
 241         void *s;
 242
 243         blob_buf_init(&b, 0);
 244         blob_put_int32(&b, UBUS_ATTR_OBJID, 0);
 245         blob_put_string(&b, UBUS_ATTR_METHOD, id);
 246         s = blob_nest_start(&b, UBUS_ATTR_DATA);
 247         blobmsg_add_u32(&b, "id", obj->id.id);
 248         blobmsg_add_string(&b, "path", obj->path.key);
 249         blob_nest_end(&b, s);
 250
 251         return ubus_msg_new(b.head, blob_raw_len(b.head), true);
 252 }
 253
 254 void ubusd_send_obj_event(struct ubus_object *obj, bool add)
 255 {
 256         const char *id = add ? "ubus.object.add" : "ubus.object.remove";
 257
 258         ubusd_send_event(NULL, id, ubusd_create_object_event_msg, obj);
 259 }
 260
 261 void ubusd_event_init(void)
 262 {
 263         ubus_init_string_tree(&patterns, true);
 264         event_obj = ubusd_create_object_internal(NULL, UBUS_SYSTEM_OBJECT_EVENT);
 265         if (event_obj != NULL)
 266                 event_obj->recv_msg = ubusd_event_recv;
 267 }
 268