From da0f051e1aced4fa1fd5cd13c0548279bf04b2a0 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 12 Apr 2017 15:23:23 -0400 Subject: 0.13.9 sisupod & epub3, zipped output --- org/output.org | 932 ++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 685 insertions(+), 247 deletions(-) (limited to 'org/output.org') diff --git a/org/output.org b/org/output.org index e84796d..a9fdc74 100644 --- a/org/output.org +++ b/org/output.org @@ -17,7 +17,7 @@ #+BEGIN_SRC d :tangle ../src/sdp/output_hub.d /++ - output hub
+ output hub
check & generate output types requested +/ template outputHub() { @@ -38,13 +38,14 @@ template outputHub() { std.traits, std.typecons, std.uni, - std.utf, + std.utf; + import defaults, - output_epub, + output_epub3, output_html, output_xhtmls, - source_sisupod; - import + source_sisupod, + create_zip_file, output_rgx, output_xhtmls; void outputHub(D,I)(D doc_abstraction, I doc_matters) { @@ -83,10 +84,10 @@ template outputHub() { if ((doc_matters.opt_action_bool["verbose"])) {writeln("html scroll done");} } if (doc_matters.opt_action_bool["epub"]) { - if ((doc_matters.opt_action_bool["verbose"])) {write("epub processing... ");} - outputEPub!()(doc_abstraction, doc_matters); + if ((doc_matters.opt_action_bool["verbose"])) {write("epub3 processing... ");} + outputEPub3!()(doc_abstraction, doc_matters); // epub.css_write; - if ((doc_matters.opt_action_bool["verbose"])) {writeln("epub done");} + if ((doc_matters.opt_action_bool["verbose"])) {writeln("epub3 done");} } if (doc_matters.opt_action_bool["pdf"]) { /+ mixin outputPDF; +/ @@ -117,27 +118,53 @@ private import std.algorithm, std.array, std.container, + std.digest.sha, std.exception, std.file, std.getopt, std.json, - std.process, - std.stdio, + std.outbuffer, std.path, + std.process, std.range, std.regex, + std.stdio, std.string, std.traits, std.typecons, std.uni, std.utf, + std.zip, std.conv : to; import + create_zip_file, defaults, output_rgx, output_xhtmls; #+END_SRC +** _zip_ +*** template :template: + +#+BEGIN_SRC d :tangle ../src/sdp/create_zip_file.d +template createZipFile() { + import std.file; + import std.outbuffer; + import std.string; + import std.zip; + void createZipFile( + string zip_file_name, + void[] compressed_zip_data, + ) { + try { + write(zip_file_name, compressed_zip_data); + } catch (ZipException ex) { + // Handle Errors + } + } +} +#+END_SRC + ** _sisupod_ :sisupod: *** template :template: @@ -162,12 +189,13 @@ template SiSUpod() { #+name: source_sisupod_init #+BEGIN_SRC d -debug(asserts){ +debug(asserts) { // static assert(is(typeof(doc_matters) == tuple)); } mixin SiSUoutputRgxInit; mixin SiSUpaths; -auto pth_sisupod = SiSUpodPaths(); +auto pth_sisupod = SiSUpodPathsZipped(); +auto pth_sisupod_filesystem = SiSUpodPathsFilesystemArchive(); mixin SiSUlanguageCodes; auto lang = Lang(); auto rgx = Rgx(); @@ -177,20 +205,20 @@ assert (doc_matters.source_filename.match(rgx.src_fn)); #+name: source_sisupod_mkdirs #+BEGIN_SRC d /+ create directory structure +/ -if (!exists(pth_sisupod.doc(doc_matters.source_filename))) { - pth_sisupod.doc(doc_matters.source_filename).mkdirRecurse; +if (!exists(pth_sisupod_filesystem.doc(doc_matters.source_filename))) { + pth_sisupod_filesystem.doc(doc_matters.source_filename).mkdirRecurse; } -if (!exists(pth_sisupod.conf(doc_matters.source_filename))) { - pth_sisupod.conf(doc_matters.source_filename).mkdirRecurse; +if (!exists(pth_sisupod_filesystem.conf(doc_matters.source_filename))) { + pth_sisupod_filesystem.conf(doc_matters.source_filename).mkdirRecurse; } -if (!exists(pth_sisupod.css(doc_matters.source_filename))) { - pth_sisupod.css(doc_matters.source_filename).mkdirRecurse; +if (!exists(pth_sisupod_filesystem.css(doc_matters.source_filename))) { + pth_sisupod_filesystem.css(doc_matters.source_filename).mkdirRecurse; } -if (!exists(pth_sisupod.image(doc_matters.source_filename))) { - pth_sisupod.image(doc_matters.source_filename).mkdirRecurse; +if (!exists(pth_sisupod_filesystem.image(doc_matters.source_filename))) { + pth_sisupod_filesystem.image(doc_matters.source_filename).mkdirRecurse; } -if (!exists(pth_sisupod.doc_lng(doc_matters.source_filename, doc_matters.language))) { - pth_sisupod.doc_lng(doc_matters.source_filename, doc_matters.language).mkdirRecurse; +if (!exists(pth_sisupod_filesystem.doc_lng(doc_matters.source_filename, doc_matters.language))) { + pth_sisupod_filesystem.doc_lng(doc_matters.source_filename, doc_matters.language).mkdirRecurse; } #+END_SRC @@ -200,54 +228,158 @@ if (!exists(pth_sisupod.doc_lng(doc_matters.source_filename, doc_matters.languag #+BEGIN_SRC d debug(sisupod) { writeln(__LINE__, ": ", - // doc_matters.environment["pwd"], "/", - doc_matters.source_filename, " -> ", - // doc_matters.environment["pwd"], "/", - pth_sisupod.fn_doc( - doc_matters.source_filename, - doc_matters.language - )); -} -if (exists(doc_matters.source_filename)) { - copy( + doc_matters.source_filename, " -> ", + pth_sisupod_filesystem.fn_doc( doc_matters.source_filename, - pth_sisupod.fn_doc( - doc_matters.source_filename, - doc_matters.language + doc_matters.language )); } -if (doc_matters.file_insert_list.length > 0) { - foreach (insert_file; doc_matters.file_insert_list) { - debug(sisupod) { +auto zip = new ZipArchive(); +auto fn_sisupod = pth_sisupod.sisupod_filename(doc_matters.source_filename); +{ /+ bundle images +/ + foreach (image; doc_matters.image_list) { + debug(sisupodimages) { writeln( + "_sisu/image/", image, " -> ", + pth_sisupod.image(doc_matters.source_filename), "/", image + ); + } + auto fn_src = "_sisu/image/"~ image; + auto fn_out = pth_sisupod.image(doc_matters.source_filename).to!string ~ "/" ~ image; + auto fn_out_filesystem = pth_sisupod_filesystem.image(doc_matters.source_filename).to!string ~ "/" ~ image; + if (exists(fn_src)) { + fn_src.copy(fn_out_filesystem); + { + auto zip_arc_member_file = new ArchiveMember(); + zip_arc_member_file.name = fn_out; + auto zip_data = new OutBuffer(); + zip_data.write(cast(char[]) ((fn_src).read)); + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + createZipFile!()(pth_sisupod.sisupod_filename(fn_src), zip.build()); + } + } + } +} +{ /+ bundle sisu_document_make +/ + auto fn_src = "_sisu/sisu_document_make"; // check (_sisu/sisu_document_make) + auto fn_out = pth_sisupod.conf(doc_matters.source_filename).to!string ~ "/" ~ "sisu_document_make"; + auto fn_out_filesystem = pth_sisupod_filesystem.conf(doc_matters.source_filename).to!string ~ "/" ~ "sisu_document_make"; + if (exists(fn_src)) { + fn_src.copy(fn_out_filesystem); + { + auto zip_arc_member_file = new ArchiveMember(); + zip_arc_member_file.name = fn_out; + auto zip_data = new OutBuffer(); + zip_data.write((fn_src).readText); + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + createZipFile!()(pth_sisupod.sisupod_filename(fn_src), zip.build()); + } + } +} +{ /+ bundle primary file +/ + auto fn_src = doc_matters.source_filename; + auto fn_out = pth_sisupod.fn_doc(doc_matters.source_filename, doc_matters.language).to!string; + auto fn_out_filesystem = pth_sisupod_filesystem.fn_doc(doc_matters.source_filename, doc_matters.language).to!string; + if (exists(fn_src)) { + fn_src.copy(fn_out_filesystem); + { + auto zip_arc_member_file = new ArchiveMember(); + zip_arc_member_file.name = fn_out; + auto zip_data = new OutBuffer(); + zip_data.write((fn_src).readText); + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + createZipFile!()(pth_sisupod.sisupod_filename(fn_src), zip.build()); + } + } +} +{ /+ bundle insert files +/ + if (doc_matters.file_insert_list.length > 0) { + foreach (insert_file; doc_matters.file_insert_list) { + debug(sisupod) { + writeln( insert_file, " -> ", pth_sisupod.fn_doc_insert( doc_matters.source_filename, insert_file, doc_matters.language - )); - } - if (exists(insert_file)) { - insert_file.copy( - pth_sisupod.fn_doc_insert( - doc_matters.source_filename, - insert_file, - doc_matters.language - )); + )); + } + auto fn_src = insert_file; + auto fn_out = pth_sisupod.fn_doc_insert( + doc_matters.source_filename, + insert_file, + doc_matters.language + ).to!string; + auto fn_out_filesystem = pth_sisupod_filesystem.fn_doc_insert( + doc_matters.source_filename, + insert_file, + doc_matters.language + ).to!string; + if (exists(fn_src)) { + fn_src.copy(fn_out_filesystem); + { + auto zip_arc_member_file = new ArchiveMember(); + zip_arc_member_file.name = insert_file; + auto zip_data = new OutBuffer(); + zip_data.write((fn_src).readText); + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + createZipFile!()(pth_sisupod.sisupod_filename(fn_src), zip.build()); + } + } } } } -foreach (image; doc_matters.image_list) { - debug(sisupod) { - writeln( - "_sisu/image/", image, " -> ", - pth_sisupod.image(doc_matters.source_filename), "/", image - ); +#+END_SRC + +*** sha256 of sisupod.zip, zip debug, read zip archive + +#+name: source_sisupod_copy +#+BEGIN_SRC d +if (exists(fn_sisupod)) { + try { + auto data = (cast(byte[]) (fn_sisupod).read); + writefln("%-(%02x%) %s", data.sha256Of, fn_sisupod); + debug(sisupod) { + try { + auto zipped = new ZipArchive((fn_sisupod).read); + foreach (filename, member; zipped.directory) { + auto data = zipped.expand(member); + writeln("> ", filename, " length ", data.length); // filename == member.name + // Use data + } + } + catch (ZipException ex) { + // Handle errors + } + if (doc_matters.source_filename == "en/the_wealth_of_networks.yochai_benkler.sst") { + assert( + ((data).sha256Of).toHexString + == "DDE0013C13C6A4F06D4BE72087E2CDEF47697CA38A6A2D65BA7207DB6B144271", + "\nsisupod: sha256 value for " + ~ doc_matters.source_filename + ~ " has changed, is now: " + ~ ((data).sha256Of).toHexString + ); + } + if (doc_matters.source_filename == "en/sisu_markup_stress_test.sst") { + assert( + ((data).sha256Of).toHexString + == "112C0AEDD2518A1803D91A7CF5785274A3116C0779A631782D0C0813B212C68A", + "\nsisupod: sha256 value for " + ~ doc_matters.source_filename + ~ " has changed, is now: " + ~ ((data).sha256Of).toHexString + ); + } + } } - if (exists("_sisu/image/"~ image)) { - ("_sisu/image/"~ image).copy( - (pth_sisupod.image(doc_matters.source_filename) ~ "/" ~ image) - ); + catch (ErrnoException ex) + { + // Handle errors } } #+END_SRC @@ -279,7 +411,7 @@ string special_characters(string _txt){ .replaceAll(rgx.xhtml_ampersand, "&") .replaceAll(rgx.xhtml_less_than, "<") .replaceAll(rgx.xhtml_greater_than, ">") - .replaceAll(rgx.xhtml_line_break, "
"); + .replaceAll(rgx.xhtml_line_break, "
"); return _txt; } #+END_SRC @@ -329,7 +461,7 @@ string _xhtml_anchor_tags(const(string[]) anchor_tags) { auto scroll_head(Me)( Me dochead_meta, ) { - debug(asserts){ + debug(asserts) { static assert(is(typeof(dochead_meta) == string[string][string])); } string o; @@ -337,26 +469,27 @@ auto scroll_head(Me)( - - %s%s - - - - - - - - - - - - - - + + %s%s + + + + + + + + + + + + + + + - - + + ¶", @@ -374,7 +507,7 @@ dochead_meta["title"]["full"], auto seg_head(Me)( Me dochead_meta, ) { - debug(asserts){ + debug(asserts) { static assert(is(typeof(dochead_meta) == string[string][string])); } string o; @@ -382,26 +515,27 @@ auto seg_head(Me)( - - %s%s - - - - - - - - - - - - - - + + %s%s + + + + + + + + + + + + + + + + - - + + ¶", @@ -485,13 +619,13 @@ auto inline_links(O)( #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_notes_scroll(O)( - auto return ref const O obj, - string _txt, + auto return ref const O obj, + string _txt, ) { if (obj.inline_notes_reg) { _txt = (_txt).replaceAll( rgx.inline_notes_delimiter_al_regular_number_note, - (" $1 ") + (" $1 ") ); } debug(markup_endnotes) { @@ -535,7 +669,7 @@ auto inline_notes_seg(O)( "\">", " ", + "\"> ", m.captures[1], ".", m.captures[2], @@ -544,7 +678,7 @@ auto inline_notes_seg(O)( } _txt = (_txt).replaceAll( rgx.inline_notes_delimiter_al_regular_number_note, - (" $1 ") + (" $1 ") ); } else if (_txt.match(rgx.inline_notes_delimiter_al_regular_number_note)) { debug(markup) { @@ -625,7 +759,7 @@ auto heading(O)( auto tags = _xhtml_anchor_tags(obj.anchor_tags); string o; if (obj.obj_cite_number.empty) { - o = format(q"¶


+ o = format(q"¶


%s %s @@ -638,7 +772,7 @@ auto heading(O)( obj.heading_lev_markup, ); } else { - o = format(q"¶


+ o = format(q"¶


%s @@ -707,7 +841,7 @@ auto para(O)( auto tags = _xhtml_anchor_tags(obj.anchor_tags); _txt = font_face(_txt); string o; - _txt = (obj.bullet) ? ("●  " ~ _txt) : _txt; + _txt = (obj.bullet) ? ("●  " ~ _txt) : _txt; if (obj.obj_cite_number.empty) { o = format(q"¶

%s @@ -942,7 +1076,6 @@ auto block(O)(

¶", obj.is_a, _txt - // obj.text ); } else { o = format(q"¶
@@ -956,7 +1089,6 @@ auto block(O)( obj.is_a, obj.obj_cite_number, _txt - // obj.text ); } return o; @@ -1008,9 +1140,9 @@ auto verse(O)( // using code from code block, review ) { _txt = font_face(_txt); _txt = (_txt) - .replaceAll(rgx.newline, "
\n") - .replaceAll(rgx.two_spaces, " " ~ " " ~ " " ~ " ") - .replaceAll(rgx.nbsp_and_space, " " ~ " ") + .replaceAll(rgx.newline, "
\n") + .replaceAll(rgx.two_spaces, " " ~ " " ~ " " ~ " ") + .replaceAll(rgx.nbsp_and_space, " " ~ " ") .replaceAll(rgx.strip_br, ""); string o; if (obj.obj_cite_number.empty) { @@ -1084,8 +1216,8 @@ auto verse_seg(O)( ) { string _txt = obj.text; _txt = (_txt) - .replaceAll(rgx.newline, "
\n") - .replaceAll(rgx.nbsp_char, " "); + .replaceAll(rgx.newline, "
\n") + .replaceAll(rgx.nbsp_char, " "); string o; if (obj.obj_cite_number.empty) { o = format(q"¶
@@ -1388,7 +1520,7 @@ void scroll_write_output(Fn,C)( Fn fn_src, C doc, ) { - debug(asserts){ + debug(asserts) { static assert(is(typeof(fn_src) == string)); static assert(is(typeof(doc) == string[])); } @@ -1636,7 +1768,7 @@ void seg_write_output(M,D,E)( D doc_html, E doc_html_endnotes, ) { - debug(asserts){ + debug(asserts) { static assert(is(typeof(doc_html) == string[][string])); } mixin SiSUoutputRgxInit; @@ -2523,104 +2655,225 @@ auto css_write() { #+END_SRC *** _epub_ [#B] :epub: + +|-----------------------+--------------------------+---------------------------+----------------------------------| +| function | filename | module | variable | +|-----------------------+--------------------------+---------------------------+----------------------------------| +| identify doc filetype | mimetype | epub3_mimetypes | mimetypes | +|-----------------------+--------------------------+---------------------------+----------------------------------| +| identify doc root | META-INF/container.xml | epub3_container_xml | meta_inf_container_xml | +|-----------------------+--------------------------+---------------------------+----------------------------------| +| doc manifest | OEBPS/content.opf | epub3_oebps_content | oebps_content_opf | +|-----------------------+--------------------------+---------------------------+----------------------------------| +| doc navigation | OEBPS/toc_nav.xhtml | epub3_oebps_toc_nav_xhtml | oebps_toc_nav_xhtml | +| | OEBPS/toc.ncx | epub2_oebps_toc_ncx | oebps_toc_ncx | +|-----------------------+--------------------------+---------------------------+----------------------------------| +| doc contents | OEBPS/[files ... ].xhtml | outputEPub3 | doc_epub3[seg_filename] | +| | | | doc_epub3_endnotes[seg_filename] | +|-----------------------+--------------------------+---------------------------+----------------------------------| + **** template :template: -#+BEGIN_SRC d :tangle ../src/sdp/output_epub.d -template outputEPub() { +#+BEGIN_SRC d :tangle ../src/sdp/output_epub3.d +template outputEPub3() { <> mixin InternalMarkup; mixin outputXHTMLs; - <> - <> - <> - <> - <> + <> + <> + <> + <> + <> } #+END_SRC -**** epub special files :format: -***** static -****** mimetype (file) +**** special (epub) files :format: +***** DONE static +****** _identify doc filetype_ (mimetype) [static] + +- mimetype file indicating that zip file contains an EPUB -#+name: output_epub_fixed +#+name: output_epub3_fixed #+BEGIN_SRC d -string epub_mimetypes() { +string epub3_mimetypes() { string o; - o = format(q"¶application/epub+zip¶"); + o = format(q"¶application/epub+zip¶") ~ "\n"; return o; } #+END_SRC -****** META-INF/container.xml (file) +****** _identify doc root_ (META-INF/container.xml) [static] rootfile: contains document root path -#+name: output_epub_fixed +- identifies the root package document (so systems can find it), [unchanged from epub2] + +#+name: output_epub3_fixed #+BEGIN_SRC d -string epub_container_xml() { +string epub3_container_xml() { string o; - o = format(q"¶ - - - - -¶"); + o = format(q"¶¶") ~ "\n"; + o ~= format(q"¶ + + +¶") ~ "\n\n"; return o; } #+END_SRC -***** constructs (in OEBPS) -****** TODO OEBPS/content.opf (register content: files, images etc.) +***** constructs (in dir: OEBPS) +****** TODO _doc manifest_ (OEBPS/content.opf) manifest, register content: files, images etc. + +- manifest, listing all resources +- provides the default reading order +- identifies the navigation document -#+name: output_epub_constructs +#+name: output_epub3_constructs #+BEGIN_SRC d -string epub_oebps_content(D,I)(D doc_abstraction, I doc_matters) { - string uuid = "18275d951861c77f78acd05672c9906924c59f18a2e0ba06dad95959693e9bd8"; // TODO shared elsewhere - string content = format(q"¶ - +string epub3_oebps_content(D,I,P)(D doc_abstraction, I doc_matters, P parts) { + string uuid = "18275d951861c77f78acd05672c9906924c59f18a2e0ba06dad95959693e9bd8"; // TODO sort uuid in doc_matters! + string content = format(q"¶ - - %s - %s - en - %s + + %s + main + %s + subtitle + %s + %s + %s Copyright: %s - ox/current/en/epub/sisu_markup.epub + %s urn:uuid:%s - + - - + + - ¶", + + + +¶", + uuid, + doc_matters.dochead_meta["title"]["full"], + doc_matters.dochead_meta["title"]["main"], + (doc_matters.dochead_meta["title"]["sub"].empty) + ? "" : doc_matters.dochead_meta["title"]["sub"], + (doc_matters.dochead_meta["creator"]["author"].empty) + ? "" : doc_matters.dochead_meta["creator"]["author"], + (doc_matters.dochead_meta["creator"]["author"].empty) + ? "" : doc_matters.dochead_meta["creator"]["author"], + doc_matters.language, + (doc_matters.dochead_meta["date"]["published"].empty) + ? "" : doc_matters.dochead_meta["date"]["published"], + (doc_matters.dochead_meta["rights"]["copyright"].empty) + ? "" : doc_matters.dochead_meta["rights"]["copyright"], uuid, - doc_matters.dochead_meta["title"]["full"], // title - (doc_matters.dochead_meta["creator"]["author"].empty) ? "" : " by " ~ doc_matters.dochead_meta["creator"]["author"], // author - (doc_matters.dochead_meta["creator"]["author"].empty) ? "" : " by " ~ doc_matters.dochead_meta["creator"]["author"], // author - (doc_matters.dochead_meta["date"]["published"].empty) ? "" : " by " ~ doc_matters.dochead_meta["date"]["published"], // date - (doc_matters.dochead_meta["rights"]["copyright"].empty) ? "" : " by " ~ doc_matters.dochead_meta["rights"]["copyright"], // rights uuid, uuid, ); + content ~= " " ~ "" ~ "\n "; + content ~= parts["manifest_documents"]; + // TODO sort jpg & png + content ~= " " ~ "" ~ "\n "; + foreach (image; doc_matters.image_list) { + content ~= format(q"¶ +¶", + image, // strip image type, remove .png .jpg suffix, use in media-type="image/" + image, + ); + } + content ~= " " ~ "" ~ "\n "; + content ~= " " ~ "" ~ "\n "; + content ~= parts["spine"]; + content ~= " " ~ "" ~ "\n "; + content ~= " " ~ "" ~ "\n "; + content ~= parts["guide"]; + content ~= " " ~ "" ~ "\n "; + content ~= "" ~ ""; + return content; +} +#+END_SRC + +****** _doc navigation epub3_ (OEBPS/toc_nav.xhtml) epub3 navigable toc using Dom structure + +- toc_nav.xhtml declared as nav file in content.opf (epub3 navigation document) + +#+name: output_epub3_constructs +#+BEGIN_SRC d +string epub3_oebps_toc_nav_xhtml(D,I)(D doc_abstraction, I doc_matters) { + enum DomTags { none, open, close, close_and_open, open_still, } + auto markup = InlineMarkup(); + string toc ="\n"; + return toc; } #+END_SRC -****** TODO OEBPS/toc.ncx (navigable toc using Dom structure) +****** TODO _doc navigation epub2_ (OEBPS/toc.ncx) navigable toc using Dom structure -#+name: output_epub_constructs +- toc.ncx (epub2 navigation document) + - (replaced in epub3 by a declared xhtml nav file, in our case toc_nav.xhtml) + +#+name: output_epub3_constructs #+BEGIN_SRC d -string epub_oebps_toc(D,I)(D doc_abstraction, I doc_matters) { +string epub2_oebps_toc_ncx(D,I)(D doc_abstraction, I doc_matters) { int counter = 0; string uuid = "18275d951861c77f78acd05672c9906924c59f18a2e0ba06dad95959693e9bd8"; // TODO shared elsewhere auto markup = InlineMarkup(); @@ -2698,27 +2951,24 @@ obj.segment_anchor_tag, // lev < 4 [no link]; lev == 4 [filename] markup.xhtml } #+END_SRC -**** seg :seg: -***** switch (sections & objects) format epub xhtml output +**** the document contents :seg: +***** switch (sections & objects) format epub3 xhtml output -#+name: output_epub_xhtml_seg +#+name: output_epub3_xhtml_seg #+BEGIN_SRC d -void outputEPub(D,I)( +void outputEPub3(D,I)( auto return ref const D doc_abstraction, auto return ref I doc_matters, ) { mixin SiSUoutputRgxInit; auto xhtml_format = outputXHTMLs(); auto rgx = Rgx(); - string[][string] doc_epub; - string[][string] doc_epub_endnotes; + string[][string] doc_epub3; + string[][string] doc_epub3_endnotes; string[] doc; string segment_filename; string[] top_level_headings = ["","","",""]; - auto mimetypes = epub_mimetypes; - auto meta_inf_container_xml = epub_container_xml; - auto oebps_toc_ncx = epub_oebps_toc(doc_abstraction, doc_matters); - auto oebps_content_opf = epub_oebps_content(doc_abstraction, doc_matters); + string[string] oepbs_content_parts; string suffix = ".xhtml"; foreach (part; doc_matters.keys_seq_seg) { foreach (obj; doc_abstraction[part]) { @@ -2753,18 +3003,18 @@ void outputEPub(D,I)( break; case 4: segment_filename = obj.segment_anchor_tag; - doc_epub[segment_filename] ~= xhtml_format.seg_head(doc_matters.dochead_meta); + doc_epub3[segment_filename] ~= xhtml_format.seg_head(doc_matters.dochead_meta); foreach (top_level_heading; top_level_headings) { - doc_epub[segment_filename] ~= top_level_heading; + doc_epub3[segment_filename] ~= top_level_heading; } auto t = xhtml_format.heading_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case 5: .. case 7: auto t = xhtml_format.heading_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case 8: .. case 9: // unused numbers, if remain check if ((doc_matters.opt_action_bool["debug"])) { @@ -2785,7 +3035,7 @@ void outputEPub(D,I)( case "para": switch (obj.is_a) { case "toc": - doc_epub[segment_filename] ~= xhtml_format.toc(obj); + doc_epub3[segment_filename] ~= xhtml_format.toc(obj); break; default: if ((doc_matters.opt_action_bool["debug"])) { @@ -2807,8 +3057,8 @@ void outputEPub(D,I)( switch (obj.is_a) { case "para": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt_action_bool["debug"])) { @@ -2821,33 +3071,33 @@ void outputEPub(D,I)( switch (obj.is_a) { case "quote": auto t = xhtml_format.quote_seg(obj, suffix); - doc_epub[segment_filename] ~= to!string(t[0]); - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= to!string(t[0]); + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "group": auto t = xhtml_format.group_seg(obj, suffix); - doc_epub[segment_filename] ~= to!string(t[0]); - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= to!string(t[0]); + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "block": auto t = xhtml_format.block_seg(obj, suffix); - doc_epub[segment_filename] ~= to!string(t[0]); - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= to!string(t[0]); + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "poem": break; case "verse": auto t = xhtml_format.verse_seg(obj, suffix); - doc_epub[segment_filename] ~= to!string(t[0]); - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= to!string(t[0]); + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "code": - doc_epub[segment_filename] ~= xhtml_format.code(obj); + doc_epub3[segment_filename] ~= xhtml_format.code(obj); break; case "table": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt_action_bool["debug"])) { @@ -2869,27 +3119,27 @@ void outputEPub(D,I)( switch (obj.is_a) { case "endnote": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; + doc_epub3[segment_filename] ~= t[0]; break; case "glossary": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "bibliography": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "bookindex": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "blurb": auto t = xhtml_format.para_seg(obj, suffix); - doc_epub[segment_filename] ~= t[0]; - doc_epub_endnotes[segment_filename] ~= t[1]; + doc_epub3[segment_filename] ~= t[0]; + doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt_action_bool["debug"])) { @@ -2914,14 +3164,59 @@ void outputEPub(D,I)( break; } } + if (obj.is_a == "heading") { + if (obj.heading_lev_markup == 4) { + oepbs_content_parts["manifest_documents"] ~= format(q"¶ +¶", + obj.segment_anchor_tag, + obj.segment_anchor_tag, + ); + oepbs_content_parts["spine"] ~= format(q"¶ +¶", + obj.segment_anchor_tag, + ); + oepbs_content_parts["guide"] ~= format(q"¶ +¶", + obj.segment_anchor_tag, + obj.segment_anchor_tag, + ); + } else if (obj.heading_lev_markup > 4) { + oepbs_content_parts["manifest_documents"] ~= format(q"¶ +¶", + obj.segment_anchor_tag, + obj.obj_cite_number, + obj.segment_anchor_tag, + obj.obj_cite_number, + ); + oepbs_content_parts["spine"] ~= format(q"¶ +¶", + obj.segment_anchor_tag, + obj.obj_cite_number, + ); + oepbs_content_parts["guide"] ~= format(q"¶ +¶", + obj.segment_anchor_tag, + obj.obj_cite_number, + obj.segment_anchor_tag, + obj.obj_cite_number, + ); + } + } } } - epub_write_output_files( + /+ epub specific documents +/ + auto mimetypes = epub3_mimetypes; + auto meta_inf_container_xml = epub3_container_xml; + auto oebps_toc_ncx = epub2_oebps_toc_ncx(doc_abstraction, doc_matters); + auto oebps_toc_nav_xhtml = epub3_oebps_toc_nav_xhtml(doc_abstraction, doc_matters); + auto oebps_content_opf = epub3_oebps_content(doc_abstraction, doc_matters, oepbs_content_parts); + epub3_write_output_files( doc_matters, - doc_epub, - doc_epub_endnotes, + doc_epub3, + doc_epub3_endnotes, mimetypes, meta_inf_container_xml, + oebps_toc_nav_xhtml, oebps_toc_ncx, oebps_content_opf, ); @@ -2930,71 +3225,214 @@ void outputEPub(D,I)( **** write output files -#+name: output_epub_xhtml_seg +#+name: output_epub3_xhtml_seg #+BEGIN_SRC d -void epub_write_output_files(M,D,E,Mt,Mic,Ot,Oc)( +void epub3_write_output_files(M,D,E,Mt,Mic,Otnx,Otn,Oc)( M doc_matters, - D doc_epub, - E doc_epub_endnotes, + D doc_epub3, + E doc_epub3_endnotes, Mt mimetypes, Mic meta_inf_container_xml, - Ot oebps_toc_ncx, + Otnx oebps_toc_nav_xhtml, + Otn oebps_toc_ncx, Oc oebps_content_opf, ) { - debug(asserts){ - static assert(is(typeof(doc_epub) == string[][string])); + debug(asserts) { + static assert(is(typeof(doc_epub3) == string[][string])); static assert(is(typeof(mimetypes) == string)); static assert(is(typeof(meta_inf_container_xml) == string)); + static assert(is(typeof(oebps_toc_nav_xhtml) == string)); static assert(is(typeof(oebps_toc_ncx) == string)); static assert(is(typeof(oebps_content_opf) == string)); } mixin SiSUpaths; - auto pth_epub = EpubPaths(); + auto pth_epub3 = Epub3paths(); auto xhtml_format = outputXHTMLs(); + /+ zip file +/ + auto fn_epub = pth_epub3.epub_file(doc_matters.source_filename); + auto zip = new ZipArchive(); // ZipArchive zip = new ZipArchive(); + /+ zip archive member files +/ try { - if (!exists(pth_epub.doc_meta_inf(doc_matters.source_filename))) { - pth_epub.doc_meta_inf(doc_matters.source_filename).mkdirRecurse; + if (!exists(pth_epub3.doc_meta_inf(doc_matters.source_filename))) { + pth_epub3.doc_meta_inf(doc_matters.source_filename).mkdirRecurse; } - if (!exists(pth_epub.doc_oebps_css(doc_matters.source_filename))) { - pth_epub.doc_oebps_css(doc_matters.source_filename).mkdirRecurse; + if (!exists(pth_epub3.doc_oebps_css(doc_matters.source_filename))) { + pth_epub3.doc_oebps_css(doc_matters.source_filename).mkdirRecurse; } - if (!exists(pth_epub.doc_oebps_image(doc_matters.source_filename))) { - pth_epub.doc_oebps_image(doc_matters.source_filename).mkdirRecurse; + if (!exists(pth_epub3.doc_oebps_image(doc_matters.source_filename))) { + pth_epub3.doc_oebps_image(doc_matters.source_filename).mkdirRecurse; } - /+ OEBPS/[segments].xhtml +/ - foreach (seg_filename; doc_matters.segnames) { - auto f = File(pth_epub.fn_oebps_content_xhtml(doc_matters.source_filename, seg_filename), "w"); - /+ // f.writeln(seg_head); // not needed built and inserted earlier +/ - foreach (docseg; doc_epub[seg_filename]) { - f.writeln(docseg); + { /+ OEBPS/[segments].xhtml (the document contents) +/ + foreach (seg_filename; doc_matters.segnames) { + string fn = pth_epub3.fn_oebps_content_xhtml(doc_matters.source_filename, seg_filename); + /+ add zip archive file members (with their content) +/ + auto zip_arc_member_file = new ArchiveMember(); + // add seg fn to zip archive + zip_arc_member_file.name = fn; + auto zip_data = new OutBuffer(); + debug(epub_output) { + string fn_dbg = pth_epub3.dbg_fn_oebps_content_xhtml(doc_matters.source_filename, seg_filename); + auto f = File(fn_dbg, "w"); + } + /+ // f.writeln(seg_head); // not needed built and inserted earlier +/ + foreach (docseg; doc_epub3[seg_filename]) { + debug(epub_output) { f.writeln(docseg); } + zip_data.write(docseg.dup); // cast as: char[] + } + foreach (docseg; doc_epub3_endnotes[seg_filename]) { + debug(epub_output) { f.writeln(docseg); } + zip_data.write(docseg.dup); // cast as: char[] + } + debug(epub_output) { f.writeln(xhtml_format.tail); } // needed for each lev4 + zip_data.write(xhtml_format.tail.dup); // cast as: char[] + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + /+ create the zip file +/ + createZipFile!()(fn_epub, zip.build()); } - foreach (docseg; doc_epub_endnotes[seg_filename]) { - f.writeln(docseg); + } + string fn; + debug(epub_output) { string fn_dbg; } + File f; + { /+ mimetypes (identify zip file type) +/ + debug(epub_output) { + fn_dbg = pth_epub3.dbg_fn_mimetypes(doc_matters.source_filename); + File(fn_dbg, "w").writeln(mimetypes); } - f.writeln(xhtml_format.tail); // needed for each lev4 + fn = pth_epub3.fn_mimetypes(doc_matters.source_filename); + /+ add zip archive file members (with their content) +/ + auto zip_arc_member_file = new ArchiveMember(); + // add mimetypes to zip archive + zip_arc_member_file.name = fn; + auto zip_data = new OutBuffer(); + zip_data.write(mimetypes.dup); // cast as: char[] + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + /+ create the zip file +/ + createZipFile!()(fn_epub, zip.build()); + } + { /+ META-INF/container.xml (identify doc root) +/ + debug(epub_output) { + fn_dbg = pth_epub3.dbg_fn_dmi_container_xml(doc_matters.source_filename); + File(fn_dbg, "w").writeln(meta_inf_container_xml); + } + fn = pth_epub3.fn_dmi_container_xml(doc_matters.source_filename); + /+ add zip archive file members (with their content) +/ + auto zip_arc_member_file = new ArchiveMember(); + // add META-INF/container.xml to zip archive + zip_arc_member_file.name = fn; + auto zip_data = new OutBuffer(); + zip_data.write(meta_inf_container_xml.dup); // cast as: char[] + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + /+ create the zip file +/ + createZipFile!()(fn_epub, zip.build()); + } + { /+ OEBPS/toc_nav.xhtml (navigation toc epub3) +/ + debug(epub_output) { + fn_dbg = pth_epub3.dbg_fn_oebps_toc_nav_xhtml(doc_matters.source_filename); + File(fn_dbg, "w").writeln(oebps_toc_nav_xhtml); + } + fn = pth_epub3.fn_oebps_toc_nav_xhtml(doc_matters.source_filename); + /+ add zip archive file members (with their content) +/ + auto zip_arc_member_file = new ArchiveMember(); + // add OEBPS/toc_nav.xhtml to zip archive + zip_arc_member_file.name = fn; + auto zip_data = new OutBuffer(); + zip_data.write(oebps_toc_nav_xhtml.dup); // cast as: char[] + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + /+ create the zip file +/ + createZipFile!()(fn_epub, zip.build()); + } + { /+ TODO OEBPS/toc.ncx (navigation toc epub2) +/ + debug(epub_output) { + fn_dbg = pth_epub3.dbg_fn_oebps_toc_ncx(doc_matters.source_filename); + File(fn_dbg, "w").writeln(oebps_toc_ncx); + } + fn = pth_epub3.fn_oebps_toc_ncx(doc_matters.source_filename); + /+ add zip archive file members (with their content) +/ + auto zip_arc_member_file = new ArchiveMember(); + // add OEBPS/toc.ncx to zip archive + zip_arc_member_file.name = fn; + auto zip_data = new OutBuffer(); + zip_data.write(oebps_toc_ncx.dup); // cast as: char[] + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + /+ create the zip file +/ + createZipFile!()(fn_epub, zip.build()); } - /+ mimetypes +/ - auto f = File(pth_epub.fn_mimetypes(doc_matters.source_filename), "w"); - f.writeln(mimetypes); - /+ META-INF/container.xml +/ - f = File(pth_epub.fn_dmi_container_xml(doc_matters.source_filename), "w"); - f.writeln(meta_inf_container_xml); - /+ OEBPS/toc.ncx +/ - f = File(pth_epub.fn_oebps_toc_ncx(doc_matters.source_filename), "w"); - f.writeln(oebps_toc_ncx); - /+ OEBPS/content.opf +/ - f = File(pth_epub.fn_oebps_content_opf(doc_matters.source_filename), "w"); - f.writeln(oebps_content_opf); - foreach (image; doc_matters.image_list) { - if (exists("_sisu/image/"~ image)) { - ("_sisu/image/"~ image) - .copy((pth_epub.doc_oebps_image(doc_matters.source_filename)) ~ "/" ~ image); + { /+ TODO OEBPS/content.opf (doc manifest) +/ + debug(epub_output) { + fn_dbg = pth_epub3.dbg_fn_oebps_content_opf(doc_matters.source_filename); + File(fn_dbg, "w").writeln(oebps_content_opf); + } + fn = pth_epub3.fn_oebps_content_opf(doc_matters.source_filename); + /+ add zip archive file members (with their content) +/ + auto zip_arc_member_file = new ArchiveMember(); + // add OEBPS/content.opf to zip archive + zip_arc_member_file.name = fn; + auto zip_data = new OutBuffer(); + zip_data.write(oebps_content_opf.dup); // cast as: char[] + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + /+ create the zip file +/ + createZipFile!()(fn_epub, zip.build()); + } + { /+ OEBPS/_sisu/image (images) +/ + foreach (image; doc_matters.image_list) { + if (exists("_sisu/image/"~ image)) { + ("_sisu/image/"~ image) + .copy((pth_epub3.doc_oebps_image(doc_matters.source_filename)) ~ "/" ~ image); + } + } + foreach (image; doc_matters.image_list) { + debug(epub_images) { + writeln( + "_sisu/image/", image, " -> ", + pth_epub3.doc_oebps_image(doc_matters.source_filename), "/", image + ); + } + auto fn_src = "_sisu/image/"~ image; + auto fn_out = pth_epub3.doc_oebps_image(doc_matters.source_filename).to!string ~ "/" ~ image; + if (exists(fn_src)) { + { + auto zip_arc_member_file = new ArchiveMember(); + zip_arc_member_file.name = fn_out; + auto zip_data = new OutBuffer(); + zip_data.write(cast(char[]) ((fn_src).read)); + zip_arc_member_file.expandedData = zip_data.toBytes(); + zip.addMember(zip_arc_member_file); + createZipFile!()(fn_epub, zip.build()); + } + } } } } catch (ErrnoException ex) { // Handle error } +#+END_SRC + +*** zip debug, read zip archive + +#+name: output_epub3_xhtml_seg +#+BEGIN_SRC d + debug(epub_archive) { + if (exists(fn_epub)) { + try { + auto zipped = new ZipArchive((fn_epub).read); + foreach (filename, member; zipped.directory) { + auto data = zipped.expand(member); + writeln(filename, " length ", data.length); // member.name + // Use data + } + } + catch (ZipException ex) { + // Handle errors + } + } + } } #+END_SRC -- cgit v1.2.3