src/qt/intro.cpp

   1 // Copyright (c) 2011-2014 The Bitcoin Core developers
   2 // Distributed under the MIT software license, see the accompanying
   3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   4
   5 #include "intro.h"
   6 #include "ui_intro.h"
   7
   8 #include "guiutil.h"
   9
  10 #include "util.h"
  11
  12 #include <boost/filesystem.hpp>
  13
  14 #include <QFileDialog>
  15 #include <QSettings>
  16 #include <QMessageBox>
  17
  18 /* Minimum free space (in bytes) needed for data directory */
  19 static const uint64_t GB_BYTES = 1000000000LL;
  20 static const uint64_t BLOCK_CHAIN_SIZE = 1LL * GB_BYTES;
  21
  22 /* Check free space asynchronously to prevent hanging the UI thread.
  23
  24    Up to one request to check a path is in flight to this thread; when the check()
  25    function runs, the current path is requested from the associated Intro object.
  26    The reply is sent back through a signal.
  27
  28    This ensures that no queue of checking requests is built up while the user is
  29    still entering the path, and that always the most recently entered path is checked as
  30    soon as the thread becomes available.
  31 */
  32 class FreespaceChecker : public QObject
  33 {
  34     Q_OBJECT
  35
  36 public:
  37     FreespaceChecker(Intro *intro);
  38
  39     enum Status {
  40         ST_OK,
  41         ST_ERROR
  42     };
  43
  44 public slots:
  45     void check();
  46
  47 signals:
  48     void reply(int status, const QString &message, quint64 available);
  49
  50 private:
  51     Intro *intro;
  52 };
  53
  54 #include "intro.moc"
  55
  56 FreespaceChecker::FreespaceChecker(Intro *intro)
  57 {
  58     this->intro = intro;
  59 }
  60
  61 void FreespaceChecker::check()
  62 {
  63     namespace fs = boost::filesystem;
  64     QString dataDirStr = intro->getPathToCheck();
  65     fs::path dataDir = GUIUtil::qstringToBoostPath(dataDirStr);
  66     uint64_t freeBytesAvailable = 0;
  67     int replyStatus = ST_OK;
  68     QString replyMessage = tr("A new data directory will be created.");
  69
  70     /* Find first parent that exists, so that fs::space does not fail */
  71     fs::path parentDir = dataDir;
  72     fs::path parentDirOld = fs::path();
  73     while(parentDir.has_parent_path() && !fs::exists(parentDir))
  74     {
  75         parentDir = parentDir.parent_path();
  76
  77         /* Check if we make any progress, break if not to prevent an infinite loop here */
  78         if (parentDirOld == parentDir)
  79             break;
  80
  81         parentDirOld = parentDir;
  82     }
  83
  84     try {
  85         freeBytesAvailable = fs::space(parentDir).available;
  86         if(fs::exists(dataDir))
  87         {
  88             if(fs::is_directory(dataDir))
  89             {
  90                 QString separator = "<code>" + QDir::toNativeSeparators("/") + tr("name") + "</code>";
  91                 replyStatus = ST_OK;
  92                 replyMessage = tr("Directory already exists. Add %1 if you intend to create a new directory here.").arg(separator);
  93             } else {
  94                 replyStatus = ST_ERROR;
  95                 replyMessage = tr("Path already exists, and is not a directory.");
  96             }
  97         }
  98     } catch (const fs::filesystem_error&)
  99     {
 100         /* Parent directory does not exist or is not accessible */
 101         replyStatus = ST_ERROR;
 102         replyMessage = tr("Cannot create data directory here.");
 103     }
 104     emit reply(replyStatus, replyMessage, freeBytesAvailable);
 105 }
 106
 107
 108 Intro::Intro(QWidget *parent) :
 109     QDialog(parent),
 110     ui(new Ui::Intro),
 111     thread(0),
 112     signalled(false)
 113 {
 114     ui->setupUi(this);
 115     ui->sizeWarningLabel->setText(ui->sizeWarningLabel->text().arg(BLOCK_CHAIN_SIZE/GB_BYTES));
 116     startThread();
 117 }
 118
 119 Intro::~Intro()
 120 {
 121     delete ui;
 122     /* Ensure thread is finished before it is deleted */
 123     emit stopThread();
 124     thread->wait();
 125 }
 126
 127 QString Intro::getDataDirectory()
 128 {
 129     return ui->dataDirectory->text();
 130 }
 131
 132 void Intro::setDataDirectory(const QString &dataDir)
 133 {
 134     ui->dataDirectory->setText(dataDir);
 135     if(dataDir == getDefaultDataDirectory())
 136     {
 137         ui->dataDirDefault->setChecked(true);
 138         ui->dataDirectory->setEnabled(false);
 139         ui->ellipsisButton->setEnabled(false);
 140     } else {
 141         ui->dataDirCustom->setChecked(true);
 142         ui->dataDirectory->setEnabled(true);
 143         ui->ellipsisButton->setEnabled(true);
 144     }
 145 }
 146
 147 QString Intro::getDefaultDataDirectory()
 148 {
 149     return GUIUtil::boostPathToQString(GetDefaultDataDir());
 150 }
 151
 152 bool Intro::pickDataDirectory()
 153 {
 154     namespace fs = boost::filesystem;
 155     QSettings settings;
 156     /* If data directory provided on command line, no need to look at settings
 157        or show a picking dialog */
 158     if(!GetArg("-datadir", "").empty())
 159         return true;
 160     /* 1) Default data directory for operating system */
 161     QString dataDir = getDefaultDataDirectory();
 162     /* 2) Allow QSettings to override default dir */
 163     dataDir = settings.value("strDataDir", dataDir).toString();
 164
 165     if(!fs::exists(GUIUtil::qstringToBoostPath(dataDir)) || GetBoolArg("-choosedatadir", false))
 166     {
 167         /* If current default data directory does not exist, let the user choose one */
 168         Intro intro;
 169         intro.setDataDirectory(dataDir);
 170         intro.setWindowIcon(QIcon(":icons/bitcoin"));
 171
 172         for ( ; ; )
 173         {
 174             if(!intro.exec())
 175             {
 176                 /* Cancel clicked */
 177                 return false;
 178             }
 179             dataDir = intro.getDataDirectory();
 180             try {
 181                 boost::filesystem::create_directory(GUIUtil::qstringToBoostPath(dataDir));
 182                 break;
 183             } catch (const fs::filesystem_error&) {
 184                 QMessageBox::critical(0, tr("Novacoin-qt"),
 185                     tr("Error: Specified data directory \"%1\" cannot be created.").arg(dataDir));
 186                 /* fall through, back to choosing screen */
 187             }
 188         }
 189
 190         settings.setValue("strDataDir", dataDir);
 191     }
 192     /* Only override -datadir if different from the default, to make it possible to
 193      * override -datadir in the bitcoin.conf file in the default data directory
 194      * (to be consistent with bitcoind behavior)
 195      */
 196     if(dataDir != getDefaultDataDirectory())
 197         SoftSetArg("-datadir", GUIUtil::qstringToBoostPath(dataDir).string()); // use OS locale for path setting
 198     return true;
 199 }
 200
 201 void Intro::setStatus(int status, const QString &message, quint64 bytesAvailable)
 202 {
 203     switch(status)
 204     {
 205     case FreespaceChecker::ST_OK:
 206         ui->errorMessage->setText(message);
 207         ui->errorMessage->setStyleSheet("");
 208         break;
 209     case FreespaceChecker::ST_ERROR:
 210         ui->errorMessage->setText(tr("Error") + ": " + message);
 211         ui->errorMessage->setStyleSheet("QLabel { color: #800000 }");
 212         break;
 213     }
 214     /* Indicate number of bytes available */
 215     if(status == FreespaceChecker::ST_ERROR)
 216     {
 217         ui->freeSpace->setText("");
 218     } else {
 219         QString freeString = tr("%n GB of free space available", "", bytesAvailable/GB_BYTES);
 220         if(bytesAvailable < BLOCK_CHAIN_SIZE)
 221         {
 222             freeString += " " + tr("(of %n GB needed)", "", BLOCK_CHAIN_SIZE/GB_BYTES);
 223             ui->freeSpace->setStyleSheet("QLabel { color: #800000 }");
 224         } else {
 225             ui->freeSpace->setStyleSheet("");
 226         }
 227         ui->freeSpace->setText(freeString + ".");
 228     }
 229     /* Don't allow confirm in ERROR state */
 230     ui->buttonBox->button(QDialogButtonBox::Ok)->setEnabled(status != FreespaceChecker::ST_ERROR);
 231 }
 232
 233 void Intro::on_dataDirectory_textChanged(const QString &dataDirStr)
 234 {
 235     /* Disable OK button until check result comes in */
 236     ui->buttonBox->button(QDialogButtonBox::Ok)->setEnabled(false);
 237     checkPath(dataDirStr);
 238 }
 239
 240 void Intro::on_ellipsisButton_clicked()
 241 {
 242     QString dir = QDir::toNativeSeparators(QFileDialog::getExistingDirectory(0, "Choose data directory", ui->dataDirectory->text()));
 243     if(!dir.isEmpty())
 244         ui->dataDirectory->setText(dir);
 245 }
 246
 247 void Intro::on_dataDirDefault_clicked()
 248 {
 249     setDataDirectory(getDefaultDataDirectory());
 250 }
 251
 252 void Intro::on_dataDirCustom_clicked()
 253 {
 254     ui->dataDirectory->setEnabled(true);
 255     ui->ellipsisButton->setEnabled(true);
 256 }
 257
 258 void Intro::startThread()
 259 {
 260     thread = new QThread(this);
 261     FreespaceChecker *executor = new FreespaceChecker(this);
 262     executor->moveToThread(thread);
 263
 264     connect(executor, SIGNAL(reply(int,QString,quint64)), this, SLOT(setStatus(int,QString,quint64)));
 265     connect(this, SIGNAL(requestCheck()), executor, SLOT(check()));
 266     /*  make sure executor object is deleted in its own thread */
 267     connect(this, SIGNAL(stopThread()), executor, SLOT(deleteLater()));
 268     connect(this, SIGNAL(stopThread()), thread, SLOT(quit()));
 269
 270     thread->start();
 271 }
 272
 273 void Intro::checkPath(const QString &dataDir)
 274 {
 275     mutex.lock();
 276     pathToCheck = dataDir;
 277     if(!signalled)
 278     {
 279         signalled = true;
 280         emit requestCheck();
 281     }
 282     mutex.unlock();
 283 }
 284
 285 QString Intro::getPathToCheck()
 286 {
 287     QString retval;
 288     mutex.lock();
 289     retval = pathToCheck;
 290     signalled = false; /* new request can be queued now */
 291     mutex.unlock();
 292     return retval;
 293 }