1 /* $Id: zserver.c,v 1.131 2005-04-15 10:47:49 adam Exp $
2 Copyright (C) 1995-2005
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
30 #include <sys/locking.h>
38 #include <yaz/yaz-util.h>
40 #include <sys/types.h>
44 static int bend_sort (void *handle, bend_sort_rr *rr);
45 static int bend_delete (void *handle, bend_delete_rr *rr);
46 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
47 static int bend_segment (void *handle, bend_segment_rr *rr);
48 static int bend_search (void *handle, bend_search_rr *r);
49 static int bend_fetch (void *handle, bend_fetch_rr *r);
50 static int bend_scan (void *handle, bend_scan_rr *r);
52 bend_initresult *bend_init (bend_initrequest *q)
54 bend_initresult *r = (bend_initresult *)
55 odr_malloc (q->stream, sizeof(*r));
57 struct statserv_options_block *sob;
63 q->bend_sort = bend_sort;
64 q->bend_delete = bend_delete;
65 q->bend_esrequest = bend_esrequest;
66 q->bend_segment = bend_segment;
67 q->bend_search = bend_search;
68 q->bend_fetch = bend_fetch;
69 q->bend_scan = bend_scan;
71 q->implementation_name = "Zebra Information Server";
72 q->implementation_version = "Zebra " ZEBRAVER;
74 yaz_log (YLOG_DEBUG, "bend_init");
76 sob = statserv_getcontrol ();
77 if (!(zh = zebra_open (sob->handle)))
79 yaz_log (YLOG_WARN, "Failed to read config `%s'", sob->configname);
86 if (q->auth->which == Z_IdAuthentication_open)
88 char *openpass = xstrdup (q->auth->u.open);
89 char *cp = strchr (openpass, '/');
93 user = nmem_strdup (odr_getmem (q->stream), openpass);
94 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
98 else if (q->auth->which == Z_IdAuthentication_idPass)
100 Z_IdPass *idPass = q->auth->u.idPass;
102 user = idPass->userId;
103 passwd = idPass->password;
106 if (zebra_auth (zh, user, passwd))
112 if (q->charneg_request) /* characater set and langauge negotiation? */
120 NMEM nmem = nmem_create();
122 yaz_log (YLOG_LOG, "character set and language negotiation");
124 yaz_get_proposal_charneg (nmem, q->charneg_request,
125 &charsets, &num_charsets,
126 &langs, &num_langs, &selected);
128 for (i = 0; i < num_charsets; i++)
130 const char *right_name = "";
132 * FIXME! It is like rudiment :-))
133 * We have to support this short names of character sets,
134 * because a lot servers in Russia to use own in during
135 * character set and language negotiation still.
138 if (!yaz_matchstr(charsets[i], "win")) {
139 right_name = "WINDOWS-1251";
140 } else if (!yaz_matchstr(charsets[i], "koi")) {
141 right_name = "KOI8-R";
142 } else if (!yaz_matchstr(charsets[i], "iso")) {
143 right_name = "ISO-8859-5";
144 } else if (!yaz_matchstr(charsets[i], "dos")) {
145 right_name = "CP866";
146 } else if (!yaz_matchstr(charsets[i], "uni")) {
147 right_name = "UTF-8";
149 right_name = charsets[i];
151 if (odr_set_charset (q->decode, "UTF-8", right_name) == 0)
153 yaz_log (YLOG_LOG, "charset %d %s (proper name %s): OK", i,
154 charsets[i], right_name);
155 odr_set_charset (q->stream, right_name, "UTF-8");
157 zebra_record_encoding(zh, right_name);
158 zebra_octet_term_encoding(zh, right_name);
159 q->charneg_response =
160 yaz_set_response_charneg (q->stream, charsets[i],
164 yaz_log (YLOG_LOG, "charset %d %s (proper name %s): unsupported", i,
165 charsets[i], right_name);
173 static void search_terms (ZebraHandle zh, bend_search_rr *r)
178 int type = Z_Term_general;
179 struct Z_External *ext;
180 Z_SearchInfoReport *sr;
182 /* get no of terms for result set */
183 no_terms = 0; /* zebra_resultSetTerms (zh, r->setname, 0, 0, 0, 0, 0); */
184 /* FIXME - Rsets don't know number of terms no more ??? */
188 r->search_info = odr_malloc (r->stream, sizeof(*r->search_info));
190 r->search_info->num_elements = 1;
191 r->search_info->list =
192 odr_malloc (r->stream, sizeof(*r->search_info->list));
193 r->search_info->list[0] =
194 odr_malloc (r->stream, sizeof(**r->search_info->list));
195 r->search_info->list[0]->category = 0;
196 r->search_info->list[0]->which = Z_OtherInfo_externallyDefinedInfo;
197 ext = odr_malloc (r->stream, sizeof(*ext));
198 r->search_info->list[0]->information.externallyDefinedInfo = ext;
199 ext->direct_reference =
200 yaz_oidval_to_z3950oid (r->stream, CLASS_USERINFO, VAL_SEARCHRES1);
201 ext->indirect_reference = 0;
203 ext->which = Z_External_searchResult1;
204 sr = odr_malloc (r->stream, sizeof(Z_SearchInfoReport));
205 ext->u.searchResult1 = sr;
207 sr->elements = odr_malloc (r->stream, sr->num *
208 sizeof(*sr->elements));
209 for (i = 0; i<no_terms; i++)
213 size_t len = sizeof(outbuf);
214 /* FIXME - Can we just skip this ??? */
216 zebra_resultSetTerms (zh, r->setname, i,
217 &count, &type, outbuf, &len);
219 sr->elements[i] = odr_malloc (r->stream, sizeof(**sr->elements));
220 sr->elements[i]->subqueryId = 0;
221 sr->elements[i]->fullQuery = odr_malloc (r->stream,
223 *sr->elements[i]->fullQuery = 0;
224 sr->elements[i]->subqueryExpression =
225 odr_malloc (r->stream, sizeof(Z_QueryExpression));
226 sr->elements[i]->subqueryExpression->which =
227 Z_QueryExpression_term;
228 sr->elements[i]->subqueryExpression->u.term =
229 odr_malloc (r->stream, sizeof(Z_QueryExpressionTerm));
230 term = odr_malloc (r->stream, sizeof(Z_Term));
231 sr->elements[i]->subqueryExpression->u.term->queryTerm = term;
234 case Z_Term_characterString:
235 yaz_log (YLOG_DEBUG, "term as characterString");
236 term->which = Z_Term_characterString;
237 term->u.characterString = odr_strdup (r->stream, outbuf);
240 yaz_log (YLOG_DEBUG, "term as general");
241 term->which = Z_Term_general;
242 term->u.general = odr_malloc (r->stream, sizeof(*term->u.general));
243 term->u.general->size = term->u.general->len = len;
244 term->u.general->buf = odr_malloc (r->stream, len);
245 memcpy (term->u.general->buf, outbuf, len);
248 term->which = Z_Term_general;
249 term->u.null = odr_nullval();
251 sr->elements[i]->subqueryExpression->u.term->termComment = 0;
252 sr->elements[i]->subqueryInterpretation = 0;
253 sr->elements[i]->subqueryRecommendation = 0;
254 if (count > 2000000000)
256 sr->elements[i]->subqueryCount = odr_intdup (r->stream, (int) count);
257 sr->elements[i]->subqueryWeight = 0;
258 sr->elements[i]->resultsByDB = 0;
262 int bend_search (void *handle, bend_search_rr *r)
264 ZebraHandle zh = (ZebraHandle) handle;
272 if (zebra_select_databases (zh, r->num_bases,
273 (const char **) r->basenames))
275 zebra_result (zh, &r->errcode, &r->errstring);
278 yaz_log (YLOG_DEBUG, "ResultSet '%s'", r->setname);
279 switch (r->query->which)
281 case Z_Query_type_1: case Z_Query_type_101:
282 res = zebra_search_RPN (zh, r->stream, r->query->u.type_1,
284 if (zebra_errCode(zh) == 0)
286 if (zhits > 2147483646)
287 r->hits = 2147483647;
289 r->hits = (int) zhits;
290 search_terms (zh, r);
293 zebra_result (zh, &r->errcode, &r->errstring);
297 r->errstring = "type-2";
306 int bend_fetch (void *handle, bend_fetch_rr *r)
308 ZebraHandle zh = (ZebraHandle) handle;
309 ZebraRetrievalRecord retrievalRecord;
311 retrievalRecord.position = r->number;
314 zebra_records_retrieve (zh, r->stream, r->setname, r->comp,
315 r->request_format, 1, &retrievalRecord);
316 zebra_result (zh, &r->errcode, &r->errstring);
317 /* non Surrogate Diagnostic OR Surrogate Diagnostic */
318 if (r->errcode == 0 && retrievalRecord.errCode)
320 r->surrogate_flag = 1;
321 r->errcode = retrievalRecord.errCode;
322 r->errstring = retrievalRecord.errString;
323 r->basename = retrievalRecord.base;
325 else if (r->errcode == 0) /* Database Record */
328 r->basename = retrievalRecord.base;
329 r->record = retrievalRecord.buf;
330 r->len = retrievalRecord.len;
331 r->output_format = retrievalRecord.format;
336 static int bend_scan (void *handle, bend_scan_rr *r)
338 ZebraScanEntry *entries;
339 ZebraHandle zh = (ZebraHandle) handle;
342 if (zebra_select_databases (zh, r->num_bases,
343 (const char **) r->basenames))
345 zebra_result (zh, &r->errcode, &r->errstring);
348 if (r->step_size != 0 && *r->step_size != 0) {
349 r->errcode = 205; /* "Only zero step size supported for Scan" */
353 r->entries = (struct scan_entry *)
354 odr_malloc (r->stream, sizeof(*r->entries) * r->num_entries);
355 zebra_scan (zh, r->stream, r->term,
358 &r->num_entries, &entries, &is_partial);
360 r->status = BEND_SCAN_PARTIAL;
362 r->status = BEND_SCAN_SUCCESS;
363 for (i = 0; i < r->num_entries; i++)
365 r->entries[i].term = entries[i].term;
366 r->entries[i].occurrences = entries[i].occurrences;
368 zebra_result (zh, &r->errcode, &r->errstring);
372 void bend_close (void *handle)
374 zebra_close ((ZebraHandle) handle);
375 xmalloc_trav("bend_close");
379 int bend_sort (void *handle, bend_sort_rr *rr)
381 ZebraHandle zh = (ZebraHandle) handle;
383 zebra_sort (zh, rr->stream,
384 rr->num_input_setnames, (const char **) rr->input_setnames,
385 rr->output_setname, rr->sort_sequence, &rr->sort_status);
386 zebra_result (zh, &rr->errcode, &rr->errstring);
390 int bend_delete (void *handle, bend_delete_rr *rr)
392 ZebraHandle zh = (ZebraHandle) handle;
394 rr->delete_status = zebra_deleteResultSet(zh, rr->function,
395 rr->num_setnames, rr->setnames,
400 static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
402 if (r->toKeep->databaseName)
404 yaz_log(YLOG_LOG, "adm request database %s", r->toKeep->databaseName);
406 switch (r->toKeep->which)
408 case Z_ESAdminOriginPartToKeep_reIndex:
409 yaz_log(YLOG_LOG, "adm-reindex");
411 case Z_ESAdminOriginPartToKeep_truncate:
412 yaz_log(YLOG_LOG, "adm-truncate");
414 case Z_ESAdminOriginPartToKeep_drop:
415 yaz_log(YLOG_LOG, "adm-drop");
416 zebra_drop_database (zh, r->toKeep->databaseName);
418 case Z_ESAdminOriginPartToKeep_create:
419 yaz_log(YLOG_LOG, "adm-create %s", r->toKeep->databaseName);
420 zebra_create_database (zh, r->toKeep->databaseName);
422 case Z_ESAdminOriginPartToKeep_import:
423 yaz_log(YLOG_LOG, "adm-import");
424 zebra_admin_import_begin (zh, r->toKeep->databaseName,
425 r->toKeep->u.import->recordType);
427 case Z_ESAdminOriginPartToKeep_refresh:
428 yaz_log(YLOG_LOG, "adm-refresh");
430 case Z_ESAdminOriginPartToKeep_commit:
431 yaz_log(YLOG_LOG, "adm-commit");
432 if (r->toKeep->databaseName)
433 zebra_select_database(zh, r->toKeep->databaseName);
436 case Z_ESAdminOriginPartToKeep_shutdown:
437 yaz_log(YLOG_LOG, "shutdown");
438 zebra_admin_shutdown(zh);
440 case Z_ESAdminOriginPartToKeep_start:
441 yaz_log(YLOG_LOG, "start");
442 zebra_admin_start(zh);
445 yaz_log(YLOG_LOG, "unknown admin");
450 static int es_admin (ZebraHandle zh, Z_Admin *r)
454 case Z_Admin_esRequest:
455 es_admin_request (zh, r->u.esRequest);
457 case Z_Admin_taskPackage:
458 yaz_log (YLOG_LOG, "adm taskpackage (unhandled)");
467 int bend_segment (void *handle, bend_segment_rr *rr)
469 ZebraHandle zh = (ZebraHandle) handle;
470 Z_Segment *segment = rr->segment;
472 if (segment->num_segmentRecords)
473 zebra_admin_import_segment (zh, rr->segment);
475 zebra_admin_import_end (zh);
479 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
481 ZebraHandle zh = (ZebraHandle) handle;
483 yaz_log(YLOG_LOG, "function: %d", *rr->esr->function);
484 if (rr->esr->packageName)
485 yaz_log(YLOG_LOG, "packagename: %s", rr->esr->packageName);
486 yaz_log(YLOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
488 if (!rr->esr->taskSpecificParameters)
490 yaz_log (YLOG_WARN, "No task specific parameters");
492 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
494 es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
496 zebra_result (zh, &rr->errcode, &rr->errstring);
498 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
500 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
501 yaz_log (YLOG_LOG, "Received DB Update");
502 if (up->which == Z_IUUpdate_esRequest)
504 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
505 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
506 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
508 yaz_log (YLOG_LOG, "action");
511 switch (*toKeep->action)
513 case Z_IUOriginPartToKeep_recordInsert:
514 yaz_log (YLOG_LOG, "recordInsert");
516 case Z_IUOriginPartToKeep_recordReplace:
517 yaz_log (YLOG_LOG, "recordUpdate");
519 case Z_IUOriginPartToKeep_recordDelete:
520 yaz_log (YLOG_LOG, "recordDelete");
522 case Z_IUOriginPartToKeep_elementUpdate:
523 yaz_log (YLOG_LOG, "elementUpdate");
525 case Z_IUOriginPartToKeep_specialUpdate:
526 yaz_log (YLOG_LOG, "specialUpdate");
528 case Z_ESAdminOriginPartToKeep_shutdown:
529 yaz_log (YLOG_LOG, "shutDown");
531 case Z_ESAdminOriginPartToKeep_start:
532 yaz_log (YLOG_LOG, "start");
535 yaz_log (YLOG_LOG, " unknown (%d)", *toKeep->action);
538 if (toKeep->databaseName)
540 yaz_log (YLOG_LOG, "database: %s", toKeep->databaseName);
542 if (zebra_select_database(zh, toKeep->databaseName))
547 yaz_log (YLOG_WARN, "no database supplied for ES Update");
549 rr->errstring = "database";
555 zebra_begin_trans (zh, 1);
556 for (i = 0; i < notToKeep->num; i++)
558 Z_External *rec = notToKeep->elements[i]->record;
559 struct oident *oident = 0;
560 Odr_oct *opaque_recid = 0;
563 if (notToKeep->elements[i]->u.opaque)
565 switch(notToKeep->elements[i]->which)
567 case Z_IUSuppliedRecords_elem_opaque:
568 opaque_recid = notToKeep->elements[i]->u.opaque;
569 break; /* OK, recid already set */
570 case Z_IUSuppliedRecords_elem_number:
571 sysno = *notToKeep->elements[i]->u.number;
575 if (rec->direct_reference)
577 oident = oid_getentbyoid(rec->direct_reference);
579 yaz_log (YLOG_LOG, "record %d type %s", i,
584 case Z_External_sutrs:
585 if (rec->u.octet_aligned->len > 170)
586 yaz_log (YLOG_LOG, "%d bytes:\n%.168s ...",
590 yaz_log (YLOG_LOG, "%d bytes:\n%s",
594 case Z_External_octet:
595 if (rec->u.octet_aligned->len > 170)
596 yaz_log (YLOG_LOG, "%d bytes:\n%.168s ...",
597 rec->u.octet_aligned->len,
598 rec->u.octet_aligned->buf);
600 yaz_log (YLOG_LOG, "%d bytes\n%s",
601 rec->u.octet_aligned->len,
602 rec->u.octet_aligned->buf);
604 if (oident && oident->value != VAL_TEXT_XML)
607 rr->errstring = "only XML update supported";
610 if (rec->which == Z_External_octet)
614 if (*toKeep->action ==
615 Z_IUOriginPartToKeep_recordInsert)
617 if (*toKeep->action ==
618 Z_IUOriginPartToKeep_recordReplace)
620 if (*toKeep->action ==
621 Z_IUOriginPartToKeep_recordDelete)
623 if (*toKeep->action ==
624 Z_IUOriginPartToKeep_specialUpdate)
630 rr->errstring = "unsupported ES Update action";
633 else if (opaque_recid)
635 int r = zebra_admin_exchange_record (
637 rec->u.octet_aligned->buf,
638 rec->u.octet_aligned->len,
639 opaque_recid->buf, opaque_recid->len,
644 rr->errstring = "record exchange failed";
650 ZEBRA_RES r = ZEBRA_FAIL;
653 r = zebra_insert_record(
659 rec->u.octet_aligned->buf,
660 rec->u.octet_aligned->len,
665 rr->errstring = "insert_record failed";
670 r = zebra_update_record(
676 rec->u.octet_aligned->buf,
677 rec->u.octet_aligned->len,
682 rr->errstring = "update_record failed";
686 r = zebra_delete_record(
692 rec->u.octet_aligned->buf,
693 rec->u.octet_aligned->len,
698 rr->errstring = "delete_record failed";
705 zebra_end_trans (zh);
711 yaz_log (YLOG_WARN, "Unknown Extended Service(%d)",
712 rr->esr->taskSpecificParameters->which);
719 static void bend_start (struct statserv_options_block *sob)
722 zebra_stop((ZebraService) sob->handle);
723 sob->handle = zebra_start(sob->configname);
726 yaz_log (YLOG_FATAL, "Failed to read config `%s'", sob->configname);
738 zebra_pidfname(sob->handle, pidfname);
740 fd = open (pidfname, O_EXCL|O_WRONLY|O_CREAT, 0666);
745 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
748 fd = open(pidfname, O_RDWR, 0666);
751 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
755 area.l_type = F_WRLCK;
756 area.l_whence = SEEK_SET;
757 area.l_len = area.l_start = 0L;
758 if (fcntl (fd, F_SETLK, &area) == -1)
760 yaz_log(YLOG_ERRNO|YLOG_FATAL, "Zebra server already running");
767 sprintf (pidstr, "%ld", (long) getpid ());
768 write (fd, pidstr, strlen(pidstr));
774 static void bend_stop(struct statserv_options_block *sob)
779 if (!sob->inetd && sob->handle)
782 zebra_pidfname(sob->handle, pidfname);
788 ZebraService service = sob->handle;
793 int main (int argc, char **argv)
795 struct statserv_options_block *sob;
797 sob = statserv_getcontrol ();
798 strcpy (sob->configname, "zebra.cfg");
799 sob->bend_start = bend_start;
800 sob->bend_stop = bend_stop;
802 strcpy (sob->service_display_name, "Zebra Server");
804 statserv_setcontrol (sob);
806 return statserv_main (argc, argv, bend_init, bend_close);