kconf_update/kconf_update.cpp

   1 /*
   2  *
   3  *  This file is part of the KDE libraries
   4  *  Copyright (c) 2001 Waldo Bastian <bastian@kde.org>
   5  *
   6  *  This library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Library General Public
   8  *  License version 2 as published by the Free Software Foundation.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Library General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Library General Public License
  16  *  along with this library; see the file COPYING.LIB.  If not, write to
  17  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  *  Boston, MA 02110-1301, USA.
  19  **/
  20
  21 #include <sys/types.h>
  22 #include <sys/stat.h>
  23 #include <unistd.h>
  24 #include <stdlib.h>
  25 #include <kde_file.h>
  26
  27 #include <QtCore/QDate>
  28 #include <QtCore/QFile>
  29 #include <QtCore/QTextStream>
  30 #include <QtCore/QTextCodec>
  31
  32 #include <kconfig.h>
  33 #include <kconfiggroup.h>
  34 #include <klocale.h>
  35 #include <kcmdlineargs.h>
  36 #include <kglobal.h>
  37 #include <kstandarddirs.h>
  38 #include <kaboutdata.h>
  39 #include <kcomponentdata.h>
  40 #include <ktemporaryfile.h>
  41 #include <kurl.h>
  42
  43 class KonfUpdate
  44 {
  45 public:
  46    KonfUpdate();
  47    ~KonfUpdate();
  48    QStringList findUpdateFiles(bool dirtyOnly);
  49
  50    QTextStream &log();
  51
  52    bool checkFile(const QString &filename);
  53    void checkGotFile(const QString &_file, const QString &id);
  54
  55    bool updateFile(const QString &filename);
  56
  57    void gotId(const QString &_id);
  58    void gotFile(const QString &_file);
  59    void gotGroup(const QString &_group);
  60    void gotRemoveGroup(const QString &_group);
  61    void gotKey(const QString &_key);
  62    void gotRemoveKey(const QString &_key);
  63    void gotAllKeys();
  64    void gotAllGroups();
  65    void gotOptions(const QString &_options);
  66    void gotScript(const QString &_script);
  67    void gotScriptArguments(const QString &_arguments);
  68    void resetOptions();
  69
  70    void copyGroup(KConfig *cfg1, const QString &group1,
  71                   KConfig *cfg2, const QString &group2);
  72
  73 protected:
  74    KConfig *config;
  75    QString currentFilename;
  76    bool skip;
  77    bool skipFile;
  78    bool debug;
  79    QString id;
  80
  81    QString oldFile;
  82    QString newFile;
  83    QString newFileName;
  84    KConfig *oldConfig1; // Config to read keys from.
  85    KConfig *oldConfig2; // Config to delete keys from.
  86    KConfig *newConfig;
  87
  88    QString oldGroup;
  89    QString newGroup;
  90    QString oldKey;
  91    QString newKey;
  92
  93    bool m_bCopy;
  94    bool m_bOverwrite;
  95    bool m_bUseConfigInfo;
  96    QString m_arguments;
  97    QTextStream *m_textStream;
  98    QFile *m_file;
  99    QString m_line;
 100    int m_lineCount;
 101 };
 102
 103 KonfUpdate::KonfUpdate()
 104  : m_textStream(0), m_file(0)
 105 {
 106    bool updateAll = false;
 107    oldConfig1 = 0;
 108    oldConfig2 = 0;
 109    newConfig = 0;
 110
 111    config = new KConfig("kconf_updaterc");
 112    KConfigGroup cg(config, QString());
 113
 114    QStringList updateFiles;
 115    KCmdLineArgs *args=KCmdLineArgs::parsedArgs();
 116
 117    debug = args->isSet("debug");
 118
 119    m_bUseConfigInfo = false;
 120    if (args->isSet("check"))
 121    {
 122       m_bUseConfigInfo = true;
 123       QString file = KStandardDirs::locate("data", "kconf_update/"+args->getOption("check"));
 124       if (file.isEmpty())
 125       {
 126          qWarning("File '%s' not found.", args->getOption("check").toLocal8Bit().data());
 127          log() << "File '" << args->getOption("check") << "' passed on command line not found" << endl;
 128          return;
 129       }
 130       updateFiles.append(file);
 131    }
 132    else if (args->count())
 133    {
 134       for(int i = 0; i < args->count(); i++)
 135       {
 136          KUrl url = args->url(i);
 137          if (!url.isLocalFile())
 138             KCmdLineArgs::usageError(i18n("Only local files are supported."));
 139          updateFiles.append(url.path());
 140       }
 141    }
 142    else
 143    {
 144       if (cg.readEntry("autoUpdateDisabled", false))
 145          return;
 146       updateFiles = findUpdateFiles(true);
 147       updateAll = true;
 148    }
 149
 150    for(QStringList::ConstIterator it = updateFiles.constBegin();
 151        it != updateFiles.constEnd();
 152        ++it)
 153    {
 154       updateFile(*it);
 155    }
 156
 157    if (updateAll && !cg.readEntry("updateInfoAdded", false))
 158    {
 159        cg.writeEntry("updateInfoAdded", true);
 160        updateFiles = findUpdateFiles(false);
 161
 162        for(QStringList::ConstIterator it = updateFiles.constBegin();
 163            it != updateFiles.constEnd();
 164            ++it)
 165        {
 166            checkFile(*it);
 167        }
 168        updateFiles.clear();
 169    }
 170 }
 171
 172 KonfUpdate::~KonfUpdate()
 173 {
 174    delete config;
 175    delete m_file;
 176    delete m_textStream;
 177 }
 178
 179 QTextStream &
 180 KonfUpdate::log()
 181 {
 182    if (!m_textStream)
 183    {
 184       QString file = KStandardDirs::locateLocal("data", "kconf_update/log/update.log");
 185       m_file = new QFile(file);
 186       if (m_file->open(QIODevice::WriteOnly | QIODevice::Append))
 187       {
 188         m_textStream = new QTextStream(m_file);
 189       }
 190       else
 191       {
 192         // Error
 193         m_textStream = new QTextStream(stderr, QIODevice::WriteOnly);
 194       }
 195    }
 196
 197    (*m_textStream) << QDateTime::currentDateTime().toString( Qt::ISODate ) << " ";
 198
 199    return *m_textStream;
 200 }
 201
 202 QStringList KonfUpdate::findUpdateFiles(bool dirtyOnly)
 203 {
 204    QStringList result;
 205    const QStringList list = KGlobal::dirs()->findAllResources("data", "kconf_update/*.upd",
 206                                                               KStandardDirs::NoDuplicates);
 207    for(QStringList::ConstIterator it = list.constBegin();
 208        it != list.constEnd();
 209        ++it)
 210    {
 211       QString file = *it;
 212       KDE_struct_stat buff;
 213       if (KDE::stat(file, &buff) == 0)
 214       {
 215          int i = file.lastIndexOf('/');
 216          if (i != -1)
 217             file = file.mid(i+1);
 218          KConfigGroup cg(config, file);
 219          time_t ctime = cg.readEntry("ctime", 0);
 220          time_t mtime = cg.readEntry("mtime", 0);
 221          if (!dirtyOnly ||
 222              (ctime != buff.st_ctime) || (mtime != buff.st_mtime))
 223          {
 224             result.append(*it);
 225          }
 226       }
 227    }
 228    return result;
 229 }
 230
 231 bool KonfUpdate::checkFile(const QString &filename)
 232 {
 233    currentFilename = filename;
 234    int i = currentFilename.lastIndexOf('/');
 235    if (i != -1)
 236       currentFilename = currentFilename.mid(i+1);
 237    skip = true;
 238    QFile file(filename);
 239    if (!file.open(QIODevice::ReadOnly))
 240       return false;
 241
 242    QTextStream ts(&file);
 243    ts.setCodec(QTextCodec::codecForName("ISO-8859-1"));
 244    int lineCount = 0;
 245    resetOptions();
 246    QString id;
 247    while(!ts.atEnd())
 248    {
 249       QString line = ts.readLine().trimmed();
 250       lineCount++;
 251       if (line.isEmpty() || (line[0] == '#'))
 252          continue;
 253       if (line.startsWith("Id="))
 254          id = currentFilename+':'+line.mid(3);
 255       else if (line.startsWith("File="))
 256          checkGotFile(line.mid(5), id);
 257    }
 258
 259    return true;
 260 }
 261
 262 void KonfUpdate::checkGotFile(const QString &_file, const QString &id)
 263 {
 264    QString file;
 265    int i = _file.indexOf(',');
 266    if (i == -1)
 267    {
 268       file = _file.trimmed();
 269    }
 270    else
 271    {
 272       file = _file.mid(i+1).trimmed();
 273    }
 274
 275 //   qDebug("File %s, id %s", file.toLatin1().constData(), id.toLatin1().constData());
 276
 277    KConfig cfg(file, KConfig::SimpleConfig);
 278    KConfigGroup cg(&cfg, "$Version");
 279    QStringList ids = cg.readEntry("update_info", QStringList());
 280    if (ids.contains(id))
 281        return;
 282    ids.append(id);
 283    cg.writeEntry("update_info", ids);
 284 }
 285
 286 /**
 287  * Syntax:
 288  * # Comment
 289  * Id=id
 290  * File=oldfile[,newfile]
 291  * AllGroups
 292  * Group=oldgroup[,newgroup]
 293  * RemoveGroup=oldgroup
 294  * Options=[copy,][overwrite,]
 295  * Key=oldkey[,newkey]
 296  * RemoveKey=ldkey
 297  * AllKeys
 298  * Keys= [Options](AllKeys|(Key|RemoveKey)*)
 299  * ScriptArguments=arguments
 300  * Script=scriptfile[,interpreter]
 301  *
 302  * Sequence:
 303  * (Id,(File(Group,Keys)*)*)*
 304  **/
 305 bool KonfUpdate::updateFile(const QString &filename)
 306 {
 307    currentFilename = filename;
 308    int i = currentFilename.lastIndexOf('/');
 309    if (i != -1)
 310        currentFilename = currentFilename.mid(i+1);
 311    skip = true;
 312    QFile file(filename);
 313    if (!file.open(QIODevice::ReadOnly))
 314       return false;
 315
 316    log() << "Checking update-file '" << filename << "' for new updates" << endl;
 317
 318    QTextStream ts(&file);
 319    ts.setCodec(QTextCodec::codecForName("ISO-8859-1"));
 320    m_lineCount = 0;
 321    resetOptions();
 322    while(!ts.atEnd())
 323    {
 324       m_line = ts.readLine().trimmed();
 325       m_lineCount++;
 326       if (m_line.isEmpty() || (m_line[0] == '#'))
 327          continue;
 328       if (m_line.startsWith("Id="))
 329          gotId(m_line.mid(3));
 330       else if (skip)
 331          continue;
 332       else if (m_line.startsWith("Options="))
 333          gotOptions(m_line.mid(8));
 334       else if (m_line.startsWith("File="))
 335          gotFile(m_line.mid(5));
 336       else if(skipFile)
 337          continue;
 338       else if (m_line.startsWith("Group="))
 339          gotGroup(m_line.mid(6));
 340       else if (m_line.startsWith("RemoveGroup="))
 341       {
 342          gotRemoveGroup(m_line.mid(12));
 343          resetOptions();
 344       }
 345       else if (m_line.startsWith("Script="))
 346       {
 347          gotScript(m_line.mid(7));
 348          resetOptions();
 349       }
 350       else if (m_line.startsWith("ScriptArguments="))
 351          gotScriptArguments(m_line.mid(16));
 352       else if (m_line.startsWith("Key="))
 353       {
 354          gotKey(m_line.mid(4));
 355          resetOptions();
 356       }
 357       else if (m_line.startsWith("RemoveKey="))
 358       {
 359          gotRemoveKey(m_line.mid(10));
 360          resetOptions();
 361       }
 362       else if (m_line == "AllKeys")
 363       {
 364          gotAllKeys();
 365          resetOptions();
 366       }
 367       else if (m_line == "AllGroups")
 368       {
 369          gotAllGroups();
 370          resetOptions();
 371       }
 372       else
 373       {
 374          log() << currentFilename << ": parse error in line " << m_lineCount << " : '" << m_line << "'" << endl;
 375       }
 376    }
 377    // Flush.
 378    gotId(QString());
 379
 380    KDE_struct_stat buff;
 381    KDE::stat(filename, &buff);
 382    KConfigGroup cg(config, currentFilename);
 383    cg.writeEntry("ctime", int(buff.st_ctime));
 384    cg.writeEntry("mtime", int(buff.st_mtime));
 385    cg.sync();
 386    return true;
 387 }
 388
 389
 390
 391 void KonfUpdate::gotId(const QString &_id)
 392 {
 393    if (!id.isEmpty() && !skip)
 394    {
 395        KConfigGroup cg(config, currentFilename);
 396
 397        QStringList ids = cg.readEntry("done", QStringList());
 398        if (!ids.contains(id))
 399        {
 400           ids.append(id);
 401           cg.writeEntry("done", ids);
 402           cg.sync();
 403        }
 404    }
 405
 406    // Flush pending changes
 407    gotFile(QString());
 408    KConfigGroup cg(config, currentFilename);
 409
 410    QStringList ids = cg.readEntry("done", QStringList());
 411    if (!_id.isEmpty())
 412    {
 413        if (ids.contains(_id))
 414        {
 415           //qDebug("Id '%s' was already in done-list", _id.toLatin1().constData());
 416           if (!m_bUseConfigInfo)
 417           {
 418              skip = true;
 419              return;
 420           }
 421        }
 422        skip = false;
 423        skipFile = false;
 424        id = _id;
 425        if (m_bUseConfigInfo)
 426           log() << currentFilename << ": Checking update '" << _id << "'" << endl;
 427        else
 428           log() << currentFilename << ": Found new update '" << _id << "'" << endl;
 429    }
 430 }
 431
 432 void KonfUpdate::gotFile(const QString &_file)
 433 {
 434    // Reset group
 435    gotGroup(QString());
 436
 437    if (!oldFile.isEmpty())
 438    {
 439       // Close old file.
 440       delete oldConfig1;
 441       oldConfig1 = 0;
 442
 443       KConfigGroup cg(oldConfig2, "$Version");
 444       QStringList ids = cg.readEntry("update_info", QStringList());
 445       QString cfg_id = currentFilename + ':' + id;
 446       if (!ids.contains(cfg_id) && !skip)
 447       {
 448          ids.append(cfg_id);
 449          cg.writeEntry("update_info", ids);
 450       }
 451       cg.sync();
 452       delete oldConfig2;
 453       oldConfig2 = 0;
 454
 455       QString file = KStandardDirs::locateLocal("config", oldFile);
 456       KDE_struct_stat s_buf;
 457       if (KDE::stat(file, &s_buf) == 0)
 458       {
 459          if (s_buf.st_size == 0)
 460          {
 461             // Delete empty file.
 462             QFile::remove(file);
 463          }
 464       }
 465
 466       oldFile.clear();
 467    }
 468    if (!newFile.isEmpty())
 469    {
 470       // Close new file.
 471       KConfigGroup cg(newConfig, "$Version");
 472       QStringList ids = cg.readEntry("update_info", QStringList());
 473       QString cfg_id = currentFilename + ':' + id;
 474       if (!ids.contains(cfg_id) && !skip)
 475       {
 476          ids.append(cfg_id);
 477          cg.writeEntry("update_info", ids);
 478       }
 479       newConfig->sync();
 480       delete newConfig;
 481       newConfig = 0;
 482
 483       newFile.clear();
 484    }
 485    newConfig = 0;
 486
 487    int i = _file.indexOf(',');
 488    if (i == -1)
 489    {
 490       oldFile = _file.trimmed();
 491    }
 492    else
 493    {
 494       oldFile = _file.left(i).trimmed();
 495       newFile = _file.mid(i+1).trimmed();
 496       if (oldFile == newFile)
 497          newFile.clear();
 498    }
 499
 500    if (!oldFile.isEmpty())
 501    {
 502       oldConfig2 = new KConfig(oldFile, KConfig::NoGlobals);
 503       QString cfg_id = currentFilename + ':' + id;
 504       KConfigGroup cg(oldConfig2, "$Version");
 505       QStringList ids = cg.readEntry("update_info", QStringList());
 506       if (ids.contains(cfg_id))
 507       {
 508          skip = true;
 509          newFile.clear();
 510          log() << currentFilename << ": Skipping update '" << id << "'" << endl;
 511       }
 512
 513       if (!newFile.isEmpty())
 514       {
 515          newConfig = new KConfig(newFile, KConfig::NoGlobals);
 516          KConfigGroup cg(newConfig, "$Version");
 517          ids = cg.readEntry("update_info", QStringList());
 518          if (ids.contains(cfg_id))
 519          {
 520             skip = true;
 521             log() << currentFilename << ": Skipping update '" << id << "'" << endl;
 522          }
 523       }
 524       else
 525       {
 526          newConfig = oldConfig2;
 527       }
 528
 529       oldConfig1 = new KConfig(oldFile, KConfig::NoGlobals);
 530    }
 531    else
 532    {
 533       newFile.clear();
 534    }
 535    newFileName = newFile;
 536    if (newFileName.isEmpty())
 537       newFileName = oldFile;
 538
 539    skipFile = false;
 540    if( !oldFile.isEmpty())
 541    { // if File= is specified, it doesn't exist, is empty or contains only kconf_update's [$Version] group, skip
 542       if( oldConfig1 != NULL
 543           && ( oldConfig1->groupList().isEmpty()
 544               || ( oldConfig1->groupList().count() == 1 && oldConfig1->groupList().first() == "$Version" )))
 545       {
 546          log() << currentFilename << ": File '" << oldFile << "' does not exist or empty, skipping" << endl;
 547          skipFile = true;
 548       }
 549    }
 550 }
 551
 552 void KonfUpdate::gotGroup(const QString &_group)
 553 {
 554    int i = _group.indexOf(',');
 555    if (i == -1)
 556    {
 557       oldGroup = _group.trimmed();
 558       newGroup = oldGroup;
 559    }
 560    else
 561    {
 562       oldGroup = _group.left(i).trimmed();
 563       newGroup = _group.mid(i+1).trimmed();
 564    }
 565 }
 566
 567 void KonfUpdate::gotRemoveGroup(const QString &_group)
 568 {
 569    oldGroup = _group.trimmed();
 570
 571    if (!oldConfig1)
 572    {
 573       log() << currentFilename << ": !! RemoveGroup without previous File specification in line " << m_lineCount << " : '" << m_line << "'" << endl;
 574       return;
 575    }
 576
 577    if (!oldConfig1->hasGroup(oldGroup))
 578       return;
 579    // Delete group.
 580    oldConfig2->deleteGroup(oldGroup);
 581    log() << currentFilename << ": RemoveGroup removes group " << oldFile << ":" << oldGroup << endl;
 582 }
 583
 584
 585 void KonfUpdate::gotKey(const QString &_key)
 586 {
 587    int i = _key.indexOf(',');
 588    if (i == -1)
 589    {
 590       oldKey = _key.trimmed();
 591       newKey = oldKey;
 592    }
 593    else
 594    {
 595       oldKey = _key.left(i).trimmed();
 596       newKey = _key.mid(i+1).trimmed();
 597    }
 598
 599    if (oldKey.isEmpty() || newKey.isEmpty())
 600    {
 601       log() << currentFilename << ": !! Key specifies invalid key in line " << m_lineCount << " : '" << m_line << "'" << endl;
 602       return;
 603    }
 604    if (!oldConfig1)
 605    {
 606       log() << currentFilename << ": !! Key without previous File specification in line " << m_lineCount << " : '" << m_line << "'" << endl;
 607       return;
 608    }
 609    KConfigGroup cg1( oldConfig1, oldGroup);
 610    if (!cg1.hasKey(oldKey))
 611       return;
 612    QString value = cg1.readEntry(oldKey, QString());
 613    KConfigGroup newFGroup( newConfig, newGroup);
 614    if (!m_bOverwrite && newFGroup.hasKey(newKey))
 615    {
 616       log() << currentFilename << ": Skipping " << newFileName << ":" << newGroup << ":" << newKey << ", already exists."<< endl;
 617       return;
 618    }
 619    log() << currentFilename << ": Updating " << newFileName << ":" << newGroup << ":" << newKey << " to '" << value << "'" << endl;
 620    newFGroup.writeEntry(newKey, value);
 621
 622    if (m_bCopy)
 623       return; // Done.
 624
 625    // Delete old entry
 626    if ((oldConfig2 == newConfig) &&
 627        (oldGroup == newGroup) &&
 628        (oldKey == newKey))
 629       return; // Don't delete!
 630    KConfigGroup oldGroup2( oldConfig2, oldGroup);
 631    oldGroup2.deleteEntry(oldKey);
 632    log() << currentFilename << ": Removing " << oldFile << ":" << oldGroup << ":" << oldKey << ", moved." << endl;
 633    /*if (oldConfig2->deleteGroup(oldGroup, KConfig::Normal)) { // Delete group if empty.
 634       log() << currentFilename << ": Removing empty group " << oldFile << ":" << oldGroup << endl;
 635    }  (this should be automatic)  */
 636 }
 637
 638 void KonfUpdate::gotRemoveKey(const QString &_key)
 639 {
 640    oldKey = _key.trimmed();
 641
 642    if (oldKey.isEmpty())
 643    {
 644       log() << currentFilename << ": !! RemoveKey specifies invalid key in line " << m_lineCount << " : '" << m_line << "'" << endl;
 645       return;
 646    }
 647
 648    if (!oldConfig1)
 649    {
 650       log() << currentFilename << ": !! Key without previous File specification in line " << m_lineCount << " : '" << m_line << "'" << endl;
 651       return;
 652    }
 653
 654    KConfigGroup cg1(oldConfig1, oldGroup);
 655    if (!cg1.hasKey(oldKey))
 656       return;
 657    log() << currentFilename << ": RemoveKey removes " << oldFile << ":" << oldGroup << ":" << oldKey << endl;
 658
 659    // Delete old entry
 660    KConfigGroup cg2( oldConfig2, oldGroup);
 661    cg2.deleteEntry(oldKey);
 662    /*if (oldConfig2->deleteGroup(oldGroup, KConfig::Normal)) { // Delete group if empty.
 663       log() << currentFilename << ": Removing empty group " << oldFile << ":" << oldGroup << endl;
 664    }   (this should be automatic)*/
 665 }
 666
 667 void KonfUpdate::gotAllKeys()
 668 {
 669    if (!oldConfig1)
 670    {
 671       log() << currentFilename << ": !! AllKeys without previous File specification in line " << m_lineCount << " : '" << m_line << "'" << endl;
 672       return;
 673    }
 674
 675    QMap<QString, QString> list = oldConfig1->entryMap(oldGroup);
 676    for(QMap<QString, QString>::Iterator it = list.begin();
 677        it != list.end(); ++it)
 678    {
 679       gotKey(it.key());
 680    }
 681 }
 682
 683 void KonfUpdate::gotAllGroups()
 684 {
 685    if (!oldConfig1)
 686    {
 687       log() << currentFilename << ": !! AllGroups without previous File specification in line " << m_lineCount << " : '" << m_line << "'" << endl;
 688       return;
 689    }
 690
 691    const QStringList allGroups = oldConfig1->groupList();
 692    for(QStringList::ConstIterator it = allGroups.begin();
 693        it != allGroups.end(); ++it)
 694    {
 695      oldGroup = *it;
 696      newGroup = oldGroup;
 697      gotAllKeys();
 698    }
 699 }
 700
 701 void KonfUpdate::gotOptions(const QString &_options)
 702 {
 703    const QStringList options = _options.split(',');
 704    for(QStringList::ConstIterator it = options.begin();
 705        it != options.end();
 706        ++it)
 707    {
 708        if ( (*it).toLower().trimmed() == "copy")
 709           m_bCopy = true;
 710
 711        if ( (*it).toLower().trimmed() == "overwrite")
 712           m_bOverwrite = true;
 713    }
 714 }
 715
 716 void KonfUpdate::copyGroup(KConfig *cfg1, const QString &group1,
 717                            KConfig *cfg2, const QString &group2)
 718 {
 719    KConfigGroup cg1(cfg1, group1);
 720    KConfigGroup cg2(cfg2, group2);
 721    QMap<QString, QString> list = cg1.entryMap();
 722    for(QMap<QString, QString>::Iterator it = list.begin();
 723        it != list.end(); ++it)
 724    {
 725       cg2.writeEntry(it.key(), cg1.readEntry(it.key(), QString()));
 726    }
 727 }
 728
 729 void KonfUpdate::gotScriptArguments(const QString &_arguments)
 730 {
 731    m_arguments = _arguments;
 732 }
 733
 734 void KonfUpdate::gotScript(const QString &_script)
 735 {
 736    QString script, interpreter;
 737    int i = _script.indexOf(',');
 738    if (i == -1)
 739    {
 740       script = _script.trimmed();
 741    }
 742    else
 743    {
 744       script = _script.left(i).trimmed();
 745       interpreter = _script.mid(i+1).trimmed();
 746    }
 747
 748
 749    if (script.isEmpty())
 750    {
 751       log() << currentFilename << ": !! Script fails to specify filename in line " << m_lineCount << " : '" << m_line << "'" << endl;
 752       skip = true;
 753       return;
 754    }
 755
 756
 757
 758    QString path = KStandardDirs::locate("data","kconf_update/"+script);
 759    if (path.isEmpty())
 760    {
 761       if (interpreter.isEmpty())
 762          path = KStandardDirs::locate("lib", "kconf_update_bin/"+script);
 763
 764       if (path.isEmpty())
 765       {
 766         log() << currentFilename << ": !! Script '" << script << "' not found in line " << m_lineCount << " : '" << m_line << "'" << endl;
 767         skip = true;
 768         return;
 769       }
 770    }
 771
 772    if( !m_arguments.isNull())
 773       log() << currentFilename << ": Running script '" << script << "' with arguments '" << m_arguments << "'" << endl;
 774    else
 775       log() << currentFilename << ": Running script '" << script << "'" << endl;
 776
 777    QString cmd;
 778    if (interpreter.isEmpty())
 779       cmd = path;
 780    else
 781       cmd = interpreter + ' ' + path;
 782
 783    if( !m_arguments.isNull())
 784    {
 785       cmd += ' ';
 786       cmd += m_arguments;
 787    }
 788
 789    KTemporaryFile tmp1;
 790    tmp1.open();
 791    KTemporaryFile tmp2;
 792    tmp2.open();
 793    KTemporaryFile tmp3;
 794    tmp3.open();
 795
 796    int result;
 797    if (oldConfig1)
 798    {
 799        if (debug)
 800        {
 801            tmp1.setAutoRemove(false);
 802            log() << "Script input stored in " << tmp1.fileName() << endl;
 803        }
 804        KConfig cfg(tmp1.fileName(), KConfig::SimpleConfig);
 805
 806        if (oldGroup.isEmpty())
 807        {
 808            // Write all entries to tmpFile;
 809            const QStringList grpList = oldConfig1->groupList();
 810            for(QStringList::ConstIterator it = grpList.begin();
 811                it != grpList.end();
 812                ++it)
 813            {
 814                copyGroup(oldConfig1, *it, &cfg, *it);
 815            }
 816        }
 817        else
 818        {
 819            copyGroup(oldConfig1, oldGroup, &cfg, QString());
 820        }
 821        cfg.sync();
 822        result = system(QFile::encodeName(QString("%1 < %2 > %3 2> %4").arg(cmd, tmp1.fileName(), tmp2.fileName(), tmp3.fileName())));
 823    }
 824    else
 825    {
 826        // No config file
 827        result = system(QFile::encodeName(QString("%1 2> %2").arg(cmd, tmp3.fileName())));
 828    }
 829
 830    // Copy script stderr to log file
 831    {
 832      QFile output(tmp3.fileName());
 833      if (output.open(QIODevice::ReadOnly))
 834      {
 835        QTextStream ts( &output );
 836        ts.setCodec(QTextCodec::codecForName("UTF-8"));
 837        while(!ts.atEnd())
 838        {
 839          QString line = ts.readLine();
 840          log() << "[Script] " << line << endl;
 841        }
 842      }
 843    }
 844
 845    if (result)
 846    {
 847       log() << currentFilename << ": !! An error occurred while running '" << cmd << "'" << endl;
 848       return;
 849    }
 850
 851    if (!oldConfig1)
 852       return; // Nothing to merge
 853
 854    if (debug)
 855    {
 856       tmp2.setAutoRemove(false);
 857       log() << "Script output stored in " << tmp2.fileName() << endl;
 858    }
 859
 860    // Deleting old entries
 861    {
 862      QString group = oldGroup;
 863      QFile output(tmp2.fileName());
 864      if (output.open(QIODevice::ReadOnly))
 865      {
 866        QTextStream ts( &output );
 867        ts.setCodec(QTextCodec::codecForName("UTF-8"));
 868        while(!ts.atEnd())
 869        {
 870          QString line = ts.readLine();
 871          if (line.startsWith('['))
 872          {
 873             int j = line.indexOf(']')+1;
 874             if (j > 0)
 875                group = line.mid(1, j-2);
 876          }
 877          else if (line.startsWith("# DELETE "))
 878          {
 879             QString key = line.mid(9);
 880             if (key[0] == '[')
 881             {
 882                int j = key.indexOf(']')+1;
 883                if (j > 0)
 884                {
 885                   group = key.mid(1,j-2);
 886                   key = key.mid(j);
 887                }
 888             }
 889             KConfigGroup cg(oldConfig2, group);
 890             cg.deleteEntry(key);
 891             log() << currentFilename << ": Script removes " << oldFile << ":" << group << ":" << key << endl;
 892             /*if (oldConfig2->deleteGroup(group, KConfig::Normal)) { // Delete group if empty.
 893                log() << currentFilename << ": Removing empty group " << oldFile << ":" << group << endl;
 894             } (this should be automatic)*/
 895          }
 896          else if (line.startsWith("# DELETEGROUP"))
 897          {
 898             QString key = line.mid(13).trimmed();
 899             if (key[0] == '[')
 900             {
 901                int j = key.indexOf(']')+1;
 902                if (j > 0)
 903                {
 904                   group = key.mid(1,j-2);
 905                }
 906             }
 907             oldConfig2->deleteGroup(group);
 908             log() << currentFilename << ": Script removes group " << oldFile << ":" << group << endl;
 909           }
 910        }
 911      }
 912    }
 913
 914    // Merging in new entries.
 915    m_bCopy = true;
 916    {
 917      KConfig *saveOldConfig1 = oldConfig1;
 918      QString saveOldGroup = oldGroup;
 919      QString saveNewGroup = newGroup;
 920      oldConfig1 = new KConfig(tmp2.fileName(), KConfig::NoGlobals);
 921
 922      // For all groups...
 923      const QStringList grpList = oldConfig1->groupList();
 924      for(QStringList::ConstIterator it = grpList.begin();
 925          it != grpList.end();
 926          ++it)
 927      {
 928         oldGroup = *it;
 929         if (oldGroup != "<default>")
 930         {
 931            newGroup = oldGroup;
 932         }
 933         gotAllKeys(); // Copy all keys
 934      }
 935      delete oldConfig1;
 936      oldConfig1 = saveOldConfig1;
 937      oldGroup = saveOldGroup;
 938      newGroup = saveNewGroup;
 939    }
 940 }
 941
 942 void KonfUpdate::resetOptions()
 943 {
 944    m_bCopy = false;
 945    m_bOverwrite = false;
 946    m_arguments.clear();
 947 }
 948
 949
 950 extern "C" KDE_EXPORT int kdemain(int argc, char **argv)
 951 {
 952    KCmdLineOptions options;
 953    options.add("debug", ki18n("Keep output results from scripts"));
 954    options.add("check <update-file>", ki18n("Check whether config file itself requires updating"));
 955    options.add("+[file]", ki18n("File to read update instructions from"));
 956
 957    KAboutData aboutData("kconf_update", 0, ki18n("KConf Update"),
 958                         "1.0.2",
 959                         ki18n("KDE Tool for updating user configuration files"),
 960                         KAboutData::License_GPL,
 961                         ki18n("(c) 2001, Waldo Bastian"));
 962
 963    aboutData.addAuthor(ki18n("Waldo Bastian"), KLocalizedString(), "bastian@kde.org");
 964
 965    KCmdLineArgs::init(argc, argv, &aboutData);
 966    KCmdLineArgs::addCmdLineOptions(options);
 967
 968    KComponentData componentData(&aboutData);
 969
 970    KonfUpdate konfUpdate;
 971
 972    return 0;
 973 }