source: gsdl/trunk/runtime-src/src/recpt/depositoraction.cpp@ 20535

Last change on this file since 20535 was 20535, checked in by davidb, 15 years ago

The depositor now supports users that belong to collection specific groups (e.g. demo-collection-editor) in addition to all-collections-editor

  • Property svn:keywords set to Author Date Id Revision
File size: 31.6 KB
Line 
1/**********************************************************************
2 *
3 * depositoraction.cpp --
4 * Copyright (C) 2000 The New Zealand Digital Library Project
5 *
6 * A component of the Greenstone digital library software
7 * from the New Zealand Digital Library Project at the
8 * University of Waikato, New Zealand.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 *
24 *********************************************************************/
25
26#include "gsdl_modules_cfg.h"
27#ifdef GSDL_USE_DEPOSITOR_ACTION
28
29// note that the collectoraction relies on having direct access to a
30// collections configuration file. this breaks the separation between
31// receptionist and collection server and so is not suitable (at least
32// in its current form) for use when collection servers are separate
33// from the receptionist (e.g. when using the CORBA protocol).
34
35// following line required to get fstream.filedesc() on darwin (Mac OS X)
36#define _STREAM_COMPAT 1
37// required for utsname on solaris???
38#define _XOPEN_SOURCE 1
39// This was added for Solaris, but it makes things worse on Solaris for me...
40// #define _XOPEN_SOURCE_EXTENDED 1
41
42#include "depositoraction.h"
43#include "OIDtools.h"
44#include "fileutil.h"
45#include "cfgread.h"
46#include "gsdltools.h"
47#include "gsdltimes.h"
48#include "argdb.h"
49#include "cgiutils.h"
50
51#include <stdio.h>
52//#include <strings.h> // seems to be needed for gcc 2.95, but not particularly happy it
53#include <fcntl.h>
54#include <time.h>
55
56#if !defined (__WIN32__)
57#include <sys/utsname.h>
58#include <unistd.h>
59#endif
60
61#include <new>
62//#include <string>
63#include <vector>
64#include <stdexcept>
65#include <iostream>
66//#include <cstdlib>
67
68depositoraction::depositoraction ()
69 : wizardaction()
70{
71 macro_prefix = "di1"; //deposit item
72 lastpage = 0;
73
74 cgiarginfo arg_ainfo;
75 arg_ainfo.shortname = "a";
76 arg_ainfo.longname = "action";
77 arg_ainfo.multiplechar = true;
78 arg_ainfo.defaultstatus = cgiarginfo::weak;
79 arg_ainfo.argdefault = "depositor";
80 arg_ainfo.savedarginfo = cgiarginfo::must;
81 argsinfo.addarginfo (NULL, arg_ainfo);
82
83 arg_ainfo.shortname = "p";
84 arg_ainfo.longname = "page";
85 arg_ainfo.multiplechar = true;
86 arg_ainfo.defaultstatus = cgiarginfo::weak;
87 arg_ainfo.argdefault = "select";
88 arg_ainfo.savedarginfo = cgiarginfo::must;
89 argsinfo.addarginfo (NULL, arg_ainfo);
90
91 //furthest page that has been visited
92 arg_ainfo.shortname = "di1lastpage";
93 arg_ainfo.longname = "depositor specific";
94 arg_ainfo.multiplechar = true;
95 arg_ainfo.defaultstatus = cgiarginfo::weak;
96 arg_ainfo.argdefault = "0";
97 arg_ainfo.savedarginfo = cgiarginfo::must;
98 argsinfo.addarginfo (NULL, arg_ainfo);
99
100 // the fileupload info that cgiwrapper produces - we parse the fileupload_t
101 // and set di1userfile, di1userfilesize
102 arg_ainfo.shortname = "di1userfileinfo";
103 arg_ainfo.longname = "depositor specific";
104 arg_ainfo.fileupload = true;
105 arg_ainfo.savedarginfo = cgiarginfo::mustnot;
106 argsinfo.addarginfo (NULL, arg_ainfo);
107
108 // essential: reset fileupload to default as we are not setting
109 // it for each arg
110 arg_ainfo.fileupload = false;
111
112 //the name of the file to be added
113 arg_ainfo.shortname = "di1userfile";
114 arg_ainfo.longname = "depositor specific";
115 arg_ainfo.multiplechar = true;
116 arg_ainfo.defaultstatus = cgiarginfo::weak;
117 arg_ainfo.argdefault = g_EmptyText;
118 arg_ainfo.savedarginfo = cgiarginfo::must;
119 argsinfo.addarginfo (NULL, arg_ainfo);
120
121 //the file size
122 arg_ainfo.shortname = "di1userfilesize";
123 arg_ainfo.longname = "depositor specific";
124 arg_ainfo.multiplechar = true;
125 arg_ainfo.defaultstatus = cgiarginfo::weak;
126 arg_ainfo.argdefault = "0";
127 arg_ainfo.savedarginfo = cgiarginfo::must;
128 argsinfo.addarginfo (NULL, arg_ainfo);
129
130 //the file timestamp
131 arg_ainfo.shortname = "di1timestamp";
132 arg_ainfo.longname = "depositor specific";
133 arg_ainfo.multiplechar = true;
134 arg_ainfo.defaultstatus = cgiarginfo::weak;
135 arg_ainfo.argdefault = "0";
136 arg_ainfo.savedarginfo = cgiarginfo::must;
137 argsinfo.addarginfo (NULL, arg_ainfo);
138
139 // temporary directory name for this collector
140 // session
141 arg_ainfo.shortname = "di1tmp";
142 arg_ainfo.longname = "depositor specific";
143 arg_ainfo.multiplechar = true;
144 arg_ainfo.defaultstatus = cgiarginfo::weak;
145 arg_ainfo.argdefault = g_EmptyText;
146 arg_ainfo.savedarginfo = cgiarginfo::must;
147 argsinfo.addarginfo (NULL, arg_ainfo);
148
149// arg_ainfo.shortname = "di1fullname";
150// arg_ainfo.longname = "depositor specific";
151// arg_ainfo.multiplechar = true;
152// arg_ainfo.defaultstatus = cgiarginfo::weak;
153// arg_ainfo.argdefault = g_EmptyText;
154// arg_ainfo.savedarginfo = cgiarginfo::mustnot; // saved on disk
155// argsinfo.addarginfo (NULL, arg_ainfo);
156
157 arg_ainfo.shortname = "di1dirname";
158 arg_ainfo.longname = "depositor specific";
159 arg_ainfo.multiplechar = true;
160 arg_ainfo.defaultstatus = cgiarginfo::weak;
161 arg_ainfo.argdefault = g_EmptyText;
162 arg_ainfo.savedarginfo = cgiarginfo::must;
163 argsinfo.addarginfo (NULL, arg_ainfo);
164
165 arg_ainfo.shortname = "di1contactemail";
166 arg_ainfo.longname = "depositor specific";
167 arg_ainfo.multiplechar = true;
168 arg_ainfo.defaultstatus = cgiarginfo::weak;
169 arg_ainfo.argdefault = g_EmptyText;
170 arg_ainfo.savedarginfo = cgiarginfo::mustnot; // saved on disk
171 argsinfo.addarginfo (NULL, arg_ainfo);
172
173// arg_ainfo.shortname = "di1clone";
174// arg_ainfo.longname = "depositor specific";
175// arg_ainfo.multiplechar = false;
176// arg_ainfo.defaultstatus = cgiarginfo::weak;
177// arg_ainfo.argdefault = "0";
178// arg_ainfo.savedarginfo = cgiarginfo::mustnot; // saved on disk
179// argsinfo.addarginfo (NULL, arg_ainfo);
180
181// arg_ainfo.shortname = "di1clonecol";
182// arg_ainfo.longname = "depositor specific";
183// arg_ainfo.multiplechar = true;
184// arg_ainfo.defaultstatus = cgiarginfo::weak;
185// arg_ainfo.argdefault = g_EmptyText;
186// arg_ainfo.savedarginfo = cgiarginfo::mustnot; // saved on disk
187// argsinfo.addarginfo (NULL, arg_ainfo);
188
189// arg_ainfo.shortname = "cfgfile";
190// arg_ainfo.longname = "configuration file contents";
191// arg_ainfo.multiplechar = true;
192// arg_ainfo.defaultstatus = cgiarginfo::weak;
193// arg_ainfo.argdefault = g_EmptyText;
194// arg_ainfo.savedarginfo = cgiarginfo::mustnot;
195// argsinfo.addarginfo (NULL, arg_ainfo);
196
197// // will be set if we arrived at the "configure collection" page
198// // via the "changing an existing collection" page
199// arg_ainfo.shortname = "di1econf";
200// arg_ainfo.longname = "depositor specific";
201// arg_ainfo.multiplechar = false;
202// arg_ainfo.defaultstatus = cgiarginfo::weak;
203// arg_ainfo.argdefault = "0";
204// arg_ainfo.savedarginfo = cgiarginfo::must;
205// argsinfo.addarginfo (NULL, arg_ainfo);
206
207 // wizard uses this to see if we are working with an existing collection:
208 // set the default to 1
209 arg_ainfo.shortname = "di1esrce";
210 arg_ainfo.longname = "depositor specific";
211 arg_ainfo.multiplechar = false;
212 arg_ainfo.defaultstatus = cgiarginfo::weak;
213 arg_ainfo.argdefault = "1";
214 arg_ainfo.savedarginfo = cgiarginfo::must;
215 argsinfo.addarginfo (NULL, arg_ainfo);
216
217// arg_ainfo.shortname = "di1input";
218// arg_ainfo.longname = "depositor specific";
219// arg_ainfo.multiplechar = true;
220// arg_ainfo.multiplevalue = true;
221// arg_ainfo.defaultstatus = cgiarginfo::weak;
222// arg_ainfo.argdefault = g_EmptyText;
223// arg_ainfo.savedarginfo = cgiarginfo::mustnot; // saved on disk
224// argsinfo.addarginfo (NULL, arg_ainfo);
225
226// //we don't need this in the depositor
227// arg_ainfo.shortname = "di1inputtype";
228// arg_ainfo.longname = "depositor specific";
229// arg_ainfo.multiplechar = true;
230// arg_ainfo.multiplevalue = true;
231// arg_ainfo.defaultstatus = cgiarginfo::weak;
232// arg_ainfo.argdefault = g_EmptyText;
233// arg_ainfo.savedarginfo = cgiarginfo::mustnot; // saved on disk
234// argsinfo.addarginfo (NULL, arg_ainfo);
235
236}
237
238depositoraction::~depositoraction () {
239}
240
241
242bool depositoraction::check_cgiargs (cgiargsinfoclass &argsinfo, cgiargsclass &args, recptprotolistclass * protos, ostream &logout) {
243
244 wizardaction::check_cgiargs(argsinfo,args,protos,logout);
245
246 text_t &current_page = args["p"];
247
248 // note that the "bildstatus" and "bildframe1" pages don't actually do anything
249 // functional so we don't need to worry about authenticating them (it's the
250 // underlying "bild" page that does the building (and creates the frameset))
251 // This helps us overcome a bit of a problem we have with multiple pages trying
252 // to read from the key.gdb database at the same time.
253
254 //right now, anyone can do anything until it's time to build
255
256 // Used to check current page was "select", now changed to "step1".
257 // (i.e. one page later). This is needed so users that belong to
258 // specific collection-edit groups (e.g. demo-collection-editor) are able
259 // to log in successfully.
260 //
261
262 if (current_page == "step1") {
263 //authenticate the user if authentication is available
264 args["uan"] = 1;
265 args["ug"] = "all-collections-editor," + args["c"] + "-collection-editor";
266 }
267
268
269 //Check to see if a file was specified
270 //if so, upload it and set the di1userfile, di1userfilesize, and
271 //di1timestamp args.
272 //every time a new file is specified, a new timestamped folder is
273 //created.
274
275 // This doesn't create a problem but is inefficient (wasted space)
276 // Consider recoding at some point in the future.
277
278 fileupload_t *fileupload = args.getargfile("di1userfileinfo");
279
280 if (fileupload != NULL) {
281
282 if (!(*fileupload).tmp_name.empty() && file_exists((*fileupload).tmp_name)) {
283 // create the timestamp
284 time_t timestamp = time(NULL);
285 text_t timestamp_str(timestamp);
286
287 args["di1timestamp"] = timestamp_str;
288
289 // set filename and size from the fileupload struct
290 args["di1userfilesize"] = (*fileupload).size;
291 args["di1userfile"] = (*fileupload).name;
292 // copy the file into its temporary location
293 text_t tmpdir = filename_cat(gsdlhome,"tmp",args["di1tmp"],timestamp_str);
294 bool tflag = mk_dir(tmpdir);
295 text_t tmpfile = filename_cat(tmpdir,(*fileupload).name);
296 if (!file_copy((*fileupload).tmp_name, tmpfile)) {
297 cerr << "Depositor error: cannot save uploaded fileto "<<tmpfile<<endl;
298 } else {
299 cerr << "Depositor: saved uploaded file to "<<tmpfile<<endl;
300 }
301 }
302 }
303
304 if (current_page == "select") {
305
306 //make sure the last page arg is re-set to zero
307 //since a new collection is being chosen
308 args["di1lastpage"] = "0";
309
310 // assign (and create) a temporary directory This will create a new
311 // tbuild directory every time the user goes back to select a new
312 // collection. It causes no problems except wasted space. Should be
313 // addressed in the future
314 if (assign_tmpname (args, logout)==false) {
315 // there was an error creating the tmp dir
316 message="tmpfail";
317 return true; // true because we could still parse the arguments
318 }
319
320 // clean up any old builds left laying about in the tmp directory
321 // (note that it's possible this could take some time if there's a huge
322 // partially built collecton laying about so we'll make it an asynchronous
323 // system call)
324 gsdl_system ("perl -S cleantmp.pl", false, logout);
325
326 }
327
328 if (current_page == "bildstatus" || current_page == "bildcancel") {
329 // if .final file exists then build has finished
330 text_t fbld = filename_cat (gsdlhome, "tmp", args[macro_prefix + "tmp"], args[macro_prefix + "dirname"] + ".bld.final");
331 if (file_exists (fbld)) {
332 char *fbldc = fbld.getcstr();
333 ifstream fbld_in (fbldc);
334 if (fbld_in) {
335 failcode = fbld_in.get();
336 fbld_in.close();
337 if (failcode == '0') {
338 // success - we need to create and configure a collection server for the
339 // newly built collection (for fastcgi and local library where
340 // initialization isn't going to be redone when the user clicks the
341 // "view your new collection" button
342 create_colserver (args[macro_prefix + "dirname"], logout);
343 current_page = "bilddone";
344 }
345 else current_page = "bildfail";
346 } else {
347 // assume build failed (we shouldn't get here though ... right?)
348 current_page = "bildfail";
349 }
350 delete []fbldc;
351 }
352 }
353
354 //is it a step page?
355 text_t::const_iterator here = current_page.begin();
356 text_t::const_iterator end = current_page.end();
357 text_t stepstring = substr(here,here+4);
358
359 //if so, increment the step count
360 //this should not be going up more than one at a time.
361 if(stepstring == "step") {
362 text_t currpage_textt = substr(here+4,here+5);
363 int currpage = currpage_textt.getint();
364
365 text_t lastpage_textt = args["di1lastpage"];
366 int lastpage = lastpage_textt.getint();
367 if (currpage > lastpage) {
368 lastpage++;
369 text_t lastpage_textt(lastpage);
370 args["di1lastpage"] = lastpage_textt;
371 }
372
373 // create cached metadata values
374 text_t cached_metadata_values = "";
375 cgiargsclass::const_iterator args_here = args.begin();
376 cgiargsclass::const_iterator args_end = args.end();
377 while (args_here != args_end) {
378 text_t args_name = (*args_here).first;
379 int prefix_len = macro_prefix.size();
380 text_t args_prefix = substr(args_name.begin(),args_name.begin()+prefix_len+3);
381
382 if (args_prefix == (macro_prefix+"md.")) {
383 text_t args_val = args[args_name];
384 text_t args_suffix = substr(args_name.begin()+prefix_len+3,args_name.end());
385
386 text_tarray mdvalues;
387 splitchar (args_val.begin(), args_val.end(), ',', mdvalues);
388 int numvalues = mdvalues.size();
389
390 for (int i = 0; i < numvalues; ++i) {
391 if (!mdvalues[i].empty()) {
392 decode_cgi_arg(mdvalues[i]);
393
394 if (cached_metadata_values == "") {
395 cached_metadata_values = "var CachedMDValues = new Array(\\{";
396 } else {
397 cached_metadata_values += ",";
398 }
399
400 cached_metadata_values += "\"" + args_name + "\":\"" + args_val + "\"";
401 }
402 }
403 }
404 ++args_here;
405 }
406
407 if (cached_metadata_values != "") {
408 cached_metadata_values += "\\});";
409 args["cachedMDValues"] = cached_metadata_values;
410 }
411 }
412 return true;
413}
414
415
416void depositoraction::define_internal_macros (displayclass &disp, cgiargsclass &args,
417 recptprotolistclass *protos, ostream &logout) {
418
419 // define_internal_macros sets some/all of the following macros (depending
420 // on cgiargs):
421 //
422 // _pagescriptextra_
423 // _header_
424 // _depositorbar_
425 // _textfailmsg_
426 // _di1userfile_
427 // _di1userfilesize_
428
429 text_t &depositor_page = args["p"];
430
431 // set _pagescriptextra_ macro to _cpagescriptextra_
432 disp.setmacro ("pagescriptextra", "depositor", "_" + depositor_page + "scriptextra_");
433
434 if (depositor_page == "bildstatus" || depositor_page == "bilddone" ||
435 depositor_page == "bildfail" || depositor_page == "bildframe1" ||
436 depositor_page == "select") {
437 disp.setmacro ("header", "depositor", "_" + depositor_page + "header_");
438 }
439
440 if (depositor_page == "bildstatus") {
441 set_statusline (disp, args, logout);
442 }
443
444 if (depositor_page == "select") {
445 set_fullnamemenu (disp, args, protos, logout);
446 }
447
448 //how many pages in collection?
449 //we need a _depositorbar_ for each
450
451 text_t numsteps_str;
452 disp.expandstring("depositor", "_numsteps_", numsteps_str);
453 int numsteps = numsteps_str.getint();
454
455 //is the page a step page?
456
457 text_t::const_iterator here = depositor_page.begin();
458 text_t::const_iterator end = depositor_page.end();
459 text_t stepstring = substr(here,here+4);
460
461 if((stepstring) == "step" || (depositor_page == "depositonly") ) {
462 disp.setmacro("di1userfile","depositor",args["di1userfile"]);
463 disp.setmacro("di1userfilesize","depositor",args["di1userfilesize"]);
464 }
465
466 //set up the depositor bar
467 text_t depositorbar = "<table class=wizardbar border=0 cellspacing=4 cellpadding=0><tr>\n";
468
469 if(stepstring == "step") {
470 // check configured metadata elements
471 if (args["metadataconf"] == "var DepositorMDFields = new Array();" || args["metadataconf"] == "") {
472 text_t cfgfile_name = filename_cat (collecthome, args[macro_prefix + "dirname"], "etc", "collect.cfg");
473 text_t cfgfile_content;
474 text_t metadata_str;
475
476 if (read_file (cfgfile_name, cfgfile_content)) {
477 text_t::const_iterator here = cfgfile_content.begin();
478 text_t::const_iterator end = cfgfile_content.end();
479 while (here != end) {
480 here = findchar (here, end, 'd');
481 if (here == end) break;
482 if ((here+17 < end) && (substr (here, here+17) == "depositormetadata")) {
483 here = findchar (here, end, '"');
484 if (here == end) break;
485 text_t enddelimit = "\"\n";
486 getdelimitstr (here+1, end, enddelimit, metadata_str);
487 args["metadataconf"] = "var DepositorMDFields = new Array("+metadata_str+");";
488 }
489 ++here;
490 }
491 }
492
493 if (metadata_str == "") {
494 args["metadataconf"] = "var DepositorMDFields = new Array({\"name\":\"dc.Title\",\"label\":\"Title\",\"tooltip\":\"dc.Title: A name given to the resource.\",\"type\":\"text\"}, {\"name\":\"dc.Creator\",\"label\":\"Creator\",\"tooltip\":\"dc.Creator: An entity primarily responsible for making the content of the resource.\",\"type\":\"text\"}, {\"name\":\"dc.Description\",\"label\":\"Description\",\"tooltip\":\"dc.Description: An account of the content of the resource.\",\"type\":\"textarea\"});";
495 }
496 }
497
498 here = depositor_page.begin();
499 text_t stepnums = substr(here+4,here+5);
500 int stepnum = stepnums.getint();
501
502 text_t lastpage_textt = args["di1lastpage"];
503 int lastpage = lastpage_textt.getint();
504
505 // again, begin with the select bar...
506 //the first button - selecting a collection
507 for(int i = 1; i <= numsteps; i++) {
508 text_t numstr(i);
509 if(i <= lastpage && i == stepnum) {
510 depositorbar += get_button (args,depositor_page, "yellow", "step"+numstr, false);
511 } else if (i <= lastpage) {
512 depositorbar += get_button (args,depositor_page, "yellow", "step"+numstr, true);
513 } else if((i == lastpage+1)){
514 depositorbar += get_button (args,depositor_page, "green", "step"+numstr, true);
515 } else {
516 depositorbar += get_button (args,depositor_page, "grey", "step"+numstr, false);
517 }
518 depositorbar += "<td>_icongreyarrow_</td>\n";
519
520 }
521
522 //the build and preview pages are always last
523 if(lastpage == numsteps) {
524 depositorbar += get_button (args,depositor_page, "green", "laststep", true);
525 } else {
526 depositorbar += get_button (args,depositor_page, "grey", "laststep", false);
527 }
528
529 text_t laststep_textt;
530 disp.expandstring("depositor", "_laststep_", laststep_textt);
531 if(laststep_textt == "bild") {
532 depositorbar += "<td>_icongreyarrow_</td>\n";
533 depositorbar += get_button (args,depositor_page, "grey", "view", false);
534 }
535 depositorbar += "</tr><tr>";
536
537 for(int j = 1; j <= 2*(stepnum-1); j++) {
538 depositorbar += "<td></td>";
539 }
540 depositorbar += "<td align=center>_icongreyuparrow_</td>\n";
541
542 depositorbar += "</tr></table>\n";
543
544 // set the javascript so that the metadata form can read the existing values
545 if (args["cachedMDValues"] != "") {
546 disp.setmacro("cachedmetadatavalues", "depositor", args["cachedMDValues"]);
547 }
548 if (args["metadataconf"] != "") {
549 disp.setmacro("metadataconf", "depositor", args["metadataconf"]);
550 }
551 }
552
553 if ((depositor_page == "bildcancel") || (depositor_page == "bildfail")) {
554
555 for(int i = 1; i <= numsteps; i++) {
556
557 text_t numstr(i);
558 depositorbar += get_button (args,depositor_page, "yellow", "step"+numstr, true);
559 depositorbar += "<td>_icongreyarrow_</td>\n";
560
561 }
562
563 //the build and preview pages are always last
564 depositorbar += get_button (args,depositor_page, "green", "laststep", true);
565 depositorbar += "<td>_icongreyarrow_</td>\n";
566 depositorbar += get_button (args,depositor_page, "grey", "view", false);
567
568 depositorbar += "</tr><tr>";
569
570 for(int j = 1; j <= 2*numsteps; j++) {
571 depositorbar += "<td></td>";
572 }
573 depositorbar += "<td align=center>_icongreyuparrow_</td>\n";
574
575 depositorbar += "</tr></table>\n";
576
577 }
578
579 if(depositor_page == "bilddone"){
580
581 for(int i = 1; i <= numsteps; i++) {
582
583 text_t numstr(i);
584 depositorbar += get_button (args, depositor_page, "grey", "step"+numstr, false);
585 depositorbar += "<td>_icongreyarrow_</td>\n";
586
587 }
588
589 //the build and preview pages are always last
590 depositorbar += get_button (args,depositor_page, "yellow", "laststep", false);
591 depositorbar += "<td>_icongreyarrow_</td>\n";
592 depositorbar += get_button (args,depositor_page, "green", "view", true);
593
594 depositorbar += "</tr><tr>";
595
596 for(int j = 1; j <= 2*numsteps; j++) {
597 depositorbar += "<td></td>";
598 }
599 depositorbar += "<td align=center>_icongreyuparrow_</td>\n";
600
601 depositorbar += "</tr></table>\n";
602 }
603 disp.setmacro ("depositorbar", "depositor", depositorbar);
604
605 if (depositor_page == "bildfail") {
606
607 text_t textfailmsg = "_textfailmsg";
608 textfailmsg.push_back(failcode);
609 textfailmsg.push_back('_');
610 disp.setmacro("textfailmsg", "depositor", textfailmsg);
611
612 text_t bldlog = filename_cat(gsdlhome, "tmp", args["di1tmp"], args["di1dirname"] + ".bld");
613 text_t rawlog = file_tail (bldlog, 6, 0);
614 // we'll shove in some <br> tags where \n's occur
615 text_t faillog;
616 text_t::const_iterator here = rawlog.begin();
617 text_t::const_iterator end = rawlog.end();
618 while (here != end) {
619 if (*here == '\n') faillog += "<br>";
620 faillog.push_back (*here);
621 ++here;
622 }
623 disp.setmacro ("faillog", "depositor", dm_safe(faillog));
624 }
625}
626
627
628//basic framework
629bool depositoraction::do_action (cgiargsclass &args, recptprotolistclass * /*protos*/,
630 browsermapclass * /*browsers*/, displayclass &disp,
631 outconvertclass &outconvert, ostream &textout,
632 ostream &logout) {
633 // make sure the depositor is enabled
634 if (disabled) {
635 textout << outconvert
636 << "<html>\n"
637 << "<head>\n"
638 << "<title>Depositor disabled</title>\n"
639 << "</head>\n"
640 << "<body bgcolor=\"#ffffff\" text=\"#000000\" link=\"#006666\" "
641 << "alink=\"#cc9900\" vlink=\"#666633\">\n"
642 << "<h2>Facility disabled</h2>\n"
643 << "Sorry, the Depositor end-user collecation update facility is currently disabled\n"
644 << "\n</body>\n"
645 << "</html>\n";
646 return true;
647 }
648
649 text_t &depositor_page = args["p"];
650 text_t &collection = args["di1dirname"];
651
652 // make sure we have perl (we won't bother with this check for the
653 // building status pages to avoid slowing things down unneccessarily)
654 if (depositor_page != "bildstatus" && depositor_page != "bildframe1" && !perl_ok(logout)) {
655 textout << outconvert
656 << "<html>\n"
657 << "<head>\n"
658 << "<title>Perl not found</title>\n"
659 << "</head>\n"
660 << "<body bgcolor=\"#ffffff\" text=\"#000000\" link=\"#006666\" "
661 << "alink=\"#cc9900\" vlink=\"#666633\">\n"
662 << "<h2>Perl not found</h2>\n"
663 << "Greenstone could not detect perl on this system. It is therefore not\n"
664 << "possible to build a Greenstone collection, either from the Collector or the \n"
665 << "command-line tools, or to use the Collector for any other task.\n"
666 << "<p>Please refer to the Greenstone Installer's Guide for details on\n"
667 << "installing perl on your system.\n"
668 << "\n</body>\n"
669 << "</html>\n";
670 return true;
671
672 }
673
674 text_t::const_iterator here = depositor_page.begin();
675 text_t::const_iterator end = depositor_page.end();
676 text_t stepstring = substr(here,here+4);
677
678 if ((depositor_page == "select") || (stepstring == "step")) {
679 textout << outconvert << disp << ("_depositor:header_\n")
680 << ("_depositor:" + depositor_page + "content_\n")
681 << ("_depositor:footer_\n");
682
683 }
684
685 if ((depositor_page == "bild") || (depositor_page == "depositonly")) {
686
687 text_t filename_textt = args["di1userfile"];
688 text_t timestamp_str = args["di1timestamp"];
689 //check to make sure a file was uploaded
690 //if more than one upload occurred, the last one is taken
691 if(filename_textt == "") {
692 textout << outconvert << disp << "<p> no file available</p>\n";
693 } else {
694
695 text_t col_dirname = filename_cat(collecthome,args[macro_prefix+"dirname"]);
696 text_t import_dirname = filename_cat(col_dirname,"import");
697 if(!directory_exists(import_dirname)) {
698 bool flag = mk_dir(import_dirname);
699 if(!flag) {
700 cerr << "Error: unable to make directory " << import_dirname << endl;
701 return true;
702 }
703 }
704
705 text_t dirname = filename_cat(import_dirname,timestamp_str);
706 bool flag = mk_dir(dirname);
707 if(!flag) {
708 cerr << "Error: unable to make timestamp directory " << dirname << endl;
709 return true;
710 }
711
712 text_t filename_textt = args["di1userfile"];
713 text_t tmpdir = filename_cat(gsdlhome,"tmp",args["di1tmp"],timestamp_str);
714 text_t tmpfile = filename_cat(tmpdir,filename_textt);
715 text_t filename = filename_cat(dirname, filename_textt);
716 if(!file_copy(tmpfile, filename)) {
717 cerr << "Unable to copy " << tmpfile << " to " << filename << endl;
718 }
719
720 //write the metadata file
721 write_metadata_file(args, filename_textt, timestamp_str);
722
723 if(depositor_page == "bild"){
724
725 //create a manifest file
726 write_manifest_file(args, filename_textt, timestamp_str);
727
728 // do the work (download, import, build)
729 gsdl_build (args, logout);
730
731 if (message.empty()) {
732 // bild page is a frameset so we don't want headers and stuff
733 textout << outconvert << disp << ("_depositor:bildcontent_\n");
734 }
735 }
736 }
737 }
738
739 if (message.empty()) {
740
741 if (depositor_page != "bild" && stepstring != "step" && depositor_page != "select") {
742 // output page ("bild" page was already output above)
743 textout << outconvert << disp << ("_depositor:header_\n")
744 << ("_depositor:" + depositor_page + "content_\n")
745 << ("_depositor:footer_\n");
746 }
747 } else {
748 // message was set somewhere (probably an error), output message page
749 textout << outconvert << disp << ("_depositor:header_\n")
750 << ("_depositor:" + message + "content_\n")
751 << ("_depositor:footer_\n");
752 message.clear();
753 }
754
755 return true;
756
757}
758
759
760//This function creates a metadata.xml file
761void depositoraction::write_metadata_file(cgiargsclass &args, text_t filename_str, text_t& timestamp_str)
762{
763
764 //build metadata file
765 //the front
766 text_t metadata_file = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
767 metadata_file += "<!DOCTYPE DirectoryMetadata SYSTEM \"http://greenstone.org/dtd/DirectoryMetadata/1.0/DirectoryMetadata.dtd\">\n";
768 metadata_file += "<DirectoryMetadata>\n";
769 metadata_file += " <FileSet>\n";
770 metadata_file += " <FileName>";
771
772 // Generate 'regular expression' save version of filename
773 // for now that means escaping any '.' characters
774 // consider generalising as function in gsdltools.h/cpp?
775
776 text_t filename_re;
777 text_t::const_iterator here = filename_str.begin();
778 text_t::const_iterator end = filename_str.end();
779 while (here != end) {
780 if (*here == '.') {
781 filename_re.push_back('\\');
782 }
783
784 filename_re.push_back(*here);
785 ++here;
786 }
787
788 metadata_file += filename_re;
789
790 metadata_file += "</FileName>\n";
791 metadata_file += " <Description>\n";
792
793
794 cgiargsclass::const_iterator args_here = args.begin();
795 cgiargsclass::const_iterator args_end = args.end();
796
797 while (args_here != args_end) {
798 text_t args_name = (*args_here).first;
799
800 int prefix_len = macro_prefix.size();
801
802 text_t args_prefix = substr(args_name.begin(),args_name.begin()+prefix_len+3);
803
804 if (args_prefix == (macro_prefix+"md.")) {
805 text_t args_val = args[args_name];
806
807 text_t args_suffix = substr(args_name.begin()+prefix_len+3,args_name.end());
808
809 text_tarray mdvalues;
810 splitchar (args_val.begin(), args_val.end(), ',', mdvalues);
811 int numvalues = mdvalues.size();
812
813 for (int i = 0; i < numvalues; ++i) {
814 if (!mdvalues[i].empty()) {
815
816 decode_cgi_arg(mdvalues[i]);
817
818 metadata_file += " <Metadata mode=\"accumulate\" name=\"";
819 metadata_file += args_suffix;
820 metadata_file += "\">";
821 metadata_file += mdvalues[i];
822 metadata_file += "</Metadata>\n";
823
824 }
825 }
826 }
827
828 ++args_here;
829 }
830
831 //the end of the file
832 metadata_file += " </Description>\n";
833 metadata_file += " </FileSet>\n";
834 metadata_file += "</DirectoryMetadata>\n";
835
836 //create metadata.xml file
837 text_t metadata_path = filename_cat(collecthome, args[macro_prefix+"dirname"], "import", timestamp_str, "metadata.xml");
838 text_t my_path = filename_cat(gsdlhome,"tmp", "metadata.xml");
839
840 ofstream metadata(metadata_path.getcstr());
841 ofstream my_tmp(my_path.getcstr());
842
843 if(!metadata.is_open()) {
844 cerr << "Cannot open metadata.xml!" << endl;
845 } else {
846
847 //write metadata.xml
848 metadata.write(metadata_file.getcstr(), metadata_file.size());
849 my_tmp.write(metadata_file.getcstr(), metadata_file.size());
850 }
851}
852
853//This function creates a manifest.xml file
854void depositoraction::write_manifest_file(cgiargsclass &args, text_t filename,
855 text_t& timestamp_str)
856{
857
858 //build manifest file
859
860 //the front
861 text_t manifest_file = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
862 manifest_file += "<Manifest>\n";
863 manifest_file += " <Import>\n";
864 manifest_file += " <Filename>\n";
865 manifest_file += " " + timestamp_str + "\n";
866 manifest_file += " </Filename>\n";
867
868 //the end of the file
869 manifest_file += " </Import>\n";
870 manifest_file += "</Manifest>\n";
871
872 //create manifest.xml file
873 text_t manifest_path = filename_cat(collecthome, args[macro_prefix+"dirname"], "manifest.xml");
874
875 char* manifest_cstr = manifest_path.getcstr();
876
877 ofstream manifest(manifest_cstr);
878
879 if(!manifest.is_open()) {
880 cerr << "Cannot open" << manifest_cstr << endl;
881 } else {
882
883 //write manifest.xml
884 char *manifest_file_cstr = manifest_file.getcstr();
885 manifest.write(manifest_file_cstr, manifest_file.size());
886 delete [] manifest_file_cstr;
887 }
888
889 delete [] manifest_cstr;
890}
891
892
893
894text_t depositoraction::get_button(cgiargsclass &args, const text_t &thispage,
895 const text_t &color,
896 const text_t &type, bool enabled)
897{
898
899 text_t::const_iterator here = type.begin();
900 text_t::const_iterator end = type.end();
901 text_t stepstring = substr(here,here+4);
902 if ((color != "green" && color != "grey" && color != "yellow") ||
903 (type != "select" && type != "laststep" && stepstring != "step" && type != "view"))
904 return g_EmptyText;
905
906 text_t href = "_http"+type+"_";
907 text_t target = "";
908
909 here = thispage.begin();
910 stepstring = substr(here,here+4);
911 if (thispage == "bildcancel" || thispage == "bildfail" || thispage == "select"|| stepstring == "step") {
912 // call the check submit macro instead of linking directly to the page
913
914 if(type == "laststep") {
915 href="\"javascript:check_submit('_"+type+"_');\"";
916 } else {
917 href="\"javascript:check_submit('"+type+"');\"";
918 }
919
920 } else if (type == "view") {
921 //target = " target=_top";
922 target = " target=_blank";
923 }
924
925 text_t tdclass = "wizardbar"+color;
926 if (enabled) {
927 // link to the appropriate page
928 return "<td class="+tdclass+"><a href="+href+target+">_text"+type+"_</a></td>";
929 }
930 else {
931 // just display the text
932 return "<td class="+tdclass+">_text"+type+"_</td>";
933 }
934}
935
936
937#endif //GSDL_USE_DEPOSITOR_ACTION
Note: See TracBrowser for help on using the repository browser.