backuprestore.cpp

Go to the documentation of this file.

/*
                     This file is part of the Opie Project
               =.
      .=l.            Copyright (c) 2002-2004 The Opie Team <opie-devel@handhelds.org>
     .>+-=
_;:,   .>  :=|.         This file is free software; you can
.> <`_,  > .  <=          redistribute it and/or modify it under
:`=1 )Y*s>-.--  :           the terms of the GNU General Public
.="- .-=="i,   .._         License as published by the Free Software
- .  .-<_>   .<>         Foundation; either version 2 of the License,
  ._= =}    :          or (at your option) any later version.
  .%`+i>    _;_.
  .i_,=:_.   -<s.       This file 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 file;
 -_. . .  )=. =           see the file COPYING. If not, write to the
  --    :-=`           Free Software Foundation, Inc.,
                             59 Temple Place - Suite 330,
                             Boston, MA 02111-1307, USA.

*/

#include "backuprestore.h"
#include "errordialog.h"

/* OPIE */
#include <opie2/odebug.h>
#include <opie2/odevice.h>
#include <opie2/ostorageinfo.h>
#include <opie2/ofiledialog.h>
#include <opie2/oresource.h>
#include <opie2/owait.h>

#include <qpe/qpeapplication.h>
#include <qpe/config.h>

using namespace Opie::Core;
using namespace Opie::Ui;

/* QT */
#include <qapplication.h>
#include <qmultilineedit.h>
#include <qdir.h>
#include <qfile.h>
#include <qfileinfo.h>
#include <qlistview.h>
#include <qpushbutton.h>
#include <qradiobutton.h>
#include <qheader.h>
#include <qmessagebox.h>
#include <qcombobox.h>
#include <qlist.h>
#include <qregexp.h>
#include <qtextstream.h>
#include <qtextview.h>
#include <qlineedit.h>
#include <qstringlist.h>

/* STD */
#include <errno.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/stat.h>
#include <dirent.h>

#define HEADER_NAME 0
#define HEADER_BACKUP 1
#define BACKUP_LOCATION 2

#define EXTENSION ".bck"

const QString tempFileName = "/tmp/backup.err";

BackupAndRestore::BackupAndRestore( QWidget* parent, const char* name,  WFlags fl)
        : BackupAndRestoreBase(parent, name,  fl)
{
    backupList->header()->hide();
    restoreList->header()->hide();
    locationList->header()->hide();
    connect( backupButton, SIGNAL( clicked() ), this, SLOT( backup() ) );
    connect( restoreButton, SIGNAL( clicked() ), this, SLOT( restore() ) );
    connect( backupList, SIGNAL( clicked( QListViewItem* ) ), this, SLOT( selectItem( QListViewItem* ) ) );
    connect( restoreSource, SIGNAL( activated( int ) ), this, SLOT( sourceDirChanged( int ) ) );
    connect( addLocationButton, SIGNAL( clicked() ), this, SLOT( addLocation() ) );
    connect( removeLocationButton, SIGNAL( clicked() ), this, SLOT( removeLocation() ) );
    connect( selectLocationButton, SIGNAL( clicked() ), this, SLOT( selectLocation() ) );

    //add directorys for backing up
    applicationSettings = new QListViewItem(backupList, "Application Settings", "", "Settings/");
    selectItem(applicationSettings);
    applicationSettings = new QListViewItem(backupList, "Application Data", "", "Applications/");
    selectItem(applicationSettings);
    documents= new QListViewItem(backupList, "Documents", "", "Documents/");
    selectItem(documents);

    scanForApplicationSettings();
    refreshLocations();
    refreshBackupLocations();
    sourceDirChanged(restoreSource->currentItem());

    // Read the list of items to ignore.
    QList<QString> dontBackupList;
    dontBackupList.setAutoDelete(true);
    Config config("BackupAndRestore");
    config.setGroup("DontBackup");
    int total = config.readNumEntry("Total", 0);
    for(int i = 0; i < total; i++)
    {
        dontBackupList.append(new QString(config.readEntry(QString("%1").arg(i), "")));
    }

    QList<QListViewItem> list;
    getAllItems(backupList->firstChild(), list);

    for(uint i = 0; i < list.count(); i++)
    {
        QString text = list.at(i)->text(HEADER_NAME);
        for(uint i2 = 0;  i2 < dontBackupList.count(); i2++)
        {
            if(*dontBackupList.at(i2) == text)
            {
                selectItem(list.at(i));
                break;
            }
        }
    }
    QPEApplication::showWidget( this );
}

BackupAndRestore::~BackupAndRestore()
{
    QList<QListViewItem> list;
    getAllItems(backupList->firstChild(), list);

    Config config("BackupAndRestore");
    config.setGroup("DontBackup");
    config.clearGroup();

    int count = 0;
    for(uint i = 0; i < list.count(); i++)
    {
        if(list.at(i)->text(HEADER_BACKUP) == "")
        {
            config.writeEntry(QString("%1").arg(count), list.at(i)->text(HEADER_NAME));
            count++;
        }
    }
    config.writeEntry("Total", count);

    // Remove Temp File
    if ( QFile::exists( tempFileName ) )
        QFile::remove( tempFileName );
}

void BackupAndRestore::refreshBackupLocations()
{
    backupLocations.clear();
    // Add cards
    Opie::Core::OStorageInfo storage;
    backupLocations.insert( "Documents", QDir::homeDirPath() + "/Documents" );
    if ( storage.hasCf() )
    {
        backupLocations.insert( "CF", storage.cfPath() );
        odebug << "Cf Path: " + storage.cfPath() << oendl;
    }
    if ( storage.hasSd() )
    {
        backupLocations.insert( "SD", storage.sdPath() );
        odebug << " Sd Path: " + storage.sdPath() << oendl;
    }
    if ( storage.hasMmc() )
    {
        backupLocations.insert( "MMC", storage.mmcPath() );
        odebug << "Mmc Path: " + storage.mmcPath() << oendl;
    }

    for ( QListViewItemIterator it( locationList ); it.current(); ++it )
    {
        backupLocations.insert( it.current()->text( 0 ), it.current()->text( 0 ) );
    }

    //update QComboBox
    storeToLocation->clear();
    restoreSource->clear();

    //read last locations
    Config config("BackupAndRestore");
    config.setGroup("LastLocation");
    QString lastStoreLocation   = config.readEntry( "LastStoreLocation", "" );
    QString lastRestoreLocation = config.readEntry( "LastRestoreLocation", "" );
    int locationIndex    = 0;

    //fill QComboBox
    QMap<QString, QString>::Iterator it;
    for( it = backupLocations.begin(); it != backupLocations.end(); ++it )
    {
        storeToLocation->insertItem(it.key());
        restoreSource->insertItem(it.key());

        //check for last locations
        if ( it.key() == lastStoreLocation )
            storeToLocation->setCurrentItem( locationIndex );
        if ( it.key() == lastRestoreLocation )
            restoreSource->setCurrentItem( locationIndex );
        locationIndex++;
    }
}

QList<QListViewItem> BackupAndRestore::getAllItems(QListViewItem *item, QList<QListViewItem> &list)
{
    while(item)
    {
        if(item->childCount() > 0)
            getAllItems(item->firstChild(), list);
        list.append(item);
        item = item->nextSibling();
    }
    return list;
}

void BackupAndRestore::selectItem(QListViewItem *currentItem)
{
    if(!currentItem)
        return;

    if(currentItem->text(HEADER_BACKUP) == "B")
    {
        currentItem->setPixmap(HEADER_NAME, Opie::Core::OResource::loadPixmap("backup/null"));
        currentItem->setText(HEADER_BACKUP, "");
    }
    else
    {
        currentItem->setPixmap(HEADER_NAME, Opie::Core::OResource::loadPixmap("backup/check"));
        currentItem->setText(HEADER_BACKUP, "B");
    }
}

void BackupAndRestore::scanForApplicationSettings()
{
    QDir d( QDir::homeDirPath() + "/" + QString( applicationSettings->text(BACKUP_LOCATION) ) );
    d.setFilter( QDir::Dirs | QDir::Files | QDir::NoSymLinks );
    const QFileInfoList *list = d.entryInfoList();
    QFileInfoListIterator it( *list );
    QFileInfo *fi;
    while ( (fi=it.current()) )
    {
        //odebug << (d.path()+"/"+fi->fileName()).latin1() << oendl;
        if ( ( fi->fileName() != "." ) && ( fi->fileName() != ".." ) )
        {
            QListViewItem *newItem = new QListViewItem(applicationSettings, fi->fileName());
            selectItem(newItem);
        }
        ++it;
    }
}

void BackupAndRestore::backup()
{
    backupUserData();
/*    if ( cb_type_userdata->isChecked() )
        backupUserData();
    else
        backupRootFs();*/
}


void BackupAndRestore::backupRootFs()
{
    if ( ( ODevice::inst()->model() != Model_Zaurus_SL5000 ) && ( ODevice::inst()->model() != Model_Zaurus_SL5500 ) )
    {
        QMessageBox::critical( this, "Not yet implemented!", "<qt>Sorry, support for this model is not yet done.</qt>", "Ok" );
        return;
    }

    if ( !QFile::exists( "/usr/bin/mkfs.jffs2" ) && !QFile::exists( "/usr/sbin/mkfs.jffs2" ) )
    {
        QMessageBox::critical( this, "Can't find utility!", "<qt>Can't find mkfs.jffs2 - Install mtd-utils.</qt>", "Ok" );
        return;
    }

    // call 'mount' and parse its output to gather the device on which the root partition is mounted
    FILE* mountp = popen( "mount", "r" );
    QString device;
    QString mountpoint;
    {
        QTextStream mounto( mountp, IO_ReadOnly );
        QString on;
        QString type;
        QString filesystem;
        QString options;
        while ( !mounto.atEnd() )
        {
            mounto >> device >> on >> mountpoint >> type >> filesystem >> options;
            if ( mountpoint == "/" ) break;
        }
        odebug << device << " is formatted w/ '" << filesystem << "' and mounted on '" << mountpoint << "'" << oendl;

        if ( !device.startsWith( "/dev/mtdblock" ) )
        {
            QMessageBox::critical( this, "Can't backup!", QString( "<qt>unsupported root device '%1' - needs to be /dev/mtdblockN</qt>").arg( device ), "Ok" );
            return;
        }
    } // at this point, the QTextStream has been destroy and we can close the FILE*
    pclose( mountp );

#if 1
    int rootmtd = device.right( 1 ).toInt();
#else
    int rootmtd = 0;
#endif
    odebug << "root mtdblock seems to be '" << rootmtd << "'" << oendl;

    // scan /proc/mtd to gather the size and erasesize of the root mtdblock
    QFile procmtdf( "/proc/mtd" );
    if ( !procmtdf.open( IO_ReadOnly ) )
    {
        QMessageBox::critical( this, "Can't backup!", "<qt>Can't open /proc/mtd</qt>", "Ok" );
        return;
    }

    QTextStream procmtd( &procmtdf );
    for ( int i = 0; i <= rootmtd; ++i ) procmtd.readLine(); // skip uninteresting things
    QString dev;
    QString size;
    QString erasesize;
    QString devname;
    procmtd >> dev >> size >> erasesize >> devname;

    odebug << "device " << dev << " size = " << size << ", erase size = " << erasesize << ", name = " << devname << "\"" << oendl;

    // compute pad
    QString pad = "--pad";
    switch ( ODevice::inst()->model() )
    {
        case Model_Zaurus_SL5000: pad = "--pad=14680064"; break;
        case Model_Zaurus_SL5500: pad = "--pad=14680064"; break;
        // FIXME: Add Beagle and SIMpad
    }

    // compute eraseblock
    QString eraseblock = "--eraseblock=0x" + erasesize;

    // compute output
    QString outputFile = "--output=" + backupLocations[storeToLocation->currentText()];
    QDateTime datetime = QDateTime::currentDateTime();
    QString dateString = QString::number( datetime.date().year() ) + QString::number( datetime.date().month() ).rightJustify(2, '0') +
                         QString::number( datetime.date().day() ).rightJustify(2, '0');
    outputFile += "/initrd.bin-" + dateString;

    // call mkfs.jffs2 to create the backup
    QString cmdline = QString( "mkfs.jffs2 --faketime --root=/ %1 --little-endian %2 %3 -n" ).arg( outputFile ).arg( pad ).arg( eraseblock );
    cmdline.append( " --ignore=/tmp --ignore=/mnt --ignore=/var --ignore=/proc" );
    owarn << "Calling '" << cmdline << "'" << oendl;

    OWait *owait = new OWait();
    Global::statusMessage( tr( "Backing up..." ) );
    owait->show();
    qApp->processEvents();

    int r = ::system( cmdline );

    owait->hide();
    delete owait;

    if ( r != 0 )
    {
        perror("Error: ");
        QString errorMsg = QString( tr( "<qt>%1</qt>" ).arg( strerror( errno ) ) );
        QMessageBox::critical(this, tr( "Backup Failed!" ), errorMsg, QString( tr( "Ok" ) ) );
    }

    // FIXME: Add image postprocessing for C7x0 and C8x0, for Beagle, for SIMpad
}

void BackupAndRestore::backupUserData()
{
    QString backupFiles;
    if(getBackupFiles(backupFiles, NULL) == 0)
    {
        QMessageBox::critical(this, "Message",
                              "No items selected.",QString("Ok") );
        return;
    }

    OWait *owait = new OWait();
    Global::statusMessage( tr( "Backing up..." ) );
    owait->show();
    qApp->processEvents();

    QString outputFile = backupLocations[storeToLocation->currentText()];

    QDateTime datetime = QDateTime::currentDateTime();
    QString dateString = QString::number( datetime.date().year() ) + QString::number( datetime.date().month() ).rightJustify(2, '0') +
                         QString::number( datetime.date().day() ).rightJustify(2, '0');

    outputFile += "/" + dateString;

    QString t = outputFile;
    int c = 1;
    while(QFile::exists(outputFile + EXTENSION))
    {
        outputFile = t + QString("%1").arg(c);
        c++;
    }

    // We execute tar and compressing its output with gzip..
    // The error output will be written into a temp-file which could be provided
    // for debugging..
    odebug << "Storing file: " << outputFile.latin1() << "" << oendl;
    outputFile += EXTENSION;

    QString commandLine = QString( "cd %1 && (tar -X %1 -cz %2 Applications/backup/exclude -f %3 ) 2> %4" ).arg( QDir::homeDirPath() )
                          .arg( getExcludeFile() )
                          .arg( backupFiles )
                          .arg( outputFile.latin1() )
                          .arg( tempFileName.latin1() );

    odebug << commandLine << oendl;

    int r = system( commandLine );

    owait->hide();
    delete owait;

    //Error-Handling
    if(r != 0)
    {
        perror("Error: ");
        QString errorMsg= tr( "Error from System:\n" ) + (QString)strerror( errno );

        switch( QMessageBox::critical(this, tr( "Message" ), tr( "Backup Failed!" ) + "\n"
                                      + errorMsg, QString( tr( "Ok" ) ), QString( tr( "Details" ) ) ) )
        {

        case 1:
            owarn << "Details pressed !" << oendl;
            ErrorDialog* pErrDialog = new ErrorDialog( this, NULL, true );
            QFile errorFile( tempFileName );
            if ( errorFile.open(IO_ReadOnly) )
            {
                QTextStream t( &errorFile );
                QString s;
                while ( !t.eof() )
                {        // until end of file...
                    s += t.readLine();       // line of text excluding '\n'
                }
                errorFile.close();

                pErrDialog->m_textarea->setText( s );
            }
            else
            {
                pErrDialog->m_textarea->setText( "Unable to open File: /tmp/backup.er" );
            }
            QPEApplication::execDialog( pErrDialog );
            delete pErrDialog;
            break;
        }
        setCaption(tr("Backup and Restore.. Failed !!"));
        return;
    }
    else
    {
        QMessageBox::information(this, tr( "Message" ), tr( "Backup Successful." ), QString(tr( "Ok" ) ) );
    }

    //write store-location
    Config config( "BackupAndRestore" );
    config.setGroup( "LastLocation" );
    config.writeEntry( "LastStoreLocation", storeToLocation->currentText() );

    setCaption(tr("Backup and Restore"));
}

/***
 * Get a list of all of the files to backup.
 */
int BackupAndRestore::getBackupFiles(QString &backupFiles, QListViewItem *parent)
{
    QListViewItem * currentItem;
    QString currentHome;
    if(!parent)
        currentItem = backupList->firstChild();
    else
    {
        currentItem = parent->firstChild();
        currentHome = parent->text(BACKUP_LOCATION);
    }

    uint count = 0;
    while( currentItem != 0 )
    {
        if(currentItem->text(HEADER_BACKUP) == "B" )
        {
            if(currentItem->childCount() == 0 )
            {
                if(parent == NULL)
                    backupFiles += currentItem->text(BACKUP_LOCATION);
                else
                    backupFiles += currentHome + currentItem->text(HEADER_NAME);
                backupFiles += " ";
                count++;
            }
            else
            {
                count += getBackupFiles(backupFiles, currentItem);
            }
        }
        currentItem = currentItem->nextSibling();
    }
    return count;
}

void BackupAndRestore::sourceDirChanged(int selection)
{
    restoreList->clear();
    rescanFolder(backupLocations[restoreSource->text(selection)]);
}

void BackupAndRestore::fileListUpdate()
{
    owarn << "void BackupAndRestore::fileListUpdate()" << oendl;
    restoreList->clear();
    rescanFolder( backupLocations[restoreSource->currentText()] );
}

void BackupAndRestore::rescanFolder(QString directory)
{
    //odebug << QString("rescanFolder: ") + directory.latin1() << oendl;
    QDir d(directory);
    if(!d.exists())
        return;

    d.setFilter( QDir::Files | QDir::Hidden | QDir::Dirs);
    const QFileInfoList *list = d.entryInfoList();
    QFileInfoListIterator it( *list );
    QFileInfo *file;
    while ( (file=it.current()) )
    {  // for each file...
        // If it is a dir and not .. or . then add it as a tab and go down.
        if(file->isDir())
        {
            if(file->fileName() != ".." && file->fileName() != ".")
            {
                rescanFolder(directory + "/" + file->fileName());
            }
        }
        else
        {
            // If it is a backup file add to list.
            if(file->fileName().contains(EXTENSION))
                (void)new QListViewItem(restoreList, file->fileName());
        }
        ++it;
    }
}

void BackupAndRestore::restore()
{
    QListViewItem *restoreItem = restoreList->currentItem();
    if(!restoreItem)
    {
        QMessageBox::critical(this, tr( "Message" ),
                              tr( "Please select something to restore." ),QString( tr( "Ok") ) );
        return;
    }

    if ( QMessageBox::warning( this, tr( "Restore" ),
                                     tr( "Would you really overwrite your local data?" ),
                                     tr( "Yes" ), tr( "No" ), "", 1 ) == 1 )
        return;

    OWait *owait = new OWait();
    Global::statusMessage( tr( "Restore Backup..." ) );
    owait->show();
    qApp->processEvents();

    QString restoreFile = backupLocations[restoreSource->currentText()];

    restoreFile += "/" + restoreItem->text(0);

    odebug << restoreFile << oendl;

    //check if backup file come from opie 1.0.x

    QString commandLine = QString( "tar -tzf %1 | grep Applications/backup/exclude" ).arg( restoreFile.latin1() );

    int r = system( commandLine );

    QString startDir;

    if( r != 0 ) //Applications/backup/exclude not found - old backup file
    {
        startDir = QString( "/" );
    } else
    {
        startDir = QDir::homeDirPath();
    }

    //unpack backup file
    commandLine = QString( "cd %1 && tar -zxf %2 2> %3" ).arg( startDir )
                  .arg( restoreFile.latin1() )
                  .arg( tempFileName.latin1() );

    odebug << commandLine << oendl;

    r = system( commandLine );

    owait->hide();
    delete owait;

    //error handling
    if(r != 0)
    {
        QString errorMsg= tr( "Error from System:\n" ) + (QString)strerror( errno );
        switch( QMessageBox::critical(this, tr( "Message" ), tr( "Restore Failed." ) + "\n"
                                      + errorMsg, QString( tr( "Ok") ), QString( tr( "Details" ) ) ) )
        {
        case 1:
            owarn << "Details pressed !" << oendl;
            ErrorDialog* pErrDialog = new ErrorDialog( this, NULL, true );
            QFile errorFile( tempFileName );
            if ( errorFile.open(IO_ReadOnly) )
            {
                QTextStream t( &errorFile );
                QString s;
                while ( !t.eof() )
                {        // until end of file...
                    s += t.readLine();       // line of text excluding '\n'
                }
                errorFile.close();

                pErrDialog->m_textarea->setText( s );
            }
            else
            {
                pErrDialog->m_textarea->setText( tr( "Unable to open File: %1" ).arg( "/tmp/backup.er" ) );
            }
            QPEApplication::execDialog( pErrDialog );
            delete pErrDialog;

            setCaption(tr("Backup and Restore.. Failed !!"));
            return;

            break;

        }
    }
    else
    {
        QMessageBox::information(this, tr( "Message" ), tr( "Restore Successful." ), QString( tr( "Ok") ) );
    }

    //write restore-location
    Config config( "BackupAndRestore" );
    config.setGroup( "LastLocation" );
    config.writeEntry( "LastRestoreLocation", restoreSource->currentText() );

    setCaption(tr("Backup and Restore"));
}

QString BackupAndRestore::getExcludeFile()
{
    QString excludeFileName = Global::applicationFileName( "backup", "exclude" );
    if ( !QFile::exists( excludeFileName ) )
    {
        QFile excludeFile( excludeFileName);
        if ( excludeFile.open( IO_WriteOnly ) == true )
        {
            QTextStream writeStream( &excludeFile );
            writeStream << "*.bck" << "\n";
            excludeFile.close();
        }
        else
        {
            return QString::null;
        }
    }

    return excludeFileName;
}

void BackupAndRestore::refreshLocations()
{
    locationList->clear();

    //todo: implement add locations
    Config config( "BackupAndRestore" );
    config.setGroup( "Locations" );

    QStringList locations( config.readListEntry( "locations", '|' ) );

    for ( QStringList::Iterator it = locations.begin(); it != locations.end(); ++it ) {
         (void) new QListViewItem( locationList, *it );
    }
}

void BackupAndRestore::addLocation()
{
    if ( ( !locationEdit->text().isEmpty() ) &&
         ( QDir( locationEdit->text() ).exists() ) )
    {
        (void) new QListViewItem( locationList, locationEdit->text() );
        locationEdit->setText( "" );
        saveLocations();
    }
}

void BackupAndRestore::removeLocation()
{
    if ( locationList->selectedItem() )
    {
        delete( locationList->selectedItem() );
        saveLocations();
    }
}

void BackupAndRestore::saveLocations()
{
    Config config("BackupAndRestore");
    config.setGroup("Locations");

    QStringList locations;
    for ( QListViewItemIterator it( locationList ); it.current(); ++it )
    {
        locations.append( it.current()->text( 0 ) );
    }
    config.writeEntry( "locations", locations, '|' );

    refreshBackupLocations();
}

void BackupAndRestore::selectLocation()
{
    QString location = OFileDialog::getDirectory( OFileSelector::DIRECTORYSELECTOR );
    if ( !location.isEmpty() )
    {
        locationEdit->setText( location );
    }
}

// backuprestore.cpp

---