builder-manifest: Set some optional appstream compose flags

Screencasts are generally unwanted in catalogue to as they are more
expensive to download, store in ref and serve. Also no appstore
currently supports showing them.

Appstream by default produces partial media URLs in catalogue after
mirroring but libappstream-glib did not and generally the full URL is
required by Flathub at least.

Author: bbhtt

configure.ac

@@ -86,7 +86,7 @@ PKG_PROG_PKG_CONFIG([0.24])
 # For libglnx
 AC_CHECK_HEADER([sys/xattr.h], [], [AC_MSG_ERROR([You must have sys/xattr.h from glibc])])
 
-PKG_CHECK_MODULES(BASE, [glib-2.0 >= $GLIB_REQS gio-2.0 gio-unix-2.0 ostree-1 >= $OSTREE_REQS json-glib-1.0 libxml-2.0 >= 2.4 libcurl appstream-compose >= $APPSTREAMCLI_REQS])
+PKG_CHECK_MODULES(BASE, [glib-2.0 >= $GLIB_REQS gio-2.0 gio-unix-2.0 ostree-1 >= $OSTREE_REQS json-glib-1.0 libxml-2.0 >= 2.4 libcurl appstream >= $APPSTREAMCLI_REQS appstream-compose >= $APPSTREAMCLI_REQS])
 
 dnl ************************
 dnl *** check for libelf ***

doc/flatpak-builder.xml

@@ -587,6 +587,22 @@
                 </para></listitem>
             </varlistentry>
 
+            <varlistentry>
+                <term><option>--compose-enable-screencasts</option></term>
+
+                <listitem><para>
+                  Allow screencasts in Appstream catalogue.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--compose-enable-partial-urls</option></term>
+                <listitem><para>
+                  Use partial URLs in Appstream catalogue. Requires
+                  appstream >= 0.16.3.
+                </para></listitem>
+            </varlistentry>
+
             <varlistentry>
                 <term><option>--add-tag=TAG</option></term>
 

src/builder-context.c

@@ -86,6 +86,8 @@ struct BuilderContext
   gboolean        no_shallow_clone;
   gboolean        opt_export_only;
   char           *opt_mirror_screenshots_url;
+  gboolean        opt_compose_enable_screencasts;
+  gboolean        opt_compose_enable_partial_urls;
 
   BuilderSdkConfig *sdk_config;
 };
@@ -376,6 +378,32 @@ builder_context_get_opt_mirror_screenshots_url (BuilderContext *self)
   return self->opt_mirror_screenshots_url;
 }
 
+void
+builder_context_set_opt_compose_enable_screencasts (BuilderContext *self,
+                                                    gboolean opt_compose_enable_screencasts)
+{
+    self->opt_compose_enable_screencasts = !!opt_compose_enable_screencasts;
+}
+
+gboolean
+builder_context_get_opt_compose_enable_screencasts (BuilderContext *self)
+{
+    return self->opt_compose_enable_screencasts;
+}
+
+void
+builder_context_set_opt_compose_enable_partial_urls (BuilderContext *self,
+                                                     gboolean opt_compose_enable_partial_urls)
+{
+    self->opt_compose_enable_partial_urls = !!opt_compose_enable_partial_urls;
+}
+
+gboolean
+builder_context_get_opt_compose_enable_partial_urls (BuilderContext *self)
+{
+    return self->opt_compose_enable_partial_urls;
+}
+
 GFile *
 builder_context_find_in_sources_dirs (BuilderContext *self,
                                       ...)

src/builder-context.h

@@ -180,6 +180,16 @@ void            builder_context_set_opt_mirror_screenshots_url (BuilderContext *
 
 const char *    builder_context_get_opt_mirror_screenshots_url (BuilderContext *self);
 
+void            builder_context_set_opt_compose_enable_screencasts (BuilderContext *self,
+                                                                    gboolean opt_compose_enable_screencasts);
+
+gboolean        builder_context_get_opt_compose_enable_screencasts (BuilderContext *self);
+
+void            builder_context_set_opt_compose_enable_partial_urls (BuilderContext *self,
+                                                                     gboolean opt_compose_enable_partial_urls);
+
+gboolean        builder_context_get_opt_compose_enable_partial_urls (BuilderContext *self);
+
 BuilderSdkConfig * builder_context_get_sdk_config (BuilderContext *self);
 
 gboolean        builder_context_create_state_dir (BuilderContext *self,

src/builder-main.c

@@ -89,6 +89,8 @@ static gboolean opt_log_session_bus;
 static gboolean opt_log_system_bus;
 static gboolean opt_yes;
 static gint64 opt_source_date_epoch = -1;
+static gboolean opt_compose_enable_screencasts;
+static gboolean opt_compose_enable_partial_urls;
 
 static GOptionEntry entries[] = {
   { "verbose", 'v', 0, G_OPTION_ARG_NONE, &opt_verbose, "Print debug information during command processing", NULL },
@@ -144,6 +146,8 @@ static GOptionEntry entries[] = {
   { "assumeyes", 'y', 0, G_OPTION_ARG_NONE, &opt_yes, N_("Automatically answer yes for all questions"), NULL },
   { "no-shallow-clone", 0, 0, G_OPTION_ARG_NONE, &opt_no_shallow_clone, "Don't use shallow clones when mirroring git repos", NULL },
   { "override-source-date-epoch", 0, 0, G_OPTION_ARG_INT64, &opt_source_date_epoch, "Use this timestamp to perform the build, instead of the last modification time of the manifest.", NULL },
+  { "compose-enable-screencasts", 0, 0, G_OPTION_ARG_NONE, &opt_compose_enable_screencasts, "Allow screencasts in Appstream catalogue", NULL },
+  { "compose-enable-partial-urls", 0, 0, G_OPTION_ARG_NONE, &opt_compose_enable_partial_urls, "Allow partial URLs in Appstream catalogue", NULL },
   { NULL }
 };
 
@@ -605,6 +609,8 @@ main (int    argc,
   builder_context_set_bundle_sources (build_context, opt_bundle_sources);
   builder_context_set_opt_export_only (build_context, opt_export_only);
   builder_context_set_opt_mirror_screenshots_url (build_context, opt_mirror_screenshots_url);
+  builder_context_set_opt_compose_enable_screencasts (build_context, opt_compose_enable_screencasts);
+  builder_context_set_opt_compose_enable_partial_urls (build_context, opt_compose_enable_partial_urls);
 
   git_init_email ();
 

src/builder-manifest.c

@@ -2415,6 +2415,8 @@ builder_appstreamcli_compose (const gchar *origin,
                               const gchar *media_dir,
                               const gchar *hint_dir,
                               const gchar *media_baseurl,
+                              gboolean     enable_screencasts,
+                              gboolean     enable_partial_urls,
                               GError **error)
 {
   g_autoptr(AscCompose) compose = NULL;
@@ -2449,6 +2451,14 @@ builder_appstreamcli_compose (const gchar *origin,
 
   asc_compose_add_flags (compose, ASC_COMPOSE_FLAG_PROPAGATE_CUSTOM);
 
+#if AS_CHECK_VERSION(0, 16, 3)
+  if (!enable_partial_urls)
+    asc_compose_add_flags (compose, ASC_COMPOSE_FLAG_NO_PARTIAL_URLS);
+#endif
+
+  if (!enable_screencasts)
+    asc_compose_remove_flags (compose, ASC_COMPOSE_FLAG_ALLOW_SCREENCASTS);
+
   g_autoptr(GPtrArray) results = asc_compose_run (compose, NULL, error);
   if (results == NULL)
     {
@@ -3080,6 +3090,8 @@ builder_manifest_cleanup (BuilderManifest *self,
           const char *hint_dir = flatpak_file_get_path_cached(hint_out);
           const char *opt_mirror_screenshots_url = builder_context_get_opt_mirror_screenshots_url (context);
           gboolean opt_export_only = builder_context_get_opt_export_only (context);
+          gboolean opt_enable_screencasts = builder_context_get_opt_compose_enable_screencasts(context);
+          gboolean opt_enable_partial_urls = builder_context_get_opt_compose_enable_partial_urls(context);
 
           g_print ("Running appstreamcli compose\n");
           if (opt_mirror_screenshots_url && !opt_export_only)
@@ -3095,6 +3107,8 @@ builder_manifest_cleanup (BuilderManifest *self,
                                                  media_dir,
                                                  hint_dir,
                                                  url,
+                                                 opt_enable_screencasts,
+                                                 opt_enable_partial_urls,
                                                  error))
                 return FALSE;
             }
@@ -3108,6 +3122,8 @@ builder_manifest_cleanup (BuilderManifest *self,
                                                  NULL,
                                                  hint_dir,
                                                  NULL,
+                                                 FALSE,
+                                                 opt_enable_partial_urls,
                                                  error))
                 return FALSE;
             }

src/meson.build

@@ -57,6 +57,7 @@ flatpak_builder_deps = [
   dependency('libglnx', default_options: ['tests=false']),
   dependency('libxml-2.0', version: '>= 2.4'),
   dependency('ostree-1', version: '>= 2017.14'),
+  dependency('appstream', version: '>=0.15.0'),
   dependency('appstream-compose', version: '>=0.15.0'),
   yaml_dep,
 ]