#+TITLE: doc_reform output sisupod #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :doc_reform:output:sisupod: #+AUTHOR: Ralph Amissah #+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] #+LANGUAGE: en #+STARTUP: indent content #+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc #+OPTIONS: author:nil email:nil creator:nil timestamp:nil #+PROPERTY: header-args :padline no :exports code :noweb yes #+EXPORT_SELECT_TAGS: export #+EXPORT_EXCLUDE_TAGS: noexport #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) - [[./doc_reform.org][doc_reform]] [[./][org/]] - [[./output_hub.org][output_hub]] * sisupod :module:doc_reform:source_sisupod: ** module template #+BEGIN_SRC d :tangle ../src/doc_reform/output/source_sisupod.d module doc_reform.output.source_sisupod; template DocReformPod() { <<output_imports>> void DocReformPod(T)(T doc_matters) { <<source_sisupod_init>> try { <<source_sisupod_mkdirs>> <<source_sisupod_copy>> <<source_sisupod_zip>> } catch (ErrnoException ex) { // Handle error } } } #+END_SRC ** output imports #+name: output_imports #+BEGIN_SRC d import doc_reform.output; import std.digest.sha, std.file, std.outbuffer, std.zip, std.conv : to; import doc_reform.output.create_zip_file, doc_reform.output.xmls; #+END_SRC ** mkdir #+name: source_sisupod_init #+BEGIN_SRC d debug(asserts) { // static assert(is(typeof(doc_matters) == tuple)); } mixin DocReformOutputRgxInit; string pwd = doc_matters.env.pwd; auto src_path_info = doc_matters.src_path_info; auto pth_sisudoc_src = doc_matters.src_path_info; auto pths_sisupod = DocReformPathsSisupods!()(doc_matters); mixin DocReformLanguageCodes; auto lang = Lang(); static auto rgx = Rgx(); assert (doc_matters.src.filename.match(rgx.src_fn)); #+END_SRC #+name: source_sisupod_mkdirs #+BEGIN_SRC d /+ create directory structure +/ if (!exists(pths_sisupod.sisupod_dir_())) { // used both by sisupod zipped (& sisupod filesystem (unzipped) which makes its own recursive dirs) pths_sisupod.sisupod_dir_().mkdirRecurse; } if (doc_matters.opt.action.source) { if (!exists(pths_sisupod.text_root(doc_matters.src.filename).filesystem_open_zpod)) { pths_sisupod.text_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } if (!exists(pths_sisupod.conf_root(doc_matters.src.filename).filesystem_open_zpod)) { pths_sisupod.conf_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } if (!exists(pths_sisupod.media_root(doc_matters.src.filename).filesystem_open_zpod)) { pths_sisupod.media_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } if (!exists(pths_sisupod.css(doc_matters.src.filename).filesystem_open_zpod)) { pths_sisupod.css(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } if (!exists(pths_sisupod.image_root(doc_matters.src.filename).filesystem_open_zpod)) { pths_sisupod.image_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } if (!exists(pths_sisupod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod)) { pths_sisupod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.mkdirRecurse; } } #+END_SRC ** copy #+name: source_sisupod_copy #+BEGIN_SRC d debug(sisupod) { writeln(__LINE__, ": ", doc_matters.src.filename, " -> ", pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod ); } auto zip = new ZipArchive(); auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; { /+ bundle images +/ foreach (image; doc_matters.srcs.image_list) { debug(sisupodimages) { writeln( pth_sisudoc_src.image_root.to!string, "/", image, " -> ", pths_sisupod.image_root(doc_matters.src.filename).zpod, "/", image ); } auto fn_src_in = doc_matters.src.image_dir_path ~ "/" ~ image; auto fn_src_out_sisupod_zip_base = pths_sisupod.image_root(doc_matters.src.filename).zpod.to!string ~ "/" ~ image; auto fn_src_out_filesystem = pths_sisupod.image_root(doc_matters.src.filename).filesystem_open_zpod.to!string ~ "/" ~ image; if (exists(fn_src_in)) { debug(io) { writeln("(io debug) src out found: ", fn_src_in); } if (doc_matters.opt.action.source) { fn_src_in.copy(fn_src_out_filesystem); } if (doc_matters.opt.action.sisupod) { auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn_src_out_sisupod_zip_base; auto zip_data = new OutBuffer(); zip_data.write(cast(char[]) ((fn_src_in).read)); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); } } else { if (doc_matters.opt.action.verbose) { writeln("WARNING (io) src out NOT found (image): ", fn_src_in); } } } } { /+ bundle sisu_document_make +/ auto fn_src_in = ((doc_matters.src.is_pod) ? doc_matters.src.conf_dir_path : pth_sisudoc_src.conf_root).to!string ~ "/" ~ "sisu_document_make"; auto fn_src_out_sisupod_zip_base = pths_sisupod.conf_root(doc_matters.src.filename).zpod.to!string ~ "/" ~ "sisu_document_make"; auto fn_src_out_filesystem = pths_sisupod.conf_root(doc_matters.src.filename).filesystem_open_zpod.to!string ~ "/" ~ "sisu_document_make"; if (exists(fn_src_in)) { debug(io) { writeln("(io debug) src out found: ", fn_src_in); } if (doc_matters.opt.action.source) { fn_src_in.copy(fn_src_out_filesystem); } if (doc_matters.opt.action.sisupod) { auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn_src_out_sisupod_zip_base; auto zip_data = new OutBuffer(); zip_data.write((fn_src_in).readText); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); } } else { if (doc_matters.opt.action.verbose || doc_matters.opt.action.debug_do) { writeln("WARNING (io) src out NOT found (document make): ", fn_src_in); } } } { /+ bundle primary file +/ auto fn_src_in = doc_matters.src.file_with_absolute_path.to!string; auto fn_src_out_sisupod_zip_base = pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; auto fn_src_out_filesystem = pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.to!string; // without root path: auto fn_src_out_inside_pod = pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; // without root path: string[] filelist_src_out_sisupod_arr; string[] filelist_src_zpod_arr; if (exists(fn_src_in)) { debug(io) { writeln("(io debug) src in found: ", fn_src_in); } filelist_src_out_sisupod_arr ~= fn_src_out_sisupod_zip_base; filelist_src_zpod_arr ~= fn_src_out_inside_pod; if (doc_matters.opt.action.source) { auto filelist = File(pths_sisupod.fn_pod_filelist(doc_matters.src.filename).filesystem_open_zpod, "w"); foreach (source_pth_and_fn; filelist_src_zpod_arr) { filelist.writeln(source_pth_and_fn); } fn_src_in.copy(fn_src_out_filesystem); } if (doc_matters.opt.action.sisupod) { auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn_src_out_sisupod_zip_base; auto zip_data = new OutBuffer(); zip_data.write((fn_src_in).readText); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); } } else { if (doc_matters.opt.action.verbose || doc_matters.opt.action.debug_do) { writeln("WARNING (io) src in NOT found (markup source): ", fn_src_in); } } } { /+ bundle insert files +/ if (doc_matters.srcs.file_insert_list.length > 0) { foreach (insert_file; doc_matters.srcs.file_insert_list) { debug(sisupod) { writeln( insert_file, " -> ", pths_sisupod.fn_doc_insert( doc_matters.src.filename, insert_file, doc_matters.src.language, ).zpod ); } auto fn_src_in = insert_file; auto fn_src_out_sisupod_zip_base = pths_sisupod.fn_doc_insert( doc_matters.src.filename, insert_file, doc_matters.src.language, ).zpod.to!string; auto fn_src_out_filesystem = pths_sisupod.fn_doc_insert( doc_matters.src.filename, insert_file, doc_matters.src.language, ).filesystem_open_zpod.to!string; if (exists(fn_src_in)) { debug(io) { writeln("(io debug) src out found: ", fn_src_in); } if (doc_matters.opt.action.source) { fn_src_in.copy(fn_src_out_filesystem); } if (doc_matters.opt.action.sisupod) { auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn_src_out_sisupod_zip_base; auto zip_data = new OutBuffer(); zip_data.write((fn_src_in).readText); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_sisupod, zip.build()); } } else { if (doc_matters.opt.action.verbose || doc_matters.opt.action.debug_do) { writeln("WARNING (io) src out NOT found (insert file): ", fn_src_in); } } } } } { auto fn_src_in = doc_matters.src.filename; if (doc_matters.opt.action.sisupod) { if (exists(doc_matters.src.file_with_absolute_path)) { createZipFile!()(fn_sisupod, zip.build()); } else { writeln("WARNING check missing source file(s): ", doc_matters.opt.action.sisupod); } if (!(exists(fn_sisupod))) { writeln("WARNING failed to create sisupod zip archive: ", fn_sisupod); } } } #+END_SRC ** sha256 of sisupod.zip, zip debug, read zip archive #+name: source_sisupod_copy #+BEGIN_SRC d if (exists(fn_sisupod)) { try { if (doc_matters.opt.action.verbose) { auto data = (cast(byte[]) (fn_sisupod).read); writeln(doc_matters.src.filename, " >> "); 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); } } catch (ZipException ex) { // Handle errors } if (doc_matters.src.filename == "sisudoc/media/text/en/the_wealth_of_networks.yochai_benkler.sst") { assert( ((data).sha256Of).toHexString == "626F83A31ED82F42CF528E922C1643498A137ABA3F2E5AFF8A379EA79EA22A1E", "\nsisupod: sha256 value for " ~ doc_matters.src.filename ~ " has changed, is now: " ~ ((data).sha256Of).toHexString ); } if (doc_matters.src.filename == "sisudoc/media/text/en/sisu_markup_stress_test.sst") { assert( ((data).sha256Of).toHexString == "AAE0C87AB3F6D5F7385AEEA6EE661F56D40475CFE87AD930C78C9FE07FFB0D91", "\nsisupod: sha256 value for " ~ doc_matters.src.filename ~ " has changed, is now: " ~ ((data).sha256Of).toHexString ); } } } catch (ErrnoException ex) { // Handle errors } } #+END_SRC * __END__