rbutil/rbutilqt/base/bootloaderinstallbase.cpp

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  *
   9  *   Copyright (C) 2008 by Dominik Riebeling
  10  *   $Id$
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19
  20
  21 #include <QtCore>
  22
  23 #include "bootloaderinstallbase.h"
  24 #include "bootloaderinstallmi4.h"
  25 #include "bootloaderinstallhex.h"
  26 #include "bootloaderinstallipod.h"
  27 #include "bootloaderinstallsansa.h"
  28 #include "bootloaderinstallfile.h"
  29 #include "bootloaderinstallchinachip.h"
  30 #include "bootloaderinstallams.h"
  31 #include "bootloaderinstalltcc.h"
  32 #include "bootloaderinstallmpio.h"
  33 #include "utils.h"
  34
  35 #if defined(Q_OS_MACX)
  36 #include <sys/param.h>
  37 #include <sys/ucred.h>
  38 #include <sys/mount.h>
  39 #endif
  40
  41
  42 BootloaderInstallBase* BootloaderInstallBase::createBootloaderInstaller(QObject* parent,QString type)
  43 {
  44     if(type == "mi4") {
  45         return new BootloaderInstallMi4(parent);
  46     }
  47     else if(type == "hex") {
  48         return new BootloaderInstallHex(parent);
  49     }
  50     else if(type == "sansa") {
  51         return new BootloaderInstallSansa(parent);
  52     }
  53     else if(type == "ipod") {
  54         return new BootloaderInstallIpod(parent);
  55     }
  56     else if(type == "file") {
  57         return new BootloaderInstallFile(parent);
  58     }
  59     else if(type == "chinachip") {
  60         return new BootloaderInstallChinaChip(parent);
  61     }
  62     else if(type == "ams") {
  63         return new BootloaderInstallAms(parent);
  64     }
  65     else if(type == "tcc") {
  66         return new BootloaderInstallTcc(parent);
  67     }
  68     else if(type == "mpio") {
  69         return new BootloaderInstallMpio(parent);
  70     }
  71     else {
  72         return NULL;
  73     }
  74
  75 }
  76
  77 BootloaderInstallBase::BootloaderType BootloaderInstallBase::installed(void)
  78 {
  79     return BootloaderUnknown;
  80 }
  81
  82
  83 BootloaderInstallBase::Capabilities BootloaderInstallBase::capabilities(void)
  84 {
  85     return 0;
  86 }
  87
  88
  89 void BootloaderInstallBase::downloadBlStart(QUrl source)
  90 {
  91     m_http.setFile(&m_tempfile);
  92     m_http.setCache(true);
  93     connect(&m_http, SIGNAL(done(bool)), this, SLOT(downloadBlFinish(bool)));
  94     // connect the http read signal to our logProgess *signal*
  95     // to immediately emit it without any helper function.
  96     connect(&m_http, SIGNAL(dataReadProgress(int, int)),
  97             this, SIGNAL(logProgress(int, int)));
  98     m_http.getFile(source);
  99 }
 100
 101
 102 void BootloaderInstallBase::downloadReqFinished(int id, bool error)
 103 {
 104     qDebug() << "[BootloaderInstallBase] Download Request" << id
 105              << "finished, error:" << m_http.errorString();
 106
 107     downloadBlFinish(error);
 108 }
 109
 110
 111 void BootloaderInstallBase::downloadBlFinish(bool error)
 112 {
 113     qDebug() << "[BootloaderInstallBase] Downloading bootloader finished, error:"
 114              << error;
 115
 116     // update progress bar
 117     emit logProgress(100, 100);
 118
 119     if(m_http.httpResponse() != 200) {
 120         emit logItem(tr("Download error: received HTTP error %1.")
 121                 .arg(m_http.errorString()), LOGERROR);
 122         emit done(true);
 123         return;
 124     }
 125     if(error) {
 126         emit logItem(tr("Download error: %1")
 127                 .arg(m_http.error()), LOGERROR);
 128         emit done(true);
 129         return;
 130     }
 131     else if(m_http.isCached())
 132         emit logItem(tr("Download finished (cache used)."), LOGOK);
 133     else
 134         emit logItem(tr("Download finished."), LOGOK);
 135
 136     QCoreApplication::processEvents();
 137     m_blversion = m_http.timestamp();
 138     emit downloadDone();
 139 }
 140
 141 void BootloaderInstallBase::installBlfile(void)
 142 {
 143     qDebug() << "[BootloaderInstallBase]" << __func__;
 144 }
 145
 146
 147 //! @brief backup OF file.
 148 //! @param to folder to write backup file to. Folder will get created.
 149 //! @return true on success, false on error.
 150
 151 bool BootloaderInstallBase::backup(QString to)
 152 {
 153     qDebug() << "[BootloaderInstallBase] Backing up bootloader file";
 154     QDir targetDir(".");
 155     emit logItem(tr("Creating backup of original firmware file."), LOGINFO);
 156     if(!targetDir.mkpath(to)) {
 157         emit logItem(tr("Creating backup folder failed"), LOGERROR);
 158         return false;
 159     }
 160     QString tofile = to + "/" + QFileInfo(m_blfile).fileName();
 161     qDebug() << "[BootloaderInstallBase] trying to backup" << m_blfile << "to" << tofile;
 162     if(!QFile::copy(Utils::resolvePathCase(m_blfile), tofile)) {
 163         emit logItem(tr("Creating backup copy failed."), LOGERROR);
 164         return false;
 165     }
 166     emit logItem(tr("Backup created."), LOGOK);
 167     return true;
 168 }
 169
 170
 171 //! @brief log installation to logfile.
 172 //! @param mode action to perform. 0: add to log, 1: remove from log.
 173 //! @return 0 on success
 174 int BootloaderInstallBase::logInstall(LogMode mode)
 175 {
 176     int result = 0;
 177     QString section = m_blurl.path().section('/', -1);
 178     QSettings s(m_logfile, QSettings::IniFormat, this);
 179     emit logItem(tr("Creating installation log"), LOGINFO);
 180
 181     if(mode == LogAdd) {
 182         s.setValue("Bootloader/" + section, m_blversion.toString(Qt::ISODate));
 183         qDebug() << "[BootloaderInstallBase] Writing log, version:"
 184                  << m_blversion.toString(Qt::ISODate);
 185     }
 186     else {
 187         s.remove("Bootloader/" + section);
 188     }
 189     s.sync();
 190
 191     emit logItem(tr("Installation log created"), LOGOK);
 192
 193     return result;
 194 }
 195
 196
 197 //! @brief Return post install hints string.
 198 //! @param model model string
 199 //! @return hints.
 200 QString BootloaderInstallBase::postinstallHints(QString model)
 201 {
 202     bool hint = false;
 203     QString msg = tr("Bootloader installation is almost complete. "
 204             "Installation <b>requires</b> you to perform the "
 205             "following steps manually:");
 206
 207     msg += "<ol>";
 208     msg += tr("<li>Safely remove your player.</li>");
 209     if(model == "h100" || model == "h120" || model == "h300" ||
 210        model == "ondavx747") {
 211         hint = true;
 212         msg += tr("<li>Reboot your player into the original firmware.</li>"
 213                 "<li>Perform a firmware upgrade using the update functionality "
 214                 "of the original firmware. Please refer to your player's manual "
 215                 "on details.</li>"
 216                 "<li>After the firmware has been updated reboot your player.</li>");
 217     }
 218     if(model == "iaudiox5" || model == "iaudiom5"
 219             || model == "iaudiox5v" || model == "iaudiom3" || model == "mpioh200") {
 220         hint = true;
 221         msg += tr("<li>Turn the player off</li>"
 222                 "<li>Insert the charger</li>");
 223     }
 224     if(model == "gigabeatf") {
 225         hint = true;
 226         msg += tr("<li>Unplug USB and power adaptors</li>"
 227                 "<li>Hold <i>Power</i> to turn the player off</li>"
 228                 "<li>Toggle the battery switch on the player</li>"
 229                 "<li>Hold <i>Power</i> to boot into Rockbox</li>");
 230     }
 231     msg += "</ol>";
 232     msg += tr("<p><b>Note:</b> You can safely install other parts first, but "
 233             "the above steps are <b>required</b> to finish the installation!</p>");
 234
 235     if(hint)
 236         return msg;
 237     else
 238         return QString("");
 239 }
 240
 241
 242 #if defined(Q_OS_MACX)
 243 void BootloaderInstallBase::waitRemount()
 244 {
 245     m_remountTries = 600;
 246     emit logItem(tr("Waiting for system to remount player"), LOGINFO);
 247
 248     QTimer::singleShot(100, this, SLOT(checkRemount()));
 249 }
 250 #endif
 251
 252
 253 void BootloaderInstallBase::checkRemount()
 254 {
 255 #if defined(Q_OS_MACX)
 256     if(m_remountTries--) {
 257         int status = 0;
 258         // check if device has been remounted
 259         QCoreApplication::processEvents();
 260         int num;
 261         struct statfs *mntinf;
 262
 263         num = getmntinfo(&mntinf, MNT_WAIT);
 264         while(num--) {
 265             if(QString(mntinf->f_mntfromname).startsWith(m_remountDevice)
 266                     && QString(mntinf->f_fstypename).contains("msdos", Qt::CaseInsensitive))
 267                 status = 1;
 268             mntinf++;
 269         }
 270         if(!status) {
 271             // still not remounted, restart timer.
 272             QTimer::singleShot(500, this, SLOT(checkRemount()));
 273             qDebug() << "[BootloaderInstallBase] Player not remounted yet" << m_remountDevice;
 274         }
 275         else {
 276             emit logItem(tr("Player remounted"), LOGINFO);
 277             emit remounted(true);
 278         }
 279     }
 280     else {
 281         emit logItem(tr("Timeout on remount"), LOGERROR);
 282         emit remounted(false);
 283     }
 284 #endif
 285 }
 286
 287
 288 //! @brief set list of possible bootloader files and pick the existing one.
 289 //! @param sl list of possible bootloader files.
 290 void BootloaderInstallBase::setBlFile(QStringList sl)
 291 {
 292     // figue which of the possible bootloader filenames is correct.
 293     for(int a = 0; a < sl.size(); a++) {
 294         if(!Utils::resolvePathCase(sl.at(a)).isEmpty()) {
 295             m_blfile = sl.at(a);
 296         }
 297     }
 298     if(m_blfile.isEmpty()) {
 299         m_blfile = sl.at(0);
 300     }
 301 }
 302