summaryrefslogtreecommitdiffstats
path: root/AFBClient.cpp
blob: 4b37740909d20b0feceed7d3cec5b8d4aa57b08b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
275
276
277
278
279
280
281
282
283
284
285
286
287
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
#include "AFBClient.h"

#include <cassert>
#include <cctype>
#include <cerrno>
#include <cstdio>
#include <cstdlib>
#include <cstring>

#include <atomic>
#include <map>
#include <mutex>
#include <set>

#include <unistd.h>

#include <systemd/sd-event.h>

#include <json-c/json.h>

extern "C" {
#include <afb/afb-ws-client.h>
#include <afb/afb-wsj1.h>
}

#define UNUSED(x) (void)(x)

//       _                 ___                 _
//   ___| | __ _ ___ ___  |_ _|_ __ ___  _ __ | |
//  / __| |/ _` / __/ __|  | || '_ ` _ \| '_ \| |
// | (__| | (_| \__ \__ \  | || | | | | | |_) | |
//  \___|_|\__,_|___/___/ |___|_| |_| |_| .__/|_|
//                                      |_|
class AFBClient::Impl {
    friend class AFBClient;

    // This is the AFBClient interface impl
    int init(int port, char const *token);
    int dispatch();

    // WM API
    int requestSurface(const char *label);
    int activateSurface(const char *label);
    int deactivateSurface(const char *label);
    int endDraw(const char *label);

    void set_event_handler(enum EventType et, handler_fun func);

    Impl();
    ~Impl();

    struct afb_wsj1 *wsj1;
    struct sd_event *loop;

    std::set<std::string> labels;
    std::map<EventType, handler_fun> handlers;

    int api_call(const char *verb, json_object *object,
                 const std::function<void(bool, json_object *)> &onReply);

public:
    void event(char const *et, char const *label);
};

namespace {

constexpr const int token_maxlen = 20;
constexpr const char *const wmAPI = "winman";

#ifdef NDEBUG
#define TRACE()
#define TRACEN(N)
#else
#define CONCAT_(X, Y) X##Y
#define CONCAT(X, Y) CONCAT_(X, Y)

#define TRACE() \
    ScopeTrace __attribute__((unused)) CONCAT(trace_scope_, __LINE__)(__func__)
#define TRACEN(N) \
    ScopeTrace __attribute__((unused)) CONCAT(named_trace_scope_, __LINE__)(#N)

struct ScopeTrace {
    thread_local static int indent;
    char const *f{};
    explicit ScopeTrace(char const *func) : f(func) {
        fprintf(stderr, "%*s%s -->\n", 2 * indent++, "", this->f);
    }
    ~ScopeTrace() { fprintf(stderr, "%*s%s <--\n", 2 * --indent, "", this->f); }
};
thread_local int ScopeTrace::indent = 0;
#endif

/* called when wsj1 receives a method invocation */
void onCall(void *closure, const char *api, const char *verb,
            struct afb_wsj1_msg *msg) {
    TRACE();
    UNUSED(closure);
    UNUSED(verb);
    UNUSED(api);
    UNUSED(msg);
}

/* called when wsj1 receives an event */
void onEvent(void *closure, const char *event, afb_wsj1_msg *msg) {
    TRACE();
    reinterpret_cast<AFBClient::Impl *>(closure)->event(
        event, json_object_get_string(
                   json_object_object_get(afb_wsj1_msg_object_j(msg), "data")));
}

/* called when wsj1 hangsup */
void onHangup(void *closure, afb_wsj1 *wsj1) {
    TRACE();
    UNUSED(closure);
    UNUSED(wsj1);
    fputs("Hangup, the WindowManager vanished\n", stderr);
    exit(1);
}

constexpr struct afb_wsj1_itf itf = {
    onHangup, onCall, onEvent,
};

// XXX: I am not sure this is the right thing to do though...
std::recursive_mutex dispatch_mutex;

void dispatch_internal(struct sd_event *loop) {
    std::lock_guard<std::recursive_mutex> guard(dispatch_mutex);
    TRACE();
    sd_event_run(loop, -1);
}

}  // namespace

//       _                 ___                 _   _                 _
//   ___| | __ _ ___ ___  |_ _|_ __ ___  _ __ | | (_)_ __ ___  _ __ | |
//  / __| |/ _` / __/ __|  | || '_ ` _ \| '_ \| | | | '_ ` _ \| '_ \| |
// | (__| | (_| \__ \__ \  | || | | | | | |_) | | | | | | | | | |_) | |
//  \___|_|\__,_|___/___/ |___|_| |_| |_| .__/|_| |_|_| |_| |_| .__/|_|
//                                      |_|                   |_|
AFBClient::Impl::Impl() : wsj1{}, loop{}, labels(), handlers() { TRACE(); }

AFBClient::Impl::~Impl() {
    TRACE();
    afb_wsj1_unref(wsj1);
    sd_event_unref(loop);
}

int AFBClient::Impl::init(int port, char const *token) {
    TRACE();
    char *uribuf = nullptr;
    int rc = -1;

    if (this->loop != nullptr && this->wsj1 != nullptr) {
        fputs("AFBClient instance is already initialized!\n", stderr);
        rc = -EALREADY;
        goto fail;
    }

    if ((token == nullptr) || strlen(token) > token_maxlen) {
        fputs("Token is invalid\n", stderr);
        rc = -EINVAL;
        goto fail;
    }

    for (char const *p = token; *p != 0; p++) {
        if (isalnum(*p) == 0) {
            fputs("Token is invalid\n", stderr);
            rc = -EINVAL;
            goto fail;
        }
    }

    if (port < 1 && port > 0xffff) {
        fputs("Port is invalid\n", stderr);
        rc = -EINVAL;
        goto fail;
    }

    /* get the default event loop */
    rc = sd_event_default(&this->loop);
    if (rc < 0) {
        fprintf(stderr, "Connection to default event loop failed: %s\n",
                strerror(-rc));
        goto fail;
    }

    asprintf(&uribuf, "ws://localhost:%d/api?token=%s", port, token);

    /* connect the websocket wsj1 to the uri given by the first argument */
    this->wsj1 = afb_ws_client_connect_wsj1(
        this->loop, uribuf, const_cast<struct afb_wsj1_itf *>(&itf), this);
    if (this->wsj1 == nullptr) {
        sd_event_unref(this->loop);
        this->loop = nullptr;
        fprintf(stderr, "Connection to %s failed: %m\n", uribuf);
        rc = -errno;
        goto fail;
    }

    return 0;

fail:
    return rc;
}

int AFBClient::Impl::dispatch() {
    std::lock_guard<std::recursive_mutex> guard(dispatch_mutex);
    return sd_event_run(this->loop, 1);
}

json_object *drawing_name_json_argument(char const *label) {
    json_object *j = json_object_new_object();
    json_object_object_add(j, "drawing_name", json_object_new_string(label));
    return j;
}

int AFBClient::Impl::requestSurface(const char *label) {
    TRACE();

    if (this->labels.find(label) != this->labels.end()) {
        fputs("Surface label already known!\n", stderr);
        return -EINVAL;
    }

    json_object *j = drawing_name_json_argument(label);

    int rc = -1;
    /* send the request */
    int rc2 = api_call("request_surface", j, [&rc](bool ok, json_object *j) {
        if (ok) {
            int id = json_object_get_int(json_object_object_get(j, "response"));
            char *buf;
            asprintf(&buf, "%d", id);
            printf("setenv(\"QT_IVI_SURFACE_ID\", %s, 1)\n", buf);
            if (setenv("QT_IVI_SURFACE_ID", buf, 1) != 0) {
                fprintf(stderr, "putenv failed: %m\n");
                rc = -errno;
            } else {
                rc = 0;  // Single point of success
            }
        } else {
            fprintf(stderr, "Could not get surface ID from WM: %s\n",
                    j != nullptr ? json_object_to_json_string_ext(
                                       j, JSON_C_TO_STRING_PRETTY)
                                 : "no-info");
            rc = -EINVAL;
        }
    });

    if (rc2 < 0) {
        rc = rc2;
    }

    if (rc >= 0) {
        this->labels.insert(this->labels.end(), label);
    }

    return rc;
}

int AFBClient::Impl::activateSurface(const char *label) {
    TRACE();
    json_object *j = drawing_name_json_argument(label);
    return api_call("activate_surface", j, [](bool ok, json_object *j) {
        if (!ok) {
            fprintf(stderr, "API Call activate_surface() failed: %s\n",
                    j != nullptr ? json_object_to_json_string_ext(
                                       j, JSON_C_TO_STRING_PRETTY)
                                 : "no-info");
        }
    });
}

int AFBClient::Impl::deactivateSurface(const char *label) {
    TRACE();
    json_object *j = drawing_name_json_argument(label);
    return api_call("deactivate_surface", j, [](bool ok, json_object *j) {
        if (!ok) {
            fprintf(stderr, "API Call deactivate_surface() failed: %s\n",
                    j != nullptr ? json_object_to_json_string_ext(
                                       j, JSON_C_TO_STRING_PRETTY)
                                 : "no-info");
        }
    });
}

int AFBClient::Impl::endDraw(const char *label) {
    TRACE();
    json_object *j = drawing_name_json_argument(label);
    return api_call("enddraw", j, [](bool ok, json_object *j) {
        if (!ok) {
            fprintf(stderr, "API Call endDraw() failed: %s\n",
                    j != nullptr ? json_object_to_json_string_ext(
                                       j, JSON_C_TO_STRING_PRETTY)
                                 : "no-info");
        }
    });
}

void AFBClient::Impl::set_event_handler(
    enum EventType et, std::function<void(char const *)> func) {
    TRACE();

    if (et >= 1 && et <= 6) {  // Yeah ... just go with it!
        this->handlers[et] = std::move(func);
    }
}

namespace {
std::pair<bool, AFBClient::EventType> make_event_type(char const *et) {
    // Event have the form "$API/$EVENT", just try to find the first / and
    // get on with it.
    char const *et2 = strchr(et, '/');
    if (et2 != nullptr) {
        et = et2 + 1;
    }

#define ET(N, A)                                          \
    do {                                                  \
        if (strcasecmp(et, N) == 0)                       \
            return std::pair<bool, AFBClient::EventType>( \
                true, CONCAT(AFBClient::Event_, A));      \
    } while (false)

    ET("activated", Active);
    ET("deactivated", Inactive);
    ET("visible", Visible);
    ET("invisible", Invisible);
    ET("syncdraw", SyncDraw);
    ET("flushdraw", FlushDraw);
#undef ET

    return std::pair<bool, AFBClient::EventType>(false,
                                                 AFBClient::Event_Active);
}
}  // namespace

/// object will be json_object_put
int AFBClient::Impl::api_call(
    const char *verb, json_object *object,
    const std::function<void(bool, json_object *)> &onReply) {
    TRACE();

    // We need to wrap the actual onReply call once in order to
    // *look* like a normal functions pointer (std::functions<>
    // with captures cannot convert to function pointers).
    // Alternatively we could setup a local struct and use it as
    // closure, but I think it is cleaner this way.
    int call_rc = 0;
    std::atomic<bool> returned{};
    returned.store(false, std::memory_order_relaxed);
    std::function<void(bool, json_object *)> wrappedOnReply =
        [&returned, &call_rc, &onReply](bool ok, json_object *j) {
            TRACEN(wrappedOnReply);
            call_rc = ok ? 0 : -EINVAL;
            // We know it failed, but there may be an explanation in the
            // json object.
            {
                TRACEN(onReply);
                onReply(ok, j);
            }
            returned.store(true, std::memory_order_release);
        };

    // make the actual call, use wrappedOnReply as closure
    int rc = afb_wsj1_call_j(
        this->wsj1, wmAPI, verb, object,
        [](void *closure, afb_wsj1_msg *msg) {
            TRACEN(callClosure);
            auto *onReply =
                reinterpret_cast<std::function<void(bool, json_object *)> *>(
                    closure);
            (*onReply)(!(afb_wsj1_msg_is_reply_ok(msg) == 0),
                       afb_wsj1_msg_object_j(msg));
        },
        &wrappedOnReply);

    if (rc < 0) {
        fprintf(
            stderr, "calling %s/%s(%s) failed: %m\n", wmAPI, verb,
            json_object_to_json_string_ext(object, JSON_C_TO_STRING_PRETTY));
        // Call the reply handler regardless with a NULL json_object*
        onReply(false, nullptr);
    } else {
        // We need to dispatch until "returned" got set, this is necessary
        // if events get triggered by the call (and would be dispatched before
        // the actual call-reply).
        while (!returned.load(std::memory_order_consume)) {
            std::lock_guard<std::recursive_mutex> guard(dispatch_mutex);
            if (!returned.load(std::memory_order_consume)) {
                dispatch_internal(this->loop);
            }
        }

        // return the actual API call result
        rc = call_rc;
    }

    return rc;
}

void AFBClient::Impl::event(char const *et, char const *label) {
    TRACE();
    auto oet = make_event_type(et);
    if (!oet.first) {
        fprintf(stderr, "Unknown event type string '%s'\n", et);
        return;
    }

    auto i = this->handlers.find(oet.second);
    if (i != this->handlers.end()) {
        if (this->labels.find(label) != this->labels.end()) {
            i->second(label);
        }
    }
}

//       _                    _    _____ ____   ____ _ _            _
//   ___| | __ _ ___ ___     / \  |  ___| __ ) / ___| (_) ___ _ __ | |_
//  / __| |/ _` / __/ __|   / _ \ | |_  |  _ \| |   | | |/ _ \ '_ \| __|
// | (__| | (_| \__ \__ \  / ___ \|  _| | |_) | |___| | |  __/ | | | |_
//  \___|_|\__,_|___/___/ /_/   \_\_|   |____/ \____|_|_|\___|_| |_|\__|
//
int AFBClient::init(int port, char const *token) {
    return this->d->init(port, token);
}

int AFBClient::dispatch() { return this->d->dispatch(); }

int AFBClient::requestSurface(const char *label) {
    return this->d->requestSurface(label);
}

int AFBClient::activateSurface(const char *label) {
    return this->d->activateSurface(label);
}

int AFBClient::deactivateSurface(const char *label) {
    return this->d->deactivateSurface(label);
}

int AFBClient::endDraw(const char *label) { return this->d->endDraw(label); }

void AFBClient::set_event_handler(enum EventType et,
                                  std::function<void(char const *label)> f) {
    return this->d->set_event_handler(et, std::move(f));
}

AFBClient &AFBClient::instance() {
    TRACE();
    static AFBClient obj;
    return obj;
}

AFBClient::AFBClient() : d(new Impl) {}

AFBClient::~AFBClient() { delete d; }