(ACR) Modify the handle and API naming for resource and client(remote resource)
[platform/core/iot/iotcon.git] / lib / icl-resource.c
1 /*
2  * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #include <stdbool.h>
17 #include <stdint.h>
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <string.h>
21 #include <errno.h>
22 #include <glib.h>
23
24 #include "iotcon.h"
25 #include "ic-utils.h"
26 #include "icl.h"
27 #include "icl-repr.h"
28 #include "icl-dbus.h"
29 #include "icl-request.h"
30 #include "icl-dbus-type.h"
31 #include "icl-resource-types.h"
32 #include "icl-resource.h"
33 #include "icl-payload.h"
34
35 /**
36  * @brief The maximum length of uri_path path which can be held in a resource.
37  *
38  * @since_tizen 3.0
39  */
40 #define ICL_URI_PATH_LENGTH_MAX 36
41
42
43 static void _icl_request_handler(GDBusConnection *connection,
44                 const gchar *sender_name,
45                 const gchar *object_path,
46                 const gchar *interface_name,
47                 const gchar *signal_name,
48                 GVariant *parameters,
49                 gpointer user_data)
50 {
51         FN_CALL;
52         int ret;
53         char *key = NULL;
54         char *option_data;
55         char *value = NULL;
56         GVariant *repr_gvar;
57         GVariantIter *query;
58         GVariantIter *options;
59         GVariantIter *repr_iter;
60         unsigned short option_id;
61         struct icl_resource_request request = {0};
62         iotcon_resource_h resource = user_data;
63         iotcon_request_handler_cb cb = resource->cb;
64
65         g_variant_get(parameters, "(ia(qs)a(ss)iiavxx)",
66                         &request.types,
67                         &options,
68                         &query,
69                         &request.observation_info.action,
70                         &request.observation_info.observer_id,
71                         &repr_iter,
72                         &request.oic_request_h,
73                         &request.oic_resource_h);
74
75         if (g_variant_iter_n_children(options)) {
76                 ret = iotcon_options_create(&request.header_options);
77                 if (IOTCON_ERROR_NONE != ret) {
78                         ERR("iotcon_options_create() Fail(%d)", ret);
79                         g_variant_iter_free(options);
80                         g_variant_iter_free(query);
81                         g_variant_iter_free(repr_iter);
82                         return;
83                 }
84
85                 while (g_variant_iter_loop(options, "(q&s)", &option_id, &option_data))
86                         iotcon_options_insert(request.header_options, option_id, option_data);
87         }
88         g_variant_iter_free(options);
89
90         if (g_variant_iter_n_children(query)) {
91                 ret = iotcon_query_create(&request.query);
92                 if (IOTCON_ERROR_NONE != ret) {
93                         ERR("iotcon_query_create() Fail(%d)", ret);
94                         g_variant_iter_free(query);
95                         g_variant_iter_free(repr_iter);
96                         if (request.header_options)
97                                 iotcon_options_destroy(request.header_options);
98                         return;
99                 }
100
101                 while (g_variant_iter_loop(query, "(&s&s)", &key, &value))
102                         iotcon_query_insert(request.query, key, value);
103         }
104         g_variant_iter_free(query);
105
106         if (g_variant_iter_loop(repr_iter, "v", &repr_gvar)) {
107                 request.repr = icl_representation_from_gvariant(repr_gvar);
108                 if (NULL == request.repr) {
109                         ERR("icl_representation_from_gvariant() Fail");
110                         if (request.query)
111                                 iotcon_query_destroy(request.query);
112                         if (request.header_options)
113                                 iotcon_options_destroy(request.header_options);
114                         return;
115                 }
116         }
117         g_variant_iter_free(repr_iter);
118
119         /* TODO remove request.uri */
120         request.uri_path = "temp_uri_path";
121
122         if (cb)
123                 cb(resource, &request, resource->user_data);
124
125         /* To avoid unnecessary ERR log (representation could be NULL) */
126         if (request.repr)
127                 iotcon_representation_destroy(request.repr);
128         if (request.query)
129                 iotcon_query_destroy(request.query);
130         if (request.header_options)
131                 iotcon_options_destroy(request.header_options);
132 }
133
134
135 static void _icl_resource_conn_cleanup(iotcon_resource_h resource)
136 {
137         resource->sub_id = 0;
138
139         if (resource->handle) {
140                 resource->handle = 0;
141                 return;
142         }
143
144         iotcon_resource_types_destroy(resource->types);
145         free(resource->uri_path);
146         free(resource);
147 }
148
149
150 /* The length of uri_path should be less than or equal to 36. */
151 API int iotcon_resource_create(const char *uri_path,
152                 iotcon_resource_types_h res_types,
153                 int ifaces,
154                 uint8_t properties,
155                 iotcon_request_handler_cb cb,
156                 void *user_data,
157                 iotcon_resource_h *resource_handle)
158 {
159         unsigned int sub_id;
160         GError *error = NULL;
161         const gchar **types;
162         iotcon_resource_h resource;
163         int signal_number, ret;
164         char sig_name[IC_DBUS_SIGNAL_LENGTH];
165
166         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
167         RETV_IF(NULL == uri_path, IOTCON_ERROR_INVALID_PARAMETER);
168         RETVM_IF(ICL_URI_PATH_LENGTH_MAX < strlen(uri_path),
169                         IOTCON_ERROR_INVALID_PARAMETER, "Invalid uri_path(%s)", uri_path);
170         RETV_IF(NULL == res_types, IOTCON_ERROR_INVALID_PARAMETER);
171         RETV_IF(NULL == cb, IOTCON_ERROR_INVALID_PARAMETER);
172
173         resource = calloc(1, sizeof(struct icl_resource));
174         if (NULL == resource) {
175                 ERR("calloc() Fail(%d)", errno);
176                 return IOTCON_ERROR_OUT_OF_MEMORY;
177         }
178
179         types = icl_dbus_resource_types_to_array(res_types);
180         if (NULL == types) {
181                 ERR("icl_dbus_resource_types_to_array() Fail");
182                 free(resource);
183                 return IOTCON_ERROR_INVALID_PARAMETER;
184         }
185
186         signal_number = icl_dbus_generate_signal_number();
187
188         ic_dbus_call_register_resource_sync(icl_dbus_get_object(), uri_path, types, ifaces,
189                         properties, signal_number, &(resource->handle), NULL, &error);
190         if (error) {
191                 ERR("ic_dbus_call_register_resource_sync() Fail(%s)", error->message);
192                 ret = icl_dbus_convert_dbus_error(error->code);
193                 g_error_free(error);
194                 free(types);
195                 free(resource);
196                 return ret;
197         }
198         free(types);
199
200         if (0 == resource->handle) {
201                 ERR("iotcon-daemon Fail");
202                 free(resource);
203                 return IOTCON_ERROR_IOTIVITY;
204         }
205
206         resource->cb = cb;
207         resource->user_data = user_data;
208
209         resource->types = icl_resource_types_ref(res_types);
210         resource->uri_path = ic_utils_strdup(uri_path);
211         resource->ifaces = ifaces;
212         resource->is_observable = properties & IOTCON_OBSERVABLE;
213
214         snprintf(sig_name, sizeof(sig_name), "%s_%u", IC_DBUS_SIGNAL_REQUEST_HANDLER,
215                         signal_number);
216
217         sub_id = icl_dbus_subscribe_signal(sig_name, resource, _icl_resource_conn_cleanup,
218                         _icl_request_handler);
219         if (0 == sub_id) {
220                 ERR("icl_dbus_subscribe_signal() Fail");
221                 iotcon_resource_types_destroy(res_types);
222                 free(resource->uri_path);
223                 free(resource);
224                 return IOTCON_ERROR_DBUS;
225         }
226
227         resource->sub_id = sub_id;
228
229         *resource_handle = resource;
230
231         return IOTCON_ERROR_NONE;
232 }
233
234
235 API int iotcon_resource_destroy(iotcon_resource_h resource)
236 {
237         FN_CALL;
238         int ret;
239         GError *error = NULL;
240
241         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
242         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
243
244         if (0 == resource->sub_id) {
245                 WARN("Invalid Resource handle");
246                 iotcon_resource_types_destroy(resource->types);
247                 free(resource->uri_path);
248                 free(resource);
249                 return IOTCON_ERROR_NONE;
250         }
251
252         ic_dbus_call_unregister_resource_sync(icl_dbus_get_object(), resource->handle, NULL,
253                         &error);
254         if (error) {
255                 ERR("ic_dbus_call_unregister_resource_sync() Fail(%s)", error->message);
256                 ret = icl_dbus_convert_dbus_error(error->code);
257                 g_error_free(error);
258                 return ret;
259         }
260
261         resource->handle = 0;
262
263         icl_dbus_unsubscribe_signal(resource->sub_id);
264
265         return IOTCON_ERROR_NONE;
266 }
267
268
269 API int iotcon_resource_bind_interface(iotcon_resource_h resource, int iface)
270 {
271         FN_CALL;
272         int ret;
273         GError *error = NULL;
274
275         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
276         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
277         if (0 == resource->sub_id) {
278                 ERR("Invalid Resource handle");
279                 return IOTCON_ERROR_INVALID_PARAMETER;
280         }
281
282         ic_dbus_call_bind_interface_sync(icl_dbus_get_object(), resource->handle,
283                         iface, &ret, NULL, &error);
284         if (error) {
285                 ERR("ic_dbus_call_bind_interface_sync() Fail(%s)", error->message);
286                 ret = icl_dbus_convert_dbus_error(error->code);
287                 g_error_free(error);
288                 return ret;
289         }
290
291         if (IOTCON_ERROR_NONE != ret) {
292                 ERR("iotcon-daemon Fail(%d)", ret);
293                 return icl_dbus_convert_daemon_error(ret);
294         }
295
296         return ret;
297 }
298
299
300 API int iotcon_resource_bind_type(iotcon_resource_h resource, const char *resource_type)
301 {
302         FN_CALL;
303         int ret;
304         GError *error = NULL;
305
306         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
307         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
308         RETV_IF(NULL == resource_type, IOTCON_ERROR_INVALID_PARAMETER);
309         if (ICL_RESOURCE_TYPE_LENGTH_MAX < strlen(resource_type)) {
310                 ERR("Invalid resource_type(%s)", resource_type);
311                 return IOTCON_ERROR_INVALID_PARAMETER;
312         }
313
314         if (0 == resource->sub_id) {
315                 ERR("Invalid Resource handle");
316                 return IOTCON_ERROR_INVALID_PARAMETER;
317         }
318
319         ic_dbus_call_bind_type_sync(icl_dbus_get_object(), resource->handle, resource_type,
320                         &ret, NULL, &error);
321         if (error) {
322                 ERR("ic_dbus_call_bind_type_sync() Fail(%s)", error->message);
323                 ret = icl_dbus_convert_dbus_error(error->code);
324                 g_error_free(error);
325                 return ret;
326         }
327
328         if (IOTCON_ERROR_NONE != ret) {
329                 ERR("iotcon-daemon Fail(%d)", ret);
330                 return icl_dbus_convert_daemon_error(ret);
331         }
332
333         return ret;
334 }
335
336
337 API int iotcon_resource_set_request_handler(iotcon_resource_h resource,
338                 iotcon_request_handler_cb cb)
339 {
340         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
341         RETV_IF(NULL == cb, IOTCON_ERROR_INVALID_PARAMETER);
342
343         WARN("Request handler is changed");
344         resource->cb = cb;
345
346         return IOTCON_ERROR_NONE;
347 }
348
349
350 API int iotcon_resource_bind_child_resource(iotcon_resource_h parent,
351                 iotcon_resource_h child)
352 {
353         GError *error = NULL;
354         int i, ret;
355
356         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
357         RETV_IF(NULL == parent, IOTCON_ERROR_INVALID_PARAMETER);
358         RETV_IF(NULL == child, IOTCON_ERROR_INVALID_PARAMETER);
359         RETV_IF(parent == child, IOTCON_ERROR_INVALID_PARAMETER);
360
361         if (0 == parent->sub_id) {
362                 ERR("Invalid Resource handle(parent)");
363                 return IOTCON_ERROR_INVALID_PARAMETER;
364         }
365         if (0 == child->sub_id) {
366                 ERR("Invalid Resource handle(child)");
367                 return IOTCON_ERROR_INVALID_PARAMETER;
368         }
369
370         for (i = 0; i < ICL_CONTAINED_RESOURCES_MAX; i++) {
371                 if (child == parent->children[i]) {
372                         ERR("Child resource was already bound to parent resource.");
373                         return IOTCON_ERROR_ALREADY;
374                 }
375         }
376
377         for (i = 0; i < ICL_CONTAINED_RESOURCES_MAX; i++) {
378                 if (NULL == parent->children[i]) {
379                         ic_dbus_call_bind_resource_sync(icl_dbus_get_object(), parent->handle,
380                                         child->handle, &ret, NULL, &error);
381                         if (error) {
382                                 ERR("ic_dbus_call_bind_resource_sync() Fail(%s)", error->message);
383                                 ret = icl_dbus_convert_dbus_error(error->code);
384                                 g_error_free(error);
385                                 return ret;
386                         }
387
388                         if (IOTCON_ERROR_NONE != ret) {
389                                 ERR("iotcon-daemon Fail(%d)", ret);
390                                 return icl_dbus_convert_daemon_error(ret);
391                         }
392
393                         parent->children[i] = child;
394
395                         return IOTCON_ERROR_NONE;
396                 }
397         }
398
399         ERR("There is no slot to bind a child resource");
400         return IOTCON_ERROR_OUT_OF_MEMORY;
401 }
402
403
404 API int iotcon_resource_unbind_child_resource(iotcon_resource_h parent,
405                 iotcon_resource_h child)
406 {
407         GError *error = NULL;
408         int i, ret;
409
410         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
411         RETV_IF(NULL == parent, IOTCON_ERROR_INVALID_PARAMETER);
412         RETV_IF(NULL == child, IOTCON_ERROR_INVALID_PARAMETER);
413
414         if (0 == parent->sub_id) {
415                 ERR("Invalid Resource handle(parent)");
416                 return IOTCON_ERROR_INVALID_PARAMETER;
417         }
418         if (0 == child->sub_id) {
419                 ERR("Invalid Resource handle(child)");
420                 return IOTCON_ERROR_INVALID_PARAMETER;
421         }
422
423         ic_dbus_call_unbind_resource_sync(icl_dbus_get_object(), parent->handle,
424                         child->handle, &ret, NULL, &error);
425         if (error) {
426                 ERR("ic_dbus_call_unbind_resource_sync() Fail(%s)", error->message);
427                 ret = icl_dbus_convert_dbus_error(error->code);
428                 g_error_free(error);
429                 return ret;
430         }
431
432         if (IOTCON_ERROR_NONE != ret) {
433                 ERR("iotcon-daemon Fail(%d)", ret);
434                 return icl_dbus_convert_daemon_error(ret);
435         }
436
437         for (i = 0; i < ICL_CONTAINED_RESOURCES_MAX; i++) {
438                 if (child == parent->children[i])
439                         parent->children[i] = NULL;
440         }
441
442         return IOTCON_ERROR_NONE;
443 }
444
445
446 API int iotcon_resource_get_number_of_children(iotcon_resource_h resource, int *number)
447 {
448         int i;
449
450         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
451         RETV_IF(NULL == number, IOTCON_ERROR_INVALID_PARAMETER);
452
453         *number = 0;
454         for (i = 0; i < ICL_CONTAINED_RESOURCES_MAX; i++) {
455                 if (resource->children[i])
456                         *number += 1;
457         }
458
459         return IOTCON_ERROR_NONE;
460 }
461
462
463 API int iotcon_resource_get_nth_child(iotcon_resource_h parent, int index,
464                 iotcon_resource_h *child)
465 {
466         RETV_IF(NULL == parent, IOTCON_ERROR_INVALID_PARAMETER);
467         RETV_IF(NULL == child, IOTCON_ERROR_INVALID_PARAMETER);
468         if ((index < 0) || (ICL_CONTAINED_RESOURCES_MAX <= index)) {
469                 ERR("Invalid index(%d)", index);
470                 return IOTCON_ERROR_INVALID_PARAMETER;
471         }
472
473         *child = parent->children[index];
474
475         return IOTCON_ERROR_NONE;
476 }
477
478
479 /* The content of the resource should not be freed by user. */
480 API int iotcon_resource_get_uri_path(iotcon_resource_h resource, char **uri_path)
481 {
482         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
483         RETV_IF(NULL == uri_path, IOTCON_ERROR_INVALID_PARAMETER);
484
485         *uri_path = resource->uri_path;
486
487         return IOTCON_ERROR_NONE;
488 }
489
490
491 /* The content of the resource should not be freed by user. */
492 API int iotcon_resource_get_types(iotcon_resource_h resource,
493                 iotcon_resource_types_h *types)
494 {
495         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
496         RETV_IF(NULL == types, IOTCON_ERROR_INVALID_PARAMETER);
497
498         *types = resource->types;
499
500         return IOTCON_ERROR_NONE;
501 }
502
503
504 API int iotcon_resource_get_interfaces(iotcon_resource_h resource, int *ifaces)
505 {
506         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
507         RETV_IF(NULL == ifaces, IOTCON_ERROR_INVALID_PARAMETER);
508
509         *ifaces = resource->ifaces;
510
511         return IOTCON_ERROR_NONE;
512 }
513
514
515 API int iotcon_resource_is_observable(iotcon_resource_h resource, bool *observable)
516 {
517         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
518         RETV_IF(NULL == observable, IOTCON_ERROR_INVALID_PARAMETER);
519
520         *observable = resource->is_observable;
521
522         return IOTCON_ERROR_NONE;
523 }
524
525
526 API int iotcon_notimsg_create(iotcon_representation_h repr, int iface,
527                 iotcon_notimsg_h *notimsg_handle)
528 {
529         iotcon_notimsg_h msg;
530
531         RETV_IF(NULL == repr, IOTCON_ERROR_INVALID_PARAMETER);
532         RETV_IF(NULL == notimsg_handle, IOTCON_ERROR_INVALID_PARAMETER);
533
534         msg = calloc(1, sizeof(struct icl_notify_msg));
535         if (NULL == msg) {
536                 ERR("calloc() Fail(%d)", errno);
537                 return IOTCON_ERROR_OUT_OF_MEMORY;
538         }
539
540         msg->repr = repr;
541         icl_representation_inc_ref_count(msg->repr);
542         msg->iface = iface;
543         msg->error_code = 200;
544
545         *notimsg_handle = msg;
546
547         return IOTCON_ERROR_NONE;
548 }
549
550
551 API void iotcon_notimsg_destroy(iotcon_notimsg_h msg)
552 {
553         RET_IF(NULL == msg);
554
555         iotcon_representation_destroy(msg->repr);
556         free(msg);
557 }
558
559
560 API int iotcon_notify_list_of_observers(iotcon_resource_h resource, iotcon_notimsg_h msg,
561                 iotcon_observers_h observers)
562 {
563         int ret;
564         GError *error = NULL;
565         GVariant *noti_msg;
566         GVariant *obs;
567
568         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
569         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
570         RETV_IF(NULL == observers, IOTCON_ERROR_INVALID_PARAMETER);
571
572         if (0 == resource->sub_id) {
573                 ERR("Invalid Resource handle");
574                 return IOTCON_ERROR_INVALID_PARAMETER;
575         }
576
577         noti_msg = icl_dbus_notimsg_to_gvariant(msg);
578         if (NULL == noti_msg) {
579                 ERR("icl_dbus_notimsg_to_gvariant() Fail");
580                 return IOTCON_ERROR_REPRESENTATION;
581         }
582         obs = icl_dbus_observers_to_gvariant(observers);
583
584         ic_dbus_call_notify_list_of_observers_sync(icl_dbus_get_object(), resource->handle,
585                         noti_msg, obs, &ret, NULL, &error);
586         if (error) {
587                 ERR("ic_dbus_call_notify_list_of_observers_sync() Fail(%s)", error->message);
588                 ret = icl_dbus_convert_dbus_error(error->code);
589                 g_error_free(error);
590                 g_variant_unref(obs);
591                 g_variant_unref(noti_msg);
592                 return ret;
593         }
594
595         if (IOTCON_ERROR_NONE != ret) {
596                 ERR("iotcon-daemon Fail(%d)", ret);
597                 return icl_dbus_convert_daemon_error(ret);
598         }
599
600         return IOTCON_ERROR_NONE;
601 }
602
603
604 API int iotcon_resource_notify_all(iotcon_resource_h resource)
605 {
606         int ret;
607         GError *error = NULL;
608
609         RETV_IF(NULL == icl_dbus_get_object(), IOTCON_ERROR_DBUS);
610         RETV_IF(NULL == resource, IOTCON_ERROR_INVALID_PARAMETER);
611         if (0 == resource->sub_id) {
612                 ERR("Invalid Resource handle");
613                 return IOTCON_ERROR_INVALID_PARAMETER;
614         }
615
616         ic_dbus_call_notify_all_sync(icl_dbus_get_object(), resource->handle, &ret, NULL,
617                         &error);
618         if (error) {
619                 ERR("ic_dbus_call_notify_all_sync() Fail(%s)", error->message);
620                 ret = icl_dbus_convert_dbus_error(error->code);
621                 g_error_free(error);
622                 return ret;
623         }
624
625         if (IOTCON_ERROR_NONE != ret) {
626                 ERR("iotcon-daemon Fail(%d)", ret);
627                 return icl_dbus_convert_daemon_error(ret);
628         }
629
630         return IOTCON_ERROR_NONE;
631 }