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
|
# Copyright 2008, 2009, 2010, 2012, 2013, 2015 Kevin Ryde
# HTML-FormatExternal 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, or (at your option) any
# later version.
#
# HTML-FormatExternal is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with HTML-FormatExternal. If not, see <http://www.gnu.org/licenses/>.
# elinks.conf(5) describes the various config options
#
# Maybe:
# --dump-charset UTF-8 ??
#
package HTML::FormatText::Elinks;
use 5.006;
use strict;
use warnings;
use URI::file;
use HTML::FormatExternal;
our @ISA = ('HTML::FormatExternal');
our $VERSION = 26;
use constant DEFAULT_LEFTMARGIN => 3;
use constant DEFAULT_RIGHTMARGIN => 77;
sub program_full_version {
my ($self_or_class) = @_;
return $self_or_class->_run_version (['elinks', '-version']);
}
sub program_version {
my ($self_or_class) = @_;
my $version = $self_or_class->program_full_version;
if (! defined $version) { return undef; }
# eg. "ELinks 0.12pre2\n
# Built on Oct 2 2008 18:34:16"
#
$version =~ /^ELinks (.*)/i
or $version =~ /^(.*)/; # whole first line if format not recognised
return $1 . substr($version,0,0); # retain taintedness
}
sub _make_run {
my ($class, $input_filename, $options) = @_;
my @command = ('elinks', '-dump', '-force-html');
# if ($options->{'ansi_colour'}) {
# push @command, '-eval', 'set document.dump.color_mode=1';
# }
if (defined $options->{'_width'}) {
push @command,
'-dump-width', $options->{'_width'},
'-eval', 'set document.browse.margin_width=0';
}
if (my $input_charset = $options->{'input_charset'}) {
$input_charset = _elinks_mung_charset ($input_charset);
push @command,
'-eval', ('set document.codepage.assume='
. _quote_config_stringarg($input_charset)),
'-eval', 'set document.codepage.force_assumed=1';
}
if (my $output_charset = $options->{'output_charset'}) {
push @command, '-dump-charset', _elinks_mung_charset ($output_charset);
}
# 'elinks_options' not documented ...
push @command, @{$options->{'elinks_options'} || []};
# elinks takes any "-foo" to be an option (except a bare "-") and
# there's no apparent "--" to end options (in its version 0.12pre5).
# Filenames starting "http:" are rejected.
# Turn into file:// using URI::file to ensure literal filename.
#
push @command, URI::file->new_abs($input_filename)->as_string;
return (\@command);
}
# elinks (version 0.12pre2 at least) is picky about charset names in a
# similar fashion to the main "links" program (see Links.pm). Turn
# "latin-1" into "latin1" here for convenience.
#
sub _elinks_mung_charset {
my ($charset) = @_;
$charset =~ s/^(latin)-([0-9]+)$/$1$2/i;
return $charset;
}
# Return $str with quotes around it, and backslashed within it, suitable for
# use in an elinks config file or -eval of a config file line.
sub _quote_config_stringarg {
my ($str) = @_;
$str =~ s/'/\\'/g; # ' -> \'
return "'$str'"; # '$str' surrounding quotes
}
1;
__END__
=for stopwords HTML-FormatExternal elinks formatters Elinks 0.12pre2 multibyte charset utf-8 charsets latin-1 latin1 Ryde recode unibyte
=head1 NAME
HTML::FormatText::Elinks - format HTML as plain text using elinks
=for test_synopsis my ($text, $filename, $html_string, $formatter, $tree)
=head1 SYNOPSIS
use HTML::FormatText::Elinks;
$text = HTML::FormatText::Elinks->format_file ($filename);
$text = HTML::FormatText::Elinks->format_string ($html_string);
$formatter = HTML::FormatText::Elinks->new (rightmargin => 60);
$tree = HTML::TreeBuilder->new_from_file ($filename);
$text = $formatter->format ($tree);
=head1 DESCRIPTION
C<HTML::FormatText::Elinks> turns HTML into plain text using the C<elinks>
program.
=over 4
L<http://elinks.cz/>
=back
The module interface is compatible with formatters like C<HTML::FormatText>,
but all parsing etc is done by elinks.
See C<HTML::FormatExternal> for the formatting functions and options, all of
which are supported by C<HTML::FormatText::Elinks> with the following
caveats.
=over 4
=item C<input_charset>
As of Elinks 0.12pre2 (Oct 2008) has various unibyte input charsets but the
only multibyte input charset accepted is utf-8. You could recode others to
utf-8 if necessary (but this module doesn't attempt to do that
automatically).
=back
Elinks can be a little picky about its charset names. This module attempts
to ease that by for instance turning "latin-1" (not accepted) into "latin1"
(which is accepted). A full name "ISO-8859-1" etc is accepted too.
=head1 SEE ALSO
L<HTML::FormatExternal>, L<elinks(1)>
=head1 HOME PAGE
L<http://user42.tuxfamily.org/html-formatexternal/index.html>
=head1 LICENSE
Copyright 2008, 2009, 2010, 2012, 2013, 2015 Kevin Ryde
HTML-FormatExternal 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, or (at your option) any later
version.
HTML-FormatExternal is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
HTML-FormatExternal. If not, see L<http://www.gnu.org/licenses/>.
=cut
|
