module sdp.output.epub3;
template outputEPub3() {
import sdp.output;
import
std.digest.sha,
std.file,
std.outbuffer,
std.zip,
std.conv : to;
import
sdp.output.create_zip_file,
sdp.output.xmls,
sdp.output.xmls_css;
mixin InternalMarkup;
mixin outputXHTMLs;
string epub3_mimetypes() {
string o;
o = format(q"¶application/epub+zip¶") ~ "\n";
return o;
}
string epub3_container_xml() {
string o;
o = format(q"¶¶") ~ "\n";
o ~= format(q"¶
¶") ~ "\n\n";
return o;
}
string epub3_oebps_content(D,I,P)(D doc_abstraction, I doc_matters, P parts) {
auto xhtml_format = outputXHTMLs();
auto pth_epub3 = SiSUpathsEPUB!()(doc_matters.output_path, doc_matters.src.language);
string uuid = "18275d951861c77f78acd05672c9906924c59f18a2e0ba06dad95959693e9bd8"; // TODO sort uuid in doc_matters!
string content = format(q"¶
%s
main
%s
subtitle
%s
%s
%s
Copyright: %s
%s
urn:uuid:%s
¶",
uuid,
xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.title_full),
xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.title_main),
(doc_matters.conf_make_meta.meta.title_sub.empty)
? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.title_sub),
(doc_matters.conf_make_meta.meta.creator_author.empty)
? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.creator_author),
(doc_matters.conf_make_meta.meta.creator_author.empty)
? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.creator_author),
doc_matters.src.language, // language, fix (needed in dochead metadata)
(doc_matters.conf_make_meta.meta.date_published.empty)
? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.date_published),
(doc_matters.conf_make_meta.meta.rights_copyright.empty)
? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright),
uuid,
uuid,
uuid,
(pth_epub3.fn_oebps_css(doc_matters.src.filename)).chompPrefix("OEBPS/"),
);
content ~= " " ~ "" ~ "\n ";
content ~= parts["manifest_documents"];
// TODO sort jpg & png
content ~= " " ~ "" ~ "\n ";
foreach (image; doc_matters.srcs.image_list) {
content ~= format(q"¶
¶",
image.baseName.stripExtension,
(pth_epub3.doc_oebps_image(doc_matters.src.filename)).chompPrefix("OEBPS/"),
image,
image.extension.chompPrefix("."),
);
}
content ~= " " ~ "" ~ "\n ";
content ~= " " ~ "" ~ "\n ";
content ~= parts["spine"];
content ~= " " ~ "" ~ "\n ";
content ~= " " ~ "" ~ "\n ";
content ~= parts["guide"];
content ~= " " ~ "" ~ "\n ";
content ~= "" ~ "";
debug(epubmanifest) {
foreach (s; doc_matters.xml.keys_seq.seg) {
foreach (obj; doc_abstraction[s]) {
if (obj.is_a == "heading") {
if (obj.heading_lev_markup == 4) {
writefln(
"%s~ [%s.xhtml] %s",
obj.marked_up_level,
obj.segment_anchor_tag,
obj.text
);
} else if (obj.heading_lev_markup > 4) {
writefln(
"%s~ [%s.xhtml#%s] %s",
obj.marked_up_level,
obj.segment_anchor_tag,
obj.obj_cite_number,
obj.text
);
}
}
}
}
}
return content;
}
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();
auto rgx = Rgx();
string toc =format("
%s
\n";
return toc;
}
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();
auto rgx = Rgx();
enum DomTags { none, open, close, close_and_open, open_still, }
string toc = format(q"¶
%s%s
%s
%s
¶",
doc_matters.conf_make_meta.meta.title_full, // title
(doc_matters.conf_make_meta.meta.creator_author.empty) ? ""
: " by " ~ doc_matters.conf_make_meta.meta.creator_author, // author
uuid, // uuid
"3", // content depth
doc_matters.conf_make_meta.meta.title_full, // title
(doc_matters.conf_make_meta.meta.creator_author.empty) ? ""
: doc_matters.conf_make_meta.meta.creator_author, // author
);
foreach (sect; doc_matters.xml.keys_seq.seg) {
foreach (obj; doc_abstraction[sect]) {
if (obj.is_a == "heading") {
string _txt = obj.text.replaceAll(rgx.inline_notes_al_gen, "").strip;
string hashtag =(obj.heading_lev_markup <= 4) ? "" : ("#" ~ obj.ocn.to!string);
foreach_reverse (k; 0 .. 7) {
switch (obj.dom_markedup[k]) {
case DomTags.close :
toc ~= "\n ";
break;
case DomTags.close_and_open :
++counter;
toc ~= "\n ";
toc ~= format(q"¶
%s
¶",
counter,
_txt,
obj.segment_anchor_tag,
hashtag,
);
break;
case DomTags.open :
++counter;
toc ~= format(q"¶
%s
¶",
counter,
_txt,
obj.segment_anchor_tag,
hashtag,
);
break;
default :
break;
}
}
}
}
}
toc ~= format(q"¶
¶");
return toc;
}
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_epub3;
string[][string] doc_epub3_endnotes;
string[] doc;
string segment_filename;
string[] top_level_headings = ["","","",""];
string[string] oepbs_content_parts;
string suffix = ".xhtml";
string[] doc_parts_;
foreach (part; doc_matters.xml.keys_seq.seg) {
foreach (obj; doc_abstraction[part]) {
string _txt = xhtml_format.special_characters(obj, obj.text);
if (obj.is_a == "heading") {
assert(part == "head" || "toc_seg" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "blurb" || "tail");
switch (obj.heading_lev_markup) {
case 0: .. case 3:
/+ fill buffer, and replace with new levels from 1 to 3 +/
switch (obj.heading_lev_markup) {
case 0:
top_level_headings[0] = "";
top_level_headings[1] = "";
top_level_headings[2] = "";
top_level_headings[3] = "";
goto default;
case 1:
top_level_headings[1] = "";
top_level_headings[2] = "";
top_level_headings[3] = "";
goto default;
case 2:
top_level_headings[2] = "";
top_level_headings[3] = "";
goto default;
case 3:
top_level_headings[3] = "";
goto default;
default:
doc_parts_ ~= obj.segment_anchor_tag;
doc_epub3[obj.segment_anchor_tag] ~= xhtml_format.epub3_seg_head(doc_matters);
auto t = xhtml_format.heading_seg(obj, _txt, suffix, "epub");
doc_epub3[obj.segment_anchor_tag] ~= t[0];
doc_epub3_endnotes[obj.segment_anchor_tag] ~= t[1];
break;
}
break;
case 4:
segment_filename = obj.segment_anchor_tag;
doc_epub3[segment_filename] ~= xhtml_format.epub3_seg_head(doc_matters);
auto t = xhtml_format.heading_seg(obj, _txt, suffix, "epub");
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, _txt, suffix, "epub");
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case 8: .. case 9:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_a, ": ", obj.heading_lev_markup);
writeln(__FILE__, ":", __LINE__, ": ", obj.text);
}
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_a, ": ", obj.heading_lev_markup);
}
break;
}
} else {
assert(part == "head" || "toc_seg" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "blurb" || "tail");
switch (obj.of_part) {
case "frontmatter": assert(part == "head" || "toc_seg");
switch (obj.is_of) {
case "para":
switch (obj.is_a) {
case "toc":
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_a);
}
break;
}
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_of);
}
break;
}
break;
case "body": assert(part == "body");
switch (obj.is_of) {
case "para":
switch (obj.is_a) {
case "para":
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_a);
}
break;
}
break;
case "block":
switch (obj.is_a) {
case "quote":
auto t = xhtml_format.quote_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0].to!string;
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "group":
auto t = xhtml_format.group_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0].to!string;
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "block":
auto t = xhtml_format.block_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0].to!string;
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "poem":
break;
case "verse":
auto t = xhtml_format.verse_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0].to!string;
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "code":
doc_epub3[segment_filename] ~= xhtml_format.code(obj, _txt);
break;
case "table":
doc_epub3[segment_filename] ~= xhtml_format.table(obj, _txt);
doc_epub3_endnotes[segment_filename] ~= "";
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_a);
}
break;
}
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_of);
}
break;
}
break;
case "backmatter":
assert(part == "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "blurb" || "tail");
switch (obj.is_of) {
case "para":
switch (obj.is_a) {
case "endnote": assert(part == "endnotes");
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
break;
case "glossary": assert(part == "glossary");
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "bibliography": assert(part == "bibliography");
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "bookindex": assert(part == "bookindex_seg");
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
case "blurb": assert(part == "blurb");
auto t = xhtml_format.para_seg(obj, _txt, suffix);
doc_epub3[segment_filename] ~= t[0];
doc_epub3_endnotes[segment_filename] ~= t[1];
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_a);
}
break;
}
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.is_of);
}
break;
}
break;
case "comment":
break;
default:
if ((doc_matters.opt.action.debug_do)) {
writeln(__FILE__, ":", __LINE__, ": ", obj.of_part);
}
break;
}
}
if (obj.is_a == "heading") {
assert(obj.text.length > 0);
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 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_epub3,
doc_epub3_endnotes,
mimetypes,
meta_inf_container_xml,
oebps_toc_nav_xhtml,
oebps_toc_ncx,
oebps_content_opf,
doc_parts_,
);
}
void epub3_write_output_files(M,D,E,Mt,Mic,Otnx,Otn,Oc)(
M doc_matters,
D doc_epub3,
E doc_epub3_endnotes,
Mt mimetypes,
Mic meta_inf_container_xml,
Otnx oebps_toc_nav_xhtml,
Otn oebps_toc_ncx,
Oc oebps_content_opf,
string[] doc_parts_,
) {
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));
}
auto pth_epub3 = SiSUpathsEPUB!()(doc_matters.output_path, doc_matters.src.language);
auto xhtml_format = outputXHTMLs();
/+ zip file +/
auto fn_epub = pth_epub3.epub_file(doc_matters.src.filename);
auto zip = new ZipArchive(); // ZipArchive zip = new ZipArchive();
/+ zip archive member files +/
try {
if (!exists(pth_epub3.base)) {
pth_epub3.base.mkdirRecurse;
}
debug(epub_output) {
if (!exists(pth_epub3.dbg_doc_meta_inf(doc_matters.src.filename))) {
pth_epub3.dbg_doc_meta_inf(doc_matters.src.filename).mkdirRecurse;
}
if (!exists(pth_epub3.dbg_doc_oebps_css(doc_matters.src.filename))) {
pth_epub3.dbg_doc_oebps_css(doc_matters.src.filename).mkdirRecurse;
}
if (!exists(pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename))) {
pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename).mkdirRecurse;
}
}
{ /+ OEBPS/[segments].xhtml (the document contents) +/
foreach (seg_filename; doc_matters.xml.segnames_lv_0_to_4) {
string fn = pth_epub3.fn_oebps_content_xhtml(doc_matters.src.filename, seg_filename);
auto zip_arc_member_file = new ArchiveMember();
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.src.filename, seg_filename);
auto f = File(fn_dbg, "w");
}
foreach (docseg; doc_epub3[seg_filename]) {
debug(epub_output) { f.writeln(docseg); }
zip_data.write(docseg.dup);
}
foreach (docseg; doc_epub3_endnotes[seg_filename]) {
debug(epub_output) { f.writeln(docseg); }
zip_data.write(docseg.dup);
}
debug(epub_output) { f.writeln(xhtml_format.tail); }
zip_data.write(xhtml_format.tail.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_file);
/+ create the zip file +/
createZipFile!()(fn_epub, zip.build());
}
}
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.src.filename);
File(fn_dbg, "w").writeln(mimetypes);
}
fn = pth_epub3.fn_mimetypes(doc_matters.src.filename);
auto zip_arc_member_file = new ArchiveMember();
zip_arc_member_file.name = fn;
auto zip_data = new OutBuffer();
zip_data.write(mimetypes.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_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.src.filename);
File(fn_dbg, "w").writeln(meta_inf_container_xml);
}
fn = pth_epub3.fn_dmi_container_xml(doc_matters.src.filename);
auto zip_arc_member_file = new ArchiveMember();
zip_arc_member_file.name = fn;
auto zip_data = new OutBuffer();
zip_data.write(meta_inf_container_xml.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_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.src.filename);
File(fn_dbg, "w").writeln(oebps_toc_nav_xhtml);
}
fn = pth_epub3.fn_oebps_toc_nav_xhtml(doc_matters.src.filename);
auto zip_arc_member_file = new ArchiveMember();
zip_arc_member_file.name = fn;
auto zip_data = new OutBuffer();
zip_data.write(oebps_toc_nav_xhtml.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_file);
createZipFile!()(fn_epub, zip.build());
}
{ /+ OEBPS/toc.ncx (navigation toc epub2) +/
debug(epub_output) {
fn_dbg = pth_epub3.dbg_fn_oebps_toc_ncx(doc_matters.src.filename);
File(fn_dbg, "w").writeln(oebps_toc_ncx);
}
fn = pth_epub3.fn_oebps_toc_ncx(doc_matters.src.filename);
auto zip_arc_member_file = new ArchiveMember();
zip_arc_member_file.name = fn;
auto zip_data = new OutBuffer();
zip_data.write(oebps_toc_ncx.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_file);
createZipFile!()(fn_epub, zip.build());
}
{ /+ OEBPS/content.opf (doc manifest) +/
debug(epub_output) {
fn_dbg = pth_epub3.dbg_fn_oebps_content_opf(doc_matters.src.filename);
File(fn_dbg, "w").writeln(oebps_content_opf);
}
fn = pth_epub3.fn_oebps_content_opf(doc_matters.src.filename);
auto zip_arc_member_file = new ArchiveMember();
zip_arc_member_file.name = fn;
auto zip_data = new OutBuffer();
zip_data.write(oebps_content_opf.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_file);
createZipFile!()(fn_epub, zip.build());
}
{ /+ OEBPS/_sisu/image (images) +/
foreach (image; doc_matters.srcs.image_list) {
debug(epub_output) {
if (exists(doc_matters.src_path_info.image_root ~ "/" ~ image)) {
(doc_matters.src_path_info.image_root ~ "/" ~ image)
.copy((pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename)) ~ "/" ~ image);
}
}
}
foreach (image; doc_matters.srcs.image_list) {
debug(epub_output) {
debug(epub_images) {
writeln(
doc_matters.src_path_info.image_root, image, " -> ",
pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename), "/", image
);
}
}
auto fn_src = doc_matters.src_path_info.image_root ~ image;
auto fn_out = pth_epub3.doc_oebps_image(doc_matters.src.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());
}
}
}
}
{ /+ OEBPS/epub.css +/
auto css = SiSUcss();
debug(epub_output) {
fn_dbg = pth_epub3.dbg_fn_oebps_css(doc_matters.src.filename);
File(fn_dbg, "w").writeln(css.epub_css);
}
fn = pth_epub3.fn_oebps_css(doc_matters.src.filename);
auto zip_arc_member_file = new ArchiveMember();
zip_arc_member_file.name = fn;
auto zip_data = new OutBuffer();
zip_data.write(css.epub_css.dup);
zip_arc_member_file.expandedData = zip_data.toBytes();
zip.addMember(zip_arc_member_file);
createZipFile!()(fn_epub, zip.build());
}
}
catch (ErrnoException ex) {
// Handle error
}
writeln(" ", fn_epub);
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);
}
}
catch (ZipException ex) {
// Handle errors
}
}
}
}
}