kateconfig.cpp

Go to the documentation of this file.

/**********************************************************************
** Copyright (C) 2000 Trolltech AS.  All rights reserved.
**
** This file is part of Qtopia Environment.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/

#define QTOPIA_INTERNAL_LANGLIST
#include "kateconfig.h"

/* OPIE */
#include <opie2/odebug.h>
#include <qpe/global.h>
using namespace Opie::Core;

/* QT */
#include <qdir.h>
#include <qmessagebox.h>
#if QT_VERSION <= 230 && defined(QT_NO_CODECS)
#include <qtextcodec.h>
#endif
#include <qtextstream.h>

/* STD */
#include <sys/stat.h>
#include <sys/types.h>
#include <fcntl.h>
#include <stdlib.h>
#include <unistd.h>


QString KateConfig::configFilename(const QString& name, Domain d)
{
    switch (d) {
    case File:
        return name;
    case User: {
        QDir dir = (QString(getenv("HOME")) + "/Settings");
        if ( !dir.exists() )
        mkdir(dir.path().local8Bit(),0700);
        return dir.path() + "/" + name + ".conf";
    }
    }
    return name;
}

KateConfig::KateConfig( const QString &name, Domain domain )
    : filename( configFilename(name,domain) )
{
    owarn << "KateConfig constructor\n" << oendl;
    git = groups.end();
    read();
    QStringList l = Global::languageList();
    lang = l[0];
    glang = l[1];
}


// Sharp ROM compatibility
KateConfig::KateConfig ( const QString &name, bool what )
    : filename( configFilename(name,what ? User : File) )
{
    git = groups.end();
    read();
    QStringList l = Global::languageList();
    lang = l[0];
    glang = l[1];
}

KateConfig::~KateConfig()
{
    owarn << "KateConfig destructor\n" << oendl;
    if ( changed )
    write();
}

bool KateConfig::hasKey( const QString &key ) const
{
    if ( groups.end() == git )
    return FALSE;
    KateConfigGroup::ConstIterator it = ( *git ).find( key );
    return it != ( *git ).end();
}

void KateConfig::setGroup( const QString &gname )
{
    QMap< QString, KateConfigGroup>::Iterator it = groups.find( gname );
    if ( it == groups.end() ) {
    git = groups.insert( gname, KateConfigGroup() );
    changed = TRUE;
    return;
    }
    git = it;
}

void KateConfig::writeEntry( const QString &key, const char* value )
{
    writeEntry(key,QString(value));
}

void KateConfig::writeEntry( const QString &key, const QString &value )
{
    if ( git == groups.end() ) {
    owarn << "no group set" << oendl;
    return;
    }
    if ( (*git)[key] != value ) {
    ( *git ).insert( key, value );
    changed = TRUE;
    }
}

/*
  Note that the degree of protection offered by the encryption here is
  only sufficient to avoid the most casual observation of the configuration
  files. People with access to the files can write down the contents and
  decrypt it using this source code.

  Conceivably, and at some burden to the user, this encryption could
  be improved.
*/
static QString encipher(const QString& plain)
{
    // mainly, we make it long
    QString cipher;
    int mix=28730492;
    for (int i=0; i<(int)plain.length(); i++) {
    int u = plain[i].unicode();
    int c = u ^ mix;
    QString x = QString::number(c,36);
    cipher.append(QChar('a'+x.length()));
    cipher.append(x);
    mix *= u;
    }
    return cipher;
}

static QString decipher(const QString& cipher)
{
    QString plain;
    int mix=28730492;
    for (int i=0; i<(int)cipher.length();) {
    int l = cipher[i].unicode()-'a';
    QString x = cipher.mid(i+1,l); i+=l+1;
    int u = x.toInt(0,36) ^ mix;
    plain.append(QChar(u));
    mix *= u;
    }
    return plain;
}

void KateConfig::writeEntryCrypt( const QString &key, const QString &value )
{
    if ( git == groups.end() ) {
    owarn << "no group set" << oendl;
    return;
    }
    QString evalue = encipher(value);
    if ( (*git)[key] != evalue ) {
    ( *git ).insert( key, evalue );
    changed = TRUE;
    }
}

void KateConfig::writeEntry( const QString &key, int num )
{
    QString s;
    s.setNum( num );
    writeEntry( key, s );
}

void KateConfig::writeEntry( const QString &key, unsigned int num )
{
    QString s;
    s.setNum( num );
    writeEntry( key, s );
}

#ifdef Q_HAS_BOOL_TYPE

void KateConfig::writeEntry( const QString &key, bool b )
{
    QString s;
    s.setNum( ( int )b );
    writeEntry( key, s );
}
#endif

void KateConfig::writeEntry( const QString &key, const QStringList &lst, const QChar &sep )
{
    QString s;
    QStringList::ConstIterator it = lst.begin();
    for ( ; it != lst.end(); ++it )
    s += *it + sep;
    writeEntry( key, s );
}

void KateConfig::writeEntry( const QString &key, const QColor &val )
{
    QStringList l;
    l.append( QString().setNum(val.red()) );
    l.append( QString().setNum(val.green()) );
    l.append( QString().setNum(val.blue()) );

    writeEntry( key, l, QChar(',') );
}

void KateConfig::writeEntry( const QString &key, const QFont &val )
{
    QStringList l;
    l.append( val.family() );
    l.append( QString().setNum(val.pointSize()) );
    l.append( QString().setNum(val.weight()) );
    l.append( QString().setNum((int)val.italic()) );
    l.append( QString().setNum((int)val.charSet()) );

    writeEntry( key, l, QChar(',') );
}

void KateConfig::removeEntry( const QString &key )
{
    if ( git == groups.end() ) {
    owarn << "no group set" << oendl;
    return;
    }
    ( *git ).remove( key );
    changed = TRUE;
}

QString KateConfig::readEntry( const QString &key, const QString &deflt )
{
    QString res = readEntryDirect( key+"["+lang+"]" );
    if ( !res.isNull() )
    return res;
    if ( !glang.isEmpty() ) {
    res = readEntryDirect( key+"["+glang+"]" );
    if ( !res.isNull() )
        return res;
    }
    return readEntryDirect( key, deflt );
}

QString KateConfig::readEntryCrypt( const QString &key, const QString &deflt )
{
    QString res = readEntryDirect( key+"["+lang+"]" );
    if ( res.isNull() && glang.isEmpty() )
    res = readEntryDirect( key+"["+glang+"]" );
    if ( res.isNull() )
    res = readEntryDirect( key, QString::null );
    if ( res.isNull() )
    return deflt;
    return decipher(res);
}

QString KateConfig::readEntryDirect( const QString &key, const QString &deflt )
{
    if ( git == groups.end() ) {
    //owarn << "no group set" << oendl;
    return deflt;
    }
    KateConfigGroup::ConstIterator it = ( *git ).find( key );
    if ( it != ( *git ).end() )
    return *it;
    else
    return deflt;
}

int KateConfig::readNumEntry( const QString &key, int deflt )
{
    QString s = readEntry( key );
    if ( s.isEmpty() )
    return deflt;
    else
    return s.toInt();
}

bool KateConfig::readBoolEntry( const QString &key, bool deflt )
{
    QString s = readEntry( key );
    if ( s.isEmpty() )
    return deflt;
    else
    return (bool)s.toInt();
}

QStringList KateConfig::readListEntry( const QString &key, const QChar &sep )
{
    QString s = readEntry( key );
    if ( s.isEmpty() )
    return QStringList();
    else
    return QStringList::split( sep, s );
}

QColor KateConfig::readColorEntry( const QString &key, const QColor &def ) const
{
    QStringList list = readListEntry(key, QChar(','));
    if( list.count() != 3 )
        return def;

    return QColor(list[0].toInt(), list[1].toInt(), list[2].toInt());
}

QFont KateConfig::readFontEntry( const QString &key, const QFont &def ) const
{
    QStringList list = readListEntry(key, QChar(','));
    if( list.count() != 5 )
        return def;

    return QFont(list[0], list[1].toInt(), list[2].toInt(), (bool)list[3].toInt(), (QFont::CharSet)list[4].toInt());
}

QValueList<int> KateConfig::readIntListEntry( const QString &key ) const
{
    QString s = readEntry( key );
    QValueList<int> il;
    if ( s.isEmpty() )
    return il;

    QStringList l = QStringList::split( QChar(','), s );

    QStringList::Iterator l_it;
    for( l_it = l.begin(); l_it != l.end(); ++l_it )
        il.append( (*l_it).toInt() );
    return il;
}

void KateConfig::clearGroup()
{
    if ( git == groups.end() ) {
    owarn << "no group set" << oendl;
    return;
    }
    if ( !(*git).isEmpty() ) {
    ( *git ).clear();
    changed = TRUE;
    }
}

void KateConfig::write( const QString &fn )
{
    QString strNewFile;
    if ( !fn.isEmpty() )
    filename = fn;
    strNewFile = filename + ".new";

    QFile f( strNewFile );
    if ( !f.open( IO_WriteOnly|IO_Raw ) ) {
    owarn << "could not open for writing `" << strNewFile << "'" << oendl;
    git = groups.end();
    return;
    }

    QString str;
    QCString cstr;
    QMap< QString, KateConfigGroup >::Iterator g_it = groups.begin();

    for ( ; g_it != groups.end(); ++g_it ) {
    str += "[" + g_it.key() + "]\n";
    KateConfigGroup::Iterator e_it = ( *g_it ).begin();
    for ( ; e_it != ( *g_it ).end(); ++e_it )
        str += e_it.key() + " = " + *e_it + "\n";
    }
    cstr = str.utf8();

    int total_length;
    total_length = f.writeBlock( cstr.data(), cstr.length() );
    if ( total_length != int(cstr.length()) ) {
    QMessageBox::critical( 0, QObject::tr("Out of Space"),
                   QObject::tr("There was a problem creating\nKateConfiguration Information \nfor this program.\n\nPlease free up some space and\ntry again.") );
    f.close();
    QFile::remove( strNewFile );
    return;
    }

    f.close();
    // now rename the file...
    if ( rename( strNewFile, filename ) < 0 ) {
    owarn << "problem renaming the file " << strNewFile.latin1() << " to " << filename.latin1() << oendl;
    QFile::remove( strNewFile );
    }
}

bool KateConfig::isValid() const
{
    return groups.end() != git;
}

void KateConfig::read()
{
    changed = FALSE;

    if ( !QFileInfo( filename ).exists() ) {
    git = groups.end();
    return;
    }

    QFile f( filename );
    if ( !f.open( IO_ReadOnly ) ) {
    git = groups.end();
    return;
    }

    QTextStream s( &f );
#if QT_VERSION <= 230 && defined(QT_NO_CODECS)
    // The below should work, but doesn't in Qt 2.3.0
    s.setCodec( QTextCodec::codecForMib( 106 ) );
#else
    s.setEncoding( QTextStream::UnicodeUTF8 );
#endif

    QStringList list = QStringList::split('\n', s.read() );
    f.close();

    for ( QStringList::Iterator it = list.begin(); it != list.end(); ++it ) {
        if ( !parse( *it ) ) {
            git = groups.end();
            return;
        }
    }
}

bool KateConfig::parse( const QString &l )
{
    QString line = l.stripWhiteSpace();

    if ( line [0] == QChar ( '#' ))
        return true; // ignore comments

    if ( line[ 0 ] == QChar( '[' ) ) {
    QString gname = line;
    gname = gname.remove( 0, 1 );
    if ( gname[ (int)gname.length() - 1 ] == QChar( ']' ) )
        gname = gname.remove( gname.length() - 1, 1 );
    git = groups.insert( gname, KateConfigGroup() );
    } else if ( !line.isEmpty() ) {
    if ( git == groups.end() )
        return FALSE;
    int eq = line.find( '=' );
    if ( eq == -1 )
        return FALSE;
    QString key = line.left(eq).stripWhiteSpace();
    QString value = line.mid(eq+1).stripWhiteSpace();
    ( *git ).insert( key, value );
    }
    return TRUE;
}

---