summaryrefslogtreecommitdiffstats
path: root/packages/gitbook/lib/templating/conrefsLoader.js
diff options
context:
space:
mode:
Diffstat (limited to 'packages/gitbook/lib/templating/conrefsLoader.js')
-rw-r--r--packages/gitbook/lib/templating/conrefsLoader.js93
1 files changed, 93 insertions, 0 deletions
diff --git a/packages/gitbook/lib/templating/conrefsLoader.js b/packages/gitbook/lib/templating/conrefsLoader.js
new file mode 100644
index 0000000..b3cdb3f
--- /dev/null
+++ b/packages/gitbook/lib/templating/conrefsLoader.js
@@ -0,0 +1,93 @@
+var path = require('path');
+var nunjucks = require('nunjucks');
+
+var fs = require('../utils/fs');
+var Git = require('../utils/git');
+var LocationUtils = require('../utils/location');
+var PathUtils = require('../utils/path');
+
+
+/**
+ * Template loader resolving both:
+ * - relative url ("./test.md")
+ * - absolute url ("/test.md")
+ * - git url ("")
+ *
+ * @param {String} rootFolder
+ * @param {Function(filePath, source)} transformFn (optional)
+ * @param {Logger} logger (optional)
+ */
+var ConrefsLoader = nunjucks.Loader.extend({
+ async: true,
+
+ init: function(rootFolder, transformFn, logger) {
+ this.rootFolder = rootFolder;
+ this.transformFn = transformFn;
+ this.logger = logger;
+ this.git = new Git();
+ },
+
+ getSource: function(sourceURL, callback) {
+ var that = this;
+
+ this.git.resolve(sourceURL)
+ .then(function(filepath) {
+ // Is local file
+ if (!filepath) {
+ filepath = path.resolve(sourceURL);
+ } else {
+ if (that.logger) that.logger.debug.ln('resolve from git', sourceURL, 'to', filepath);
+ }
+
+ // Read file from absolute path
+ return fs.readFile(filepath)
+ .then(function(source) {
+ source = source.toString('utf8');
+
+ if (that.transformFn) {
+ return that.transformFn(filepath, source);
+ }
+
+ return source;
+ })
+ .then(function(source) {
+ return {
+ src: source,
+ path: filepath
+ };
+ });
+ })
+ .nodeify(callback);
+ },
+
+ resolve: function(from, to) {
+ // If origin is in the book, we enforce result file to be in the book
+ if (PathUtils.isInRoot(this.rootFolder, from)) {
+
+ // Path of current template in the rootFolder (not absolute to fs)
+ var fromRelative = path.relative(this.rootFolder, from);
+
+ // Resolve "to" to a filepath relative to rootFolder
+ var href = LocationUtils.toAbsolute(to, path.dirname(fromRelative), '');
+
+ // Return absolute path
+ return PathUtils.resolveInRoot(this.rootFolder, href);
+ }
+
+ // If origin is in a git repository, we resolve file in the git repository
+ var gitRoot = this.git.resolveRoot(from);
+ if (gitRoot) {
+ return PathUtils.resolveInRoot(gitRoot, to);
+ }
+
+ // If origin is not in the book (include from a git content ref)
+ return path.resolve(path.dirname(from), to);
+ },
+
+ // Handle all files as relative, so that nunjucks pass responsability to 'resolve'
+ isRelative: function(filename) {
+ return LocationUtils.isRelative(filename);
+ }
+});
+
+module.exports = ConrefsLoader;