source: gsdl/trunk/runtime-src/src/oaiservr/listidsaction.cpp@ 16714

Last change on this file since 16714 was 16714, checked in by mdewsnip, 16 years ago

Minor comment change.

  • Property svn:keywords set to Author Date Id Revision
File size: 6.8 KB
Line 
1#include "listidsaction.h"
2#include "recptprototools.h"
3#include "oaitools.h"
4
5//--------------------------------------------------------------------------------------------------
6
7bool listidsaction::validateAction(recptproto *protocol, oaiargs &params)
8{
9 // ----------------------------------------------------------------------------
10 // 1. Check for invalid arguments
11 // ----------------------------------------------------------------------------
12 bool invalid_argument_supplied = false;
13 text_tmap::const_iterator param_iterator = params.begin();
14 while (param_iterator != params.end())
15 {
16 // Check for arguments that aren't valid for this action
17 if (param_iterator->first != "verb" &&
18 param_iterator->first != "from" &&
19 param_iterator->first != "until" &&
20 param_iterator->first != "set" &&
21 param_iterator->first != "resumptionToken" &&
22 param_iterator->first != "metadataPrefix")
23 {
24 // We've found an invalid argument
25 invalid_argument_supplied = true;
26
27 // Delete the invalid argument from the list so it doesn't end up in the <request> tag that is returned
28 params.erase(param_iterator->first);
29 }
30
31 // The metadataPrefix argument is not allowed in OAI v1.1
32 else if (param_iterator->first == "metadataPrefix" && this->configuration->getOAIVersion() <= 110)
33 {
34 // We've found an invalid argument
35 invalid_argument_supplied = true;
36
37 // Delete the invalid argument from the list so it doesn't end up in the <request> tag that is returned
38 params.erase(param_iterator->first);
39 }
40
41 param_iterator++;
42 }
43
44 // If we found an invalid argument it's an error, so don't go any further
45 if (invalid_argument_supplied)
46 {
47 this->errorType = "badArgument";
48 return false;
49 }
50
51 // ----------------------------------------------------------------------------
52 // 2. Handle any exclusive arguments
53 // ----------------------------------------------------------------------------
54
55 // The resumptionToken argument is exclusive
56 if (params["resumptionToken"] != "")
57 {
58 // This argument is exclusive, so no other arguments are allowed (except "verb" of course)
59 if (params.getSize() != 2)
60 {
61 this->errorType = "badArgument";
62 return false;
63 }
64
65 // Check the resumption token is valid
66 ResumptionToken token(params["resumptionToken"]);
67 if (token.isValid())
68 {
69 // Everything is fine, and we don't continue further because this is an exclusive argument
70 this->errorType = "";
71 return true;
72 }
73 else
74 {
75 // There was an error with the resumption token
76 this->errorType = "badResumptionToken";
77 return false;
78 }
79 }
80
81 // ----------------------------------------------------------------------------
82 // 3. Handle any required arguments
83 // ----------------------------------------------------------------------------
84
85 // OAI v2.0 requires metadataPrefix
86 if (this->configuration->getOAIVersion() > 110)
87 {
88 text_t metadataPrefix = params["metadataPrefix"];
89
90 // Check that the metadataPrefix argument exists
91 if (metadataPrefix == "")
92 {
93 this->errorType = "badArgument";
94 return false;
95 }
96 // Check that the metadataPrefix is a format we support
97 if (this->formatNotSupported(metadataPrefix))
98 {
99 this->errorType = "cannotDisseminateFormat";
100 return false;
101 }
102 }
103
104 // ----------------------------------------------------------------------------
105 // 4. Check any remaining arguments
106 // ----------------------------------------------------------------------------
107
108 // Check "from" and "until" arguments
109 if (params["from"] != "" || params["until"] != "")
110 {
111 text_t from = params["from"];
112 text_t until = params["until"];
113
114 // Check the from date is in the correct format: YYYY-MM-DD
115 if (from != "")
116 {
117 // Must be in the form YYYY-MM-DD
118 if (from.size() != 10 || from[4] != '-' || from[7] != '-')
119 {
120 this->errorType = "badArgument";
121 params.erase("from");
122 }
123 }
124 // Check the until date is in the correct format: YYYY-MM-DD
125 if (until != "")
126 {
127 // Must be in the form YYYY-MM-DD
128 if (until.size() != 10 || until[4] != '-' || until[7] != '-')
129 {
130 this->errorType = "badArgument";
131 params.erase("until");
132 }
133 }
134
135 if (this->errorType == "badArgument")
136 {
137 return false;
138 }
139
140 // If both arguments are supplied the from date must be less than or equal to the until date
141 if (from != "" && until != "" && !(from <= until))
142 {
143 this->errorType = "badArgument";
144 return false;
145 }
146 }
147
148 // Check "set" argument
149 if (params["set"] != "")
150 {
151 // Example set specification: "demo:CL2"
152 text_t set = params["set"];
153
154 // Extract the collection name from the set specification
155 text_t collection = "";
156 oaiclassifier::toGSDL(collection, set);
157
158 // Check that the collection is accessible
159 ColInfoResponse_t cinfo;
160 comerror_t err;
161 protocol->get_collectinfo(collection, cinfo, err, cerr);
162 if (err != noError)
163 {
164 this->errorType = "badArgument";
165 return false;
166 }
167
168 // Check the collection is one that is in the list in the oai.cfg file
169 text_tarray &collections = this->configuration->getCollectionsList();
170 bool collection_found = false;
171 for (int c = 0; c < collections.size(); c++)
172 {
173 if (collections[c] == collection)
174 {
175 collection_found = true;
176 break;
177 }
178 }
179
180 // The collection was not found
181 if (!collection_found)
182 {
183 this->errorType = "badArgument";
184 return false;
185 }
186
187 // Check the child set if it was given
188 if (set != "" && !this->check_classifier(protocol, collection, set))
189 {
190 this->errorType = "badArgument";
191 return false;
192 }
193 }
194
195 // If we've reached here everything must be fine
196 this->errorType = "";
197 return true;
198}
199
200//--------------------------------------------------------------------------------------------------
201
202bool listidsaction::output_document(ostream& output, recptproto *protocol, const text_t &collection,
203 const text_t &OID, const text_t &metadataPrefix /* ignored */)
204{
205 FilterResponse_t response;
206 ResultDocInfo_t doc_info;
207 text_tset metadata;
208 ofstream logout("oai.log", ios::app);
209 text_t lastModified;
210 int oaiVersion = this->configuration->getOAIVersion();
211
212 get_info(OID, collection, "", metadata, false, protocol, response, logout);
213 doc_info = response.docInfo[0];
214 this->getLastModifiedDate(doc_info, lastModified);
215
216 // output the record for this document
217 text_t oaiLabel = OID;
218 oaiclassifier::toOAI(collection, oaiLabel);
219
220 if(oaiVersion <= 110)
221 output << " <identifier>" << oaiLabel << "</identifier>\n";
222 else
223 this->output_record_header(output, oaiLabel, lastModified,
224 doc_info.metadata["memberof"].values, oaiVersion);
225
226 return true;
227}
Note: See TracBrowser for help on using the repository browser.