xwords/xwords4/linux/gamesdb.c

/* -*- compile-command: "make MEMDEBUG=TRUE -j5"; -*- */
/* 
 * Copyright 2000 - 2016 by Eric House (xwords@eehouse.org).  All rights
 * reserved.
 *
 * 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.
 */

#include "gamesdb.h"
#include "gtkboard.h"
#include "gtkdraw.h"
#include "linuxutl.h"
#include "main.h"
#include "dbgutil.h"

#define SNAP_WIDTH 150
#define SNAP_HEIGHT 150
#define KEY_DB_VERSION "dbvers"

#define VERS_0_TO_1 \
        "nPending INT" \
        ",role INT" \
        ",dictlang INT" \
        ",scores TEXT" \

#define VERS_1_TO_2 \
        "created INT" \

#define VERS_2_TO_3   \
        "isoCode TEXT(8)" \

#define VERS_3_TO_4   \
        "channel INT(4)" \

#define VERS_4_TO_5  \
        "nTiles INT" \

static XP_Bool getColumnText( sqlite3_stmt *ppStmt, int iCol, XP_UCHAR* buf,
                              int* len );
static void createTables( sqlite3* pDb );
static bool gamesTableExists( sqlite3* pDb );
static void upgradeTables( sqlite3* pDb, int32_t oldVersion );
static void execNoResult( sqlite3* pDb, const gchar* query, bool errOK );


static void assertPrintResult( sqlite3* pDb, int result, int expect );

/* Versioning:
 *
 * Version 0 is defined, and not having a version code means you're 0. For
 * each subsequent version there needs to be a recipe for upgrading, whether
 * it's adding new fields or whatever.
 */

#define CUR_DB_VERSION 5

sqlite3* 
gdb_open( const char* dbName )
{
#ifdef DEBUG
    int result =
#endif
        sqlite3_initialize();
    XP_ASSERT( SQLITE_OK == result );

    sqlite3* pDb = NULL;
#ifdef DEBUG
    result =
#endif
        sqlite3_open( dbName, &pDb );
    XP_ASSERT( SQLITE_OK == result );

    if ( gamesTableExists( pDb ) ) {
        int32_t oldVersion;
        if ( !gdb_fetchInt( pDb, KEY_DB_VERSION, &oldVersion ) ) {
            oldVersion = 0;
            XP_LOGFF( "no version found; assuming %d", oldVersion );
        }
        if ( oldVersion < CUR_DB_VERSION ) {
            upgradeTables( pDb, oldVersion );
        }
    } else {
        createTables( pDb );
    }

    return pDb;
}

static void
upgradeTables( sqlite3* pDb, int32_t oldVersion )
{
    gchar* newCols = NULL;
    switch ( oldVersion ) {
    case 0:
        XP_ASSERT( 1 == CUR_DB_VERSION );
        newCols = VERS_0_TO_1;
        break;
    case 1:
        XP_ASSERT( 2 == CUR_DB_VERSION );
        newCols = VERS_1_TO_2;
        break;
    case 2:
        XP_ASSERT( 3 == CUR_DB_VERSION );
        newCols = VERS_2_TO_3;
        break;
    case 3:
        XP_ASSERT( 4 == CUR_DB_VERSION );
        newCols = VERS_3_TO_4;
        break;
    case 4:
        XP_ASSERT( 5 == CUR_DB_VERSION );
        newCols = VERS_4_TO_5;
        break;
    default:
        XP_ASSERT(0);
        break;
    }

    if ( !!newCols ) {
        gchar** strs = g_strsplit( newCols, ",", -1 );
        for ( int ii = 0; !!strs[ii]; ++ii ) {
            gchar* str = strs[ii];
            if ( 0 < strlen(str) ) {
                gchar* query = g_strdup_printf( "ALTER TABLE games ADD COLUMN %s", strs[ii] );
                XP_LOGFF( "query: \"%s\"", query );
                execNoResult( pDb, query, true );
                g_free( query );
            }
        }
        g_strfreev( strs );

        gdb_storeInt( pDb, KEY_DB_VERSION, CUR_DB_VERSION );
    }
}

static bool
gamesTableExists( sqlite3* pDb )
{
    const gchar* query = "SELECT COUNT(*) FROM sqlite_master "
        "WHERE type = 'table' AND name = 'games'";

    sqlite3_stmt *ppStmt;
    int result = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_step( ppStmt );
    XP_ASSERT( SQLITE_ROW == result );
    bool exists = 1 == sqlite3_column_int( ppStmt, 0 );
    sqlite3_finalize( ppStmt );
    LOG_RETURNF( "%s", boolToStr(exists) );
    return exists;
}

static void
createTables( sqlite3* pDb )
{
    /* This can never change! Versioning counts on it. */
    const char* createValuesStr =
        "CREATE TABLE pairs ( key TEXT UNIQUE, value TEXT )";
#ifdef DEBUG
    int result =
#endif
        sqlite3_exec( pDb, createValuesStr, NULL, NULL, NULL );
    XP_LOGFF( "sqlite3_exec(%s)=>%d", createValuesStr, result );

    const char* createGamesStr = 
        "CREATE TABLE games ( "
        "rowid INTEGER PRIMARY KEY AUTOINCREMENT"
        ",game BLOB"
        ",snap BLOB"
        ",inviteInfo BLOB"
        ",room VARCHAR(32)"     /* no longer used */
        ",connvia VARCHAR(32)"
        ",relayid VARCHAR(32)"
        ",ended INT(1)"
        ",turn INT(2)"
        ",local INT(1)"
        ",nmoves INT"
        ",seed INT"
        ",gameid INT"
        ",ntotal INT(2)"
        ",nmissing INT(2)"
        ",lastMoveTime INT"
         ",dupTimerExpires INT"
        ","VERS_0_TO_1
        ","VERS_1_TO_2
        ","VERS_2_TO_3
        ","VERS_3_TO_4
        ","VERS_4_TO_5
        // ",dupTimerExpires INT"
        ")";
    (void)sqlite3_exec( pDb, createGamesStr, NULL, NULL, NULL );

    gdb_storeInt( pDb, KEY_DB_VERSION, CUR_DB_VERSION );
}

void
gdb_close( sqlite3* pDb )
{
    sqlite3_close( pDb );
    LOG_RETURN_VOID();
}

static sqlite3_int64
writeBlobColumnData( const XP_U8* data, gsize len, XP_U16 strVersion, sqlite3* pDb,
                     sqlite3_int64 curRow, const char* column )
{
    XP_LOGFF( "(col=%s)", column );
    int result;
    char query[256];

    sqlite3_stmt* stmt = NULL;
    XP_Bool newGame = -1 == curRow;
    if ( newGame ) {         /* new row; need to insert blob first */
        const char* fmt = "INSERT INTO games (%s) VALUES (?)";
        snprintf( query, sizeof(query), fmt, column );
    } else {
        const char* fmt = "UPDATE games SET %s=? where rowid=%lld";
        snprintf( query, sizeof(query), fmt, column, curRow );
    }
    XP_LOGFF( "query: %s", query );

    result = sqlite3_prepare_v2( pDb, query, -1, &stmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_bind_zeroblob( stmt, 1 /*col 0 ??*/, sizeof(XP_U16) + len );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_step( stmt );
    if ( SQLITE_DONE != result ) {
        XP_LOGFF( "sqlite3_step => %s", sqlite3_errstr( result ) );
        XP_ASSERT(0);
    }
    XP_USE( result );

    if ( newGame ) {         /* new row; need to insert blob first */
        curRow = sqlite3_last_insert_rowid( pDb );
        XP_LOGFF( "new rowid: %lld", curRow );
    }

    sqlite3_blob* blob;
    result = sqlite3_blob_open( pDb, "main", "games", column,
                                curRow, 1 /*flags: writeable*/, &blob );
    assertPrintResult( pDb, result, SQLITE_OK );
    XP_ASSERT( strVersion <= CUR_STREAM_VERS );
    result = sqlite3_blob_write( blob, &strVersion, sizeof(strVersion), 0/*offset*/ );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_blob_write( blob, data, len, sizeof(strVersion) /* offset */ );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_blob_close( blob );
    assertPrintResult( pDb, result, SQLITE_OK );

    if ( !!stmt ) {
        sqlite3_finalize( stmt );
    }

    LOG_RETURNF( "%lld", curRow );
    return curRow;
} /* writeBlobColumnData */

static sqlite3_int64
writeBlobColumnStream( XWStreamCtxt* stream, sqlite3* pDb, sqlite3_int64 curRow,
                       const char* column )
{
    XP_U16 strVersion = stream_getVersion( stream );
    const XP_U8* data = stream_getPtr( stream );
    gsize len = stream_getSize( stream );
    return writeBlobColumnData( data, len, strVersion, pDb, curRow, column );
}

sqlite3_int64
gdb_writeNewGame( XWStreamCtxt* stream, sqlite3* pDb )
{
    sqlite3_int64 newRow = writeBlobColumnStream( stream, pDb, -1, "game" );
    return newRow;
}

void
gdb_write( XWStreamCtxt* stream, XWEnv XP_UNUSED(xwe), void* closure )
{
    CommonGlobals* cGlobals = (CommonGlobals*)closure;
    sqlite3_int64 selRow = cGlobals->rowid;
    sqlite3* pDb = cGlobals->params->pDb;

    XP_Bool newGame = -1 == selRow;
    selRow = writeBlobColumnStream( stream, pDb, selRow, "game" );

    if ( newGame ) {         /* new row; need to insert blob first */
        cGlobals->rowid = selRow;
        XP_LOGFF( "new game for id %X at row %lld", cGlobals->gi->gameID, selRow );
    } else {
        assert( selRow == cGlobals->rowid );
    }

    (*cGlobals->onSave)( cGlobals->onSaveClosure, selRow, newGame );
}

#ifdef PLATFORM_GTK
static void
addSnapshot( CommonGlobals* cGlobals )
{
    LOG_FUNC();

    BoardCtxt* board = cGlobals->game.board;
    GtkDrawCtx* dctx = (GtkDrawCtx*)(void*)board_getDraw( board );
    if ( !!dctx ) {
        addSurface( dctx, SNAP_WIDTH, SNAP_HEIGHT );
        board_drawSnapshot( board, NULL_XWE, (DrawCtx*)dctx, SNAP_WIDTH, SNAP_HEIGHT );

        XWStreamCtxt* stream = mem_stream_make_raw( MPPARM(cGlobals->util->mpool)
                                                    cGlobals->params->vtMgr );
        getImage( dctx, stream );
        removeSurface( dctx );
        cGlobals->rowid = writeBlobColumnStream( stream, cGlobals->params->pDb,
                                                 cGlobals->rowid, "snap" );
        stream_destroy( stream );
    }

    LOG_RETURN_VOID();
}
#else
# define addSnapshot( cGlobals )
#endif

void
gdb_summarize( CommonGlobals* cGlobals )
{
    const XWGame* game = &cGlobals->game;
    XP_S16 nMoves = model_getNMoves( game->model );
    XP_Bool gameOver = server_getGameIsOver( game->server );
    XP_Bool isLocal = -1;
    XP_S16 turn = server_getCurrentTurn( game->server, &isLocal );
    XP_U32 lastMoveTime = server_getLastMoveTime( game->server );
    XP_U32 dupTimerExpires = server_getDupTimerExpires( game->server );
    XP_U16 seed = 0;
    XP_S16 nMissing = 0;
    XP_U16 nPending = 0;
    const CurGameInfo* gi = cGlobals->gi;
    XP_U16 nTotal = gi->nPlayers;
    XP_U32 gameID = gi->gameID;
    XP_ASSERT( 0 != gameID );

    gchar connvia[128] = {0};

    ScoresArray scores = {0};
    if ( gameOver ) {
        model_figureFinalScores( game->model, &scores, NULL );
    } else {
        for ( int ii = 0; ii < nTotal; ++ii ) {
            scores.arr[ii] = model_getPlayerScore( game->model, ii );
        }
    }
    gchar scoreBufs[MAX_NUM_PLAYERS][64] = {0};
    gchar* arr[MAX_NUM_PLAYERS+1] = {0};
    for ( int ii = 0; ii < nTotal; ++ii ) {
        XP_SNPRINTF( scoreBufs[ii], VSIZE(scoreBufs[ii]), "%s: %d",
                     gi->players[ii].name, scores.arr[ii] );
        arr[ii] = scoreBufs[ii];
    }
    gchar* scoresStr = g_strjoinv( "; ", arr );
    XP_LOGF( "%s(): scoresStr: %s", __func__, scoresStr );

    if ( !!game->comms ) {
        nMissing = server_getMissingPlayers( game->server );
        CommsAddrRec selfAddr;
        comms_getSelfAddr( game->comms, &selfAddr );
        CommsConnType typ;
        for ( XP_U32 st = 0; addr_iter( &selfAddr, &typ, &st ); ) {
            if ( !!connvia[0] ) {
                strcat( connvia, "+" );
            }
            switch( typ) {
            case COMMS_CONN_RELAY:
                strcat( connvia, "Relay" );
                break;
            case COMMS_CONN_SMS:
                strcat( connvia, "SMS" );
                break;
            case COMMS_CONN_BT:
                strcat( connvia, "BT" );
                break;
            case COMMS_CONN_IP_DIRECT:
                strcat( connvia, "IP" );
                break;
            case COMMS_CONN_MQTT:
                strcat( connvia, "MQTT" );
                break;
            case COMMS_CONN_NFC: /* this should be filtered out!!! */
                strcat( connvia, "NFC" );
                break;
            default:
                XP_ASSERT(0);
                break;
            }
        }
        seed = comms_getChannelSeed( game->comms );
#ifdef XWFEATURE_RELAY
        XP_UCHAR relayID[32] = {0};
        XP_U16 len = VSIZE(relayID);
        (void)comms_getRelayID( game->comms, relayID, &len );
#endif

        nPending = comms_countPendingPackets( game->comms, NULL );
    } else {
        strcat( connvia, "local" );
    }

    XP_S16 nTiles = server_countTilesInPool( game->server );

    gchar* pairs[40];
    int indx = 0;
    pairs[indx++] = g_strdup_printf( "ended=%d", gameOver?1:0 );
    pairs[indx++] = g_strdup_printf( "turn=%d", turn);
    pairs[indx++] = g_strdup_printf( "local=%d", isLocal?1:0);
    pairs[indx++] = g_strdup_printf( "ntotal=%d", nTotal );
    pairs[indx++] = g_strdup_printf( "nmissing=%d", nMissing);
    pairs[indx++] = g_strdup_printf( "nmoves=%d", nMoves);
    pairs[indx++] = g_strdup_printf( "seed=%d", seed);
    pairs[indx++] = g_strdup_printf( "isoCode='%s'", gi->isoCodeStr);
    pairs[indx++] = g_strdup_printf( "gameid=%d", gameID);
    pairs[indx++] = g_strdup_printf( "connvia='%s'", connvia);
#ifdef XWFEATURE_RELAY
    pairs[indx++] = g_strdup_printf( "relayid='%s'", relayID);
#endif
    pairs[indx++] = g_strdup_printf( "lastMoveTime=%d", lastMoveTime );
    pairs[indx++] = g_strdup_printf( "dupTimerExpires=%d", dupTimerExpires);
    pairs[indx++] = g_strdup_printf( "scores='%s'", scoresStr);
    pairs[indx++] = g_strdup_printf( "nPending=%d", nPending );
    pairs[indx++] = g_strdup_printf( "role=%d", gi->serverRole);
    pairs[indx++] = g_strdup_printf( "created=%d", game->created );
    pairs[indx++] = g_strdup_printf( "channel=%d", gi->forceChannel );
    pairs[indx++] = g_strdup_printf( "nTiles=%d", nTiles );
    pairs[indx++] = NULL;
    XP_ASSERT( indx < VSIZE(pairs) );

    gchar* vals = g_strjoinv( ",", pairs );
    for ( int ii = 0; !!pairs[ii]; ++ii ) {
        g_free( pairs[ii] );
    }
    XP_ASSERT( -1 != cGlobals->rowid );
    gchar* query = g_strdup_printf( "UPDATE games SET %s WHERE rowid=%lld",
                                    vals, cGlobals->rowid );
    g_free( vals );
    XP_LOGFF( "query: %s", query );
    sqlite3_stmt* stmt = NULL;
    int result = sqlite3_prepare_v2( cGlobals->params->pDb, query, -1, &stmt, NULL );
    assertPrintResult( cGlobals->params->pDb, result, SQLITE_OK );
    result = sqlite3_step( stmt );
    if ( SQLITE_DONE != result ) {
        XP_LOGFF( "sqlite3_step=>%s", sqlite3_errstr( result ) );
        XP_ASSERT( 0 );
    }
    sqlite3_finalize( stmt );
    XP_USE( result );

    if ( !cGlobals->params->useCurses ) {
        addSnapshot( cGlobals );
    }
    g_free( scoresStr );
    g_free( query );
}

GSList*
gdb_listGames( sqlite3* pDb )
{
    GSList* list = NULL;
    
    sqlite3_stmt *ppStmt;
    int result = sqlite3_prepare_v2( pDb, 
                                     "SELECT rowid FROM games ORDER BY rowid", 
                                     -1, &ppStmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    XP_USE( result );
    while ( NULL != ppStmt ) {
        switch( sqlite3_step( ppStmt ) ) {
        case SQLITE_ROW:        /* have data */
        {
            sqlite3_int64* data = g_malloc( sizeof( *data ) );
            *data = sqlite3_column_int64( ppStmt, 0 );
            XP_LOGFF( "got a row; id=%lld", *data );
            list = g_slist_append( list, data );
        }
        break;
        case SQLITE_DONE:
            sqlite3_finalize( ppStmt );
            ppStmt = NULL;
            break;
        default:
            XP_ASSERT( 0 );
            break;
        }
    }
    return list;
}

static void
dataKiller( gpointer data )
{
    g_free( data );
}

void
gdb_freeGamesList( GSList* games )
{
    g_slist_free_full( games, dataKiller );
}

GHashTable*
gdb_getRelayIDsToRowsMap( sqlite3* pDb )
{
    GHashTable* table = g_hash_table_new( g_str_hash, g_str_equal );
    sqlite3_stmt *ppStmt;
    int result = sqlite3_prepare_v2( pDb, "SELECT relayid, rowid FROM games "
                                     "where NOT relayid = ''", -1, &ppStmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    while ( result == SQLITE_OK && NULL != ppStmt ) {
        switch( sqlite3_step( ppStmt ) ) {
        case SQLITE_ROW:        /* have data */
        {
            XP_UCHAR relayID[32];
            int len = VSIZE(relayID);
            getColumnText( ppStmt, 0, relayID, &len );
            gpointer key = g_strdup( relayID );
            sqlite3_int64* value = g_malloc( sizeof( value ) );
            *value = sqlite3_column_int64( ppStmt, 1 );
            g_hash_table_insert( table, key, value );
            /* XP_LOGF( "%s(): added map %s => %lld", __func__, (char*)key, *value ); */
        }
        break;
        case SQLITE_DONE:
            sqlite3_finalize( ppStmt );
            ppStmt = NULL;
            break;
        default:
            XP_ASSERT( 0 );
            break;
        }
    }

    return table;
}

XP_Bool
gdb_getGameInfoForRow( sqlite3* pDb, sqlite3_int64 rowid, GameInfo* gib )
{
    XP_Bool success = XP_FALSE;
    const char* fmt = "SELECT ended, turn, local, nmoves, ntotal, nmissing, "
        "isoCode, seed, connvia, gameid, lastMoveTime, dupTimerExpires, "
        "relayid, scores, nPending, nTiles, role, channel, created, snap "
        "FROM games WHERE rowid = %lld";
    XP_UCHAR query[256];
    snprintf( query, sizeof(query), fmt, rowid );

    sqlite3_stmt* ppStmt;
    int result = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_step( ppStmt );
    if ( SQLITE_ROW == result ) {
        success = XP_TRUE;
        int col = 0;
        gib->rowid = rowid;
        gib->gameOver = 1 == sqlite3_column_int( ppStmt, col++ );
        gib->turn = sqlite3_column_int( ppStmt, col++ );
        gib->turnLocal = 1 == sqlite3_column_int( ppStmt, col++ );
        gib->nMoves = sqlite3_column_int( ppStmt, col++ );
        gib->nTotal = sqlite3_column_int( ppStmt, col++ );
        gib->nMissing = sqlite3_column_int( ppStmt, col++ );
        int len = sizeof(gib->isoCode);
        getColumnText( ppStmt, col++, gib->isoCode, &len );
        gib->seed = sqlite3_column_int( ppStmt, col++ );
        len = sizeof(gib->conn);
        getColumnText( ppStmt, col++, gib->conn, &len );
        gib->gameID = sqlite3_column_int( ppStmt, col++ );
        gib->lastMoveTime = sqlite3_column_int( ppStmt, col++ );
        gib->dupTimerExpires = sqlite3_column_int( ppStmt, col++ );
        len = sizeof(gib->relayID);
        getColumnText( ppStmt, col++, gib->relayID, &len );
        len = sizeof(gib->scores);
        getColumnText( ppStmt, col++, gib->scores, &len );
        gib->nPending = sqlite3_column_int( ppStmt, col++ );
        gib->nTiles = sqlite3_column_int( ppStmt, col++ );
        gib->role = sqlite3_column_int( ppStmt, col++ );
        gib->channelNo = sqlite3_column_int( ppStmt, col++ );
        gib->created = sqlite3_column_int( ppStmt, col++ );
        snprintf( gib->name, sizeof(gib->name), "Game %lld", rowid );

#ifdef PLATFORM_GTK
        /* Load the snapshot */
        GdkPixbuf* snap = NULL;
        int snapCol = col++;
        const XP_U8* ptr = sqlite3_column_blob( ppStmt, snapCol );
        if ( !!ptr ) {
            int size = sqlite3_column_bytes( ppStmt, snapCol );
            /* Skip the version that's written in */
            ptr += sizeof(XP_U16); size -= sizeof(XP_U16);
            GInputStream* istr = g_memory_input_stream_new_from_data( ptr, size, NULL );
            snap = gdk_pixbuf_new_from_stream( istr, NULL, NULL );
            g_object_unref( istr );
        }
        gib->snap = snap;
#endif
    }
    sqlite3_finalize( ppStmt );

    return success;
}

XP_Bool
gdb_getGameInfoForGID( sqlite3* pDb, XP_U32 gameID, GameInfo* gib )
{
    sqlite3_int64 rowids[4];
    int nRowIDs = VSIZE(rowids);
    gdb_getRowsForGameID( pDb, gameID, rowids, &nRowIDs );
    return 1 == nRowIDs
        && gdb_getGameInfoForRow( pDb, rowids[0], gib );
}

void
gdb_getRowsForGameID( sqlite3* pDb, XP_U32 gameID, sqlite3_int64* rowids,
                      int* nRowIDs )
{
    int maxRowIDs = *nRowIDs;
    *nRowIDs = 0;

    char buf[256];
    snprintf( buf, sizeof(buf), "SELECT rowid from games WHERE gameid = %d "
              "LIMIT %d", gameID, maxRowIDs );
    sqlite3_stmt *ppStmt;
    int result = sqlite3_prepare_v2( pDb, buf, -1, &ppStmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    int ii;
    for ( ii = 0; ii < maxRowIDs; ++ii ) {
        result = sqlite3_step( ppStmt );
        if ( SQLITE_ROW != result ) {
            break;
        }
        rowids[ii] = sqlite3_column_int64( ppStmt, 0 );
        ++*nRowIDs;
    }
    sqlite3_finalize( ppStmt );
}

static XP_Bool
loadBlobColumn( XWStreamCtxt* stream, sqlite3* pDb, sqlite3_int64 rowid, 
                const char* column )
{
    char buf[256];
    snprintf( buf, sizeof(buf), "SELECT %s from games WHERE rowid = %lld", 
              column, rowid );

    sqlite3_stmt *ppStmt;
    int result = sqlite3_prepare_v2( pDb, buf, -1, &ppStmt, NULL );
    assertPrintResult( pDb, result, SQLITE_OK );
    result = sqlite3_step( ppStmt );
    XP_Bool success = SQLITE_ROW == result;
    if ( success ) {
        const void* ptr = sqlite3_column_blob( ppStmt, 0 );
        int size = sqlite3_column_bytes( ppStmt, 0 );
        success = 0 < size;
        if ( success ) {
            XP_U16 strVersion;
            XP_MEMCPY( &strVersion, ptr, sizeof(strVersion) );
            XP_ASSERT( strVersion <= CUR_STREAM_VERS );
            stream_setVersion( stream, strVersion );
            XP_ASSERT( size >= sizeof(strVersion) );
            stream_putBytes( stream, ptr + sizeof(strVersion), 
                             size - sizeof(strVersion) );
        }
    }
    sqlite3_finalize( ppStmt );
    return success;
}

XP_Bool
gdb_loadGame( XWStreamCtxt* stream, sqlite3* pDb, sqlite3_int64 rowid )
{
    return loadBlobColumn( stream, pDb, rowid, "game" );
}

void
gdb_deleteGame( sqlite3* pDb, sqlite3_int64 rowid )
{
    XP_ASSERT( !!pDb );
    char query[256];
    snprintf( query, sizeof(query), "DELETE FROM games WHERE rowid = %lld", rowid );
    execNoResult( pDb, query, false );
}

void
gdb_getSummary( sqlite3* pDb, DevSummary* ds )
{
    {
        const char* query = "SELECT count(rowid) FROM games WHERE "
            /* This doesn't work. I don't know what's increasing the number of
               pending messages after a game finishes. PENDING */
            // "nPending > 0 OR "
            "ended = 0";
        sqlite3_stmt* ppStmt;
        int err = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
        assertPrintResult( pDb, err, SQLITE_OK );
        err = sqlite3_step( ppStmt );
        XP_ASSERT( SQLITE_ROW == err );
        ds->allDone = 0 == sqlite3_column_int( ppStmt, 0 );
        sqlite3_finalize( ppStmt );
    }

    {
        XP_Bool allSet = XP_TRUE;
        const char* query = "SELECT nTiles FROM games";
        sqlite3_stmt* ppStmt;
        int err = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
        assertPrintResult( pDb, err, SQLITE_OK );
        for ( ; ; ) {
            err = sqlite3_step( ppStmt );
            if ( SQLITE_ROW != err ) {
                break;
            }
            int nTiles = sqlite3_column_int( ppStmt, 0 );
            allSet = allSet && 0 <= nTiles;
            ds->nTiles += nTiles;
        }
        sqlite3_finalize( ppStmt );

        if ( !allSet ) {
            ds->nTiles += -1;
        }
    }

    {
        const char* query = "SELECT count(rowid) FROM games";
        sqlite3_stmt* ppStmt;
        int err = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
        assertPrintResult( pDb, err, SQLITE_OK );
        err = sqlite3_step( ppStmt );
        XP_ASSERT( SQLITE_ROW == err );
        ds->nGames = sqlite3_column_int( ppStmt, 0 );
        sqlite3_finalize( ppStmt );
    }
}

void
gdb_store( sqlite3* pDb, const gchar* key, const gchar* value )
{
    XP_ASSERT( !!pDb );
    gchar* query =
        g_strdup_printf( "INSERT OR REPLACE INTO pairs (key, value) VALUES ('%s', '%s')",
                         key, value );
    execNoResult( pDb, query, false );
    g_free( query );
}

bool
gdb_fetchInt( sqlite3* pDb, const gchar* key, int32_t* resultP )
{
    gint buflen = 16;
    gchar buf[buflen];
    FetchResult fr = gdb_fetch( pDb, key, NULL, buf, &buflen );
    bool gotIt = SUCCESS == fr;
    if ( gotIt ) {
        buf[buflen] = '\0';
        sscanf( buf, "%x", resultP );
    }
    return gotIt;
}

void
gdb_storeInt( sqlite3* pDb, const gchar* key, int32_t val )
{
    gchar buf[32];
    snprintf( buf, VSIZE(buf), "%x", val );
    gdb_store( pDb, key, buf );

#ifdef DEBUG
    int32_t tmp;
    bool worked = gdb_fetchInt( pDb, key, &tmp );
    XP_ASSERT( worked && tmp == val );
#endif
}

static FetchResult
fetchQuery( sqlite3* pDb, const char* query, gchar* buf, gint* buflen )
{
    XP_ASSERT( !!pDb );
    FetchResult fetchRes = NOT_THERE;

    sqlite3_stmt* ppStmt;
    int sqlResult = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
    XP_Bool found = SQLITE_OK == sqlResult;
    if ( found ) {
        sqlResult = sqlite3_step( ppStmt );
        found = SQLITE_ROW == sqlResult;
        if ( found ) {
            if ( getColumnText( ppStmt, 0, buf, buflen ) ) {
                fetchRes = SUCCESS;
            } else {
                fetchRes = BUFFER_TOO_SMALL;
            }
        } else if ( !!buf ) {
            buf[0] = '\0';
        }
    }
    sqlite3_finalize( ppStmt );
    return fetchRes;
}

FetchResult
gdb_fetch( sqlite3* pDb, const gchar* key, const XP_UCHAR* keySuffix,
           gchar* buf, gint* buflen )
{
    XP_ASSERT( !!pDb );
    FetchResult fetchRes = NOT_THERE;
    char query[256];
#ifdef DEBUG
    int len =
#endif
        snprintf( query, sizeof(query),
                  "SELECT value from pairs where key = '%s'", key );
    XP_ASSERT( len < sizeof(query) );
    fetchRes = fetchQuery( pDb, query, buf, buflen );
    if ( NOT_THERE == fetchRes && NULL != keySuffix ) {
#ifdef DEBUG
        len =
#endif
            snprintf( query, sizeof(query),
                      "SELECT value from pairs where key LIKE '%%%s'", keySuffix );
        XP_ASSERT( len < sizeof(query) );
        fetchRes = fetchQuery( pDb, query, buf, buflen );

        /* Let's rewrite it using the correct key so this code can eventually
           go away */
        if ( SUCCESS == fetchRes ) {
            gdb_store( pDb, key, buf );
        }
    }

    return fetchRes;
}

XP_Bool
gdb_fetch_safe( sqlite3* pDb, const gchar* key, const gchar* keySuffix,
                gchar* buf, gint buflen )
{
    XP_ASSERT( !!pDb );
    int tmp = buflen;
    FetchResult result = gdb_fetch( pDb, key, keySuffix, buf, &tmp );
    XP_ASSERT( result != BUFFER_TOO_SMALL );
    return SUCCESS == result;
}

void
gdb_remove( sqlite3* pDb, const gchar* key )
{
    XP_ASSERT( !!pDb );
    char query[256];
    snprintf( query, sizeof(query), "DELETE FROM pairs WHERE key = '%s'", key );
    execNoResult( pDb, query, false );
}

static XP_Bool
getColumnText( sqlite3_stmt *ppStmt, int iCol, XP_UCHAR* buf, int *len )
{
    int colLen = sqlite3_column_bytes( ppStmt, iCol );

    XP_Bool success = colLen < *len;
    *len = colLen + 1;          /* sqlite does not store the null byte */
    if ( success ) {
        const unsigned char* colTxt = sqlite3_column_text( ppStmt, iCol );
        XP_MEMCPY( buf, colTxt, colLen );
        buf[colLen] = '\0';
    }
    return success;
}

static void
execNoResult( sqlite3* pDb, const gchar* query, bool errOk )
{
    sqlite3_stmt *ppStmt;
    int result = sqlite3_prepare_v2( pDb, query, -1, &ppStmt, NULL );
    if ( ! errOk ) {
        assertPrintResult( pDb, result, SQLITE_OK );
    }
    result = sqlite3_step( ppStmt );
    if ( ! errOk ) {
        assertPrintResult( pDb, result, SQLITE_DONE );
    }
    sqlite3_finalize( ppStmt );
}

static void
assertPrintResult( sqlite3* pDb, int result, int expect )
{
    int code = sqlite3_errcode( pDb );
    if ( code != result ) {
        XP_LOGFF( "ERROR??? code %d (%s) != result %d (%s)", code, sqlite3_errstr(code),
                  result, sqlite3_errstr(result) );
    }
    if ( result != expect ) {
        XP_LOGFF( "sqlite3 error: %d (%s)", result, sqlite3_errstr(result) );
        XP_LOGFF( "Err msg (which could be out-of-sync): %s", sqlite3_errmsg( pDb ) );
        XP_ASSERT(0);
    }
}