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
|
# Copyright (C) 2014 Niels Thykier <niels@thykier.net>
#
# 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program. If not, you can find it on the World Wide
# Web at https://www.gnu.org/copyleft/gpl.html, or write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
# A simple resource manager for html_reports
package Lintian::Reporting::ResourceManager;
use v5.20;
use warnings;
use utf8;
use Carp qw(croak);
use Const::Fast;
use File::Basename qw(basename);
use File::Copy qw(copy);
use Unicode::UTF8 qw(encode_utf8);
use Lintian::Util qw(get_file_digest);
const my $SPACE => q{ };
const my $SLASH => q{/};
const my $EQUALS => q{=};
const my $BASE64_UNIT => 4;
const my $WIDELY_READABLE_FOLDER => oct(755);
=head1 NAME
Lintian::Reporting::ResourceManager -- A simple resource manager for html_reports
=head1 SYNOPSIS
use Lintian::Reporting::ResourceManager;
my $resMan = Lintian::Reporting::ResourceManager->new(
'html_dir' => 'path/to/HTML-root',
);
# Copy the resource
$resMan->install_resource('path/to/my-image.png', { install_method => 'copy'} );
# Move the resource
$resMan->install_resource('path/to/generated-styles.css');
print encode_utf8('Image: ' . $resMan->resource_url('my-image.png'), "\n");
print encode_utf8('CSS: ' . $resMan->resource_url('generated-styles.css'), "\n");
=head1 DESCRIPTION
A simple resource manager for Lintian's reporting tool,
B<html_reports>.
=head1 CLASS METHODS
=over 4
=item new(TYPE, OPTS)
Instantiates a new resource manager.
OPTS is a key-value list, which must contain the key "html_dir" set to
the root of the HTML path. It is beneath this path that all resources
will be installed
=cut
sub new {
my ($class, %opts) = @_;
my $self = {%opts,};
croak encode_utf8('Missing required parameter html_dir (or it is undef)')
if not defined $opts{'html_dir'};
$self->{'_resource_cache'} = {};
$self->{'_resource_integrity'} = {};
return bless($self, $class);
}
=back
=head1 INSTANCE METHODS
=over 4
=item install_resource(RESOURCE[, OPT])
Installs RESOURCE into the html root. The resource may be renamed
(based on content etc.).
Note that the basename of RESOURCE must be unique between all
resources installed. See L</resource_url(RESOURCE_NAME)>.
If OPT is given, it must be a hashref with 0 or more of the following
keys (and values).
=over 4
=item install_method
Can be "copy" or "move" (default). If set to "move", the original file
will be renamed into its new location. Otherwise, a copy is done and
the original file is left in place.
=item source_file
By default, the path denoted by RESOURCE is both the resource name and
the source file. This option can be used to install a given file as
RESOURCE regardless of the basename of the source file.
If this is passed, RESOURCE must be a basename (i.e. without any
slashes).
=back
=cut
sub install_resource {
my ($self, $resource_name, $opt) = @_;
my $resource_root = $self->{'html_dir'} . '/resources';
my $method = 'move';
my ($basename, $install_name, $resource, $digest, $b64digest);
$method = $opt->{'install_method'}
if $opt && exists($opt->{'install_method'});
if ($opt && exists($opt->{'source_file'})) {
$basename = $resource_name;
$resource = $opt->{'source_file'};
if ($basename =~ m{ / }msx) {
croak encode_utf8(
join($SPACE,
qq(Resource "${resource_name}" must not contain "/"),
'when source_file is given')
);
}
} else {
$basename = basename($resource_name);
$resource = $resource_name;
}
$digest = get_file_digest('sha256', $resource);
$install_name = $digest->clone->hexdigest;
$b64digest = $digest->b64digest;
while (length($b64digest) % $BASE64_UNIT) {
$b64digest .= $EQUALS;
}
croak encode_utf8("Resource name ${basename} already in use")
if defined($self->{'_resource_cache'}{$basename});
if ($basename =~ m/^.+(\.[^\.]+)$/xsm) {
my $ext = $1;
$install_name .= $ext;
}
if (!-d $resource_root) {
mkdir($resource_root, $WIDELY_READABLE_FOLDER)
or die encode_utf8("Cannot mkdir $resource_root");
}
my $target_file = "$resource_root/$install_name";
if ($method eq 'move') {
rename($resource, $target_file)
or die encode_utf8("Cannot rename $resource to $target_file");
} elsif ($method eq 'copy') {
copy($resource, $target_file)
or croak encode_utf8("Cannot copy $resource to $target_file: $!");
} else {
croak encode_utf8(
join($SPACE,
"Unknown install method ${method}",
'- please use "move" or "copy"')
);
}
$self->{'_resource_cache'}{$basename} = $target_file;
$self->{'_resource_integrity'}{$basename} = "sha256-${b64digest}";
return;
}
=item resource_url(RESOURCE_NAME)
Returns the path (relative to the HTML root) to a resource installed
via L</install_resource(RESOURCE)>, where RESOURCE_NAME is the
basename of the path given to install_resource.
=cut
sub resource_url {
my ($self, $resource_name) = @_;
croak encode_utf8("Unknown resource $resource_name")
if not defined($self->{'_resource_cache'}{$resource_name});
return $self->{'_resource_cache'}{$resource_name};
}
=item resource_integrity_value(RESOURCE_NAME)
Return a string that is valid in the "integrity" field of a C<< <link>
>> HTML tag. (See https://www.w3.org/TR/SRI/)
=cut
sub resource_integrity_value {
my ($self, $resource_name) = @_;
croak encode_utf8("Unknown resource $resource_name")
if not defined($self->{'_resource_integrity'}{$resource_name});
return $self->{'_resource_integrity'}{$resource_name};
}
=back
=head1 AUTHOR
Originally written by Niels Thykier <niels@thykier.net> for Lintian.
=cut
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|
