summaryrefslogtreecommitdiff
path: root/lib/html.source.sh
blob: d99220b9b70fe3accd412241bfebc68e2a4917fb (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
# Convert special characters to their HTML codes
html::encode () {
    $SED '
        s|\&|\&|g;
        s|<|\&lt;|g;
        s|>|\&gt;|g;
    ' <<< "$@"
}

# Make a HTML paragraph.
html::make_paragraph () {
    local -r text="$1"; shift

    if [[ -n "$text" ]]; then
        echo "<p>$(html::encode "$text")</p>"
    fi
}

# Make a HTML header.
html::make_heading () {
    local -r text=$($SED -E 's/^#+ //' <<< "$1"); shift
    local -r level="$1"; shift
    echo "<h${level}>$(html::encode "$text")</h${level}>"
}

# Make a HTML quotation
html::make_quote () {
    local -r quote="${1/> }"
    echo "<p class=\"quote\"><i>$(html::encode "$quote")</i></p>"
}

# Make a HTML image
html::make_img () {
    local link="$1"; shift
    local descr="$1"; shift

    if [ -z "$descr" ]; then
        echo -n "<a href=\"$link\"><img src=\"$link\" /></a>"
    else
        echo -n "<a href=\"$link\"><img alt=\"$descr\" title=\"$descr\" src=\"$link\" /></a>"
    fi

    echo "<br />"
}

# Make a HTML hyperlink
html::make_link () {
    local link="$1"; shift
    local descr="$1"; shift

    if ! $GREP -F -q '://' <<< "$link"; then
        link=${link/.gmi/.html}
    fi

    if [[ -z "$descr" ]]; then
        descr="$link"
    fi

    echo "<a class=\"textlink\" href=\"$link\">$descr</a><br />"
}

# Make inline code!
html::process_inline_code () {
    $SED -E 's|`([^`]+)`|<span class="inlinecode">\1</span>|g'
}

html::process_inline () {
    # As of now we only inlinde "code blocks", but we can chain more here later!
    html::process_inline_code
}

html::add_extras () {
    local -r html_base_dir="$CONTENT_BASE_DIR/html"
    cp "$HTML_CSS_STYLE" "$html_base_dir/style.css"

    while read -r section_dir; do
        local override_source="./extras/html/style-$(basename "$section_dir")-override.css"
        local override_dest="$section_dir/style-override.css"
        if [ ! -f "$override_source" ]; then
            touch "$override_dest" # Empty override
        else
            cp "$override_source" "$override_dest"
        fi
    done < <(find "$html_base_dir" -mindepth 1 -maxdepth 1 -type d | $GREP -E -v '(\.git)')
    cp "$HTML_WEBFONT_TEXT" "$html_base_dir/text.ttf"
    cp "$HTML_WEBFONT_CODE" "$html_base_dir/code.ttf"
    cp "$HTML_WEBFONT_HANDNOTES" "$html_base_dir/handnotes.ttf"
    cp "$HTML_WEBFONT_TYPEWRITER" "$html_base_dir/typewriter.ttf"
}

# Convert Gemtext to HTML
html::fromgmi () {
    local is_list=no
    local is_plain=no

    while IFS='' read -r line; do
        if [[ "$is_list" == yes ]]; then
            if [[ "$line" == '* '* ]]; then
                echo "<li>$(html::encode "${line/\* /}")</li>" |
                    html::process_inline
            else
                is_list=no
                echo "</ul>"
            fi
            continue

        elif [[ "$is_plain" == yes ]]; then
            if [[ "$line" == '```'* ]]; then
                echo "</pre>"
                is_plain=no
            else
                html::encode "$line"
            fi
            continue
        fi

        case "$line" in
            '* '*)
                is_list=yes
                echo "<ul>"
                echo "<li>$(html::encode "${line/\* /}")</li>" |
                    html::process_inline
                ;;
            '```'*)
                is_plain=yes
                echo '<pre>'
                ;;
            '# '*)
                html::make_heading "$line" 1 | html::process_inline
                ;;
            '## '*)
                html::make_heading "$line" 2 | html::process_inline
                ;;
            '### '*)
                html::make_heading "$line" 3 | html::process_inline
                ;;
            '> '*)
                html::make_quote "$line" | html::process_inline
                ;;
            '=> '*)
                generate::make_link html "$line" | html::process_inline
                ;;
            *)
                if [[ "$is_plain" == no ]]; then
                    html::make_paragraph "$line" | html::process_inline
                else
                    html::make_paragraph "$line"
                fi
                ;;
        esac
    done
}

# Test HTML package.
html::test () {
    local line='Hello world! This is a paragraph.'
    assert::equals "$(html::make_paragraph "$line")" '<p>Hello world! This is a paragraph.</p>'

    line=''
    assert::equals "$(html::make_paragraph "$line")" ''

    line='Foo &<>& Bar!'
    assert::equals "$(html::make_paragraph "$line")" '<p>Foo &amp;&lt;&gt;&amp; Bar!</p>'

    line='echo foo 2>&1'
    assert::equals "$(html::make_paragraph "$line")" '<p>echo foo 2&gt;&amp;1</p>'

    line='# Header 1'
    assert::equals "$(html::make_heading "$line" 1)" '<h1>Header 1</h1>'

    line='## Header 2'
    assert::equals "$(html::make_heading "$line" 2)" '<h2>Header 2</h2>'

    line='### Header 3'
    assert::equals "$(html::make_heading "$line" 3)" '<h3>Header 3</h3>'

    line='> This is a quote'
    assert::equals "$(html::make_quote "$line")" '<p class="quote"><i>This is a quote</i></p>'

    line='Testing: `hello_world.sh --debug` :-) `another one`!'
    assert::equals "$(echo "$line" | html::process_inline_code)" \
        'Testing: <span class="inlinecode">hello_world.sh --debug</span> :-) <span class="inlinecode">another one</span>!'

    line='=> https://example.org'
    assert::equals "$(generate::make_link html "$line")" \
        '<a class="textlink" href="https://example.org">https://example.org</a><br />'

    line='=> index.html'
    assert::equals "$(generate::make_link html "$line")" \
        '<a class="textlink" href="index.html">index.html</a><br />'

    line='=> http://example.org Description of the link'
    assert::equals "$(generate::make_link html "$line")" \
        '<a class="textlink" href="http://example.org">Description of the link</a><br />'

    line='=> http://example.org/image.png'
    assert::equals "$(generate::make_link html "$line")" \
        '<a href="http://example.org/image.png"><img src="http://example.org/image.png" /></a><br />'

    line='=> http://example.org/image.png Image description'
    assert::equals "$(generate::make_link html "$line")" \
        '<a href="http://example.org/image.png"><img alt="Image description" title="Image description" src="http://example.org/image.png" /></a><br />'
}