shell: Verify agl-shell version for bound_ok/bound_fail
[src/agl-compositor.git] / src / shell.c
index cb6e592..d9d3c2d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2019 Collabora, Ltd.
+ * Copyright © 2019, 2022 Collabora, Ltd.
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -33,6 +33,7 @@
 #include <string.h>
 #include <sys/socket.h>
 #include <sys/types.h>
+#include <sys/wait.h>
 #include <unistd.h>
 #include <libweston/libweston.h>
 #include <libweston/config-parser.h>
@@ -90,6 +91,16 @@ ivi_set_desktop_surface(struct ivi_surface *surface)
        agl_shell_desktop_advertise_application_id(ivi, surface);
 }
 
+static void
+ivi_set_background_surface(struct ivi_surface *surface)
+{
+       struct ivi_compositor *ivi = surface->ivi;
+       assert(surface->role == IVI_SURFACE_ROLE_BACKGROUND);
+
+       wl_list_insert(&surface->ivi->surfaces, &surface->link);
+       agl_shell_desktop_advertise_application_id(ivi, surface);
+}
+
 static void
 ivi_set_desktop_surface_popup(struct ivi_surface *surface)
 {
@@ -791,7 +802,8 @@ ivi_shell_finalize(struct ivi_compositor *ivi)
        weston_layer_fini(&ivi->popup);
 
        wl_list_for_each(output, &ivi->outputs, link) {
-               if (output->fullscreen_view.fs->view) {
+               if (output->fullscreen_view.fs &&
+                   output->fullscreen_view.fs->view) {
                        weston_surface_destroy(output->fullscreen_view.fs->view->surface);
                        output->fullscreen_view.fs->view = NULL;
                }
@@ -928,6 +940,37 @@ struct process_info {
        char *path;
 };
 
+int
+sigchld_handler(int signal_number, void *data)
+{
+       struct weston_process *p;
+       struct ivi_compositor *ivi = data;
+       int status;
+       pid_t pid;
+
+       while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
+               wl_list_for_each(p, &ivi->child_process_list, link) {
+                       if (p->pid == pid)
+                               break;
+               }
+
+               if (&p->link == &ivi->child_process_list) {
+                       weston_log("unknown child process exited\n");
+                       continue;
+               }
+
+               wl_list_remove(&p->link);
+               wl_list_init(&p->link);
+               p->cleanup(p, status);
+       }
+
+       if (pid < 0 && errno != ECHILD)
+               weston_log("waitpid error %s\n", strerror(errno));
+
+       return 1;
+}
+
+
 static void
 process_handle_sigchld(struct weston_process *process, int status)
 {
@@ -954,17 +997,16 @@ process_handle_sigchld(struct weston_process *process, int status)
 }
 
 int
-ivi_launch_shell_client(struct ivi_compositor *ivi)
+ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section,
+                       struct wl_client **client)
 {
        struct process_info *pinfo;
        struct weston_config_section *section;
        char *command = NULL;
 
-       section = weston_config_get_section(ivi->config, "shell-client",
-                                           NULL, NULL);
+       section = weston_config_get_section(ivi->config, cmd_section, NULL, NULL);
        if (section)
-               weston_config_section_get_string(section, "command",
-                                                &command, NULL);
+               weston_config_section_get_string(section, "command", &command, NULL);
 
        if (!command)
                return -1;
@@ -977,9 +1019,8 @@ ivi_launch_shell_client(struct ivi_compositor *ivi)
        if (!pinfo->path)
                goto out_free;
 
-       ivi->shell_client.client = client_launch(ivi->compositor, &pinfo->proc,
-                                                command, process_handle_sigchld);
-       if (!ivi->shell_client.client)
+       *client = client_launch(ivi->compositor, &pinfo->proc, command, process_handle_sigchld);
+       if (!*client)
                goto out_str;
 
        return 0;
@@ -1057,9 +1098,10 @@ remove_black_curtain(struct ivi_output *output)
 {
        struct weston_view *view;
 
-       if (!output &&
+       if ((!output &&
            !output->fullscreen_view.fs &&
-           !output->fullscreen_view.fs->view) {
+           !output->fullscreen_view.fs->view) ||
+           !output->fullscreen_view.fs) {
                weston_log("Output %s doesn't have a surface installed!\n", output->name);
                return;
        }
@@ -1086,7 +1128,8 @@ insert_black_curtain(struct ivi_output *output)
 
        if ((!output &&
            !output->fullscreen_view.fs &&
-           !output->fullscreen_view.fs->view) || !output->output) {
+           !output->fullscreen_view.fs->view) || !output->output ||
+           !output->fullscreen_view.fs) {
                weston_log("Output %s doesn't have a surface installed!\n", output->name);
                return;
        }
@@ -1108,6 +1151,22 @@ insert_black_curtain(struct ivi_output *output)
        weston_log("Added black curtain to output %s\n", output->output->name);
 }
 
+void
+shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
+                    enum agl_shell_app_state state)
+{
+       if (app_id && wl_resource_get_version(ivi->shell_client.resource) >=
+           AGL_SHELL_APP_STATE_SINCE_VERSION) {
+
+               agl_shell_send_app_state(ivi->shell_client.resource,
+                                        app_id, state);
+
+               if (ivi->shell_client.resource_ext)
+                       agl_shell_send_app_state(ivi->shell_client.resource_ext,
+                                                app_id, state);
+       }
+}
+
 static void
 shell_ready(struct wl_client *client, struct wl_resource *shell_res)
 {
@@ -1115,7 +1174,8 @@ shell_ready(struct wl_client *client, struct wl_resource *shell_res)
        struct ivi_output *output;
        struct ivi_surface *surface, *tmp;
 
-       if (ivi->shell_client.resource &&
+       if (wl_resource_get_version(shell_res) >=
+           AGL_SHELL_BOUND_OK_SINCE_VERSION &&
            ivi->shell_client.status == BOUND_FAILED) {
                wl_resource_post_error(shell_res,
                                       WL_DISPLAY_ERROR_INVALID_OBJECT,
@@ -1132,8 +1192,14 @@ shell_ready(struct wl_client *client, struct wl_resource *shell_res)
        ivi->shell_client.ready = true;
 
        wl_list_for_each(output, &ivi->outputs, link) {
-               if (output->background)
+               if (output->background &&
+                   output->background->role == IVI_SURFACE_ROLE_BACKGROUND) {
+                       /* track the background surface role as a "regular"
+                        * surface so we can activate it */
+                       ivi_set_background_surface(output->background);
                        remove_black_curtain(output);
+               }
+
                ivi_layout_init(ivi, output);
        }
 
@@ -1146,11 +1212,7 @@ shell_ready(struct wl_client *client, struct wl_resource *shell_res)
                surface->checked_pending = true;
                app_id = weston_desktop_surface_get_app_id(surface->dsurface);
 
-               if (app_id &&
-                   wl_resource_get_version(ivi->shell_client.resource) >=
-                   AGL_SHELL_APP_STATE_SINCE_VERSION)
-                       agl_shell_send_app_state(ivi->shell_client.resource,
-                                                app_id, AGL_SHELL_APP_STATE_STARTED);
+               shell_send_app_state(ivi, app_id, AGL_SHELL_APP_STATE_STARTED);
        }
 }
 
@@ -1168,8 +1230,10 @@ shell_set_background(struct wl_client *client,
        struct weston_desktop_surface *dsurface;
        struct ivi_surface *surface;
 
-       if (ivi->shell_client.resource &&
-           ivi->shell_client.status == BOUND_FAILED) {
+       if ((wl_resource_get_version(shell_res) >=
+           AGL_SHELL_BOUND_OK_SINCE_VERSION &&
+           ivi->shell_client.status == BOUND_FAILED) ||
+           ivi->shell_client.resource_ext == shell_res) {
                wl_resource_post_error(shell_res,
                                       WL_DISPLAY_ERROR_INVALID_OBJECT,
                                       "agl_shell has already been bound. "
@@ -1231,8 +1295,10 @@ shell_set_panel(struct wl_client *client,
        struct ivi_surface **member;
        int32_t width = 0, height = 0;
 
-       if (ivi->shell_client.resource &&
-           ivi->shell_client.status == BOUND_FAILED) {
+       if ((wl_resource_get_version(shell_res) >=
+            AGL_SHELL_BOUND_OK_SINCE_VERSION &&
+            ivi->shell_client.status == BOUND_FAILED) ||
+           ivi->shell_client.resource_ext == shell_res) {
                wl_resource_post_error(shell_res,
                                       WL_DISPLAY_ERROR_INVALID_OBJECT,
                                       "agl_shell has already been bound. "
@@ -1348,7 +1414,8 @@ shell_activate_app(struct wl_client *client,
        struct ivi_compositor *ivi = wl_resource_get_user_data(shell_res);
        struct ivi_output *output = to_ivi_output(woutput);
 
-       if (ivi->shell_client.resource &&
+       if (wl_resource_get_version(shell_res) >=
+           AGL_SHELL_BOUND_OK_SINCE_VERSION &&
            ivi->shell_client.status == BOUND_FAILED) {
                wl_resource_post_error(shell_res,
                                       WL_DISPLAY_ERROR_INVALID_OBJECT,
@@ -1388,18 +1455,64 @@ shell_deactivate_app(struct wl_client *client,
                                  NULL, AGL_SHELL_DESKTOP_APP_STATE_DEACTIVATED);
 }
 
-/* stub, no usage for the time being */
 static void
 shell_destroy(struct wl_client *client, struct wl_resource *res)
 {
+       struct  ivi_compositor *ivi = wl_resource_get_user_data(res);
+
+       /* reset status in case bind_fail was sent */
+       if (wl_resource_get_version(res) >= AGL_SHELL_BOUND_OK_SINCE_VERSION &&
+           ivi->shell_client.status == BOUND_FAILED)
+               ivi->shell_client.status = BOUND_OK;
+}
+
+static void
+shell_set_activate_region(struct wl_client *client, struct wl_resource *res,
+                         struct wl_resource *output, int x, int y,
+                         int width, int height)
+{
+       struct ivi_compositor *ivi = wl_resource_get_user_data(res);
+       struct weston_head *head = weston_head_from_resource(output);
+       struct weston_output *woutput = weston_head_get_output(head);
+       struct ivi_output *ioutput = to_ivi_output(woutput);
+
+       struct weston_geometry area = { .x = x, .y = y,
+                                       .width = width,
+                                       .height = height };
+       if (ivi->shell_client.ready)
+               return;
+
+       ioutput->area_activation = area;
+}
+
+static void
+shell_ext_destroy(struct wl_client *client, struct wl_resource *res)
+{
+       wl_resource_destroy(res);
+}
+
+static void
+shell_ext_doas(struct wl_client *client, struct wl_resource *res)
+{
+       struct  ivi_compositor *ivi = wl_resource_get_user_data(res);
+
+       ivi->shell_client_ext.doas_requested = true;
+       agl_shell_ext_send_doas_done(ivi->shell_client_ext.resource,
+                                    AGL_SHELL_EXT_DOAS_SHELL_CLIENT_STATUS_SUCCESS);
 }
 
 static const struct agl_shell_interface agl_shell_implementation = {
-       .destroy = shell_destroy,
        .ready = shell_ready,
        .set_background = shell_set_background,
        .set_panel = shell_set_panel,
        .activate_app = shell_activate_app,
+       .destroy = shell_destroy,
+       .set_activate_region = shell_set_activate_region
+};
+
+static const struct agl_shell_ext_interface agl_shell_ext_implementation = {
+       .destroy = shell_ext_destroy,
+       .doas_shell_client = shell_ext_doas,
 };
 
 static void
@@ -1490,7 +1603,8 @@ unbind_agl_shell(struct wl_resource *resource)
        ivi = wl_resource_get_user_data(resource);
 
        /* reset status to allow other clients issue legit requests */
-       if (ivi->shell_client.resource &&
+       if (wl_resource_get_version(resource) >=
+           AGL_SHELL_BOUND_OK_SINCE_VERSION &&
            ivi->shell_client.status == BOUND_FAILED) {
                ivi->shell_client.status = BOUND_OK;
                return;
@@ -1527,6 +1641,14 @@ unbind_agl_shell(struct wl_resource *resource)
        ivi->shell_client.client = NULL;
 }
 
+static void
+unbind_agl_shell_ext(struct wl_resource *resource)
+{
+       struct ivi_compositor *ivi = wl_resource_get_user_data(resource);
+
+       ivi->shell_client_ext.resource = NULL;
+}
+
 static void
 bind_agl_shell(struct wl_client *client,
               void *data, uint32_t version, uint32_t id)
@@ -1558,17 +1680,72 @@ bind_agl_shell(struct wl_client *client,
                        return;
                }
 
-               agl_shell_send_bound_fail(resource);
-               ivi->shell_client.status = BOUND_FAILED;
+               if (ivi->shell_client_ext.resource && 
+                   ivi->shell_client_ext.doas_requested) {
+
+                       /* reset status in case client-ext doesn't send an
+                        * explicit agl_shell_destroy request, see
+                        * shell_destroy() */
+                       if (ivi->shell_client.status == BOUND_FAILED)
+                               ivi->shell_client.status = BOUND_OK;
+
+                       wl_resource_set_implementation(resource, &agl_shell_implementation,
+                                                      ivi, NULL);
+                       ivi->shell_client.resource_ext = resource;
+
+                       ivi->shell_client_ext.status = BOUND_OK;
+                       agl_shell_send_bound_ok(ivi->shell_client.resource_ext);
+
+                       return;
+               } else {
+                       wl_resource_set_implementation(resource, &agl_shell_implementation,
+                                                      ivi, NULL);
+                       agl_shell_send_bound_fail(resource);
+                       ivi->shell_client.status = BOUND_FAILED;
+                       return;
+               }
        }
 
-       wl_resource_set_implementation(resource, &agl_shell_implementation,
-                                      ivi, unbind_agl_shell);
-       ivi->shell_client.resource = resource;
 
-       if (ivi->shell_client.status == BOUND_OK &&
-           wl_resource_get_version(resource) >= AGL_SHELL_BOUND_OK_SINCE_VERSION)
+       if (wl_resource_get_version(resource) >=
+           AGL_SHELL_BOUND_OK_SINCE_VERSION) {
+               wl_resource_set_implementation(resource, &agl_shell_implementation,
+                                              ivi, unbind_agl_shell);
+               ivi->shell_client.resource = resource;
+               /* if we land here we'll have BOUND_OK by default,
+                  but still do the assignment */
+               ivi->shell_client.status = BOUND_OK;
                agl_shell_send_bound_ok(ivi->shell_client.resource);
+       } else {
+               /* fallback for just version 1 of the protocol */
+               wl_resource_set_implementation(resource, &agl_shell_implementation,
+                                              ivi, unbind_agl_shell);
+               ivi->shell_client.resource = resource;
+       }
+}
+
+static void
+bind_agl_shell_ext(struct wl_client *client,
+                  void *data, uint32_t version, uint32_t id)
+{
+       struct ivi_compositor *ivi = data;
+       struct wl_resource *resource;
+
+       resource = wl_resource_create(client, &agl_shell_ext_interface, version, id);
+       if (!resource) {
+               wl_client_post_no_memory(client);
+               return;
+       }
+
+       if (ivi->shell_client_ext.resource) {
+               wl_resource_post_error(resource, WL_DISPLAY_ERROR_INVALID_OBJECT,
+                                      "agl_shell_ext has already been bound");
+               return;
+       }
+
+       wl_resource_set_implementation(resource, &agl_shell_ext_implementation,
+                                      ivi, unbind_agl_shell_ext);
+       ivi->shell_client_ext.resource = resource;
 }
 
 static void
@@ -1627,13 +1804,21 @@ int
 ivi_shell_create_global(struct ivi_compositor *ivi)
 {
        ivi->agl_shell = wl_global_create(ivi->compositor->wl_display,
-                                         &agl_shell_interface, 3,
+                                         &agl_shell_interface, 4,
                                          ivi, bind_agl_shell);
        if (!ivi->agl_shell) {
                weston_log("Failed to create wayland global.\n");
                return -1;
        }
 
+       ivi->agl_shell_ext = wl_global_create(ivi->compositor->wl_display,
+                                             &agl_shell_ext_interface, 1,
+                                             ivi, bind_agl_shell_ext);
+       if (!ivi->agl_shell_ext) {
+               weston_log("Failed to create agl_shell_ext global.\n");
+               return -1;
+       }
+
        ivi->agl_shell_desktop = wl_global_create(ivi->compositor->wl_display,
                                                  &agl_shell_desktop_interface, 2,
                                                  ivi, bind_agl_shell_desktop);