summaryrefslogtreecommitdiffstats
path: root/lib/utils/page.js
blob: e526afb394544bbf1b4de45ea9f0a0c9da809dd8 (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
var Q = require('q');
var _ = require('lodash');
var path = require('path');
var cheerio = require('cheerio');

var links = require('./links');
var imgUtils = require('./images');
var fs = require('./fs');

function replaceText($, el, search, replace, text_only ) {
    return $(el).each(function(){
        var node = this.firstChild,
            val,
            new_val,

            // Elements to be removed at the end.
            remove = [];

        // Only continue if firstChild exists.
        if ( node ) {

            // Loop over all childNodes.
            do {
                // Only process text nodes.
                if ( node.nodeType === 3 ) {

                    // The original node value.
                    val = node.nodeValue;

                    // The new value.
                    new_val = val.replace( search, replace );

                    // Only replace text if the new value is actually different!
                    if ( new_val !== val ) {

                        if ( !text_only && /</.test( new_val ) ) {
                            // The new value contains HTML, set it in a slower but far more
                            // robust way.
                            $(node).before( new_val );

                            // Don't remove the node yet, or the loop will lose its place.
                            remove.push( node );
                        } else {
                            // The new value contains no HTML, so it can be set in this
                            // very fast, simple way.
                            node.nodeValue = new_val;
                        }
                    }
                }

            } while ( node = node.nextSibling );
        }

        // Time to remove those elements!
        remove.length && $(remove).remove();
    });
};

function pregQuote( str ) {
    return (str+'').replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, "\\$1");
};


// Adapt an html snippet to be relative to a base folder
function normalizeHtml(src, options) {
	var $ = cheerio.load(src);
    var toConvert = [];

	$("img").each(function() {
        var src = $(this).attr("src");

        // Transform as absolute
        if (links.isRelative(src)) {
        	src = links.toAbsolute(src, options.base, options.output);
        }

        // Convert if needed
        if (options.convertImages) {
            var ext = path.extname(src);
            if (_.contains(imgUtils.INVALID, ext)) {
                // Replace extension
                var dest = path.join(path.dirname(src), path.basename(src, ext)+".png");

                // Absolute with input
                dest = path.resolve(options.book.root, dest);

                // Get a name that doesn't exists
                dest = fs.getUniqueFilename(dest);

                // Reset as relative to book
                dest = path.relative(options.book.root, dest);

                options.book.log.debug.ln("detect invalid image (will be converted to png):", src);
                toConvert.push({
                    source: src,
                    dest: dest
                });
                src = dest;
            }
        }

        $(this).attr("src", src);
    });

    $("a").each(function() {
        var href = $(this).attr("href");

        if (links.isRelative(href)) {
        	var absolutePath = path.join(options.base, href);

        	// If is in navigation relative: change extsnio nto be .html
        	if (options.navigation[absolutePath]) href = links.changeExtension(href, ".html");

        	// Transform as absolute
        	href = links.toAbsolute(href, options.base, options.output);
        } else {
        	$(this).attr("target", "_blank");
        }

        // Transform extension
        $(this).attr("href", href);
    });

    // Replace glossayr terms
    _.each(options.glossary, function(term) {
        var r =  new RegExp( "\\b(" + pregQuote(term.name.toLowerCase()) + ")\\b" , 'gi' );
        var includedInFiles = false;

        $("*").each(function() {
            replaceText($, this, r, function(match) {
                if (!includedInFiles) {
                    includedInFiles = true;
                    term.files = term.files || [];
                    term.files.push(options.navigation[options.input]);
                }
                return "<a href='"+links.toAbsolute("GLOSSARY.html", options.base, options.output)+"#"+term.id+"' class='glossary-term' title='"+term.description+"'>"+match+"</span>";
            });
        });
    });

	return {
        html: $.html(),
        images: toConvert
    };
};

// Convert svg images to png
function convertImages(images, options) {
    return _.reduce(images, function(prev, image) {
        return prev.then(function() {
            var imgin = path.resolve(options.book.root, image.source);
            var imgout = path.resolve(options.book.options.output, image.dest);

            options.book.log.debug("convert image", image.source, "to", image.dest, "...");
            return imgUtils.convert(imgin, imgout)
            .then(function() {
                options.book.log.debug.ok();
            }, function() {
                options.book.log.debug.fail();
            });
        });
    }, Q());
};


// Adapt page content to be relative to a base folder
function normalizePage(sections, options) {
	options = _.defaults(options || {}, {
        // Current book
        book: null,

        // Do we need to convert svg?
        convertImages: false,

        // Current file path
        input: ".",

		// Navigation to use to transform path
		navigation: {},

		// Directory parent of the file currently in rendering process
		base: "./",

		// Directory parent from the html output
		output: "./",

        // Glossary terms
        glossary: []
	});

    // List of images to convert
    var toConvert = [];

	sections = _.map(sections, function(section) {
		if (section.type != "normal") return section;

        var out = normalizeHtml(section.content, options);;

        toConvert = toConvert.concat(out.images);
		section.content = out.html;
		return section;
	});

    return Q()
    .then(function() {
        return convertImages(toConvert, options);
    })
    .thenResolve(sections);
};

// Extract text from sections
function extractText(sections) {
    return _.reduce(sections, function(prev, section) {
        if (section.type != "normal") return prev;

        var $ = cheerio.load(section.content);
        $("*").each(function() {
            prev = prev+" "+$(this).text();
        });

        return prev;
    }, "");
};

module.exports = {
	normalize: normalizePage,
    extractText: extractText
};