gs_utils_get_file_age ()

guint64
gs_utils_get_file_age (GFile *file);

Gets a file age.

gs_utils_get_content_type ()

gchar *
gs_utils_get_content_type (GFile *file,
                           GCancellable *cancellable,
                           GError **error);

Gets the standard content type for a file.

gs_utils_get_content_type_async ()

void
gs_utils_get_content_type_async (GFile *file,
                                 GCancellable *cancellable,
                                 GAsyncReadyCallback callback,
                                 gpointer user_data);

Asynchronously get the standard content type for the file . Finish the operation with gs_utils_get_content_type_finish .

Since: 47

gs_utils_get_content_type_finish ()

gchar *
gs_utils_get_content_type_finish (GFile *file,
                                  GAsyncResult *result,
                                  GError **error);

Finish an asynchronous operation started with gs_utils_get_content_type_async().

Since: 47

gs_utils_symlink ()

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.

gs_utils_unlink ()

gboolean
gs_utils_unlink (const gchar *filename,
                 GError **error);

Deletes a file from disk.

gs_mkdir_parent ()

gboolean
gs_mkdir_parent (const gchar *path,
                 GError **error);

Creates any required directories, including any parent directories.

gs_utils_get_cache_filename ()

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 .

gs_utils_get_user_hash ()

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 app.

There is no known way to calculate the machine ID or username from the machine hash and there should be no privacy issue.

gs_utils_get_permission ()

GPermission *
gs_utils_get_permission (const gchar *id,
                         GCancellable *cancellable,
                         GError **error);

Gets a permission object for an ID.

gs_utils_get_permission_async ()

void
gs_utils_get_permission_async (const gchar *id,
                               GCancellable *cancellable,
                               GAsyncReadyCallback callback,
                               gpointer user_data);

Asynchronously gets a GPermission object representing the given polkit action id .

Since: 42

gs_utils_get_permission_finish ()

GPermission *
gs_utils_get_permission_finish (GAsyncResult *result,
                                GError **error);

Finish an asynchronous operation started with gs_utils_get_permission_async().

Since: 42

gs_utils_strv_fnmatch ()

gboolean
gs_utils_strv_fnmatch (gchar **strv,
                       const gchar *str);

Matches a string against a list of globs.

gs_utils_sort_key ()

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).

gs_utils_sort_strcmp ()

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.

gs_utils_get_desktop_app_info ()

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.

gs_utils_rmtree ()

gboolean
gs_utils_rmtree (const gchar *directory,
                 GError **error);

Deletes a directory from disk and all its contents.

gs_utils_estimate_average_rating_score ()

unsigned int
gs_utils_estimate_average_rating_score
                               (const uint64_t *score_values,
                                size_t n_scores,
                                const uint64_t *votes,
                                gboolean *out_should_show_score);

Estimates an average rating score for an app, using the given votes and the star scale of score_values .

This behaves similarly to the simple mean of the votes, but it does some statistics to calculate a confidence interval on the result. This means that the average rating can be hidden if there have not been enough votes to give a confident mean rating. See out_should_show_score .

The properties that we want for the user interface are:

All these properties can be achieved by this approach proposed by Evan Miller which we implement.

At a high level:

The acceptable credible interval is currently set at 0.5 (i.e. half a star), as users will not notice/care about that difference between the ‘average’ given in the UI and the mean of the votes histogram. The ‘average’ rating is currently shown to a 0.1 star granularity (e.g. ‘4.1 out of 5’), so if we wanted to guarantee the ‘average’ matching the votes histogram we should set acceptable_credible_interval = 0.1. However, this would require at least 176 votes for each app (using 90% confidence), assuming all voters voted in consensus. It would need 4344 votes if voting was polarised. Given that most apps receive 10-50 votes (and only a handful of apps receive more), requiring this level of credibility is not practical.

Similarly for the confidence interval, we’ve chosen 90% confidence as anything higher would require too many votes.

According to https://www.evanmiller.org/ranking-items-with-star-ratings.htmltable for w = 0.5 and 90% confidence, a credible interval can be achieved with 81 uniformly distributed votes, 31 consensus votes, or 168 polarised votes.

gs_utils_error_add_app_id ()

void
gs_utils_error_add_app_id (GError **error,
                           GsApp *app);

Adds app unique ID prefix to the error.

Since: 3.30

gs_utils_error_add_origin_id ()

void
gs_utils_error_add_origin_id (GError **error,
                              GsApp *origin);

Adds origin unique ID prefix to the error.

Since: 3.30

gs_utils_error_strip_app_id ()

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

gs_utils_error_strip_origin_id ()

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

gs_utils_error_convert_gio ()

gboolean
gs_utils_error_convert_gio (GError **perror);

Converts the GIOError to an error with a GsPluginError domain.

gs_utils_error_convert_gresolver ()

gboolean
gs_utils_error_convert_gresolver (GError **perror);

Converts the GResolverError to an error with a GsPluginError domain.

gs_utils_error_convert_gdbus ()

gboolean
gs_utils_error_convert_gdbus (GError **perror);

Converts the GDBusError to an error with a GsPluginError domain.

gs_utils_error_convert_gdk_pixbuf ()

gboolean
gs_utils_error_convert_gdk_pixbuf (GError **perror);

Converts the GdkPixbufError to an error with a GsPluginError domain.

gs_utils_error_convert_appstream ()

gboolean
gs_utils_error_convert_appstream (GError **perror);

Converts the various AppStream error types to an error with a GsPluginError domain.

gs_utils_get_url_scheme ()

gchar *
gs_utils_get_url_scheme (const gchar *url);

Gets the scheme from the URL string.

gs_utils_get_url_path ()

gchar *
gs_utils_get_url_path (const gchar *url);

Gets the path from the URL string, removing any leading slashes.

gs_user_agent ()

const gchar *
gs_user_agent (void);

Gets the user agent to use for remote requests.

gs_utils_append_key_value ()

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.

Since: 3.26

gs_utils_get_memory_total ()

guint
gs_utils_get_memory_total (void);

gs_utils_parse_evr ()

gboolean
gs_utils_parse_evr (const gchar *evr,
                    gchar **out_epoch,
                    gchar **out_version,
                    gchar **out_release);

gs_utils_unique_id_compat_convert ()

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.

Since: 40

gs_utils_build_unique_id ()

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.

Since: 41

gs_utils_pixbuf_blur ()

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.

GsFileSizeIncludeFunc ()

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.

Since: 41

gs_utils_get_file_size ()

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.

Since: 41

gs_utils_get_file_etag ()

gchar *
gs_utils_get_file_etag (GFile *file,
                        GDateTime **last_modified_date_out,
                        GCancellable *cancellable);

Gets the ETag for the file , previously stored by gs_utils_set_file_etag().

Since: 43

gs_utils_set_file_etag ()

gboolean
gs_utils_set_file_etag (GFile *file,
                        const gchar *etag,
                        GCancellable *cancellable);

Sets the ETag for the file . When the etag is NULL or an empty string, then unsets the ETag for the file . The ETag can be read back with gs_utils_get_file_etag().

The file should exist, otherwise the function fails.

Since: 42

gs_utils_get_upgrade_background ()

gchar *
gs_utils_get_upgrade_background (const gchar *version);

Get the path to a background image to display as the background for a banner advertising an upgrade to the given version .

If a path is returned, it’s guaranteed to exist on the file system.

Vendors can drop their customised backgrounds in this directory for them to be used by gnome-software. See doc/vendor-customisation.md.

Since: 42

gs_utils_app_sort_name ()

gint
gs_utils_app_sort_name (GsApp *app1,
                        GsApp *app2,
                        gpointer user_data);

Comparison function to sort apps in increasing alphabetical order of name.

This is suitable for passing to gs_app_list_sort().

Since: 43

gs_utils_app_sort_match_value ()

gint
gs_utils_app_sort_match_value (GsApp *app1,
                               GsApp *app2,
                               gpointer user_data);

Comparison function to sort apps in decreasing order of match value (“match-value”).

This is suitable for passing to gs_app_list_sort().

Since: 43

gs_utils_app_sort_priority ()

gint
gs_utils_app_sort_priority (GsApp *app1,
                            GsApp *app2,
                            gpointer user_data);

Comparison function to sort apps in increasing order of their priority (“priority”).

This is suitable for passing to gs_app_list_sort().

Since: 43

gs_utils_gstring_replace ()

void
gs_utils_gstring_replace (GString *str,
                          const gchar *find,
                          const gchar *replace);

Replaces all find occurrences in str with replace .

Since: 45

gs_utils_app_sort_kind ()

gint
gs_utils_app_sort_kind (GsApp *app1,
                        GsApp *app2);

Comparison function to sort apps by Appstream kind, then by increasing alphabetical order of name.

This is useful for sorting apps with multiple kinds (E.g Updates / Updated pages), as opposed to category pages where all apps are of the same kind.

Since: 47

gs_utils_compare_versions ()

gint
gs_utils_compare_versions (const gchar *ver1,
                           const gchar *ver2);

Compares ver1 and ver2 , return value as strcmp(), that is, a number below zero, when the ver1 is before ver2 zero, when ver1 is the same as ver2 , and a number above zero, when ver1 is lower than ver2 .

Since: 48

gs_utils_filter_apps_for_plugin ()

GsAppList *
gs_utils_filter_apps_for_plugin (GsAppList *list,
                                 GsPlugin *plugin);

Extracts all apps belonging to the plugin from the list , traversing proxy apps as well.

The returned list can be empty, but it will never be NULL.

Since: 52

enum GsUtilsCacheFlags

The cache flags.