From 581879051042b8ca5e8e53a48ada58c508c524ca Mon Sep 17 00:00:00 2001 From: Alexander Larsson Date: Thu, 28 Sep 2017 14:42:39 +0200 Subject: [PATCH] Add extra-data source type All this does is construct a finish arg, but it makes it a lot nicer to create extra-data using manifest. Additionally, it allows you to create per-arch extra data if you set only-arches on the source. Closes: #40 Approved by: alexlarsson --- doc/flatpak-manifest.xml | 29 ++++ src/Makefile.am.inc | 2 + src/builder-manifest.c | 6 + src/builder-module.c | 18 ++ src/builder-module.h | 3 + src/builder-source-extra-data.c | 285 ++++++++++++++++++++++++++++++++ src/builder-source-extra-data.h | 40 +++++ src/builder-source.c | 16 ++ src/builder-source.h | 6 + 9 files changed, 405 insertions(+) create mode 100644 src/builder-source-extra-data.c create mode 100644 src/builder-source-extra-data.h diff --git a/doc/flatpak-manifest.xml b/doc/flatpak-manifest.xml index 052a18a8..58e9bd73 100644 --- a/doc/flatpak-manifest.xml +++ b/doc/flatpak-manifest.xml @@ -649,6 +649,35 @@ + + Extra data sources + + + + "extra-data" + + + (string) + The name to use for the downloaded extra data + + + (string) + The url to the extra data. + + + (string) + The sha256 of the extra data. + + + (string) + The size of the extra data. + + + (string) + The extra installed size this adds to the app (optional). + + + diff --git a/src/Makefile.am.inc b/src/Makefile.am.inc index 94f74832..7b11606d 100644 --- a/src/Makefile.am.inc +++ b/src/Makefile.am.inc @@ -28,6 +28,8 @@ flatpak_builder_SOURCES = \ src/builder-source-script.h \ src/builder-source-shell.c \ src/builder-source-shell.h \ + src/builder-source-extra-data.c \ + src/builder-source-extra-data.h \ src/builder-source-patch.c \ src/builder-source-patch.h \ src/builder-context.c \ diff --git a/src/builder-manifest.c b/src/builder-manifest.c index 1659b7bf..b5497e3d 100644 --- a/src/builder-manifest.c +++ b/src/builder-manifest.c @@ -2577,6 +2577,12 @@ builder_manifest_finish (BuilderManifest *self, for (l = self->add_extensions; l != NULL; l = l->next) builder_extension_add_finish_args (l->data, args); + for (l = self->expanded_modules; l != NULL; l = l->next) + { + BuilderModule *m = l->data; + builder_module_finish_sources (m, args, context); + } + g_ptr_array_add (args, g_file_get_path (app_dir)); g_ptr_array_add (args, NULL); diff --git a/src/builder-module.c b/src/builder-module.c index 7e0559fa..f470f1e0 100644 --- a/src/builder-module.c +++ b/src/builder-module.c @@ -937,6 +937,24 @@ builder_module_extract_sources (BuilderModule *self, return TRUE; } +void +builder_module_finish_sources (BuilderModule *self, + GPtrArray *args, + BuilderContext *context) +{ + GList *l; + + for (l = self->sources; l != NULL; l = l->next) + { + BuilderSource *source = l->data; + + if (!builder_source_is_enabled (source, context)) + continue; + + builder_source_finish (source, args, context); + } +} + gboolean builder_module_bundle_sources (BuilderModule *self, BuilderContext *context, diff --git a/src/builder-module.h b/src/builder-module.h index 22933e8a..9d169561 100644 --- a/src/builder-module.h +++ b/src/builder-module.h @@ -68,6 +68,9 @@ gboolean builder_module_extract_sources (BuilderModule *self, gboolean builder_module_bundle_sources (BuilderModule *self, BuilderContext *context, GError **error); +void builder_module_finish_sources (BuilderModule *self, + GPtrArray *args, + BuilderContext *context); gboolean builder_module_ensure_writable (BuilderModule *self, BuilderCache *cache, BuilderContext *context, diff --git a/src/builder-source-extra-data.c b/src/builder-source-extra-data.c new file mode 100644 index 00000000..707c69e4 --- /dev/null +++ b/src/builder-source-extra-data.c @@ -0,0 +1,285 @@ +/* builder-source-extra_data.c + * + * Copyright (C) 2015 Red Hat, Inc + * + * This file is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * This file is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + * + * Authors: + * Alexander Larsson + */ + +#include "config.h" + +#include +#include +#include +#include +#include + +#include "builder-flatpak-utils.h" +#include "builder-utils.h" +#include "builder-source-extra-data.h" + +struct BuilderSourceExtraData +{ + BuilderSource parent; + + char *filename; + char *url; + char *sha256; + guint64 size; + guint64 installed_size; +}; + +typedef struct +{ + BuilderSourceClass parent_class; +} BuilderSourceExtraDataClass; + +G_DEFINE_TYPE (BuilderSourceExtraData, builder_source_extra_data, BUILDER_TYPE_SOURCE); + +enum { + PROP_0, + PROP_FILENAME, + PROP_URL, + PROP_SHA256, + PROP_SIZE, + PROP_INSTALLED_SIZE, + LAST_PROP +}; + +static void +builder_source_extra_data_finalize (GObject *object) +{ + BuilderSourceExtraData *self = (BuilderSourceExtraData *) object; + + g_free (self->filename); + g_free (self->url); + g_free (self->sha256); + + G_OBJECT_CLASS (builder_source_extra_data_parent_class)->finalize (object); +} + +static void +builder_source_extra_data_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + BuilderSourceExtraData *self = BUILDER_SOURCE_EXTRA_DATA (object); + + switch (prop_id) + { + case PROP_FILENAME: + g_value_set_string (value, self->filename); + break; + + case PROP_URL: + g_value_set_string (value, self->url); + break; + + case PROP_SHA256: + g_value_set_string (value, self->sha256); + break; + + case PROP_SIZE: + g_value_set_uint64 (value, self->size); + break; + + case PROP_INSTALLED_SIZE: + g_value_set_uint64 (value, self->installed_size); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +builder_source_extra_data_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + BuilderSourceExtraData *self = BUILDER_SOURCE_EXTRA_DATA (object); + + switch (prop_id) + { + case PROP_FILENAME: + g_free (self->filename); + self->filename = g_value_dup_string (value); + break; + + case PROP_URL: + g_free (self->url); + self->url = g_value_dup_string (value); + break; + + case PROP_SHA256: + g_free (self->sha256); + self->sha256 = g_value_dup_string (value); + break; + + case PROP_SIZE: + self->size = g_value_get_uint64 (value); + break; + + case PROP_INSTALLED_SIZE: + self->installed_size = g_value_get_uint64 (value); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static gboolean +builder_source_extra_data_download (BuilderSource *source, + gboolean update_vcs, + BuilderContext *context, + GError **error) +{ + BuilderSourceExtraData *self = BUILDER_SOURCE_EXTRA_DATA (source); + + if (self->filename == NULL) + return flatpak_fail (error, "No filename specified for extra data source"); + + if (self->url == NULL) + return flatpak_fail (error, "No url specified for extra data source"); + + if (self->sha256 == NULL) + return flatpak_fail (error, "No sha256 specified for extra data source"); + + if (self->size == 0) + return flatpak_fail (error, "No size specified for extra data source"); + + return TRUE; +} + + +static gboolean +builder_source_extra_data_extract (BuilderSource *source, + GFile *dest, + BuilderOptions *build_options, + BuilderContext *context, + GError **error) +{ + return TRUE; +} + +static gboolean +builder_source_extra_data_bundle (BuilderSource *source, + BuilderContext *context, + GError **error) +{ + return TRUE; +} + +static void +builder_source_extra_data_checksum (BuilderSource *source, + BuilderCache *cache, + BuilderContext *context) +{ + BuilderSourceExtraData *self = BUILDER_SOURCE_EXTRA_DATA (source); + + builder_cache_checksum_str (cache, self->filename); + builder_cache_checksum_str (cache, self->url); + builder_cache_checksum_str (cache, self->sha256); + builder_cache_checksum_uint64 (cache, self->size); + builder_cache_checksum_uint64 (cache, self->installed_size); +} + +static void +builder_source_extra_data_finish (BuilderSource *source, + GPtrArray *args, + BuilderContext *context) +{ + BuilderSourceExtraData *self = BUILDER_SOURCE_EXTRA_DATA (source); + char *arg; + g_autofree char *installed_size = NULL; + + if (self->installed_size != 0) + installed_size = g_strdup_printf ("%" G_GUINT64_FORMAT, self->installed_size); + else + installed_size = g_strdup (""); + + arg = g_strdup_printf ("--extra-data=%s:%s:%"G_GUINT64_FORMAT":%s:%s", + self->filename, + self->sha256, + self->size, + installed_size, + self->url); + + g_ptr_array_add (args, arg); +} + +static void +builder_source_extra_data_class_init (BuilderSourceExtraDataClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + BuilderSourceClass *source_class = BUILDER_SOURCE_CLASS (klass); + + object_class->finalize = builder_source_extra_data_finalize; + object_class->get_property = builder_source_extra_data_get_property; + object_class->set_property = builder_source_extra_data_set_property; + + source_class->download = builder_source_extra_data_download; + source_class->extract = builder_source_extra_data_extract; + source_class->bundle = builder_source_extra_data_bundle; + source_class->checksum = builder_source_extra_data_checksum; + source_class->finish = builder_source_extra_data_finish; + + g_object_class_install_property (object_class, + PROP_URL, + g_param_spec_string ("url", + "", + "", + NULL, + G_PARAM_READWRITE)); + g_object_class_install_property (object_class, + PROP_FILENAME, + g_param_spec_string ("filename", + "", + "", + NULL, + G_PARAM_READWRITE)); + g_object_class_install_property (object_class, + PROP_SHA256, + g_param_spec_string ("sha256", + "", + "", + NULL, + G_PARAM_READWRITE)); + g_object_class_install_property (object_class, + PROP_SIZE, + g_param_spec_uint64 ("size", + "", + "", + 0, G_MAXUINT64, + 0, + G_PARAM_READWRITE)); + g_object_class_install_property (object_class, + PROP_INSTALLED_SIZE, + g_param_spec_uint64 ("installed-size", + "", + "", + 0, G_MAXUINT64, + 0, + G_PARAM_READWRITE)); +} + +static void +builder_source_extra_data_init (BuilderSourceExtraData *self) +{ +} diff --git a/src/builder-source-extra-data.h b/src/builder-source-extra-data.h new file mode 100644 index 00000000..64680ea1 --- /dev/null +++ b/src/builder-source-extra-data.h @@ -0,0 +1,40 @@ +/* + * Copyright © 2015 Red Hat, Inc + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see . + * + * Authors: + * Alexander Larsson + */ + +#ifndef __BUILDER_SOURCE_EXTRA_DATA_H__ +#define __BUILDER_SOURCE_EXTRA_DATA_H__ + +#include "builder-source.h" + +G_BEGIN_DECLS + +typedef struct BuilderSourceExtraData BuilderSourceExtraData; + +#define BUILDER_TYPE_SOURCE_EXTRA_DATA (builder_source_extra_data_get_type ()) +#define BUILDER_SOURCE_EXTRA_DATA(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), BUILDER_TYPE_SOURCE_EXTRA_DATA, BuilderSourceExtraData)) +#define BUILDER_IS_SOURCE_EXTRA_DATA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), BUILDER_TYPE_SOURCE_EXTRA_DATA)) + +GType builder_source_extra_data_get_type (void); + +G_DEFINE_AUTOPTR_CLEANUP_FUNC (BuilderSourceExtraData, g_object_unref) + +G_END_DECLS + +#endif /* __BUILDER_SOURCE_EXTRA_DATA_H__ */ diff --git a/src/builder-source.c b/src/builder-source.c index 836d5cb1..390da529 100644 --- a/src/builder-source.c +++ b/src/builder-source.c @@ -36,6 +36,7 @@ #include "builder-source-file.h" #include "builder-source-script.h" #include "builder-source-shell.h" +#include "builder-source-extra-data.h" static void serializable_iface_init (JsonSerializableIface *serializable_iface); @@ -252,6 +253,8 @@ builder_source_to_json (BuilderSource *self) type = "script"; else if (BUILDER_IS_SOURCE_SHELL (self)) type = "shell"; + else if (BUILDER_IS_SOURCE_EXTRA_DATA (self)) + type = "extra-data"; else if (BUILDER_IS_SOURCE_PATCH (self)) type = "patch"; else if (BUILDER_IS_SOURCE_GIT (self)) @@ -285,6 +288,8 @@ builder_source_from_json (JsonNode *node) return (BuilderSource *) json_gobject_deserialize (BUILDER_TYPE_SOURCE_SCRIPT, node); else if (strcmp (type, "shell") == 0) return (BuilderSource *) json_gobject_deserialize (BUILDER_TYPE_SOURCE_SHELL, node); + else if (strcmp (type, "extra-data") == 0) + return (BuilderSource *) json_gobject_deserialize (BUILDER_TYPE_SOURCE_EXTRA_DATA, node); else if (strcmp (type, "patch") == 0) return (BuilderSource *) json_gobject_deserialize (BUILDER_TYPE_SOURCE_PATCH, node); else if (strcmp (type, "git") == 0) @@ -388,6 +393,17 @@ builder_source_checksum (BuilderSource *self, class->checksum (self, cache, context); } +void +builder_source_finish (BuilderSource *self, + GPtrArray *args, + BuilderContext *context) +{ + BuilderSourceClass *class = BUILDER_SOURCE_GET_CLASS (self); + + if (class->finish) + class->finish (self, args, context); +} + gboolean builder_source_is_enabled (BuilderSource *self, BuilderContext *context) diff --git a/src/builder-source.h b/src/builder-source.h index 4fa3c599..10456491 100644 --- a/src/builder-source.h +++ b/src/builder-source.h @@ -71,6 +71,9 @@ typedef struct void (* checksum)(BuilderSource *self, BuilderCache *cache, BuilderContext *context); + void (* finish)(BuilderSource *self, + GPtrArray *args, + BuilderContext *context); } BuilderSourceClass; GType builder_source_get_type (void); @@ -103,6 +106,9 @@ gboolean builder_source_update (BuilderSource *self, void builder_source_checksum (BuilderSource *self, BuilderCache *cache, BuilderContext *context); +void builder_source_finish (BuilderSource *self, + GPtrArray *args, + BuilderContext *context); gboolean builder_source_is_enabled (BuilderSource *self, BuilderContext *context);