[gnome-software] Add a simple anonymous ratings and review service
- From: Richard Hughes <rhughes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software] Add a simple anonymous ratings and review service
- Date: Wed, 10 Feb 2016 11:07:57 +0000 (UTC)
commit 40855228a406bb0f508c7feb8c10287dd863c99d
Author: Richard Hughes <richard hughsie com>
Date: Wed Feb 10 09:47:10 2016 +0000
Add a simple anonymous ratings and review service
src/plugins/Makefile.am | 7 +
src/plugins/gs-plugin-xdg-app-reviews.c | 909 +++++++++++++++++++++++++++++++
2 files changed, 916 insertions(+), 0 deletions(-)
---
diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am
index 3349a3f..ed90743 100644
--- a/src/plugins/Makefile.am
+++ b/src/plugins/Makefile.am
@@ -10,6 +10,7 @@ AM_CPPFLAGS = \
$(SOUP_CFLAGS) \
$(SQLITE_CFLAGS) \
$(FWUPD_CFLAGS) \
+ $(JSON_GLIB_CFLAGS) \
$(LIMBA_CFLAGS) \
$(XDG_APP_CFLAGS) \
-DBINDIR=\"$(bindir)\" \
@@ -61,6 +62,7 @@ endif
if HAVE_XDG_APP
plugin_LTLIBRARIES += libgs_plugin_xdg_app.la
+plugin_LTLIBRARIES += libgs_plugin_xdg_app_reviews.la
endif
if HAVE_LIMBA
@@ -124,6 +126,11 @@ libgs_plugin_xdg_app_la_SOURCES = gs-plugin-xdg-app.c
libgs_plugin_xdg_app_la_LIBADD = $(GS_PLUGIN_LIBS) $(XDG_APP_LIBS)
libgs_plugin_xdg_app_la_LDFLAGS = -module -avoid-version
libgs_plugin_xdg_app_la_CFLAGS = $(GS_PLUGIN_CFLAGS) $(WARN_CFLAGS)
+
+libgs_plugin_xdg_app_reviews_la_SOURCES = gs-plugin-xdg-app-reviews.c
+libgs_plugin_xdg_app_reviews_la_LIBADD = $(GS_PLUGIN_LIBS) $(JSON_GLIB_LIBS)
+libgs_plugin_xdg_app_reviews_la_LDFLAGS = -module -avoid-version
+libgs_plugin_xdg_app_reviews_la_CFLAGS = $(GS_PLUGIN_CFLAGS) $(WARN_CFLAGS)
endif
libgs_plugin_moduleset_la_SOURCES = \
diff --git a/src/plugins/gs-plugin-xdg-app-reviews.c b/src/plugins/gs-plugin-xdg-app-reviews.c
new file mode 100644
index 0000000..d794c10
--- /dev/null
+++ b/src/plugins/gs-plugin-xdg-app-reviews.c
@@ -0,0 +1,909 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2016 Richard Hughes <richard hughsie com>
+ *
+ * Licensed under the GNU General Public License Version 2
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <gs-plugin.h>
+#include <json-glib/json-glib.h>
+#include <libsoup/soup.h>
+#include <string.h>
+
+#include "gs-app.h"
+#include "gs-os-release.h"
+#include "gs-plugin.h"
+#include "gs-review.h"
+#include "gs-utils.h"
+
+/*
+ * SECTION:
+ * Provides review data from an anonymous source.
+ */
+
+#define XDG_APP_REVIEW_CACHE_AGE_MAX 237000 /* 1 week */
+#define XDG_APP_REVIEW_NUMBER_RESULTS_MAX 5
+
+#ifndef JsonParser_autoptr
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(JsonParser, g_object_unref)
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(JsonBuilder, g_object_unref)
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(JsonNode, json_node_free)
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(JsonGenerator, g_object_unref)
+#endif
+
+struct GsPluginPrivate {
+ GSettings *settings;
+ SoupSession *session;
+ gchar *distro;
+ gchar *user_hash;
+ gchar *review_server;
+};
+
+/**
+ * gs_plugin_get_name:
+ */
+const gchar *
+gs_plugin_get_name (void)
+{
+ return "xdg-app-reviews";
+}
+
+/**
+ * gs_plugin_initialize:
+ */
+void
+gs_plugin_initialize (GsPlugin *plugin)
+{
+ g_autoptr(GError) error = NULL;
+ plugin->priv = GS_PLUGIN_GET_PRIVATE (GsPluginPrivate);
+ plugin->priv->session = soup_session_new_with_options (SOUP_SESSION_USER_AGENT, gs_user_agent (),
NULL);
+ plugin->priv->user_hash = gs_utils_get_user_hash (&error);
+ plugin->priv->distro = gs_os_release_get_name (&error);
+ plugin->priv->settings = g_settings_new ("org.gnome.software");
+ plugin->priv->review_server = g_settings_get_string (plugin->priv->settings,
+ "review-server");
+}
+
+
+/**
+ * gs_plugin_get_deps:
+ */
+const gchar **
+gs_plugin_get_deps (GsPlugin *plugin)
+{
+ static const gchar *deps[] = {
+ "appstream", /* need application IDs */
+ NULL };
+ return deps;
+}
+
+/**
+ * gs_plugin_destroy:
+ */
+void
+gs_plugin_destroy (GsPlugin *plugin)
+{
+ g_free (plugin->priv->user_hash);
+ g_free (plugin->priv->distro);
+ g_object_unref (plugin->priv->session);
+ g_object_unref (plugin->priv->settings);
+}
+
+/**
+ * xdg_app_review_parse_review_object:
+ */
+static GsReview *
+xdg_app_review_parse_review_object (JsonObject *item)
+{
+ GsReview *rev = gs_review_new ();
+ guint64 timestamp;
+ g_autofree gchar *dbid = NULL;
+ g_autoptr(GDateTime) dt = NULL;
+
+ /* date */
+ timestamp = json_object_get_int_member (item, "date_created");
+ dt = g_date_time_new_from_unix_utc (timestamp);
+ gs_review_set_date (rev, dt);
+
+ /* assemble review */
+ gs_review_set_rating (rev, json_object_get_int_member (item, "rating"));
+ gs_review_set_score (rev, json_object_get_int_member (item, "score"));
+ gs_review_set_reviewer (rev, json_object_get_string_member (item, "user_display"));
+ gs_review_set_summary (rev, json_object_get_string_member (item, "summary"));
+ gs_review_set_text (rev, json_object_get_string_member (item, "description"));
+ gs_review_set_version (rev, json_object_get_string_member (item, "version"));
+ gs_review_set_karma (rev, json_object_get_int_member (item, "karma"));
+
+ /* add extra metadata for the plugin */
+ gs_review_add_metadata (rev, "user_hash",
+ json_object_get_string_member (item, "user_id"));
+ gs_review_add_metadata (rev, "user_key",
+ json_object_get_string_member (item, "user_key"));
+ gs_review_add_metadata (rev, "appid",
+ json_object_get_string_member (item, "appid"));
+ dbid = g_strdup_printf ("%" G_GINT64_FORMAT,
+ json_object_get_int_member (item, "dbid"));
+ gs_review_add_metadata (rev, "dbid", dbid);
+
+ return rev;
+}
+
+/**
+ * xdg_app_review_parse_reviews:
+ */
+static GPtrArray *
+xdg_app_review_parse_reviews (const gchar *data,
+ gsize data_len,
+ GError **error)
+{
+ JsonArray *json_reviews;
+ JsonNode *json_root;
+ guint i;
+ g_autoptr(JsonParser) json_parser = NULL;
+ g_autoptr(GPtrArray) reviews = NULL;
+
+ /* nothing */
+ if (data == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "server returned no data");
+ return NULL;
+ }
+
+ /* parse the data and find the array or ratings */
+ json_parser = json_parser_new ();
+ if (!json_parser_load_from_data (json_parser, data, data_len, error))
+ return NULL;
+ json_root = json_parser_get_root (json_parser);
+ if (json_root == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no root");
+ return NULL;
+ }
+ if (json_node_get_node_type (json_root) != JSON_NODE_ARRAY) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no array");
+ return NULL;
+ }
+
+ /* parse each rating */
+ reviews = g_ptr_array_new_with_free_func ((GDestroyNotify) g_object_unref);
+ json_reviews = json_node_get_array (json_root);
+ for (i = 0; i < json_array_get_length (json_reviews); i++) {
+ JsonNode *json_review;
+ JsonObject *json_item;
+ g_autoptr(GsReview) review = NULL;
+
+ /* extract the data */
+ json_review = json_array_get_element (json_reviews, i);
+ if (json_node_get_node_type (json_review) != JSON_NODE_OBJECT) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no object type");
+ return NULL;
+ }
+ json_item = json_node_get_object (json_review);
+ if (json_item == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no object");
+ return NULL;
+ }
+
+ /* create review */
+ review = xdg_app_review_parse_review_object (json_item);
+ g_ptr_array_add (reviews, g_object_ref (review));
+ }
+ return g_steal_pointer (&reviews);
+}
+
+/**
+ * xdg_app_review_parse_success:
+ */
+static gboolean
+xdg_app_review_parse_success (const gchar *data,
+ gsize data_len,
+ GError **error)
+{
+ JsonNode *json_root;
+ JsonObject *json_item;
+ const gchar *msg = NULL;
+ g_autoptr(JsonParser) json_parser = NULL;
+
+ /* nothing */
+ if (data == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "server returned no data");
+ return FALSE;
+ }
+
+ /* parse the data and find the success */
+ json_parser = json_parser_new ();
+ if (!json_parser_load_from_data (json_parser, data, data_len, error))
+ return FALSE;
+ json_root = json_parser_get_root (json_parser);
+ if (json_root == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no error root");
+ return FALSE;
+ }
+ if (json_node_get_node_type (json_root) != JSON_NODE_OBJECT) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no error object");
+ return FALSE;
+ }
+ json_item = json_node_get_object (json_root);
+ if (json_item == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no error object");
+ return FALSE;
+ }
+
+ /* failed? */
+ if (json_object_has_member (json_item, "msg"))
+ msg = json_object_get_string_member (json_item, "msg");
+ if (!json_object_get_boolean_member (json_item, "success")) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ msg != NULL ? msg : "unknown failure");
+ return FALSE;
+ }
+
+ /* just for the console */
+ if (msg != NULL)
+ g_debug ("success: %s", msg);
+ return TRUE;
+}
+
+#if 0
+/**
+ * xdg_app_review_get_moderate:
+ */
+static GPtrArray *
+xdg_app_review_get_moderate (SoupSession *session,
+ const gchar *user_hash,
+ GError **error)
+{
+ guint status_code;
+ g_autofree gchar *uri = NULL;
+ g_autoptr(SoupMessage) msg = NULL;
+ g_autoptr(GFile) cachefn_file = NULL;
+ g_autoptr(GPtrArray) reviews = NULL;
+
+ /* create the GET data *with* the machine hash so we can later
+ * review the application ourselves */
+ uri = g_strdup_printf ("%s/moderate/%s",
+ plugin->priv->review_server,
+ user_hash);
+ msg = soup_message_new (SOUP_METHOD_GET, uri);
+ status_code = soup_session_send_message (session, msg);
+ if (status_code != SOUP_STATUS_OK) {
+ if (!xdg_app_review_parse_success (msg->response_body->data,
+ msg->response_body->length,
+ error))
+ return NULL;
+ /* not sure what to do here */
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "status code invalid");
+ return NULL;
+ }
+ g_debug ("xdg-app-review returned: %s", msg->response_body->data);
+ return xdg_app_review_parse_reviews (msg->response_body->data,
+ msg->response_body->length,
+ error);
+}
+#endif
+
+/**
+ * gs_plugin_xdg_app_reviews_json_post:
+ */
+static gboolean
+gs_plugin_xdg_app_reviews_json_post (SoupSession *session,
+ const gchar *uri,
+ const gchar *data,
+ GError **error)
+{
+ guint status_code;
+ g_autoptr(SoupMessage) msg = NULL;
+
+ /* create the GET data */
+ g_debug ("xdg-app-review sending: %s", data);
+ msg = soup_message_new (SOUP_METHOD_POST, uri);
+ soup_message_set_request (msg, "application/json",
+ SOUP_MEMORY_COPY, data, strlen (data));
+
+ /* set sync request */
+ status_code = soup_session_send_message (session, msg);
+ if (status_code != SOUP_STATUS_OK) {
+ g_warning ("Failed to set rating on xdg-app-review: %s",
+ soup_status_get_phrase (status_code));
+ }
+
+ /* process returned JSON */
+ g_debug ("xdg-app-review returned: %s", msg->response_body->data);
+ return xdg_app_review_parse_success (msg->response_body->data,
+ msg->response_body->length,
+ error);
+}
+
+/**
+ * xdg_app_review_parse_ratings:
+ */
+static GArray *
+xdg_app_review_parse_ratings (const gchar *data,
+ gsize data_len,
+ GError **error)
+{
+ GArray *ratings;
+ JsonNode *json_root;
+ JsonObject *json_item;
+ guint i;
+ g_autoptr(JsonParser) json_parser = NULL;
+ const gchar *names[] = { "star0", "star1", "star2", "star3",
+ "star4", "star5", NULL };
+
+ /* nothing */
+ if (data == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "server returned no data");
+ return NULL;
+ }
+
+ /* parse the data and find the success */
+ json_parser = json_parser_new ();
+ if (!json_parser_load_from_data (json_parser, data, data_len, error))
+ return NULL;
+ json_root = json_parser_get_root (json_parser);
+ if (json_root == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no error root");
+ return NULL;
+ }
+ if (json_node_get_node_type (json_root) != JSON_NODE_OBJECT) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no error object");
+ return NULL;
+ }
+ json_item = json_node_get_object (json_root);
+ if (json_item == NULL) {
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "no error object");
+ return NULL;
+ }
+
+ /* get data array */
+ ratings = g_array_sized_new (FALSE, TRUE, sizeof(guint32), 6);
+ for (i = 0; names[i] != NULL; i++) {
+ guint64 tmp;
+ if (!json_object_has_member (json_item, names[i]))
+ continue;
+ tmp = json_object_get_int_member (json_item, names[i]);
+ g_array_append_val (ratings, tmp);
+ }
+ return ratings;
+}
+
+/**
+ * xdg_app_review_get_ratings:
+ */
+static GArray *
+xdg_app_review_get_ratings (GsPlugin *plugin, GsApp *app, GError **error)
+{
+ GArray *ratings;
+ guint status_code;
+ g_autofree gchar *cachedir = NULL;
+ g_autofree gchar *cachefn = NULL;
+ g_autofree gchar *data = NULL;
+ g_autofree gchar *uri = NULL;
+ g_autoptr(GFile) cachefn_file = NULL;
+ g_autoptr(SoupMessage) msg = NULL;
+
+ /* look in the cache */
+ cachedir = gs_utils_get_cachedir ("ratings", error);
+ if (cachedir == NULL)
+ return NULL;
+ cachefn = g_strdup_printf ("%s/%s.json", cachedir, gs_app_get_id (app));
+ cachefn_file = g_file_new_for_path (cachefn);
+ if (gs_utils_get_file_age (cachefn_file) < XDG_APP_REVIEW_CACHE_AGE_MAX) {
+ g_autofree gchar *json_data = NULL;
+ if (!g_file_get_contents (cachefn, &json_data, NULL, error))
+ return NULL;
+ g_debug ("got ratings data for %s from %s",
+ gs_app_get_id (app), cachefn);
+ return xdg_app_review_parse_ratings (json_data, -1, error);
+ }
+
+ /* create the GET data *with* the machine hash so we can later
+ * review the application ourselves */
+ uri = g_strdup_printf ("%s/ratings/%s",
+ plugin->priv->review_server,
+ "org.gnome.Software.desktop");
+ msg = soup_message_new (SOUP_METHOD_GET, uri);
+ status_code = soup_session_send_message (plugin->priv->session, msg);
+ if (status_code != SOUP_STATUS_OK) {
+ if (!xdg_app_review_parse_success (msg->response_body->data,
+ msg->response_body->length,
+ error))
+ return NULL;
+ /* not sure what to do here */
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "status code invalid");
+ return NULL;
+ }
+ g_warning ("xdg-app-review returned: %s", msg->response_body->data);
+ ratings = xdg_app_review_parse_ratings (msg->response_body->data,
+ msg->response_body->length,
+ error);
+ if (ratings == NULL)
+ return NULL;
+
+ /* save to the cache */
+ if (!g_file_set_contents (cachefn,
+ msg->response_body->data,
+ msg->response_body->length,
+ error))
+ return NULL;
+
+ return ratings;
+}
+
+/**
+ * gs_plugin_refine_ratings:
+ */
+static gboolean
+gs_plugin_refine_ratings (GsPlugin *plugin,
+ GsApp *app,
+ GCancellable *cancellable,
+ GError **error)
+{
+ const guint to_percentage[] = { 0, 20, 40, 60, 80, 100 };
+ guint32 cnt = 0;
+ guint32 acc = 0;
+ guint i;
+ g_autoptr(GArray) array = NULL;
+
+ /* get ratings */
+ array = xdg_app_review_get_ratings (plugin, app, error);
+ if (array == NULL)
+ return FALSE;
+ gs_app_set_review_ratings (app, array);
+
+ /* find the correct global rating */
+ for (i = 1; i <= 5; i++) {
+ guint32 tmp = g_array_index (array, guint32, i);
+ acc += to_percentage[i] * tmp;
+ cnt += tmp;
+ }
+ if (cnt == 0)
+ gs_app_set_rating (app, cnt);
+ else
+ gs_app_set_rating (app, acc / cnt);
+
+ return TRUE;
+}
+
+/**
+ * xdg_app_review_fetch_for_app:
+ */
+static GPtrArray *
+xdg_app_review_fetch_for_app (GsPlugin *plugin, GsApp *app, GError **error)
+{
+ guint karma_min;
+ guint status_code;
+ g_autofree gchar *cachedir = NULL;
+ g_autofree gchar *cachefn = NULL;
+ g_autofree gchar *data = NULL;
+ g_autofree gchar *uri = NULL;
+ g_autoptr(GFile) cachefn_file = NULL;
+ g_autoptr(GPtrArray) reviews = NULL;
+ g_autoptr(JsonBuilder) builder = NULL;
+ g_autoptr(JsonGenerator) json_generator = NULL;
+ g_autoptr(JsonNode) json_root = NULL;
+ g_autoptr(SoupMessage) msg = NULL;
+
+ /* look in the cache */
+ cachedir = gs_utils_get_cachedir ("reviews", error);
+ if (cachedir == NULL)
+ return NULL;
+ cachefn = g_strdup_printf ("%s/%s.json", cachedir, gs_app_get_id (app));
+ cachefn_file = g_file_new_for_path (cachefn);
+ if (gs_utils_get_file_age (cachefn_file) < XDG_APP_REVIEW_CACHE_AGE_MAX) {
+ g_autofree gchar *json_data = NULL;
+ if (!g_file_get_contents (cachefn, &json_data, NULL, error))
+ return NULL;
+ g_debug ("got review data for %s from %s",
+ gs_app_get_id (app), cachefn);
+ return xdg_app_review_parse_reviews (json_data, -1, error);
+ }
+
+ /* create object with review data */
+ builder = json_builder_new ();
+ json_builder_begin_object (builder);
+ json_builder_set_member_name (builder, "user_id");
+ json_builder_add_string_value (builder, plugin->priv->user_hash);
+ json_builder_set_member_name (builder, "appid");
+ json_builder_add_string_value (builder, gs_app_get_id (app));
+ json_builder_set_member_name (builder, "locale");
+ json_builder_add_string_value (builder, plugin->locale);
+ json_builder_set_member_name (builder, "distro");
+ json_builder_add_string_value (builder, plugin->priv->distro);
+ json_builder_set_member_name (builder, "version");
+ json_builder_add_string_value (builder, gs_app_get_version (app));
+ json_builder_set_member_name (builder, "limit");
+ json_builder_add_int_value (builder, XDG_APP_REVIEW_NUMBER_RESULTS_MAX);
+ json_builder_set_member_name (builder, "karma");
+ karma_min = g_settings_get_int (plugin->priv->settings,
+ "review-karma-required");
+ json_builder_add_int_value (builder, karma_min);
+ json_builder_end_object (builder);
+
+ /* export as a string */
+ json_root = json_builder_get_root (builder);
+ json_generator = json_generator_new ();
+ json_generator_set_pretty (json_generator, TRUE);
+ json_generator_set_root (json_generator, json_root);
+ data = json_generator_to_data (json_generator, NULL);
+ if (data == NULL)
+ return NULL;
+ uri = g_strdup_printf ("%s/fetch", plugin->priv->review_server);
+ msg = soup_message_new (SOUP_METHOD_POST, uri);
+ soup_message_set_request (msg, "application/json",
+ SOUP_MEMORY_COPY, data, strlen (data));
+ status_code = soup_session_send_message (plugin->priv->session, msg);
+ if (status_code != SOUP_STATUS_OK) {
+ if (!xdg_app_review_parse_success (msg->response_body->data,
+ msg->response_body->length,
+ error))
+ return NULL;
+ /* not sure what to do here */
+ g_set_error_literal (error,
+ GS_PLUGIN_ERROR,
+ GS_PLUGIN_ERROR_FAILED,
+ "status code invalid");
+ return NULL;
+ }
+ reviews = xdg_app_review_parse_reviews (msg->response_body->data,
+ msg->response_body->length,
+ error);
+ if (reviews == NULL)
+ return NULL;
+ g_debug ("xdg-app-review returned: %s", msg->response_body->data);
+
+ /* save to the cache */
+ if (!g_file_set_contents (cachefn,
+ msg->response_body->data,
+ msg->response_body->length,
+ error))
+ return NULL;
+
+ /* success */
+ return g_steal_pointer (&reviews);
+}
+
+/**
+ * gs_plugin_refine_reviews:
+ */
+static gboolean
+gs_plugin_refine_reviews (GsPlugin *plugin,
+ GsApp *app,
+ GCancellable *cancellable,
+ GError **error)
+{
+ GsReview *review;
+ guint i;
+ g_autoptr(GPtrArray) reviews = NULL;
+
+ /* get from server */
+ reviews = xdg_app_review_fetch_for_app (plugin, app, error);
+ if (reviews == NULL)
+ return FALSE;
+ for (i = 0; i < reviews->len; i++) {
+ review = g_ptr_array_index (reviews, i);
+
+ /* save this on the application object so we can use it for
+ * submitting a new review */
+ if (i == 0) {
+ gs_app_set_metadata (app, "XdgAppReviews::user_key",
+ gs_review_get_metadata_item (review, "user_key"));
+ }
+
+ /* the user_id matches, so mark this as our own review */
+ if (g_strcmp0 (gs_review_get_metadata_item (review, "user_hash"),
+ plugin->priv->user_hash) == 0) {
+ gs_review_set_state (review, GS_REVIEW_STATE_SELF);
+ }
+ gs_app_add_review (app, review);
+ }
+ return TRUE;
+}
+
+/**
+ * gs_plugin_refine:
+ */
+gboolean
+gs_plugin_refine (GsPlugin *plugin,
+ GList **list,
+ GsPluginRefineFlags flags,
+ GCancellable *cancellable,
+ GError **error)
+{
+ GsApp *app;
+ GList *l;
+
+ /* add reviews if possible */
+ if (flags & GS_PLUGIN_REFINE_FLAGS_REQUIRE_REVIEWS) {
+ for (l = *list; l != NULL; l = l->next) {
+ app = GS_APP (l->data);
+ if (gs_app_get_reviews(app)->len > 0)
+ continue;
+ if (gs_app_get_id (app) == NULL)
+ continue;
+ if (!gs_plugin_refine_reviews (plugin,
+ app,
+ cancellable,
+ error))
+ return FALSE;
+ }
+ }
+
+ /* add ratings if possible */
+ if (flags & GS_PLUGIN_REFINE_FLAGS_REQUIRE_REVIEW_RATINGS) {
+ for (l = *list; l != NULL; l = l->next) {
+ app = GS_APP (l->data);
+ if (gs_app_get_review_ratings(app) != NULL)
+ continue;
+ if (gs_app_get_id (app) == NULL)
+ continue;
+ if (!gs_plugin_refine_ratings (plugin,
+ app,
+ cancellable,
+ error))
+ return FALSE;
+ }
+ }
+
+ return TRUE;
+}
+
+/**
+ * gs_plugin_review_submit:
+ */
+gboolean
+gs_plugin_review_submit (GsPlugin *plugin,
+ GsApp *app,
+ GsReview *review,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_autofree gchar *data = NULL;
+ g_autofree gchar *uri = NULL;
+ g_autoptr(JsonBuilder) builder = NULL;
+ g_autoptr(JsonGenerator) json_generator = NULL;
+ g_autoptr(JsonNode) json_root = NULL;
+
+ /* save as we don't re-request the review from the server */
+ gs_review_add_metadata (review, "appid", gs_app_get_id (app));
+ gs_review_add_metadata (review, "user_key",
+ gs_app_get_metadata_item (app, "XdgAppReviews::user_key"));
+
+ /* create object with review data */
+ builder = json_builder_new ();
+ json_builder_begin_object (builder);
+ json_builder_set_member_name (builder, "user_id");
+ json_builder_add_string_value (builder, plugin->priv->user_hash);
+ json_builder_set_member_name (builder, "user_key");
+ json_builder_add_string_value (builder,
+ gs_review_get_metadata_item (review, "user_key"));
+ json_builder_set_member_name (builder, "appid");
+ json_builder_add_string_value (builder,
+ gs_review_get_metadata_item (review, "appid"));
+ json_builder_set_member_name (builder, "locale");
+ json_builder_add_string_value (builder, plugin->locale);
+ json_builder_set_member_name (builder, "distro");
+ json_builder_add_string_value (builder, plugin->priv->distro);
+ json_builder_set_member_name (builder, "version");
+ json_builder_add_string_value (builder, gs_review_get_version (review));
+ json_builder_set_member_name (builder, "user_display");
+ json_builder_add_string_value (builder, g_get_real_name ());
+ json_builder_set_member_name (builder, "summary");
+ json_builder_add_string_value (builder, gs_review_get_summary (review));
+ json_builder_set_member_name (builder, "description");
+ json_builder_add_string_value (builder, gs_review_get_text (review));
+ json_builder_set_member_name (builder, "rating");
+ json_builder_add_int_value (builder, gs_review_get_rating (review));
+ json_builder_end_object (builder);
+
+ /* export as a string */
+ json_root = json_builder_get_root (builder);
+ json_generator = json_generator_new ();
+ json_generator_set_pretty (json_generator, TRUE);
+ json_generator_set_root (json_generator, json_root);
+ data = json_generator_to_data (json_generator, NULL);
+
+ /* POST */
+ uri = g_strdup_printf ("%s/add", plugin->priv->review_server);
+ return gs_plugin_xdg_app_reviews_json_post (plugin->priv->session,
+ uri, data, error);
+}
+
+/**
+ * gs_plugin_xdg_app_reviews_invalidate_cache:
+ */
+static gboolean
+gs_plugin_xdg_app_reviews_invalidate_cache (GsReview *review, GError **error)
+{
+ g_autofree gchar *cachedir = NULL;
+ g_autofree gchar *cachefn = NULL;
+ g_autoptr(GFile) cachefn_file = NULL;
+
+ /* look in the cache */
+ cachedir = gs_utils_get_cachedir ("reviews", error);
+ if (cachedir == NULL)
+ return FALSE;
+ cachefn = g_strdup_printf ("%s/%s.json",
+ cachedir,
+ gs_review_get_metadata_item (review, "appid"));
+ cachefn_file = g_file_new_for_path (cachefn);
+ if (!g_file_query_exists (cachefn_file, NULL))
+ return TRUE;
+ return g_file_delete (cachefn_file, NULL, error);
+}
+
+/**
+ * gs_plugin_xdg_app_reviews_vote:
+ */
+static gboolean
+gs_plugin_xdg_app_reviews_vote (GsPlugin *plugin, GsReview *review,
+ const gchar *uri, GError **error)
+{
+ guint64 dbid;
+ g_autofree gchar *data = NULL;
+ g_autoptr(JsonBuilder) builder = NULL;
+ g_autoptr(JsonGenerator) json_generator = NULL;
+ g_autoptr(JsonNode) json_root = NULL;
+
+ /* create object with vote data */
+ builder = json_builder_new ();
+ json_builder_begin_object (builder);
+
+ json_builder_set_member_name (builder, "user_id");
+ json_builder_add_string_value (builder, plugin->priv->user_hash);
+ json_builder_set_member_name (builder, "user_key");
+ json_builder_add_string_value (builder,
+ gs_review_get_metadata_item (review, "user_key"));
+ json_builder_set_member_name (builder, "appid");
+ json_builder_add_string_value (builder,
+ gs_review_get_metadata_item (review, "appid"));
+ json_builder_set_member_name (builder, "dbid");
+ dbid = g_ascii_strtoull (gs_review_get_metadata_item (review, "dbid"), NULL, 10);
+ json_builder_add_int_value (builder, dbid);
+ json_builder_end_object (builder);
+
+ /* export as a string */
+ json_root = json_builder_get_root (builder);
+ json_generator = json_generator_new ();
+ json_generator_set_pretty (json_generator, TRUE);
+ json_generator_set_root (json_generator, json_root);
+ data = json_generator_to_data (json_generator, NULL);
+ if (data == NULL)
+ return FALSE;
+
+ /* clear cache */
+ if (!gs_plugin_xdg_app_reviews_invalidate_cache (review, error))
+ return FALSE;
+
+ /* send to server */
+ if (!gs_plugin_xdg_app_reviews_json_post (plugin->priv->session,
+ uri, data, error))
+ return FALSE;
+
+ /* mark as voted */
+ gs_review_set_state (review, GS_REVIEW_STATE_VOTED);
+
+ /* success */
+ return TRUE;
+}
+
+/**
+ * gs_plugin_review_report:
+ */
+gboolean
+gs_plugin_review_report (GsPlugin *plugin,
+ GsApp *app,
+ GsReview *review,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_autofree gchar *uri = NULL;
+ uri = g_strdup_printf ("%s/report", plugin->priv->review_server);
+ return gs_plugin_xdg_app_reviews_vote (plugin, review, uri, error);
+}
+
+/**
+ * gs_plugin_review_upvote:
+ */
+gboolean
+gs_plugin_review_upvote (GsPlugin *plugin,
+ GsApp *app,
+ GsReview *review,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_autofree gchar *uri = NULL;
+ uri = g_strdup_printf ("%s/upvote", plugin->priv->review_server);
+ return gs_plugin_xdg_app_reviews_vote (plugin, review, uri, error);
+}
+
+/**
+ * gs_plugin_review_downvote:
+ */
+gboolean
+gs_plugin_review_downvote (GsPlugin *plugin,
+ GsApp *app,
+ GsReview *review,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_autofree gchar *uri = NULL;
+ uri = g_strdup_printf ("%s/downvote", plugin->priv->review_server);
+ return gs_plugin_xdg_app_reviews_vote (plugin, review, uri, error);
+}
+
+/**
+ * gs_plugin_review_remove:
+ */
+gboolean
+gs_plugin_review_remove (GsPlugin *plugin,
+ GsApp *app,
+ GsReview *review,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_autofree gchar *uri = NULL;
+ uri = g_strdup_printf ("%s/remove", plugin->priv->review_server);
+ return gs_plugin_xdg_app_reviews_vote (plugin, review, uri, error);
+}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
