afm-launch: implement remote launching
[src/app-framework-main.git] / src / afm-launch.c
index 12a481e..46bc4e0 100644 (file)
 extern char **environ;
 
 #include "verbose.h"
+#include "afm-launch-mode.h"
 #include "afm-launch.h"
 #include "secmgr-wrap.h"
 
+#define DEFAULT_TYPE "text/html"
+
+struct type_list {
+       struct type_list *next;
+       char type[1];
+};
+
+struct desc_list {
+       struct desc_list *next;
+       enum afm_launch_mode mode;
+       struct type_list *types;
+       char **execs[2];
+};
+
+struct launchparam {
+       int port;
+       char **uri;
+       const char *secret;
+       const char *datadir;
+       const char **master;
+       const char **slave;
+};
+
+struct confread {
+       const char *filepath;
+       FILE *file;
+       int lineno;
+       int index;
+       int length;
+       char buffer[4096];
+};
+
+struct desc_list *launchers = NULL;
+
+static gid_t groupid = 0;
+
+const char separators[] = " \t\n";
+
+static void dump_launchers()
+{
+       int j, k;
+       struct desc_list *desc;
+       struct type_list *type;
+
+       for (desc = launchers ; desc != NULL ; desc = desc->next) {
+               printf("mode %s\n", name_of_launch_mode(desc->mode));
+               for (type = desc->types ; type != NULL ; type = type->next)
+                       printf("%s\n", type->type);
+               for ( j = 0 ; j < 2 ; j++)
+                       if (desc->execs[j] != NULL) {
+                               for (k = 0 ; desc->execs[j][k] != NULL ; k++)
+                                       printf("  %s", desc->execs[j][k]);
+                               printf("\n");
+                       }
+               printf("\n");
+       }
+}
+
+static int next_token(struct confread *cread)
+{
+       int idx = cread->index + cread->length;
+       cread->index = idx + strspn(&cread->buffer[idx], separators);
+       cread->length = strcspn(&cread->buffer[cread->index], separators);
+       return cread->length;
+}
+
+static int read_line(struct confread *cread)
+{
+       while (fgets(cread->buffer, sizeof cread->buffer, cread->file) != NULL) {
+               cread->lineno++;
+               cread->index = strspn(cread->buffer, separators);
+               if (cread->buffer[cread->index] && cread->buffer[cread->index] != '#') {
+                       cread->length = strcspn(&cread->buffer[cread->index], separators);
+                       assert(cread->length > 0);
+                       return cread->length;
+               }
+       }
+       if (ferror(cread->file)) {
+               ERROR("%s:%d: error while reading, %m", cread->filepath, cread->lineno);
+               return -1;
+       }
+       return 0;
+}
+
+static char **read_vector(struct confread *cread)
+{
+       int index0, length0;
+       char **vector, *args;
+       int count, length;
+
+       /* record origin */
+       index0 = cread->index;
+       length0 = cread->length;
+
+       /* count */
+       count = 0;
+       length = 0;
+       while(cread->length) {
+               count++;
+               length += cread->length;
+               next_token(cread);
+       }
+
+       /* allocates */
+       cread->index = index0;
+       cread->length = length0;
+       vector = malloc(length + count + (count + 1) * sizeof(char*));
+       if (vector == NULL)
+               return NULL;
+
+       /* copies */
+       args = (char*)(vector + count + 1);
+       count = 0;
+       while(cread->length) {
+               vector[count++] = args;
+               memcpy(args, &cread->buffer[cread->index], cread->length);
+               args += cread->length;
+               *args++ = 0;
+               next_token(cread);
+       }
+       vector[count] = NULL;
+       cread->index = index0;
+       cread->length = length0;
+       return vector;
+}
+
+static struct type_list *read_type(struct confread *cread)
+{
+       int index, length;
+       struct type_list *result;
+
+       /* record index and length */
+       index = cread->index;
+       length = cread->length;
+
+       /* check no extra characters */
+       if (next_token(cread)) {
+               ERROR("%s:%d: extra characters found after type %.*s",
+                       cread->filepath, cread->lineno, length, &cread->buffer[index]);
+               errno = EINVAL;
+               return NULL;
+       }
+
+       /* allocate structure */
+       result = malloc(sizeof(struct type_list) + length);
+       if (result == NULL) {
+               ERROR("%s:%d: out of memory", cread->filepath, cread->lineno);
+               errno = ENOMEM;
+               return NULL;
+       }
+
+       /* fill the structure */
+       memcpy(result->type, &cread->buffer[index], length);
+       result->type[length] = 0;
+       return result;
+}
+
+static enum afm_launch_mode read_mode(struct confread *cread)
+{
+       int index, length;
+       enum afm_launch_mode result;
+
+       assert(cread->index == 0);
+       assert(!strncmp(&cread->buffer[cread->index], "mode", 4));
+
+       /* get the next token: the mode string */
+       if (!next_token(cread)) {
+               ERROR("%s:%d: no mode value set", cread->filepath, cread->lineno);
+               errno = EINVAL;
+               return invalid_launch_mode;
+       }
+
+       /* record index and length */
+       index = cread->index;
+       length = cread->length;
+
+       /* check no extra characters */
+       if (next_token(cread)) {
+               ERROR("%s:%d: extra characters found after mode %.*s",
+                       cread->filepath, cread->lineno, length, &cread->buffer[index]);
+               errno = EINVAL;
+               return invalid_launch_mode;
+       }
+
+       /* get the mode */
+       cread->buffer[index + length] = 0;
+       result = launch_mode_of_string(&cread->buffer[index]);
+       if (result == invalid_launch_mode) {
+               ERROR("%s:%d: invalid mode value %s",
+                       cread->filepath, cread->lineno, &cread->buffer[index]);
+               errno = EINVAL;
+       }
+       return result;
+}
+
+static void free_type_list(struct type_list *types)
+{
+       while (types != NULL) {
+               struct type_list *next = types->next;
+               free(types);
+               types = next;
+       }
+}
+
+static int read_launchers(struct confread *cread)
+{
+       int rc;
+       struct type_list *types, *lt;
+       struct desc_list *desc;
+       enum afm_launch_mode mode;
+       char **vector;
+
+       /* reads the file */
+       lt = NULL;
+       types = NULL;
+       desc = NULL;
+       mode = invalid_launch_mode;
+       rc = read_line(cread);
+       while (rc > 0) {
+               if (cread->index == 0) {
+                       if (cread->length == 4
+                       && !memcmp(&cread->buffer[cread->index], "mode", 4)) {
+                               /* check if allowed */
+                               if (types != NULL) {
+                                       ERROR("%s:%d: mode found before launch vector",
+                                               cread->filepath, cread->lineno);
+                                       errno = EINVAL;
+                                       free_type_list(types);
+                                       return -1;
+                               }
+
+                               /* read the mode */
+                               mode = read_mode(cread);
+                               if (mode == invalid_launch_mode)
+                                       return -1;
+                       } else {
+                               if (mode == invalid_launch_mode) {
+                                       ERROR("%s:%d: mode not found before type",
+                                                       cread->filepath, cread->lineno);
+                                       errno = EINVAL;
+                                       assert(types == NULL);
+                                       return -1;
+                               }
+                               /* read a type */
+                               lt = read_type(cread);
+                               if (lt == NULL) {
+                                       free_type_list(types);
+                                       return -1;
+                               }
+                               lt->next = types;
+                               types = lt;
+                       }
+                       desc = NULL;
+               } else if (types == NULL && desc == NULL) {
+                       if (lt == NULL)
+                               ERROR("%s:%d: untyped launch vector found",
+                                       cread->filepath, cread->lineno);
+                       else
+                               ERROR("%s:%d: extra launch vector found (2 max)",
+                                       cread->filepath, cread->lineno);
+                       errno = EINVAL;
+                       return -1;
+               } else {
+                       vector = read_vector(cread);
+                       if (vector == NULL) {
+                               ERROR("%s:%d: out of memory",
+                                       cread->filepath, cread->lineno);
+                               free_type_list(types);
+                               errno = ENOMEM;
+                               return -1;
+                       }
+                       if (types) {
+                               assert(desc == NULL);
+                               desc = malloc(sizeof * desc);
+                               if (desc == NULL) {
+                                       ERROR("%s:%d: out of memory",
+                                               cread->filepath, cread->lineno);
+                                       free_type_list(types);
+                                       errno = ENOMEM;
+                                       return -1;
+                               }
+                               desc->next = launchers;
+                               desc->mode = mode;
+                               desc->types = types;
+                               desc->execs[0] = vector;
+                               desc->execs[1] = NULL;
+                               types = NULL;
+                               launchers = desc;
+                       } else {
+                               desc->execs[1] = vector;
+                               desc = NULL;
+                       }
+               }
+               rc = read_line(cread);
+       }
+       if (types != NULL) {
+               ERROR("%s:%d: end of file found before launch vector",
+                       cread->filepath, cread->lineno);
+               free_type_list(types);
+               errno = EINVAL;
+               return -1;
+       }
+       return rc;
+}
+
+static int read_configuration_file(const char *filepath)
+{
+       int rc;
+       struct confread cread;
+
+       /* opens the configuration file */
+       cread.file = fopen(filepath, "r");
+       if (cread.file == NULL) {
+               /* error */
+               ERROR("can't read file %s: %m", filepath);
+               rc = -1;
+       } else {
+               /* reads it */
+               cread.filepath = filepath;
+               cread.lineno = 0;
+               rc = read_launchers(&cread);
+               fclose(cread.file);
+       }
+       return rc;
+}
+
 /*
 %I icondir                     FWK_ICON_DIR
 %P port                                params->port
@@ -50,81 +377,45 @@ extern char **environ;
 %p plugins                     desc->plugins
 %W width                       desc->width
 %H height                      desc->height
+%% %
 */
 
-static const char *launch_master_args[] = {
-       "/usr/bin/echo",
-       "--alias=/icons:%I",
-       "--port=%P",
-       "--rootdir=%D",
-       "--token=%S",
-       NULL
-};
-
-static const char *launch_html_args[] = {
-       "/usr/bin/chromium",
-       "--single-process",
-       "--user-data-dir=%D",
-       "--data-path=%r",
-       "file://%r/%c",
-/*
-       "http://localhost:%P",
-*/
-       NULL
-};
-
-static const char *launch_bin_args[] = {
-       "/usr/bin/echo",
-       "BINARY",
-       NULL
-};
-
-static const char *launch_qml_args[] = {
-       "/usr/bin/echo",
-       "QML",
-       NULL
-};
-
-static struct {
-       const char *type;
-       const char **launch_args;
-}
-known_launchers[] = {
-       { "text/html",                launch_html_args },
-       { "application/x-executable", launch_bin_args },
-       { "application/octet-stream", launch_bin_args },
-       { "text/vnd.qt.qml",          launch_qml_args }
-};
-
-struct launchparam {
-       int port;
-       const char *secret;
-       const char *datadir;
+union arguments {
+       char *scalar;
+       char **vector;
 };
 
-static char **instantiate_arguments(const char **args, struct afm_launch_desc *desc, struct launchparam *params)
+static union arguments instantiate_arguments(
+       const char            **args,
+       struct afm_launch_desc *desc,
+       struct launchparam     *params,
+       int                     wants_vector
+)
 {
        const char **iter, *p, *v;
-       char *data, **result, port[20], width[20], height[20], mini[3], c;
-       int n, s, x;
+       char *data, port[20], width[20], height[20], mini[3], c, sep;
+       int n, s;
+       union arguments result;
 
        /* init */
+       sep = wants_vector ? 0 : ' ';
        mini[0] = '%';
        mini[2] = 0;
 
        /* loop that either compute the size and build the result */
-       n = s = x = 0;
+       data = NULL;
+       n = s = 0;
        for (;;) {
                iter = args;
                n = 0;
                while (*iter) {
                        p = *iter++;
-                       if (x)
-                               result[n] = data;
+                       if (data && !sep)
+                               result.vector[n] = data;
                        n++;
                        while((c = *p++) != 0) {
                                if (c != '%') {
-                                       if (x)
+                                       if (data)
                                                *data++ = c;
                                        else
                                                s++;
@@ -132,7 +423,6 @@ static char **instantiate_arguments(const char **args, struct afm_launch_desc *d
                                        c = *p++;
                                        switch (c) {
                                        case 'I': v = FWK_ICON_DIR; break;
-                                       case 'P': if(!x) sprintf(port, "%d", params->port); v = port; break;
                                        case 'S': v = params->secret; break;
                                        case 'D': v = params->datadir; break;
                                        case 'r': v = desc->path; break;
@@ -143,34 +433,66 @@ static char **instantiate_arguments(const char **args, struct afm_launch_desc *d
                                        case 'm': v = desc->type; break;
                                        case 'n': v = desc->name; break;
                                        case 'p': v = "" /*desc->plugins*/; break;
-                                       case 'W': if(!x) sprintf(width, "%d", desc->width); v = width; break;
-                                       case 'H': if(!x) sprintf(height, "%d", desc->height); v = height; break;
-                                       case '%': c = 0;
-                                       default: mini[1] = c; v = mini; break;
+                                       case 'P':
+                                               if(!data)
+                                                       sprintf(port, "%d", params->port);
+                                               v = port;
+                                               break;
+                                       case 'W':
+                                               if(!data)
+                                                       sprintf(width, "%d", desc->width);
+                                               v = width;
+                                               break;
+                                       case 'H':
+                                               if(!data)
+                                                       sprintf(height, "%d", desc->height);
+                                               v = height;
+                                               break;
+                                       case '%':
+                                               c = 0;
+                                       default:
+                                               mini[1] = c;
+                                               v = mini;
+                                               break;
                                        }
-                                       if (x)
+                                       if (data)
                                                data = stpcpy(data, v);
                                        else
                                                s += strlen(v);
                                }
                        }
-                       if (x)
-                               *data++ = 0;
+                       if (data)
+                               *data++ = sep;
                        else
                                s++;
                }
-               if (x) {
-                       result[n] = NULL;
-                       return result;
-               }
-               /* allocation */
-               result = malloc((n+1)*sizeof(char*) + s);
-               if (result == NULL) {
-                       errno = ENOMEM;
-                       return NULL;
+               if (sep) {
+                       assert(!wants_vector);
+                       if (data) {
+                               *--data = 0;
+                               return result;
+                       }
+                       /* allocation */
+                       result.scalar = malloc(s);
+                       if (result.scalar == NULL) {
+                               errno = ENOMEM;
+                               return result;
+                       }
+                       data = result.scalar;
+               } else {
+                       assert(wants_vector);
+                       if (data) {
+                               result.vector[n] = NULL;
+                               return result;
+                       }
+                       /* allocation */
+                       result.vector = malloc((n+1)*sizeof(char*) + s);
+                       if (result.vector == NULL) {
+                               errno = ENOMEM;
+                               return result;
+                       }
+                       data = (char*)(&result.vector[n + 1]);
                }
-               data = (char*)(&result[n + 1]);
-               x = 1;
        }
 }
 
@@ -189,46 +511,79 @@ static int mkport()
        return port;
 }
 
-int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
+static int launch_local_1(
+       struct afm_launch_desc *desc,
+       pid_t                   children[2],
+       struct launchparam     *params
+)
 {
-       char datadir[PATH_MAX];
-       int ikl, nkl, rc;
-       char secret[9];
-       int port;
-       char message[10];
-       int mpipe[2];
-       int spipe[2];
-       struct launchparam params;
+       int rc;
        char **args;
 
-       /* what launcher ? */
-       ikl = 0;
-       if (desc->type != NULL && *desc->type) {
-               nkl = sizeof known_launchers / sizeof * known_launchers;
-               while (ikl < nkl && strcmp(desc->type, known_launchers[ikl].type))
-                       ikl++;
-               if (ikl == nkl) {
-                       ERROR("type %s not found!", desc->type);
-                       errno = ENOENT;
-                       return -1;
-               }
+       /* fork the master child */
+       children[0] = fork();
+       if (children[0] < 0) {
+               ERROR("master fork failed: %m");
+               return -1;
+       }
+       if (children[0]) {
+               /********* in the parent process ************/
+               return 0;
        }
 
-       /* prepare paths */
-       rc = snprintf(datadir, sizeof datadir, "%s/%s", desc->home, desc->tag);
-       if (rc < 0 || rc >= sizeof datadir) {
-               ERROR("overflow for datadir");
-               errno = EINVAL;
-               return -1;
+       /********* in the master child ************/
+
+       /* avoid set-gid effect */
+       setresgid(groupid, groupid, groupid);
+
+       /* enter the process group */
+       rc = setpgid(0, 0);
+       if (rc) {
+               ERROR("setpgid failed");
+               _exit(1);
        }
 
-       /* make the secret and port */
-       mksecret(secret);
-       port = mkport();
+       /* enter security mode */
+       rc = secmgr_prepare_exec(desc->tag);
+       if (rc < 0) {
+               ERROR("call to secmgr_prepare_exec failed: %m");
+               _exit(1);
+       }
 
-       params.port = port;
-       params.secret = secret;
-       params.datadir = datadir;
+       /* enter the datadirectory */
+       rc = mkdir(params->datadir, 0755);
+       if (rc && errno != EEXIST) {
+               ERROR("creation of datadir %s failed: %m", params->datadir);
+               _exit(1);
+       }
+       rc = chdir(params->datadir);
+       if (rc) {
+               ERROR("can't enter the datadir %s: %m", params->datadir);
+               _exit(1);
+       }
+
+       args = instantiate_arguments(params->master, desc, params, 1).vector;
+       if (args == NULL) {
+               ERROR("out of memory in master");
+       }
+       else {
+               rc = execve(args[0], args, environ);
+               ERROR("failed to exec master %s: %m", args[0]);
+       }
+       _exit(1);
+}
+
+static int launch_local_2(
+       struct afm_launch_desc *desc,
+       pid_t                   children[2],
+       struct launchparam     *params
+)
+{
+       int rc;
+       char message[10];
+       int mpipe[2];
+       int spipe[2];
+       char **args;
 
        /* prepare the pipes */
        rc = pipe2(mpipe, O_CLOEXEC);
@@ -260,13 +615,12 @@ int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
                close(spipe[0]);
                /* wait the ready signal (that transmit the slave pid) */
                rc = read(mpipe[0], &children[1], sizeof children[1]);
-               if (rc  < 0) {
+               close(mpipe[0]);
+               if (rc  <= 0) {
                        ERROR("reading master pipe failed: %m");
-                       close(mpipe[0]);
                        close(spipe[1]);
                        return -1;
                }
-               close(mpipe[0]);
                assert(rc == sizeof children[1]);
                /* start the child */
                rc = write(spipe[1], "start", 5);
@@ -284,6 +638,9 @@ int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
        close(mpipe[0]);
        close(spipe[1]);
 
+       /* avoid set-gid effect */
+       setresgid(groupid, groupid, groupid);
+
        /* enter the process group */
        rc = setpgid(0, 0);
        if (rc) {
@@ -299,14 +656,14 @@ int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
        }
 
        /* enter the datadirectory */
-       rc = mkdir(datadir, 0755);
+       rc = mkdir(params->datadir, 0755);
        if (rc && errno != EEXIST) {
-               ERROR("creation of datadir %s failed: %m", datadir);
+               ERROR("creation of datadir %s failed: %m", params->datadir);
                _exit(1);
        }
-       rc = chdir(datadir);
+       rc = chdir(params->datadir);
        if (rc) {
-               ERROR("can't enter the datadir %s: %m", datadir);
+               ERROR("can't enter the datadir %s: %m", params->datadir);
                _exit(1);
        }
 
@@ -320,12 +677,12 @@ int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
                /********* in the slave child ************/
                close(mpipe[0]);
                rc = read(spipe[0], message, sizeof message);
-               if (rc < 0) {
+               if (rc <= 0) {
                        ERROR("reading slave pipe failed: %m");
                        _exit(1);
                }
 
-               args = instantiate_arguments(known_launchers[ikl].launch_args, desc, &params);
+               args = instantiate_arguments(params->slave, desc, params, 1).vector;
                if (args == NULL) {
                        ERROR("out of memory in slave");
                }
@@ -338,13 +695,13 @@ int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
 
        /********* still in the master child ************/
        close(spipe[1]);
-       args = instantiate_arguments(launch_master_args, desc, &params);
+       args = instantiate_arguments(params->master, desc, params, 1).vector;
        if (args == NULL) {
                ERROR("out of memory in master");
        }
        else {
                rc = write(mpipe[1], &children[1], sizeof children[1]);
-               if (rc < 0) {
+               if (rc <= 0) {
                        ERROR("can't write master pipe: %m");
                }
                else {
@@ -356,3 +713,128 @@ int afm_launch(struct afm_launch_desc *desc, pid_t children[2])
        _exit(1);
 }
 
+static int launch_local(
+       struct afm_launch_desc *desc,
+       pid_t                   children[2],
+       struct launchparam     *params
+)
+{
+       if (params->slave == NULL)
+               return launch_local_1(desc, children, params);
+       return launch_local_2(desc, children, params);
+}
+
+static int launch_remote(
+       struct afm_launch_desc *desc,
+       pid_t                   children[2],
+       struct launchparam     *params
+)
+{
+       int rc;
+       char *uri;
+
+       /* instanciate the uri */
+       if (params->slave == NULL)
+               uri = strdup("");
+       else
+               uri = instantiate_arguments(params->slave, desc, params, 0).scalar;
+       if (uri == NULL) {
+               ERROR("out of memory for remote uri");
+               errno = ENOMEM;
+               return -1;
+       }
+
+       /* launch the command */
+       rc = launch_local_1(desc, children, params);
+       if (rc)
+               free(uri);
+       else
+               *params->uri = uri;
+       return rc;
+}
+
+int afm_launch_initialize()
+{
+       int rc;
+       gid_t r, e, s;
+
+       getresgid(&r, &e, &s);
+       if (s && s != e)
+               groupid = s;
+       else
+               groupid = -1;
+
+       rc = read_configuration_file(FWK_LAUNCH_CONF);
+       dump_launchers();
+       return rc;
+}
+
+static struct desc_list *search_launcher(const char *type, enum afm_launch_mode mode)
+{
+       struct desc_list *dl;
+       struct type_list *tl;
+
+       for (dl = launchers ; dl ; dl = dl->next)
+               if (dl->mode == mode)
+                       for (tl = dl->types ; tl != NULL ; tl = tl->next)
+                               if (!strcmp(tl->type, type))
+                                       return dl;
+       return NULL;
+}
+
+int afm_launch(struct afm_launch_desc *desc, pid_t children[2], char **uri)
+{
+       int rc;
+       char datadir[PATH_MAX];
+       char secret[9];
+       struct launchparam params;
+       const char *type;
+       struct desc_list *dl;
+
+       /* should be init */
+       assert(groupid != 0);
+       assert(launch_mode_is_valid(desc->mode));
+       assert(desc->mode == mode_local || uri != NULL);
+       assert(uri == NULL || *uri == NULL);
+
+       /* init */
+       children[0] = 0;
+       children[1] = 0;
+
+       /* what launcher ? */
+       type = desc->type != NULL && *desc->type ? desc->type : DEFAULT_TYPE;
+       dl = search_launcher(type, desc->mode);
+       if (dl == NULL) {
+               ERROR("type %s not found for mode %s!", type, name_of_launch_mode(desc->mode));
+               errno = ENOENT;
+               return -1;
+       }
+
+       /* prepare paths */
+       rc = snprintf(datadir, sizeof datadir, "%s/%s", desc->home, desc->tag);
+       if (rc < 0 || rc >= sizeof datadir) {
+               ERROR("overflow for datadir");
+               errno = EINVAL;
+               return -1;
+       }
+
+       /* make the secret and port */
+       mksecret(secret);
+       params.uri = uri;
+       params.port = mkport();
+       params.secret = secret;
+       params.datadir = datadir;
+       params.master = (const char **)dl->execs[0];
+       params.slave = (const char **)dl->execs[1];
+
+       switch (desc->mode) {
+       case mode_local:
+               return launch_local(desc, children, &params);
+       case mode_remote:
+               return launch_remote(desc, children, &params);
+       default:
+               assert(0);
+               return -1;
+       }
+}
+