/* * $Id$ * sqlite2-specific db implementation * * Copyright (C) 2005 Ron Pedde (ron@pedde.com) * * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* * This file handles sqlite3 databases. SQLite3 databases * should have a dsn of: * * sqlite3:/path/to/folder * * The actual db will be appended to the passed path. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #define _XOPEN_SOURCE 500 #include #include #include #include #include #include #include #ifdef HAVE_UNISTD_H # include #endif #include "err.h" #include "db-generic.h" #include "db-sql.h" #include "db-sql-sqlite3.h" #ifndef TRUE # define TRUE 1 # define FALSE 0 #endif /* Globals */ static sqlite3 *db_sqlite3_songs; /**< Database that holds the mp3 info */ static pthread_mutex_t db_sqlite3_mutex = PTHREAD_MUTEX_INITIALIZER; /**< sqlite not reentrant */ static sqlite3_stmt *db_sqlite3_stmt; static int db_sqlite3_reload=0; static char *db_sqlite3_enum_query=NULL; static char **db_sqlite3_row = NULL; static char db_sqlite3_path[PATH_MAX + 1]; #define DB_SQLITE3_VERSION 11 /* Forwards */ void db_sqlite3_lock(void); void db_sqlite3_unlock(void); extern char *db_sqlite3_initial1; extern char *db_sqlite3_initial2; int db_sqlite3_enum_begin_helper(char **pe); /** * lock the db_mutex */ void db_sqlite3_lock(void) { int err; if((err=pthread_mutex_lock(&db_sqlite3_mutex))) { DPRINTF(E_FATAL,L_DB,"cannot lock sqlite lock: %s\n",strerror(err)); } } /** * unlock the db_mutex */ void db_sqlite3_unlock(void) { int err; if((err=pthread_mutex_unlock(&db_sqlite3_mutex))) { DPRINTF(E_FATAL,L_DB,"cannot unlock sqlite3 lock: %s\n",strerror(err)); } } /** * */ char *db_sqlite3_vmquery(char *fmt,va_list ap) { return sqlite3_vmprintf(fmt,ap); } /** * */ void db_sqlite3_vmfree(char *query) { sqlite3_free(query); } /** * open a sqlite3 database * * @param dsn the full dns to the database * (sqlite3:/path/to/database) * * @returns DB_E_SUCCESS on success */ int db_sqlite3_open(char **pe, char *dsn) { int ver; int err; snprintf(db_sqlite3_path,sizeof(db_sqlite3_path),"%s/songs3.db",dsn); db_sqlite3_lock(); if(sqlite3_open(db_sqlite3_path,&db_sqlite3_songs) != SQLITE_OK) { db_get_error(pe,DB_E_SQL_ERROR,sqlite3_errmsg(db_sqlite3_songs)); DPRINTF(E_LOG,L_DB,"db_sqlite3_open: %s (%s)\n",pe ? *pe : "Unknown", db_sqlite3_path); db_sqlite3_unlock(); return DB_E_SQL_ERROR; } sqlite3_busy_timeout(db_sqlite3_songs,30000); /* 30 seconds */ db_sqlite3_unlock(); err = db_sql_fetch_int(pe,&ver,"select value from config where " "term='version'"); if(err != DB_E_SUCCESS) { if(pe) { free(*pe); } /* we'll catch this on the init */ DPRINTF(E_LOG,L_DB,"Can't get db version. New database?\n"); } else if(ver != DB_SQLITE3_VERSION) { DPRINTF(E_LOG,L_DB,"Old database version.\n"); db_get_error(pe,DB_E_WRONGVERSION); return DB_E_WRONGVERSION; } return DB_E_SUCCESS; } /** * close the database */ int db_sqlite3_close(void) { db_sqlite3_lock(); sqlite3_close(db_sqlite3_songs); db_sqlite3_unlock(); return DB_E_SUCCESS; } /** * execute a throwaway query against the database, disregarding * the outcome * * @param pe db error structure * @param loglevel error level to return if the query fails * @param fmt sprintf-style arguements * * @returns DB_E_SUCCESS on success */ int db_sqlite3_exec(char **pe, int loglevel, char *fmt, ...) { va_list ap; char *query; int err; char *perr; db_sqlite3_lock(); va_start(ap,fmt); query=sqlite3_vmprintf(fmt,ap); va_end(ap); DPRINTF(E_DBG,L_DB,"Executing: %s\n",query); err=sqlite3_exec(db_sqlite3_songs,query,NULL,NULL,&perr); if(err != SQLITE_OK) { db_get_error(pe,DB_E_SQL_ERROR,perr); DPRINTF(loglevel == E_FATAL ? E_LOG : loglevel,L_DB,"Query: %s\n", query); DPRINTF(loglevel,L_DB,"Error: %s\n",perr); sqlite3_free(perr); } else { DPRINTF(E_DBG,L_DB,"Rows: %d\n",sqlite3_changes(db_sqlite3_songs)); } sqlite3_free(query); db_sqlite3_unlock(); if(err != SQLITE_OK) return DB_E_SQL_ERROR; return DB_E_SUCCESS; } /** * start enumerating rows in a select */ int db_sqlite3_enum_begin(char **pe, char *fmt, ...) { va_list ap; db_sqlite3_lock(); va_start(ap, fmt); db_sqlite3_enum_query = sqlite3_vmprintf(fmt,ap); va_end(ap); return db_sqlite3_enum_begin_helper(pe); } int db_sqlite3_enum_begin_helper(char **pe) { int err; const char *ptail; if(!db_sqlite3_enum_query) *((int*)NULL) = 1; DPRINTF(E_DBG,L_DB,"Executing: %s\n",db_sqlite3_enum_query); err=sqlite3_prepare(db_sqlite3_songs,db_sqlite3_enum_query,-1, &db_sqlite3_stmt,&ptail); if(err != SQLITE_OK) { db_get_error(pe,DB_E_SQL_ERROR,sqlite3_errmsg(db_sqlite3_songs)); db_sqlite3_unlock(); sqlite3_free(db_sqlite3_enum_query); db_sqlite3_enum_query=NULL; return DB_E_SQL_ERROR; } /* otherwise, we leave the db locked while we walk through the enums */ if(db_sqlite3_row) free(db_sqlite3_row); db_sqlite3_row=NULL; return DB_E_SUCCESS; } /** * fetch the next row. This will return DB_E_SUCCESS if it got a * row, or it's done. If it's done, the row will be empty, otherwise * it will be full of data. Either way, if fetch fails, you must close. * * @param pe error string, if result isn't DB_E_SUCCESS * @param pr pointer to a row struct * * @returns DB_E_SUCCESS with *pr=NULL when end of table, * DB_E_SUCCESS with a valid row when more data, * DB_E_* on error */ int db_sqlite3_enum_fetch(char **pe, SQL_ROW *pr) { int err; int cols; int idx; int counter=10; if(!db_sqlite3_enum_query) *((int*)NULL) = 1; while(counter--) { err=sqlite3_step(db_sqlite3_stmt); if(err != SQLITE_BUSY) break; usleep(100); } if(err == SQLITE_DONE) { *pr = NULL; if(db_sqlite3_row) free(db_sqlite3_row); db_sqlite3_row = NULL; return DB_E_SUCCESS; } if(err == SQLITE_ROW) { cols = sqlite3_column_count(db_sqlite3_stmt); if(!db_sqlite3_row) { /* gotta alloc space */ db_sqlite3_row = (char**)malloc((sizeof(char*)) * cols); if(!db_sqlite3_row) DPRINTF(E_FATAL,L_DB,"Malloc error\n"); } for(idx=0; idx < cols; idx++) { db_sqlite3_row[idx] = (char*) sqlite3_column_blob(db_sqlite3_stmt,idx); } *pr = db_sqlite3_row; return DB_E_SUCCESS; } if(db_sqlite3_row) free(db_sqlite3_row); db_sqlite3_row = NULL; db_get_error(pe,DB_E_SQL_ERROR,sqlite3_errmsg(db_sqlite3_songs)); sqlite3_finalize(db_sqlite3_stmt); return DB_E_SQL_ERROR; } /** * end the db enumeration */ int db_sqlite3_enum_end(char **pe) { int err; if(!db_sqlite3_enum_query) *((int*)NULL) = 1; if(db_sqlite3_row) free(db_sqlite3_row); db_sqlite3_row = NULL; sqlite3_free(db_sqlite3_enum_query); db_sqlite3_enum_query = NULL; err = sqlite3_finalize(db_sqlite3_stmt); if(err != SQLITE_OK) { db_get_error(pe,DB_E_SQL_ERROR,sqlite3_errmsg(db_sqlite3_songs)); db_sqlite3_unlock(); return DB_E_SQL_ERROR; } db_sqlite3_unlock(); return DB_E_SUCCESS; } /** * restart the enumeration */ int db_sqlite3_enum_restart(char **pe) { return db_sqlite3_enum_begin_helper(pe); } int db_sqlite3_event(int event_type) { switch(event_type) { case DB_SQL_EVENT_STARTUP: /* this is a startup with existing songs */ db_sqlite3_exec(NULL,E_FATAL,"vacuum"); db_sqlite3_exec(NULL,E_DBG,"create index idx_path on " "songs(path,idx)"); db_sqlite3_exec(NULL,E_DBG,"create index idx_songid on " "playlistitems(songid)"); db_sqlite3_exec(NULL,E_DBG,"create index idx_playlistid on " "playlistitems(playlistid,songid)"); db_sqlite3_reload=0; break; case DB_SQL_EVENT_FULLRELOAD: /* either a fresh load or force load */ db_sqlite3_exec(NULL,E_DBG,"drop index idx_path"); db_sqlite3_exec(NULL,E_DBG,"drop index idx_songid"); db_sqlite3_exec(NULL,E_DBG,"drop index idx_playlistid"); db_sqlite3_exec(NULL,E_DBG,"drop table songs"); // db_sqlite3_exec(NULL,E_DBG,"drop table playlists"); db_sqlite3_exec(NULL,E_DBG,"delete from playlists where not type=1"); db_sqlite3_exec(NULL,E_DBG,"drop table playlistitems"); db_sqlite3_exec(NULL,E_DBG,"drop table config"); db_sqlite3_exec(NULL,E_DBG,"vacuum"); db_sqlite3_exec(NULL,E_DBG,db_sqlite3_initial1); db_sqlite3_exec(NULL,E_DBG,db_sqlite3_initial2); db_sqlite3_reload=1; break; case DB_SQL_EVENT_SONGSCANSTART: if(db_sqlite3_reload) { db_sqlite3_exec(NULL,E_FATAL,"begin transaction"); db_sqlite3_exec(NULL,E_FATAL,"pragma synchronous = off"); } else { db_sqlite3_exec(NULL,E_DBG,"drop table updated"); db_sqlite3_exec(NULL,E_FATAL,"create temp table updated (id int)"); db_sqlite3_exec(NULL,E_DBG,"drop table plupdated"); db_sqlite3_exec(NULL,E_FATAL,"create temp table plupdated(id int)"); } break; case DB_SQL_EVENT_SONGSCANEND: if(db_sqlite3_reload) { db_sqlite3_exec(NULL,E_FATAL,"pragma synchronous = normal"); db_sqlite3_exec(NULL,E_FATAL,"commit transaction"); db_sqlite3_exec(NULL,E_FATAL,"create index idx_path on songs(path,idx)"); db_sqlite3_exec(NULL,E_DBG,"delete from config where term='rescan'"); } break; case DB_SQL_EVENT_PLSCANSTART: db_sqlite3_exec(NULL,E_FATAL,"begin transaction"); db_sqlite3_exec(NULL,E_FATAL,"pragma synchronous = off"); break; case DB_SQL_EVENT_PLSCANEND: db_sqlite3_exec(NULL,E_FATAL,"pragma synchronous=normal"); db_sqlite3_exec(NULL,E_FATAL,"end transaction"); if(db_sqlite3_reload) { db_sqlite3_exec(NULL,E_FATAL,"create index idx_songid on playlistitems(songid)"); db_sqlite3_exec(NULL,E_FATAL,"create index idx_playlistid on playlistitems(playlistid,songid)"); } else { db_sqlite3_exec(NULL,E_FATAL,"delete from songs where id not in (select id from updated)"); db_sqlite3_exec(NULL,E_FATAL,"update songs set force_update=0"); db_sqlite3_exec(NULL,E_FATAL,"drop table updated"); db_sqlite3_exec(NULL,E_FATAL,"delete from playlists where " "((type=%d) OR (type=%d)) and " "id not in (select id from plupdated)", PL_STATICFILE,PL_STATICXML); db_sqlite3_exec(NULL,E_FATAL,"delete from playlistitems where " "playlistid not in (select distinct " "id from playlists)"); db_sqlite3_exec(NULL,E_FATAL,"drop table plupdated"); } db_sqlite3_reload=0; break; default: break; } return DB_E_SUCCESS; } /** * get the id of the last auto_update inserted item * * @returns autoupdate value */ int db_sqlite3_insert_id(void) { int result; db_sqlite3_lock(); result = (int)sqlite3_last_insert_rowid(db_sqlite3_songs); db_sqlite3_unlock(); return result; } char *db_sqlite3_initial1 = "create table songs (\n" " id INTEGER PRIMARY KEY NOT NULL,\n" " path VARCHAR(4096) NOT NULL,\n" " fname VARCHAR(255) NOT NULL,\n" " title VARCHAR(1024) DEFAULT NULL,\n" " artist VARCHAR(1024) DEFAULT NULL,\n" " album VARCHAR(1024) DEFAULT NULL,\n" " genre VARCHAR(255) DEFAULT NULL,\n" " comment VARCHAR(4096) DEFAULT NULL,\n" " type VARCHAR(255) DEFAULT NULL,\n" " composer VARCHAR(1024) DEFAULT NULL,\n" " orchestra VARCHAR(1024) DEFAULT NULL,\n" " conductor VARCHAR(1024) DEFAULT NULL,\n" " grouping VARCHAR(1024) DEFAULT NULL,\n" " url VARCHAR(1024) DEFAULT NULL,\n" " bitrate INTEGER DEFAULT 0,\n" " samplerate INTEGER DEFAULT 0,\n" " song_length INTEGER DEFAULT 0,\n" " file_size INTEGER DEFAULT 0,\n" " year INTEGER DEFAULT 0,\n" " track INTEGER DEFAULT 0,\n" " total_tracks INTEGER DEFAULT 0,\n" " disc INTEGER DEFAULT 0,\n" " total_discs INTEGER DEFAULT 0,\n" " bpm INTEGER DEFAULT 0,\n" " compilation INTEGER DEFAULT 0,\n" " rating INTEGER DEFAULT 0,\n" " play_count INTEGER DEFAULT 0,\n" " data_kind INTEGER DEFAULT 0,\n" " item_kind INTEGER DEFAULT 0,\n" " description INTEGER DEFAULT 0,\n" " time_added INTEGER DEFAULT 0,\n" " time_modified INTEGER DEFAULT 0,\n" " time_played INTEGER DEFAULT 0,\n" " db_timestamp INTEGER DEFAULT 0,\n" " disabled INTEGER DEFAULT 0,\n" " sample_count INTEGER DEFAULT 0,\n" " force_update INTEGER DEFAULT 0,\n" " codectype VARCHAR(5) DEFAULT NULL,\n" " idx INTEGER NOT NULL,\n" " has_video INTEGER DEFAULT 0,\n" " contentrating INTEGER DEFAULT 0\n" ");\n" "create table playlistitems (\n" " id INTEGER PRIMARY KEY NOT NULL,\n" " playlistid INTEGER NOT NULL,\n" " songid INTEGER NOT NULL\n" ");\n" "create table config (\n" " term VARCHAR(255) NOT NULL,\n" " subterm VARCHAR(255) DEFAULT NULL,\n" " value VARCHAR(1024) NOT NULL\n" ");\n" "insert into config values ('version','','11');\n"; char *db_sqlite3_initial2 = "create table playlists (\n" " id INTEGER PRIMARY KEY NOT NULL,\n" " title VARCHAR(255) NOT NULL,\n" " type INTEGER NOT NULL,\n" " items INTEGER NOT NULL,\n" " query VARCHAR(1024),\n" " db_timestamp INTEGER NOT NULL,\n" " path VARCHAR(4096),\n" " idx INTEGER NOT NULL\n" ");\n" "insert into playlists values (1,'Library',1,0,'1',0,'',0);\n";