File: TextToHtml.pm

package info (click to toggle)
noss 1.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 704 kB
  • sloc: perl: 6,571; sh: 569; xml: 294; makefile: 2
file content (463 lines) | stat: -rw-r--r-- 13,427 bytes parent folder | download
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
package WWW::Noss::TextToHtml;
use 5.016;
use strict;
use warnings;
our $VERSION = '1.10';

use Exporter 'import';
our @EXPORT_OK = qw(text2html escape_html unescape_html strip_tags);

use constant {
    STRIP_TEXT    => 0,
    STRIP_TAG     => 1,
    STRIP_COMMENT => 2,
    STRIP_CDATA   => 3,
};

# Copypasted from HTML::Parser's HTML::Entities
my %ENTITY2CHAR = (
    # Some normal chars that have special meaning in SGML context
    amp    => '&',  # ampersand
    'gt'    => '>',  # greater than
    'lt'    => '<',  # less than
    quot   => '"',  # double quote
    apos   => "'",  # single quote
    # PUBLIC ISO 8879-1986//ENTITIES Added Latin 1//EN//HTML
    AElig  => chr(198),  # capital AE diphthong (ligature)
    Aacute => chr(193),  # capital A, acute accent
    Acirc  => chr(194),  # capital A, circumflex accent
    Agrave => chr(192),  # capital A, grave accent
    Aring  => chr(197),  # capital A, ring
    Atilde => chr(195),  # capital A, tilde
    Auml   => chr(196),  # capital A, dieresis or umlaut mark
    Ccedil => chr(199),  # capital C, cedilla
    ETH    => chr(208),  # capital Eth, Icelandic
    Eacute => chr(201),  # capital E, acute accent
    Ecirc  => chr(202),  # capital E, circumflex accent
    Egrave => chr(200),  # capital E, grave accent
    Euml   => chr(203),  # capital E, dieresis or umlaut mark
    Iacute => chr(205),  # capital I, acute accent
    Icirc  => chr(206),  # capital I, circumflex accent
    Igrave => chr(204),  # capital I, grave accent
    Iuml   => chr(207),  # capital I, dieresis or umlaut mark
    Ntilde => chr(209),  # capital N, tilde
    Oacute => chr(211),  # capital O, acute accent
    Ocirc  => chr(212),  # capital O, circumflex accent
    Ograve => chr(210),  # capital O, grave accent
    Oslash => chr(216),  # capital O, slash
    Otilde => chr(213),  # capital O, tilde
    Ouml   => chr(214),  # capital O, dieresis or umlaut mark
    THORN  => chr(222),  # capital THORN, Icelandic
    Uacute => chr(218),  # capital U, acute accent
    Ucirc  => chr(219),  # capital U, circumflex accent
    Ugrave => chr(217),  # capital U, grave accent
    Uuml   => chr(220),  # capital U, dieresis or umlaut mark
    Yacute => chr(221),  # capital Y, acute accent
    aacute => chr(225),  # small a, acute accent
    acirc  => chr(226),  # small a, circumflex accent
    aelig  => chr(230),  # small ae diphthong (ligature)
    agrave => chr(224),  # small a, grave accent
    aring  => chr(229),  # small a, ring
    atilde => chr(227),  # small a, tilde
    auml   => chr(228),  # small a, dieresis or umlaut mark
    ccedil => chr(231),  # small c, cedilla
    eacute => chr(233),  # small e, acute accent
    ecirc  => chr(234),  # small e, circumflex accent
    egrave => chr(232),  # small e, grave accent
    eth    => chr(240),  # small eth, Icelandic
    euml   => chr(235),  # small e, dieresis or umlaut mark
    iacute => chr(237),  # small i, acute accent
    icirc  => chr(238),  # small i, circumflex accent
    igrave => chr(236),  # small i, grave accent
    iuml   => chr(239),  # small i, dieresis or umlaut mark
    ntilde => chr(241),  # small n, tilde
    oacute => chr(243),  # small o, acute accent
    ocirc  => chr(244),  # small o, circumflex accent
    ograve => chr(242),  # small o, grave accent
    oslash => chr(248),  # small o, slash
    otilde => chr(245),  # small o, tilde
    ouml   => chr(246),  # small o, dieresis or umlaut mark
    szlig  => chr(223),  # small sharp s, German (sz ligature)
    thorn  => chr(254),  # small thorn, Icelandic
    uacute => chr(250),  # small u, acute accent
    ucirc  => chr(251),  # small u, circumflex accent
    ugrave => chr(249),  # small u, grave accent
    uuml   => chr(252),  # small u, dieresis or umlaut mark
    yacute => chr(253),  # small y, acute accent
    yuml   => chr(255),  # small y, dieresis or umlaut mark
    # Some extra Latin 1 chars that are listed in the HTML3.2 draft (21-May-96)
    copy   => chr(169),  # copyright sign
    reg    => chr(174),  # registered sign
    nbsp   => chr(160),  # non breaking space
    # Additional ISO-8859/1 entities listed in rfc1866 (section 14)
    iexcl  => chr(161),
    cent   => chr(162),
    pound  => chr(163),
    curren => chr(164),
    yen    => chr(165),
    brvbar => chr(166),
    sect   => chr(167),
    uml    => chr(168),
    ordf   => chr(170),
    laquo  => chr(171),
    'not'   => chr(172),    # not is a keyword in perl
    shy    => chr(173),
    macr   => chr(175),
    deg    => chr(176),
    plusmn => chr(177),
    sup1   => chr(185),
    sup2   => chr(178),
    sup3   => chr(179),
    acute  => chr(180),
    micro  => chr(181),
    para   => chr(182),
    middot => chr(183),
    cedil  => chr(184),
    ordm   => chr(186),
    raquo  => chr(187),
    frac14 => chr(188),
    frac12 => chr(189),
    frac34 => chr(190),
    iquest => chr(191),
    'times' => chr(215),    # times is a keyword in perl
    divide => chr(247),
    'OElig'    => chr(338),
    'oelig'    => chr(339),
    'Scaron'   => chr(352),
    'scaron'   => chr(353),
    'Yuml'     => chr(376),
    'fnof'     => chr(402),
    'circ'     => chr(710),
    'tilde'    => chr(732),
    'Alpha'    => chr(913),
    'Beta'     => chr(914),
    'Gamma'    => chr(915),
    'Delta'    => chr(916),
    'Epsilon'  => chr(917),
    'Zeta'     => chr(918),
    'Eta'      => chr(919),
    'Theta'    => chr(920),
    'Iota'     => chr(921),
    'Kappa'    => chr(922),
    'Lambda'   => chr(923),
    'Mu'       => chr(924),
    'Nu'       => chr(925),
    'Xi'       => chr(926),
    'Omicron'  => chr(927),
    'Pi'       => chr(928),
    'Rho'      => chr(929),
    'Sigma'    => chr(931),
    'Tau'      => chr(932),
    'Upsilon'  => chr(933),
    'Phi'      => chr(934),
    'Chi'      => chr(935),
    'Psi'      => chr(936),
    'Omega'    => chr(937),
    'alpha'    => chr(945),
    'beta'     => chr(946),
    'gamma'    => chr(947),
    'delta'    => chr(948),
    'epsilon'  => chr(949),
    'zeta'     => chr(950),
    'eta'      => chr(951),
    'theta'    => chr(952),
    'iota'     => chr(953),
    'kappa'    => chr(954),
    'lambda'   => chr(955),
    'mu'       => chr(956),
    'nu'       => chr(957),
    'xi'       => chr(958),
    'omicron'  => chr(959),
    'pi'       => chr(960),
    'rho'      => chr(961),
    'sigmaf'   => chr(962),
    'sigma'    => chr(963),
    'tau'      => chr(964),
    'upsilon'  => chr(965),
    'phi'      => chr(966),
    'chi'      => chr(967),
    'psi'      => chr(968),
    'omega'    => chr(969),
    'thetasym' => chr(977),
    'upsih'    => chr(978),
    'piv'      => chr(982),
    'ensp'     => chr(8194),
    'emsp'     => chr(8195),
    'thinsp'   => chr(8201),
    'zwnj'     => chr(8204),
    'zwj'      => chr(8205),
    'lrm'      => chr(8206),
    'rlm'      => chr(8207),
    'ndash'    => chr(8211),
    'mdash'    => chr(8212),
    'lsquo'    => chr(8216),
    'rsquo'    => chr(8217),
    'sbquo'    => chr(8218),
    'ldquo'    => chr(8220),
    'rdquo'    => chr(8221),
    'bdquo'    => chr(8222),
    'dagger'   => chr(8224),
    'Dagger'   => chr(8225),
    'bull'     => chr(8226),
    'hellip'   => chr(8230),
    'permil'   => chr(8240),
    'prime'    => chr(8242),
    'Prime'    => chr(8243),
    'lsaquo'   => chr(8249),
    'rsaquo'   => chr(8250),
    'oline'    => chr(8254),
    'frasl'    => chr(8260),
    'euro'     => chr(8364),
    'image'    => chr(8465),
    'weierp'   => chr(8472),
    'real'     => chr(8476),
    'trade'    => chr(8482),
    'alefsym'  => chr(8501),
    'larr'     => chr(8592),
    'uarr'     => chr(8593),
    'rarr'     => chr(8594),
    'darr'     => chr(8595),
    'harr'     => chr(8596),
    'crarr'    => chr(8629),
    'lArr'     => chr(8656),
    'uArr'     => chr(8657),
    'rArr'     => chr(8658),
    'dArr'     => chr(8659),
    'hArr'     => chr(8660),
    'forall'   => chr(8704),
    'part'     => chr(8706),
    'exist'    => chr(8707),
    'empty'    => chr(8709),
    'nabla'    => chr(8711),
    'isin'     => chr(8712),
    'notin'    => chr(8713),
    'ni'       => chr(8715),
    'prod'     => chr(8719),
    'sum'      => chr(8721),
    'minus'    => chr(8722),
    'lowast'   => chr(8727),
    'radic'    => chr(8730),
    'prop'     => chr(8733),
    'infin'    => chr(8734),
    'ang'      => chr(8736),
    'and'      => chr(8743),
    'or'       => chr(8744),
    'cap'      => chr(8745),
    'cup'      => chr(8746),
    'int'      => chr(8747),
    'there4'   => chr(8756),
    'sim'      => chr(8764),
    'cong'     => chr(8773),
    'asymp'    => chr(8776),
    'ne'       => chr(8800),
    'equiv'    => chr(8801),
    'le'       => chr(8804),
    'ge'       => chr(8805),
    'sub'      => chr(8834),
    'sup'      => chr(8835),
    'nsub'     => chr(8836),
    'sube'     => chr(8838),
    'supe'     => chr(8839),
    'oplus'    => chr(8853),
    'otimes'   => chr(8855),
    'perp'     => chr(8869),
    'sdot'     => chr(8901),
    'lceil'    => chr(8968),
    'rceil'    => chr(8969),
    'lfloor'   => chr(8970),
    'rfloor'   => chr(8971),
    'lang'     => chr(9001),
    'rang'     => chr(9002),
    'loz'      => chr(9674),
    'spades'   => chr(9824),
    'clubs'    => chr(9827),
    'hearts'   => chr(9829),
    'diams'    => chr(9830),
);

sub escape_html {

    my $text = shift;

    $text =~ s/&/&amp;/g;
    $text =~ s/</&lt;/g;
    $text =~ s/>/&gt;/g;

    return $text;

}

sub unescape_html {

    my $text = shift;

    $text =~ s{&(\S+?);}{
        my $e = $1;
        if ($e =~ /^#x([[:xdigit:]]+)$/) {
            chr hex $1;
        } elsif ($e =~ /^#(\d+)$/) {
            chr $1;
        } elsif (exists $ENTITY2CHAR{ $1 }) {
            $ENTITY2CHAR{ $1 };
        } else {
            '&' . $1 . ';';
        }
    }ge;

    return $text;

}

sub text2html {

    my $text = shift;

    $text = escape_html($text);

    my @paras = split /(\s*\n){2,}/, $text;

    my $html = join '',
        map { "<p>" . $_ . "</p>\n" }
        grep { /\S/ }
        @paras;

    return $html;

}

sub strip_tags {

    my $text = shift;

    no warnings 'substr';

    my $out = '';

    my $state = STRIP_TEXT;
    my $prev;
    my $start = 0;

    for (my $i = 0; $i < length($text); $i++) {
        my $c = substr $text, $i, 1;
        if ($state == STRIP_TEXT) {
            next if $c ne '<';
            if (substr($text, $i, 4) eq '<!--') {
                $prev = STRIP_TEXT;
                $state = STRIP_COMMENT;
                $out .= substr $text, $start, $i - $start;
                $i += 3;
            } elsif (substr($text, $i, 9) eq '<![CDATA[') {
                $state = STRIP_CDATA;
                $out .= substr $text, $start, $i - $start;
                $i += 7;
            } else {
                $state = STRIP_TAG;
                $out .= substr $text, $start, $i - $start;
            }
        } elsif ($state == STRIP_TAG) {
            if ($c eq '<') {
                if (substr($text, $i, 4) eq '<!--') {
                    $prev = STRIP_TAG;
                    $state = STRIP_COMMENT;
                    $i += 3;
                }
            } elsif ($c eq '>') {
                $start = $i + 1;
                $state = STRIP_TEXT;
            }
        } elsif ($state == STRIP_COMMENT) {
            if (substr($text, $i, 3) eq '-->') {
                $state = $prev;
                if ($state == STRIP_TEXT) {
                    $start = $i + 3;
                }
                $i += 2;
            }
        } elsif ($state == STRIP_CDATA) {
            if (substr($text, $i, 3) eq ']]>') {
                $state = STRIP_TEXT;
                $start = $i + 3;
                $i += 2;
            }
        }
    }

    if ($state == STRIP_TEXT and $start < length $text) {
        $out .= substr $text, $start;
    # Invalid HTML
    } elsif ($state != STRIP_COMMENT and $state != STRIP_TEXT) {
        return $text;
    }

    return $out;

}

1;

=head1 NAME

WWW::Noss::TextToHtml - Convert text to HTML

=head1 USAGE

  use WWW::Noss::TextToHtml(text2html);

  my $html = text2html($text);

=head1 DESCRIPTION

B<WWW::Noss::TextToHtml> is a module that provides subroutines for converting
plain text to HTML. This is a private module, please consult the L<noss>
manual for user documentation.

=head1 SUBROUTINES

Subroutines are not exported automatically.

=over 4

=item $html = text2html($text)

Converts the given string C<$text> to HTML.

=item $escaped = escape_html($text)

Escapes the given text by converting special HTML characters (C<E<lt>>,
C<E<gt>>, and C<&>) into their entity equivalents.

=item $unescaped = unescape_html($text)

Unescapes the given text by converting HTML entities to their string
equivalents.

=item $stripped = strip_tags($text)

Strips HTML tags from the given text.

=back

=head1 AUTHOR

Written by Samuel Young, E<lt>samyoung12788@gmail.comE<gt>.

This project's source can be found on its
L<Codeberg page|https://codeberg.org/1-1sam/noss.git>. Comments and pull
requests are welcome!

=head1 COPYRIGHT

Copyright (C) 2025 Samuel Young

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

=head1 SEE ALSO

L<noss>

=cut

# vim: expandtab shiftwidth=4