Merge pull request owntone#1373 from chme/feat/browse-info-query

Fetch additional meta data in "browse" queries

Author: chme

README_JSON_API.md

@@ -1677,7 +1677,7 @@ GET /api/library/genres
 
 | Key             | Type     | Value                                     |
 | --------------- | -------- | ----------------------------------------- |
-| items           | array    | Array of [`genre`](#genre-object) objects |
+| items           | array    | Array of [`browse-info`](#browse-info-object) objects |
 | total           | integer  | Total number of genres in the library     |
 | offset          | integer  | Requested offset of the first genre       |
 | limit           | integer  | Requested maximum number of genres        |
@@ -2604,11 +2604,17 @@ curl --include \
 | limit           | integer  | Requested maximum number of items         |
 
 
-### `genre` object
+### `browse-info` object
 
 | Key             | Type     | Value                                     |
 | --------------- | -------- | ----------------------------------------- |
-| name            | string   | Name of genre                             |
+| name            | string   | Name (depends on the type of the query)   |
+| name_sort       | string   | Sort name                                 |
+| artist_count    | integer  | Number of artists                         |
+| album_count     | integer  | Number of albums                          |
+| track_count     | integer  | Number of tracks                          |
+| time_played     | string   | Timestamp in `ISO 8601` format           |
+| time_added      | string   | Timestamp in `ISO 8601` format           |
 
 
 ### `directory` object

src/artwork.c

@@ -1377,7 +1377,7 @@ source_group_dir_get(struct artwork_ctx *ctx)
       return ART_E_ERROR;
     }
 
-  while (((ret = db_query_fetch_string(&qp, &dir)) == 0) && (dir))
+  while (((ret = db_query_fetch_string(&dir, &qp)) == 0) && (dir))
     {
       /* The db query may return non-directories (eg if item is an internet stream or Spotify) */
       if (access(dir, F_OK) < 0)
@@ -1718,7 +1718,7 @@ source_item_ownpl_get(struct artwork_ctx *ctx)
   mfi_path = ctx->dbmfi->path;
 
   format = ART_E_NONE;
-  while (((ret = db_query_fetch_pl(&qp, &dbpli)) == 0) && (dbpli.id) && (format == ART_E_NONE))
+  while (((ret = db_query_fetch_pl(&dbpli, &qp)) == 0) && (dbpli.id) && (format == ART_E_NONE))
     {
       if (!dbpli.path)
 	continue;
@@ -1766,7 +1766,7 @@ process_items(struct artwork_ctx *ctx, int item_mode)
       return -1;
     }
 
-  while (((ret = db_query_fetch_file(&ctx->qp, &dbmfi)) == 0) && (dbmfi.id))
+  while ((ret = db_query_fetch_file(&dbmfi, &ctx->qp)) == 0)
     {
       // Save the first songalbumid, might need it for process_group() if this search doesn't give anything
       if (!ctx->persistentid)
@@ -1859,7 +1859,7 @@ process_group(struct artwork_ctx *ctx)
       goto invalid_group;
     }
 
-  is_valid = (db_query_fetch_file(&ctx->qp, &dbmfi) == 0 && dbmfi.id && strcmp(dbmfi.album, CFG_NAME_UNKNOWN_ALBUM) != 0 && strcmp(dbmfi.album_artist, CFG_NAME_UNKNOWN_ARTIST) != 0);
+  is_valid = (db_query_fetch_file(&dbmfi, &ctx->qp) == 0 && strcmp(dbmfi.album, CFG_NAME_UNKNOWN_ALBUM) != 0 && strcmp(dbmfi.album_artist, CFG_NAME_UNKNOWN_ARTIST) != 0);
   db_query_end(&ctx->qp);
   if (!is_valid)
     {

src/db.c

@@ -420,6 +420,27 @@ static const ssize_t dbgri_cols_map[] =
     dbgri_offsetof(seek),
   };
 
+/* This list must be kept in sync with
+ * - the order of fields in the Q_BROWSE_INFO query
+ * - the name of the fields in struct db_browse_info
+ */
+static const ssize_t dbbi_cols_map[] =
+  {
+    dbbi_offsetof(itemname),
+    dbbi_offsetof(itemname_sort),
+    dbbi_offsetof(track_count),
+    dbbi_offsetof(album_count),
+    dbbi_offsetof(artist_count),
+    dbbi_offsetof(song_length),
+    dbbi_offsetof(data_kind),
+    dbbi_offsetof(media_kind),
+    dbbi_offsetof(year),
+    dbbi_offsetof(date_released),
+    dbbi_offsetof(time_added),
+    dbbi_offsetof(time_played),
+    dbbi_offsetof(seek),
+  };
+
 /* This list must be kept in sync with
  * - qi_cols_map
  */
@@ -2188,7 +2209,10 @@ db_build_query_browse(struct query_params *qp, struct query_clause *qc)
   where  = browse_clause[qp->type & ~Q_F_BROWSE].where;
 
   count = sqlite3_mprintf("SELECT COUNT(*) FROM (SELECT %s FROM files f %s AND %s != '' %s);", select, qc->where, where, qc->group);
-  query = sqlite3_mprintf("SELECT %s FROM files f %s AND %s != '' %s %s %s;", select, qc->where, where, qc->group, qc->order, qc->index);
+  query = sqlite3_mprintf("SELECT %s, COUNT(f.id) as track_count, COUNT(DISTINCT f.songalbumid) as album_count, COUNT(DISTINCT f.songartistid) as artist_count, "
+			  "  SUM(f.song_length), MIN(f.data_kind), MIN(f.media_kind), MAX(f.year), MAX(f.date_released), "
+			  "  MAX(f.time_added), MAX(f.time_played), MAX(f.seek) FROM files f %s AND %s != '' %s %s %s;",
+			  select, qc->where, where, qc->group, qc->order, qc->index);
 
   return db_build_query_check(qp, count, query);
 }
@@ -2348,53 +2372,44 @@ db_query_run(char *query, int free, short update_events)
   return ((ret != SQLITE_OK) ? -1 : 0);
 }
 
-int
-db_query_fetch_file(struct query_params *qp, struct db_media_file_info *dbmfi)
+static int
+db_query_fetch(void *item, struct query_params *qp, const ssize_t cols_map[], int size)
 {
   int ncols;
   char **strcol;
   int i;
   int ret;
 
-  memset(dbmfi, 0, sizeof(struct db_media_file_info));
-
   if (!qp->stmt)
     {
       DPRINTF(E_LOG, L_DB, "Query not started!\n");
       return -1;
     }
 
-  if ((qp->type != Q_ITEMS) && (qp->type != Q_PLITEMS) && (qp->type != Q_GROUP_ITEMS))
-    {
-      DPRINTF(E_LOG, L_DB, "Not an items, playlist or group items query!\n");
-      return -1;
-    }
-
   ret = db_blocking_step(qp->stmt);
   if (ret == SQLITE_DONE)
     {
       DPRINTF(E_DBG, L_DB, "End of query results\n");
-      dbmfi->id = NULL;
-      return 0;
+      return 1;
     }
   else if (ret != SQLITE_ROW)
     {
-      DPRINTF(E_LOG, L_DB, "Could not step: %s\n", sqlite3_errmsg(hdl));	
+      DPRINTF(E_LOG, L_DB, "Could not step: %s\n", sqlite3_errmsg(hdl));
       return -1;
     }
 
   ncols = sqlite3_column_count(qp->stmt);
 
   // We allow more cols in db than in map because the db may be a future schema
-  if (ncols < ARRAY_SIZE(dbmfi_cols_map))
+  if (ncols < size)
     {
-      DPRINTF(E_LOG, L_DB, "BUG: database has fewer columns (%d) than dbmfi column map (%u)\n", ncols, ARRAY_SIZE(dbmfi_cols_map));
+      DPRINTF(E_LOG, L_DB, "BUG: database has fewer columns (%d) than column map (%u)\n", ncols, size);
       return -1;
     }
 
-  for (i = 0; i < ARRAY_SIZE(dbmfi_cols_map); i++)
+  for (i = 0; i < size; i++)
     {
-      strcol = (char **) ((char *)dbmfi + dbmfi_cols_map[i]);
+      strcol = (char **) ((char *)item + cols_map[i]);
 
       *strcol = (char *)sqlite3_column_text(qp->stmt, i);
     }
@@ -2403,7 +2418,27 @@ db_query_fetch_file(struct query_params *qp, struct db_media_file_info *dbmfi)
 }
 
 int
-db_query_fetch_pl(struct query_params *qp, struct db_playlist_info *dbpli)
+db_query_fetch_file(struct db_media_file_info *dbmfi, struct query_params *qp)
+{
+  int ret;
+
+  memset(dbmfi, 0, sizeof(struct db_media_file_info));
+
+  if ((qp->type != Q_ITEMS) && (qp->type != Q_PLITEMS) && (qp->type != Q_GROUP_ITEMS))
+    {
+      DPRINTF(E_LOG, L_DB, "Not an items, playlist or group items query!\n");
+      return -1;
+    }
+
+  ret = db_query_fetch(dbmfi, qp, dbmfi_cols_map, ARRAY_SIZE(dbmfi_cols_map));
+  if (ret < 0) {
+      DPRINTF(E_LOG, L_DB, "Failed to fetch db_media_file_info\n");
+  }
+  return ret;
+}
+
+int
+db_query_fetch_pl(struct db_playlist_info *dbpli, struct query_params *qp)
 {
   int ncols;
   char **strcol;
@@ -2470,60 +2505,47 @@ db_query_fetch_pl(struct query_params *qp, struct db_playlist_info *dbpli)
 }
 
 int
-db_query_fetch_group(struct query_params *qp, struct db_group_info *dbgri)
+db_query_fetch_group(struct db_group_info *dbgri, struct query_params *qp)
 {
-  int ncols;
-  char **strcol;
-  int i;
   int ret;
 
   memset(dbgri, 0, sizeof(struct db_group_info));
 
-  if (!qp->stmt)
-    {
-      DPRINTF(E_LOG, L_DB, "Query not started!\n");
-      return -1;
-    }
-
   if ((qp->type != Q_GROUP_ALBUMS) && (qp->type != Q_GROUP_ARTISTS))
     {
       DPRINTF(E_LOG, L_DB, "Not a groups query!\n");
       return -1;
     }
 
-  ret = db_blocking_step(qp->stmt);
-  if (ret == SQLITE_DONE)
-    {
-      DPRINTF(E_DBG, L_DB, "End of query results\n");
-      return 1;
-    }
-  else if (ret != SQLITE_ROW)
-    {
-      DPRINTF(E_LOG, L_DB, "Could not step: %s\n", sqlite3_errmsg(hdl));
-      return -1;
-    }
+  ret = db_query_fetch(dbgri, qp, dbgri_cols_map, ARRAY_SIZE(dbgri_cols_map));
+  if (ret < 0) {
+      DPRINTF(E_LOG, L_DB, "Failed to fetch db_group_info\n");
+  }
+  return ret;
+}
 
-  ncols = sqlite3_column_count(qp->stmt);
+int
+db_query_fetch_browse(struct db_browse_info *dbbi, struct query_params *qp)
+{
+  int ret;
 
-  // We allow more cols in db than in map because the db may be a future schema
-  if (ncols < ARRAY_SIZE(dbgri_cols_map))
-    {
-      DPRINTF(E_LOG, L_DB, "BUG: database has fewer columns (%d) than dbgri column map (%u)\n", ncols, ARRAY_SIZE(dbgri_cols_map));
-      return -1;
-    }
+  memset(dbbi, 0, sizeof(struct db_browse_info));
 
-  for (i = 0; i < ARRAY_SIZE(dbgri_cols_map); i++)
+  if (!(qp->type & Q_F_BROWSE))
     {
-      strcol = (char **) ((char *)dbgri + dbgri_cols_map[i]);
-
-      *strcol = (char *)sqlite3_column_text(qp->stmt, i);
+      DPRINTF(E_LOG, L_DB, "Not a browse query!\n");
+      return -1;
     }
 
-  return 0;
+  ret = db_query_fetch(dbbi, qp, dbbi_cols_map, ARRAY_SIZE(dbbi_cols_map));
+  if (ret < 0) {
+      DPRINTF(E_LOG, L_DB, "Failed to fetch db_browse_info\n");
+  }
+  return ret;
 }
 
 int
-db_query_fetch_count(struct query_params *qp, struct filecount_info *fci)
+db_query_fetch_count(struct filecount_info *fci, struct query_params *qp)
 {
   int ret;
 
@@ -2574,7 +2596,7 @@ db_filecount_get(struct filecount_info *fci, struct query_params *qp)
       return -1;
     }
 
-  ret = db_query_fetch_count(qp, fci);
+  ret = db_query_fetch_count(fci, qp);
   if (ret < 0)
     {
       db_query_end(qp);
@@ -2587,7 +2609,7 @@ db_filecount_get(struct filecount_info *fci, struct query_params *qp)
 }
 
 int
-db_query_fetch_string(struct query_params *qp, char **string)
+db_query_fetch_string(char **string, struct query_params *qp)
 {
   int ret;
 
@@ -2618,7 +2640,7 @@ db_query_fetch_string(struct query_params *qp, char **string)
 }
 
 int
-db_query_fetch_string_sort(struct query_params *qp, char **string, char **sortstring)
+db_query_fetch_string_sort(char **string, char **sortstring, struct query_params *qp)
 {
   int ret;
 
@@ -3841,7 +3863,7 @@ db_pl_delete_bypath(const char *path)
       return;
     }
 
-  while (((ret = db_query_fetch_pl(&qp, &dbpli)) == 0) && (dbpli.id))
+  while (((ret = db_query_fetch_pl(&dbpli, &qp)) == 0) && (dbpli.id))
     {
       if (safe_atoi32(dbpli.id, &id) != 0)
 	continue;
@@ -5097,7 +5119,7 @@ db_queue_add_by_query(struct query_params *qp, char reshuffle, uint32_t item_id,
 	goto end_transaction;
     }
 
-  while (((ret = db_query_fetch_file(qp, &dbmfi)) == 0) && (dbmfi.id))
+  while ((ret = db_query_fetch_file(&dbmfi, qp)) == 0)
     {
       ret = queue_item_add_from_file(&dbmfi, pos, queue_count, queue_version);
 
@@ -5118,6 +5140,9 @@ db_queue_add_by_query(struct query_params *qp, char reshuffle, uint32_t item_id,
       queue_count++;
     }
 
+  if (ret > 0)
+    ret = 0;
+
   db_query_end(qp);
 
   if (ret < 0)

src/db.h

@@ -409,6 +409,28 @@ struct db_media_file_info {
 
 #define dbmfi_offsetof(field) offsetof(struct db_media_file_info, field)
 
+/* Info object for generic browse queries that want more info than just
+ * the item string and sort string (e. g. for genre or compose queries
+ * that want to display the total track / album count).
+ */
+struct db_browse_info {
+  char *itemname;
+  char *itemname_sort;
+  char *track_count;
+  char *album_count;
+  char *artist_count;
+  char *song_length;
+  char *data_kind;
+  char *media_kind;
+  char *year;
+  char *date_released;
+  char *time_added;
+  char *time_played;
+  char *seek;
+};
+
+#define dbbi_offsetof(field) offsetof(struct db_browse_info, field)
+
 enum strip_type {
   STRIP_NONE,
   STRIP_PATH,
@@ -585,22 +607,25 @@ void
 db_query_end(struct query_params *qp);
 
 int
-db_query_fetch_file(struct query_params *qp, struct db_media_file_info *dbmfi);
+db_query_fetch_file(struct db_media_file_info *dbmfi, struct query_params *qp);
+
+int
+db_query_fetch_pl(struct db_playlist_info *dbpli, struct query_params *qp);
 
 int
-db_query_fetch_pl(struct query_params *qp, struct db_playlist_info *dbpli);
+db_query_fetch_group(struct db_group_info *dbgri, struct query_params *qp);
 
 int
-db_query_fetch_group(struct query_params *qp, struct db_group_info *dbgri);
+db_query_fetch_browse(struct db_browse_info *dbbi, struct query_params *qp);
 
 int
-db_query_fetch_count(struct query_params *qp, struct filecount_info *fci);
+db_query_fetch_count(struct filecount_info *fci, struct query_params *qp);
 
 int
-db_query_fetch_string(struct query_params *qp, char **string);
+db_query_fetch_string(char **string, struct query_params *qp);
 
 int
-db_query_fetch_string_sort(struct query_params *qp, char **string, char **sortstring);
+db_query_fetch_string_sort(char **string, char **sortstring, struct query_params *qp);
 
 /* Files */
 int