1 #ifndef __BIAWEBDOCUMENTTREE__
2 #define __BIAWEBDOCUMENTTREE__
8 #include "biawebdocument.hpp"
9 #include "biawebstrings.hpp"
10 #include "biawebutil.hpp"
11 #include "biawebdoclist.hpp"
13 // class to implement a document tree - both with or without subtrees
17 // the pointer to the parent tree if there is one or nullptr
20 std::list<DocumentTree> children;
23 // summary for this tree - this is displayed in the index.html file of
24 // this tree before the list of articles in the tree
26 // file stub of this tree
28 // list of documents in this tree
29 std::list<Document> docs;
30 // set the parent - protected function as this has to be
31 // called only by add_child
32 void set_parent (DocumentTree *parent) {
33 this->parent = parent;
37 // method to build a document tree from a path
38 void document_tree_builder (std::string srcpath);
40 // create new top level document tree
41 DocumentTree (std::string title, std::string stub = "") {
42 this->title = escape_html (title);
43 // if stub is not empty set it
46 // make the stub from the title
48 this->stub = convert_title (title);
49 this->parent = nullptr;
52 // set the summary for this tree
53 void set_summary (std::string summary) {
54 this->summary = summary;
57 // set the summary for this tree as markdown text
58 void set_markdown_summary (std::string summary) {
59 this->summary = convert_to_markdown (summary);
62 std::string get_summary () {
66 // sort the documents as per creation time from latest to oldest
67 void sort_documents_creation_time () {
68 this->docs.sort ([] (Document &a, Document &b)
69 {return (a.get_creation_date() > b.get_creation_date()); });
72 // create the document index for this tree
73 void create_tree_html (std::string templatedir, std::string destdir);
76 void set_title (std::string title) {
77 this->title = escape_html (title);
80 this->stub = convert_title (title);
83 void set_stub (std::string stub) {
87 std::string get_title () {
91 std::string get_stub () {
95 // get the child level of this tree
96 unsigned int get_level ();
98 // get the stub hierarchy
99 std::string stub_hierarchy ();
101 // add a child tree to this tree
102 void add_child (DocumentTree *child) {
103 child->set_parent (this);
104 this->children.push_back (*child);
107 // add a document to this tree
108 void add_document (Document *doc) {
109 this->docs.push_back (*doc);
112 // print a visual representation of this tree with levels
113 void visualize_tree ();
115 // get a pointer to the parent of this tree
116 DocumentTree *get_parent () {
121 // get the tree level - 0 if top level
122 unsigned int DocumentTree::get_level () {
123 unsigned int lev = 0;
124 DocumentTree *par = this->get_parent ();
125 while (par != nullptr) {
127 par = par->get_parent ();
132 // get the stub hierarchy for this tree
133 std::string DocumentTree::stub_hierarchy () {
134 std::list<std::string> levels;
135 DocumentTree *par = this->get_parent();
136 while (par!= nullptr) {
137 levels.push_front (par->get_stub());
138 par = par->get_parent ();
140 std::string stub_str;
141 for (std::string level : levels) {
142 // if stub is empty, don't append a /
144 stub_str += level + "/";
149 // print the representation of this tree
150 void DocumentTree::visualize_tree () {
151 // print the tree level
152 std::cout << std::setw(3) << std::left << this->get_level ();
153 // indent as per the level
154 for (unsigned int i = 0; i < this->get_level(); i ++)
156 // print the title of this tree
157 std::cout << this->title << std::endl;
158 // recurse through the child trees if any and so on
159 for (DocumentTree child : children)
160 child.visualize_tree ();
163 // create the tree - the index file for this tree and all the documents and
164 // the child trees recursively - using the template specified
165 void DocumentTree::create_tree_html (std::string templatedir, std::string destdir) {
166 std::unique_ptr<Document> index (new Document (this->title));
167 index.get()->set_index ();
168 // set the file name path
169 std::string filepath = destdir + "/" + this->stub_hierarchy () + this->stub;
170 // set the url path - this should not have destdir as it is not part
172 std::string urlpath = this->stub_hierarchy () + this->stub;
173 // if urlpath is not empty then append a / to the end of the URL. This
174 // is so that the base URL is not absolute
178 // create the sidebars
180 // Create a link to the index page and
181 // If this tree has a parent, create a sidebar link to the level up
182 std::unique_ptr<SideBar> bar1 (new SideBar());
184 item0.set_sidebar_text (INDEX);
185 item0.set_sidebar_url (urlpath + "index.html");
186 bar1.get()->add_sidebar_item (item0);
187 if (this->get_parent() != nullptr) {
189 item1.set_sidebar_text (GO_UP);
190 item1.set_sidebar_url (this->stub_hierarchy() + "index.html");
191 bar1.get()->add_sidebar_item (item1);
193 index.get()->add_side_bar (*bar1.get());
195 // create a sidebar for the child levels if there are children
196 std::unique_ptr<SideBar> bar2 (new SideBar ());
197 bar2.get()->set_title (SUB_CAT + this->title);
198 for (DocumentTree tree : this->children) {
199 // we use site relative URLs that rely on the base href tag
200 // so for biaweb generated sites, the base href tag should be
201 // used in the main template
202 SideBarItem item (tree.get_title(), urlpath +
203 tree.stub + "/" + "index.html");
204 bar2.get()->add_sidebar_item (item);
206 index.get()->add_side_bar (*bar2.get());
208 // create the path and then the index file
209 std::filesystem::create_directories (filepath);
211 // Create the list of documents in this tree with links
212 std::unique_ptr<DocList> article_list (new DocList ());
213 article_list.get()->set_title (this->title + ": " + ART_LIST);
214 // sort the documents as per creation time and then add the document
215 // links - newest documents should appear above older ones.
216 sort_documents_creation_time ();
217 for (Document doc : this->docs) {
218 DocListItem item (doc.get_title(),
219 urlpath + doc.get_filename() + ".html",
220 doc.get_creation_date(), doc.get_modified_date ());
221 article_list.get()->add_document_item (item);
222 // output the document also, add the side bars
223 doc.add_side_bar (*bar1.get());
224 doc.add_side_bar (*bar2.get());
225 doc.output_to_html (templatedir, filepath);
227 // index should contain the summary followed by the article list
228 index.get()->set_content (this->summary + article_list.get()->to_html(templatedir));
230 index.get()->output_to_html (templatedir, filepath);
232 // recursively create index for children
233 for (DocumentTree tree : this->children)
234 tree.create_tree_html (templatedir, destdir);
237 // build a document tree from a filesystem path recursively
238 void DocumentTree::document_tree_builder (std::string srcpath_str) {
239 std::filesystem::path srcpath (srcpath_str);
240 this->title = srcpath.stem().string ();
242 // Get the directories to this child and add them as sub document
245 for (auto fsitem : std::filesystem::directory_iterator (srcpath) )
247 // if it is a directory then build the tree for that directory
248 if (fsitem.is_directory ()) {
249 std::shared_ptr <DocumentTree> doctree
250 (new DocumentTree (fsitem.path().filename().string()));
252 this->add_child (doctree.get());
254 // add the regular files as documents in the tree
255 else if (fsitem.is_regular_file ()) {
256 // read the contents of the file
257 std::ifstream infile (fsitem.path().string());
258 std::string infilestr ((std::istreambuf_iterator<char> (infile)),
259 (std::istreambuf_iterator<char> ()));
260 // if it is an index file (specially named index) add
261 // the contents to the summary of the Doctree
262 if (fsitem.path().stem().string() == "index")
264 this->set_markdown_summary (infilestr);
266 // else it is a non-index file-
267 // create a Document and add it to the tree
269 std::shared_ptr<Document> doc
270 (new Document (fsitem.path().stem().string()));
272 // file creation/modified date from system
274 if (stat (fsitem.path().string().c_str(), &buf) == 0)
276 doc.get()->set_creation_date (buf.st_ctim.tv_sec);
277 doc.get()->set_modified_date (buf.st_mtim.tv_sec);
279 doc.get()->set_markdown_content (infilestr);
281 this->add_document (doc.get());
286 catch (std::filesystem::filesystem_error) {
287 std::cout << "No such path! Specify an existing file path" << std::endl;
290 // add the trees for the children recursively
291 for (DocumentTree &child : this->children)
292 child.document_tree_builder (srcpath_str + "/" + child.title);