Top | ![]() |
![]() |
![]() |
![]() |
These functions provide useful functionality that makes it easy to add new plugin functions.
gchar * gs_utils_get_content_type (GFile *file
,GCancellable *cancellable
,GError **error
);
Gets the standard content type for a file.
gboolean gs_utils_symlink (const gchar *target
,const gchar *linkpath
,GError **error
);
Creates a symlink that can cross filesystem boundaries. Any parent directories needed for target to exist are also created.
gboolean gs_utils_unlink (const gchar *filename
,GError **error
);
Deletes a file from disk.
gboolean gs_mkdir_parent (const gchar *path
,GError **error
);
Creates any required directories, including any parent directories.
gchar * gs_utils_get_cache_filename (const gchar *kind
,const gchar *resource
,GsUtilsCacheFlags flags
,GError **error
);
Returns a filename that points into the cache.
This may be per-system or per-user, the latter being more likely
when GS_UTILS_CACHE_FLAG_WRITEABLE
is specified in flags
.
If GS_UTILS_CACHE_FLAG_USE_HASH
is set in flags
then the returned filename
will contain the hashed version of resource
.
If there is more than one match, the file that has been modified last is returned.
If a plugin requests a file to be saved in the cache it is the plugins
responsibility to remove the file when it is no longer valid or is too old
-- gnome-software will not ever clean the cache for the plugin.
For this reason it is a good idea to use the plugin name as kind
.
This function can only fail if GS_UTILS_CACHE_FLAG_ENSURE_EMPTY
or
GS_UTILS_CACHE_FLAG_CREATE_DIRECTORY
are passed in flags
.
kind |
A cache kind, e.g. "fwupd" or "screenshots/123x456" |
|
resource |
A resource, e.g. "system.bin" or "http://foo.bar/baz.bin" |
|
flags |
Some GsUtilsCacheFlags, e.g. |
|
error |
A GError, or |
gchar *
gs_utils_get_user_hash (GError **error
);
This SHA1 hash is composed of the contents of machine-id and your username and is also salted with a hardcoded value.
This provides an identifier that can be used to identify a specific user on a machine, allowing them to cast only one vote or perform one review on each application.
There is no known way to calculate the machine ID or username from the machine hash and there should be no privacy issue.
GPermission * gs_utils_get_permission (const gchar *id
,GCancellable *cancellable
,GError **error
);
Gets a permission object for an ID.
gboolean gs_utils_strv_fnmatch (gchar **strv
,const gchar *str
);
Matches a string against a list of globs.
gchar *
gs_utils_sort_key (const gchar *str
);
Useful to sort strings in a locale-sensitive, presentational way. Case is ignored and utf8 collation is used (e.g. accents are ignored).
gint gs_utils_sort_strcmp (const gchar *str1
,const gchar *str2
);
Compares two strings in a locale-sensitive, presentational way.
Case is ignored and utf8 collation is used (e.g. accents are ignored). NULL
is sorted before all non-NULL
strings, and NULLs
compare equal.
GDesktopAppInfo *
gs_utils_get_desktop_app_info (const gchar *id
);
Gets a a GDesktopAppInfo taking into account the kde4- prefix.
If the given id
doesn not have a ".desktop" suffix, it will add one to it
for convenience.
gboolean gs_utils_rmtree (const gchar *directory
,GError **error
);
Deletes a directory from disk and all its contents.
gint gs_utils_get_wilson_rating (guint64 star1
,guint64 star2
,guint64 star3
,guint64 star4
,guint64 star5
);
Returns the lower bound of Wilson score confidence interval for a Bernoulli parameter. This ensures small numbers of ratings don't give overly high scores. See https://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval for details.
void gs_utils_error_add_app_id (GError **error
,GsApp *app
);
Adds app unique ID prefix to the error.
Since: 3.30
void gs_utils_error_add_origin_id (GError **error
,GsApp *origin
);
Adds origin unique ID prefix to the error.
Since: 3.30
gchar *
gs_utils_error_strip_app_id (GError *error
);
Removes a possible app ID prefix from the error, and returns the removed app ID.
Since: 3.30
gchar *
gs_utils_error_strip_origin_id (GError *error
);
Removes a possible origin ID prefix from the error, and returns the removed origin ID.
Since: 3.30
gboolean
gs_utils_error_convert_gio (GError **perror
);
Converts the GIOError to an error with a GsPluginError domain.
gboolean
gs_utils_error_convert_gresolver (GError **perror
);
Converts the GResolverError to an error with a GsPluginError domain.
gboolean
gs_utils_error_convert_gdbus (GError **perror
);
Converts the GDBusError to an error with a GsPluginError domain.
gboolean
gs_utils_error_convert_gdk_pixbuf (GError **perror
);
Converts the GdkPixbufError to an error with a GsPluginError domain.
gboolean
gs_utils_error_convert_json_glib (GError **perror
);
Converts the JsonParserError to an error with a GsPluginError domain.
gboolean
gs_utils_error_convert_appstream (GError **perror
);
Converts the various AppStream error types to an error with a GsPluginError domain.
gchar *
gs_utils_get_url_scheme (const gchar *url
);
Gets the scheme from the URL string.
gchar *
gs_utils_get_url_path (const gchar *url
);
Gets the path from the URL string, removing any leading slashes.
const gchar *
gs_user_agent (void
);
Gets the user agent to use for remote requests.
void gs_utils_append_key_value (GString *str
,gsize align_len
,const gchar *key
,const gchar *value
);
Adds a line to an existing string, padding the key to a set number of spaces.
str |
A GString |
|
align_len |
The alignment of the |
|
key |
The text to use as a title |
|
value |
The text to use as a value |
Since: 3.26
gboolean gs_utils_parse_evr (const gchar *evr
,gchar **out_epoch
,gchar **out_version
,gchar **out_release
);
Splits EVR into epoch-version-release strings.
void
gs_utils_set_online_updates_timestamp (GSettings *settings
);
Sets the value of online-updates-timestamp to current epoch. "online-updates-timestamp" represents the last time the system was online and got any updates.
It also sets the "update-notification-timestamp", to not receive notifications about available updates too early after the actual update happened.
gchar *
gs_utils_unique_id_compat_convert (const gchar *data_id
);
Converts the unique ID string from its legacy 6-part form into a new-style 5-part AppStream data-id. Does nothing if the string is already valid.
See !583 for the history of this conversion.
A newly allocated string with the new-style data-id, or NULL
if input was no valid ID.
[nullable]
Since: 40
gchar * gs_utils_build_unique_id (AsComponentScope scope
,AsBundleKind bundle_kind
,const gchar *origin
,const gchar *cid
,const gchar *branch
);
Builds an identifier string unique to the individual dataset using the supplied information.
It's similar to as_utils_build_data_id()
, except it respects the origin
for the packages.
scope |
Scope of the metadata as AsComponentScope e.g. |
|
bundle_kind |
Bundling system providing this data, e.g. 'package' or 'flatpak' |
|
origin |
Origin string, e.g. 'os' or 'gnome-apps-nightly' |
|
cid |
AppStream component ID, e.g. 'org.freedesktop.appstream.cli' |
|
branch |
Branch, e.g. '3-20' or 'master' |
Since: 41
void gs_utils_pixbuf_blur (GdkPixbuf *src
,guint radius
,guint iterations
);
Blurs an image. Warning, this method is s..l..o..w... for large images.
gboolean (*GsFileSizeIncludeFunc) (const gchar *filename
,GFileTest file_kind
,gpointer user_data
);
Check whether include the filename
in the size calculation.
The filename
is a relative path to the file name passed to
the GsFileSizeIncludeFunc.
filename |
file name to check |
|
file_kind |
the file kind, one of GFileTest enums |
|
user_data |
a user data passed to the |
Since: 41
guint64 gs_utils_get_file_size (const gchar *filename
,GsFileSizeIncludeFunc include_func
,gpointer user_data
,GCancellable *cancellable
);
Gets the size of the file or a directory identified by filename
.
When the include_func
is not NULL
, it can limit which files are included
in the resulting size. When it's NULL
, all files and subdirectories are included.
filename |
a file name to get the size of; it can be a file or a directory |
|
include_func |
optional callback to limit what files to count. |
[nullable][scope call] |
user_data |
user data passed to the |
|
cancellable |
an optional GCancellable or |
[nullable] |
Since: 41
GsMainContextPusher *
gs_main_context_pusher_new (GMainContext *main_context
);