forked from plainblack/webgui
-
Notifications
You must be signed in to change notification settings - Fork 1
/
AssetExportHtml.pm
412 lines (329 loc) · 13.8 KB
/
AssetExportHtml.pm
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
package WebGUI::Asset;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2007 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use File::Path;
use FileHandle;
=head1 NAME
Package WebGUI::AssetExportHtml
=head1 DESCRIPTION
This is a mixin package for WebGUI::Asset that contains all clipboard related functions.
=head1 SYNOPSIS
use WebGUI::Asset;
=head1 METHODS
These methods are available from this class:
=cut
#-------------------------------------------------------------------
=head2 checkExportPath ( )
Returns a descriptive error message (HTML) if the export path is not
writable, does not exist, or is not specified in the per-domain WebGUI
config file.
=cut
sub checkExportPath {
my $self = shift;
my $error;
if (defined $self->session->config->get("exportPath")) {
if (-d $self->session->config->get("exportPath")) {
unless (-w $self->session->config->get("exportPath")) {
$error .= 'Error: The export path '.$self->session->config->get("exportPath").' is not writable.<br />
Make sure that the webserver has permissions to write to that directory';
}
} else {
eval {mkpath($self->session->config->get("exportPath"),0)};
if ($@) {
$error .= 'Error: The export path '.$self->session->config->get("exportPath").' does not exist, and couldn\'t create it because '.$@;
}
}
} else {
$error.= 'Error: The export path is not configured. Please set the exportPath variable in the WebGUI config file';
}
$error = '<p><b>'.$error.'</b></p>' if $error;
return $error;
}
#-------------------------------------------------------------------
# Private method to do most of the work for exporting. Returns
# ($success_flag, $description).
# Buggo: probably shouldn't be doing i18n stuff here; refactor this
# further
sub _exportAsHtml {
my $self = shift;
my $quiet = shift;
my $userId = shift;
my $index = shift;
my $extrasUploadsAction = shift;
my $rootUrlAction = shift;
my $startTime = $self->session->datetime->time();
my $exportPathError = $self->checkExportPath();
if ($exportPathError) {
return (0, $exportPathError);
}
my $exportPath = $self->session->config->get('exportPath');
my $defaultAssetId = $self->session->setting->get('defaultPage');
my $defaultAssetPath = undef;
my $i18n = WebGUI::International->new($self->session, 'Asset');
# Get a list of the asset IDs we need, reverse sorted by URL
my $tempSession = WebGUI::Session->open($self->session->config->getWebguiRoot, $self->session->config->getFilename);
$tempSession->user({userId=>$userId});
my $newSelf = WebGUI::Asset->new($tempSession, $self->getId, $self->get("className"), $self->get("revisionDate"));
my $assetIds = $newSelf->getLineage(["self","descendants"],{
endingLineageLength => $newSelf->getLineageLength+$self->session->form->process("depth"),
orderByClause => 'assetData.url DESC',
});
$tempSession->var->end;
$tempSession->close;
# We're going to walk up the URL branch, making the deepest paths first
foreach my $assetId (@{$assetIds}) {
my $assetSession = WebGUI::Session->open($self->session->config->getWebguiRoot, $self->session->config->getFilename);
$assetSession->user({userId=>$userId});
my $asset = WebGUI::Asset->newByDynamicClass($assetSession, $assetId);
my $url = $asset->get("url");
# notify we can't output because user selected can't view the page
unless ($asset->canView($userId)) {
$self->session->output->print(sprintf($i18n->get('bad user privileges')."\n") . $asset->getUrl) unless $quiet;
next;
}
# find out where we're exporting
my $pathData = $self->_translateUrlToPath($url, $index);
if (my $error = $pathData->{'error'}) {
return (0, $error);
}
my $path = $exportPath . '/'. $pathData->{'path'};
my $filename = $pathData->{'filename'};
# this is needed for symlinking
if ($asset->getId eq $defaultAssetId) {
$defaultAssetPath = (length($pathData->{'path'}) ? $pathData->{'path'}."/" : "") . $pathData->{'filename'};
}
# see if path already exists, if not, create it
unless (-d $path) {
eval { mkpath($path) };
if($@) {
return (0, sprintf($i18n->get('could not create path'), $path, $@));
}
}
# output which page we're exporting
my $pathWithFilename = $path.'/'.$filename;
$pathWithFilename =~ s{//}{/}g;
unless ($quiet) {
$self->session->output->print(sprintf($i18n->get('exporting page'), $pathWithFilename));
}
# write the file
#open my $fileHandle, ">", $pathWithFilename;
my $fileHandle = FileHandle->new(">".$pathWithFilename);
if (defined $fileHandle) {
$assetSession->output->setHandle($fileHandle);
$assetSession->asset($asset);
my $content = $asset->exportHtml_view;
# chunked content will have already been printed, so no need to print again
unless ($content eq "chunked") {
$assetSession->output->print($content);
}
$fileHandle->close;
}
else {
return (0, sprintf($i18n->get('could not open path'), $pathWithFilename, $!));
}
$assetSession->var->end;
$assetSession->close;
$self->session->db->write("UPDATE asset SET lastExportedAs = ? WHERE assetId = ?", [$pathWithFilename, $asset->getId]);
$self->session->output->print($i18n->get('done')) unless $quiet;
}
# symlink?
if ($extrasUploadsAction eq 'symlink') {
my ($extrasPath, $uploadsPath) = ($self->session->config->get('extrasPath'), $self->session->config->get('uploadsPath'));
my ($extrasUrl, $uploadsUrl) = ($self->session->config->get('extrasURL'), $self->session->config->get('uploadsURL'));
s#^/*## for ($extrasUrl, $uploadsUrl);
my ($extrasDst, $uploadsDst) = ($exportPath.'/'.$extrasUrl, $exportPath.'/'.$uploadsUrl);
$self->session->output->print($i18n->get('extrasUploads symlinking')."\n") unless $quiet;
foreach my $rec ([$extrasPath, $extrasDst], [$uploadsPath, $uploadsDst]) {
my ($path, $dst) = @$rec;
if (-l $dst) {
next if (readlink $dst eq $path);
unlink $dst or return (0, sprintf($i18n->get('could not unlink'), $dst, $!));
}
eval { mkpath($dst) };
$@ and return (0, sprintf($i18n->get('could not create'), $dst, $@));
rmdir $dst or return (0, sprintf($i18n->get('could not rmdir'), $dst, $!));
symlink $path, $dst or return (0, sprintf($i18n->get('could not symlink'), $path, $dst, $!));
}
}
elsif ($extrasUploadsAction eq 'none') {
# Nothing. This is the default.
}
if ($rootUrlAction eq 'symlinkDefault') {
if (defined $defaultAssetPath) {
my ($src, $dst) = ($defaultAssetPath, $exportPath.'/'.$index);
$self->session->output->print($i18n->get('rootUrl symlinking default')."\n") unless $quiet;
if (-l $dst) {
last if (readlink $dst eq $src);
unlink $dst or return (0, sprintf($i18n->get('could not unlink'), $dst, $!));
}
symlink $src, $dst or return (0, sprintf($i18n->get('could not symlink'), $src, $dst, $!));
} else {
$self->session->output->print($i18n->get('rootUrl default not present')."\n") unless $quiet;
}
} elsif ($rootUrlAction eq 'none') {
# Nothing. This is the default.
}
return (1, sprintf($i18n->get('export information'), scalar(@{$assetIds}), ($self->session->datetime->time()-$startTime)));
}
#-------------------------------------------------------------------
=head2 _translateUrlToPath ( url, index )
Translates a url into an appropriate path and filename for exporting
=head3 url
URL of the asset we need an export path for
=head3 index
index filename passed in from the UI
=cut
sub _translateUrlToPath {
my $self = shift;
my $url = shift;
my $index = shift;
my $dataRef;
# Ignore trailing slashes
$url =~ s{/+$}{}g;
# If there is not a dot in the URL, this is easy
if ($url !~ m{[.]}) {
$dataRef->{'path' } = $url;
$dataRef->{'filename' } = $index;
}
# There is a dot
else {
# The last part after a slash is the "name"
my ($path,$name) = $url =~ m{(?:(.*) /)? ([^/]+) $}x; # NOTE: Might be more efficient to use index() and substr()
# If it ends in a known file type handled by apache, use that
if ($name =~ m{[.](?:html|htm|txt|pdf|jpg|css|gif|png|doc|xls|xml|rss|bmp|mp3|js|fla|flv|swf)$}) {
$dataRef->{'path' } = $path;
$dataRef->{'filename' } = $name;
}
else {
# It doesn't end in a known file type
# Make a directory for it
$dataRef->{'path' } = $url;
$dataRef->{'filename' } = $index;
}
}
return $dataRef;
}
#-------------------------------------------------------------------
=head2 exportAsHtml
Same as www_exportGenerate except without the output. Returns
"success" if successful, otherwise returns an error message.
=cut
sub exportAsHtml {
my $self = shift;
my ($success, $description) = $self->_exportAsHtml(1, '1', 'index.html');
return $success? "success" : $description;
}
#-------------------------------------------------------------------
=head2 exportHtml_view ( )
View method for static export. This is like www_view, and defaults to
just calling www_view, but this needs to be overridden if www_view
depends on there being an actual HTTP response on the other end.
=cut
sub exportHtml_view {
my $self = shift;
$self->www_view(@_);
}
#-------------------------------------------------------------------
=head2 www_export
Displays the export page administrative interface
=cut
sub www_export {
my $self = shift;
return $self->session->privilege->insufficient() unless ($self->session->user->isInGroup(13));
$self->getAdminConsole->setHelp("page export", "Asset");
my $i18n = WebGUI::International->new($self->session, "Asset");
my $f = WebGUI::HTMLForm->new($self->session,-action=>$self->getUrl);
$f->hidden(
-name => "func",
-value => "exportStatus"
);
$f->integer(
-label=>$i18n->get('Depth'),
-hoverHelp=>$i18n->get('Depth description'),
-name=>"depth",
-value=>99,
);
$f->selectBox(
-label=>$i18n->get('Export as user'),
-hoverHelp=>$i18n->get('Export as user description'),
-name=>"userId",
-options=>$self->session->db->buildHashRef("select userId, username from users"),
-value=>[1],
);
$f->text(
-label=>$i18n->get("directory index"),
-hoverHelp=>$i18n->get("directory index description"),
-name=>"index",
-value=>"index.html"
);
# TODO: maybe add copy options to these boxes alongside symlink
$f->selectBox(
-label => $i18n->get('extrasUploads form label'),
-hoverHelp => $i18n->get('extrasUploads form hoverHelp'),
-name => "extrasUploadsAction",
-options => { 'symlink' => $i18n->get('extrasUploads form option symlink'),
'none' => $i18n->get('extrasUploads form option none') },
-value => ['none'],
);
$f->selectBox(
-label => $i18n->get('rootUrl form label'),
-hoverHelp => $i18n->get('rootUrl form hoverHelp'),
-name => "rootUrlAction",
-options => { 'symlinkDefault' => $i18n->get('rootUrl form option symlinkDefault'),
'none' => $i18n->get('rootUrl form option none') },
-value => ['none'],
);
$f->submit;
$self->getAdminConsole->render($self->checkExportPath.$f->print,$i18n->get('Export Page'));
}
#-------------------------------------------------------------------
=head2 www_exportStatus
Displays the export status page
=cut
sub www_exportStatus {
my $self = shift;
return $self->session->privilege->insufficient() unless ($self->session->user->isInGroup(13));
my $i18n = WebGUI::International->new($self->session, "Asset");
my $iframeUrl = $self->getUrl('func=exportGenerate');
foreach my $formVar (qw/index depth userId extrasUploadsAction rootUrlAction/) {
$iframeUrl = $self->session->url->append($iframeUrl, $formVar.'='.$self->session->form->process($formVar));
}
my $output = '<iframe src="'.$iframeUrl.'" title="'.$i18n->get('Page Export Status').'" width="700" height="500"></iframe>';
$self->getAdminConsole->render($output,$i18n->get('Page Export Status'),"Asset");
}
#-------------------------------------------------------------------
=head2 www_exportGenerate
Executes the export process and displays real time status. This operation is displayed by exportStatus in an IFRAME.
=cut
sub www_exportGenerate {
my $self = shift;
return $self->session->privilege->insufficient() unless ($self->session->user->isInGroup(13));
# This routine is called in an IFRAME and prints status output directly to the browser.
$|++; # Unbuffered data output
$self->session->style->useEmptyStyle(1);
$self->session->http->sendHeader;
my $i18n = WebGUI::International->new($self->session, 'Asset');
my ($success, $description) =
$self->_exportAsHtml(0, $self->session->form->process('userId'),
$self->session->form->process('index'),
$self->session->form->process('extrasUploadsAction'),
$self->session->form->process('rootUrlAction'));
if (!$success) {
$self->session->output->print($description,1);
return "chunked";
}
$self->session->output->print($description,1);
$self->session->output->print('<a target="_parent" href="'.$self->getUrl.'">'.$i18n->get(493,'WebGUI').'</a>');
return "chunked";
}
1;