2 * Copyright (C) 2015, 2016 IoT.bzh
3 * Author "Fulup Ar Foll"
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #define _GNU_SOURCE /* See feature_test_macros(7) */
22 #include <json-c/json.h>
24 #include <afb/afb-binding.h>
26 #include "utils-jbus.h"
28 static const char _added_[] = "added";
29 static const char _auto_[] = "auto";
30 static const char _continue_[] = "continue";
31 static const char _changed_[] = "changed";
32 static const char _detail_[] = "detail";
33 static const char _id_[] = "id";
34 static const char _install_[] = "install";
35 static const char _local_[] = "local";
36 static const char _mode_[] = "mode";
37 static const char _pause_[] = "pause";
38 static const char _remote_[] = "remote";
39 static const char _resume_[] = "resume";
40 static const char _runid_[] = "runid";
41 static const char _runnables_[] = "runnables";
42 static const char _runners_[] = "runners";
43 static const char _start_[] = "start";
44 static const char _state_[] = "state";
45 static const char _stop_[] = "stop";
46 static const char _terminate_[] = "terminate";
47 static const char _uninstall_[] = "uninstall";
48 static const char _uri_[] = "uri";
50 static const struct afb_binding_interface *binder;
52 static struct jbus *jbus;
55 * Structure for asynchronous call handling
59 struct afb_req request; /* the recorded request */
60 const char *method; /* the called method */
64 * Creates the memo for the 'request' and the 'method'.
65 * Returns the memo in case of success.
66 * In case of error, send a failure answer and returns NULL.
68 static struct memo *memo_create(struct afb_req request, const char *method)
70 struct memo *memo = malloc(sizeof *memo);
72 afb_req_fail(request, "failed", "out of memory");
74 memo->request = request;
75 memo->method = method;
76 afb_req_addref(request);
82 * Sends the asynchronous failed reply to the request recorded by 'memo'
83 * Then fress the resources.
85 static void memo_fail(struct memo *memo, const char *info)
87 afb_req_fail(memo->request, "failed", info);
88 afb_req_unref(memo->request);
93 * Sends the asynchronous success reply to the request recorded by 'memo'
94 * Then fress the resources.
96 static void memo_success(struct memo *memo, struct json_object *obj, const char *info)
98 afb_req_success(memo->request, obj, info);
99 afb_req_unref(memo->request);
104 * Broadcast the event "application-list-changed".
105 * This event is sent was the event "changed" is received from dbus.
107 static void application_list_changed(const char *data, void *closure)
109 afb_daemon_broadcast_event(binder->daemon, "application-list-changed", NULL);
113 * Builds if possible the json object having one field of name 'tag'
114 * whose value is 'obj' like here: { tag: obj } and returns it.
115 * In case of error or when 'tag'==NULL or 'obj'==NULL, 'obj' is returned.
116 * The reference count of 'obj' is not incremented.
118 static struct json_object *embed(const char *tag, struct json_object *obj)
120 struct json_object *result;
122 if (obj == NULL || tag == NULL)
125 result = json_object_new_object();
126 if (result == NULL) {
131 /* TODO why is json-c not returning a status? */
132 json_object_object_add(result, tag, obj);
139 * Callback for replies made by 'embed_call_void'.
141 static void embed_call_void_callback(int iserror, struct json_object *obj, struct memo *memo)
143 DEBUG(binder, "(afm-main-binding) %s(true) -> %s\n", memo->method,
144 obj ? json_object_to_json_string(obj) : "NULL");
147 memo_fail(memo, obj ? json_object_get_string(obj) : "framework daemon failure");
149 memo_success(memo, embed(memo->method, json_object_get(obj)), NULL);
154 * Calls with DBus the 'method' of the user daemon without arguments.
156 static void embed_call_void(struct afb_req request, const char *method)
160 /* store the request */
161 memo = memo_create(request, method);
165 if (jbus_call_sj(jbus, method, "true", (void*)embed_call_void_callback, memo) < 0)
166 memo_fail(memo, "dbus failure");
170 * Callback for replies made by 'call_appid' and 'call_runid'.
172 static void call_xxxid_callback(int iserror, struct json_object *obj, struct memo *memo)
174 DEBUG(binder, "(afm-main-binding) %s -> %s\n", memo->method,
175 obj ? json_object_to_json_string(obj) : "NULL");
178 memo_fail(memo, obj ? json_object_get_string(obj) : "framework daemon failure");
180 memo_success(memo, json_object_get(obj), NULL);
185 * Calls with DBus the 'method' of the user daemon with the argument "id".
187 static void call_appid(struct afb_req request, const char *method)
193 id = afb_req_value(request, _id_);
195 afb_req_fail(request, "bad-request", "missing 'id'");
199 memo = memo_create(request, method);
203 if (asprintf(&sid, "\"%s\"", id) <= 0) {
204 memo_fail(memo, "out of memory");
208 if (jbus_call_sj(jbus, method, sid, (void*)call_xxxid_callback, memo) < 0)
209 memo_fail(memo, "dbus failure");
214 static void call_runid(struct afb_req request, const char *method)
219 id = afb_req_value(request, _runid_);
221 afb_req_fail(request, "bad-request", "missing 'runid'");
225 memo = memo_create(request, method);
229 if (jbus_call_sj(jbus, method, id, (void*)call_xxxid_callback, memo) < 0)
230 memo_fail(memo, "dbus failure");
233 /************************** entries ******************************/
235 static void runnables(struct afb_req request)
237 embed_call_void(request, _runnables_);
240 static void detail(struct afb_req request)
242 call_appid(request, _detail_);
245 static void start_callback(int iserror, struct json_object *obj, struct memo *memo)
247 DEBUG(binder, "(afm-main-binding) %s -> %s\n", memo->method,
248 obj ? json_object_to_json_string(obj) : "NULL");
251 memo_fail(memo, obj ? json_object_get_string(obj) : "framework daemon failure");
253 obj = json_object_get(obj);
254 if (json_object_get_type(obj) == json_type_int)
255 obj = embed(_runid_, obj);
256 memo_success(memo, obj, NULL);
260 static void start(struct afb_req request)
263 const char *id, *mode;
268 id = afb_req_value(request, _id_);
270 afb_req_fail(request, "bad-request", "missing 'id'");
275 mode = afb_req_value(request, _mode_);
276 if (mode == NULL || !strcmp(mode, _auto_)) {
277 mode = binder->mode == AFB_MODE_REMOTE ? _remote_ : _local_;
280 /* prepares asynchronous request */
281 memo = memo_create(request, _start_);
285 /* create the query */
286 rc = asprintf(&query, "{\"id\":\"%s\",\"mode\":\"%s\"}", id, mode);
288 memo_fail(memo, "out of memory");
292 /* calls the service asynchronously */
293 if (jbus_call_sj(jbus, _start_, query, (void*)start_callback, memo) < 0)
294 memo_fail(memo, "dbus failure");
298 static void terminate(struct afb_req request)
300 call_runid(request, _terminate_);
303 static void pause(struct afb_req request)
305 call_runid(request, _pause_);
308 static void resume(struct afb_req request)
310 call_runid(request, _resume_);
313 static void runners(struct afb_req request)
315 embed_call_void(request, _runners_);
318 static void state(struct afb_req request)
320 call_runid(request, _state_);
323 static void install_callback(int iserror, struct json_object *obj, struct memo *memo)
325 struct json_object *added;
328 memo_fail(memo, obj ? json_object_get_string(obj) : "framework daemon failure");
330 if (json_object_object_get_ex(obj, _added_, &added))
332 obj = json_object_get(obj);
333 obj = embed(_id_, obj);
334 memo_success(memo, obj, NULL);
337 static void install(struct afb_req request)
341 const char *filename;
344 /* get the argument */
345 arg = afb_req_get(request, "widget");
347 if (filename == NULL) {
348 afb_req_fail(request, "bad-request", "missing 'widget' file");
352 /* prepares asynchronous request */
353 memo = memo_create(request, _install_);
357 /* makes the query */
358 if (0 >= asprintf(&query, "\"%s\"", filename)) {
359 afb_req_fail(request, "server-error", "out of memory");
363 /* calls the service asynchronously */
364 if (jbus_call_sj(jbus, _install_, query, (void*)install_callback, memo) < 0)
365 memo_fail(memo, "dbus failure");
369 static void uninstall(struct afb_req request)
371 call_appid(request, _uninstall_);
374 static const struct afb_verb_desc_v1 verbs[] =
376 {_runnables_, AFB_SESSION_CHECK, runnables, "Get list of runnable applications"},
377 {_detail_ , AFB_SESSION_CHECK, detail, "Get the details for one application"},
378 {_start_ , AFB_SESSION_CHECK, start, "Start an application"},
379 {_terminate_, AFB_SESSION_CHECK, terminate, "Terminate a running application"},
380 {_pause_ , AFB_SESSION_CHECK, pause, "Pause a running application"},
381 {_resume_ , AFB_SESSION_CHECK, resume, "Resume a paused application"},
382 {_stop_ , AFB_SESSION_CHECK, pause, "Obsolete since 2016/11/08, use 'pause' instead"},
383 {_continue_ , AFB_SESSION_CHECK, resume, "Obsolete since 2016/11/08, use 'resume' instead"},
384 {_runners_ , AFB_SESSION_CHECK, runners, "Get the list of running applications"},
385 {_state_ , AFB_SESSION_CHECK, state, "Get the state of a running application"},
386 {_install_ , AFB_SESSION_CHECK, install, "Install an application using a widget file"},
387 {_uninstall_, AFB_SESSION_CHECK, uninstall, "Uninstall an application"},
388 { NULL, 0, NULL, NULL }
391 static const struct afb_binding plug_desc = {
392 .type = AFB_BINDING_VERSION_1,
394 .info = "Application Framework Master Service",
395 .prefix = "afm-main",
400 const struct afb_binding *afbBindingV1Register(const struct afb_binding_interface *itf)
405 /* records the interface */
406 assert (binder == NULL);
409 /* creates the jbus for accessing afm-user-daemon */
410 sbus = afb_daemon_get_user_bus(itf->daemon);
413 jbus = create_jbus(sbus, "/org/AGL/afm/user");
417 /* records the signal handler */
418 rc = jbus_on_signal_s(jbus, _changed_, application_list_changed, NULL);