proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2025-08-06 09:00:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

libfwupd: Split up FwupdResult into FwupdDevice and FwupdRelease

Browse Source 
This retains the old API to avoid breaking ABI.
This commit is contained in:
Richard Hughes 2017-06-05 17:34:13 +01:00
parent 502a2ca64a
commit 4db6c4a4b0
12 changed files with 2490 additions and 574 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
libfwupd/fwupd-client.c
View File

@ -33,6 +33,7 @@
#include "fwupd-client.h"
#include "fwupd-enums.h"
#include "fwupd-error.h"
#include "fwupd-release-private.h"
#include "fwupd-remote-private.h"
#include "fwupd-result.h"
@ -146,7 +147,7 @@ fwupd_client_signal_cb (GDBusProxy *proxy,
if (g_strcmp0 (signal_name, "DeviceAdded") == 0) {
res = fwupd_result_new_from_data (parameters);
g_debug ("Emitting ::device-added(%s)",
fwupd_result_get_device_id (res));
fwupd_device_get_id (fwupd_result_get_device (res)));
g_signal_emit (client, signals[SIGNAL_DEVICE_ADDED], 0, res);
return;
}
@ -154,14 +155,14 @@ fwupd_client_signal_cb (GDBusProxy *proxy,
res = fwupd_result_new_from_data (parameters);
g_signal_emit (client, signals[SIGNAL_DEVICE_REMOVED], 0, res);
g_debug ("Emitting ::device-removed(%s)",
fwupd_result_get_device_id (res));
fwupd_device_get_id (fwupd_result_get_device (res)));
return;
}
if (g_strcmp0 (signal_name, "DeviceChanged") == 0) {
res = fwupd_result_new_from_data (parameters);
g_signal_emit (client, signals[SIGNAL_DEVICE_CHANGED], 0, res);
g_debug ("Emitting ::device-changed(%s)",
fwupd_result_get_device_id (res));
fwupd_device_get_id (fwupd_result_get_device (res)));
return;
}
g_warning ("Unknown signal name '%s' from %s",

43
libfwupd/fwupd-device-private.h Normal file
View File

@ -0,0 +1,43 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2017 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __FWUPD_DEVICE_PRIVATE_H
#define __FWUPD_DEVICE_PRIVATE_H
#include <glib-object.h>
#include "fwupd-device.h"
G_BEGIN_DECLS
FwupdDevice *fwupd_device_new_from_data (GVariant *data);
GVariant *fwupd_device_to_data (FwupdDevice *device,
const gchar *type_string);
void fwupd_device_to_variant_builder (FwupdDevice *device,
GVariantBuilder *builder);
void fwupd_device_from_key_value (FwupdDevice *device,
const gchar *key,
GVariant *value);
G_END_DECLS
#endif /* __FWUPD_DEVICE_PRIVATE_H */

1119
libfwupd/fwupd-device.c Normal file
View File

File diff suppressed because it is too large Load Diff

111
libfwupd/fwupd-device.h Normal file
View File

@ -0,0 +1,111 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2015-2017 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __FWUPD_DEVICE_H
#define __FWUPD_DEVICE_H
#include <glib-object.h>
#include "fwupd-enums.h"
G_BEGIN_DECLS
#define FWUPD_TYPE_DEVICE (fwupd_device_get_type ())
G_DECLARE_DERIVABLE_TYPE (FwupdDevice, fwupd_device, FWUPD, DEVICE, GObject)
struct _FwupdDeviceClass
{
GObjectClass parent_class;
/*< private >*/
void (*_fwupd_reserved1) (void);
void (*_fwupd_reserved2) (void);
void (*_fwupd_reserved3) (void);
void (*_fwupd_reserved4) (void);
void (*_fwupd_reserved5) (void);
void (*_fwupd_reserved6) (void);
void (*_fwupd_reserved7) (void);
};
FwupdDevice *fwupd_device_new (void);
gchar *fwupd_device_to_string (FwupdDevice *device);
const gchar *fwupd_device_get_id (FwupdDevice *device);
void fwupd_device_set_id (FwupdDevice *device,
const gchar *id);
const gchar *fwupd_device_get_name (FwupdDevice *device);
void fwupd_device_set_name (FwupdDevice *device,
const gchar *name);
const gchar *fwupd_device_get_summary (FwupdDevice *device);
void fwupd_device_set_summary (FwupdDevice *device,
const gchar *summary);
const gchar *fwupd_device_get_description (FwupdDevice *device);
void fwupd_device_set_description (FwupdDevice *device,
const gchar *description);
const gchar *fwupd_device_get_version (FwupdDevice *device);
void fwupd_device_set_version (FwupdDevice *device,
const gchar *version);
const gchar *fwupd_device_get_version_lowest (FwupdDevice *device);
void fwupd_device_set_version_lowest (FwupdDevice *device,
const gchar *version_lowest);
const gchar *fwupd_device_get_version_bootloader (FwupdDevice *device);
void fwupd_device_set_version_bootloader (FwupdDevice *device,
const gchar *version_bootloader);
guint32 fwupd_device_get_flashes_left (FwupdDevice *device);
void fwupd_device_set_flashes_left (FwupdDevice *device,
guint32 flashes_left);
guint64 fwupd_device_get_flags (FwupdDevice *device);
void fwupd_device_set_flags (FwupdDevice *device,
guint64 flags);
void fwupd_device_add_flag (FwupdDevice *device,
FwupdDeviceFlags flag);
void fwupd_device_remove_flag (FwupdDevice *device,
FwupdDeviceFlags flag);
gboolean fwupd_device_has_flag (FwupdDevice *device,
FwupdDeviceFlags flag);
guint64 fwupd_device_get_created (FwupdDevice *device);
void fwupd_device_set_created (FwupdDevice *device,
guint64 created);
guint64 fwupd_device_get_modified (FwupdDevice *device);
void fwupd_device_set_modified (FwupdDevice *device,
guint64 modified);
const gchar *fwupd_device_get_checksum (FwupdDevice *device);
void fwupd_device_set_checksum (FwupdDevice *device,
const gchar *checksum);
GChecksumType fwupd_device_get_checksum_kind (FwupdDevice *device);
void fwupd_device_set_checksum_kind (FwupdDevice *device,
GChecksumType checkum_kind);
const gchar *fwupd_device_get_provider (FwupdDevice *device);
void fwupd_device_set_provider (FwupdDevice *device,
const gchar *provider);
const gchar *fwupd_device_get_vendor (FwupdDevice *device);
void fwupd_device_set_vendor (FwupdDevice *device,
const gchar *vendor);
void fwupd_device_add_guid (FwupdDevice *device,
const gchar *guid);
gboolean fwupd_device_has_guid (FwupdDevice *device,
const gchar *guid);
GPtrArray *fwupd_device_get_guids (FwupdDevice *device);
const gchar *fwupd_device_get_guid_default (FwupdDevice *device);
G_END_DECLS
#endif /* __FWUPD_DEVICE_H */

43
libfwupd/fwupd-release-private.h Normal file
View File

@ -0,0 +1,43 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2017 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __FWUPD_RELEASE_PRIVATE_H
#define __FWUPD_RELEASE_PRIVATE_H
#include <glib-object.h>
#include "fwupd-release.h"
G_BEGIN_DECLS
FwupdRelease *fwupd_release_new_from_data (GVariant *data);
GVariant *fwupd_release_to_data (FwupdRelease *release,
const gchar *type_string);
void fwupd_release_to_variant_builder (FwupdRelease *release,
GVariantBuilder *builder);
void fwupd_release_from_key_value (FwupdRelease *release,
const gchar *key,
GVariant *value);
G_END_DECLS
#endif /* __FWUPD_RELEASE_PRIVATE_H */

891
libfwupd/fwupd-release.c Normal file
View File

@ -0,0 +1,891 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2015-2017 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include "config.h"
#include <glib-object.h>
#include <gio/gio.h>
#include <string.h>
#include "fwupd-enums-private.h"
#include "fwupd-error.h"
#include "fwupd-release-private.h"
static void fwupd_release_finalize (GObject *object);
typedef struct {
gchar *checksum;
GChecksumType checksum_kind;
gchar *description;
gchar *filename;
gchar *homepage;
gchar *appstream_id;
gchar *license;
gchar *name;
gchar *summary;
gchar *uri;
gchar *vendor;
gchar *version;
gchar *remote_id;
guint64 size;
} FwupdReleasePrivate;
G_DEFINE_TYPE_WITH_PRIVATE (FwupdRelease, fwupd_release, G_TYPE_OBJECT)
#define GET_PRIVATE(o) (fwupd_release_get_instance_private (o))
/**
* fwupd_release_get_remote_id:
* @release: A #FwupdRelease
*
* Gets the remote ID that can be used for downloading.
*
* Returns: the ID, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_remote_id (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->remote_id;
}
/**
* fwupd_release_set_remote_id:
* @release: A #FwupdRelease
* @remote_id: the release ID, e.g. "USB:foo"
*
* Sets the remote ID that can be used for downloading.
*
* Since: 0.9.3
**/
void
fwupd_release_set_remote_id (FwupdRelease *release, const gchar *remote_id)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->remote_id);
priv->remote_id = g_strdup (remote_id);
}
/**
* fwupd_release_get_version:
* @release: A #FwupdRelease
*
* Gets the update version.
*
* Returns: the update version, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_version (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->version;
}
/**
* fwupd_release_set_version:
* @release: A #FwupdRelease
* @version: the update version, e.g. "1.2.4"
*
* Sets the update version.
*
* Since: 0.9.3
**/
void
fwupd_release_set_version (FwupdRelease *release, const gchar *version)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->version);
priv->version = g_strdup (version);
}
/**
* fwupd_release_get_filename:
* @release: A #FwupdRelease
*
* Gets the update filename.
*
* Returns: the update filename, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_filename (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->filename;
}
/**
* fwupd_release_set_filename:
* @release: A #FwupdRelease
* @filename: the update filename on disk
*
* Sets the update filename.
*
* Since: 0.9.3
**/
void
fwupd_release_set_filename (FwupdRelease *release, const gchar *filename)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->filename);
priv->filename = g_strdup (filename);
}
/**
* fwupd_release_get_checksum:
* @release: A #FwupdRelease
*
* Gets the update checksum.
*
* Returns: the update checksum, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_checksum (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->checksum;
}
/**
* fwupd_release_set_checksum:
* @release: A #FwupdRelease
* @checksum: the update checksum
*
* Sets the update checksum.
*
* Since: 0.9.3
**/
void
fwupd_release_set_checksum (FwupdRelease *release, const gchar *checksum)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->checksum);
priv->checksum = g_strdup (checksum);
}
/**
* fwupd_release_get_checksum_kind:
* @release: A #FwupdRelease
*
* Gets the update checkum kind.
*
* Returns: the #GChecksumType
*
* Since: 0.9.3
**/
GChecksumType
fwupd_release_get_checksum_kind (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), 0);
return priv->checksum_kind;
}
/**
* fwupd_release_set_checksum_kind:
* @release: A #FwupdRelease
* @checkum_kind: the checksum kind, e.g. %G_CHECKSUM_SHA1
*
* Sets the update checkum kind.
*
* Since: 0.9.3
**/
void
fwupd_release_set_checksum_kind (FwupdRelease *release, GChecksumType checkum_kind)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
priv->checksum_kind = checkum_kind;
}
/**
* fwupd_release_get_uri:
* @release: A #FwupdRelease
*
* Gets the update uri.
*
* Returns: the update uri, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_uri (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->uri;
}
/**
* fwupd_release_set_uri:
* @release: A #FwupdRelease
* @uri: the update URI
*
* Sets the update uri, i.e. where you can download the firmware from.
*
* Since: 0.9.3
**/
void
fwupd_release_set_uri (FwupdRelease *release, const gchar *uri)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->uri);
priv->uri = g_strdup (uri);
}
/**
* fwupd_release_get_homepage:
* @release: A #FwupdRelease
*
* Gets the update homepage.
*
* Returns: the update homepage, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_homepage (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->homepage;
}
/**
* fwupd_release_set_homepage:
* @release: A #FwupdRelease
* @homepage: the description
*
* Sets the update homepage.
*
* Since: 0.9.3
**/
void
fwupd_release_set_homepage (FwupdRelease *release, const gchar *homepage)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->homepage);
priv->homepage = g_strdup (homepage);
}
/**
* fwupd_release_get_description:
* @release: A #FwupdRelease
*
* Gets the update description in AppStream markup format.
*
* Returns: the update description, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_description (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->description;
}
/**
* fwupd_release_set_description:
* @release: A #FwupdRelease
* @description: the update description in AppStream markup format
*
* Sets the update description.
*
* Since: 0.9.3
**/
void
fwupd_release_set_description (FwupdRelease *release, const gchar *description)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->description);
priv->description = g_strdup (description);
}
/**
* fwupd_release_get_appstream_id:
* @release: A #FwupdRelease
*
* Gets the AppStream ID.
*
* Returns: the AppStream ID, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_appstream_id (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->appstream_id;
}
/**
* fwupd_release_set_appstream_id:
* @release: A #FwupdRelease
* @appstream_id: the AppStream component ID, e.g. "org.hughski.ColorHug2.firmware"
*
* Sets the AppStream ID.
*
* Since: 0.9.3
**/
void
fwupd_release_set_appstream_id (FwupdRelease *release, const gchar *appstream_id)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->appstream_id);
priv->appstream_id = g_strdup (appstream_id);
}
/**
* fwupd_release_get_size:
* @release: A #FwupdRelease
*
* Gets the update size.
*
* Returns: the update size in bytes, or 0 if unset
*
* Since: 0.9.3
**/
guint64
fwupd_release_get_size (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), 0);
return priv->size;
}
/**
* fwupd_release_set_size:
* @release: A #FwupdRelease
* @size: the update size in bytes
*
* Sets the update size.
*
* Since: 0.9.3
**/
void
fwupd_release_set_size (FwupdRelease *release, guint64 size)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
priv->size = size;
}
/**
* fwupd_release_get_summary:
* @release: A #FwupdRelease
*
* Gets the update summary.
*
* Returns: the update summary, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_summary (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->summary;
}
/**
* fwupd_release_set_summary:
* @release: A #FwupdRelease
* @summary: the update one line summary
*
* Sets the update summary.
*
* Since: 0.9.3
**/
void
fwupd_release_set_summary (FwupdRelease *release, const gchar *summary)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->summary);
priv->summary = g_strdup (summary);
}
/**
* fwupd_release_get_vendor:
* @release: A #FwupdRelease
*
* Gets the update vendor.
*
* Returns: the update vendor, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_vendor (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->vendor;
}
/**
* fwupd_release_set_vendor:
* @release: A #FwupdRelease
* @vendor: the vendor name, e.g. "Hughski Limited"
*
* Sets the update vendor.
*
* Since: 0.9.3
**/
void
fwupd_release_set_vendor (FwupdRelease *release, const gchar *vendor)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->vendor);
priv->vendor = g_strdup (vendor);
}
/**
* fwupd_release_get_license:
* @release: A #FwupdRelease
*
* Gets the update license.
*
* Returns: the update license, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_license (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->license;
}
/**
* fwupd_release_set_license:
* @release: A #FwupdRelease
* @license: the description
*
* Sets the update license.
*
* Since: 0.9.3
**/
void
fwupd_release_set_license (FwupdRelease *release, const gchar *license)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->license);
priv->license = g_strdup (license);
}
/**
* fwupd_release_get_name:
* @release: A #FwupdRelease
*
* Gets the update name.
*
* Returns: the update name, or %NULL if unset
*
* Since: 0.9.3
**/
const gchar *
fwupd_release_get_name (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
return priv->name;
}
/**
* fwupd_release_set_name:
* @release: A #FwupdRelease
* @name: the description
*
* Sets the update name.
*
* Since: 0.9.3
**/
void
fwupd_release_set_name (FwupdRelease *release, const gchar *name)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_return_if_fail (FWUPD_IS_RELEASE (release));
g_free (priv->name);
priv->name = g_strdup (name);
}
void
fwupd_release_to_variant_builder (FwupdRelease *release, GVariantBuilder *builder)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
if (priv->remote_id != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_REMOTE_ID,
g_variant_new_string (priv->remote_id));
}
if (priv->appstream_id != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_ID,
g_variant_new_string (priv->appstream_id));
}
if (priv->filename != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_FILENAME,
g_variant_new_string (priv->filename));
}
if (priv->license != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_LICENSE,
g_variant_new_string (priv->license));
}
if (priv->name != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_NAME,
g_variant_new_string (priv->name));
}
if (priv->size != 0) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_SIZE,
g_variant_new_uint64 (priv->size));
}
if (priv->summary != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_SUMMARY,
g_variant_new_string (priv->summary));
}
if (priv->description != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_DESCRIPTION,
g_variant_new_string (priv->description));
}
if (priv->checksum != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_CHECKSUM,
g_variant_new_string (priv->checksum));
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_CHECKSUM_KIND,
g_variant_new_uint32 (priv->checksum_kind));
}
if (priv->uri != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_URI,
g_variant_new_string (priv->uri));
}
if (priv->homepage != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_HOMEPAGE,
g_variant_new_string (priv->homepage));
}
if (priv->version != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_VERSION,
g_variant_new_string (priv->version));
}
if (priv->vendor != NULL) {
g_variant_builder_add (builder, "{sv}",
FWUPD_RESULT_KEY_UPDATE_VENDOR,
g_variant_new_string (priv->vendor));
}
}
/**
* fwupd_release_to_data:
* @release: A #FwupdRelease
* @type_string: The Gvariant type string, e.g. "a{sv}" or "(a{sv})"
*
* Creates a GVariant from the release data.
*
* Returns: the GVariant, or %NULL for error
*
* Since: 0.9.3
**/
GVariant *
fwupd_release_to_data (FwupdRelease *release, const gchar *type_string)
{
GVariantBuilder builder;
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
g_return_val_if_fail (type_string != NULL, NULL);
/* create an array with all the metadata in */
g_variant_builder_init (&builder, G_VARIANT_TYPE_ARRAY);
fwupd_release_to_variant_builder (release, &builder);
/* supported types */
if (g_strcmp0 (type_string, "a{sv}") == 0)
return g_variant_new ("a{sv}", &builder);
if (g_strcmp0 (type_string, "(a{sv})") == 0)
return g_variant_new ("(a{sv})", &builder);
return NULL;
}
void
fwupd_release_from_key_value (FwupdRelease *release, const gchar *key, GVariant *value)
{
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_REMOTE_ID) == 0) {
fwupd_release_set_remote_id (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_ID) == 0) {
fwupd_release_set_appstream_id (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_FILENAME) == 0) {
fwupd_release_set_filename (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_LICENSE) == 0) {
fwupd_release_set_license (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_NAME) == 0) {
fwupd_release_set_name (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_SIZE) == 0) {
fwupd_release_set_size (release, g_variant_get_uint64 (value));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_SUMMARY) == 0) {
fwupd_release_set_summary (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_DESCRIPTION) == 0) {
fwupd_release_set_description (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_CHECKSUM) == 0) {
fwupd_release_set_checksum (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_CHECKSUM_KIND) == 0) {
fwupd_release_set_checksum_kind (release, g_variant_get_uint32 (value));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_URI) == 0) {
fwupd_release_set_uri (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_HOMEPAGE) == 0) {
fwupd_release_set_homepage (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_VERSION) == 0) {
fwupd_release_set_version (release, g_variant_get_string (value, NULL));
return;
}
if (g_strcmp0 (key, FWUPD_RESULT_KEY_UPDATE_VENDOR) == 0) {
fwupd_release_set_vendor (release, g_variant_get_string (value, NULL));
return;
}
}
static void
fwupd_pad_kv_str (GString *str, const gchar *key, const gchar *value)
{
/* ignore */
if (key == NULL || value == NULL)
return;
g_string_append_printf (str, " %s: ", key);
for (gsize i = strlen (key); i < 20; i++)
g_string_append (str, " ");
g_string_append_printf (str, "%s\n", value);
}
static void
fwupd_pad_kv_csk (GString *str, const gchar *key, GChecksumType checksum_type)
{
const gchar *tmp = "unknown";
if (checksum_type == G_CHECKSUM_SHA1)
tmp = "sha1";
else if (checksum_type == G_CHECKSUM_SHA256)
tmp = "sha256";
else if (checksum_type == G_CHECKSUM_SHA512)
tmp = "sha512";
fwupd_pad_kv_str (str, key, tmp);
}
static void
fwupd_pad_kv_siz (GString *str, const gchar *key, guint64 value)
{
g_autofree gchar *tmp = NULL;
/* ignore */
if (value == 0)
return;
tmp = g_format_size (value);
fwupd_pad_kv_str (str, key, tmp);
}
/**
* fwupd_release_to_string:
* @release: A #FwupdRelease
*
* Builds a text representation of the object.
*
* Returns: text, or %NULL for invalid
*
* Since: 0.9.3
**/
gchar *
fwupd_release_to_string (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
GString *str;
g_return_val_if_fail (FWUPD_IS_RELEASE (release), NULL);
str = g_string_new ("");
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_ID, priv->appstream_id);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_REMOTE_ID, priv->remote_id);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_SUMMARY, priv->summary);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_DESCRIPTION, priv->description);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_VERSION, priv->version);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_FILENAME, priv->filename);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_CHECKSUM, priv->checksum);
if (priv->checksum != NULL)
fwupd_pad_kv_csk (str, FWUPD_RESULT_KEY_UPDATE_CHECKSUM_KIND, priv->checksum_kind);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_LICENSE, priv->license);
fwupd_pad_kv_siz (str, FWUPD_RESULT_KEY_UPDATE_SIZE, priv->size);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_URI, priv->uri);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_HOMEPAGE, priv->homepage);
fwupd_pad_kv_str (str, FWUPD_RESULT_KEY_UPDATE_VENDOR, priv->vendor);
return g_string_free (str, FALSE);
}
static void
fwupd_release_class_init (FwupdReleaseClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = fwupd_release_finalize;
}
static void
fwupd_release_init (FwupdRelease *release)
{
FwupdReleasePrivate *priv = GET_PRIVATE (release);
priv->checksum_kind = G_CHECKSUM_SHA1;
}
static void
fwupd_release_finalize (GObject *object)
{
FwupdRelease *release = FWUPD_RELEASE (object);
FwupdReleasePrivate *priv = GET_PRIVATE (release);
g_free (priv->description);
g_free (priv->filename);
g_free (priv->checksum);
g_free (priv->appstream_id);
g_free (priv->license);
g_free (priv->name);
g_free (priv->summary);
g_free (priv->uri);
g_free (priv->homepage);
g_free (priv->vendor);
g_free (priv->version);
g_free (priv->remote_id);
G_OBJECT_CLASS (fwupd_release_parent_class)->finalize (object);
}
static void
fwupd_release_from_variant_iter (FwupdRelease *release, GVariantIter *iter)
{
GVariant *value;
const gchar *key;
while (g_variant_iter_next (iter, "{&sv}", &key, &value)) {
fwupd_release_from_key_value (release, key, value);
g_variant_unref (value);
}
}
/**
* fwupd_release_new_from_data:
* @data: a #GVariant
*
* Creates a new release using packed data.
*
* Returns: a new #FwupdRelease, or %NULL if @data was invalid
*
* Since: 0.9.3
**/
FwupdRelease *
fwupd_release_new_from_data (GVariant *data)
{
FwupdRelease *res = NULL;
const gchar *type_string;
g_autoptr(GVariantIter) iter = NULL;
/* format from GetDetails */
type_string = g_variant_get_type_string (data);
if (g_strcmp0 (type_string, "(a{sv})") == 0) {
res = fwupd_release_new ();
g_variant_get (data, "(a{sv})", &iter);
fwupd_release_from_variant_iter (res, iter);
} else if (g_strcmp0 (type_string, "a{sv}") == 0) {
res = fwupd_release_new ();
g_variant_get (data, "a{sv}", &iter);
fwupd_release_from_variant_iter (res, iter);
} else {
g_warning ("type %s not known", type_string);
}
return res;
}
/**
* fwupd_release_new:
*
* Creates a new release.
*
* Returns: a new #FwupdRelease
*
* Since: 0.9.3
**/
FwupdRelease *
fwupd_release_new (void)
{
FwupdRelease *release;
release = g_object_new (FWUPD_TYPE_RELEASE, NULL);
return FWUPD_RELEASE (release);
}

96
libfwupd/fwupd-release.h Normal file
View File

@ -0,0 +1,96 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2015-2017 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __FWUPD_RELEASE_H
#define __FWUPD_RELEASE_H
#include <glib-object.h>
#include "fwupd-enums.h"
G_BEGIN_DECLS
#define FWUPD_TYPE_RELEASE (fwupd_release_get_type ())
G_DECLARE_DERIVABLE_TYPE (FwupdRelease, fwupd_release, FWUPD, RELEASE, GObject)
struct _FwupdReleaseClass
{
GObjectClass parent_class;
/*< private >*/
void (*_fwupd_reserved1) (void);
void (*_fwupd_reserved2) (void);
void (*_fwupd_reserved3) (void);
void (*_fwupd_reserved4) (void);
void (*_fwupd_reserved5) (void);
void (*_fwupd_reserved6) (void);
void (*_fwupd_reserved7) (void);
};
FwupdRelease *fwupd_release_new (void);
gchar *fwupd_release_to_string (FwupdRelease *release);
const gchar *fwupd_release_get_version (FwupdRelease *release);
void fwupd_release_set_version (FwupdRelease *release,
const gchar *version);
const gchar *fwupd_release_get_uri (FwupdRelease *release);
void fwupd_release_set_uri (FwupdRelease *release,
const gchar *uri);
const gchar *fwupd_release_get_checksum (FwupdRelease *release);
void fwupd_release_set_checksum (FwupdRelease *release,
const gchar *checksum);
GChecksumType fwupd_release_get_checksum_kind (FwupdRelease *release);
void fwupd_release_set_checksum_kind (FwupdRelease *release,
GChecksumType checkum_kind);
const gchar *fwupd_release_get_filename (FwupdRelease *release);
void fwupd_release_set_filename (FwupdRelease *release,
const gchar *filename);
const gchar *fwupd_release_get_appstream_id (FwupdRelease *release);
void fwupd_release_set_appstream_id (FwupdRelease *release,
const gchar *id);
const gchar *fwupd_release_get_remote_id (FwupdRelease *release);
void fwupd_release_set_remote_id (FwupdRelease *release,
const gchar *remote_id);
const gchar *fwupd_release_get_vendor (FwupdRelease *release);
void fwupd_release_set_vendor (FwupdRelease *release,
const gchar *vendor);
const gchar *fwupd_release_get_name (FwupdRelease *release);
void fwupd_release_set_name (FwupdRelease *release,
const gchar *name);
const gchar *fwupd_release_get_summary (FwupdRelease *release);
void fwupd_release_set_summary (FwupdRelease *release,
const gchar *summary);
const gchar *fwupd_release_get_description (FwupdRelease *release);
void fwupd_release_set_description (FwupdRelease *release,
const gchar *description);
const gchar *fwupd_release_get_homepage (FwupdRelease *release);
void fwupd_release_set_homepage (FwupdRelease *release,
const gchar *homepage);
guint64 fwupd_release_get_size (FwupdRelease *release);
void fwupd_release_set_size (FwupdRelease *release,
guint64 size);
const gchar *fwupd_release_get_license (FwupdRelease *release);
void fwupd_release_set_license (FwupdRelease *release,
const gchar *license);
G_END_DECLS
#endif /* __FWUPD_RELEASE_H */

685
libfwupd/fwupd-result.c
View File

File diff suppressed because it is too large Load Diff

6
libfwupd/fwupd-result.h
View File

@ -24,7 +24,9 @@
#include <glib-object.h>
#include "fwupd-device.h"
#include "fwupd-enums.h"
#include "fwupd-release.h"
G_BEGIN_DECLS
@ -59,6 +61,10 @@ const gchar *fwupd_result_get_unique_id (FwupdResult *result);
void fwupd_result_set_unique_id (FwupdResult *result,
const gchar *unique_id);
/* helper objects */
FwupdRelease *fwupd_result_get_release (FwupdResult *result);
FwupdDevice *fwupd_result_get_device (FwupdResult *result);
/* device-specific */
const gchar *fwupd_result_get_device_id (FwupdResult *result);
void fwupd_result_set_device_id (FwupdResult *result,

57
libfwupd/fwupd-self-test.c
View File

@ -97,6 +97,8 @@ fwupd_enums_func (void)
static void
fwupd_result_func (void)
{
FwupdDevice *dev;
FwupdRelease *rel;
gboolean ret;
g_autofree gchar *str = NULL;
g_autoptr(FwupdResult) result = NULL;
@ -104,31 +106,34 @@ fwupd_result_func (void)
/* create dummy object */
result = fwupd_result_new ();
fwupd_result_set_device_checksum (result, "beefdead");
fwupd_result_set_device_checksum_kind (result, G_CHECKSUM_SHA256);
fwupd_result_set_device_created (result, 1);
fwupd_result_set_device_flags (result, FWUPD_DEVICE_FLAG_ALLOW_OFFLINE);
fwupd_result_set_device_id (result, "USB:foo");
fwupd_result_set_device_modified (result, 60 * 60 * 24);
fwupd_result_set_device_name (result, "ColorHug2");
fwupd_result_add_guid (result, "2082b5e0-7a64-478a-b1b2-e3404fab6dad");
fwupd_result_add_guid (result, "00000000-0000-0000-0000-000000000000");
fwupd_result_set_update_checksum (result, "deadbeef");
fwupd_result_set_update_description (result, "<p>Hi there!</p>");
fwupd_result_set_update_filename (result, "firmware.bin");
fwupd_result_set_update_id (result, "org.dave.ColorHug.firmware");
fwupd_result_set_update_size (result, 1024);
fwupd_result_set_update_uri (result, "http://foo.com");
fwupd_result_set_update_version (result, "1.2.3");
fwupd_result_add_device_flag (result, FWUPD_DEVICE_FLAG_REQUIRE_AC);
dev = fwupd_result_get_device (result);
fwupd_device_set_checksum (dev, "beefdead");
fwupd_device_set_checksum_kind (dev, G_CHECKSUM_SHA256);
fwupd_device_set_created (dev, 1);
fwupd_device_set_flags (dev, FWUPD_DEVICE_FLAG_ALLOW_OFFLINE);
fwupd_device_set_id (dev, "USB:foo");
fwupd_device_set_modified (dev, 60 * 60 * 24);
fwupd_device_set_name (dev, "ColorHug2");
fwupd_device_add_guid (dev, "2082b5e0-7a64-478a-b1b2-e3404fab6dad");
fwupd_device_add_guid (dev, "00000000-0000-0000-0000-000000000000");
fwupd_device_add_flag (dev, FWUPD_DEVICE_FLAG_REQUIRE_AC);
fwupd_result_set_update_trust_flags (result, FWUPD_TRUST_FLAG_PAYLOAD);
rel = fwupd_result_get_release (result);
fwupd_release_set_checksum (rel, "deadbeef");
fwupd_release_set_description (rel, "<p>Hi there!</p>");
fwupd_release_set_filename (rel, "firmware.bin");
fwupd_release_set_appstream_id (rel, "org.dave.ColorHug.firmware");
fwupd_release_set_size (rel, 1024);
fwupd_release_set_uri (rel, "http://foo.com");
fwupd_release_set_version (rel, "1.2.3");
str = fwupd_result_to_string (result);
g_print ("\n%s", str);
/* check GUIDs */
g_assert (fwupd_result_has_guid (result, "2082b5e0-7a64-478a-b1b2-e3404fab6dad"));
g_assert (fwupd_result_has_guid (result, "00000000-0000-0000-0000-000000000000"));
g_assert (!fwupd_result_has_guid (result, "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"));
g_assert (fwupd_device_has_guid (dev, "2082b5e0-7a64-478a-b1b2-e3404fab6dad"));
g_assert (fwupd_device_has_guid (dev, "00000000-0000-0000-0000-000000000000"));
g_assert (!fwupd_device_has_guid (dev, "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"));
ret = as_test_compare_lines (str,
"ColorHug2\n"
@ -156,6 +161,7 @@ fwupd_result_func (void)
static void
fwupd_client_devices_func (void)
{
FwupdDevice *dev;
FwupdResult *res;
g_autoptr(FwupdClient) client = NULL;
g_autoptr(GPtrArray) array = NULL;
@ -176,8 +182,9 @@ fwupd_client_devices_func (void)
/* check device */
res = g_ptr_array_index (array, 0);
g_assert (FWUPD_IS_RESULT (res));
g_assert_cmpstr (fwupd_result_get_guid_default (res), !=, NULL);
g_assert_cmpstr (fwupd_result_get_device_id (res), !=, NULL);
dev = fwupd_result_get_device (res);
g_assert_cmpstr (fwupd_device_get_guid_default (dev), !=, NULL);
g_assert_cmpstr (fwupd_device_get_id (dev), !=, NULL);
}
static void
@ -230,6 +237,7 @@ fwupd_client_remotes_func (void)
static void
fwupd_client_updates_func (void)
{
FwupdDevice *dev;
FwupdResult *res;
g_autoptr(FwupdClient) client = NULL;
g_autoptr(GPtrArray) array = NULL;
@ -250,8 +258,9 @@ fwupd_client_updates_func (void)
/* check device */
res = g_ptr_array_index (array, 0);
g_assert (FWUPD_IS_RESULT (res));
g_assert_cmpstr (fwupd_result_get_guid_default (res), !=, NULL);
g_assert_cmpstr (fwupd_result_get_device_id (res), !=, NULL);
dev = fwupd_result_get_device (res);
g_assert_cmpstr (fwupd_device_get_guid_default (dev), !=, NULL);
g_assert_cmpstr (fwupd_device_get_id (dev), !=, NULL);
}
static gboolean

2
libfwupd/fwupd.h
View File

@ -30,8 +30,10 @@
#define __FWUPD_H_INSIDE__
#include <libfwupd/fwupd-client.h>
#include <libfwupd/fwupd-device.h>
#include <libfwupd/fwupd-enums.h>
#include <libfwupd/fwupd-error.h>
#include <libfwupd/fwupd-release.h>
#include <libfwupd/fwupd-remote.h>
#include <libfwupd/fwupd-result.h>
#include <libfwupd/fwupd-version.h>

4
libfwupd/meson.build
View File

@ -15,9 +15,11 @@ install_headers(
install_headers([
'fwupd-client.h',
'fwupd-device.h',
'fwupd-enums.h',
'fwupd-error.h',
'fwupd-remote.h',
'fwupd-release.h',
'fwupd-result.h',
fwupd_version_h,
],
@ -30,8 +32,10 @@ fwupd = shared_library(
'fwupd',
sources : [
'fwupd-client.c',
'fwupd-device.c',
'fwupd-enums.c',
'fwupd-error.c',
'fwupd-release.c',
'fwupd-remote.c',
'fwupd-result.c',
],