1 |
|
---|
2 | function GSAjaxAPI(gwcgi,collect)
|
---|
3 | {
|
---|
4 | var gwcgi_ = gwcgi;
|
---|
5 | var collect_ = collect;
|
---|
6 |
|
---|
7 |
|
---|
8 | this.fullDomainURL = function(localURL)
|
---|
9 | {
|
---|
10 | return window.location.protocol+'//'+window.location.host+localURL;
|
---|
11 | }
|
---|
12 |
|
---|
13 | this.apiURL = function(apiProg)
|
---|
14 | {
|
---|
15 | //get the location of the cgi program
|
---|
16 | splitpos = gwcgi_.lastIndexOf("/");
|
---|
17 |
|
---|
18 | var mdserver;
|
---|
19 | if (splitpos >= 0) {
|
---|
20 | mdserver = gwcgi.substring(0,(splitpos+1)) + apiProg;
|
---|
21 | }
|
---|
22 | else {
|
---|
23 | mdserver = apiProg;
|
---|
24 | }
|
---|
25 |
|
---|
26 | return mdserver;
|
---|
27 | }
|
---|
28 |
|
---|
29 | this.metadataserverURL = function()
|
---|
30 | {
|
---|
31 | return this.apiURL("metadata-server.pl");
|
---|
32 | }
|
---|
33 |
|
---|
34 | this.indexserverURL = function()
|
---|
35 | {
|
---|
36 | return this.apiURL("index-server.pl");
|
---|
37 | }
|
---|
38 |
|
---|
39 | this.buildserverURL = function()
|
---|
40 | {
|
---|
41 | return this.apiURL("build-server.pl");
|
---|
42 | }
|
---|
43 |
|
---|
44 | this.explodeserverURL = function()
|
---|
45 | {
|
---|
46 | return this.apiURL("explode-server.pl");
|
---|
47 | }
|
---|
48 |
|
---|
49 | this.myspaceserverURL = function()
|
---|
50 | {
|
---|
51 | return this.apiURL("myspace-server.pl");
|
---|
52 | }
|
---|
53 |
|
---|
54 |
|
---|
55 | this.urlGetAsync = function(url,callback)
|
---|
56 | {
|
---|
57 | var xmlHttp;
|
---|
58 | try {
|
---|
59 | // Firefox, Opera 8.0+, Safari
|
---|
60 | xmlHttp=new XMLHttpRequest();
|
---|
61 | }
|
---|
62 | catch (e) {
|
---|
63 | // Internet Explorer
|
---|
64 | try {
|
---|
65 | xmlHttp=new ActiveXObject("Msxml2.XMLHTTP");
|
---|
66 | }
|
---|
67 | catch (e) {
|
---|
68 | try {
|
---|
69 | xmlHttp=new ActiveXObject("Microsoft.XMLHTTP");
|
---|
70 | }
|
---|
71 | catch (e) {
|
---|
72 | alert("Your browser does not support AJAX!");
|
---|
73 | return false;
|
---|
74 | }
|
---|
75 | }
|
---|
76 | }
|
---|
77 |
|
---|
78 | var typeof_callback = typeof(callback);
|
---|
79 | if ((typeof_callback == "string") || (typeof_callback == "number") || (typeof_callback == "boolean")) {
|
---|
80 | var locid = callback;
|
---|
81 |
|
---|
82 | xmlHttp.onreadystatechange=function() {
|
---|
83 | if(xmlHttp.readyState==4) {
|
---|
84 | if (locelem != null) {
|
---|
85 | var locelem = document.getElementById(locid);
|
---|
86 |
|
---|
87 | locelem.innerHTML = xmlHttp.responseText;
|
---|
88 | }
|
---|
89 | }
|
---|
90 | }
|
---|
91 | }
|
---|
92 | else if (typeof_callback == "function") {
|
---|
93 | xmlHttp.onreadystatechange=function() {
|
---|
94 | if(xmlHttp.readyState==4) {
|
---|
95 | callback(xmlHttp);
|
---|
96 | }
|
---|
97 | }
|
---|
98 | }
|
---|
99 | else {
|
---|
100 | alert("Unrecognized type of callback value: " + typeof_callback);
|
---|
101 | }
|
---|
102 |
|
---|
103 | xmlHttp.open("GET",url,true);
|
---|
104 | xmlHttp.send(null);
|
---|
105 | }
|
---|
106 |
|
---|
107 |
|
---|
108 | this.urlGetSync = function(url)
|
---|
109 | {
|
---|
110 | // alert("url = " + url);
|
---|
111 |
|
---|
112 | var xmlHttp;
|
---|
113 | try {
|
---|
114 | // Firefox, Opera 8.0+, Safari
|
---|
115 | xmlHttp=new XMLHttpRequest();
|
---|
116 | }
|
---|
117 | catch (e) {
|
---|
118 | // Internet Explorer
|
---|
119 | try {
|
---|
120 | xmlHttp=new ActiveXObject("Msxml2.XMLHTTP");
|
---|
121 | }
|
---|
122 | catch (e) {
|
---|
123 | try {
|
---|
124 | xmlHttp=new ActiveXObject("Microsoft.XMLHTTP");
|
---|
125 | }
|
---|
126 | catch (e) {
|
---|
127 | alert("Your browser does not support AJAX!");
|
---|
128 | return false;
|
---|
129 | }
|
---|
130 | }
|
---|
131 | }
|
---|
132 |
|
---|
133 | xmlHttp.open("GET",url,false);
|
---|
134 | xmlHttp.send(null);
|
---|
135 |
|
---|
136 | // alert("response = '" + xmlHttp.responseText + "'");
|
---|
137 |
|
---|
138 | return xmlHttp.responseText;
|
---|
139 | }
|
---|
140 |
|
---|
141 | // New, an Ajax Synchronous Post method.
|
---|
142 | // http://www.degraeve.com/reference/simple-ajax-example.php
|
---|
143 | // Async vs Sync: http://www.w3schools.com/ajax/ajax_xmlhttprequest_send.asp
|
---|
144 | // Also:
|
---|
145 | // http://stackoverflow.com/questions/6312447/in-an-ajax-post-do-i-need-to-urlencode-parameters-before-sending
|
---|
146 | // http://api.jquery.com/jQuery.post/
|
---|
147 | // http://www.w3schools.com/ajax/ajax_xmlhttprequest_send.asp
|
---|
148 | this.urlPostSync = function(scriptURL, params) {
|
---|
149 | var xmlHttp=false;
|
---|
150 | try {
|
---|
151 | // Firefox, Opera 8.0+, Safari
|
---|
152 | xmlHttp=new XMLHttpRequest();
|
---|
153 | }
|
---|
154 | catch (e) {
|
---|
155 | // Internet Explorer
|
---|
156 | try {
|
---|
157 | xmlHttp=new ActiveXObject("Msxml2.XMLHTTP");
|
---|
158 | }
|
---|
159 | catch (e) {
|
---|
160 | try {
|
---|
161 | xmlHttp=new ActiveXObject("Microsoft.XMLHTTP");
|
---|
162 | }
|
---|
163 | catch (e) {
|
---|
164 | alert("Your browser does not support AJAX!");
|
---|
165 | return false;
|
---|
166 | }
|
---|
167 | }
|
---|
168 | }
|
---|
169 |
|
---|
170 | // e.g. scriptURL: /greenstone/cgi-bin/metadata-server.pl
|
---|
171 | xmlHttp.open('POST', scriptURL, false); // false means synchronous
|
---|
172 | xmlHttp.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
|
---|
173 |
|
---|
174 | // If asynchronous:
|
---|
175 | // xmlHttp.onreadystatechange = function() {
|
---|
176 | // if (xmlHttp.readyState == 4) {
|
---|
177 | // updatepage(xmlHttp.responseText);
|
---|
178 | // }
|
---|
179 | // }
|
---|
180 |
|
---|
181 | xmlHttp.send(params); // needs to be escaped/encoded
|
---|
182 |
|
---|
183 | //alert(xmlHttp.responseText); // if synchronous, process xmlHttp.responseText AFTER send() call
|
---|
184 | return xmlHttp.responseText;
|
---|
185 | }
|
---|
186 |
|
---|
187 | this.setLiveMetadata = function(id,metaname,metavalue)
|
---|
188 | {
|
---|
189 | var mdserver = this.metadataserverURL();
|
---|
190 |
|
---|
191 | var url = mdserver + "?a=set-live-metadata";
|
---|
192 | url += "&c="+collect_;
|
---|
193 | url += "&d="+id;
|
---|
194 | url += "&metaname=" + metaname;
|
---|
195 | url += "&metavalue=" + metavalue;
|
---|
196 |
|
---|
197 | this.urlGetSync(url);
|
---|
198 | }
|
---|
199 |
|
---|
200 | // New
|
---|
201 | // The where parameter can be specified as one or more of: import, archives, index, live
|
---|
202 | // separated by |. If null, it is assumed to be index which is the original default
|
---|
203 | // behaviour of calling set-metadata. E.g. where=import|archives|index
|
---|
204 | this.setMetadata = function(docid,metaname,metapos,metavalue,metamode,where)
|
---|
205 | {
|
---|
206 | var mdserver = this.metadataserverURL();
|
---|
207 |
|
---|
208 | var params = "a=set-metadata";
|
---|
209 | if(where != null) {
|
---|
210 | params += "&where=" + where; // if where not specified, meta-server will default to setting index meta
|
---|
211 | //} else {
|
---|
212 | // params += "&where=import|archives|index";
|
---|
213 | }
|
---|
214 | params += "&c="+collect_;
|
---|
215 | params += "&d="+docid;
|
---|
216 | params += "&metaname=" + metaname;
|
---|
217 | if (metapos!=null) {
|
---|
218 | params += "&metapos=" + metapos;
|
---|
219 | }
|
---|
220 | params += "&metavalue=" + metavalue;
|
---|
221 | if (metamode!=null) {
|
---|
222 | params += "&metamode=" + metamode;
|
---|
223 | }
|
---|
224 |
|
---|
225 | //this.urlGetSync(mdserver + "?" + params);
|
---|
226 | this.urlPostSync(mdserver,params);
|
---|
227 | }
|
---|
228 |
|
---|
229 | // New
|
---|
230 | // The where parameter can be specified as one or more of: import, archives, index, live
|
---|
231 | // separated by |. If null, it is assumed to be index which is the original default
|
---|
232 | // behaviour of calling set-metadata-array). E.g. where=import|archives|index
|
---|
233 | this.setMetadataArray = function(docArray,metamode,where)
|
---|
234 | {
|
---|
235 | docArrayJSON = JSON.stringify(docArray);
|
---|
236 |
|
---|
237 | var mdserver = this.metadataserverURL();
|
---|
238 |
|
---|
239 | var params = "a=" + escape("set-metadata-array"); //"a=set-metadata-array";
|
---|
240 | if(where != null) {
|
---|
241 | params += "&where=" + escape(where); // if where not specified, meta-server will default to setting index meta
|
---|
242 | //} else {
|
---|
243 | // params += "&where=import|archives|index";
|
---|
244 | }
|
---|
245 | params += "&c="+escape(collect_);
|
---|
246 | params += "&json="+escape(docArrayJSON);
|
---|
247 |
|
---|
248 | if (metamode!=null) {
|
---|
249 | params += "&metamode=" + escape(metamode);
|
---|
250 | }
|
---|
251 |
|
---|
252 | //this.urlGetSync(mdserver + "?" + params);
|
---|
253 | this.urlPostSync(mdserver,params);
|
---|
254 | }
|
---|
255 |
|
---|
256 | // New
|
---|
257 | this.getArchivesMetadata = function(docoid,metaname,metapos)
|
---|
258 | {
|
---|
259 | var mdserver = this.metadataserverURL();
|
---|
260 |
|
---|
261 | var url = mdserver + "?a=get-archives-metadata";
|
---|
262 | url += "&c="+collect_;
|
---|
263 | url += "&d="+docoid;
|
---|
264 | url += "&metaname=" + metaname;
|
---|
265 | if (metapos!=null) {
|
---|
266 | url += "&metapos=" + metapos;
|
---|
267 | }
|
---|
268 |
|
---|
269 | //alert("In getArchivesMeta. URL: " + url)
|
---|
270 | return this.urlGetSync(url); //Once this works, make it POST
|
---|
271 | }
|
---|
272 |
|
---|
273 | this.getMetadataArray = function(docArray,where)
|
---|
274 | {
|
---|
275 | docArrayJSON = JSON.stringify(docArray);
|
---|
276 |
|
---|
277 | var mdserver = this.metadataserverURL();
|
---|
278 |
|
---|
279 | var params = "a=" + escape("get-metadata-array"); //"a=set-metadata-array";
|
---|
280 | if(where != null) {
|
---|
281 | params += "&where=" + escape(where); // if where not specified, meta-server will default to setting index meta
|
---|
282 | //} else {
|
---|
283 | // params += "&where=import|archives|index";
|
---|
284 | }
|
---|
285 | params += "&c="+escape(collect_);
|
---|
286 | params += "&json="+escape(docArrayJSON);
|
---|
287 |
|
---|
288 | //this.urlGetSync(mdserver + "?" + params);
|
---|
289 | return this.urlPostSync(mdserver,params);
|
---|
290 | }
|
---|
291 |
|
---|
292 |
|
---|
293 | this._setMetadata = function(mode,docid,metaname,metapos,metavalue,metamode)
|
---|
294 | {
|
---|
295 | var mdserver = this.metadataserverURL();
|
---|
296 |
|
---|
297 | var params = "a=set" + mode + "-metadata";
|
---|
298 | params += "&c="+collect_;
|
---|
299 | params += "&d="+docid;
|
---|
300 | params += "&metaname=" + metaname;
|
---|
301 | if (metapos!=null) {
|
---|
302 | params += "&metapos=" + metapos;
|
---|
303 | }
|
---|
304 | params += "&metavalue=" + metavalue;
|
---|
305 | if (metamode!=null) {
|
---|
306 | params += "&metamode=" + metamode;
|
---|
307 | }
|
---|
308 |
|
---|
309 | this.urlGetSync(mdserver + "?" + params);
|
---|
310 | //this.urlPostSync(mdserver,params);
|
---|
311 | }
|
---|
312 |
|
---|
313 |
|
---|
314 | this._setDocumentArrayMetadata = function(mode,docArray,metamode)
|
---|
315 | {
|
---|
316 | docArrayJSON = JSON.stringify(docArray);
|
---|
317 |
|
---|
318 | var mdserver = this.metadataserverURL();
|
---|
319 |
|
---|
320 | var params = "a=set" + mode + "-metadata-array";
|
---|
321 | params += "&c="+collect_;
|
---|
322 | params += "&json="+docArrayJSON;
|
---|
323 |
|
---|
324 | if (metamode!=null) {
|
---|
325 | params += "&metamode=" + metamode;
|
---|
326 | }
|
---|
327 |
|
---|
328 | this.urlGetSync(mdserver + "?" + params);
|
---|
329 |
|
---|
330 | }
|
---|
331 |
|
---|
332 |
|
---|
333 | this.setDocumentMetadata = function(docid,metaname,metapos,metavalue)
|
---|
334 | {
|
---|
335 | // Allow for three param call to function, where metapos is missed out
|
---|
336 | if (metavalue==null) {
|
---|
337 | // 4 param case
|
---|
338 | metavalue = metapos;
|
---|
339 | metapos = null;
|
---|
340 | }
|
---|
341 |
|
---|
342 | this._setMetadata("",docid,metaname,metapos,metavalue);
|
---|
343 | this._setMetadata("-archives",docid,metaname,metapos,metavalue,"override");
|
---|
344 |
|
---|
345 | }
|
---|
346 |
|
---|
347 | this.setDocumentArrayMetadata = function(docArray,metamode)
|
---|
348 | {
|
---|
349 | //showDialog('Greenstone Javascript API','This sequence of changes has been commited into the system.','success', 2);
|
---|
350 |
|
---|
351 | this._setDocumentArrayMetadata("",docArray,metamode);
|
---|
352 | this._setDocumentArrayMetadata("-archives",docArray,metamode);
|
---|
353 | }
|
---|
354 |
|
---|
355 | this.setNewDocumentMetadata = function(docid,metaname,metavalue)
|
---|
356 | {
|
---|
357 | this._setMetadata("",docid,metaname,null,metavalue);
|
---|
358 | this._setMetadata("-archives",docid,metaname,null,metavalue,"accumulate");
|
---|
359 | }
|
---|
360 |
|
---|
361 | this.setImportMetadata = function(docid,metaname,metapos,metavalue)
|
---|
362 | {
|
---|
363 | this._setMetadata("-import",docid,metaname,metapos,metavalue,"override");
|
---|
364 | }
|
---|
365 |
|
---|
366 |
|
---|
367 | this.explodeDocument = function(docid)
|
---|
368 | {
|
---|
369 | var exserver = this.explodeserverURL();
|
---|
370 |
|
---|
371 | var url = exserver + "?a=explode-document";
|
---|
372 | url += "&c="+collect_;
|
---|
373 | url += "&d="+docid;
|
---|
374 |
|
---|
375 | this.urlGetSync(url);
|
---|
376 | }
|
---|
377 |
|
---|
378 | this.deleteDocument = function(docid,onlyAdd)
|
---|
379 | {
|
---|
380 | var exserver = this.explodeserverURL();
|
---|
381 |
|
---|
382 | var url = exserver + "?a=delete-document";
|
---|
383 | url += "&c="+collect_;
|
---|
384 | params += "&onlyadd="+onlyAdd;
|
---|
385 | url += "&d="+docid;
|
---|
386 |
|
---|
387 | this.urlGetSync(url);
|
---|
388 | }
|
---|
389 |
|
---|
390 | this.deleteDocumentArray = function(docArray,onlyAdd)
|
---|
391 | {
|
---|
392 | docArrayJSON = JSON.stringify(docArray);
|
---|
393 |
|
---|
394 | var exserver = this.explodeserverURL();
|
---|
395 |
|
---|
396 | var params = "a=delete-document-array";
|
---|
397 | params += "&c="+collect_;
|
---|
398 | params += "&onlyadd="+onlyAdd;
|
---|
399 | params += "&json="+docArrayJSON;
|
---|
400 |
|
---|
401 | this.urlGetSync(exserver + "?" + params);
|
---|
402 |
|
---|
403 | }
|
---|
404 |
|
---|
405 |
|
---|
406 | this.cloneDocument = function(docid,toCollect)
|
---|
407 | {
|
---|
408 | var msserver = this.myspaceserverURL();
|
---|
409 |
|
---|
410 | var url = msserver + "?a=clone";
|
---|
411 | url += "&c="+collect_;
|
---|
412 | url += "&d="+docid;
|
---|
413 | url += "&toCollect="+toCollect;
|
---|
414 |
|
---|
415 | this.urlGetSync(url);
|
---|
416 | }
|
---|
417 |
|
---|
418 | // consider name change to reindexDocument
|
---|
419 | this.documentReindex = function(docid)
|
---|
420 | {
|
---|
421 | var mdserver = this.metadataserverURL();
|
---|
422 |
|
---|
423 | var url = mdserver + "?a=reindex-document";
|
---|
424 | url += "&c="+collect_;
|
---|
425 | url += "&d="+docid;
|
---|
426 |
|
---|
427 | this.urlGetSync(url);
|
---|
428 | }
|
---|
429 |
|
---|
430 |
|
---|
431 | this.reindexCollection = function(mode,callback)
|
---|
432 | {
|
---|
433 | if (mode==null) {
|
---|
434 | mode = "incremental";
|
---|
435 | }
|
---|
436 |
|
---|
437 | var idserver = this.indexserverURL();
|
---|
438 |
|
---|
439 | var url = idserver + "?a=" + mode + "-rebuild";
|
---|
440 | url += "&c="+collect_;
|
---|
441 |
|
---|
442 | this.urlGetAsync(url,callback);
|
---|
443 | }
|
---|
444 |
|
---|
445 |
|
---|
446 | this.buildByManifestGeneral = function(hashargs)
|
---|
447 | {
|
---|
448 | var idserver = this.buildserverURL();
|
---|
449 |
|
---|
450 | var url = idserver + "?a=build-by-manifest";
|
---|
451 | url += "&c="+collect_;
|
---|
452 |
|
---|
453 | if (hashargs["index-files"] != undefined) {
|
---|
454 | url += "&index-files=" + JSON.stringify(hashargs["index-files"]);
|
---|
455 | }
|
---|
456 |
|
---|
457 | if (hashargs["reindex-files"] != undefined) {
|
---|
458 | url += "&reindex-files=" + JSON.stringify(hashargs["reindex-files"]);
|
---|
459 | }
|
---|
460 | if (hashargs["delete-OIDs"] != undefined) {
|
---|
461 | url += "&delete-OIDs=" + JSON.stringify(hashargs["delete-OIDs"]);
|
---|
462 | }
|
---|
463 |
|
---|
464 | this.urlGetSync(url);
|
---|
465 | }
|
---|
466 |
|
---|
467 | this.indexByManifest = function(docidArray)
|
---|
468 | {
|
---|
469 | var hashargs = {};
|
---|
470 | hashargs["index-files"] = docidArray;
|
---|
471 | this.buildByManifestGeneral(hashargs);
|
---|
472 | }
|
---|
473 |
|
---|
474 | this.reindexByManifest = function(docidArray)
|
---|
475 | {
|
---|
476 | var hashargs = {};
|
---|
477 | hashargs["reindex-files"] = docidArray;
|
---|
478 | this.buildByManifestGeneral(hashargs);
|
---|
479 | }
|
---|
480 | this.deleteByManifest = function(docidArray)
|
---|
481 | {
|
---|
482 | var hashargs = {};
|
---|
483 | hashargs["delete-OIDs"] = docidArray;
|
---|
484 | this.buildByManifestGeneral(hashargs);
|
---|
485 | }
|
---|
486 |
|
---|
487 | this.getLiveMetadata = function(id,metaname)
|
---|
488 | {
|
---|
489 | var mdserver = this.metadataserverURL();
|
---|
490 |
|
---|
491 | var url = mdserver + "?a=get-live-metadata";
|
---|
492 | url += "&c="+collect_;
|
---|
493 | url += "&d="+id;
|
---|
494 | url += "&metaname=" + metaname;
|
---|
495 |
|
---|
496 | var metavalue = this.urlGetSync(url);
|
---|
497 |
|
---|
498 | return metavalue;
|
---|
499 | }
|
---|
500 |
|
---|
501 | this.getDocumentMetadata = function(docoid,metaname,metapos)
|
---|
502 | {
|
---|
503 | var mdserver = this.metadataserverURL();
|
---|
504 |
|
---|
505 | var url = mdserver + "?a=get-metadata";
|
---|
506 | url += "&c="+collect_;
|
---|
507 | url += "&d="+docoid;
|
---|
508 | url += "&metaname=" + metaname;
|
---|
509 | if (metapos!=null) {
|
---|
510 | url += "&metapos=" + metapos;
|
---|
511 | }
|
---|
512 |
|
---|
513 | return this.urlGetSync(url);
|
---|
514 | }
|
---|
515 |
|
---|
516 | this.removeLiveMetadata = function(id,metaname)
|
---|
517 | {
|
---|
518 | var mdserver = this.metadataserverURL();
|
---|
519 |
|
---|
520 | var url = mdserver + "?a=remove-live-metadata";
|
---|
521 | url += "&c="+collect_;
|
---|
522 | url += "&d="+id;
|
---|
523 | url += "&metaname=" + metaname;
|
---|
524 |
|
---|
525 | this.urlGetSync(url);
|
---|
526 | }
|
---|
527 |
|
---|
528 | this.removeDocumentMetadata = function(docid,metaname,metapos)
|
---|
529 | {
|
---|
530 | var mdserver = this.metadataserverURL();
|
---|
531 |
|
---|
532 | var url = mdserver + "?a=remove-metadata";
|
---|
533 | url += "&c="+collect_;
|
---|
534 | url += "&d="+docid;
|
---|
535 | url += "&metaname=" + metaname;
|
---|
536 | if (metapos!=null) {
|
---|
537 | url += "&metapos=" + metapos;
|
---|
538 | }
|
---|
539 |
|
---|
540 | this.urlGetSync(url);
|
---|
541 | }
|
---|
542 |
|
---|
543 | return true;
|
---|
544 |
|
---|
545 | } |
---|