1 /* $Id: zserver.c,v 1.128 2005-01-16 23:14:57 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;
270 if (zebra_select_databases (zh, r->num_bases,
271 (const char **) r->basenames))
273 zebra_result (zh, &r->errcode, &r->errstring);
276 yaz_log (YLOG_DEBUG, "ResultSet '%s'", r->setname);
277 switch (r->query->which)
279 case Z_Query_type_1: case Z_Query_type_101:
280 zebra_search_RPN (zh, r->stream, r->query->u.type_1,
281 r->setname, &r->hits);
282 zebra_result (zh, &r->errcode, &r->errstring);
284 search_terms (zh, r);
288 r->errstring = "type-2";
297 int bend_fetch (void *handle, bend_fetch_rr *r)
299 ZebraHandle zh = (ZebraHandle) handle;
300 ZebraRetrievalRecord retrievalRecord;
302 retrievalRecord.position = r->number;
305 zebra_records_retrieve (zh, r->stream, r->setname, r->comp,
306 r->request_format, 1, &retrievalRecord);
307 zebra_result (zh, &r->errcode, &r->errstring);
308 /* non Surrogate Diagnostic OR Surrogate Diagnostic */
309 if (r->errcode == 0 && retrievalRecord.errCode)
311 r->surrogate_flag = 1;
312 r->errcode = retrievalRecord.errCode;
313 r->errstring = retrievalRecord.errString;
314 r->basename = retrievalRecord.base;
316 else if (r->errcode == 0) /* Database Record */
319 r->basename = retrievalRecord.base;
320 r->record = retrievalRecord.buf;
321 r->len = retrievalRecord.len;
322 r->output_format = retrievalRecord.format;
327 static int bend_scan (void *handle, bend_scan_rr *r)
329 ZebraScanEntry *entries;
330 ZebraHandle zh = (ZebraHandle) handle;
333 if (zebra_select_databases (zh, r->num_bases,
334 (const char **) r->basenames))
336 zebra_result (zh, &r->errcode, &r->errstring);
339 if (r->step_size != 0 && *r->step_size != 0) {
340 r->errcode = 205; /* "Only zero step size supported for Scan" */
344 r->entries = (struct scan_entry *)
345 odr_malloc (r->stream, sizeof(*r->entries) * r->num_entries);
346 zebra_scan (zh, r->stream, r->term,
349 &r->num_entries, &entries, &is_partial);
351 r->status = BEND_SCAN_PARTIAL;
353 r->status = BEND_SCAN_SUCCESS;
354 for (i = 0; i < r->num_entries; i++)
356 r->entries[i].term = entries[i].term;
357 r->entries[i].occurrences = entries[i].occurrences;
359 zebra_result (zh, &r->errcode, &r->errstring);
363 void bend_close (void *handle)
365 zebra_close ((ZebraHandle) handle);
366 xmalloc_trav("bend_close");
370 int bend_sort (void *handle, bend_sort_rr *rr)
372 ZebraHandle zh = (ZebraHandle) handle;
374 zebra_sort (zh, rr->stream,
375 rr->num_input_setnames, (const char **) rr->input_setnames,
376 rr->output_setname, rr->sort_sequence, &rr->sort_status);
377 zebra_result (zh, &rr->errcode, &rr->errstring);
381 int bend_delete (void *handle, bend_delete_rr *rr)
383 ZebraHandle zh = (ZebraHandle) handle;
385 rr->delete_status = zebra_deleleResultSet(zh, rr->function,
386 rr->num_setnames, rr->setnames,
391 static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
393 if (r->toKeep->databaseName)
395 yaz_log(YLOG_LOG, "adm request database %s", r->toKeep->databaseName);
397 switch (r->toKeep->which)
399 case Z_ESAdminOriginPartToKeep_reIndex:
400 yaz_log(YLOG_LOG, "adm-reindex");
402 case Z_ESAdminOriginPartToKeep_truncate:
403 yaz_log(YLOG_LOG, "adm-truncate");
405 case Z_ESAdminOriginPartToKeep_drop:
406 yaz_log(YLOG_LOG, "adm-drop");
407 zebra_drop_database (zh, r->toKeep->databaseName);
409 case Z_ESAdminOriginPartToKeep_create:
410 yaz_log(YLOG_LOG, "adm-create %s", r->toKeep->databaseName);
411 zebra_create_database (zh, r->toKeep->databaseName);
413 case Z_ESAdminOriginPartToKeep_import:
414 yaz_log(YLOG_LOG, "adm-import");
415 zebra_admin_import_begin (zh, r->toKeep->databaseName,
416 r->toKeep->u.import->recordType);
418 case Z_ESAdminOriginPartToKeep_refresh:
419 yaz_log(YLOG_LOG, "adm-refresh");
421 case Z_ESAdminOriginPartToKeep_commit:
422 yaz_log(YLOG_LOG, "adm-commit");
423 if (r->toKeep->databaseName)
424 zebra_select_database(zh, r->toKeep->databaseName);
427 case Z_ESAdminOriginPartToKeep_shutdown:
428 yaz_log(YLOG_LOG, "shutdown");
429 zebra_admin_shutdown(zh);
431 case Z_ESAdminOriginPartToKeep_start:
432 yaz_log(YLOG_LOG, "start");
433 zebra_admin_start(zh);
436 yaz_log(YLOG_LOG, "unknown admin");
441 static int es_admin (ZebraHandle zh, Z_Admin *r)
445 case Z_Admin_esRequest:
446 es_admin_request (zh, r->u.esRequest);
448 case Z_Admin_taskPackage:
449 yaz_log (YLOG_LOG, "adm taskpackage (unhandled)");
458 int bend_segment (void *handle, bend_segment_rr *rr)
460 ZebraHandle zh = (ZebraHandle) handle;
461 Z_Segment *segment = rr->segment;
463 if (segment->num_segmentRecords)
464 zebra_admin_import_segment (zh, rr->segment);
466 zebra_admin_import_end (zh);
470 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
472 ZebraHandle zh = (ZebraHandle) handle;
474 yaz_log(YLOG_LOG, "function: %d", *rr->esr->function);
475 if (rr->esr->packageName)
476 yaz_log(YLOG_LOG, "packagename: %s", rr->esr->packageName);
477 yaz_log(YLOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
479 if (!rr->esr->taskSpecificParameters)
481 yaz_log (YLOG_WARN, "No task specific parameters");
483 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
485 es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
487 zebra_result (zh, &rr->errcode, &rr->errstring);
489 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
491 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
492 yaz_log (YLOG_LOG, "Received DB Update");
493 if (up->which == Z_IUUpdate_esRequest)
495 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
496 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
497 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
499 yaz_log (YLOG_LOG, "action");
502 switch (*toKeep->action)
504 case Z_IUOriginPartToKeep_recordInsert:
505 yaz_log (YLOG_LOG, "recordInsert");
507 case Z_IUOriginPartToKeep_recordReplace:
508 yaz_log (YLOG_LOG, "recordUpdate");
510 case Z_IUOriginPartToKeep_recordDelete:
511 yaz_log (YLOG_LOG, "recordDelete");
513 case Z_IUOriginPartToKeep_elementUpdate:
514 yaz_log (YLOG_LOG, "elementUpdate");
516 case Z_IUOriginPartToKeep_specialUpdate:
517 yaz_log (YLOG_LOG, "specialUpdate");
519 case Z_ESAdminOriginPartToKeep_shutdown:
520 yaz_log (YLOG_LOG, "shutDown");
522 case Z_ESAdminOriginPartToKeep_start:
523 yaz_log (YLOG_LOG, "start");
526 yaz_log (YLOG_LOG, " unknown (%d)", *toKeep->action);
529 if (toKeep->databaseName)
531 yaz_log (YLOG_LOG, "database: %s", toKeep->databaseName);
533 if (zebra_select_database(zh, toKeep->databaseName))
538 yaz_log (YLOG_WARN, "no database supplied for ES Update");
540 rr->errstring = "database";
546 zebra_begin_trans (zh, 1);
547 for (i = 0; i < notToKeep->num; i++)
549 Z_External *rec = notToKeep->elements[i]->record;
550 struct oident *oident = 0;
551 Odr_oct *opaque_recid = 0;
554 if (notToKeep->elements[i]->u.opaque)
556 switch(notToKeep->elements[i]->which)
558 case Z_IUSuppliedRecords_elem_opaque:
559 opaque_recid = notToKeep->elements[i]->u.opaque;
560 break; /* OK, recid already set */
561 case Z_IUSuppliedRecords_elem_number:
562 sysno = *notToKeep->elements[i]->u.number;
566 if (rec->direct_reference)
568 oident = oid_getentbyoid(rec->direct_reference);
570 yaz_log (YLOG_LOG, "record %d type %s", i,
575 case Z_External_sutrs:
576 if (rec->u.octet_aligned->len > 170)
577 yaz_log (YLOG_LOG, "%d bytes:\n%.168s ...",
581 yaz_log (YLOG_LOG, "%d bytes:\n%s",
585 case Z_External_octet:
586 if (rec->u.octet_aligned->len > 170)
587 yaz_log (YLOG_LOG, "%d bytes:\n%.168s ...",
588 rec->u.octet_aligned->len,
589 rec->u.octet_aligned->buf);
591 yaz_log (YLOG_LOG, "%d bytes\n%s",
592 rec->u.octet_aligned->len,
593 rec->u.octet_aligned->buf);
595 if (oident && oident->value != VAL_TEXT_XML)
598 rr->errstring = "only XML update supported";
601 if (rec->which == Z_External_octet)
605 if (*toKeep->action ==
606 Z_IUOriginPartToKeep_recordInsert)
608 if (*toKeep->action ==
609 Z_IUOriginPartToKeep_recordReplace)
611 if (*toKeep->action ==
612 Z_IUOriginPartToKeep_recordDelete)
614 if (*toKeep->action ==
615 Z_IUOriginPartToKeep_specialUpdate)
621 rr->errstring = "unsupported ES Update action";
624 else if (opaque_recid)
626 int r = zebra_admin_exchange_record (
628 rec->u.octet_aligned->buf,
629 rec->u.octet_aligned->len,
630 opaque_recid->buf, opaque_recid->len,
635 rr->errstring = "record exchange failed";
644 r = zebra_insert_record(
650 rec->u.octet_aligned->buf,
651 rec->u.octet_aligned->len,
656 rr->errstring = "insert_record failed";
661 r = zebra_update_record(
667 rec->u.octet_aligned->buf,
668 rec->u.octet_aligned->len,
673 rr->errstring = "update_record failed";
677 r = zebra_delete_record(
683 rec->u.octet_aligned->buf,
684 rec->u.octet_aligned->len,
689 rr->errstring = "delete_record failed";
696 zebra_end_trans (zh);
702 yaz_log (YLOG_WARN, "Unknown Extended Service(%d)",
703 rr->esr->taskSpecificParameters->which);
710 static void bend_start (struct statserv_options_block *sob)
713 zebra_stop((ZebraService) sob->handle);
714 sob->handle = zebra_start(sob->configname);
717 yaz_log (YLOG_FATAL, "Failed to read config `%s'", sob->configname);
729 zebra_pidfname(sob->handle, pidfname);
731 fd = open (pidfname, O_EXCL|O_WRONLY|O_CREAT, 0666);
736 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
739 fd = open(pidfname, O_RDWR, 0666);
742 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
746 area.l_type = F_WRLCK;
747 area.l_whence = SEEK_SET;
748 area.l_len = area.l_start = 0L;
749 if (fcntl (fd, F_SETLK, &area) == -1)
751 yaz_log(YLOG_ERRNO|YLOG_FATAL, "Zebra server already running");
758 sprintf (pidstr, "%ld", (long) getpid ());
759 write (fd, pidstr, strlen(pidstr));
765 static void bend_stop(struct statserv_options_block *sob)
770 if (!sob->inetd && sob->handle)
773 zebra_pidfname(sob->handle, pidfname);
779 ZebraService service = sob->handle;
784 int main (int argc, char **argv)
786 struct statserv_options_block *sob;
788 sob = statserv_getcontrol ();
789 strcpy (sob->configname, "zebra.cfg");
790 sob->bend_start = bend_start;
791 sob->bend_stop = bend_stop;
793 strcpy (sob->service_display_name, "Zebra Server");
795 statserv_setcontrol (sob);
797 return statserv_main (argc, argv, bend_init, bend_close);