Сборка ePub с PHP и Markdown

Метод parseSpine() выполняет аналогичную работу. Он устанавливает файл NCX / TOC и составляет список объявленных идентификаторов. Идентификаторы могут быть регулярными выражениями. Например, я указал шаблон ^cd{1,2}-.*$ , Который соответствует идентификаторам глав ( c01-first-chapter , c02-second-chapter и т. Д.). Начало «c» важно, поскольку атрибуты XML- id не могут начинаться с цифры.

Мощный makeEpub() затем запускает процесс преобразования для нашей книги. Необходимые данные:

• путь к целевому файлу .epub
• временный каталог, в котором компилируются и копируются все ресурсы
• исходный каталог для файлов шаблонов
• дополнительные фильтры содержимого, в данном случае Markdown связан с расширением md

Сначала он проверяет входные параметры, чтобы убедиться, что он имеет правильные разрешения файловой системы, а затем последовательно вызывает четыре вспомогательных метода, соответствующих требуемым шагам:

• создать каталог и данные META-INF
• экспортировать все файлы содержимого, компилировать шаблоны и применять фильтры
• создать файл манифеста OPF
• создать файл навигации NCX (если необходимо)
• создать сжатый архив epub

Метод createMetaInf() является самым простым и помогает нам понять логику шаблона за другими:

 <?php protected function createMetaInf($workDir) { // create destination directory if (!mkdir("$workDir/META-INF")) { throw new Exception('Unable to create content META-INF directory'); } // compile file $tpl = $this->initTemplateEngine( array( 'tpl_dir' => "{$this->params['templates_dir']}/", 'tpl_ext' => 'xml', 'cache_dir' => sys_get_temp_dir() . '/' ) ); $tpl->assign('ContentDirectory', $this->params['content_dir']); $container = $tpl->draw('book/META-INF/container', true); // write compiled file to destination if (file_put_contents("$workDir/META-INF/container.xml", $container) === false) { throw new Exception("Unable to create content META-INF/container.xml"); } } 

В шаблоне container.xml есть только одна переменная, которая задает путь к файлу content.opf относительно базового каталога книги. Синтаксис: {$VariableName} .

 <?xml version="1.0"?> <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container"> <rootfiles> <rootfile full-path="{$ContentDirectory}/content.opf" media-type="application/oebps-package+xml"/> </rootfiles> </container> 

Сначала библиотека RainTPL инициализируется с помощью каталога шаблонов, расширения файлов шаблонов и каталога временного кэша. Затем присваивается переменная шаблона ( $tpl->assign() ) и метод draw() анализирует предоставленный файл шаблона. Его второй параметр сообщает draw() , возвращать ли результат. Скомпилированный файл затем сохраняется в путь назначения.

Метод createOpf() имеет ту же логику и еще несколько переменных для назначения. Я выбрал шаблон Book<Varname> поэтому дополнительные метаданные назначаются в цикле:

 <?php $optParams = array( 'authors', 'date', 'description', 'publisher', 'relation', 'rights', 'subject' ); foreach ($optParams as $p) { if (isset($this->$p)) { $tpl->assign('Book' . ucfirst($p), $this->$p); } } 

И они вставляются в шаблон с условным синтаксисом:

 {if="$BookDescription"}<dc:description>{$BookDescription}</dc:description>{/if} 

Файлы и переменные позвоночника форматируются в методе и вставляются в шаблон с помощью цикла:

 <manifest> {loop="$BookFiles"}<item id="{$key}" href="{$value.path}" media-type="{$value.type}"/> {/loop} </manifest> 

processBookFiles() вызывается перед createOpf() и выполняет большой цикл со всеми ссылочными ресурсами ( $this->files ). Для каждого ресурса он может выбирать между двумя действиями:

• обработать и отфильтровать файл
• скопируйте путь к файлу «как есть» в целевом каталоге

Фильтр, применяемый к файлу, должен быть вызываемой функцией PHP или методом класса, который принимает один параметр: содержимое. Содержимое файла загружается из исходного источника с помощью file_get_contents() а фильтр применяется с помощью встроенного call_user_func() :

 <?php $content = call_user_func($filters[$ext], $content); 

Обработанный контент затем внедряется в шаблон XHTML, аналогично предыдущим методам. В этом случае также есть возможность использовать пользовательский шаблон. Если в .xhtml templates есть файл с именем .xhtml , этот файл будет использоваться page.xhtml по умолчанию. Кроме того, если style.css файл style.css то {$BookStyle} переменная шаблона {$BookStyle} и CSS связывается со страницей.

Полученный файл затем записывается в каталог назначения, и запись манифеста для этого файла обновляется с использованием нового пути и типа носителя, готовых для createOpf() .

createNcx() немного сложнее, потому что он должен изучить элементы секции позвоночника и извлечь содержимое тегов H1 и H2. Файл toc.ncx имеет такую ​​структуру, сначала стандартизированный заголовок:

 <?xml version="1.0" encoding="UTF-8"?> <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1"> <head> <meta name="dtb:uid" content="{$BookID}"/> <!-- 1 = chapters only, 2 = subchapters, 3 = third level section --> <meta name="dtb:depth" content="2"/> <!-- Both required but unused, can be 0 --> <meta name="dtb:totalPageCount" content="0"/> <meta name="dtb:maxPageNumber" content="0"/> </head> <docTitle> <text>{$BookTitle}</text> </docTitle> 

Настраиваемая dtb:uid указывает идентификатор нашей книги, а dtb:depth говорит о глубине навигации. Здесь я выбираю фиксированное значение 2, поэтому в коде синтаксического анализа я должен извлечь первые два уровня заголовков.

После заголовка есть <navMap> который генерируется с помощью цикла шаблона.

 {$playOrder=1} {loop="$BookChapters"} <navPoint id="{$key}" playOrder="{$playOrder++}"> <navLabel> <text>{$value.title}</text> </navLabel> <content src="{$value.path}"/> {if="isset($value.sections)"}{loop="$value.sections"} <navPoint id="{$key}" playOrder="{$playOrder++}"> <navLabel> <text>{$value.title}</text> </navLabel> <content src="{$value.path}"/> </navPoint> {/loop}{/if} </navPoint> {/loop} , {$playOrder=1} {loop="$BookChapters"} <navPoint id="{$key}" playOrder="{$playOrder++}"> <navLabel> <text>{$value.title}</text> </navLabel> <content src="{$value.path}"/> {if="isset($value.sections)"}{loop="$value.sections"} <navPoint id="{$key}" playOrder="{$playOrder++}"> <navLabel> <text>{$value.title}</text> </navLabel> <content src="{$value.path}"/> </navPoint> {/loop}{/if} </navPoint> {/loop} 

Каждый H1 становится <navPoint> , id — это соответствующий идентификатор ресурса (например, c01-first-chapter и т. Д.), Содержимое H1 становится меткой, а атрибут playOrder указывает глобальный порядок чтения. В нашем примере каждая точка навигации может иметь вложенные точки навигации для субтитров H2.

В методе двойной цикл генерирует массив, структурированный так:

 $chapters['c01-first-chapter'] = array( 'title' => 'Title for chapter 1', 'path' => '01-first-chapter.xhtml', 'sections' => array( 'section-1-1' => array( 'title' => 'Title for subsection 1.1', 'path' => '01-first-chapter.xhtml#section-1-1', ) ) ) 

Во внешнем цикле каждый элемент загружается как объект SimpleXML :

 <?php $doc = simplexml_load_file("$workDir/{$this->params['content_dir']}/{$this->files[$item]['path']}"); if ($doc && isset($doc->body->h1)) { // chapter title $chapters[$item] = array( 'title' => $doc->body->h1, 'path' => $this->files[$item]['path'] ); // subchapter title foreach ($doc->body->h2 as $section) { if (!empty($section['id'])) { $section_id = (string) $section['id']; $chapters[$item]['sections'][$section_id] = array( 'title' => $section, 'path' => $this->files[$item]['path'] . '#' . $section['id'] ); } } } 

Если документ имеет заголовок H1, элемент первого уровня вставляется в массив $chapters . Затем запрашиваются заголовки второго уровня, каждый заголовок с непустым атрибутом id включается в разделы для каждой главы. Массив $chapters становится {$BookChapters} в шаблоне. Затем шаблон отображается и сохраняется в месте назначения.

Теперь у нас есть рабочий каталог назначения в /tmp/path/com.publisher.BookID который можно упаковать на последнем шаге createArchive() :

 <?php protected function createArchive($workDir, $epubFile) { $excludes = array('.DS_Store', 'mimetype'); $mimeZip = "{$this->params['templates_dir']}/mimetype.zip"; $zipFile = sys_get_temp_dir() . '/book.zip'; if (!copy($mimeZip, $zipFile)) { throw new Exception("Unable to copy temporary archive file"); } $zip = new ZipArchive(); if ($zip->open($zipFile, ZipArchive::CREATE) != true) { throw new Exception("Unable open archive '$zipFile'"); } $files = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($workDir), RecursiveIteratorIterator::SELF_FIRST); foreach ($files as $file) { if (in_array(basename($file), $excludes)) { continue; } if (is_dir($file)) { $zip->addEmptyDir(str_replace("$workDir/", '', "$file/")); } elseif (is_file($file)) { $zip->addFromString( str_replace("$workDir/", '', $file), file_get_contents($file) ); } } $zip->close(); rename($zipFile, $epubFile); } 

Массив $excludes содержит специальные и системные файлы, которые нам не нужны в архиве. Создается временный путь для пустого $zipFile , а затем путь $zipFile заполняется копией нашего базового mimetype.zip который загружается в объект ZipArchive . На этом этапе содержимое рабочего каталога рекурсивно загружается в массив $files с использованием объектов RecursiveIteratorIterator и RecursiveDirectoryIterator . В следующем цикле структура рабочего каталога копируется в zip-архив. Как последний штрих, архив перемещается в путь назначения, указанный вызывающей стороной.

Резюме

Когда все сказано и сделано, у нас есть новая блестящая электронная книга. У нас есть хороший шанс, что он будет проверен приложением EpubCheck, и, самое главное, у нас есть еще один полезный инструмент, который можно добавить в наш пояс супергероя PHP! И это только отправная точка, вы можете поиграть с кодом, чтобы добавить фильтры, функции, темы, стили и многое другое, если хотите. Сохраняйте спокойствие, получайте удовольствие и пишите эти электронные книги!

Изображение через Fotolia