Update HTML test page to new template. Added Config file selection from UI.
[apps/agl-service-unicens.git] / ucs2-afb / ucs_binding.c
1 /*
2  * Copyright (C) 2016 "IoT.bzh"
3  * Author Fulup Ar Foll <fulup@iot.bzh>
4  *
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
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  *
17  * references:
18  *   https://gist.github.com/ghedo/963382
19  *   http://alsa-utils.sourcearchive.com/documentation/1.0.15/aplay_8c-source.html
20  */
21
22 #define _GNU_SOURCE
23
24 #define BUFFER_FRAME_COUNT 10 /* max frames in buffer */
25 #define WAIT_TIMER_US 1000000 /* default waiting timer 1s */
26
27 #include <systemd/sd-event.h>
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <stdio.h>
31 #include <fcntl.h>
32 #include <string.h>
33 #include <unistd.h>
34 #include <time.h>
35 #include <assert.h>
36 #include <errno.h>
37 #include <dirent.h> 
38
39 #include "ucs_binding.h"
40 #include "ucs_interface.h"
41
42
43
44 #define MAX_FILENAME_LEN (100)
45 #define RX_BUFFER (64)
46
47 /** Internal structure, enabling multiple instances of this component.
48  * \note Do not access any of this variables.
49  *  */
50 typedef struct {
51     int fileHandle;
52     int fileFlags;
53     char fileName[MAX_FILENAME_LEN];
54     uint8_t rxBuffer[RX_BUFFER];
55     uint32_t rxLen;
56 } CdevData_t;
57
58
59 typedef struct {
60   CdevData_t rx;
61   CdevData_t tx;
62   UCSI_Data_t ucsiData;
63   UCSI_channelsT *channels;
64 } ucsContextT;
65
66 static ucsContextT *ucsContextS;
67
68 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
69     /*AFB_DEBUG (afbIface, format, args); */
70     va_list args;
71     va_start (args, vargsCnt);
72     vfprintf (stderr, format, args);
73     va_end(args);
74     
75     va_list argptr;
76     char outbuf[300];
77     va_start(argptr, vargsCnt);
78     vsprintf(outbuf, format, argptr);
79     va_end(argptr);
80     AFB_WARNING (outbuf);
81 }
82
83 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
84     struct timespec currentTime;
85     uint16_t timer;
86     pTag = pTag;
87
88     if (clock_gettime(CLOCK_MONOTONIC_RAW, &currentTime))   {
89         assert(false);
90         return 0;
91     }
92
93     timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
94     return(timer);
95 }
96
97 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
98     ucsContextT *ucsContext = (ucsContextT*) pTag;
99
100     sd_event_source_unref(source);
101     UCSI_Timeout(&ucsContext->ucsiData);
102
103     return 0;
104 }
105
106 /* UCS2 Interface Timer Callback */
107 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
108   uint64_t usec;
109   /* set a timer with  250ms accuracy */
110   sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
111   sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
112
113 }
114
115 /**
116  * \brief Callback when ever an Unicens forms a human readable message.
117  *        This can be error events or when enabled also debug messages.
118  * \note This function must be implemented by the integrator
119  * \param pTag - Pointer given by the integrator by UCSI_Init
120  * \param format - Zero terminated format string (following printf rules)
121  * \param vargsCnt - Amount of parameters stored in "..."
122  */
123 void UCSI_CB_OnUserMessage(void *pTag, bool isError, const char format[],
124     uint16_t vargsCnt, ...) {
125     va_list argptr;
126     char outbuf[300];
127     pTag = pTag;
128     va_start(argptr, vargsCnt);
129     vsprintf(outbuf, format, argptr);
130     va_end(argptr);
131     if (isError)
132         AFB_NOTICE (outbuf);
133 }
134
135 /** UCSI_Service cannot be called directly within UNICENS context, need to service stack through mainloop */
136 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
137     ucsContextT *ucsContext = (ucsContextT*) pTag;
138
139     sd_event_source_unref(source);
140     UCSI_Service(&ucsContext->ucsiData);
141     return (0);
142 }
143
144 /* UCS Callback fire when ever UNICENS needs to be serviced */
145 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
146
147    /* push an asynchronous request for loopback to call UCSI_Service */
148    sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
149 }
150
151 /* Callback when ever this UNICENS wants to send a message to INIC. */
152 PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
153     ucsContextT *ucsContext = (ucsContextT*) pTag;
154     CdevData_t *cdevTx = &ucsContext->tx;
155     uint32_t total = 0;
156
157     if (NULL == pData || 0 == len) return;
158
159     if (O_RDONLY == cdevTx->fileFlags) return;
160     if (-1 == cdevTx->fileHandle)
161         cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
162     if (-1 == cdevTx->fileHandle)
163         return;
164
165     while(total < len) {
166         ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
167         if (0 >= written)
168         {
169             /* Silently ignore write error (only occur in non-blocking mode) */
170             break;
171         }
172         total += (uint32_t) written;
173     }
174 }
175
176 /**
177  * \brief Callback when UNICENS instance has been stopped.
178  * \note This event can be used to free memory holding the resources
179  *       passed with UCSI_NewConfig
180  * \note This function must be implemented by the integrator
181  * \param pTag - Pointer given by the integrator by UCSI_Init
182  */
183 void UCSI_CB_OnStop(void *pTag) {
184     AFB_NOTICE ("UNICENS stopped");
185
186 }
187
188 /** This callback will be raised, when ever an applicative message on the control channel arrived */
189 void UCSI_CB_OnAmsMessageReceived(void *pTag)
190 {
191         /* If not interested, just ignore this event.
192            Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content. 
193            Don't forget to call UCSI_ReleaseAmsMessage after that */
194 }
195
196 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
197 {
198     if (NULL == d || NULL == fileName)  goto OnErrorExit;
199
200     memset(d, 0, sizeof(CdevData_t));
201     strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
202     d->fileHandle = -1;
203
204     if (read && write)
205         d->fileFlags = O_RDWR | O_NONBLOCK;
206     else if (read)
207         d->fileFlags = O_RDONLY | O_NONBLOCK;
208     else if (write)
209         d->fileFlags = O_WRONLY | O_NONBLOCK;
210
211     /* open file to enable event loop */
212     d->fileHandle = open(d->fileName, d->fileFlags);
213     if (d->fileHandle  <= 0) goto OnErrorExit;
214
215     return true;
216
217  OnErrorExit:
218     return false;
219 }
220
221 static bool InitializeCdevs(ucsContextT *ucsContext)
222 {
223     if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
224         return false;
225     if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
226         return false;
227     return true;
228 }
229
230 /* Callback fire when something is avaliable on MOST cdev */
231 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
232     ucsContextT *ucsContext =( ucsContextT*) pTag;
233     ssize_t len;
234     uint8_t pBuffer[RX_BUFFER];
235     int ok;
236
237     len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
238     if (0 == len)
239         return 0;
240     ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
241     if (!ok) {
242         AFB_DEBUG ("Buffer overrun (not handle)");
243         /* Buffer overrun could replay pBuffer */
244     }
245     return 0;
246 }
247
248 STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
249     char *xmlBuffer;
250     ssize_t readSize;
251     int fdHandle ;
252     struct stat fdStat;
253     UcsXmlVal_t* ucsConfig;
254
255     const char *filename = afb_req_value(request, "filename");
256     if (!filename) {
257         afb_req_fail_f (request, "filename-missing", "No filename given");
258         goto OnErrorExit;
259     }
260
261     fdHandle = open(filename, O_RDONLY);
262     if (fdHandle <= 0) {
263         afb_req_fail_f (request, "fileread-error", "File not accessible: '%s' err=%s", filename, strerror(fdHandle));
264         goto OnErrorExit;
265     }
266
267     /* read file into buffer as a \0 terminated string */
268     fstat(fdHandle, &fdStat);
269     xmlBuffer = (char*)alloca(fdStat.st_size + 1);
270     readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
271     close(fdHandle);
272     xmlBuffer[readSize] = '\0'; /* In any case, terminate it. */
273
274     if (readSize != fdStat.st_size)  {
275         afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, (int)readSize, (int)fdStat.st_size);
276         goto OnErrorExit;
277     }
278
279     ucsConfig = UcsXml_Parse(xmlBuffer);
280     if (!ucsConfig)  {
281         afb_req_fail_f (request, "filexml-error", "File XML invalid: '%s'", filename);
282         goto OnErrorExit;
283     }
284
285     return (ucsConfig);
286
287  OnErrorExit:
288     return NULL;
289 }
290
291 STATIC int volOnSvcCB (sd_event_source* source,uint64_t timer, void* pTag) {
292     ucsContextT *ucsContext = (ucsContextT*) pTag;
293
294     sd_event_source_unref(source);
295     UCSI_Vol_Service(&ucsContext->ucsiData);
296
297     return 0;
298 }
299
300 /* This callback is fire each time an volume event wait in the queue */
301 void volumeCB (uint16_t timeout) {
302     uint64_t usec;
303     sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
304     sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
305 }
306
307 STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsContextT *ucsContext) {
308     int numid, vol, err;
309     struct json_object *nameJ, *channelJ, *volJ;
310
311     enum json_type jtype= json_object_get_type(commandJ);
312     switch (jtype) {
313         case json_type_array:
314             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 0)), "%d", &numid)) {
315                 afb_req_fail_f (request, "channel-invalid","command=%s channel is not an integer", json_object_get_string (channelJ));
316                 goto OnErrorExit;
317             }
318             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 1)), "%d", &vol)) {
319                 afb_req_fail_f (request, "vol-invalid","command=%s vol is not an integer", json_object_get_string (channelJ));
320                 goto OnErrorExit;
321             }
322             break;
323
324         case json_type_object:
325             if (json_object_object_get_ex (commandJ, "numid", &channelJ)) {
326                 if (!sscanf (json_object_get_string (channelJ), "%d", &numid)) {
327                     afb_req_fail_f (request, "channel-invalid","command=%s numid is not an integer", json_object_get_string (channelJ));
328                     goto OnErrorExit;
329                 }
330             } else {
331                 if (json_object_object_get_ex (commandJ, "channel", &nameJ)) {
332                     int idx;
333                     const char *name = json_object_get_string(nameJ);
334
335                     for (idx =0; ucsContext->channels[idx].name != NULL; idx++) {
336                         if (!strcasecmp(ucsContext->channels[idx].name, name)) {
337                             numid = ucsContext->channels[idx].numid;
338                             break;
339                         }
340                     }
341                     if (ucsContext->channels[idx].name == NULL) {
342                         afb_req_fail_f (request, "channel-invalid","command=%s channel name does not exist", name);
343                         goto OnErrorExit;
344                     }
345                 } else {
346                     afb_req_fail_f (request, "channel-invalid","command=%s no valid channel name or channel", json_object_get_string(commandJ));
347                     goto OnErrorExit;
348                 };
349             }
350
351             if (!json_object_object_get_ex (commandJ, "volume", &volJ)) {
352                 afb_req_fail_f (request, "vol-missing","command=%s vol not present", json_object_get_string (commandJ));
353                 goto OnErrorExit;
354             }
355
356             if (!sscanf (json_object_get_string (volJ), "%d", &vol)) {
357                 afb_req_fail_f (request, "vol-invalid","command=%s vol:%s is not an integer", json_object_get_string (commandJ), json_object_get_string (volJ));
358                 goto OnErrorExit;
359             }
360
361             break;
362
363         default:
364             afb_req_fail_f (request, "setvol-invalid","command=%s not valid JSON Volume Command", json_object_get_string(commandJ));
365             goto OnErrorExit;
366     }
367
368
369     /* Fulup what's append when channel or vol are invalid ??? */
370     err = UCSI_Vol_Set  (&ucsContext->ucsiData, numid, (uint8_t) vol);
371     if (err) {
372         /* Fulup this might only be a warning (not sure about it) */
373         afb_req_fail_f (request, "vol-refused","command=%s vol was refused by UNICENS", json_object_get_string (volJ));
374         goto OnErrorExit;
375     }
376
377     return 0;
378
379   OnErrorExit:
380     return 1;
381 }
382
383 PUBLIC void ucs2_volume (struct afb_req request) {
384     struct json_object *queryJ;
385     int err;
386
387     /* check UNICENS is initialised */
388     if (!ucsContextS) {
389         afb_req_fail_f (request, "UNICENS-init","Should Load Config before using setvol");
390         goto OnErrorExit;
391     }
392
393     queryJ = afb_req_json(request);
394     if (!queryJ) {
395         afb_req_fail_f (request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
396         goto OnErrorExit;
397     };
398
399     enum json_type jtype= json_object_get_type(queryJ);
400     switch (jtype) {
401         case json_type_array:
402             for (int idx=0; idx < json_object_array_length (queryJ); idx ++) {
403                err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS);
404                if (err) goto OnErrorExit;
405             }
406             break;
407
408         case json_type_object:
409             err = volSndCmd (request, queryJ, ucsContextS);
410             if (err) goto OnErrorExit;
411             break;
412
413         default:
414             afb_req_fail_f (request, "query-notarray","query=%s not valid JSON Volume Command Array", afb_req_value(request,""));
415             goto OnErrorExit;
416     }
417
418
419     afb_req_success(request,NULL,NULL);
420
421  OnErrorExit:
422     return;
423 }
424
425
426 PUBLIC void ucs2_initialise (struct afb_req request) {
427     static UcsXmlVal_t *ucsConfig;
428     static ucsContextT ucsContext;
429
430     sd_event_source *evtSource;
431     int err;
432
433     /* Read and parse XML file */
434     ucsConfig = ParseFile (request);
435     if (NULL == ucsConfig) goto OnErrorExit;
436
437     /* When ucsContextS is set, do not initalize UNICENS, CDEVs or system hooks, just load new XML */
438     if (!ucsContextS)
439     {
440         if (!ucsContextS && !InitializeCdevs(&ucsContext))  {
441             afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
442             goto OnErrorExit;
443         }
444
445         /* Initialise UNICENS Config Data Structure */
446         UCSI_Init(&ucsContext.ucsiData, &ucsContext);
447
448         /* register aplayHandle file fd into binder mainloop */
449         err = sd_event_add_io(afb_daemon_get_event_loop(), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
450         if (err < 0) {
451             afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
452             goto OnErrorExit;
453         }
454
455         /* init UNICENS Volume Library */
456         ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
457         if (!ucsContext.channels) {
458             afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
459             goto OnErrorExit;
460         }
461         /* save this in a statical variable until ucs2vol move to C */
462         ucsContextS = &ucsContext;
463     }
464     /* Initialise UNICENS with parsed config */
465     if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig))   {
466         afb_req_fail_f (request, "UNICENS-init", "Fail to initialize UNICENS");
467         goto OnErrorExit;
468     }
469
470     afb_req_success(request,NULL,"UNICENS-active");
471
472  OnErrorExit:
473     return;
474 }
475
476
477 // List Avaliable Configuration Files
478 PUBLIC void ucs2_listconfig (struct afb_req request) {
479     struct json_object *queryJ, *tmpJ, *responseJ;
480     DIR  *dirHandle;
481     char *dirPath, *dirList;
482     int error=0;
483
484     queryJ = afb_req_json(request);
485     if (queryJ && json_object_object_get_ex (queryJ, "cfgpath" , &tmpJ)) {
486         strdup (json_object_get_string(tmpJ));
487     } else {    
488         dirList = strdup (UCS2_CFG_PATH); 
489         AFB_NOTICE ("fgpath:missing uses UCS2_CFG_PATH=%s", UCS2_CFG_PATH);
490     }
491
492     responseJ = json_object_new_array();
493     for (dirPath= strtok(dirList, ":"); dirPath && *dirPath; dirPath=strtok(NULL,":")) {
494          struct dirent *dirEnt;
495          
496         dirHandle = opendir (dirPath);
497         if (!dirHandle) {
498             AFB_NOTICE ("ucs2_listconfig dir=%s not readable", dirPath);
499             error++;
500             continue;
501         } 
502         
503         AFB_NOTICE ("ucs2_listconfig scanning: %s", dirPath);
504         while ((dirEnt = readdir(dirHandle)) != NULL) {
505             // Unknown type is accepted to support dump filesystems
506             if (dirEnt->d_type == DT_REG || dirEnt->d_type == DT_UNKNOWN) {
507                 struct json_object *pathJ = json_object_new_object();
508                 json_object_object_add(pathJ, "dirpath", json_object_new_string(dirPath));
509                 json_object_object_add(pathJ, "basename", json_object_new_string(dirEnt->d_name));
510                 json_object_array_add(responseJ, pathJ);
511             }
512         }
513     }
514     
515     free (dirList);
516    
517     if (!error)  afb_req_success(request,responseJ,NULL);
518     else {
519         char info[40];
520         snprintf (info, sizeof(info), "[%d] where not scanned", error); 
521          afb_req_success(request,responseJ, info);
522     } 
523     
524     return;
525 }
526
527 PUBLIC void ucs2_monitor (struct afb_req request) {
528     
529    afb_req_success(request,NULL,"UNICENS-to_be_done"); 
530 }
531