[libmediaart/api-cleanup: 3/14] extract: Allow error reporting with API using GError
- From: Martyn James Russell <mr src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libmediaart/api-cleanup: 3/14] extract: Allow error reporting with API using GError
- Date: Tue, 25 Feb 2014 18:36:21 +0000 (UTC)
commit 5727b51d41c8a58655b2d708ffa10fc4aaa8f0cf
Author: Martyn Russell <martyn lanedo com>
Date: Mon Feb 17 14:01:24 2014 +0000
extract: Allow error reporting with API using GError
libmediaart/extract.c | 132 +++++++++++++++++++++++--------------------------
libmediaart/extract.h | 51 ++++++++++++++-----
tests/mediaarttest.c | 62 ++++++++++++++++++++++-
3 files changed, 159 insertions(+), 86 deletions(-)
---
diff --git a/libmediaart/extract.c b/libmediaart/extract.c
index 7d4e616..5bd3c36 100644
--- a/libmediaart/extract.c
+++ b/libmediaart/extract.c
@@ -1241,6 +1241,26 @@ media_art_shutdown (void)
initialized = FALSE;
}
+/**
+ * media_art_error_quark:
+ *
+ * Returns: the #GQuark used to identify media art errors in
+ * GError structures.
+ *
+ * Since: 0.2
+ **/
+GQuark
+media_art_error_quark (void)
+{
+ static GQuark error_quark = 0;
+
+ if (G_UNLIKELY (error_quark == 0)) {
+ error_quark = g_quark_from_static_string ("media-art-error-quark");
+ }
+
+ return error_quark;
+}
+
static void
set_mtime (const gchar *filename,
guint64 mtime)
@@ -1253,27 +1273,21 @@ set_mtime (const gchar *filename,
static
guint64
-get_mtime (GFile *file)
+get_mtime (GFile *file,
+ GError **error)
{
GFileInfo *info;
- GError *error = NULL;
- guint64 mtime;
+ GError *local_error = NULL;
+ guint64 mtime;
info = g_file_query_info (file,
G_FILE_ATTRIBUTE_TIME_MODIFIED,
G_FILE_QUERY_INFO_NONE,
NULL,
- &error);
-
- if (G_UNLIKELY (error)) {
- gchar *uri;
+ &local_error);
- uri = g_file_get_uri (file);
- g_message ("Could not get mtime for '%s': %s",
- uri,
- error->message);
- g_free (uri);
- g_error_free (error);
+ if (G_UNLIKELY (local_error != NULL)) {
+ g_propagate_error (error, local_error);
mtime = 0;
} else {
mtime = g_file_info_get_attribute_uint64 (info, G_FILE_ATTRIBUTE_TIME_MODIFIED);
@@ -1283,42 +1297,6 @@ get_mtime (GFile *file)
return mtime;
}
-guint64
-get_mtime_by_path (const gchar *path)
-{
- GFile *file;
- guint64 mtime;
-
- g_return_val_if_fail (path != NULL, 0);
-
- file = g_file_new_for_path (path);
-
- mtime = get_mtime (file);
-
- g_object_unref (file);
-
- return mtime;
-}
-
-
-guint64
-get_mtime_by_uri (const gchar *uri)
-{
- GFile *file;
- guint64 mtime;
-
- g_return_val_if_fail (uri != NULL, 0);
-
- file = g_file_new_for_uri (uri);
-
- mtime = get_mtime (file);
-
- g_object_unref (file);
-
- return mtime;
-}
-
-
/**
* media_art_process_file:
* @file: File to be processed
@@ -1328,6 +1306,7 @@ get_mtime_by_uri (const gchar *uri)
* @type: The type of media
* @artist: The media file artist name, or %NULL
* @title: The media file title, or %NULL
+ * @error: Pointer to potential GLib / MediaArt error, or %NULL
*
* Processes a media file. If you have extracted any embedded media art and
* passed this in as @buffer, the image data will be converted to the correct
@@ -1340,20 +1319,22 @@ get_mtime_by_uri (const gchar *uri)
* If @file is on a removable filesystem, the media art file will be saved in a
* cache on the removable file system rather than on the host machine.
*
- * Returns: #TRUE if the file could be processed.
+ * Returns: %TRUE if @file could be processed or %FALSE if @error is set.
*
* Since: 0.2.0
*/
gboolean
-media_art_process_file (GFile *file,
- const guchar *buffer,
- gsize len,
- const gchar *mime,
- MediaArtType type,
- const gchar *artist,
- const gchar *title)
+media_art_process_file (GFile *file,
+ const guchar *buffer,
+ gsize len,
+ const gchar *mime,
+ MediaArtType type,
+ const gchar *artist,
+ const gchar *title,
+ GError **error)
{
GFile *cache_art_file, *local_art_file;
+ GError *local_error = NULL;
gchar *art_path, *uri;
gchar *local_art_uri = NULL;
gboolean processed = TRUE, a_exists, created = FALSE;
@@ -1371,7 +1352,16 @@ media_art_process_file (GFile *file,
(long int) len,
mime);
- mtime = get_mtime (file);
+ mtime = get_mtime (file, &local_error);
+ if (local_error != NULL) {
+ g_debug ("Could not get mtime for '%s': %s",
+ uri,
+ local_error->message);
+ g_propagate_error (error, local_error);
+ g_free (uri);
+
+ return FALSE;
+ }
media_art_get_file (artist,
title,
@@ -1395,7 +1385,7 @@ media_art_process_file (GFile *file,
a_exists = g_file_query_exists (cache_art_file, NULL);
if (a_exists) {
- a_mtime = get_mtime (cache_art_file);
+ a_mtime = get_mtime (cache_art_file, &local_error);
}
art_path = g_file_get_path (cache_art_file);
@@ -1488,29 +1478,30 @@ media_art_process_file (GFile *file,
/**
* media_art_process:
- * @buffer: (array length=len): A buffer of binary image data
+ * @uri: URI of the media file that contained the data
+ * @buffer: (array length=len): A buffer of binary data
* @len: The length of @buffer, in bytes
* @mime: The MIME type of the data stored in @buffer
* @type: The type of media that contained the image data
* @artist: (allow-none): Artist name of the media
* @title: (allow-none): Title of the media
- * @uri: URI of the media file that contained the image data
*
* This function is the same as media_art_process_file(), but takes the URI as
* a string rather than a #GFile object.
*
- * Returns: %TRUE in case of success, %FALSE otherwise.
+ * Returns: %TRUE if @uri could be processed or %FALSE if @error is set.
*
* Since: 0.2.0
*/
gboolean
-media_art_process (const unsigned char *buffer,
- size_t len,
- const gchar *mime,
- MediaArtType type,
- const gchar *artist,
- const gchar *title,
- const gchar *uri)
+media_art_process (const gchar *uri,
+ const unsigned char *buffer,
+ size_t len,
+ const gchar *mime,
+ MediaArtType type,
+ const gchar *artist,
+ const gchar *title,
+ GError **error)
{
GFile *file;
gboolean result;
@@ -1525,7 +1516,8 @@ media_art_process (const unsigned char *buffer,
mime,
type,
artist,
- title);
+ title,
+ error);
g_object_unref (file);
diff --git a/libmediaart/extract.h b/libmediaart/extract.h
index c4e716d..c3063a0 100644
--- a/libmediaart/extract.h
+++ b/libmediaart/extract.h
@@ -46,24 +46,47 @@ typedef enum {
MEDIA_ART_TYPE_COUNT
} MediaArtType;
+#define TRACKER_MINER_MANAGER_ERROR tracker_miner_manager_error_quark ()
+
+/**
+ * MediaArtError:
+ * @MEDIA_ART_ERROR_NOENT: The resource that the was passed (for example a
+ * file or URI) does not exist.
+ * @MEDIA_ART_ERROR_NOENT: The URI or GFile provided
+ * points to a file that does not exist.
+ *
+ * Enumeration values used in errors returned by the
+ * #MediaArtError API.
+ *
+ * Since: 0.2
+ **/
+typedef enum {
+ MEDIA_ART_ERROR_NOENT,
+} MediaArtError;
+
+
gboolean media_art_init (void);
void media_art_shutdown (void);
-gboolean media_art_process (const unsigned char *buffer,
- size_t len,
- const gchar *mime,
- MediaArtType type,
- const gchar *artist,
- const gchar *title,
- const gchar *uri);
+GQuark media_art_error_quark (void) G_GNUC_CONST;
+
+gboolean media_art_process (const gchar *uri,
+ const unsigned char *buffer,
+ size_t len,
+ const gchar *mime,
+ MediaArtType type,
+ const gchar *artist,
+ const gchar *title,
+ GError **error);
-gboolean media_art_process_file (GFile *file,
- const guchar *buffer,
- gsize len,
- const gchar *mime,
- MediaArtType type,
- const gchar *artist,
- const gchar *title);
+gboolean media_art_process_file (GFile *file,
+ const guchar *buffer,
+ gsize len,
+ const gchar *mime,
+ MediaArtType type,
+ const gchar *artist,
+ const gchar *title,
+ GError **error);
G_END_DECLS
diff --git a/tests/mediaarttest.c b/tests/mediaarttest.c
index d02fb68..e94f453 100644
--- a/tests/mediaarttest.c
+++ b/tests/mediaarttest.c
@@ -203,7 +203,8 @@ test_mediaart_embedded_mp3 (void)
"audio/mp3", /* mime */
MEDIA_ART_ALBUM,
"King Kilo", /* artist */
- "Lanedo"); /* title */
+ "Lanedo", /* title */
+ NULL);
g_assert_true (retval);
@@ -245,7 +246,8 @@ test_mediaart_png (void)
"image/png", /* mime */
MEDIA_ART_ALBUM,
NULL, /* album */
- "Lanedo"); /* title */
+ "Lanedo", /* title */
+ NULL);
g_assert_true (retval);
@@ -283,6 +285,58 @@ test_mediaart_png (void)
g_free (path);
}
+static void
+test_mediaart_process_failures (void)
+{
+ GError *error = NULL;
+
+ g_test_trap_subprocess ("/mediaart/process_failures/subprocess", 0, 0
/*G_TEST_SUBPROCESS_INHERIT_STDOUT | G_TEST_SUBPROCESS_INHERIT_STDERR*/);
+ g_test_trap_assert_failed ();
+ g_test_trap_assert_stderr ("*assertion 'uri != NULL' failed*");
+
+ /* Test: invalid file */
+ g_assert (!media_art_process ("file:///invalid/path.png",
+ NULL,
+ 0,
+ "image/png", /* mime */
+ MEDIA_ART_ALBUM,
+ "Foo", /* album */
+ "Bar", /* title */
+ &error));
+
+ g_assert_error (error, g_io_error_quark(), G_IO_ERROR_NOT_FOUND);
+ g_clear_error (&error);
+
+
+ /* Test: Invalid mime type */
+ /* g_assert (!media_art_process ("file:///invalid/path.png", */
+ /* NULL, */
+ /* 0, */
+ /* "image/png", /\* mime *\/ */
+ /* MEDIA_ART_ALBUM, */
+ /* "Foo", /\* album *\/ */
+ /* "Bar", /\* title *\/ */
+ /* &error)); */
+
+ /* g_message ("code:%d, domain:%d, error:'%s'\n", error->code, error->domain, error->message); */
+}
+
+static void
+test_mediaart_process_failures_subprocess (void)
+{
+ GError *error = NULL;
+
+ g_assert (!media_art_process (NULL,
+ NULL,
+ 0,
+ "image/png", /* mime */
+ MEDIA_ART_ALBUM,
+ "Foo", /* album */
+ "Bar", /* title */
+ &error));
+ g_assert_no_error (error);
+}
+
int
main (int argc, char **argv)
{
@@ -308,6 +362,10 @@ main (int argc, char **argv)
test_mediaart_embedded_mp3);
g_test_add_func ("/mediaart/png",
test_mediaart_png);
+ g_test_add_func ("/mediaart/process_failures",
+ test_mediaart_process_failures);
+ g_test_add_func ("/mediaart/process_failures/subprocess",
+ test_mediaart_process_failures_subprocess);
success = g_test_run ();
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
