| -rw-r--r-- | library/config.cpp | 164 |
1 files changed, 163 insertions, 1 deletions
diff --git a/library/config.cpp b/library/config.cpp index 664ca34..61ff089 100644 --- a/library/config.cpp +++ b/library/config.cpp @@ -1,194 +1,194 @@ /********************************************************************** -** Copyright (C) 2000 Trolltech AS. All rights reserved. +** Copyright (C) 2000,2004 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. ** **********************************************************************/ #include <qdir.h> #include <qmessagebox.h> #if QT_VERSION <= 230 && defined(QT_NO_CODECS) #include <qtextcodec.h> #endif #include <qtextstream.h> #include <sys/stat.h> #include <sys/types.h> #include <fcntl.h> #include <stdlib.h> #include <unistd.h> #define QTOPIA_INTERNAL_LANGLIST #include "config.h" #include "global.h" /*! \internal */ QString Config::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; } /*! \class Config config.h \brief The Config class provides for saving application cofniguration state. You should keep a Config in existence only while you do not want others to be able to change the state. There is no locking currently, but there may be in the future. */ /*! \enum Config::ConfigGroup \internal */ /*! \enum Config::Domain \value File \value User See Config for details. */ /*! Constructs a config that will load or create a configuration with the given \a name in the given \a domain. You must call setGroup() before doing much else with the Config. In the default Domain, \e User, the configuration is user-specific. \a name should not contain "/" in this case, and in general should be the name of the C++ class that is primarily responsible for maintaining the configuration. In the File Domain, \a name is an absolute filename. */ Config::Config( const QString &name, Domain domain ) : filename( configFilename(name,domain) ) { git = groups.end(); read(); QStringList l = Global::languageList(); lang = l[0]; glang = l[1]; } // Sharp ROM compatibility Config::Config ( 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]; } /*! Writes any changes to disk and destroys the in-memory object. */ Config::~Config() { if ( changed ) write(); } /*! Returns whether the current group has an entry called \a key. */ bool Config::hasKey( const QString &key ) const { if ( groups.end() == git ) return FALSE; ConfigGroup::ConstIterator it = ( *git ).find( key ); return it != ( *git ).end(); } /*! Sets the current group for subsequent reading and writing of entries to \a gname. Grouping allows the application to partition the namespace. This function must be called prior to any reading or writing of entries. The \a gname must not be empty. */ void Config::setGroup( const QString &gname ) { QMap< QString, ConfigGroup>::Iterator it = groups.find( gname ); if ( it == groups.end() ) { git = groups.insert( gname, ConfigGroup() ); changed = TRUE; return; } git = it; } /*! Writes a (\a key, \a value) entry to the current group. \sa readEntry() */ void Config::writeEntry( const QString &key, const char* value ) { writeEntry(key,QString(value)); } /*! Writes a (\a key, \a value) entry to the current group. \sa readEntry() */ void Config::writeEntry( const QString &key, const QString &value ) { if ( git == groups.end() ) { qWarning( "no group set" ); 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; @@ -389,192 +389,354 @@ int Config::readNumEntry( const QString &key, int deflt ) { QString s = readEntry( key ); if ( s.isEmpty() ) return deflt; else return s.toInt(); } /*! \fn bool Config::readBoolEntry( const QString &key, bool deflt ) const Reads a bool entry stored with \a key, defaulting to \a deflt if there is no entry. */ /*! \internal For compatibility, non-const version. */ bool Config::readBoolEntry( const QString &key, bool deflt ) { QString s = readEntry( key ); if ( s.isEmpty() ) return deflt; else return (bool)s.toInt(); } /*! \fn QStringList Config::readListEntry( const QString &key, const QChar &sep ) const Reads a string list entry stored with \a key, and with \a sep as the separator. */ /*! \internal For compatibility, non-const version. */ QStringList Config::readListEntry( const QString &key, const QChar &sep ) { QString s = readEntry( key ); if ( s.isEmpty() ) return QStringList(); else return QStringList::split( sep, s ); } /*! Removes all entries from the current group. */ void Config::clearGroup() { if ( git == groups.end() ) { qWarning( "no group set" ); return; } if ( !(*git).isEmpty() ) { ( *git ).clear(); changed = TRUE; } } /*! \internal */ void Config::write( const QString &fn ) { QString strNewFile; if ( !fn.isEmpty() ) filename = fn; strNewFile = filename + ".new"; QFile f( strNewFile ); if ( !f.open( IO_WriteOnly|IO_Raw ) ) { qWarning( "could not open for writing `%s'", strNewFile.latin1() ); git = groups.end(); return; } QString str; QCString cstr; QMap< QString, ConfigGroup >::Iterator g_it = groups.begin(); for ( ; g_it != groups.end(); ++g_it ) { str += "[" + g_it.key() + "]\n"; ConfigGroup::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\nConfiguration 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 ) { qWarning( "problem renaming the file %s to %s", strNewFile.latin1(), filename.latin1() ); QFile::remove( strNewFile ); } } /*! Returns whether the Config is in a valid state. */ bool Config::isValid() const { return groups.end() != git; } /*! \internal */ void Config::read() { changed = FALSE; if ( !QFileInfo( filename ).exists() ) { git = groups.end(); return; } QFile f( filename ); if ( !f.open( IO_ReadOnly ) ) { git = groups.end(); return; } // hack to avoid problems if big files are passed to test // if they are valid configs ( like passing a mp3 ... ) // I just hope that there are no conf files > 100000 byte // not the best solution, find something else later if ( f.getch()!='[' ||f.size() > 100000 ) { git = groups.end(); return; } f.ungetch('['); 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; } } } /*! \internal */ bool Config::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, ConfigGroup() ); } 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; } + + + +bool Config::hasGroup( const QString& name )const { + return ( groups. find ( name ) != groups. end ( )); +}; + +QStringList Config::groupList()const { + QStringList sl; + for ( ConfigGroupMap::ConstIterator it = groups. begin ( ); it != groups. end ( ); ++it ) + sl << it.key(); + + return sl; +}; + +///////////// +// Qtopia 2.1 Functions +// +//////////// + +QStringList Config::allGroups()const { + return groupList(); +} + +/*! + Returns the time stamp for the config identified by \a name. The + time stamp represents the time the config was last committed to storage. + Returns 0 if there is no time stamp available for the config. + + A \a domain can optionally be specified and defaults to User. + See \l{Config()} for details. + + First availability: Qtopia 2.0 +*/ +long Config::timeStamp(const QString& name, Domain domain) +{ +#ifdef Q_WS_WIN + // Too slow (many conversions too and from time_t and QDataTime) + QDateTime epoch; + epoch.setTime_t(0); + return epoch.secsTo(QFileInfo(Config::configFilename(name,domain)).lastModified()); +#else + QString fn = Config::configFilename(name,domain); + struct stat b; + if (lstat( QFile::encodeName(fn).data(), &b ) == 0) + return b.st_mtime; + else + return 0; +#endif +} + + +/*! + Removes the current group (and all its entries). + + The current group becomes unset. + + First availability: Qtopia 2.0 +*/ +void Config::removeGroup() +{ + if ( git == groups.end() ) { + qWarning( "no group set" ); + return; + } + + groups.remove(git.key()); + git = groups.end(); + changed = TRUE; +} + +/*! + Removes the current group (and all its entries). + + The current group becomes unset. + + First availability: Qtopia 2.0 +*/ +void Config::removeGroup(const QString& g) +{ + groups.remove(g); + git = groups.end(); +} + + + +/*! + Writes a (\a key, \a lst) entry to the current group. + + The list is + separated by the two characters "^e", and "^" withing the strings + is replaced by "^^", such that the strings may contain any character, + including "^". + + Null strings are also allowed, and are recorded as "^0" in the string. + + First availability: Qtopia 2.0 + + \sa readListEntry() +*/ +void Config::writeEntry( const QString &key, const QStringList &lst ) +{ + QString s; + for (QStringList::ConstIterator it=lst.begin(); it!=lst.end(); ++it) { + QString el = *it; + if ( el.isNull() ) { + el = "^0"; + } else { + el.replace(QRegExp("\\^"), "^^"); + } + s+=el; + s+="^e"; // end of element + } + writeEntry(key, s); +} + +/*! + Returns the string list entry stored using \a key and with + the escaped seperator convention described in writeListEntry(). + + First availability: Qtopia 2.0 +*/ +QStringList Config::readListEntry( const QString &key ) const +{ + QString value = readEntry( key, QString::null ); + QStringList l; + QString s; + bool esc=FALSE; + for (int i=0; i<(int)value.length(); i++) { + if ( esc ) { + if ( value[i] == 'e' ) { // end-of-string + l.append(s); + s=""; + } else if ( value[i] == '0' ) { // null string + s=QString::null; + } else { + s.append(value[i]); + } + esc = FALSE; + } else if ( value[i] == '^' ) { + esc = TRUE; + } else { + s.append(value[i]); + if ( i == (int)value.length()-1 ) + l.append(s); + } + } + return l; +} + +QString Config::readEntry( const QString &key, const QString &deflt ) const +{ return ((Config*)this)->readEntry(key,deflt); } +QString Config::readEntryCrypt( const QString &key, const QString &deflt ) const +{ return ((Config*)this)->readEntryCrypt(key,deflt); } +QString Config::readEntryDirect( const QString &key, const QString &deflt ) const +{ return ((Config*)this)->readEntryDirect(key,deflt); } +int Config::readNumEntry( const QString &key, int deflt ) const +{ return ((Config*)this)->readNumEntry(key,deflt); } +bool Config::readBoolEntry( const QString &key, bool deflt ) const +{ return ((Config*)this)->readBoolEntry(key,deflt); } +QStringList Config::readListEntry( const QString &key, const QChar &sep ) const +{ return ((Config*)this)->readListEntry(key,sep); } |