1 /* $Id: zserver.c,v 1.101 2003-01-13 10:56:09 oleg Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
40 static int bend_sort (void *handle, bend_sort_rr *rr);
41 static int bend_delete (void *handle, bend_delete_rr *rr);
42 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
43 static int bend_segment (void *handle, bend_segment_rr *rr);
44 static int bend_search (void *handle, bend_search_rr *r);
45 static int bend_fetch (void *handle, bend_fetch_rr *r);
46 static int bend_scan (void *handle, bend_scan_rr *r);
48 bend_initresult *bend_init (bend_initrequest *q)
50 bend_initresult *r = (bend_initresult *)
51 odr_malloc (q->stream, sizeof(*r));
53 struct statserv_options_block *sob;
59 q->bend_sort = bend_sort;
60 q->bend_delete = bend_delete;
61 q->bend_esrequest = bend_esrequest;
62 q->bend_segment = bend_segment;
63 q->bend_search = bend_search;
64 q->bend_fetch = bend_fetch;
65 q->bend_scan = bend_scan;
67 q->implementation_name = "Zebra Information Server";
68 q->implementation_version = "Zebra " ZEBRAVER;
70 logf (LOG_DEBUG, "bend_init");
72 sob = statserv_getcontrol ();
73 if (!(zh = zebra_open (sob->handle)))
75 yaz_log (LOG_WARN, "Failed to read config `%s'", sob->configname);
81 if (q->auth->which == Z_IdAuthentication_open)
83 char *openpass = xstrdup (q->auth->u.open);
84 char *cp = strchr (openpass, '/');
88 user = nmem_strdup (odr_getmem (q->stream), openpass);
89 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
94 if (zebra_auth (zh, user, passwd))
102 if (q->charneg_request) /* characater set and langauge negotiation? */
112 NMEM nmem = nmem_create ();
113 yaz_log (LOG_LOG, "character set and language negotiation");
115 yaz_get_proposal_charneg (nmem, q->charneg_request,
116 &charsets, &num_charsets,
117 &langs, &num_langs, &selected);
119 right_name = (char *)nmem_malloc(nmem, 32);
121 for (i = 0; i < num_charsets; i++)
126 * FIXME! It is like rudiment :-))
127 * We have to support this short names of character sets,
128 * because a lot servers in Russia to use own in during
129 * character set and language negotiation still.
132 if (!yaz_matchstr(charsets[i], "win")) {
133 strcpy(right_name, "WINDOWS-1251");
134 } else if (!yaz_matchstr(charsets[i], "koi")) {
135 strcpy(right_name, "KOI8-R");
136 } else if (!yaz_matchstr(charsets[i], "iso")) {
137 strcpy(right_name, "ISO-8859-5");
138 } else if (!yaz_matchstr(charsets[i], "dos")) {
139 strcpy(right_name, "CP866");
140 } else if (!yaz_matchstr(charsets[i], "uni")) {
141 strcpy(right_name, "UTF-8");
143 strcpy(right_name, charsets[i]);
146 logf (LOG_LOG, "charset %d %s (right name is %s)", i,
147 charsets[i], right_name);
149 if (odr_set_charset (q->decode, "UTF-8", right_name) == 0)
151 odr_set_charset (q->stream, right_name, "UTF-8");
153 zebra_record_encoding (zh, right_name);
154 q->charneg_response =
155 yaz_set_response_charneg (q->stream, right_name,
159 yaz_log(LOG_LOG, "odr_set_charset(): charset name %s unsupported",
168 static void search_terms (ZebraHandle zh, bend_search_rr *r)
174 struct Z_External *ext;
175 Z_SearchInfoReport *sr;
177 /* get no of terms for result set */
178 no_terms = zebra_resultSetTerms (zh, r->setname, 0, 0, 0, 0, 0);
182 r->search_info = odr_malloc (r->stream, sizeof(*r->search_info));
184 r->search_info->num_elements = 1;
185 r->search_info->list =
186 odr_malloc (r->stream, sizeof(*r->search_info->list));
187 r->search_info->list[0] =
188 odr_malloc (r->stream, sizeof(**r->search_info->list));
189 r->search_info->list[0]->category = 0;
190 r->search_info->list[0]->which = Z_OtherInfo_externallyDefinedInfo;
191 ext = odr_malloc (r->stream, sizeof(*ext));
192 r->search_info->list[0]->information.externallyDefinedInfo = ext;
193 ext->direct_reference =
194 yaz_oidval_to_z3950oid (r->stream, CLASS_USERINFO, VAL_SEARCHRES1);
195 ext->indirect_reference = 0;
197 ext->which = Z_External_searchResult1;
198 sr = odr_malloc (r->stream, sizeof(Z_SearchInfoReport));
199 ext->u.searchResult1 = sr;
201 sr->elements = odr_malloc (r->stream, sr->num *
202 sizeof(*sr->elements));
203 for (i = 0; i<no_terms; i++)
207 size_t len = sizeof(outbuf);
208 zebra_resultSetTerms (zh, r->setname, i,
209 &count, &type, outbuf, &len);
211 sr->elements[i] = odr_malloc (r->stream, sizeof(**sr->elements));
212 sr->elements[i]->subqueryId = 0;
213 sr->elements[i]->fullQuery = odr_malloc (r->stream,
215 *sr->elements[i]->fullQuery = 0;
216 sr->elements[i]->subqueryExpression =
217 odr_malloc (r->stream, sizeof(Z_QueryExpression));
218 sr->elements[i]->subqueryExpression->which =
219 Z_QueryExpression_term;
220 sr->elements[i]->subqueryExpression->u.term =
221 odr_malloc (r->stream, sizeof(Z_QueryExpressionTerm));
222 term = odr_malloc (r->stream, sizeof(Z_Term));
223 sr->elements[i]->subqueryExpression->u.term->queryTerm = term;
226 case Z_Term_characterString:
227 yaz_log (LOG_DEBUG, "term as characterString");
228 term->which = Z_Term_characterString;
229 term->u.characterString = odr_strdup (r->stream, outbuf);
232 yaz_log (LOG_DEBUG, "term as general");
233 term->which = Z_Term_general;
234 term->u.general = odr_malloc (r->stream, sizeof(*term->u.general));
235 term->u.general->size = term->u.general->len = len;
236 term->u.general->buf = odr_malloc (r->stream, len);
237 memcpy (term->u.general->buf, outbuf, len);
240 term->which = Z_Term_general;
241 term->u.null = odr_nullval();
243 sr->elements[i]->subqueryExpression->u.term->termComment = 0;
244 sr->elements[i]->subqueryInterpretation = 0;
245 sr->elements[i]->subqueryRecommendation = 0;
246 sr->elements[i]->subqueryCount = odr_intdup (r->stream, count);
247 sr->elements[i]->subqueryWeight = 0;
248 sr->elements[i]->resultsByDB = 0;
252 int bend_search (void *handle, bend_search_rr *r)
254 ZebraHandle zh = (ZebraHandle) handle;
260 if (zebra_select_databases (zh, r->num_bases,
261 (const char **) r->basenames))
263 zebra_result (zh, &r->errcode, &r->errstring);
266 logf (LOG_LOG, "ResultSet '%s'", r->setname);
267 switch (r->query->which)
269 case Z_Query_type_1: case Z_Query_type_101:
270 zebra_search_rpn (zh, r->decode, r->stream, r->query->u.type_1,
271 r->setname, &r->hits);
272 zebra_result (zh, &r->errcode, &r->errstring);
274 search_terms (zh, r);
278 r->errstring = "type-2";
287 int bend_fetch (void *handle, bend_fetch_rr *r)
289 ZebraHandle zh = (ZebraHandle) handle;
290 ZebraRetrievalRecord retrievalRecord;
292 retrievalRecord.position = r->number;
295 zebra_records_retrieve (zh, r->stream, r->setname, r->comp,
296 r->request_format, 1, &retrievalRecord);
297 zebra_result (zh, &r->errcode, &r->errstring);
298 /* non Surrogate Diagnostic OR Surrogate Diagnostic */
299 if (r->errcode == 0 && retrievalRecord.errCode)
301 r->surrogate_flag = 1;
302 r->errcode = retrievalRecord.errCode;
303 r->errstring = retrievalRecord.errString;
304 r->basename = retrievalRecord.base;
306 else if (r->errcode == 0) /* Database Record */
309 r->basename = retrievalRecord.base;
310 r->record = retrievalRecord.buf;
311 r->len = retrievalRecord.len;
312 r->output_format = retrievalRecord.format;
317 static int bend_scan (void *handle, bend_scan_rr *r)
319 ZebraScanEntry *entries;
320 ZebraHandle zh = (ZebraHandle) handle;
323 if (zebra_select_databases (zh, r->num_bases,
324 (const char **) r->basenames))
326 zebra_result (zh, &r->errcode, &r->errstring);
329 r->entries = (struct scan_entry *)
330 odr_malloc (r->stream, sizeof(*r->entries) * r->num_entries);
331 zebra_scan (zh, r->stream, r->term,
334 &r->num_entries, &entries, &is_partial);
336 r->status = BEND_SCAN_PARTIAL;
338 r->status = BEND_SCAN_SUCCESS;
339 for (i = 0; i < r->num_entries; i++)
341 r->entries[i].term = entries[i].term;
342 r->entries[i].occurrences = entries[i].occurrences;
344 zebra_result (zh, &r->errcode, &r->errstring);
348 void bend_close (void *handle)
350 zebra_close ((ZebraHandle) handle);
351 xmalloc_trav("bend_close");
355 int bend_sort (void *handle, bend_sort_rr *rr)
357 ZebraHandle zh = (ZebraHandle) handle;
359 zebra_sort (zh, rr->stream,
360 rr->num_input_setnames, (const char **) rr->input_setnames,
361 rr->output_setname, rr->sort_sequence, &rr->sort_status);
362 zebra_result (zh, &rr->errcode, &rr->errstring);
366 int bend_delete (void *handle, bend_delete_rr *rr)
368 ZebraHandle zh = (ZebraHandle) handle;
370 rr->delete_status = zebra_deleleResultSet(zh, rr->function,
371 rr->num_setnames, rr->setnames,
376 static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
378 switch (r->toKeep->which)
380 case Z_ESAdminOriginPartToKeep_reIndex:
381 yaz_log(LOG_LOG, "adm-reindex");
383 case Z_ESAdminOriginPartToKeep_truncate:
384 yaz_log(LOG_LOG, "adm-truncate");
386 case Z_ESAdminOriginPartToKeep_drop:
387 yaz_log(LOG_LOG, "adm-drop");
389 case Z_ESAdminOriginPartToKeep_create:
390 yaz_log(LOG_LOG, "adm-create %s", r->toKeep->databaseName);
391 zebra_admin_create (zh, r->toKeep->databaseName);
393 case Z_ESAdminOriginPartToKeep_import:
394 yaz_log(LOG_LOG, "adm-import");
395 zebra_admin_import_begin (zh, r->toKeep->databaseName,
396 r->toKeep->u.import->recordType);
398 case Z_ESAdminOriginPartToKeep_refresh:
399 yaz_log(LOG_LOG, "adm-refresh");
401 case Z_ESAdminOriginPartToKeep_commit:
402 yaz_log(LOG_LOG, "adm-commit");
404 case Z_ESAdminOriginPartToKeep_shutdown:
405 yaz_log(LOG_LOG, "shutdown");
406 zebra_admin_shutdown(zh);
408 case Z_ESAdminOriginPartToKeep_start:
409 yaz_log(LOG_LOG, "start");
410 zebra_admin_start(zh);
413 yaz_log(LOG_LOG, "unknown admin");
415 if (r->toKeep->databaseName)
417 yaz_log(LOG_LOG, "database %s", r->toKeep->databaseName);
422 static int es_admin (ZebraHandle zh, Z_Admin *r)
426 case Z_Admin_esRequest:
427 es_admin_request (zh, r->u.esRequest);
429 case Z_Admin_taskPackage:
430 yaz_log (LOG_LOG, "adm taskpackage (unhandled)");
439 int bend_segment (void *handle, bend_segment_rr *rr)
441 ZebraHandle zh = (ZebraHandle) handle;
442 Z_Segment *segment = rr->segment;
444 if (segment->num_segmentRecords)
445 zebra_admin_import_segment (zh, rr->segment);
447 zebra_admin_import_end (zh);
451 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
453 ZebraHandle zh = (ZebraHandle) handle;
455 yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
456 if (rr->esr->packageName)
457 yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
458 yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
460 if (!rr->esr->taskSpecificParameters)
462 yaz_log (LOG_WARN, "No task specific parameters");
464 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
466 es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
468 zebra_result (zh, &rr->errcode, &rr->errstring);
470 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
472 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
473 yaz_log (LOG_LOG, "Received DB Update");
474 if (up->which == Z_IUUpdate_esRequest)
476 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
477 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
478 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
480 yaz_log (LOG_LOG, "action");
483 switch (*toKeep->action)
485 case Z_IUOriginPartToKeep_recordInsert:
486 yaz_log (LOG_LOG, "recordInsert");
488 case Z_IUOriginPartToKeep_recordReplace:
489 yaz_log (LOG_LOG, "recordUpdate");
491 case Z_IUOriginPartToKeep_recordDelete:
492 yaz_log (LOG_LOG, "recordDelete");
494 case Z_IUOriginPartToKeep_elementUpdate:
495 yaz_log (LOG_LOG, "elementUpdate");
497 case Z_IUOriginPartToKeep_specialUpdate:
498 yaz_log (LOG_LOG, "specialUpdate");
500 case Z_ESAdminOriginPartToKeep_shutdown:
501 yaz_log (LOG_LOG, "shutDown");
503 case Z_ESAdminOriginPartToKeep_start:
504 yaz_log (LOG_LOG, "start");
507 yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
510 if (toKeep->databaseName)
512 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
514 if (zebra_select_database(zh, toKeep->databaseName))
519 yaz_log (LOG_WARN, "no database supplied for ES Update");
521 rr->errstring = "database";
527 zebra_begin_trans (zh);
528 for (i = 0; i < notToKeep->num; i++)
530 Z_External *rec = notToKeep->elements[i]->record;
531 struct oident *oident = 0;
532 Odr_oct *recid = notToKeep->elements[i]->u.opaque;
537 rr->errstring = "record Id not supplied";
540 if (notToKeep->elements[i]->which !=
541 Z_IUSuppliedRecords_elem_opaque)
544 rr->errstring = "only opaque record ID supported";
548 if (rec->direct_reference)
550 oident = oid_getentbyoid(rec->direct_reference);
552 yaz_log (LOG_LOG, "record %d type %s", i,
557 case Z_External_sutrs:
558 if (rec->u.octet_aligned->len > 170)
559 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
563 yaz_log (LOG_LOG, "%d bytes:\n%s",
567 case Z_External_octet:
568 if (rec->u.octet_aligned->len > 170)
569 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
570 rec->u.octet_aligned->len,
571 rec->u.octet_aligned->buf);
573 yaz_log (LOG_LOG, "%d bytes\n%s",
574 rec->u.octet_aligned->len,
575 rec->u.octet_aligned->buf);
577 if (oident && oident->value != VAL_TEXT_XML)
580 rr->errstring = "only XML update supported";
583 if (rec->which == Z_External_octet)
587 if (*toKeep->action ==
588 Z_IUOriginPartToKeep_recordInsert)
590 if (*toKeep->action ==
591 Z_IUOriginPartToKeep_recordReplace)
593 if (*toKeep->action ==
594 Z_IUOriginPartToKeep_recordDelete)
596 if (*toKeep->action ==
597 Z_IUOriginPartToKeep_specialUpdate)
603 rr->errstring = "unsupported ES Update action";
608 int r = zebra_admin_exchange_record (
609 zh, toKeep->databaseName,
610 rec->u.octet_aligned->buf,
611 rec->u.octet_aligned->len,
612 recid->buf, recid->len,
614 if (r && *toKeep->action ==
615 Z_IUOriginPartToKeep_specialUpdate)
617 r = zebra_admin_exchange_record (
618 zh, toKeep->databaseName,
619 rec->u.octet_aligned->buf,
620 rec->u.octet_aligned->len,
621 recid->buf, recid->len,
627 rr->errstring = "record exchange failed";
633 zebra_end_trans (zh);
639 yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
640 rr->esr->taskSpecificParameters->which);
647 static void bend_start (struct statserv_options_block *sob)
654 char *pidfile = "zebrasrv.pid";
655 int fd = creat (pidfile, 0666);
657 logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
662 sprintf (pidstr, "%ld", (long) getpid ());
663 write (fd, pidstr, strlen(pidstr));
669 zebra_stop((ZebraService) sob->handle);
670 sob->handle = zebra_start(sob->configname);
673 yaz_log (LOG_FATAL, "Failed to read config `%s'", sob->configname);
678 static void bend_stop(struct statserv_options_block *sob)
684 * Fixme! Why commets?, because the first chaild process to invoke bend_stop().
688 unlink ("zebrasrv.pid");
694 ZebraService service = sob->handle;
699 int main (int argc, char **argv)
701 struct statserv_options_block *sob;
703 sob = statserv_getcontrol ();
704 strcpy (sob->configname, "zebra.cfg");
705 sob->bend_start = bend_start;
706 sob->bend_stop = bend_stop;
708 strcpy (sob->service_display_name, "Zebra Server");
710 statserv_setcontrol (sob);
712 return statserv_main (argc, argv, bend_init, bend_close);