1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Base entities of a nitiwiki.
18 import template
::macro
22 # A Nitiwiki instance.
24 # Nitiwiki provide all base services used by `WikiSection` and `WikiArticle`.
25 # It manages content and renders pages.
27 # Each nitiwiki instance is linked to a config file.
28 # This file show to `nitiwiki` that a wiki is present in the current directory.
29 # Without it, nitiwiki will consider the directory as empty.
33 var config
: WikiConfig
35 # Default config filename.
36 var config_filename
= "config.ini"
38 # Force render on all file even if the source is unmodified.
39 var force_render
= false is writable
42 var verbose_level
= 0 is writable
44 # Delete all the output files.
46 var out_dir
= expand_path
(config
.root_dir
, config
.out_dir
)
47 if out_dir
.file_exists
then out_dir
.rmdir
50 # Synchronize local output with the distant `WikiConfig::rsync_dir`.
52 var root
= expand_path
(config
.root_dir
, config
.out_dir
)
53 var rsync_dir
= config
.rsync_dir
54 sys
.system
"rsync -vr --delete -- {root.escape_to_sh}/ {rsync_dir.escape_to_sh}"
57 # Pull data from git repository.
59 sys
.system
"git pull {config.git_origin.escape_to_sh} {config.git_branch.escape_to_sh}"
62 # Analyze wiki files from `dir` to build wiki entries.
64 # This method build a hierarchical structure of `WikiSection` and `WikiArticle`
65 # based on the markdown source structure.
67 var dir
= expand_path
(config
.root_dir
, config
.source_dir
)
68 root_section
= new_section
(dir
)
69 var files
= list_md_files
(dir
)
81 print
"name: {config.wiki_name}"
82 print
"config: {config.ini_file}"
84 if root_section
.is_dirty
then
85 print
"There is modified files:"
86 var paths
= entries
.keys
.to_a
87 var s
= new DefaultComparator
90 var entry
= entries
[path
]
91 if not entry
.is_dirty
then continue
93 if entry
.has_source
then name
= entry
.src_path
.to_s
101 print
"Use nitiwiki --render to render modified files"
103 print
"Wiki is up-to-date"
105 print
"Use nitiwiki --fetch to pull modification from origin"
106 print
"Use nitiwiki --rsync to synchronize distant output"
110 # Display msg if `level <= verbose_level`
111 fun message
(msg
: String, level
: Int) do
112 if level
<= verbose_level
then print msg
115 # List markdown source files from a directory.
116 fun list_md_files
(dir
: String): Array[String] do
117 var files
= new Array[String]
118 var pipe
= new ProcessReader("find", dir
, "-name", "*.{config.md_ext}")
119 while not pipe
.eof
do
120 var file
= pipe
.read_line
121 if file
== "" then break # last line
122 var name
= file
.basename
(".{config.md_ext}")
123 if name
== "header" or name
== "footer" or name
== "menu" then continue
128 if pipe
.status
!= 0 then exit
1
129 var s
= new DefaultComparator
134 # Does `src` have been modified since `target` creation?
136 # Always returns `true` if `--force` is on.
137 fun need_render
(src
, target
: String): Bool do
138 if force_render
then return true
139 if not target
.file_exists
then return true
140 return src
.file_stat
.mtime
>= target
.file_stat
.mtime
143 # Create a new `WikiSection`.
145 # `path` is used to determine the place in the wiki hierarchy.
146 protected fun new_section
(path
: String): WikiSection do
147 path
= path
.simplify_path
148 if entries
.has_key
(path
) then return entries
[path
].as(WikiSection)
149 var root
= expand_path
(config
.root_dir
, config
.source_dir
)
150 var name
= path
.basename
("")
151 var section
= new WikiSection(self, name
)
152 entries
[path
] = section
153 if path
== root
then return section
154 var ppath
= path
.dirname
155 if ppath
!= path
then
156 var parent
= new_section
(ppath
)
157 parent
.add_child
(section
)
159 section
.try_load_config
163 # Create a new `WikiArticle`.
165 # `path` is used to determine the ancestor sections.
166 protected fun new_article
(path
: String): WikiArticle do
167 if entries
.has_key
(path
) then return entries
[path
].as(WikiArticle)
168 message
("Found article `{path}`", 2)
169 var article
= new WikiArticle.from_source
(self, path
)
170 var section
= new_section
(path
.dirname
)
171 section
.add_child
(article
)
172 entries
[path
] = article
176 # Wiki entries found in the last `lookup_hierarchy`.
177 var entries
= new HashMap[String, WikiEntry]
179 # The root `WikiSection` of the site found in the last `lookup_hierarchy`.
180 var root_section
: WikiSection is noinit
182 # Does a template named `name` exists for this wiki?
183 fun has_template
(name
: String): Bool do
184 return expand_path
(config
.root_dir
, config
.templates_dir
, name
).file_exists
187 # Load a template file as a `TemplateString`.
189 # REQUIRE: `has_template`
190 fun load_template
(name
: String): TemplateString do
191 if not has_template
(name
) then
192 message
("Error: can't load template `{name}`", 0)
195 var file
= expand_path
(config
.root_dir
, config
.templates_dir
, name
)
196 var tpl
= new TemplateString.from_file
(file
)
197 if tpl
.has_macro
("TITLE") then
198 tpl
.replace
("TITLE", config
.wiki_name
)
200 if tpl
.has_macro
("SUBTITLE") then
201 tpl
.replace
("SUBTITLE", config
.wiki_desc
)
203 if tpl
.has_macro
("LOGO") then
204 tpl
.replace
("LOGO", config
.wiki_logo
)
209 # Does a sideblock named `name` exists for this wiki?
210 fun has_sideblock
(name
: String): Bool do
211 name
= "{name}.{config.md_ext}"
212 return expand_path
(config
.root_dir
, config
.sidebar_dir
, name
).file_exists
215 # Load a markdown block with `name` from `WikiConfig::sidebar_dir`.
216 private fun load_sideblock
(name
: String): nullable String do
217 if not has_sideblock
(name
) then
218 message
("Error: can't load sideblock `{name}`", 0)
221 name
= "{name}.{config.md_ext}"
222 var path
= expand_path
(config
.root_dir
, config
.sidebar_dir
, name
)
223 var file
= new FileReader.open
(path
)
224 var res
= file
.read_all
229 # Join `parts` as a path and simplify it
230 fun expand_path
(parts
: String...): String do
233 path
= path
.join_path
(part
)
235 return path
.simplify_path
238 # Transform an id style name into a pretty printed name.
240 # Used to translate ids in beautiful page names.
241 fun pretty_name
(name
: String): String do
242 name
= name
.replace
("_", " ")
243 name
= name
.capitalized
248 # A wiki is composed of hierarchical entries.
249 abstract class WikiEntry
251 # `Nitiwiki` this entry belongs to.
256 # Entry internal name.
258 # Mainly used in urls.
261 # Displayed title for `self`.
263 # If `self` is the root entry then display the wiki `WikiConfig::wiki_name` instead.
265 if is_root
then return wiki
.config
.wiki_name
266 return wiki
.pretty_name
(name
)
269 # Is this section rendered from a source document?
271 # Source is an abstract concept at this level.
272 # It can represent a directory, a source file,
273 # a part of a file, everything needed to
274 # extend this base framework.
275 fun has_source
: Bool do return src_path
!= null
277 # Entry creation time.
279 # Returns `-1` if not `has_source`.
280 fun create_time
: Int do
281 if not has_source
then return -1
282 return src_full_path
.file_stat
.ctime
285 # Entry last modification time.
287 # Returns `-1` if not `has_source`.
288 fun last_edit_time
: Int do
289 if not has_source
then return -1
290 return src_full_path
.file_stat
.mtime
293 # Entry list rendering time.
295 # Returns `-1` if `is_new`.
296 fun last_render_time
: Int do
297 if is_new
then return -1
298 return out_full_path
.file_stat
.mtime
303 # Type of the parent entry.
304 type PARENT: WikiEntry
306 # Parent entry if any.
307 var parent
: nullable PARENT = null
309 # Does `self` have a parent?
310 fun is_root
: Bool do return parent
== null
312 # Children labelled by `name`.
313 var children
= new HashMap[String, WikiEntry]
315 # Does `self` have a child nammed `name`?
316 fun has_child
(name
: String): Bool do return children
.keys
.has
(name
)
318 # Retrieve the child called `name`.
319 fun child
(name
: String): WikiEntry do return children
[name
]
321 # Add a sub-entry to `self`.
322 fun add_child
(entry
: WikiEntry) do
324 children
[entry
.name
] = entry
329 # Breadcrumbs from the `Nitiwiki::root_section` to `self`.
331 # Result is returned as an array containg ordered entries:
332 # `breadcrumbs.first` is the root entry and
333 # `breadcrumbs.last == self`
334 var breadcrumbs
: Array[WikiEntry] is lazy
do
335 var path
= new Array[WikiEntry]
336 var entry
: nullable WikiEntry = self
337 while entry
!= null and not entry
.is_root
do
344 # Sidebar relative to this wiki entry.
345 var sidebar
= new WikiSidebar(self)
347 # Relative path from `wiki.config.root_dir` to source if any.
348 fun src_path
: nullable String is abstract
350 # Absolute path to the source if any.
351 fun src_full_path
: nullable String do
353 if src
== null then return null
354 return wiki
.config
.root_dir
.join_path
(src
)
357 # Relative path from `wiki.config.root_dir` to rendered output.
359 # Like `src_path`, this method can represent a
360 # directory or a file.
361 fun out_path
: String is abstract
363 # Absolute path to the output.
364 fun out_full_path
: String do return wiki
.config
.root_dir
.join_path
(out_path
)
368 # Does `self` have already been rendered?
369 fun is_new
: Bool do return not out_full_path
.file_exists
371 # Does `self` rendered output is outdated?
373 # Returns `true` if `is_new` then check in children.
374 fun is_dirty
: Bool do
375 if is_new
then return true
377 if last_edit_time
>= last_render_time
then return true
379 for child
in children
.values
do
380 if child
.is_dirty
then return true
385 # Render `self` and `children` is needed.
386 fun render
do for child
in children
.values
do child
.render
390 # Template file for `self`.
392 # Each entity can use a custom template.
393 # By default the template is inherited from the parent.
395 # If the root does not have a custom template,
396 # then returns the main wiki template file.
397 fun template_file
: String do
398 if is_root
then return wiki
.config
.template_file
399 return parent
.template_file
402 # Header template file for `self`.
404 # Behave like `template_file`.
405 fun header_file
: String do
406 if is_root
then return wiki
.config
.header_file
407 return parent
.header_file
410 # Footer template file for `self`.
412 # Behave like `template_file`.
413 fun footer_file
: String do
414 if is_root
then return wiki
.config
.footer_file
415 return parent
.footer_file
418 # Menu template file for `self`.
420 # Behave like `template_file`.
421 fun menu_file
: String do
422 if is_root
then return wiki
.config
.menu_file
423 return parent
.menu_file
426 # Display the entry `name`.
427 redef fun to_s
do return name
430 # Each WikiSection is related to a source directory.
432 # A section can contain other sub-sections or pages.
436 # A section can only have another section as parent.
437 redef type PARENT: WikiSection
441 var title
= config
.title
442 if title
!= null then return title
447 # Is this section hidden?
449 # Hidden section are rendered but not linked in menus.
450 fun is_hidden
: Bool do
451 if has_config
then return config
.is_hidden
456 redef fun src_path
: String do
457 if parent
== null then
458 return wiki
.config
.source_dir
460 return wiki
.expand_path
(parent
.src_path
, name
)
466 # Custom configuration file for this section.
467 var config
: nullable SectionConfig = null
469 # Does this section have its own config file?
470 fun has_config
: Bool do return config
!= null
472 # Try to load the config file for this section.
473 private fun try_load_config
do
474 var cfile
= wiki
.expand_path
(wiki
.config
.root_dir
, src_path
, wiki
.config_filename
)
475 if not cfile
.file_exists
then return
476 wiki
.message
("Custom config for section {name}", 1)
477 config
= new SectionConfig(cfile
)
482 # Also check custom config.
483 redef fun template_file
do
485 var tpl
= config
.template_file
486 if tpl
!= null then return tpl
488 if is_root
then return wiki
.config
.template_file
489 return parent
.template_file
492 # Also check custom config.
493 redef fun header_file
do
495 var tpl
= config
.header_file
496 if tpl
!= null then return tpl
498 if is_root
then return wiki
.config
.header_file
499 return parent
.header_file
502 # Also check custom config.
503 redef fun footer_file
do
505 var tpl
= config
.footer_file
506 if tpl
!= null then return tpl
508 if is_root
then return wiki
.config
.footer_file
509 return parent
.footer_file
512 # Also check custom config.
513 redef fun menu_file
do
515 var tpl
= config
.menu_file
516 if tpl
!= null then return tpl
518 if is_root
then return wiki
.config
.menu_file
519 return parent
.menu_file
523 # Each WikiArticle is related to a HTML file.
525 # Article can be created from scratch using this API or
526 # automatically from a markdown source file (see: `from_source`).
530 # Articles can only have `WikiSection` as parents.
531 redef type PARENT: WikiSection
533 redef fun title
: String do
534 if name
== "index" and parent
!= null then return parent
.title
540 # What you want to be displayed in the page.
541 var content
: nullable Writable = null is writable
543 # Create a new article using a markdown source file.
544 init from_source
(wiki
: Nitiwiki, md_file
: String) do
545 src_full_path
= md_file
546 init(wiki
, md_file
.basename
(".{wiki.config.md_ext}"))
550 redef var src_full_path
: nullable String = null
552 redef fun src_path
do
553 var src_full_path
= self.src_full_path
554 if src_full_path
== null then return null
555 var res
= wiki
.config
.root_dir
.relpath
(src_full_path
)
559 # The page markdown source content.
561 # Extract the markdown text from `source_file`.
563 # REQUIRE: `has_source`.
564 var md
: nullable String is lazy
do
565 if not has_source
then return null
566 var file
= new FileReader.open
(src_full_path
.to_s
)
567 var md
= file
.read_all
572 # Returns true if has source and
573 # `last_edit_date` > 'last_render_date'.
574 redef fun is_dirty
do
575 if super then return true
577 return wiki
.need_render
(src_full_path
.to_s
, out_full_path
)
582 redef fun to_s
do return "{name} ({parent or else "null"})"
585 # The sidebar is displayed in front of the main panel of a `WikiEntry`.
588 # Wiki used to parse sidebar blocks.
589 var wiki
: Nitiwiki is lazy
do return entry
.wiki
591 # WikiEntry this panel is related to.
594 # Blocks are ieces of markdown that will be rendered in the sidebar.
595 var blocks
: Array[Text] is lazy
do
596 var res
= new Array[Text]
597 # TODO get blocks from the entry for more customization
598 for name
in entry
.wiki
.config
.sidebar_blocks
do
599 var block
= wiki
.load_sideblock
(name
)
600 if block
== null then continue
607 # Wiki configuration class.
609 # This class provides services that ensure static typing when accessing the `config.ini` file.
613 # Returns the config value at `key` or return `default` if no key was found.
614 private fun value_or_default
(key
: String, default
: String): String do
615 if not has_key
(key
) then return default
619 # Site name displayed.
621 # The title is used as home title and in headers.
624 # * default: `MyWiki`
625 var wiki_name
: String is lazy
do return value_or_default
("wiki.name", "MyWiki")
629 # Displayed in header.
633 var wiki_desc
: String is lazy
do return value_or_default
("wiki.desc", "")
637 # Url of the image to be displayed in header.
641 var wiki_logo
: String is lazy
do return value_or_default
("wiki.logo", "")
643 # Markdown extension recognized by this wiki.
645 # We allow only one kind of extension per wiki.
646 # Files with other markdown extensions will be treated as resources.
648 # * key: `wiki.md_ext`
650 var md_ext
: String is lazy
do return value_or_default
("wiki.md_ext", "md")
652 # Root directory of the wiki.
654 # Directory where the wiki files are stored locally.
656 # * key: `wiki.root_dir`
658 var root_dir
: String is lazy
do return value_or_default
("wiki.root_dir", "./").simplify_path
662 # Directory where markdown source files are stored.
664 # * key: `wiki.source_dir
665 # * default: `pages/`
666 var source_dir
: String is lazy
do
667 return value_or_default
("wiki.source_dir", "pages/").simplify_path
672 # Directory where public wiki files are generated.
673 # **This path MUST be relative to `root_dir`.**
675 # * key: `wiki.out_dir`
677 var out_dir
: String is lazy
do return value_or_default
("wiki.out_dir", "out/").simplify_path
679 # Asset files directory.
681 # Directory where public assets like JS scripts or CSS files are stored.
682 # **This path MUST be relative to `root_dir`.**
684 # * key: `wiki.assets_dir`
685 # * default: `assets/`
686 var assets_dir
: String is lazy
do
687 return value_or_default
("wiki.assets_dir", "assets/").simplify_path
690 # Template files directory.
692 # Directory where template used in HTML generation are stored.
693 # **This path MUST be relative to `root_dir`.**
695 # * key: `wiki.templates_dir`
696 # * default: `templates/`
697 var templates_dir
: String is lazy
do
698 return value_or_default
("wiki.templates_dir", "templates/").simplify_path
701 # Main template file.
703 # The main template is used to specify the overall structure of a page.
705 # * key: `wiki.template`
706 # * default: `template.html`
707 var template_file
: String is lazy
do
708 return value_or_default
("wiki.template", "template.html")
711 # Main header template file.
713 # Used to specify the structure of the page header.
714 # This is generally the place where you want to put your logo and wiki title.
716 # * key: `wiki.header`
717 # * default: `header.html`
718 var header_file
: String is lazy
do
719 return value_or_default
("wiki.header", "header.html")
722 # Main menu template file.
724 # Used to specify the menu structure.
727 # * default: `menu.html`
728 var menu_file
: String is lazy
do
729 return value_or_default
("wiki.menu", "menu.html")
734 # The main footer is used to specify the structure of the page footer.
735 # This is generally the place where you want to put your copyright.
737 # * key: `wiki.footer`
738 # * default: `footer.html`
739 var footer_file
: String is lazy
do
740 return value_or_default
("wiki.footer", "footer.html")
743 # Automatically add a summary.
745 # * key: `wiki.auto_summary`
747 var auto_summary
: Bool is lazy
do
748 return value_or_default
("wiki.auto_summary", "true") == "true"
751 # Automatically add breadcrumbs.
753 # * key: `wiki.auto_breadcrumbs`
755 var auto_breadcrumbs
: Bool is lazy
do
756 return value_or_default
("wiki.auto_breadcrumbs", "true") == "true"
761 # Position of the sidebar between `left`, `right` and `none`. Any other value
762 # will be considered as `none`.
764 # * key: `wiki.sidebar`
766 var sidebar
: String is lazy
do
767 return value_or_default
("wiki.sidebar", "left")
770 # Sidebar markdown block to include.
772 # Blocks are specified by their filename without the extension.
774 # * key: `wiki.sidebar.blocks`
776 var sidebar_blocks
: Array[String] is lazy
do
777 var res
= new Array[String]
778 if not has_key
("wiki.sidebar.blocks") then return res
779 for val
in at
("wiki.sidebar.blocks").values
do
785 # Sidebar files directory.
787 # Directory where sidebar blocks are stored.
788 # **This path MUST be relative to `root_dir`.**
790 # * key: `wiki.sidebar_dir`
791 # * default: `sidebar/`
792 var sidebar_dir
: String is lazy
do
793 return value_or_default
("wiki.sidebar_dir", "sidebar/").simplify_path
796 # Directory used by rsync to upload wiki files.
798 # This information is used to update your distant wiki files (like the webserver).
800 # * key: `wiki.rsync_dir`
802 var rsync_dir
: String is lazy
do return value_or_default
("wiki.rsync_dir", "")
804 # Remote repository used to pull modifications on sources.
806 # * key: `wiki.git_origin`
807 # * default: `origin`
808 var git_origin
: String is lazy
do return value_or_default
("wiki.git_origin", "origin")
810 # Remote branch used to pull modifications on sources.
812 # * key: `wiki.git_branch`
813 # * default: `master`
814 var git_branch
: String is lazy
do return value_or_default
("wiki.git_branch", "master")
816 # URL to source versionning used to display last changes
818 # * key: `wiki.last_changes`
820 var last_changes
: String is lazy
do return value_or_default
("wiki.last_changes", "")
822 # URL to source edition.
826 var edit
: String is lazy
do return value_or_default
("wiki.edit", "")
829 # WikiSection custom configuration.
831 # Each section can provide its own config file to customize
832 # appearance or behavior.
836 # Returns the config value at `key` or `null` if no key was found.
837 private fun value_or_null
(key
: String): nullable String do
838 if not has_key
(key
) then return null
842 # Is this section hidden in sitemap and trees and menus?
843 fun is_hidden
: Bool do return value_or_null
("section.hidden") == "true"
845 # Custom section title if any.
846 fun title
: nullable String do return value_or_null
("section.title")
848 # Custom template file if any.
849 fun template_file
: nullable String do return value_or_null
("section.template")
851 # Custom header file if any.
852 fun header_file
: nullable String do return value_or_null
("section.header")
854 # Custom menu file if any.
855 fun menu_file
: nullable String do return value_or_null
("section.menu")
857 # Custom footer file if any.
858 fun footer_file
: nullable String do return value_or_null
("section.footer")