summaryrefslogtreecommitdiffstats
path: root/plugins/repos
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--plugins/repos/gs-plugin-repos.c422
-rw-r--r--plugins/repos/gs-plugin-repos.h22
-rw-r--r--plugins/repos/gs-self-test.c71
-rw-r--r--plugins/repos/meson.build35
-rw-r--r--plugins/repos/tests/yum.repos.d/utopia.repo5
5 files changed, 555 insertions, 0 deletions
diff --git a/plugins/repos/gs-plugin-repos.c b/plugins/repos/gs-plugin-repos.c
new file mode 100644
index 0000000..8e57e8b
--- /dev/null
+++ b/plugins/repos/gs-plugin-repos.c
@@ -0,0 +1,422 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ * vi:set noexpandtab tabstop=8 shiftwidth=8:
+ *
+ * Copyright (C) 2016 Richard Hughes <richard@hughsie.com>
+ * Copyright (C) 2017-2018 Kalev Lember <klember@redhat.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ */
+
+#include <config.h>
+
+#include <gnome-software.h>
+
+#include "gs-plugin-repos.h"
+
+/*
+ * SECTION:
+ * Plugin to set URLs and origin hostnames on repos and apps using data from
+ * `/etc/yum.repos.d`
+ *
+ * This plugin is only useful on distributions which use `/etc/yum.repos.d`.
+ *
+ * It enumerates `/etc/yum.repos.d` in a worker thread and updates its internal
+ * hash tables and state from that worker thread (while holding a lock).
+ *
+ * Other tasks on the plugin access the data synchronously, not using a worker
+ * thread. Data accesses should be fast.
+ */
+
+struct _GsPluginRepos {
+ GsPlugin parent;
+
+ /* These hash tables are replaced by a worker thread. They are immutable
+ * once set, and will only be replaced with a new hash table instance.
+ * This means they are safe to access from the refine function in the
+ * main thread with a strong reference and no lock.
+ *
+ * @mutex must be held when getting a strong reference to them, or
+ * replacing them. */
+ GHashTable *fns; /* origin : filename */
+ GHashTable *urls; /* origin : url */
+
+ GFileMonitor *monitor;
+ gchar *reposdir;
+
+ GMutex mutex;
+
+ /* Used to cancel a pending update operation which is loading the repos
+ * data in a worker thread. */
+ GCancellable *update_cancellable; /* (nullable) (owned) */
+};
+
+G_DEFINE_TYPE (GsPluginRepos, gs_plugin_repos, GS_TYPE_PLUGIN)
+
+static void
+gs_plugin_repos_init (GsPluginRepos *self)
+{
+ GsPlugin *plugin = GS_PLUGIN (self);
+
+ g_mutex_init (&self->mutex);
+
+ /* for debugging and the self tests */
+ self->reposdir = g_strdup (g_getenv ("GS_SELF_TEST_REPOS_DIR"));
+ if (self->reposdir == NULL)
+ self->reposdir = g_strdup ("/etc/yum.repos.d");
+
+ /* plugin only makes sense if this exists at startup */
+ if (!g_file_test (self->reposdir, G_FILE_TEST_EXISTS)) {
+ gs_plugin_set_enabled (plugin, FALSE);
+ return;
+ }
+}
+
+static void
+gs_plugin_repos_dispose (GObject *object)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (object);
+
+ g_cancellable_cancel (self->update_cancellable);
+ g_clear_object (&self->update_cancellable);
+ g_clear_pointer (&self->reposdir, g_free);
+ g_clear_pointer (&self->fns, g_hash_table_unref);
+ g_clear_pointer (&self->urls, g_hash_table_unref);
+ g_clear_object (&self->monitor);
+
+ G_OBJECT_CLASS (gs_plugin_repos_parent_class)->dispose (object);
+}
+
+static void
+gs_plugin_repos_finalize (GObject *object)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (object);
+
+ g_mutex_clear (&self->mutex);
+
+ G_OBJECT_CLASS (gs_plugin_repos_parent_class)->finalize (object);
+}
+
+/* Run in a worker thread; will take the mutex */
+static gboolean
+gs_plugin_repos_load (GsPluginRepos *self,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_autoptr(GDir) dir = NULL;
+ const gchar *fn;
+ g_autoptr(GHashTable) new_filenames = NULL;
+ g_autoptr(GHashTable) new_urls = NULL;
+ g_autoptr(GMutexLocker) locker = NULL;
+
+ new_filenames = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
+ new_urls = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
+
+ /* search all files */
+ dir = g_dir_open (self->reposdir, 0, error);
+ if (dir == NULL) {
+ gs_utils_error_convert_gio (error);
+ return FALSE;
+ }
+ while ((fn = g_dir_read_name (dir)) != NULL) {
+ g_autofree gchar *filename = NULL;
+ g_auto(GStrv) groups = NULL;
+ g_autoptr(GKeyFile) kf = g_key_file_new ();
+ guint i;
+
+ /* not a repo */
+ if (!g_str_has_suffix (fn, ".repo"))
+ continue;
+
+ /* load file */
+ filename = g_build_filename (self->reposdir, fn, NULL);
+ if (!g_key_file_load_from_file (kf, filename,
+ G_KEY_FILE_NONE,
+ error)) {
+ gs_utils_error_convert_gio (error);
+ return FALSE;
+ }
+
+ /* we can have multiple repos in one file */
+ groups = g_key_file_get_groups (kf, NULL);
+ for (i = 0; groups[i] != NULL; i++) {
+ g_autofree gchar *baseurl = NULL, *metalink = NULL;
+
+ g_hash_table_insert (new_filenames,
+ g_strdup (groups[i]),
+ g_strdup (filename));
+
+ baseurl = g_key_file_get_string (kf, groups[i], "baseurl", NULL);
+ if (baseurl != NULL) {
+ g_hash_table_insert (new_urls,
+ g_strdup (groups[i]),
+ g_steal_pointer (&baseurl));
+ continue;
+ }
+
+ metalink = g_key_file_get_string (kf, groups[i], "metalink", NULL);
+ if (metalink != NULL) {
+ g_hash_table_insert (new_urls,
+ g_strdup (groups[i]),
+ g_steal_pointer (&metalink));
+ continue;
+ }
+ }
+ }
+
+ /* success; replace the hash table pointers in the object while the lock
+ * is held */
+ locker = g_mutex_locker_new (&self->mutex);
+
+ g_clear_pointer (&self->fns, g_hash_table_unref);
+ self->fns = g_steal_pointer (&new_filenames);
+ g_clear_pointer (&self->urls, g_hash_table_unref);
+ self->urls = g_steal_pointer (&new_urls);
+
+ g_assert (self->fns != NULL && self->urls != NULL);
+
+ return TRUE;
+}
+
+/* Run in a worker thread. */
+static void
+update_repos_thread_cb (GTask *task,
+ gpointer source_object,
+ gpointer task_data,
+ GCancellable *cancellable)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (source_object);
+ g_autoptr(GError) local_error = NULL;
+
+ if (!gs_plugin_repos_load (self, cancellable, &local_error))
+ g_task_return_error (task, g_steal_pointer (&local_error));
+ else
+ g_task_return_boolean (task, TRUE);
+}
+
+/* Run in the main thread. */
+static void
+gs_plugin_repos_changed_cb (GFileMonitor *monitor,
+ GFile *file,
+ GFile *other_file,
+ GFileMonitorEvent event_type,
+ gpointer user_data)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (user_data);
+ g_autoptr(GTask) task = NULL;
+
+ /* Cancel any pending updates and schedule a new update of the repo data
+ * in a worker thread. */
+ g_cancellable_cancel (self->update_cancellable);
+ g_clear_object (&self->update_cancellable);
+ self->update_cancellable = g_cancellable_new ();
+
+ task = g_task_new (self, self->update_cancellable, NULL, NULL);
+ g_task_set_source_tag (task, gs_plugin_repos_changed_cb);
+ g_task_run_in_thread (task, update_repos_thread_cb);
+}
+
+static void
+gs_plugin_repos_setup_async (GsPlugin *plugin,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (plugin);
+ g_autoptr(GFile) file = g_file_new_for_path (self->reposdir);
+ g_autoptr(GTask) task = NULL;
+ g_autoptr(GError) local_error = NULL;
+
+ task = g_task_new (plugin, cancellable, callback, user_data);
+ g_task_set_source_tag (task, gs_plugin_repos_setup_async);
+
+ /* watch for changes in the main thread */
+ self->monitor = g_file_monitor_directory (file, G_FILE_MONITOR_NONE, cancellable, &local_error);
+ if (self->monitor == NULL) {
+ gs_utils_error_convert_gio (&local_error);
+ g_task_return_error (task, g_steal_pointer (&local_error));
+ return;
+ }
+
+ g_signal_connect (self->monitor, "changed",
+ G_CALLBACK (gs_plugin_repos_changed_cb), self);
+
+ /* Set up the repos at startup. */
+ g_task_run_in_thread (task, update_repos_thread_cb);
+}
+
+static gboolean
+gs_plugin_repos_setup_finish (GsPlugin *plugin,
+ GAsyncResult *result,
+ GError **error)
+{
+ return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+static void
+gs_plugin_repos_shutdown_async (GsPlugin *plugin,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (plugin);
+ g_autoptr(GTask) task = NULL;
+
+ task = g_task_new (plugin, cancellable, callback, user_data);
+ g_task_set_source_tag (task, gs_plugin_repos_shutdown_async);
+
+ /* Cancel any ongoing update operations. */
+ g_cancellable_cancel (self->update_cancellable);
+
+ g_task_return_boolean (task, TRUE);
+}
+
+static gboolean
+gs_plugin_repos_shutdown_finish (GsPlugin *plugin,
+ GAsyncResult *result,
+ GError **error)
+{
+ return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+static void
+refine_app (GsApp *app,
+ GsPluginRefineFlags flags,
+ GHashTable *filenames,
+ GHashTable *urls)
+{
+ const gchar *tmp;
+
+ /* not required */
+ if ((flags & GS_PLUGIN_REFINE_FLAGS_REQUIRE_ORIGIN_HOSTNAME) == 0)
+ return;
+ if (gs_app_get_origin_hostname (app) != NULL)
+ return;
+
+ /* make sure we don't end up refining flatpak repos */
+ if (gs_app_get_bundle_kind (app) != AS_BUNDLE_KIND_PACKAGE)
+ return;
+
+ /* find hostname */
+ switch (gs_app_get_kind (app)) {
+ case AS_COMPONENT_KIND_REPOSITORY:
+ if (gs_app_get_id (app) == NULL)
+ return;
+ tmp = g_hash_table_lookup (urls, gs_app_get_id (app));
+ if (tmp != NULL)
+ gs_app_set_url (app, AS_URL_KIND_HOMEPAGE, tmp);
+ break;
+ default:
+ if (gs_app_get_origin (app) == NULL)
+ return;
+ tmp = g_hash_table_lookup (urls, gs_app_get_origin (app));
+ if (tmp != NULL)
+ gs_app_set_origin_hostname (app, tmp);
+ else {
+ GHashTableIter iter;
+ gpointer key, value;
+ const gchar *origin;
+
+ origin = gs_app_get_origin (app);
+
+ /* Some repos, such as rpmfusion, can have set the name with a distribution
+ number in the appstream file, thus check those specifically */
+ g_hash_table_iter_init (&iter, urls);
+ while (g_hash_table_iter_next (&iter, &key, &value)) {
+ if (g_str_has_prefix (origin, key)) {
+ const gchar *rest = origin + strlen (key);
+ while (*rest == '-' || (*rest >= '0' && *rest <= '9'))
+ rest++;
+ if (!*rest) {
+ gs_app_set_origin_hostname (app, value);
+ break;
+ }
+ }
+ }
+ }
+ break;
+ }
+
+ /* find filename */
+ switch (gs_app_get_kind (app)) {
+ case AS_COMPONENT_KIND_REPOSITORY:
+ if (gs_app_get_id (app) == NULL)
+ return;
+ tmp = g_hash_table_lookup (filenames, gs_app_get_id (app));
+ if (tmp != NULL)
+ gs_app_set_metadata (app, "repos::repo-filename", tmp);
+ break;
+ default:
+ break;
+ }
+}
+
+static void
+gs_plugin_repos_refine_async (GsPlugin *plugin,
+ GsAppList *list,
+ GsPluginRefineFlags flags,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ GsPluginRepos *self = GS_PLUGIN_REPOS (plugin);
+ g_autoptr(GHashTable) filenames = NULL; /* (element-type utf8 filename) mapping origin to filename */
+ g_autoptr(GHashTable) urls = NULL; /* (element-type utf8 utf8) mapping origin to URL */
+ g_autoptr(GMutexLocker) locker = NULL;
+ g_autoptr(GTask) task = NULL;
+
+ task = g_task_new (plugin, cancellable, callback, user_data);
+ g_task_set_source_tag (task, gs_plugin_repos_refine_async);
+
+ /* nothing to do here */
+ if ((flags & GS_PLUGIN_REFINE_FLAGS_REQUIRE_ORIGIN_HOSTNAME) == 0) {
+ g_task_return_boolean (task, TRUE);
+ return;
+ }
+
+ /* Grab a reference to the object’s state so it can be accessed without
+ * holding the lock throughout, to keep the critical section small. */
+ locker = g_mutex_locker_new (&self->mutex);
+ filenames = g_hash_table_ref (self->fns);
+ urls = g_hash_table_ref (self->urls);
+ g_clear_pointer (&locker, g_mutex_locker_free);
+
+ /* Update each of the apps */
+ for (guint i = 0; i < gs_app_list_length (list); i++) {
+ GsApp *app = gs_app_list_index (list, i);
+
+ refine_app (app, flags, filenames, urls);
+ }
+
+ g_task_return_boolean (task, TRUE);
+}
+
+static gboolean
+gs_plugin_repos_refine_finish (GsPlugin *plugin,
+ GAsyncResult *result,
+ GError **error)
+{
+ return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+static void
+gs_plugin_repos_class_init (GsPluginReposClass *klass)
+{
+ GObjectClass *object_class = G_OBJECT_CLASS (klass);
+ GsPluginClass *plugin_class = GS_PLUGIN_CLASS (klass);
+
+ object_class->dispose = gs_plugin_repos_dispose;
+ object_class->finalize = gs_plugin_repos_finalize;
+
+ plugin_class->setup_async = gs_plugin_repos_setup_async;
+ plugin_class->setup_finish = gs_plugin_repos_setup_finish;
+ plugin_class->shutdown_async = gs_plugin_repos_shutdown_async;
+ plugin_class->shutdown_finish = gs_plugin_repos_shutdown_finish;
+ plugin_class->refine_async = gs_plugin_repos_refine_async;
+ plugin_class->refine_finish = gs_plugin_repos_refine_finish;
+}
+
+GType
+gs_plugin_query_type (void)
+{
+ return GS_TYPE_PLUGIN_REPOS;
+}
diff --git a/plugins/repos/gs-plugin-repos.h b/plugins/repos/gs-plugin-repos.h
new file mode 100644
index 0000000..36ceeed
--- /dev/null
+++ b/plugins/repos/gs-plugin-repos.h
@@ -0,0 +1,22 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ * vi:set noexpandtab tabstop=8 shiftwidth=8:
+ *
+ * Copyright (C) 2021 Endless OS Foundation LLC
+ *
+ * Author: Philip Withnall <pwithnall@endlessos.org>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ */
+
+#pragma once
+
+#include <glib.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define GS_TYPE_PLUGIN_REPOS (gs_plugin_repos_get_type ())
+
+G_DECLARE_FINAL_TYPE (GsPluginRepos, gs_plugin_repos, GS, PLUGIN_REPOS, GsPlugin)
+
+G_END_DECLS
diff --git a/plugins/repos/gs-self-test.c b/plugins/repos/gs-self-test.c
new file mode 100644
index 0000000..5a0d108
--- /dev/null
+++ b/plugins/repos/gs-self-test.c
@@ -0,0 +1,71 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ * vi:set noexpandtab tabstop=8 shiftwidth=8:
+ *
+ * Copyright (C) 2013-2017 Richard Hughes <richard@hughsie.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ */
+
+#include "config.h"
+
+#include "gnome-software-private.h"
+
+#include "gs-test.h"
+
+static void
+gs_plugins_repos_func (GsPluginLoader *plugin_loader)
+{
+ gboolean ret;
+ g_autoptr(GsApp) app = NULL;
+ g_autoptr(GError) error = NULL;
+ g_autoptr(GsPluginJob) plugin_job = NULL;
+
+ /* get the extra bits */
+ app = gs_app_new ("testrepos.desktop");
+ gs_app_set_origin (app, "utopia");
+ gs_app_set_bundle_kind (app, AS_BUNDLE_KIND_PACKAGE);
+ plugin_job = gs_plugin_job_refine_new_for_app (app, GS_PLUGIN_REFINE_FLAGS_REQUIRE_ORIGIN_HOSTNAME);
+ ret = gs_plugin_loader_job_action (plugin_loader, plugin_job, NULL, &error);
+ gs_test_flush_main_context ();
+ g_assert_no_error (error);
+ g_assert (ret);
+ g_assert_cmpstr (gs_app_get_origin_hostname (app), ==, "people.freedesktop.org");
+}
+
+int
+main (int argc, char **argv)
+{
+ gboolean ret;
+ g_autofree gchar *reposdir = NULL;
+ g_autoptr(GError) error = NULL;
+ g_autoptr(GsPluginLoader) plugin_loader = NULL;
+ const gchar * const allowlist[] = {
+ "repos",
+ NULL
+ };
+
+ gs_test_init (&argc, &argv);
+
+ /* dummy data */
+ reposdir = gs_test_get_filename (TESTDATADIR, "yum.repos.d");
+ g_assert (reposdir != NULL);
+ g_setenv ("GS_SELF_TEST_REPOS_DIR", reposdir, TRUE);
+
+ /* we can only load this once per process */
+ plugin_loader = gs_plugin_loader_new (NULL, NULL);
+ gs_plugin_loader_add_location (plugin_loader, LOCALPLUGINDIR);
+ ret = gs_plugin_loader_setup (plugin_loader,
+ allowlist,
+ NULL,
+ NULL,
+ &error);
+ g_assert_no_error (error);
+ g_assert (ret);
+
+ /* plugin tests go here */
+ g_test_add_data_func ("/gnome-software/plugins/repos",
+ plugin_loader,
+ (GTestDataFunc) gs_plugins_repos_func);
+
+ return g_test_run ();
+}
diff --git a/plugins/repos/meson.build b/plugins/repos/meson.build
new file mode 100644
index 0000000..81172d2
--- /dev/null
+++ b/plugins/repos/meson.build
@@ -0,0 +1,35 @@
+cargs = ['-DG_LOG_DOMAIN="GsPluginRepos"']
+cargs += ['-DLOCALPLUGINDIR="' + meson.current_build_dir() + '"']
+
+shared_module(
+ 'gs_plugin_repos',
+ sources : 'gs-plugin-repos.c',
+ include_directories : [
+ include_directories('../..'),
+ include_directories('../../lib'),
+ ],
+ install : true,
+ install_dir: plugin_dir,
+ c_args : cargs,
+ dependencies : plugin_libs,
+)
+
+if get_option('tests')
+ cargs += ['-DTESTDATADIR="' + join_paths(meson.current_source_dir(), 'tests') + '"']
+ e = executable(
+ 'gs-self-test-repos',
+ compiled_schemas,
+ sources : [
+ 'gs-self-test.c'
+ ],
+ include_directories : [
+ include_directories('../..'),
+ include_directories('../../lib'),
+ ],
+ dependencies : [
+ plugin_libs,
+ ],
+ c_args : cargs,
+ )
+ test('gs-self-test-repos', e, suite: ['plugins', 'repos'], env: test_env)
+endif
diff --git a/plugins/repos/tests/yum.repos.d/utopia.repo b/plugins/repos/tests/yum.repos.d/utopia.repo
new file mode 100644
index 0000000..e912ec4
--- /dev/null
+++ b/plugins/repos/tests/yum.repos.d/utopia.repo
@@ -0,0 +1,5 @@
+[utopia]
+name=utopia for Fedora $releasever
+baseurl=http://people.freedesktop.org/~hughsient/fedora/$releasever/x86_64/
+enabled=1
+gpgcheck=0
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 01:12:47 +0000