source: main/trunk/greenstone2/runtime-src/src/recpt/depositoraction.cpp@ 30329

Last change on this file since 30329 was 30329, checked in by kjdon, 5 years ago

need to convert the text_t to utf8 before writing out the metadata.xml file

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