vcs.maemo.org Git - dorian/blob - model/book.cpp

   1 #include <QDir>
   2 #include <QString>
   3 #include <QDebug>
   4 #include <QtXml>
   5 #include <qtextdocument.h>  // Qt::escape is currently defined here...
   6 #include <QDirIterator>
   7 #include <QFileInfo>
   8 #include <QtAlgorithms>
   9 #include <QVariantHash>
  10
  11 #include "book.h"
  12 #include "opshandler.h"
  13 #include "xmlerrorhandler.h"
  14 #include "extractzip.h"
  15 #include "library.h"
  16 #include "containerhandler.h"
  17 #include "ncxhandler.h"
  18 #include "trace.h"
  19 #include "bookdb.h"
  20
  21 const int COVER_WIDTH = 53;
  22 const int COVER_HEIGHT = 59;
  23
  24 static QImage makeCover(const QString &path)
  25 {
  26     return QImage(path).scaled(COVER_WIDTH, COVER_HEIGHT,
  27         Qt::KeepAspectRatioByExpanding, Qt::SmoothTransformation).
  28         scaled(COVER_WIDTH, COVER_HEIGHT, Qt::KeepAspectRatio);
  29 }
  30
  31 Book::Book(const QString &p, QObject *parent): QObject(parent)
  32 {
  33     mPath = "";
  34     if (p.size()) {
  35         QFileInfo info(p);
  36         mPath = info.absoluteFilePath();
  37         title = info.baseName();
  38         cover = makeCover(":/icons/book.png");
  39         mTempFile.open();
  40     }
  41 }
  42
  43 QString Book::path() const
  44 {
  45     return mPath;
  46 }
  47
  48 bool Book::open()
  49 {
  50     TRACE;
  51     qDebug() << path();
  52     close();
  53     clear();
  54     if (path().isEmpty()) {
  55         title = "No book";
  56         return false;
  57     }
  58     if (!extract(QStringList())) {
  59         return false;
  60     }
  61     if (!parse()) {
  62         return false;
  63     }
  64     save();
  65     emit opened(path());
  66     return true;
  67 }
  68
  69 void Book::peek()
  70 {
  71     TRACE;
  72     qDebug() << path();
  73     close();
  74     clear();
  75     if (path().isEmpty()) {
  76         title = "No book";
  77         return;
  78     }
  79     if (!extractMetaData()) {
  80         return;
  81     }
  82     if (!parse()) {
  83         return;
  84     }
  85     save();
  86     close();
  87 }
  88
  89 void Book::close()
  90 {
  91     TRACE;
  92     content.clear();
  93     parts.clear();
  94     QDir::setCurrent(QDir::rootPath());
  95     clearDir(tmpDir());
  96 }
  97
  98 QString Book::tmpDir() const
  99 {
 100     QString tmpName = QFileInfo(mTempFile.fileName()).fileName();
 101     return QDir(QDir::temp().absoluteFilePath("dorian")).
 102             absoluteFilePath(tmpName);
 103 }
 104
 105 bool Book::extract(const QStringList &excludedExtensions)
 106 {
 107     TRACE;
 108     bool ret = false;
 109     QString tmp = tmpDir();
 110     qDebug() << "Extracting" << mPath << "to" << tmp;
 111
 112     QDir::setCurrent(QDir::rootPath());
 113     if (!clearDir(tmp)) {
 114         qCritical() << "Book::extract: Failed to remove" << tmp;
 115         return false;
 116     }
 117     QDir d(tmp);
 118     if (!d.exists()) {
 119         if (!d.mkpath(tmp)) {
 120             qCritical() << "Book::extract: Could not create" << tmp;
 121             return false;
 122         }
 123     }
 124
 125     // If book comes from resource, copy it to the temporary directory first
 126     QString bookPath = path();
 127     if (bookPath.startsWith(":/books/")) {
 128         QFile src(bookPath);
 129         QString dst(QDir(tmp).absoluteFilePath("book.epub"));
 130         if (!src.copy(dst)) {
 131             qCritical() << "Book::extract: Failed to copy built-in book"
 132                     << bookPath << "to" << dst;
 133             return false;
 134         }
 135         bookPath = dst;
 136     }
 137
 138     QString oldDir = QDir::currentPath();
 139     if (!QDir::setCurrent(tmp)) {
 140         qCritical() << "Book::extract: Could not change to" << tmp;
 141         return false;
 142     }
 143     ret = extractZip(bookPath, excludedExtensions);
 144     if (!ret) {
 145         qCritical() << "Book::extract: Extracting ZIP failed";
 146     }
 147     QDir::setCurrent(oldDir);
 148     return ret;
 149 }
 150
 151 bool Book::parse()
 152 {
 153     TRACE;
 154
 155     // Parse OPS file
 156     bool ret = false;
 157     QString opsFileName = opsPath();
 158     qDebug() << "Parsing OPS file" << opsFileName;
 159     QFile opsFile(opsFileName);
 160     QXmlSimpleReader reader;
 161     QXmlInputSource *source = new QXmlInputSource(&opsFile);
 162     OpsHandler *opsHandler = new OpsHandler(*this);
 163     XmlErrorHandler *errorHandler = new XmlErrorHandler();
 164     reader.setContentHandler(opsHandler);
 165     reader.setErrorHandler(errorHandler);
 166     ret = reader.parse(source);
 167     delete errorHandler;
 168     delete opsHandler;
 169     delete source;
 170
 171     // Initially, put all content items in the chapter list.
 172     // This will be refined by parsing the NCX file later
 173     chapters = parts;
 174
 175     // Load cover image
 176     QString coverPath;
 177     QStringList coverKeys;
 178     coverKeys << "cover-image" << "img-cover-jpeg" << "cover";
 179     foreach (QString key, coverKeys) {
 180         if (content.contains(key)) {
 181             coverPath = QDir(rootPath()).absoluteFilePath(content[key].href);
 182             break;
 183         }
 184     }
 185     if (coverPath.isEmpty()) {
 186         // Last resort
 187         QString coverJpeg = QDir(rootPath()).absoluteFilePath("cover.jpg");
 188         if (QFileInfo(coverJpeg).exists()) {
 189             coverPath = coverJpeg;
 190         }
 191     }
 192     if (!coverPath.isEmpty()) {
 193         qDebug() << "Loading cover image from" << coverPath;
 194         cover = makeCover(coverPath);
 195     }
 196
 197     // If there is an "ncx" item in content, parse it: That's the real table of
 198     // contents
 199     QString ncxFileName;
 200     if (content.contains("ncx")) {
 201         ncxFileName = content["ncx"].href;
 202     } else if (content.contains("ncxtoc")) {
 203         ncxFileName = content["ncxtoc"].href;
 204     } else if (content.contains("toc")) {
 205         ncxFileName = content["toc"].href;
 206     } else {
 207         qDebug() << "No NCX table of contents";
 208     }
 209     if (!ncxFileName.isEmpty()) {
 210         qDebug() << "Parsing NCX file" << ncxFileName;
 211         QFile ncxFile(QDir(rootPath()).absoluteFilePath(ncxFileName));
 212         source = new QXmlInputSource(&ncxFile);
 213         NcxHandler *ncxHandler = new NcxHandler(*this);
 214         errorHandler = new XmlErrorHandler();
 215         reader.setContentHandler(ncxHandler);
 216         reader.setErrorHandler(errorHandler);
 217         ret = reader.parse(source);
 218         delete errorHandler;
 219         delete ncxHandler;
 220         delete source;
 221     }
 222
 223     // Calculate book part sizes
 224     size = 0;
 225     foreach (QString part, parts) {
 226         QFileInfo info(QDir(rootPath()).absoluteFilePath(content[part].href));
 227         content[part].size = info.size();
 228         size += content[part].size;
 229     }
 230
 231     return ret;
 232 }
 233
 234 bool Book::clearDir(const QString &dir)
 235 {
 236     QDir d(dir);
 237     if (!d.exists()) {
 238         return true;
 239     }
 240     QDirIterator i(dir, QDirIterator::Subdirectories);
 241     while (i.hasNext()) {
 242         QString entry = i.next();
 243         if (entry.endsWith("/.") || entry.endsWith("/..")) {
 244             continue;
 245         }
 246         QFileInfo info(entry);
 247         if (info.isDir()) {
 248             if (!clearDir(entry)) {
 249                 return false;
 250             }
 251         }
 252         else {
 253             if (!QFile::remove(entry)) {
 254                 qCritical() << "Book::clearDir: Could not remove" << entry;
 255                 // FIXME: To be investigated: This is happening too often
 256                 // return false;
 257             }
 258         }
 259     }
 260     (void)d.rmpath(dir);
 261     return true;
 262 }
 263
 264 void Book::clear()
 265 {
 266     close();
 267     title = "";
 268     creators.clear();
 269     date = "";
 270     publisher = "";
 271     datePublished = "";
 272     subject = "";
 273     source = "";
 274     rights = "";
 275 }
 276
 277 void Book::load()
 278 {
 279     TRACE;
 280     qDebug() << "path" << path();
 281
 282     QVariantHash data = BookDb::instance()->load(path());
 283     title = data["title"].toString();
 284     qDebug() << title;
 285     creators = data["creators"].toStringList();
 286     date = data["date"].toString();
 287     publisher = data["publisher"].toString();
 288     datePublished = data["datepublished"].toString();
 289     subject = data["subject"].toString();
 290     source = data["source"].toString();
 291     rights = data["rights"].toString();
 292     mLastBookmark.part = data["lastpart"].toInt();
 293     mLastBookmark.pos = data["lastpos"].toReal();
 294     cover = data["cover"].value<QImage>().scaled(COVER_WIDTH,
 295         COVER_HEIGHT, Qt::IgnoreAspectRatio, Qt::SmoothTransformation);
 296     if (cover.isNull()) {
 297         cover = makeCover(":/icons/book.png");
 298     }
 299     int size = data["bookmarks"].toInt();
 300     for (int i = 0; i < size; i++) {
 301         int part = data[QString("bookmark%1part").arg(i)].toInt();
 302         qreal pos = data[QString("bookmark%1pos").arg(i)].toReal();
 303         QString note = data[QString("bookmark%1note").arg(i)].toString();
 304         mBookmarks.append(Bookmark(part, pos, note));
 305     }
 306 }
 307
 308 void Book::save()
 309 {
 310     TRACE;
 311
 312     QVariantHash data;
 313     data["title"] = title;
 314     data["creators"] = creators;
 315     data["date"] = date;
 316     data["publisher"] = publisher;
 317     data["datepublished"] = datePublished;
 318     data["subject"] = subject;
 319     data["source"] = source;
 320     data["rights"] = rights;
 321     data["lastpart"] = mLastBookmark.part;
 322     data["lastpos"] = mLastBookmark.pos;
 323     data["cover"] = cover;
 324     data["bookmarks"] = mBookmarks.size();
 325     for (int i = 0; i < mBookmarks.size(); i++) {
 326         data[QString("bookmark%1part").arg(i)] = mBookmarks[i].part;
 327         data[QString("bookmark%1pos").arg(i)] = mBookmarks[i].pos;
 328         data[QString("bookmark%1note").arg(i)] = mBookmarks[i].note;
 329     }
 330     BookDb::instance()->save(path(), data);
 331 }
 332
 333 void Book::setLastBookmark(int part, qreal position)
 334 {
 335     TRACE;
 336     qDebug() << "part" << part << "position" << position;
 337     mLastBookmark.part = part;
 338     mLastBookmark.pos = position;
 339     save();
 340 }
 341
 342 Book::Bookmark Book::lastBookmark() const
 343 {
 344     return Book::Bookmark(mLastBookmark);
 345 }
 346
 347 void Book::addBookmark(int part, qreal position, const QString &note)
 348 {
 349     mBookmarks.append(Bookmark(part, position, note));
 350     qSort(mBookmarks.begin(), mBookmarks.end());
 351     save();
 352 }
 353
 354 void Book::deleteBookmark(int index)
 355 {
 356     mBookmarks.removeAt(index);
 357     save();
 358 }
 359
 360 QList<Book::Bookmark> Book::bookmarks() const
 361 {
 362     return mBookmarks;
 363 }
 364
 365 QString Book::opsPath()
 366 {
 367     TRACE;
 368     QString ret;
 369
 370     QFile container(tmpDir() + "/META-INF/container.xml");
 371     qDebug() << container.fileName();
 372     QXmlSimpleReader reader;
 373     QXmlInputSource *source = new QXmlInputSource(&container);
 374     ContainerHandler *containerHandler = new ContainerHandler();
 375     XmlErrorHandler *errorHandler = new XmlErrorHandler();
 376     reader.setContentHandler(containerHandler);
 377     reader.setErrorHandler(errorHandler);
 378     if (reader.parse(source)) {
 379         ret = tmpDir() + "/" + containerHandler->rootFile;
 380         mRootPath = QFileInfo(ret).absoluteDir().absolutePath();
 381         qDebug() << "OSP path" << ret << "\nRoot dir" << mRootPath;
 382     }
 383     delete errorHandler;
 384     delete containerHandler;
 385     delete source;
 386     return ret;
 387 }
 388
 389 QString Book::rootPath() const
 390 {
 391     return mRootPath;
 392 }
 393
 394 QString Book::name() const
 395 {
 396     if (title.size()) {
 397         QString ret = title;
 398         if (creators.length()) {
 399             ret += "\nBy " + creators[0];
 400             for (int i = 1; i < creators.length(); i++) {
 401                 ret += ", " + creators[i];
 402             }
 403         }
 404         return ret;
 405     } else {
 406         return path();
 407     }
 408 }
 409
 410 QString Book::shortName() const
 411 {
 412     return (title.isEmpty())? QFileInfo(path()).baseName(): title;
 413 }
 414
 415 int Book::chapterFromPart(int index)
 416 {
 417     int ret = -1;
 418
 419     QString partId = parts[index];
 420     QString partHref = content[partId].href;
 421
 422     for (int i = 0; i < chapters.size(); i++) {
 423         QString id = chapters[i];
 424         QString href = content[id].href;
 425         QString baseRef(href);
 426         QUrl url(QString("file://") + href);
 427         if (url.hasFragment()) {
 428             QString fragment = url.fragment();
 429             baseRef.chop(fragment.length() + 1);
 430         }
 431         if (baseRef == partHref) {
 432             ret = i;
 433             // Don't break, keep looking
 434         }
 435     }
 436
 437     return ret;
 438 }
 439
 440 int Book::partFromChapter(int index)
 441 {
 442     Trace t("Book::partFromChapter");
 443     QString id = chapters[index];
 444     QString href = content[id].href;
 445     int hashPos = href.indexOf("#");
 446     if (hashPos != -1) {
 447         href = href.left(hashPos);
 448     }
 449
 450     qDebug() << "Chapter" << index;
 451     qDebug() << " id" << id;
 452     qDebug() << " href" << href;
 453
 454     for (int i = 0; i < parts.size(); i++) {
 455         QString partId = parts[i];
 456         if (content[partId].href == href) {
 457             qDebug() << "Part index for" << href << "is" << i;
 458             return i;
 459         }
 460     }
 461
 462     qWarning() << "Book::partFromChapter: Could not find part index for"
 463             << href;
 464     return -1;
 465 }
 466
 467 qreal Book::getProgress(int part, qreal position)
 468 {
 469     Q_ASSERT(part < parts.size());
 470     QString key;
 471     qreal partSize = 0;
 472     for (int i = 0; i < part; i++) {
 473         key = parts[i];
 474         partSize += content[key].size;
 475     }
 476     key = parts[part];
 477     partSize += content[key].size * position;
 478     return partSize / (qreal)size;
 479 }
 480
 481 bool Book::extractMetaData()
 482 {
 483     QStringList excludedExtensions;
 484     excludedExtensions << ".html" << ".xhtml" << ".xht" << ".htm";
 485     return extract(excludedExtensions);
 486 }
 487
 488 void Book::upgrade()
 489 {
 490     TRACE;
 491
 492     qDebug() << path();
 493
 494     // Load book from old database (QSettings)
 495
 496     QSettings settings;
 497     QString key = "book/" + path() + "/";
 498     title = settings.value(key + "title").toString();
 499     qDebug() << title;
 500     creators = settings.value(key + "creators").toStringList();
 501     date = settings.value(key + "date").toString();
 502     publisher = settings.value(key + "publisher").toString();
 503     datePublished = settings.value(key + "datepublished").toString();
 504     subject = settings.value(key + "subject").toString();
 505     source = settings.value(key + "source").toString();
 506     rights = settings.value(key + "rights").toString();
 507     mLastBookmark.part = settings.value(key + "lastpart").toInt();
 508     mLastBookmark.pos = settings.value(key + "lastpos").toReal();
 509     cover = settings.value(key + "cover").value<QImage>().scaled(COVER_WIDTH,
 510         COVER_HEIGHT, Qt::IgnoreAspectRatio, Qt::SmoothTransformation);
 511     if (cover.isNull()) {
 512         cover = makeCover(":/icons/book.png");
 513     }
 514     int size = settings.value(key + "bookmarks").toInt();
 515     for (int i = 0; i < size; i++) {
 516         int part = settings.value(key + "bookmark" + QString::number(i) +
 517                                      "/part").toInt();
 518         qreal pos = settings.value(key + "bookmark" + QString::number(i) +
 519                                    "/pos").toReal();
 520         qDebug() << QString("Bookmark %1 at part %2, %3").
 521                 arg(i).arg(part).arg(pos);
 522         mBookmarks.append(Bookmark(part, pos));
 523     }
 524
 525     // Save book to new database
 526
 527     save();
 528 }
 529
 530 void Book::remove()
 531 {
 532     TRACE;
 533     BookDb::instance()->remove(path());
 534 }