aboutsummaryrefslogtreecommitdiffhomepage
path: root/org/output_src_pod.org
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2018-10-13 22:05:22 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2019-04-10 15:14:15 -0400
commita22df0d4e7df79da6943bd1a37d6e3f74728165f (patch)
treebc9ebc1413eb703dca77369470cf722cbec68ca0 /org/output_src_pod.org
parentinternal linking to headers A to D for segmented html (diff)
0.2.0 renames pod from sisupod
Diffstat (limited to 'org/output_src_pod.org')
-rw-r--r--org/output_src_pod.org335
1 files changed, 335 insertions, 0 deletions
diff --git a/org/output_src_pod.org b/org/output_src_pod.org
new file mode 100644
index 0000000..ee0925a
--- /dev/null
+++ b/org/output_src_pod.org
@@ -0,0 +1,335 @@
+#+TITLE: doc_reform output pod
+#+DESCRIPTION: documents - structuring, publishing in multiple formats & search
+#+FILETAGS: :doc_reform:output:pod:
+#+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]]
+
+* pod :module:doc_reform:source_pod:
+** module template
+
+#+BEGIN_SRC d :tangle ../src/doc_reform/output/source_pod.d
+module doc_reform.output.source_pod;
+template DocReformPod() {
+ <<output_imports>>
+ void DocReformPod(T)(T doc_matters) {
+ <<source_pod_init>>
+ try {
+ <<source_pod_mkdirs>>
+ <<source_pod_copy>>
+ <<source_pod_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_pod_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_pod = DocReformPathsPods!()(doc_matters);
+mixin DocReformLanguageCodes;
+auto lang = Lang();
+static auto rgx = Rgx();
+assert (doc_matters.src.filename.match(rgx.src_fn));
+#+END_SRC
+
+#+name: source_pod_mkdirs
+#+BEGIN_SRC d
+/+ create directory structure +/
+if (!exists(pths_pod.pod_dir_())) {
+ // used both by pod zipped (& pod filesystem (unzipped) which makes its own recursive dirs)
+ pths_pod.pod_dir_().mkdirRecurse;
+}
+if (doc_matters.opt.action.source) {
+ if (!exists(pths_pod.text_root(doc_matters.src.filename).filesystem_open_zpod)) {
+ pths_pod.text_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse;
+ }
+ if (!exists(pths_pod.conf_root(doc_matters.src.filename).filesystem_open_zpod)) {
+ pths_pod.conf_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse;
+ }
+ if (!exists(pths_pod.media_root(doc_matters.src.filename).filesystem_open_zpod)) {
+ pths_pod.media_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse;
+ }
+ if (!exists(pths_pod.css(doc_matters.src.filename).filesystem_open_zpod)) {
+ pths_pod.css(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse;
+ }
+ if (!exists(pths_pod.image_root(doc_matters.src.filename).filesystem_open_zpod)) {
+ pths_pod.image_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse;
+ }
+ if (!exists(pths_pod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod)) {
+ pths_pod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.mkdirRecurse;
+ }
+}
+#+END_SRC
+
+** copy
+
+#+name: source_pod_copy
+#+BEGIN_SRC d
+debug(pod) {
+ writeln(__LINE__, ": ",
+ doc_matters.src.filename, " -> ",
+ pths_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod
+ );
+}
+auto zip = new ZipArchive();
+auto fn_pod = pths_pod.pod_filename(doc_matters.src.filename).zpod;
+{ /+ bundle images +/
+ foreach (image; doc_matters.srcs.image_list) {
+ debug(podimages) {
+ writeln(
+ pth_sisudoc_src.image_root.to!string, "/", image, " -> ",
+ pths_pod.image_root(doc_matters.src.filename).zpod, "/", image
+ );
+ }
+ auto fn_src_in = doc_matters.src.image_dir_path ~ "/" ~ image;
+ auto fn_src_out_pod_zip_base
+ = pths_pod.image_root(doc_matters.src.filename).zpod.to!string
+ ~ "/" ~ image;
+ auto fn_src_out_filesystem
+ = pths_pod.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.pod) {
+ auto zip_arc_member_file = new ArchiveMember();
+ zip_arc_member_file.name = fn_src_out_pod_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_pod_zip_base
+ = pths_pod.conf_root(doc_matters.src.filename).zpod.to!string ~ "/" ~ "sisu_document_make";
+ auto fn_src_out_filesystem
+ = pths_pod.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.pod) {
+ auto zip_arc_member_file = new ArchiveMember();
+ zip_arc_member_file.name = fn_src_out_pod_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_pod_zip_base
+ = pths_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string;
+ auto fn_src_out_filesystem
+ = pths_pod.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_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; // without root path:
+ string[] filelist_src_out_pod_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_pod_arr ~= fn_src_out_pod_zip_base;
+ filelist_src_zpod_arr ~= fn_src_out_inside_pod;
+ if (doc_matters.opt.action.source) {
+ auto filelist
+ = File(pths_pod.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.pod) {
+ auto zip_arc_member_file = new ArchiveMember();
+ zip_arc_member_file.name = fn_src_out_pod_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(pod) {
+ writeln(
+ insert_file, " -> ",
+ pths_pod.fn_doc_insert(
+ doc_matters.src.filename,
+ insert_file,
+ doc_matters.src.language,
+ ).zpod
+ );
+ }
+ auto fn_src_in = insert_file;
+ auto fn_src_out_pod_zip_base
+ = pths_pod.fn_doc_insert(
+ doc_matters.src.filename,
+ insert_file,
+ doc_matters.src.language,
+ ).zpod.to!string;
+ auto fn_src_out_filesystem
+ = pths_pod.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.pod) {
+ auto zip_arc_member_file = new ArchiveMember();
+ zip_arc_member_file.name = fn_src_out_pod_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_pod, 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.pod) {
+ if (exists(doc_matters.src.file_with_absolute_path)) {
+ createZipFile!()(fn_pod, zip.build());
+ } else {
+ writeln("WARNING check missing source file(s): ", doc_matters.opt.action.pod);
+ }
+ if (!(exists(fn_pod))) {
+ writeln("WARNING failed to create pod zip archive: ", fn_pod);
+ }
+ }
+}
+#+END_SRC
+
+** sha256 of pod.zip, zip debug, read zip archive
+
+#+name: source_pod_copy
+#+BEGIN_SRC d
+if (exists(fn_pod)) {
+ try {
+ if (doc_matters.opt.action.verbose) {
+ auto data = (cast(byte[]) (fn_pod).read);
+ writeln(doc_matters.src.filename, " >> ");
+ writefln("%-(%02x%) %s", data.sha256Of, fn_pod);
+ }
+ debug(pod) {
+ try {
+ auto zipped = new ZipArchive((fn_pod).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",
+ "\npod: 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",
+ "\npod: sha256 value for "
+ ~ doc_matters.src.filename
+ ~ " has changed, is now: "
+ ~ ((data).sha256Of).toHexString
+ );
+ }
+ }
+ }
+ catch (ErrnoException ex) {
+ // Handle errors
+ }
+}
+#+END_SRC
+
+* __END__