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). Кстати такой приватный модуль-двойник есть у каждого основного модуля. И как гласит предупреждение в каждом из приватных заголовочных файлов:
(This file is not part of the Qt API. It exists purely as an implementation detail. This header file may change from version to version without notice, or even be removed).
Итак, функция 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, который можно обрабатывать в большом количестве редакторов она отлично подходит. Приятного чтения.