fb3-читака, fb2-читалка, reader, читалка fb3, fb3-reader, формат fb3

Якийсь час тому я опублікував проект fb2-читалки, в процесі роботи над якою я дізнався, що цей формат є морально застарілим. Тому я почав освоювати нові формати та зупинився на fb3 — форматі-приймачі fb2. У процесі роботи я зіткнувся з деякими проблемами, які не вирішені у повному обсязі. До того ж, незважаючи на те, що книги у fb3 вже з'являються, формат остаточно не затверджено. Хоча книжки вже з'являються. Тому я вирішив опублікувати програму в поточному вигляді та розповісти про свої досягнення та невдачі. Згодом я планую нову версію із підтримкою формату epub.

fb3

Файл fb3 є zip-контейнером, де знаходяться елементи книги. Тому я реалізував такий алгоритм. Розпаковуємо всі файли в тимчасову папку і зчитуємо всі необхідні елементи.

if(name.endsWith(".fb3"))
{
    QString s = thisName;
    QString nameUn = QStandardPaths::standardLocations(QStandardPaths::TempLocation).at(0)
                    + "/dmreader/" + s;

    if(!openerTextFiles::UnZip(name, nameUn)) // распаковка архива
        qDebug() << "файл " << name << " не открыт";
    else
    {
        // извлекаем содержимое
        openerTextFiles::openFBFile(nameUn + "/fb3/body.xml", &text, &content); 
        // помещаем содержимое в окно textBrowser
        ui->textBrowser->setText(text);
        ui->textBrowser->verticalScrollBar()->setValue(0);
        ui->comboBoxContent->insertItems(0, content);
        ui->comboBoxContent->setCurrentIndex(-1);
        this->setWindowTitle(content.first());
    }
}

Типовий файл містить:

Папка fb3 містить основну інформацію, зокрема два ключові елементи body.xml — текст книги та description.xml — анотацію книги, які відповідають основним блокам файлу fb2. Папка img містить книги ілюстрації.
Структура body.xml за деякими змінами структури fb2. Поправки спрямовані на розширення функціональності та спрощення структури. Додані тэги ol, ul, li для створення списків. blockquote – цитата, em – акцентування тексту (курсив), pre – блок попередньо форматованого тексту ідентичні html. Теги underline (підкреслений) та spacing (розряджений) можна реалізувати наступними замінами:

<span style=\"text-decoration:underline;\">
<span style=\"letter-spacing:5px;\">

Також дещо модифікована система приміток, не зупинятимуся на цьому.
Істотно змінено систему ілюстрацій. У тексті за допомогою тега розміщено посилання на номери картинок. Для відображення малюнків необхідно попередньо рахувати посилання на них із файлу "/_rels/body.xml.rels". Для цього я створюю масив img_fb3 типу QHash , де перший рядок – посилання на малюнок за текстом, другий – шлях до малюнка в каталозі img.
Обробляється тег img так

if( sr.name().toString() == "img" ) // расположение рисунков fb3
{
    if(sr.attributes().count() > 0)
    {
        if( sr.attributes().at(0).name().toString() == "src" )
            book->append("<p align=\"center\"><img src=\""
                         + filerels + "/"
                         + img_fb3.take( sr.attributes().at(0).value().toString() )
                         + "\" alt=\"рисунок\"" + "/></p>");   
        else
            qDebug() << "img src ошибка";
    }
    break;
}

img_fb3 наповнюється так

if(sr.name().toString() == "fb3-body") // ссылки на картинки fb3
{
    QFile fr(filerels + "/_rels/body.xml.rels" );
    if (!fr.open(QIODevice::ReadOnly | QIODevice::Text))
    {
        qDebug() << "файл body.xml.rels не открыт";
        break;
    }

    QXmlStreamReader srr(&fr);
    while( !srr.atEnd() )
    {
        switch( srr.readNext() )
        {
        case QXmlStreamReader::StartElement:
            if(srr.name().toString() == "Relationship")
            {
                QString f, s;
                for(int i = 0; i < srr.attributes().count(); i++)
                {
                    if( srr.attributes().at(i).name() == "Id" )
                        s = srr.attributes().at(i).value().toString();
                    if( srr.attributes().at(i).name() == "Target" )
                        f = srr.attributes().at(i).value().toString();
                }
                if(f.indexOf("cover") != -1)
                {
                    book->append("<p align=\"center\"><img src=\""
                                 + filerels + "/" + f
                                 + "\" alt=\"рисунок\"" + "/></p>");
                }
                else
                    img_fb3.insert(s, f);
                //qDebug() << f;
            }
            break;
        default: ;
        }
    }
    fr.close();
    break;
}

Крім того, залишилися деякі теги, призначення яких мені до кінця не зрозуміло: , .

Відкриваємо zip-архів

Спочатку для розархівації я планував використати програму 7z. Але цей варіант відпав, коли я дізнався, що реалізувати розпакування файлів можна за допомогою бібліотеки zlib та інтерфейсів із бібліотек zipreader_p.h, zipwriter_p.h та zip.cpp, які можна завантажити разом з іншими вихідними Qt. Зрештою, я дізнався, що ці бібліотеки входять і в версії Qt (модуль gui-private). До речі такий приватний модуль-двійник має кожен основний модуль. І як свідчить попередження в кожному з приватних заголовних файлів:
(Цей файл не є частиною API Qt. Він існує виключно як деталь реалізації. Цей файл заголовка може змінюватися від версії до версії без попередження або навіть бути видалений).
Отже, функція UnZip(QString name, QString path) містить вміст архіву name в папку path. Як тимчасове сховище я пропоную використовувати папку "dmreader", що створюється в каталозі для зберігання тимчасових файлів QStandardPaths::standardLocations(QStandardPaths::TempLocation).at(0).
Реалізація розпакування архіву

bool openerTextFiles::UnZip(QString zfile, QString path)
{
    QZipReader cZip(zfile);
    QDir dir(path);
    if(!dir.exists())
        dir.mkpath( path );

    //bool b = cZip.extractAll( path );
    bool b = extractFiles( cZip , path );
    cZip.close();
    return b;
}

Якби ми мали справу з zip архівом, достатньо було б використовувати функцію extractAll(QString path) класу QZipReader. Однак fb3 архів має одну особливість, на якій я не зупинятимуся тут. Я доповнив цей алгоритм на коліна у функції extractFiles(QZipReader zip, QString path).

bool openerTextFiles::extractFiles(const QZipReader &zip, const QString &destinationDir)
{
    QDir baseDir(destinationDir);
    QVector<QZipReader::FileInfo> allFiles = zip.fileInfoList();
    // create directories first
    foreach (QZipReader::FileInfo fi, allFiles) {
        const QString absPath = destinationDir + QDir::separator() + fi.filePath;
        if (fi.isDir) {
            if (!baseDir.mkpath(absPath))
                return false;
            if (!QFile::setPermissions(absPath, fi.permissions))
                return false;
        }
    }
    //  ------------------------
    foreach (QZipReader::FileInfo fi, allFiles) {
        const QString absPath = destinationDir + "/" + fi.filePath;
        QString d; // для fb3
        if(absPath.indexOf("/") != -1)
        {
            d = absPath.left(absPath.lastIndexOf("/"));
            QDir dir(d);
            if(!dir.exists()){
                dir.mkdir(dir.path());
            }
        }
    }
    foreach (QZipReader::FileInfo fi, allFiles) {
        const QString absPath = destinationDir + "/" + fi.filePath;
        if(absPath.endsWith("/"))
        {
            if( !baseDir.exists(fi.filePath) )
            {
                if (!baseDir.mkdir(fi.filePath))
                    return false;
                if (!QFile::setPermissions(absPath, fi.permissions))
                    return false;
            }
        }
        else
        {
            QString d; // для fb3
            if(absPath.indexOf("/") != -1)
            {
                d = absPath.left(absPath.lastIndexOf("/"));
                QDir dir(d);
                if(!dir.exists()){
                    dir.mkdir(dir.path());
                }
            }
            QFile f(absPath);
            if (!f.open(QIODevice::WriteOnly))
                return false;
            f.write(zip.fileData(fi.filePath));
            f.setPermissions(fi.permissions);
            f.close();
        }
    }
    return true;
    //  ------------------------
    // set up symlinks
    foreach (QZipReader::FileInfo fi, allFiles) {
        const QString absPath = destinationDir + QDir::separator() + fi.filePath;
        if (fi.isSymLink) {
            QString destination = QFile::decodeName(zip.fileData(fi.filePath));
            if (destination.isEmpty())
                return false;
            QFileInfo linkFi(absPath);
            if (!QFile::exists(linkFi.absolutePath()))
                QDir::root().mkpath(linkFi.absolutePath());
            if (!QFile::link(destination, absPath))
                return false;
        }
    }
}

Вихідний текст програми можна завантажити тут .

Висновок

Написана програма не претендує на повну функціональність читання fb3 файлів. Але для того, щоб відкрити текст, подивитися його і зберегти в html, який можна обробляти у великій кількості редакторів, вона відмінно підходить. Приємного читання.