source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/collection/Collection.java@ 34019

Last change on this file since 34019 was 34019, checked in by kjdon, 4 years ago

replaced a couple of text strings
  • Property svn:keywords set to Author Date Id Revision
File size: 31.2 KB
Line 
1/*
2 * Collection.java
3 * Copyright (C) 2002 New Zealand Digital Library, http://www.nzdl.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19package org.greenstone.gsdl3.collection;
20
21import java.io.BufferedReader;
22import java.io.BufferedWriter;
23import java.io.File;
24import java.io.FileReader;
25import java.io.FileWriter;
26import java.io.IOException;
27import java.io.PrintWriter;
28import java.io.StringWriter;
29import java.util.ArrayList;
30import java.util.HashMap;
31
32import org.apache.commons.lang3.StringUtils;
33import org.apache.log4j.Logger;
34import org.greenstone.gsdl3.core.ModuleInterface;
35import org.greenstone.gsdl3.service.Authentication;
36import org.greenstone.gsdl3.util.CustomClassLoader;
37import org.greenstone.gsdl3.util.Dictionary;
38import org.greenstone.gsdl3.util.GSFile;
39import org.greenstone.gsdl3.util.GSXML;
40import org.greenstone.gsdl3.util.GSXSLT;
41import org.greenstone.gsdl3.util.OAIXML;
42import org.greenstone.gsdl3.util.SimpleMacroResolver;
43import org.greenstone.gsdl3.util.UserContext;
44import org.greenstone.gsdl3.util.XMLConverter;
45import org.greenstone.gsdl3.util.XMLTransformer;
46import org.w3c.dom.Document;
47import org.w3c.dom.Element;
48import org.w3c.dom.Node;
49import org.w3c.dom.NodeList;
50
51/**
52 * Represents a collection in Greenstone. A collection is an extension of a
53 * ServiceCluster - it has local data that the services use.
54 *
55 * @author Katherine Don
56 * @see ModuleInterface
57 */
58public class Collection extends ServiceCluster
59{
60
61 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.collection.Collection.class.getName());
62
63 /** is this collection being tidied and therefore can support realistic book view? */
64 protected boolean useBook = false;
65 /**
66 * is this collection public or private - public collections will
67 * appear on the home page, whereas private collections won't
68 */
69 protected boolean is_public = true;
70 /** collection type : mg, mgpp or lucene */
71 protected String col_type = "";
72 /** database type : gdbm, jdbm or sqlite */
73 protected String db_type = "";
74 /** time when this collection was built Used by RSS */
75 protected long lastmodified = 0;
76 /** earliestDatestamp of this collection. Used by RSS. No longer used as fallback by OAI */
77 protected long earliestDatestamp = 0;
78
79 /** Stores the default accessibility of guest users */
80 protected boolean _publicAccess = true;
81 /** Stores the scope of any security rules (either collection or document) */
82 protected boolean _securityScopeCollection = true;
83 protected String _humanVerify = null;
84 protected boolean _useRecaptcha = false; // for human verify
85 protected String _siteKey = null; // for recaptcha
86 protected String _secretKey = null; // for recaptcha
87
88 protected HashMap<String, ArrayList<Element>> _documentSets = new HashMap<String, ArrayList<Element>>();
89 protected ArrayList<HashMap<String, ArrayList<String>>> _securityExceptions = new ArrayList<HashMap<String, ArrayList<String>>>();
90
91 protected XMLTransformer transformer = null;
92
93 /** same as setClusterName */
94 public void setCollectionName(String name)
95 {
96 setClusterName(name);
97 }
98
99 public Collection()
100 {
101 super();
102 this.description = this.desc_doc.createElement(GSXML.COLLECTION_ELEM);
103 }
104
105 /**
106 * Configures the collection.
107 *
108 * gsdlHome and collectionName must be set before configure is called.
109 *
110 * the file buildcfg.xml is located in gsdlHome/collect/collectionName
111 * collection metadata is obtained, and services loaded.
112 *
113 * @return true/false on success/fail
114 */
115 public boolean configure()
116 {
117 if (this.site_home == null || this.cluster_name == null)
118 {
119 logger.error("Collection: site_home and collection_name must be set before configure called!");
120 return false;
121 }
122 // set up the class loader
123 this.class_loader = new CustomClassLoader(this.getClass().getClassLoader(), GSFile.collectionResourceDir(this.site_home, this.cluster_name));
124
125 macro_resolver.addMacro("_httpcollection_", this.site_http_address + "/collect/" + this.cluster_name);
126
127 Element coll_config_xml = loadCollConfigFile();
128 if (coll_config_xml == null) {
129 logger.error("Collection: couldn't configure collection: " + this.cluster_name + ", " + "Couldn't load collection config file");
130
131 return false;
132 }
133 Element build_config_xml = loadBuildConfigFile();
134
135 if (build_config_xml == null)
136 {
137 logger.error("Collection: couldn't configure collection: " + this.cluster_name + ", " + "Couldn't load build config file");
138
139 return false;
140 }
141
142 GSXSLT.modifyCollectionConfigForDebug(coll_config_xml);
143 // get the collection type attribute
144 Element search = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.SEARCH_ELEM);
145 if (search != null)
146 {
147 col_type = search.getAttribute(GSXML.TYPE_ATT);
148 }
149
150 Element browse = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.INFODB_ELEM);
151 if (browse != null)
152 {
153 db_type = browse.getAttribute(GSXML.TYPE_ATT);
154 }
155 else
156 {
157 db_type = "gdbm"; //Default database type
158 }
159
160 this.description.setAttribute(GSXML.TYPE_ATT, col_type);
161 this.description.setAttribute(GSXML.DB_TYPE_ATT, db_type);
162
163 _globalFormat = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.FORMAT_ELEM);
164 // process the metadata and display items and default library params
165 super.configureLocalData(coll_config_xml);
166 super.configureLocalData(build_config_xml);
167 // get extra collection specific stuff
168 findAndLoadInfo(coll_config_xml, build_config_xml);
169
170 loadSecurityInformation(coll_config_xml);
171
172 // do we have archives folder?
173 File archives_folder = new File(GSFile.collectionArchiveDir(this.site_home, this.cluster_name));
174 if (!archives_folder.exists()) {
175 this.description.setAttribute(GSXML.NO_ARCHIVES_ATT, "true");
176 }
177 // now do the services
178 configureServiceRacks(coll_config_xml, build_config_xml);
179
180 return true;
181
182 }
183
184 public boolean useBook()
185 {
186 return useBook;
187 }
188
189 public boolean isPublic()
190 {
191 return is_public;
192 }
193
194 // Used by RSSRetrieve. No longer used by OAI Receptionist (as second fallback)
195 public long getLastmodified()
196 {
197 return lastmodified;
198 }
199
200 // used by RSSRetrieve, no longer used as fallback by the OAIReceptionist
201 public long getEarliestDatestamp()
202 {
203 return earliestDatestamp;
204 }
205
206 /**
207 * load in the collection config file into a DOM Element
208 */
209 protected Element loadCollConfigFile()
210 {
211
212 File coll_config_file = new File(GSFile.collectionConfigFile(this.site_home, this.cluster_name));
213
214 if (!coll_config_file.exists())
215 {
216 return null;
217 }
218 // get the xml
219 Document coll_config_doc = this.converter.getDOM(coll_config_file, CONFIG_ENCODING);
220 Element coll_config_elem = null;
221 if (coll_config_doc != null)
222 {
223 coll_config_elem = coll_config_doc.getDocumentElement();
224 }
225 return coll_config_elem;
226
227 }
228
229 /**
230 * load in the collection build config file into a DOM Element
231 */
232 protected Element loadBuildConfigFile()
233 {
234 File build_config_file = new File(GSFile.collectionBuildConfigFile(this.site_home, this.cluster_name));
235 if (!build_config_file.exists())
236 {
237 logger.error("Collection: couldn't configure collection: " + this.cluster_name + ", " + build_config_file + " does not exist");
238 return null;
239 }
240 Document build_config_doc = this.converter.getDOM(build_config_file, CONFIG_ENCODING);
241 Element build_config_elem = null;
242 if (build_config_doc != null)
243 {
244 build_config_elem = build_config_doc.getDocumentElement();
245 }
246
247 lastmodified = build_config_file.lastModified();
248
249 return build_config_elem;
250 }
251
252 /**
253 * find the metadata and display elems from the two config files and add it
254 * to the appropriate lists
255 */
256 protected boolean findAndLoadInfo(Element coll_config_xml, Element build_config_xml)
257 {
258 addMetadata("httpPath", this.site_http_address + "/collect/" + this.cluster_name);
259
260
261 //check whether the html are tidy or not
262 Element import_list = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.IMPORT_ELEM);
263 if (import_list != null)
264 {
265 Element plugin_list = (Element) GSXML.getChildByTagName(import_list, GSXML.PLUGIN_ELEM + GSXML.LIST_MODIFIER);
266 //addPlugins(plugin_list);
267 if (plugin_list != null)
268 {
269 Element plugin_elem = (Element) GSXML.getNamedElement(plugin_list, GSXML.PLUGIN_ELEM, GSXML.NAME_ATT, "HTMLPlugin");
270 if (plugin_elem != null)
271 {
272 //get the option
273 Element option_elem = (Element) GSXML.getNamedElement(plugin_elem, GSXML.PARAM_OPTION_ELEM, GSXML.NAME_ATT, "-use_realistic_book");
274 if (option_elem != null)
275 {
276 useBook = true;
277 }
278 }
279 }
280 }
281 String tidy = (useBook == true ? "tidy" : "untidy");
282 addMetadata("tidyoption", tidy);
283
284
285 if (this.metadata_list != null)
286 {
287 // check whether we are public or not
288 Element meta_elem = (Element) GSXML.getNamedElement(this.metadata_list, GSXML.METADATA_ELEM, GSXML.NAME_ATT, "public");
289 if (meta_elem != null)
290 {
291 String value = GSXML.getValue(meta_elem).toLowerCase().trim();
292 if (value.equals("false"))
293 {
294 is_public = false;
295 }
296 }
297 // earliest datestamp is the time the collection was created.
298 meta_elem = (Element) GSXML.getNamedElement(this.metadata_list, GSXML.METADATA_ELEM, GSXML.NAME_ATT, OAIXML.EARLIEST_DATESTAMP);
299 if (meta_elem != null) {
300 String earliestDatestampStr = GSXML.getValue(meta_elem);
301 if (!earliestDatestampStr.equals("")) {
302 earliestDatestamp = Long.parseLong(earliestDatestampStr) * 1000; // stored in seconds, convert to milliseconds
303 }
304 }
305
306 }
307 return true;
308 }
309
310 protected void loadSecurityInformation(Element coll_config_xml)
311 {
312 Element securityBlock = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.SECURITY_ELEM);
313
314 if (securityBlock == null)
315 {
316 return;
317 }
318
319 String disabled = securityBlock.getAttribute(GSXML.DISABLED_ATT);
320 if (!disabled.equals("")) {
321 // security block has been disabled.
322 logger.warn("Security block has been disabled. Not implementing any security for collection "+this.cluster_name);
323 return;
324 }
325 String scope = securityBlock.getAttribute(GSXML.SCOPE_ATT);
326 String defaultAccess = securityBlock.getAttribute(GSXML.DEFAULT_ACCESS_ATT);
327
328 if (defaultAccess.toLowerCase().equals(GSXML.ACCESS_PUBLIC))
329 {
330 _publicAccess = true;
331 }
332 else if (defaultAccess.toLowerCase().equals(GSXML.ACCESS_PRIVATE))
333 {
334 _publicAccess = false;
335 }
336 else
337 {
338 logger.warn("Default access for collection " + this.cluster_name + " is neither public nor private, assuming public");
339 }
340
341 String humanVerify = securityBlock.getAttribute(GSXML.VERIFY_ATT);
342 if (!humanVerify.equals("") && !humanVerify.equals("false")) {
343 _humanVerify = humanVerify;
344 }
345
346 String useRecaptcha = securityBlock.getAttribute(GSXML.USE_RECAPTCHA_ATT);
347 if (useRecaptcha.equals("true")) {
348
349 Authentication authen_services =(Authentication) this.router.getModuleMap().get(Authentication.AUTHENTICATION_SERVICE);
350 if (authen_services != null) {
351 String siteKey = authen_services.getRecaptchaSiteKey();
352 String secretKey = authen_services.getRecaptchaSecretKey();
353
354 if (siteKey != null && secretKey != null) {
355 _useRecaptcha = true;
356 _siteKey = siteKey;
357 _secretKey = secretKey;
358 } else {
359 logger.warn("use_recaptcha was set to true, but couldn't find recaptcha site and secret keys from the siteConfig Authentication service. Setting use_recaptcha to false!");
360 }
361 }
362 }
363 if (scope.toLowerCase().equals(GSXML.SCOPE_COLLECTION))
364 {
365 _securityScopeCollection = true;
366 }
367 else if (scope.toLowerCase().equals(GSXML.SCOPE_DOCUMENT))
368 {
369 _securityScopeCollection = false;
370 }
371 else
372 {
373 logger.warn("Security scope is neither collection nor document, assuming collection");
374 }
375
376 NodeList exceptions = GSXML.getChildrenByTagName(securityBlock, GSXML.EXCEPTION_ELEM);
377
378 if (exceptions.getLength() > 0)
379 {
380 if (!_securityScopeCollection)
381 {
382 NodeList documentSetElems = GSXML.getChildrenByTagName(securityBlock, GSXML.DOCUMENT_SET_ELEM);
383 for (int i = 0; i < documentSetElems.getLength(); i++)
384 {
385 Element documentSet = (Element) documentSetElems.item(i);
386 String setName = documentSet.getAttribute(GSXML.NAME_ATT);
387 NodeList matchStatements = GSXML.getChildrenByTagName(documentSet, GSXML.MATCH_ELEM);
388 ArrayList<Element> matchStatementList = new ArrayList<Element>();
389 for (int j = 0; j < matchStatements.getLength(); j++)
390 {
391 matchStatementList.add((Element) matchStatements.item(j));
392 }
393 _documentSets.put(setName, matchStatementList);
394 }
395 }
396
397 for (int i = 0; i < exceptions.getLength(); i++)
398 {
399 HashMap<String, ArrayList<String>> securityException = new HashMap<String, ArrayList<String>>();
400 ArrayList<String> exceptionGroups = new ArrayList<String>();
401 ArrayList<String> exceptionSets = new ArrayList<String>();
402
403 Element exception = (Element) exceptions.item(i);
404 NodeList groups = GSXML.getChildrenByTagName(exception, GSXML.GROUP_ELEM);
405 for (int j = 0; j < groups.getLength(); j++)
406 {
407 Element group = (Element) groups.item(j);
408 String groupName = group.getAttribute(GSXML.NAME_ATT);
409 exceptionGroups.add(groupName);
410 }
411 NodeList docSets = GSXML.getChildrenByTagName(exception, GSXML.DOCUMENT_SET_ELEM);
412 for (int j = 0; j < docSets.getLength(); j++)
413 {
414 Element docSet = (Element) docSets.item(j);
415 String docSetName = docSet.getAttribute(GSXML.NAME_ATT);
416 exceptionSets.add(docSetName);
417 }
418 if (_securityScopeCollection) {
419 // we don't add in any exceptions that have document sets
420 if (!exceptionSets.isEmpty()) {
421 continue;
422 }
423 }
424 securityException.put("groups", exceptionGroups);
425 securityException.put("sets", exceptionSets);
426 _securityExceptions.add(securityException);
427 }
428 }
429 }
430
431 protected boolean configureServiceRacks(Element coll_config_xml, Element build_config_xml)
432 {
433 clearServices();
434 Element service_list = (Element) GSXML.getChildByTagName(build_config_xml, GSXML.SERVICE_CLASS_ELEM + GSXML.LIST_MODIFIER);
435 if (service_list != null)
436 {
437 configureServiceRackList(service_list, coll_config_xml);
438 }
439 // collection Config may also contain manually added service racks
440 service_list = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.SERVICE_CLASS_ELEM + GSXML.LIST_MODIFIER);
441 if (service_list != null)
442 {
443 configureServiceRackList(service_list, build_config_xml);
444 }
445 return true;
446 }
447
448 /**
449 * do a configure on only part of the collection
450 */
451 protected boolean configureSubset(String subset)
452 {
453
454 // need the coll config files
455 Element coll_config_elem = loadCollConfigFile();
456 Element build_config_elem = loadBuildConfigFile();
457 if (coll_config_elem == null || build_config_elem == null)
458 {
459 // wont be able to do any of the requests
460 return false;
461 }
462
463 if (subset.equals(GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER))
464 {
465 return configureServiceRacks(coll_config_elem, build_config_elem);
466 }
467
468 if (subset.equals(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER) || subset.equals(GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER) || subset.equals(GSXML.LIBRARY_PARAM_ELEM+GSXML.LIST_MODIFIER))
469 {
470 configureLocalData(coll_config_elem);
471 configureLocalData(build_config_elem);
472 return findAndLoadInfo(coll_config_elem, build_config_elem);
473
474 }
475
476 logger.error("Collection: cant process system request, configure " + subset);
477 return false;
478 }
479
480 /**
481 * handles requests made to the ServiceCluster itself
482 *
483 * @param req
484 * - the request Element- <request>
485 * @return the result Element - should be <response>
486 */
487 protected Element processMessage(Document result_doc, Element request)
488 {
489 String type = request.getAttribute(GSXML.TYPE_ATT);
490 if (type.equals(GSXML.REQUEST_TYPE_FORMAT_STRING))
491 {
492 return processFormatStringRequest(result_doc, request);
493 }
494 else if (type.equals(GSXML.REQUEST_TYPE_SECURITY))
495 {
496 return processSecurityRequest(result_doc, request);
497 }
498 else if (type.equals(GSXML.REQUEST_TYPE_FORMAT))
499 {
500
501 Element response = result_doc.createElement(GSXML.RESPONSE_ELEM);
502 response.setAttribute(GSXML.FROM_ATT, this.cluster_name);
503 response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_FORMAT);
504 if (_globalFormat != null)
505 {
506 response.appendChild(result_doc.importNode(_globalFormat, true));
507 }
508 return response;
509 }
510 // unknown type
511 return super.processMessage(result_doc, request);
512
513 }
514
515 protected Element processSecurityRequest(Document result_doc, Element request)
516 {
517 Element response = result_doc.createElement(GSXML.RESPONSE_ELEM);
518 response.setAttribute(GSXML.FROM_ATT, this.cluster_name);
519 response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_SECURITY);
520
521 if (_humanVerify != null) {
522 response.setAttribute(GSXML.VERIFY_ATT, _humanVerify);
523 if (_useRecaptcha) {
524 response.setAttribute(GSXML.SITE_KEY_ATT, _siteKey);
525 response.setAttribute(GSXML.SECRET_KEY_ATT, _secretKey);
526 }
527 }
528 String oid = request.getAttribute("oid");
529 if (oid.contains("."))
530 {
531 oid = oid.substring(0, oid.indexOf("."));
532 }
533
534 ArrayList<String> groups = getPermittedGroups(oid);
535
536 Element groupList = result_doc.createElement(GSXML.GROUP_ELEM + GSXML.LIST_MODIFIER);
537 response.appendChild(groupList);
538
539 for (String groupName : groups)
540 {
541 Element group = result_doc.createElement(GSXML.GROUP_ELEM);
542 groupList.appendChild(group);
543 group.setAttribute(GSXML.NAME_ATT, groupName);
544 }
545 return response;
546 }
547
548 protected ArrayList<String> getPermittedGroups(String oid)
549 {
550 ArrayList<String> groups = new ArrayList<String>();
551
552 if (_securityScopeCollection)
553 {
554 if (_publicAccess)
555 {
556 groups.add("");
557 }
558 else
559 {
560 for (HashMap<String, ArrayList<String>> exception : _securityExceptions)
561 {
562 for (String group : exception.get("groups"))
563 {
564 groups.add(group);
565 }
566 }
567 }
568 }
569 else
570 {
571 if (oid != null && !oid.equals(""))
572 {
573 boolean inSet = false;
574 for (HashMap<String, ArrayList<String>> exception : _securityExceptions) {
575
576 ArrayList<String> exceptionSets = exception.get("sets");
577 if (exceptionSets.size() == 0) {
578 inSet = true;
579 for (String group : exception.get("groups"))
580 {
581 groups.add(group);
582 }
583 }
584 else {
585 for (String setName : exception.get("sets"))
586 {
587 if (documentIsInSet(oid, setName))
588 {
589 inSet = true;
590 for (String group : exception.get("groups"))
591 {
592 groups.add(group);
593 }
594 break;
595 }
596 }
597 }
598 }
599
600
601
602 if (!inSet && _publicAccess)
603 {// our doc was not part of any exception, so it must be public
604 groups.add("");
605 }
606 }
607 else // if we are not doing a request with an oid, then free to access
608 {
609 groups.add("");
610 }
611 }
612
613 return groups;
614 }
615
616 protected boolean documentIsInSet(String oid, String setName)
617 {
618 ArrayList<Element> matchStatements = _documentSets.get(setName);
619 if (matchStatements == null || matchStatements.size() == 0)
620 {
621 return false;
622 }
623
624 for (Element currentMatchStatement : matchStatements)
625 {
626 String fieldName = currentMatchStatement.getAttribute(GSXML.FIELD_ATT);
627 if (fieldName == null || fieldName.equals(""))
628 {
629 fieldName = "oid";
630 }
631
632 String type = currentMatchStatement.getAttribute(GSXML.TYPE_ATT);
633 if (type == null || type.equals(""))
634 {
635 type = "match";
636 }
637
638 //String fieldValue = "";
639 String[] fieldValues = null;
640 if (!fieldName.equals("oid"))
641 {
642 //fieldValue = getFieldValue(oid, fieldName);
643 fieldValues = getFieldValues(oid, fieldName);
644 if (fieldValues == null)
645 {
646 return false;
647 }
648 }
649 else
650 {
651 //fieldValue = oid;
652 //fieldValues = new String[0];
653 //fieldValues[0] = oid;
654 fieldValues = new String[]{oid}; // not allowed to do fieldValues = {oid}; after SEPARATE declaration.
655 }
656
657 String matchValue = GSXML.getNodeText(currentMatchStatement);
658 if (type.equals("match"))
659 {
660
661 for(int i = 0; i < fieldValues.length; i++) {
662 String fieldValue = fieldValues[i];
663 if (matchValue.equals(fieldValue))
664 {
665 return true;
666 }
667 }
668 }
669 else if (type.equals("regex"))
670 {
671 for(int i = 0; i < fieldValues.length; i++) {
672 String fieldValue = fieldValues[i];
673 if (fieldValue.matches(matchValue))
674 {
675 return true;
676 }
677 }
678 }
679 else
680 {
681 logger.warn("Unknown type of match specified in security block of collection " + this.cluster_name + ".");
682 }
683 }
684
685 return false;
686 }
687
688 protected String old_getFieldValue(String oid, String fieldName)
689 {
690 Document msg_doc = XMLConverter.newDOM();
691 Element metadataMessage = msg_doc.createElement(GSXML.MESSAGE_ELEM);
692 Element metadataRequest = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_PROCESS, this.cluster_name + "/DocumentMetadataRetrieve", new UserContext());
693 metadataMessage.appendChild(metadataRequest);
694
695 Element paramList = msg_doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
696 metadataRequest.appendChild(paramList);
697
698 Element param = msg_doc.createElement(GSXML.PARAM_ELEM);
699 paramList.appendChild(param);
700
701 param.setAttribute(GSXML.NAME_ATT, "metadata");
702 param.setAttribute(GSXML.VALUE_ATT, fieldName);
703
704 Element docList = msg_doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
705 metadataRequest.appendChild(docList);
706
707 Element doc = msg_doc.createElement(GSXML.DOC_NODE_ELEM);
708 docList.appendChild(doc);
709
710 doc.setAttribute(GSXML.NODE_ID_ATT, oid);
711
712 Element response = (Element) this.router.process(metadataMessage);
713 NodeList metadataElems = response.getElementsByTagName(GSXML.METADATA_ELEM);
714
715 if (metadataElems.getLength() > 0)
716 {
717 Element metadata = (Element) metadataElems.item(0);
718 return GSXML.getNodeText(metadata);
719 }
720
721 return null;
722 }
723
724 protected String[] getFieldValues(String oid, String fieldName)
725 {
726 Document msg_doc = XMLConverter.newDOM();
727 Element metadataMessage = msg_doc.createElement(GSXML.MESSAGE_ELEM);
728 Element metadataRequest = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_PROCESS, this.cluster_name + "/DocumentMetadataRetrieve", new UserContext());
729 metadataMessage.appendChild(metadataRequest);
730
731 Element paramList = msg_doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
732 metadataRequest.appendChild(paramList);
733
734 Element param = msg_doc.createElement(GSXML.PARAM_ELEM);
735 paramList.appendChild(param);
736
737 param.setAttribute(GSXML.NAME_ATT, "metadata");
738 param.setAttribute(GSXML.VALUE_ATT, fieldName);
739
740 Element docList = msg_doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
741 metadataRequest.appendChild(docList);
742
743 Element doc = msg_doc.createElement(GSXML.DOC_NODE_ELEM);
744 docList.appendChild(doc);
745
746 doc.setAttribute(GSXML.NODE_ID_ATT, oid);
747
748 Element response = (Element) this.router.process(metadataMessage);
749 NodeList metadataElems = response.getElementsByTagName(GSXML.METADATA_ELEM);
750
751 if (metadataElems.getLength() <= 0) {
752 return null;
753 }
754 // else
755 String[] fieldValues = new String[metadataElems.getLength()];
756 for(int i = 0; i < metadataElems.getLength(); i++)
757 {
758 Element metadata = (Element) metadataElems.item(i);
759 fieldValues[i] = GSXML.getNodeText(metadata);
760 }
761
762 return fieldValues;
763
764 }
765
766 protected Element processFormatStringRequest(Document result_doc, Element request)
767 {
768 Element response = result_doc.createElement(GSXML.RESPONSE_ELEM);
769 response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_FORMAT_STRING);
770 response.setAttribute(GSXML.FROM_ATT, this.cluster_name);
771
772 String subaction = request.getAttribute("subaction");
773 String service = request.getAttribute("service");
774
775 String classifier = null;
776 if (service.equals("ClassifierBrowse"))
777 {
778 classifier = request.getAttribute("classifier");
779 }
780
781 // check for version file
782 String directory = new File(GSFile.collectionConfigFile(this.site_home, this.cluster_name)).getParent() + File.separator;
783
784 String version_filename = "";
785 if (service.equals("ClassifierBrowse"))
786 version_filename = directory + "browse_" + classifier + "_format_statement_version.txt";
787 else
788 version_filename = directory + "query_format_statement_version.txt";
789
790 File version_file = new File(version_filename);
791
792 if (subaction.equals("update"))
793 {
794 Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
795 //String format_string = GSXML.getNodeText(format_element);
796 Element format_statement = (Element) format_element.getFirstChild();
797
798 String version_number = "1";
799 BufferedWriter writer;
800
801 try
802 {
803
804 if (version_file.exists())
805 {
806 // Read version
807 BufferedReader reader = new BufferedReader(new FileReader(version_filename));
808 version_number = reader.readLine();
809 int aInt = Integer.parseInt(version_number) + 1;
810 version_number = Integer.toString(aInt);
811 reader.close();
812 }
813 else
814 {
815 // Create
816 version_file.createNewFile();
817 writer = new BufferedWriter(new FileWriter(version_filename));
818 writer.write(version_number);
819 writer.close();
820 }
821
822 // Write version file
823 String format_statement_filename = "";
824
825 if (service.equals("ClassifierBrowse"))
826 format_statement_filename = directory + "browse_" + classifier + "_format_statement_v" + version_number + ".txt";
827 else
828 format_statement_filename = directory + "query_format_statement_v" + version_number + ".txt";
829
830 // Write format statement
831 String format_string = this.converter.getString(format_statement); //GSXML.xmlNodeToString(format_statement);
832 writer = new BufferedWriter(new FileWriter(format_statement_filename));
833 writer.write(format_string);
834 writer.close();
835
836 // Update version number
837 writer = new BufferedWriter(new FileWriter(version_filename));
838 writer.write(version_number);
839 writer.close();
840
841 }
842 catch (IOException e)
843 {
844 logger.error("IO Exception " + e);
845 }
846 }
847
848 if (subaction.equals("saveDocument"))
849 {
850 Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
851 //String format_string = GSXML.getNodeText(format_element);
852 // Get display tag
853 Element display_format = (Element) format_element.getFirstChild();
854
855 String collection_config = directory + "collectionConfig.xml";
856 Document config = this.converter.getDOM(new File(collection_config), "UTF-8");
857
858 Node current_node = GSXML.getChildByTagName(config, "CollectionConfig");
859
860 // Get display child
861 if (GSXML.getChildByTagName(current_node, "display") == null)
862 {
863 // well then create a format tag
864 Element display_tag = config.createElement("display");
865 current_node = (Node) current_node.appendChild(display_tag);
866 }
867 else
868 {
869 current_node = GSXML.getChildByTagName(current_node, "display");
870 }
871
872 if (GSXML.getChildByTagName(current_node, "format") == null)
873 {
874 // well then create a format tag
875 Element format_tag = config.createElement("format");
876 current_node.appendChild(format_tag);
877 }
878
879 current_node.replaceChild(config.importNode(display_format, true), GSXML.getChildByTagName(current_node, "format"));
880
881 String new_config = this.converter.getString(config);
882
883 new_config = StringUtils.replace(new_config, "&lt;", "<");
884 new_config = StringUtils.replace(new_config, "&gt;", ">");
885 new_config = StringUtils.replace(new_config, "&quot;", "\"");
886
887 try
888 {
889 // Write to file (not original! for now)
890 BufferedWriter writer = new BufferedWriter(new FileWriter(collection_config + ".new"));
891 writer.write(new_config);
892 writer.close();
893 }
894 catch (IOException e)
895 {
896 logger.error("IO Exception " + e);
897 }
898 }
899
900 if (subaction.equals("save"))
901 {
902 Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
903 Element format_statement = (Element) format_element.getFirstChild();
904
905 try
906 {
907 // open collectionConfig.xml and read in to w3 Document
908 String collection_config = directory + "collectionConfig.xml";
909 Document config = this.converter.getDOM(new File(collection_config), "UTF-8");
910
911 //String tag_name = "";
912 int k;
913 int index;
914 Element elem;
915 Node current_node = GSXML.getChildByTagName(config, "CollectionConfig");
916 NodeList current_node_list;
917
918 if (service.equals("ClassifierBrowse"))
919 {
920 //tag_name = "browse";
921 // if CLX then need to look in <classifier> X then <format>
922 // default is <browse><format>
923
924 current_node = GSXML.getChildByTagName(current_node, "browse");
925
926 // find CLX
927 if (classifier != null)
928 {
929 current_node_list = GSXML.getChildrenByTagName(current_node, "classifier");
930 index = Integer.parseInt(classifier.substring(2)) - 1;
931
932 // index should be given by X-1
933 current_node = current_node_list.item(index);
934 // what if classifier does not have a format tag?
935 if (GSXML.getChildByTagName(current_node, "format") == null)
936 {
937 // well then create a format tag
938 Element format_tag = config.createElement("format");
939 current_node.appendChild(format_tag);
940 }
941 }
942 else
943 {
944 // To support all classifiers, set classifier to null? There is the chance here that the format tag does not exist
945 if (GSXML.getChildByTagName(current_node, "format") == null)
946 {
947 // well then create a format tag
948 Element format_tag = config.createElement("format");
949 current_node.appendChild(format_tag);
950 }
951 }
952 }
953 else if (service.equals("AllClassifierBrowse"))
954 {
955 current_node = GSXML.getChildByTagName(current_node, "browse");
956 if (GSXML.getChildByTagName(current_node, "format") == null)
957 {
958 // well then create a format tag
959 Element format_tag = config.createElement("format");
960 current_node.appendChild(format_tag);
961 }
962 }
963 else
964 {
965 // look in <format> with no attributes
966 current_node_list = GSXML.getChildrenByTagName(current_node, "search");
967 for (k = 0; k < current_node_list.getLength(); k++)
968 {
969 current_node = current_node_list.item(k);
970 // if current_node has no attributes then break
971 elem = (Element) current_node;
972 if (elem.hasAttribute("name") == false)
973 break;
974 }
975 }
976
977 current_node.replaceChild(config.importNode(format_statement, true), GSXML.getChildByTagName(current_node, "format"));
978
979 // Now convert config document to string for writing to file
980 String new_config = this.converter.getString(config);
981
982 new_config = StringUtils.replace(new_config, "&lt;", "<");
983 new_config = StringUtils.replace(new_config, "&gt;", ">");
984 new_config = StringUtils.replace(new_config, "&quot;", "\"");
985
986 // Write to file (not original! for now)
987 BufferedWriter writer = new BufferedWriter(new FileWriter(collection_config + ".new"));
988 writer.write(new_config);
989 writer.close();
990
991 }
992 catch (Exception ex)
993 {
994 logger.error("There was an exception " + ex);
995
996 StringWriter sw = new StringWriter();
997 PrintWriter pw = new PrintWriter(sw, true);
998 ex.printStackTrace(pw);
999 pw.flush();
1000 sw.flush();
1001 logger.error(sw.toString());
1002 }
1003
1004 }
1005
1006 return response;
1007 }
1008
1009
1010}
Note: See TracBrowser for help on using the repository browser.