libopie PIM API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Source Files Todo

odatebookaccessbackend_sql.cpp

Go to the documentation of this file.

/*
 * SQL Backend for the OPIE-Calender Database.
 *
 * Copyright (c) 2003 by Stefan Eilers (Eilers.Stefan@epost.de)
 *
 * =====================================================================
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *      License as published by the Free Software Foundation; either
 *      version 2 of the License, or (at your option) any later version.
 * =====================================================================
 * =====================================================================
 * Version: $Id: odatebookaccessbackend_sql.cpp,v 1.3 2003/12/22 11:41:39 eilers Exp $
 * =====================================================================
 * History:
 * $Log: odatebookaccessbackend_sql.cpp,v $
 * Revision 1.3  2003/12/22 11:41:39  eilers
 * Fixing stupid bug, found by sourcode review..
 *
 * Revision 1.2  2003/12/22 10:19:26  eilers
 * Finishing implementation of sql-backend for datebook. But I have to
 * port the PIM datebook application to use it, before I could debug the
 * whole stuff.
 * Thus, PIM-Database backend is finished, but highly experimental. And some
 * parts are still generic. For instance, the "queryByExample()" methods are
 * not (or not fully) implemented. Todo: custom-entries not stored.
 * The big show stopper: matchRegExp() (needed by OpieSearch) needs regular
 * expression search in the database, which is not supported by sqlite !
 * Therefore we need either an extended sqlite or a workaround which would
 * be very slow and memory consuming..
 *
 * Revision 1.1  2003/12/08 15:18:12  eilers
 * Committing unfinished sql implementation before merging to libopie2 starts..
 *
 *
 */

#include <stdio.h>
#include <stdlib.h>

#include <qarray.h>
#include <qstringlist.h>

#include <qpe/global.h>

#include <opie2/osqldriver.h>
#include <opie2/osqlmanager.h>
#include <opie2/osqlquery.h>

#include "orecur.h"
#include "odatebookaccessbackend_sql.h"



ODateBookAccessBackend_SQL::ODateBookAccessBackend_SQL( const QString& ,
                                                        const QString& fileName )
    : ODateBookAccessBackend(), m_driver( NULL ) 
{
    m_fileName = fileName.isEmpty() ? Global::applicationFileName( "datebook", "datebook.db" ) : fileName;

    // Get the standart sql-driver from the OSQLManager..
    OSQLManager man;
    m_driver = man.standard();
    m_driver->setUrl( m_fileName );

    initFields();

    load();
}

ODateBookAccessBackend_SQL::~ODateBookAccessBackend_SQL() {
    if( m_driver )
        delete m_driver;
}

void ODateBookAccessBackend_SQL::initFields()
{

    // This map contains the translation of the fieldtype id's to 
    // the names of the table columns
    m_fieldMap.insert( OEvent::FUid, "uid" );
    m_fieldMap.insert( OEvent::FCategories, "Categories" );
    m_fieldMap.insert( OEvent::FDescription, "Description" );
    m_fieldMap.insert( OEvent::FLocation, "Location" );
    m_fieldMap.insert( OEvent::FType, "Type" );
    m_fieldMap.insert( OEvent::FAlarm, "Alarm" );
    m_fieldMap.insert( OEvent::FSound, "Sound" );
    m_fieldMap.insert( OEvent::FRType, "RType" );
    m_fieldMap.insert( OEvent::FRWeekdays, "RWeekdays" );
    m_fieldMap.insert( OEvent::FRPosition, "RPosition" );
    m_fieldMap.insert( OEvent::FRFreq, "RFreq" );
    m_fieldMap.insert( OEvent::FRHasEndDate, "RHasEndDate" );
    m_fieldMap.insert( OEvent::FREndDate, "REndDate" );
    m_fieldMap.insert( OEvent::FRCreated, "RCreated" );
    m_fieldMap.insert( OEvent::FRExceptions, "RExceptions" );
    m_fieldMap.insert( OEvent::FStart, "Start" );
    m_fieldMap.insert( OEvent::FEnd, "End" );
    m_fieldMap.insert( OEvent::FNote, "Note" );
    m_fieldMap.insert( OEvent::FTimeZone, "TimeZone" );
    m_fieldMap.insert( OEvent::FRecParent, "RecParent" );
    m_fieldMap.insert( OEvent::FRecChildren, "Recchildren" );

    // Create a map that maps the column name to the id
    QMapConstIterator<int, QString> it;
    for ( it = ++m_fieldMap.begin(); it != m_fieldMap.end(); ++it ){
        m_reverseFieldMap.insert( it.data(), it.key() );
    }
    
}

bool ODateBookAccessBackend_SQL::load() 
{
    if (!m_driver->open() )
        return false;

    // Don't expect that the database exists.
    // It is save here to create the table, even if it
    // do exist. ( Is that correct for all databases ?? )
    QString qu = "create table datebook( uid INTEGER PRIMARY KEY ";
    
    QMap<int, QString>::Iterator it;
    for ( it = ++m_fieldMap.begin(); it != m_fieldMap.end(); ++it ){
        qu += QString( ",%1 VARCHAR(10)" ).arg( it.data() );
    }
    qu += " );";
        
    qu += "create table custom_data( uid INTEGER, id INTEGER, type VARCHAR, priority INTEGER, value VARCHAR, PRIMARY KEY /* identifier */ (uid, id) );";

    qWarning( "command: %s", qu.latin1() );

    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );
    if ( res.state() != OSQLResult::Success )
        return false;

    update();

    return true;
}

void ODateBookAccessBackend_SQL::update()
{

    QString qu = "select uid from datebook";
    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );
    if ( res.state() != OSQLResult::Success ){
        // m_uids.clear();
        return;
    }
    
    m_uids = extractUids( res );
    
}

bool ODateBookAccessBackend_SQL::reload() 
{
    return load();
}

bool ODateBookAccessBackend_SQL::save() 
{
    return m_driver->close();  // Shouldn't m_driver->sync be better than close ? (eilers)
}

QArray<int> ODateBookAccessBackend_SQL::allRecords()const 
{
    return m_uids;
}

QArray<int> ODateBookAccessBackend_SQL::queryByExample(const OEvent&, int,  const QDateTime& ) {
    return QArray<int>();
}

void ODateBookAccessBackend_SQL::clear() 
{
    QString qu = "drop table datebook;";
    qu += "drop table custom_data;";

    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );

    reload();
}


OEvent ODateBookAccessBackend_SQL::find( int uid ) const{
    QString qu = "select *";
    qu += "from datebook where uid = " + QString::number(uid);

    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );

    OSQLResultItem resItem = res.first();

    // Create Map for date event and insert UID
    QMap<int,QString> dateEventMap;
    dateEventMap.insert( OEvent::FUid, QString::number( uid ) );

    // Now insert the data out of the columns into the map.
    QMapConstIterator<int, QString> it;
    for ( it = ++m_fieldMap.begin(); it != m_fieldMap.end(); ++it ){
        dateEventMap.insert( m_reverseFieldMap[*it], resItem.data( *it ) );
    }

    // Last step: Put map into date event and return it
    OEvent retDate( dateEventMap );

    return retDate;
}

// FIXME: Speed up update of uid's..
bool ODateBookAccessBackend_SQL::add( const OEvent& ev ) 
{
    QMap<int,QString> eventMap = ev.toMap();

    QString qu = "insert into datebook VALUES( " + QString::number( ev.uid() );
    QMap<int, QString>::Iterator it;
    for ( it = ++m_fieldMap.begin(); it != m_fieldMap.end(); ++it ){
        if ( !eventMap[it.key()].isEmpty() )
            qu += QString( ",\"%1\"" ).arg( eventMap[it.key()] );
        else
            qu += QString( ",\"\"" );
    }
    qu += " );";

    // Add custom entries
    int id = 0;
    QMap<QString, QString> customMap = ev.toExtraMap();
    for( QMap<QString, QString>::Iterator it = customMap.begin(); 
         it != customMap.end(); ++it ){
        qu  += "insert into custom_data VALUES(" 
            +  QString::number( ev.uid() )
            + ","
            +  QString::number( id++ ) 
            + ",'" 
            + it.key() //.latin1()
            + "',"
            + "0" // Priority for future enhancements
            + ",'" 
            + it.data() //.latin1()
            + "');";
    }       
    qWarning("add %s", qu.latin1() );

    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );
    if ( res.state() != OSQLResult::Success ){
        return false;
    }

    // Update list of uid's 
    update();
    
    return true;
}

// FIXME: Speed up update of uid's..
bool ODateBookAccessBackend_SQL::remove( int uid ) 
{
    QString qu = "DELETE from datebook where uid = " 
        + QString::number( uid ) + ";";
    qu += "DELETE from custom_data where uid = " 
        + QString::number( uid ) + ";";
    
    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );
    if ( res.state() != OSQLResult::Success ){
        return false;
    }

    // Update list of uid's
    update();

    return true;
}

bool ODateBookAccessBackend_SQL::replace( const OEvent& ev ) 
{
    remove( ev.uid() );
    return add( ev );
}

QArray<int> ODateBookAccessBackend_SQL::rawEvents()const 
{
    return allRecords();
}

QArray<int> ODateBookAccessBackend_SQL::rawRepeats()const 
{
    QString qu = "select uid from datebook where RType!=\"\" AND RType!=\"NoRepeat\"";
    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );
    if ( res.state() != OSQLResult::Success ){
        QArray<int> nix;
        return nix;
    }
    
    return extractUids( res );
}

QArray<int> ODateBookAccessBackend_SQL::nonRepeats()const 
{
    QString qu = "select uid from datebook where RType=\"\" or RType=\"NoRepeat\"";
    OSQLRawQuery raw( qu );
    OSQLResult res = m_driver->query( &raw );
    if ( res.state() != OSQLResult::Success ){
        QArray<int> nix;
        return nix;
    }
    
    return extractUids( res );
}

OEvent::ValueList ODateBookAccessBackend_SQL::directNonRepeats() 
{
    QArray<int> nonRepUids = nonRepeats();
    OEvent::ValueList list;

    for (uint i = 0; i < nonRepUids.count(); ++i ){
        list.append( find( nonRepUids[i] ) );
    }

    return list;

}
OEvent::ValueList ODateBookAccessBackend_SQL::directRawRepeats() 
{
    QArray<int> rawRepUids = rawRepeats();
    OEvent::ValueList list;

    for (uint i = 0; i < rawRepUids.count(); ++i ){
        list.append( find( rawRepUids[i] ) );
    }

    return list;
}


QArray<int> ODateBookAccessBackend_SQL::matchRegexp(  const QRegExp &r ) const
{
    QArray<int> null;
    return null;
}

/* ===== Private Functions ========================================== */

QArray<int> ODateBookAccessBackend_SQL::extractUids( OSQLResult& res ) const
{
    qWarning("extractUids");
    QTime t;
    t.start();
    OSQLResultItem::ValueList list = res.results();
    OSQLResultItem::ValueList::Iterator it;
    QArray<int> ints(list.count() );
    qWarning(" count = %d", list.count() );

    int i = 0;
    for (it = list.begin(); it != list.end(); ++it ) {
        ints[i] =  (*it).data("uid").toInt();
        i++;
    }
    qWarning("extractUids ready: count2 = %d needs %d ms", i, t.elapsed() );

    return ints;

}

This file is part of the documentation for OPIE Version 1.1.

Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:25:20 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001