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
23 # A Nitiwiki instance.
25 # Nitiwiki provide all base services used by `WikiSection` and `WikiArticle`.
26 # It manages content and renders pages.
28 # Each nitiwiki instance is linked to a config file.
29 # This file show to `nitiwiki` that a wiki is present in the current directory.
30 # Without it, nitiwiki will consider the directory as empty.
34 var config
: WikiConfig
36 # Default config filename.
37 var config_filename
= "config.ini"
39 # Force render on all file even if the source is unmodified.
40 var force_render
= false is writable
43 var verbose_level
= 0 is writable
45 # Delete all the output files.
47 var out_dir
= expand_path
(config
.root_dir
, config
.out_dir
)
48 if out_dir
.file_exists
then out_dir
.rmdir
51 # Synchronize local output with the distant `WikiConfig::rsync_dir`.
53 var root
= expand_path
(config
.root_dir
, config
.out_dir
)
54 sys
.system
"rsync -vr --delete {root}/ {config.rsync_dir}"
58 sys
.system
"git pull {config.git_origin} {config.git_branch}"
61 # Analyze wiki files from `dir` to build wiki entries.
63 # This method build a hierarchical structure of `WikiSection` and `WikiArticle`
64 # based on the markdown source structure.
66 var dir
= expand_path
(config
.root_dir
, config
.source_dir
)
67 root_section
= new_section
(dir
)
68 var files
= list_md_files
(dir
)
77 print
"name: {config.wiki_name}"
78 print
"config: {config.ini_file}"
79 print
"url: {config.root_url}"
81 if root_section
.is_dirty
then
82 print
"There is modified files:"
83 var paths
= entries
.keys
.to_a
84 var s
= new DefaultComparator
87 var entry
= entries
[path
]
88 if not entry
.is_dirty
then continue
90 if entry
.has_source
then name
= entry
.src_path
.to_s
98 print
"Use nitiwiki --render to render modified files"
100 print
"Wiki is up-to-date"
102 print
"Use nitiwiki --fetch to pull modification from origin"
103 print
"Use nitiwiki --rsync to synchronize distant output"
107 # Display msg if `level >= verbose_level`
108 fun message
(msg
: String, level
: Int) do
109 if level
<= verbose_level
then print msg
112 # List markdown source files from a directory.
113 fun list_md_files
(dir
: String): Array[String] do
114 var files
= new Array[String]
115 var pipe
= new IProcess("find", dir
, "-name", "*.md")
116 while not pipe
.eof
do
117 var file
= pipe
.read_line
118 if file
== "" then break # last line
119 file
= file
.substring
(0, file
.length
- 1) # strip last oef
120 var name
= file
.basename
(".md")
121 if name
== "header" or name
== "footer" or name
== "menu" then continue
126 if pipe
.status
!= 0 then exit
1
127 var s
= new DefaultComparator
132 # Does `src` have been modified since `target` creation?
134 # Always returns `true` if `--force` is on.
135 fun need_render
(src
, target
: String): Bool do
136 if force_render
then return true
137 if not target
.file_exists
then return true
138 return src
.file_stat
.mtime
>= target
.file_stat
.mtime
141 # Create a new `WikiSection`.
143 # `path` is used to determine the place in the wiki hierarchy.
144 protected fun new_section
(path
: String): WikiSection do
145 path
= path
.simplify_path
146 if entries
.has_key
(path
) then return entries
[path
].as(WikiSection)
147 var root
= expand_path
(config
.root_dir
, config
.source_dir
)
148 var name
= path
.basename
("")
149 var section
= new WikiSection(self, name
)
150 entries
[path
] = section
151 if path
== root
then return section
152 var ppath
= path
.dirname
153 if ppath
!= path
then
154 var parent
= new_section
(ppath
)
155 parent
.add_child
(section
)
157 section
.try_load_config
161 # Create a new `WikiArticle`.
163 # `path` is used to determine the ancestor sections.
164 protected fun new_article
(path
: String): WikiArticle do
165 if entries
.has_key
(path
) then return entries
[path
].as(WikiArticle)
166 var article
= new WikiArticle.from_source
(self, path
)
167 var section
= new_section
(path
.dirname
)
168 section
.add_child
(article
)
169 entries
[path
] = article
173 # Wiki entries found in the last `lookup_hierarchy`.
174 var entries
= new HashMap[String, WikiEntry]
176 # The root `WikiSection` of the site found in the last `lookup_hierarchy`.
177 var root_section
: WikiSection is noinit
179 # Does a template named `name` exists for this wiki?
180 fun has_template
(name
: String): Bool do
181 return expand_path
(config
.root_dir
, config
.templates_dir
, name
).file_exists
184 # Load a template file as a `TemplateString`.
186 # REQUIRE: `has_template`
187 fun load_template
(name
: String): TemplateString do
188 assert has_template
(name
)
189 var file
= expand_path
(config
.root_dir
, config
.templates_dir
, name
)
190 var tpl
= new TemplateString.from_file
(file
)
191 if tpl
.has_macro
("ROOT_URL") then
192 tpl
.replace
("ROOT_URL", config
.root_url
)
194 if tpl
.has_macro
("TITLE") then
195 tpl
.replace
("TITLE", config
.wiki_name
)
197 if tpl
.has_macro
("SUBTITLE") then
198 tpl
.replace
("SUBTITLE", config
.wiki_desc
)
200 if tpl
.has_macro
("LOGO") then
201 tpl
.replace
("LOGO", config
.wiki_logo
)
206 # Join `parts` as a path and simplify it
207 fun expand_path
(parts
: String...): String do
210 path
= path
.join_path
(part
)
212 return path
.simplify_path
215 fun pretty_name
(name
: String): String do
216 name
= name
.replace
("_", " ")
217 name
= name
.capitalized
222 # A wiki is composed of hierarchical entries.
223 abstract class WikiEntry
225 # `Nitiwiki` this entry belongs to.
230 # Entry internal name.
232 # Mainly used in urls.
235 # Displayed title for `self`.
237 # If `self` is the root entry then display the wiki `WikiConfig::wiki_name` instead.
239 if is_root
then return wiki
.config
.wiki_name
240 return wiki
.pretty_name
(name
)
243 # Is this section rendered from a source document?
245 # Source is an abstract concept at this level.
246 # It can represent a directory, a source file,
247 # a part of a file, everything needed to
248 # extend this base framework.
249 fun has_source
: Bool do return src_path
!= null
251 # Entry creation time.
253 # Returns `-1` if not `has_source`.
254 fun create_time
: Int do
255 if not has_source
then return -1
256 return src_full_path
.file_stat
.ctime
259 # Entry last modification time.
261 # Returns `-1` if not `has_source`.
262 fun last_edit_time
: Int do
263 if not has_source
then return -1
264 return src_full_path
.file_stat
.mtime
267 # Entry list rendering time.
269 # Returns `-1` if `is_new`.
270 fun last_render_time
: Int do
271 if is_new
then return -1
272 return out_full_path
.file_stat
.mtime
277 # Type of the parent entry.
278 type PARENT: WikiEntry
280 # Parent entry if any.
281 var parent
: nullable PARENT = null
283 # Does `self` have a parent?
284 fun is_root
: Bool do return parent
== null
286 # Children labelled by `name`.
287 var children
= new HashMap[String, WikiEntry]
289 # Does `self` have a child nammed `name`?
290 fun has_child
(name
: String): Bool do return children
.keys
.has
(name
)
292 # Retrieve the child called `name`.
293 fun child
(name
: String): WikiEntry do return children
[name
]
295 # Add a sub-entry to `self`.
296 fun add_child
(entry
: WikiEntry) do
298 children
[entry
.name
] = entry
303 # Breadcrumbs from the `Nitiwiki::root_section` to `self`.
305 # Result is returned as an array containg ordered entries:
306 # `breadcrumbs.first` is the root entry and
307 # `breadcrumbs.last == self`
308 fun breadcrumbs
: Array[WikiEntry] is cached
do
309 var path
= new Array[WikiEntry]
310 var entry
: nullable WikiEntry = self
311 while entry
!= null and not entry
.is_root
do
318 # Relative path from `wiki.config.root_dir` to source if any.
319 fun src_path
: nullable String is abstract
321 # Absolute path to the source if any.
322 fun src_full_path
: nullable String do
324 if src
== null then return null
325 return wiki
.config
.root_dir
.join_path
(src
)
328 # Relative path from `wiki.config.root_dir` to rendered output.
330 # Like `src_path`, this method can represent a
331 # directory or a file.
332 fun out_path
: String is abstract
334 # Absolute path to the output.
335 fun out_full_path
: String do return wiki
.config
.root_dir
.join_path
(out_path
)
339 # Does `self` have already been rendered?
340 fun is_new
: Bool do return not out_full_path
.file_exists
342 # Does `self` rendered output is outdated?
344 # Returns `true` if `is_new` then check in children.
345 fun is_dirty
: Bool do
346 if is_new
then return true
348 if last_edit_time
>= last_render_time
then return true
350 for child
in children
.values
do
351 if child
.is_dirty
then return true
356 # Render `self` and `children` is needed.
357 fun render
do for child
in children
.values
do child
.render
361 # Template file for `self`.
363 # Each entity can use a custom template.
364 # By default the template is inherited from the parent.
366 # If the root does not have a custom template,
367 # then returns the main wiki template file.
368 fun template_file
: String do
369 if is_root
then return wiki
.config
.template_file
370 return parent
.template_file
373 # Header template file for `self`.
375 # Behave like `template_file`.
376 fun header_file
: String do
377 if is_root
then return wiki
.config
.header_file
378 return parent
.header_file
381 # Footer template file for `self`.
383 # Behave like `template_file`.
384 fun footer_file
: String do
385 if is_root
then return wiki
.config
.footer_file
386 return parent
.footer_file
389 # Menu template file for `self`.
391 # Behave like `template_file`.
392 fun menu_file
: String do
393 if is_root
then return wiki
.config
.menu_file
394 return parent
.menu_file
397 # Display the entry `name`.
398 redef fun to_s
do return name
401 # Each WikiSection is related to a source directory.
403 # A section can contain other sub-sections or pages.
407 # A section can only have another section as parent.
408 redef type PARENT: WikiSection
412 var title
= config
.title
413 if title
!= null then return title
418 # Is this section hidden?
420 # Hidden section are rendered but not linked in menus.
421 fun is_hidden
: Bool do
422 if has_config
then return config
.is_hidden
427 redef fun src_path
: String do
428 if parent
== null then
429 return wiki
.config
.source_dir
431 return wiki
.expand_path
(parent
.src_path
, name
)
437 # Custom configuration file for this section.
438 var config
: nullable SectionConfig = null
440 # Does this section have its own config file?
441 fun has_config
: Bool do return config
!= null
443 # Try to load the config file for this section.
444 private fun try_load_config
do
445 var cfile
= wiki
.expand_path
(wiki
.config
.root_dir
, src_path
, wiki
.config_filename
)
446 if not cfile
.file_exists
then return
447 wiki
.message
("Custom config for section {name}", 2)
448 config
= new SectionConfig(cfile
)
453 # Also check custom config.
454 redef fun template_file
do
456 var tpl
= config
.template_file
457 if tpl
!= null then return tpl
459 if is_root
then return wiki
.config
.template_file
460 return parent
.template_file
463 # Also check custom config.
464 redef fun header_file
do
466 var tpl
= config
.header_file
467 if tpl
!= null then return tpl
469 if is_root
then return wiki
.config
.header_file
470 return parent
.header_file
473 # Also check custom config.
474 redef fun footer_file
do
476 var tpl
= config
.footer_file
477 if tpl
!= null then return tpl
479 if is_root
then return wiki
.config
.footer_file
480 return parent
.footer_file
483 # Also check custom config.
484 redef fun menu_file
do
486 var tpl
= config
.menu_file
487 if tpl
!= null then return tpl
489 if is_root
then return wiki
.config
.menu_file
490 return parent
.menu_file
494 # Each WikiArticle is related to a HTML file.
496 # Article can be created from scratch using this API or
497 # automatically from a markdown source file (see: `from_source`).
501 # Articles can only have `WikiSection` as parents.
502 redef type PARENT: WikiSection
504 redef fun title
: String do
505 if name
== "index" and parent
!= null then return parent
.title
511 # What you want to be displayed in the page.
512 var content
: nullable Streamable = null
514 # Headlines ids and titles.
515 var headlines
= new ArrayMap[String, HeadLine]
517 # Create a new articleu sing a markdown source file.
518 init from_source
(wiki
: Nitiwiki, md_file
: String) do
519 src_full_path
= md_file
520 init(wiki
, md_file
.basename
(".md"))
521 var md_proc
= new MarkdownProcessor
522 content
= md_proc
.process
(md
)
523 headlines
= md_proc
.emitter
.decorator
.headlines
526 redef var src_full_path
: nullable String = null
528 redef fun src_path
do
529 if src_full_path
== null then return null
530 return src_full_path
.substring_from
(wiki
.config
.root_dir
.length
)
533 # The page markdown source content.
535 # Extract the markdown text from `source_file`.
537 # REQUIRE: `has_source`.
538 fun md
: String is cached
do
540 var file
= new IFStream.open
(src_full_path
.to_s
)
541 var md
= file
.read_all
546 # Returns true if has source and
547 # `last_edit_date` > 'last_render_date'.
548 redef fun is_dirty
do
549 if super then return true
551 return wiki
.need_render
(src_full_path
.to_s
, out_full_path
)
556 redef fun to_s
do return "{name} ({parent or else "null"})"
559 # Wiki configuration class.
561 # This class provides services that ensure static typing when accessing the `config.ini` file.
565 # Returns the config value at `key` or return `default` if no key was found.
566 private fun value_or_default
(key
: String, default
: String): String do
567 if not has_key
(key
) then return default
571 # Site name displayed.
573 # The title is used as home title and in headers.
576 # * default: `MyWiki`
577 fun wiki_name
: String is cached
do return value_or_default
("wiki.name", "MyWiki")
581 # Displayed in header.
585 fun wiki_desc
: String is cached
do return value_or_default
("wiki.desc", "")
589 # Url of the image to be displayed in header.
593 fun wiki_logo
: String is cached
do return value_or_default
("wiki.logo", "")
595 # Root url of the wiki.
597 # * key: `wiki.root_url`
598 # * default: `http://localhost/`
599 fun root_url
: String is cached
do return value_or_default
("wiki.root_url", "http://localhost/")
602 # Root directory of the wiki.
604 # Directory where the wiki files are stored locally.
606 # * key: `wiki.root_dir`
608 fun root_dir
: String is cached
do return value_or_default
("wiki.root_dir", "./").simplify_path
612 # Directory where markdown source files are stored.
614 # * key: `wiki.source_dir
615 # * default: `pages/`
616 fun source_dir
: String is cached
do
617 return value_or_default
("wiki.source_dir", "pages/").simplify_path
622 # Directory where public wiki files are generated.
623 # **This path MUST be relative to `root_dir`.**
625 # * key: `wiki.out_dir`
627 fun out_dir
: String is cached
do return value_or_default
("wiki.out_dir", "out/").simplify_path
629 # Asset files directory.
631 # Directory where public assets like JS scripts or CSS files are stored.
632 # **This path MUST be relative to `root_dir`.**
634 # * key: `wiki.assets_dir`
635 # * default: `assets/`
636 fun assets_dir
: String is cached
do
637 return value_or_default
("wiki.assets_dir", "assets/").simplify_path
640 # Template files directory.
642 # Directory where template used in HTML generation are stored.
643 # **This path MUST be relative to `root_dir`.**
645 # * key: `wiki.templates_dir`
646 # * default: `templates/`
647 fun templates_dir
: String is cached
do
648 return value_or_default
("wiki.templates_dir", "templates/").simplify_path
651 # Main template file.
653 # The main template is used to specify the overall structure of a page.
655 # * key: `wiki.template`
656 # * default: `template.html`
657 fun template_file
: String is cached
do
658 return value_or_default
("wiki.template", "template.html")
661 # Main header template file.
663 # Used to specify the structure of the page header.
664 # This is generally the place where you want to put your logo and wiki title.
666 # * key: `wiki.header`
667 # * default: `header.html`
668 fun header_file
: String is cached
do
669 return value_or_default
("wiki.header", "header.html")
672 # Main menu template file.
674 # Used to specify the menu structure.
677 # * default: `menu.html`
678 fun menu_file
: String is cached
do
679 return value_or_default
("wiki.menu", "menu.html")
684 # The main footer is used to specify the structure of the page footer.
685 # This is generally the place where you want to put your copyright.
687 # * key: `wiki.footer`
688 # * default: `footer.html`
689 fun footer_file
: String is cached
do
690 return value_or_default
("wiki.footer", "footer.html")
693 # Directory used by rsync to upload wiki files.
695 # This information is used to update your distant wiki files (like the webserver).
697 # * key: `wiki.rsync_dir`
699 fun rsync_dir
: String is cached
do return value_or_default
("wiki.rsync_dir", "")
701 # Remote repository used to pull modifications on sources.
703 # * key: `wiki.git_origin`
704 # * default: `origin`
705 fun git_origin
: String is cached
do return value_or_default
("wiki.git_origin", "origin")
707 # Remote branch used to pull modifications on sources.
709 # * key: `wiki.git_branch`
710 # * default: `master`
711 fun git_branch
: String is cached
do return value_or_default
("wiki.git_branch", "master")
714 # WikiSection custom configuration.
716 # Each section can provide its own config file to customize
717 # appearance or behavior.
721 # Returns the config value at `key` or `null` if no key was found.
722 private fun value_or_null
(key
: String): nullable String do
723 if not has_key
(key
) then return null
727 # Is this section hidden in sitemap and trees and menus?
728 fun is_hidden
: Bool do return value_or_null
("section.hidden") == "true"
730 # Custom section title if any.
731 fun title
: nullable String do return value_or_null
("section.title")
733 # Custom template file if any.
734 fun template_file
: nullable String do return value_or_null
("section.template")
736 # Custom header file if any.
737 fun header_file
: nullable String do return value_or_null
("section.header")
739 # Custom menu file if any.
740 fun menu_file
: nullable String do return value_or_null
("section.menu")
742 # Custom footer file if any.
743 fun footer_file
: nullable String do return value_or_null
("section.footer")