forked from plainblack/webgui
/
fileImport.pl
415 lines (351 loc) · 11.9 KB
/
fileImport.pl
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
#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2005 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
#-------------------------------------------------------------------
our ($webguiRoot, @nailable);
BEGIN {
$webguiRoot = "..";
@nailable = qw(jpg jpeg png gif);
unshift (@INC, $webguiRoot."/lib");
}
$| = 1;
use File::Path;
use File::stat;
use FileHandle;
use Getopt::Long;
use POSIX;
use strict;
use WebGUI::Asset::File;
use WebGUI::Asset::File::Image;
use WebGUI::Session;
use WebGUI::Storage;
use WebGUI::Utility;
# TB : Get the time as soon as possible. Use $now as global variable.
# $now is used for skipOlderThan feature.
my $now = time;
my $configFile;
my $owner = 3;
my $groupToView = 7;
my $groupToEdit = 4;
my $help;
my $pathToFiles;
my $override;
my $quiet;
my $webUser = 'apache';
my $assetId;
my $parentAssetId;
my $skipOlderThan = 999999999;
my $findByExt = "";
my $recursive = '';
my $overwrite = '';
my $ignoreExtInName = '';
GetOptions(
'configFile=s'=>\$configFile,
'owner=s'=>\$owner,
'groupToView=s'=>\$groupToView,
'groupToEdit=s'=>\$groupToEdit,
'help'=>\$help,
'override'=>\$override,
'pathToFiles=s'=>\$pathToFiles,
'quiet'=>\$quiet,
'webUser=s'=>\$webUser,
'parentAssetId=s'=>\$parentAssetId,
'skipOlderThan=i'=>\$skipOlderThan,
'findByExt=s'=>\$findByExt,
'recursive'=>\$recursive,
'overwrite'=>\$overwrite,
'ignoreExtInName'=>\$ignoreExtInName
);
if ($configFile eq "" || $pathToFiles eq "" || $parentAssetId eq "") {
&printHelp;
exit 4;
};
if ($help) {
&printHelp;
exit 1;
}
sub printHelp {
print <<STOP;
Usage: perl $0 --pathToFiles=<pathToImportFiles> --configfile=<webguiConfig> --parentAssetId=<assetId>
--configFile WebGUI config file.
--pathToFiles Folder containing files to import.
--parentAssetId The asset ID of the asset you wish
to attach these files to.
Options:
--groupToEdit The group ID of the group that should
have the privileges to edit these
files. Defaults to '4' (Content Managers).
--groupToView The group ID of the group that should
have the privileges to view these
files. Defaults to '7' (Everybody).
--help Display this help message and exit.
--owner The user ID of the user that should
have the privileges to modify these
files. Defaults to '3' (Admin).
--override This utility is designed to be run as
a privileged user on Linux style systems.
If you wish to run this utility without
being the super user, then use this flag,
but note that it may not work as
intended.
--quiet Disable output unless there's an error.
--webUser The user that your web server runs as.
Defaults to 'apache'.
--skipOlderThan An interval defined in second to skip file older than.
Defaults "nothing skip".
--findByExt Import only files files with an extension matching
one of the exensions.
Defaults "import all files".
--recursive Import the files recursivelly from the folder --pathToFiles
Defaults "don't run recursivelly"
--overwrite Overwrite any matching file URL with the new file rather
than creating a new Asset for the file.
Instanciate the existing asset and replace the file.
--ignoreExtInName Title and menuTitle database fields should not contain the
extension of the filename.
EXIT STATUS
The following exit values are returned:
0
Successful execution.
1
For Windows User, stop the script if not super user.
2
A folder can't be open for reading.
3
In recursive mode, if two files has the same name and are selected to be imported. Return this error.
4
Error during invocation of the command.
5
The parent Asset Id doesn't exists.
STOP
}
my $slash = ($^O =~ /^Win/i) ? "\\" : "/";
if (!($^O =~ /^Win/i) && $> != 0 && !$override) {
print "You must be the super user to use this utility.\n";
exit 1;
}
my %ListAssetExists;
my %filelisthash;
print "Starting..." unless ($quiet);
my $session = WebGUI::Session->open($webguiRoot,$configFile);
$session->user({userId=>3});
print "OK\n" unless ($quiet);
my $parent = WebGUI::Asset::File->newByDynamicClass($session, $parentAssetId);
if (defined $parent) {
&buildListAssetExists($parent);
} else {
print "Warning: Parent asset '".$parentAssetId."' does not exist. Cannot import files.\n";
exit 5;
}
print "End of the childs detection\n" unless ($quiet);
# TB : wrap buildFileList in buildFileListWrap function for recursive search.
&addFiles(&buildFileListWrap($pathToFiles));
&setPrivileges();
print "Cleaning up..." unless ($quiet);
$session->var->end();
$session->close();
print "OK\n" unless ($quiet);
exit 0;
#-----------------------------------------
# addFiles(dbHandler, filelistHashRef, webguiSettingsHashRef, pathToCopyFrom)
#-----------------------------------------
sub addFiles {
my $filelist = shift;
print "Adding files...\n" unless ($quiet);
foreach my $file (@{$filelist}) {
my $class = 'WebGUI::Asset::File';
# TB : add the path relative to $pathToFile in the message.
print "\tAdding ".$file->{relpath}.$slash.$file->{filename}." to the database.\n" unless ($quiet);
my $templateId = 'PBtmpl0000000000000024';
if (isIn(lc($file->{ext}),@nailable)) {
$class = 'WebGUI::Asset::File::Image';
$templateId = 'PBtmpl0000000000000088'
}
my $url = $parent->getUrl.'/'.$file->{filename};
# TB : Possibly detect if the Asset exists already.
my ($replaceAsset, $replaceAssetId, $child) = (0,"","");
($replaceAsset, $replaceAssetId, $child) = &checkAssetExists($url) if ($overwrite);
if ($replaceAsset == 1) {
# TB : If the Asset exists, just copy the file.
# To be check.
my $storage = WebGUI::Storage->get($session, $replaceAssetId);
print "\t\tAsset exists already. Replace the file.\n" unless ($quiet);
my $filename = $storage->addFileFromFilesystem("$pathToFiles$slash$file->{relpath}$slash$file->{filename}");
$child->generateThumbnail if ($class eq 'WebGUI::Asset::File::Image');
$child->setSize($storage->getFileSize($filename));
} else {
print "\t\tCreate the new asset.\n" unless ($quiet);
my $storage = WebGUI::Storage->create($session);
my $filename = $storage->addFileFromFilesystem("$pathToFiles$slash$file->{relpath}$slash$file->{filename}");
# TB : possibly remove the extension if the ignoreExtInName feature enabled.
my $filenameTitle = $filename;
$filenameTitle =~ s/\.$file->{ext}// if ($ignoreExtInName);
my $newAsset = $parent->addChild({
className=>$class,
title=>$filenameTitle,
menuTitle=>$filenameTitle,
filename=>$filename,
storageId=>$storage->getId,
isHidden=>1,
url=>$url,
groupIdView=>$groupToView,
groupIdEdit=>$groupToEdit,
templateId=>$templateId,
endDate=>32472169200,
ownerUserId=>$owner
});
$newAsset->generateThumbnail if ($class eq 'WebGUI::Asset::File::Image');
$newAsset->setSize($storage->getFileSize($filename));
}
}
print "Finished adding.\n" unless ($quiet);
}
#-----------------------------------------
# setPrivileges()
#-----------------------------------------
sub setPrivileges {
print "Setting filesystem privileges.\n" unless ($quiet);
if ($session->os->get("type") eq "Linuxish") {
unless (system("chown -R ".$webUser." ".$session->config->get("uploadsPath"))) {
print "Privileges set.\n" unless ($quiet);
} else {
print "Could not set privileges.\n";
}
} else {
print "Cannot set privileges on this platform.\n" unless ($quiet)
}
}
#-----------------------------------------
# buildFileListWrap(pathToImportFiles)
#-----------------------------------------
sub buildFileListWrap {
my ($path) = @_;
my (@filelist);
print "Building file list.\n" unless ($quiet);
@filelist = &buildFileList($now,$path);
# &filelistCheck(@filelist);
print "File list complete.\n" unless ($quiet);
return \@filelist;
}
#-----------------------------------------
# buildFileList(time,pathToImportFiles)
#-----------------------------------------
sub buildFileList {
my ($now,$path) = @_;
my (@filelist, @files, $file, $filename, $ext);
if (opendir(FILES,$path)) {
@files = readdir(FILES);
foreach $file (@files) {
next if ($file eq "." || $file eq "..");
my $fullpathfile = "$path$slash$file";
if (-f "$fullpathfile") {
$file =~ /(.*?)\.(.*?)$/;
$filename = $1;
$ext = $2;
# TB : filter process : skip files due to options : skipOlderThan and findByExt
next if (&skipFilter($fullpathfile,$ext,$now));
# TB : due to recursive search. Not really nice.
my $relpath = &trailFile("$path");
# TB : check is the filelist doesn't contains two times the same file (file with the same name)
# due to recursive call, this can happen.
if (exists $filelisthash{$file}) {
print "Error: file \"$file\" exists at several locations.
Both \"$filelisthash{$file}\" and \"$relpath\" contains it.
Exit at the first error of this type.\n" unless ($quiet);
exit 2;
}
push(@filelist,{ext=>$ext, filename=>$file, relpath=>$relpath});
$filelisthash{$file} = $relpath;
print "Found file $file.\n" unless ($quiet);
}
# TB : the recursive call
push(@filelist,&buildFileList($now,"$fullpathfile")) if ((-d "$fullpathfile") && $recursive);
}
closedir(FILES);
return @filelist;
} else {
print "Error: Could not open folder $path.\n" unless ($quiet);
exit 2;
}
}
#-----------------------------------------
# getType(filename)
#-----------------------------------------
sub getType {
my ($extension);
$extension = $_[0];
$extension =~ s/.*\.(.*?)$/$1/;
return $extension;
}
#-----------------------------------------
# skipFilter(file,ext,time)
#-----------------------------------------
sub skipFilter {
my ($file,$ext,$now) = @_;
# TB : stat in Windows has a strange behaviour relativelly to Unix
# the output of stat si an array of array.
# to be check on Unix if this work correctly.
my @dev = stat "$file";
# TB : option skipOlderThan
if ($now - $dev[0][9] > $skipOlderThan) {
print "Found file $file.\n\tBut older than $skipOlderThan. Skip it.\n" unless ($quiet);
return 1;
}
# TB : option findByExt
if (($findByExt ne "") && ($findByExt !~ /(^|,)$ext(,|$)/)) {
print "Found file in $file.\n\tBut Extension doesn't match findByExt tag. Skip it.\n" unless ($quiet);
return 1;
}
return 0;
}
#-----------------------------------------
# trailFile(path)
#-----------------------------------------
sub trailFile {
# TB : this is ugly, but unable to find a better way to do it.
# this is supposed to find the relative path to pathToFiles
my ($path) = @_;
my $pathToFiles_temp = $pathToFiles;
if ($^O =~ /Win/) {
$pathToFiles_temp =~ s/\\/\\\\/g;
} else {
$pathToFiles_temp =~ s/\//\\\//g;
}
$path =~ s/$pathToFiles_temp//;
$path =~ s/.//;
$path = "." if ($path eq "");
return $path;
}
#-----------------------------------------
# checkAssetExists(self,url)
#-----------------------------------------
sub checkAssetExists {
my ($url) = @_;
my $replaceAsset = 0;
my $replaceAssetId = "";
my $child;
if (exists $ListAssetExists{$url}) {
$child = $ListAssetExists{$url};
$replaceAsset = 1;
$replaceAssetId = $child->getId;
}
return($replaceAsset, $replaceAssetId, $child);
}
#-----------------------------------------
# buildListAssetExists(self,url)
#-----------------------------------------
sub buildListAssetExists {
my ($parent) = @_;
my @allelement = $parent->getLineage();
foreach my $elem ( @{$allelement[0]} ) {
my $child = WebGUI::Asset::File->newByDynamicClass($session,$elem);
if (defined $child) {
$ListAssetExists{$child->getUrl} = $child;
}
}
}