aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/sisudoc/ocda/abstraction/db_in.d
blob: 3d10540e247aa1854c357fb2d6f3d0f330c46f1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/+
- Name: SisuDoc Spine, Doc Reform [a part of]
  - Description: documents, structuring, processing, publishing, search
    - static content generator

  - Author: Ralph Amissah
    [ralph.amissah@gmail.com]

  - Copyright: (C) 2015 (continuously updated, current 2026) Ralph Amissah, All Rights Reserved.

  - License: AGPL 3 or later:

    Spine (SiSU), a framework for document structuring, publishing and
    search

    Copyright (C) Ralph Amissah

    This program is free software: you can redistribute it and/or modify it
    under the terms of the GNU AFERO General Public License as published by the
    Free Software Foundation, either version 3 of the License, or (at your
    option) any later version.

    This program is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
    more details.

    You should have received a copy of the GNU General Public License along with
    this program. If not, see [https://www.gnu.org/licenses/].

    If you have Internet connection, the latest version of the AGPL should be
    available at these locations:
    [https://www.fsf.org/licensing/licenses/agpl.html]
    [https://www.gnu.org/licenses/agpl.html]

  - Spine (by Doc Reform, related to SiSU) uses standard:
    - docReform markup syntax
      - standard SiSU markup syntax with modified headers and minor modifications
    - docReform object numbering
      - standard SiSU object citation numbering & system

  - Homepages:
    [https://www.sisudoc.org]
    [https://www.doc-reform.org]

  - Git
    [https://git.sisudoc.org/]

+/
module sisudoc.ocda.abstraction.db_in;
@safe:
/+ ↓ read a <doc>.ocda.db back into the document abstraction

     the counterpart of sisudoc.outputs.io_out.create_ocda, and the
     sibling of sisudoc.ocda.abstraction.ssp_in: it returns the same value,
     so a consumer does not have to know which of the two artefacts it was
     handed.

     the check is the same one: read a database, emit it as .ssp with the
     writer's own record definition, and require the result to equal the .ssp
     written from the same document.
+/
template spineAbstractionDbRead() {
  import std.conv : to;
  import std.file;
  import std.stdio;
  import std.string;
  import std.array;
  import std.json;
  import d2sqlite3;
  import sisudoc.ocda.abstraction.ssp_in : spineAbstractionRead;
  mixin spineAbstractionRead;   // for SSPdocument, and the shared unescape
  private int[8] _jsonEight(string _s) {
    int[8] _out;
    if (_s.length == 0) { return _out; }
    try {
      auto _j = parseJSON(_s);
      foreach (i, v; _j.array) {
        if (i < _out.length) { _out[i] = v.integer.to!int; }
      }
    } catch (Exception ex) {}
    return _out;
  }
  private int[] _jsonInts(string _s) {
    int[] _out;
    if (_s.length == 0) { return _out; }
    try {
      auto _j = parseJSON(_s);
      foreach (v; _j.array) { _out ~= v.integer.to!int; }
    } catch (Exception ex) {}
    return _out;
  }
  private string[] _jsonStrs(string _s) {
    string[] _out;
    if (_s.length == 0) { return _out; }
    try {
      auto _j = parseJSON(_s);
      foreach (v; _j.array) { _out ~= v.str; }
    } catch (Exception ex) {}
    return _out;
  }
  private double[] _jsonDoubles(string _s) {
    double[] _out;
    if (_s.length == 0) { return _out; }
    try {
      auto _j = parseJSON(_s);
      foreach (v; _j.array) {
        _out ~= (v.type == JSONType.integer) ? v.integer.to!double : v.floating;
      }
    } catch (Exception ex) {}
    return _out;
  }
  private ubyte[32] _hex32(string hex) {
    ubyte[32] _out;
    if (hex.length < 64) { return _out; }
    foreach (i; 0..32) { _out[i] = hex[i*2 .. i*2+2].to!ubyte(16); }
    return _out;
  }
  private string _levMarkedUp(int lev) {
    switch (lev) {
    case 0:  return "A";
    case 1:  return "B";
    case 2:  return "C";
    case 3:  return "D";
    case 4:  return "1";
    case 5:  return "2";
    case 6:  return "3";
    case 7:  return "4";
    default: return "";
    }
  }
  @trusted SSPdocument dbReadFile(string db_file) {
    SSPdocument doc;
    if (!db_file.exists) {
      writeln("ERROR: no such file: ", db_file);
      return doc;
    }
    auto db = Database(db_file, SQLITE_OPEN_READONLY);
    /+ ↓ the four header blocks, from the metadata table. the key prefix
         says which block a row belongs to, and insertion order is kept +/
    foreach (row; db.execute("SELECT key, value FROM metadata ORDER BY rowid")) {
      string _k = row["key"].as!string;
      string _v = row["value"].as!string;
      if (_k.startsWith("make.")) {
        string _kk = _k["make.".length .. $];
        doc.make[_kk] = _v;
        doc.make_order ~= _kk;
      } else if (_k.startsWith("doc_has.")) {
        string _kk = _k["doc_has.".length .. $];
        doc.doc_has[_kk] = _v;
        doc.doc_has_order ~= _kk;
      } else if (_k.startsWith("schema.")) {
        if (_k == "schema.version") {
          doc.format = "% SiSU Document Abstraction v" ~ _v;
        }
      } else if (_k == "source.filename") {
        doc.source = _v;
      } else if (_k == "source.ssp_digest") {
        /+ ↓ this database's own note of the .ssp it was built from. it is
             not part of the .ssp, so it does not go back into the block +/
        doc.ssp_digest = _v;
      } else if (_k.startsWith("source.")) {
        string _kk = _k["source.".length .. $];
        doc.source_info[_kk] = _v;
        doc.source_info_order ~= _kk;
      } else {
        doc.meta[_k] = _v;
        doc.meta_order ~= _k;
      }
    }
    if (!sspFormatVersionOk(doc.format, db_file)) { return SSPdocument(); }
    /+ ↓ the objects, section by section, in the order they were written +/
    string[] _sections;
    foreach (row; db.execute(
      "SELECT section FROM objects GROUP BY section ORDER BY MIN(id)")
    ) {
      _sections ~= row["section"].as!string;
    }
    foreach (section; _sections) {
      doc.section_order ~= section;
      doc.abstraction[section] = [];
      foreach (row; db.execute(
        "SELECT * FROM objects WHERE section = '" ~ section ~ "' ORDER BY seq")
      ) {
        ObjGenericComposite obj;
        long _id                          = row["id"].as!long;
        obj.metainfo.ocn                  = row["ocn"].as!int;
        obj.metainfo.is_a                 = row["is_a"].as!string;
        obj.metainfo.is_of_part           = row["is_of_part"].as!string;
        obj.metainfo.is_of_section        = (row["is_of_section"].as!string.length > 0)
          ? row["is_of_section"].as!string : section;
        obj.metainfo.is_of_type           = row["is_of_type"].as!string;
        obj.metainfo.identifier           = row["identifier"].as!string;
        obj.metainfo.heading_lev_markup   = (obj.metainfo.is_a == "heading")
          ? row["heading_level"].as!int : 9;
        obj.metainfo.heading_lev_collapsed = (row["heading_lev_collapsed"].as!string.length > 0)
          ? row["heading_lev_collapsed"].as!int : 9;
        obj.metainfo.parent_ocn           = row["parent_ocn"].as!int;
        obj.metainfo.parent_lev_markup    = row["parent_lev"].as!int;
        obj.metainfo.last_descendant_ocn  = row["last_descendant_ocn"].as!int;
        obj.metainfo.children_headings    = _jsonInts(row["children"].as!string);
        obj.metainfo.markedup_ancestors   = _jsonEight(row["ancestors"].as!string);
        obj.metainfo.collapsed_ancestors  = _jsonEight(row["ancestors_collapsed"].as!string);
        obj.metainfo.dom_structure_markedup_tags_status
          = _jsonEight(row["dom_status"].as!string);
        obj.metainfo.dom_structure_collapsed_tags_status
          = _jsonEight(row["dom_status_collapsed"].as!string);
        obj.metainfo.dummy_heading        = (row["dummy_heading"].as!int == 1);
        obj.metainfo.object_number_off    = (row["object_number_off"].as!int == 1);
        obj.metainfo.attrib               = row["attrib"].as!string;
        obj.metainfo.lang                 = row["meta_lang"].as!string;
        obj.metainfo.syntax               = row["meta_syntax"].as!string;
        obj.metainfo.sha256.text          = _hex32(row["sha256"].as!string);
        obj.attrib.indent_base            = row["indent_base"].as!int;
        obj.attrib.indent_hang            = row["indent_hang"].as!int;
        obj.attrib.bullet                 = (row["bullet"].as!int == 1);
        obj.attrib.language               = row["lang"].as!string;
        obj.has.inline_links              = (row["has_links"].as!int == 1);
        obj.has.inline_notes_reg          = (row["has_notes_reg"].as!int == 1);
        obj.has.inline_notes_star         = (row["has_notes_star"].as!int == 1);
        obj.has.images                    = (row["has_images"].as!int == 1);
        obj.has.image_without_dimensions  = (row["has_images_no_dim"].as!int == 1);
        obj.tags.in_segment_html          = row["segment"].as!string;
        obj.tags.segname_prev             = row["segment_prev"].as!string;
        obj.tags.segname_next             = row["segment_next"].as!string;
        obj.tags.segment_anchor_tag_epub  = row["segment_epub"].as!string;
        obj.tags.html_segment_anchor_tag_is = row["segment_html_is"].as!string;
        obj.tags.epub_segment_anchor_tag_is = row["segment_epub_is"].as!string;
        obj.tags.anchor_tag_html          = row["anchor"].as!string;
        obj.tags.heading_lev_anchor_tag   = row["heading_lev_anchor"].as!string;
        {
          string[8] _h;
          foreach (i, h; _jsonStrs(row["heading_ancestors_text"].as!string)) {
            if (i < _h.length) { _h[i] = h; }
          }
          obj.tags.heading_ancestors_text = _h;
        }
        if (obj.metainfo.is_a == "table") {
          obj.table.number_of_columns     = row["table_cols"].as!int;
          obj.table.column_widths         = _jsonDoubles(row["table_widths"].as!string);
          obj.table.column_aligns         = _jsonStrs(row["table_aligns"].as!string);
          obj.table.heading               = (row["table_header"].as!int == 1);
        }
        obj.code_block.linenumbers        = (row["code_linenumbers"].as!int == 1);
        obj.text                          = row["text"].as!string;
        /+ ↓ the per object lists +/
        foreach (r; db.execute(
          "SELECT name, bytes, sha256, width, height, missing FROM object_images"
          ~ " WHERE object_id = " ~ _id.to!string ~ " ORDER BY seq")
        ) {
          ST_file_name_hash_size_ _img;
          _img.fileName        = r["name"].as!string;
          _img.fileSize        = r["bytes"].as!ulong;
          _img.fileHash_sha256 = _hex32(r["sha256"].as!string);
          _img.imageWidth      = r["width"].as!int;
          _img.imageHeight     = r["height"].as!int;
          _img.fileMissing     = (r["missing"].as!int == 1);
          obj.metainfo.sha256.images ~= _img;
        }
        foreach (r; db.execute(
          "SELECT url FROM object_links WHERE object_id = " ~ _id.to!string ~ " ORDER BY seq")
        ) { obj.stow.link ~= r["url"].as!string; }
        foreach (r; db.execute(
          "SELECT anchor FROM object_anchors WHERE object_id = " ~ _id.to!string ~ " ORDER BY seq")
        ) { obj.tags.anchor_tags ~= r["anchor"].as!string; }
        foreach (r; db.execute(
          "SELECT entry FROM object_subtoc WHERE object_id = " ~ _id.to!string ~ " ORDER BY seq")
        ) { obj.tags.lev4_subtoc ~= r["entry"].as!string; }
        doc.abstraction[section] ~= obj;
      }
    }
    return doc;
  }
}