src/fu-engine.h

/*
 * Copyright 2017 Richard Hughes <richard@hughsie.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#pragma once

#include <fwupdplugin.h>

#include <jcat.h>

#include "fwupd-device.h"
#include "fwupd-enums.h"

#include "fu-cabinet.h"
#include "fu-engine-config.h"
#include "fu-engine-struct.h"
#include "fu-release.h"

#define FU_TYPE_ENGINE (fu_engine_get_type())
G_DECLARE_FINAL_TYPE(FuEngine, fu_engine, FU, ENGINE, GObject)

FuEngine *
fu_engine_new(FuContext *ctx) G_GNUC_NON_NULL(1);
gboolean
fu_engine_get_loaded(FuEngine *self) G_GNUC_NON_NULL(1);
void
fu_engine_add_plugin_filter(FuEngine *self, const gchar *plugin_glob) G_GNUC_NON_NULL(1, 2);
void
fu_engine_idle_reset(FuEngine *self) G_GNUC_NON_NULL(1);
guint32
fu_engine_idle_inhibit(FuEngine *self, FuIdleInhibit inhibit, const gchar *reason)
    G_GNUC_NON_NULL(1);
void
fu_engine_idle_uninhibit(FuEngine *self, guint32 token) G_GNUC_NON_NULL(1);
gboolean
fu_engine_load(FuEngine *self, FuEngineLoadFlags flags, FuProgress *progress, GError **error)
    G_GNUC_NON_NULL(1, 3);
const gchar *
fu_engine_get_host_vendor(FuEngine *self) G_GNUC_NON_NULL(1);
const gchar *
fu_engine_get_host_product(FuEngine *self) G_GNUC_NON_NULL(1);
const gchar *
fu_engine_get_host_machine_id(FuEngine *self) G_GNUC_NON_NULL(1);
const gchar *
fu_engine_get_host_bkc(FuEngine *self) G_GNUC_NON_NULL(1);
gboolean
fu_engine_is_uid_trusted(FuEngine *self, guint64 calling_uid) G_GNUC_NON_NULL(1);
gchar *
fu_engine_get_host_security_id(FuEngine *self, const gchar *fwupd_version) G_GNUC_NON_NULL(1);
FuCabinet *
fu_engine_build_cabinet_from_stream(FuEngine *self, GInputStream *stream, GError **error)
    G_GNUC_NON_NULL(1, 2);
FuEngineConfig *
fu_engine_get_config(FuEngine *self) G_GNUC_NON_NULL(1);
GPtrArray *
fu_engine_get_plugins(FuEngine *self) G_GNUC_NON_NULL(1);
FuPlugin *
fu_engine_get_plugin_by_name(FuEngine *self, const gchar *name, GError **error)
    G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_devices(FuEngine *self, GError **error) G_GNUC_NON_NULL(1);
FuDevice *
fu_engine_get_device(FuEngine *self, const gchar *device_id, GError **error) G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_devices_by_guid(FuEngine *self, const gchar *guid, GError **error)
    G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_devices_by_composite_id(FuEngine *self, const gchar *composite_id, GError **error)
    G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_history(FuEngine *self, GError **error) G_GNUC_NON_NULL(1);
FwupdRemote *
fu_engine_get_remote_by_id(FuEngine *self, const gchar *remote_id, GError **error)
    G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_remotes(FuEngine *self, GError **error) G_GNUC_NON_NULL(1);
GPtrArray *
fu_engine_get_releases(FuEngine *self,
		       FuEngineRequest *request,
		       const gchar *device_id,
		       GError **error) G_GNUC_NON_NULL(1, 2, 3);
GPtrArray *
fu_engine_search(FuEngine *self, const gchar *token, GError **error) G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_downgrades(FuEngine *self,
			 FuEngineRequest *request,
			 const gchar *device_id,
			 GError **error) G_GNUC_NON_NULL(1, 2, 3);
GPtrArray *
fu_engine_get_upgrades(FuEngine *self,
		       FuEngineRequest *request,
		       const gchar *device_id,
		       GError **error) G_GNUC_NON_NULL(1, 2, 3);
FwupdDevice *
fu_engine_get_results(FuEngine *self, const gchar *device_id, GError **error) G_GNUC_NON_NULL(1, 2);
FuSecurityAttrs *
fu_engine_get_host_security_attrs(FuEngine *self) G_GNUC_NON_NULL(1);
FuSecurityAttrs *
fu_engine_get_host_security_events(FuEngine *self, guint limit, GError **error) G_GNUC_NON_NULL(1);
GHashTable *
fu_engine_get_report_metadata(FuEngine *self, GError **error) G_GNUC_NON_NULL(1);
gboolean
fu_engine_clear_results(FuEngine *self, const gchar *device_id, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_update_metadata(FuEngine *self,
			  const gchar *remote_id,
			  gint fd,
			  gint fd_sig,
			  GError **error) G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_update_metadata_bytes(FuEngine *self,
				const gchar *remote_id,
				GBytes *bytes_raw,
				GBytes *bytes_sig,
				GError **error) G_GNUC_NON_NULL(1, 2, 3);
gboolean
fu_engine_unlock(FuEngine *self, const gchar *device_id, GError **error) G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_verify(FuEngine *self, const gchar *device_id, FuProgress *progress, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_verify_update(FuEngine *self,
			const gchar *device_id,
			FuProgress *progress,
			GError **error) G_GNUC_NON_NULL(1, 2, 3);
GBytes *
fu_engine_firmware_dump(FuEngine *self,
			FuDevice *device,
			FuProgress *progress,
			FwupdInstallFlags flags,
			GError **error) G_GNUC_NON_NULL(1, 2, 3);
FuFirmware *
fu_engine_firmware_read(FuEngine *self,
			FuDevice *device,
			FuProgress *progress,
			FwupdInstallFlags flags,
			GError **error) G_GNUC_NON_NULL(1, 2, 3);
gboolean
fu_engine_modify_remote(FuEngine *self,
			const gchar *remote_id,
			const gchar *key,
			const gchar *value,
			GError **error) G_GNUC_NON_NULL(1, 2, 3, 4);
gboolean
fu_engine_clean_remote(FuEngine *self, const gchar *remote_id, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_modify_device(FuEngine *self,
			const gchar *device_id,
			const gchar *key,
			const gchar *value,
			GError **error) G_GNUC_NON_NULL(1, 2, 3, 4);
gboolean
fu_engine_composite_prepare(FuEngine *self, GPtrArray *devices, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_composite_cleanup(FuEngine *self, GPtrArray *devices, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_install_release(FuEngine *self,
			  FuRelease *release,
			  FuProgress *progress,
			  FwupdInstallFlags flags,
			  GError **error) G_GNUC_NON_NULL(1, 2, 3);
gboolean
fu_engine_install_blob(FuEngine *self,
		       FuDevice *device,
		       FuRelease *release,
		       FuProgress *progress,
		       FwupdInstallFlags flags,
		       FwupdFeatureFlags feature_flags,
		       GError **error) G_GNUC_NON_NULL(1, 2, 3, 4);
gboolean
fu_engine_install_releases(FuEngine *self,
			   FuEngineRequest *request,
			   GPtrArray *releases,
			   FuCabinet *cabinet,
			   FuProgress *progress,
			   FwupdInstallFlags flags,
			   GError **error) G_GNUC_NON_NULL(1, 2, 3, 4, 5);
gboolean
fu_engine_activate(FuEngine *self, const gchar *device_id, FuProgress *progress, GError **error)
    G_GNUC_NON_NULL(1, 2, 3);
GPtrArray *
fu_engine_get_approved_firmware(FuEngine *self) G_GNUC_NON_NULL(1);
void
fu_engine_add_approved_firmware(FuEngine *self, const gchar *checksum) G_GNUC_NON_NULL(1, 2);
void
fu_engine_set_approved_firmware(FuEngine *self, GPtrArray *checksums) G_GNUC_NON_NULL(1, 2);
GPtrArray *
fu_engine_get_blocked_firmware(FuEngine *self) G_GNUC_NON_NULL(1);
gboolean
fu_engine_set_blocked_firmware(FuEngine *self, GPtrArray *checksums, GError **error)
    G_GNUC_NON_NULL(1, 2);
gchar *
fu_engine_self_sign(FuEngine *self, const gchar *value, JcatSignFlags flags, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_modify_config(FuEngine *self,
			const gchar *section,
			const gchar *key,
			const gchar *value,
			GError **error) G_GNUC_NON_NULL(1, 2, 3, 4);
gboolean
fu_engine_reset_config(FuEngine *self, const gchar *section, GError **error) G_GNUC_NON_NULL(1, 2);
FuContext *
fu_engine_get_context(FuEngine *self) G_GNUC_NON_NULL(1);
GPtrArray *
fu_engine_get_releases_for_device(FuEngine *self,
				  FuEngineRequest *request,
				  FuDevice *device,
				  GError **error) G_GNUC_NON_NULL(1, 2, 3);

/* for the self tests */
void
fu_engine_add_device(FuEngine *self, FuDevice *device) G_GNUC_NON_NULL(1, 2);
void
fu_engine_add_plugin(FuEngine *self, FuPlugin *plugin) G_GNUC_NON_NULL(1, 2);
void
fu_engine_add_remote(FuEngine *self, FwupdRemote *remote) G_GNUC_NON_NULL(1, 2);
void
fu_engine_add_runtime_version(FuEngine *self, const gchar *component_id, const gchar *version)
    G_GNUC_NON_NULL(1, 2, 3);
GPtrArray *
fu_engine_get_details(FuEngine *self,
		      FuEngineRequest *request,
		      GInputStream *stream,
		      GError **error) G_GNUC_NON_NULL(1, 2, 3);
gboolean
fu_engine_check_trust(FuEngine *self, FuRelease *release, GError **error) G_GNUC_NON_NULL(1, 2);
void
fu_engine_set_silo(FuEngine *self, XbSilo *silo) G_GNUC_NON_NULL(1, 2);
XbNode *
fu_engine_get_component_by_guids(FuEngine *self, FuDevice *device) G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_load_release(FuEngine *self,
		       FuRelease *release,
		       FuCabinet *cabinet,
		       XbNode *component,
		       XbNode *rel,
		       FwupdInstallFlags install_flags,
		       GError **error) G_GNUC_NON_NULL(1, 2, 4);
gchar *
fu_engine_get_remote_id_for_stream(FuEngine *self, GInputStream *stream) G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_modify_bios_settings(FuEngine *self,
			       GHashTable *settings,
			       gboolean force_ro,
			       GError **error) G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_emulation_load(FuEngine *self, GInputStream *stream, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_emulation_save(FuEngine *self, GOutputStream *stream, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_fix_host_security_attr(FuEngine *self, const gchar *appstream_id, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_undo_host_security_attr(FuEngine *self, const gchar *appstream_id, GError **error)
    G_GNUC_NON_NULL(1, 2);
gboolean
fu_engine_plugin_allows_enumeration(FuEngine *self, FuPlugin *plugin) G_GNUC_NON_NULL(1, 2);