1 /* $Id: zebrasrv.c,v 1.6 2007-01-16 15:01:15 adam Exp $
2 Copyright (C) 1995-2007
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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
30 #include <sys/locking.h>
39 #include <yaz/yaz-util.h>
40 #include <yaz/diagbib1.h>
42 #include <sys/types.h>
44 #include <yaz/backend.h>
45 #include <yaz/charneg.h>
46 #include <idzebra/api.h>
48 static int bend_sort (void *handle, bend_sort_rr *rr);
49 static int bend_delete (void *handle, bend_delete_rr *rr);
50 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
51 static int bend_segment (void *handle, bend_segment_rr *rr);
52 static int bend_search (void *handle, bend_search_rr *r);
53 static int bend_fetch (void *handle, bend_fetch_rr *r);
54 static int bend_scan (void *handle, bend_scan_rr *r);
56 bend_initresult *bend_init (bend_initrequest *q)
58 bend_initresult *r = (bend_initresult *)
59 odr_malloc (q->stream, sizeof(*r));
61 struct statserv_options_block *sob;
67 q->bend_sort = bend_sort;
68 q->bend_delete = bend_delete;
69 q->bend_esrequest = bend_esrequest;
70 q->bend_segment = bend_segment;
71 q->bend_search = bend_search;
72 q->bend_fetch = bend_fetch;
73 q->bend_scan = bend_scan;
75 q->implementation_name = "Zebra Information Server";
76 q->implementation_version = "Zebra " ZEBRAVER;
78 yaz_log (YLOG_DEBUG, "bend_init");
80 sob = statserv_getcontrol ();
81 if (!(zh = zebra_open (sob->handle, 0)))
83 yaz_log (YLOG_WARN, "Failed to read config `%s'", sob->configname);
84 r->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
90 if (q->auth->which == Z_IdAuthentication_open)
92 char *openpass = xstrdup (q->auth->u.open);
93 char *cp = strchr (openpass, '/');
97 user = nmem_strdup (odr_getmem (q->stream), openpass);
98 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
102 else if (q->auth->which == Z_IdAuthentication_idPass)
104 Z_IdPass *idPass = q->auth->u.idPass;
106 user = idPass->userId;
107 passwd = idPass->password;
110 if (zebra_auth(zh, user, passwd) != ZEBRA_OK)
112 r->errcode = YAZ_BIB1_INIT_AC_BAD_USERID_AND_OR_PASSWORD;
116 if (q->charneg_request) /* characater set and langauge negotiation? */
124 NMEM nmem = nmem_create();
126 yaz_log (YLOG_LOG, "character set and language negotiation");
128 yaz_get_proposal_charneg (nmem, q->charneg_request,
129 &charsets, &num_charsets,
130 &langs, &num_langs, &selected);
132 for (i = 0; i < num_charsets; i++)
134 const char *right_name = "";
136 * FIXME! It is like rudiment :-))
137 * We have to support this short names of character sets,
138 * because a lot servers in Russia to use own in during
139 * character set and language negotiation still.
142 if (!yaz_matchstr(charsets[i], "win")) {
143 right_name = "WINDOWS-1251";
144 } else if (!yaz_matchstr(charsets[i], "koi")) {
145 right_name = "KOI8-R";
146 } else if (!yaz_matchstr(charsets[i], "iso")) {
147 right_name = "ISO-8859-5";
148 } else if (!yaz_matchstr(charsets[i], "dos")) {
149 right_name = "CP866";
150 } else if (!yaz_matchstr(charsets[i], "uni")) {
151 right_name = "UTF-8";
153 right_name = charsets[i];
155 if (odr_set_charset (q->decode, "UTF-8", right_name) == 0)
157 yaz_log (YLOG_LOG, "charset %d %s (proper name %s): OK", i,
158 charsets[i], right_name);
159 odr_set_charset (q->stream, right_name, "UTF-8");
161 zebra_record_encoding(zh, right_name);
162 zebra_octet_term_encoding(zh, right_name);
163 q->charneg_response =
164 yaz_set_response_charneg (q->stream, charsets[i],
168 yaz_log (YLOG_LOG, "charset %d %s (proper name %s): unsupported", i,
169 charsets[i], right_name);
177 static void search_terms(ZebraHandle zh, bend_search_rr *r)
181 int type = Z_Term_general;
182 struct Z_External *ext;
183 Z_SearchInfoReport *sr;
185 zebra_result_set_term_no(zh, r->setname, &no_terms);
189 r->search_info = odr_malloc (r->stream, sizeof(*r->search_info));
191 r->search_info->num_elements = 1;
192 r->search_info->list =
193 odr_malloc (r->stream, sizeof(*r->search_info->list));
194 r->search_info->list[0] =
195 odr_malloc (r->stream, sizeof(**r->search_info->list));
196 r->search_info->list[0]->category = 0;
197 r->search_info->list[0]->which = Z_OtherInfo_externallyDefinedInfo;
198 ext = odr_malloc (r->stream, sizeof(*ext));
199 r->search_info->list[0]->information.externallyDefinedInfo = ext;
200 ext->direct_reference =
201 yaz_oidval_to_z3950oid (r->stream, CLASS_USERINFO, VAL_SEARCHRES1);
202 ext->indirect_reference = 0;
204 ext->which = Z_External_searchResult1;
205 sr = odr_malloc (r->stream, sizeof(Z_SearchInfoReport));
206 ext->u.searchResult1 = sr;
208 sr->elements = odr_malloc (r->stream, sr->num *
209 sizeof(*sr->elements));
210 for (i = 0; i<no_terms; i++)
212 Z_SearchInfoReport_s *se;
217 size_t len = sizeof(outbuf);
218 const char *term_ref_id = 0;
220 zebra_result_set_term_info(zh, r->setname, i,
221 &count, &approx, outbuf, &len,
223 se = sr->elements[i] = odr_malloc (r->stream, sizeof(**sr->elements));
224 se->subqueryId = term_ref_id ?
225 odr_strdup(r->stream, term_ref_id) : 0;
227 se->fullQuery = odr_intdup(r->stream, 0);
228 se->subqueryExpression =
229 odr_malloc (r->stream, sizeof(Z_QueryExpression));
230 se->subqueryExpression->which =
231 Z_QueryExpression_term;
232 se->subqueryExpression->u.term =
233 odr_malloc (r->stream, sizeof(Z_QueryExpressionTerm));
234 term = odr_malloc (r->stream, sizeof(Z_Term));
235 se->subqueryExpression->u.term->queryTerm = term;
238 case Z_Term_characterString:
239 term->which = Z_Term_characterString;
240 term->u.characterString = odr_strdup (r->stream, outbuf);
243 term->which = Z_Term_general;
244 term->u.general = odr_malloc (r->stream, sizeof(*term->u.general));
245 term->u.general->size = term->u.general->len = len;
246 term->u.general->buf = odr_malloc (r->stream, len);
247 memcpy (term->u.general->buf, outbuf, len);
250 term->which = Z_Term_general;
251 term->u.null = odr_nullval();
253 se->subqueryExpression->u.term->termComment = 0;
254 se->subqueryInterpretation = 0;
255 se->subqueryRecommendation = 0;
256 if (count > 2147483646)
258 se->subqueryCount = odr_intdup(r->stream, CAST_ZINT_TO_INT(count));
259 se->subqueryWeight = 0;
264 int bend_search(void *handle, bend_search_rr *r)
266 ZebraHandle zh = (ZebraHandle) handle;
270 res = zebra_select_databases (zh, r->num_bases,
271 (const char **) r->basenames);
274 zebra_result (zh, &r->errcode, &r->errstring);
277 yaz_log (YLOG_DEBUG, "ResultSet '%s'", r->setname);
278 switch (r->query->which)
280 case Z_Query_type_1: case Z_Query_type_101:
281 res = zebra_search_RPN_x(zh, r->stream, r->query->u.type_1,
283 &r->estimated_hit_count,
284 &r->partial_resultset);
286 zebra_result(zh, &r->errcode, &r->errstring);
289 if (zhits > 2147483646)
291 r->hits = CAST_ZINT_TO_INT(zhits);
292 search_terms (zh, r);
296 r->errcode = YAZ_BIB1_QUERY_TYPE_UNSUPP;
297 r->errstring = "type-2";
300 r->errcode = YAZ_BIB1_QUERY_TYPE_UNSUPP;
306 int bend_fetch (void *handle, bend_fetch_rr *r)
308 ZebraHandle zh = (ZebraHandle) handle;
309 ZebraRetrievalRecord retrievalRecord;
312 retrievalRecord.position = r->number;
315 res = zebra_records_retrieve (zh, r->stream, r->setname, r->comp,
316 r->request_format, 1, &retrievalRecord);
319 /* non-surrogate diagnostic */
320 zebra_result (zh, &r->errcode, &r->errstring);
322 else if (retrievalRecord.errCode)
324 /* surrogate diagnostic (diagnostic per record) */
325 r->surrogate_flag = 1;
326 r->errcode = retrievalRecord.errCode;
327 r->errstring = retrievalRecord.errString;
328 r->basename = retrievalRecord.base;
332 r->basename = retrievalRecord.base;
333 r->record = retrievalRecord.buf;
334 r->len = retrievalRecord.len;
335 r->output_format = retrievalRecord.format;
340 static int bend_scan (void *handle, bend_scan_rr *r)
342 ZebraScanEntry *entries;
343 ZebraHandle zh = (ZebraHandle) handle;
347 res = zebra_select_databases(zh, r->num_bases,
348 (const char **) r->basenames);
351 zebra_result (zh, &r->errcode, &r->errstring);
354 if (r->step_size != 0 && *r->step_size != 0) {
355 r->errcode = YAZ_BIB1_ONLY_ZERO_STEP_SIZE_SUPPORTED_FOR_SCAN;
359 r->entries = (struct scan_entry *)
360 odr_malloc (r->stream, sizeof(*r->entries) * r->num_entries);
361 res = zebra_scan(zh, r->stream, r->term,
364 &r->num_entries, &entries, &is_partial,
369 r->status = BEND_SCAN_PARTIAL;
371 r->status = BEND_SCAN_SUCCESS;
372 for (i = 0; i < r->num_entries; i++)
374 r->entries[i].term = entries[i].term;
375 r->entries[i].occurrences =
376 CAST_ZINT_TO_INT(entries[i].occurrences);
381 r->status = BEND_SCAN_PARTIAL;
382 zebra_result(zh, &r->errcode, &r->errstring);
387 void bend_close (void *handle)
389 zebra_close ((ZebraHandle) handle);
390 xmalloc_trav("bend_close");
394 int bend_sort (void *handle, bend_sort_rr *rr)
396 ZebraHandle zh = (ZebraHandle) handle;
398 if (zebra_sort (zh, rr->stream,
399 rr->num_input_setnames, (const char **) rr->input_setnames,
400 rr->output_setname, rr->sort_sequence, &rr->sort_status)
402 zebra_result (zh, &rr->errcode, &rr->errstring);
406 int bend_delete (void *handle, bend_delete_rr *rr)
408 ZebraHandle zh = (ZebraHandle) handle;
410 rr->delete_status = zebra_deleteResultSet(zh, rr->function,
411 rr->num_setnames, rr->setnames,
416 static void es_admin_request (bend_esrequest_rr *rr, ZebraHandle zh, Z_AdminEsRequest *r)
418 ZEBRA_RES res = ZEBRA_OK;
419 if (r->toKeep->databaseName)
421 yaz_log(YLOG_LOG, "adm request database %s", r->toKeep->databaseName);
423 switch (r->toKeep->which)
425 case Z_ESAdminOriginPartToKeep_reIndex:
426 yaz_log(YLOG_LOG, "adm-reindex");
427 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
428 rr->errstring = "adm-reindex not implemented yet";
430 case Z_ESAdminOriginPartToKeep_truncate:
431 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
432 rr->errstring = "adm-reindex not implemented yet";
433 yaz_log(YLOG_LOG, "adm-truncate");
435 case Z_ESAdminOriginPartToKeep_drop:
436 yaz_log(YLOG_LOG, "adm-drop");
437 res = zebra_drop_database (zh, r->toKeep->databaseName);
439 case Z_ESAdminOriginPartToKeep_create:
440 yaz_log(YLOG_LOG, "adm-create %s", r->toKeep->databaseName);
441 res = zebra_create_database (zh, r->toKeep->databaseName);
443 case Z_ESAdminOriginPartToKeep_import:
444 yaz_log(YLOG_LOG, "adm-import");
445 res = zebra_admin_import_begin (zh, r->toKeep->databaseName,
446 r->toKeep->u.import->recordType);
448 case Z_ESAdminOriginPartToKeep_refresh:
449 yaz_log(YLOG_LOG, "adm-refresh");
451 case Z_ESAdminOriginPartToKeep_commit:
452 yaz_log(YLOG_LOG, "adm-commit");
453 if (r->toKeep->databaseName)
455 if (zebra_select_database(zh, r->toKeep->databaseName) !=
457 yaz_log(YLOG_WARN, "zebra_select_database failed in "
462 case Z_ESAdminOriginPartToKeep_shutdown:
463 yaz_log(YLOG_LOG, "shutdown");
464 res = zebra_admin_shutdown(zh);
466 case Z_ESAdminOriginPartToKeep_start:
467 yaz_log(YLOG_LOG, "start");
468 zebra_admin_start(zh);
471 yaz_log(YLOG_LOG, "unknown admin");
472 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
473 rr->errstring = "adm-reindex not implemented yet";
476 zebra_result(zh, &rr->errcode, &rr->errstring);
479 static void es_admin (bend_esrequest_rr *rr, ZebraHandle zh, Z_Admin *r)
483 case Z_Admin_esRequest:
484 es_admin_request (rr, zh, r->u.esRequest);
489 yaz_log (YLOG_WARN, "adm taskpackage (unhandled)");
490 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
491 rr->errstring = "adm-task package (unhandled)";
494 int bend_segment (void *handle, bend_segment_rr *rr)
496 ZebraHandle zh = (ZebraHandle) handle;
497 Z_Segment *segment = rr->segment;
499 if (segment->num_segmentRecords)
500 zebra_admin_import_segment (zh, rr->segment);
502 zebra_admin_import_end (zh);
506 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
508 ZebraHandle zh = (ZebraHandle) handle;
510 yaz_log(YLOG_LOG, "function: %d", *rr->esr->function);
511 if (rr->esr->packageName)
512 yaz_log(YLOG_LOG, "packagename: %s", rr->esr->packageName);
513 yaz_log(YLOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
515 if (!rr->esr->taskSpecificParameters)
517 yaz_log (YLOG_WARN, "No task specific parameters");
519 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
521 es_admin(rr, zh, rr->esr->taskSpecificParameters->u.adminService);
523 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
525 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
526 yaz_log (YLOG_LOG, "Received DB Update");
527 if (up->which == Z_IUUpdate_esRequest)
529 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
530 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
531 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
533 yaz_log (YLOG_LOG, "action");
536 switch (*toKeep->action)
538 case Z_IUOriginPartToKeep_recordInsert:
539 yaz_log (YLOG_LOG, "recordInsert");
541 case Z_IUOriginPartToKeep_recordReplace:
542 yaz_log (YLOG_LOG, "recordUpdate");
544 case Z_IUOriginPartToKeep_recordDelete:
545 yaz_log (YLOG_LOG, "recordDelete");
547 case Z_IUOriginPartToKeep_elementUpdate:
548 yaz_log (YLOG_LOG, "elementUpdate");
550 case Z_IUOriginPartToKeep_specialUpdate:
551 yaz_log (YLOG_LOG, "specialUpdate");
553 case Z_ESAdminOriginPartToKeep_shutdown:
554 yaz_log (YLOG_LOG, "shutDown");
556 case Z_ESAdminOriginPartToKeep_start:
557 yaz_log (YLOG_LOG, "start");
560 yaz_log (YLOG_LOG, " unknown (%d)", *toKeep->action);
563 if (toKeep->databaseName)
565 yaz_log (YLOG_LOG, "database: %s", toKeep->databaseName);
567 if (zebra_select_database(zh, toKeep->databaseName))
572 yaz_log (YLOG_WARN, "no database supplied for ES Update");
574 YAZ_BIB1_ES_MISSING_MANDATORY_PARAMETER_FOR_SPECIFIED_FUNCTION_;
575 rr->errstring = "database";
578 if (zebra_begin_trans(zh, 1) != ZEBRA_OK)
580 zebra_result(zh, &rr->errcode, &rr->errstring);
585 for (i = 0; notToKeep && i < notToKeep->num; i++)
587 Z_External *rec = notToKeep->elements[i]->record;
588 struct oident *oident = 0;
589 Odr_oct *opaque_recid = 0;
593 if (notToKeep->elements[i]->u.opaque)
595 switch(notToKeep->elements[i]->which)
597 case Z_IUSuppliedRecords_elem_opaque:
598 opaque_recid = notToKeep->elements[i]->u.opaque;
599 break; /* OK, recid already set */
600 case Z_IUSuppliedRecords_elem_number:
601 sysno_tmp = *notToKeep->elements[i]->u.number;
606 if (rec->direct_reference)
608 oident = oid_getentbyoid(rec->direct_reference);
610 yaz_log (YLOG_LOG, "record %d type %s", i,
615 case Z_External_sutrs:
616 if (rec->u.octet_aligned->len > 170)
617 yaz_log (YLOG_LOG, "%d bytes:\n%.168s ...",
621 yaz_log (YLOG_LOG, "%d bytes:\n%s",
625 case Z_External_octet:
626 if (rec->u.octet_aligned->len > 170)
627 yaz_log (YLOG_LOG, "%d bytes:\n%.168s ...",
628 rec->u.octet_aligned->len,
629 rec->u.octet_aligned->buf);
631 yaz_log (YLOG_LOG, "%d bytes\n%s",
632 rec->u.octet_aligned->len,
633 rec->u.octet_aligned->buf);
635 if (oident && oident->value != VAL_TEXT_XML
636 && oident->value != VAL_SUTRS)
638 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
639 rr->errstring = "only XML update supported";
642 if (rec->which == Z_External_octet)
646 if (*toKeep->action ==
647 Z_IUOriginPartToKeep_recordInsert)
649 if (*toKeep->action ==
650 Z_IUOriginPartToKeep_recordReplace)
652 if (*toKeep->action ==
653 Z_IUOriginPartToKeep_recordDelete)
655 if (*toKeep->action ==
656 Z_IUOriginPartToKeep_specialUpdate)
662 YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
663 rr->errstring = "unsupported ES Update action";
666 else if (opaque_recid)
668 int r = zebra_admin_exchange_record (
670 (const char *) rec->u.octet_aligned->buf,
671 rec->u.octet_aligned->len,
672 (const char *) opaque_recid->buf,
677 zebra_result(zh, &rr->errcode,
684 ZEBRA_RES r = ZEBRA_FAIL;
687 r = zebra_insert_record(
693 (const char *) rec->u.octet_aligned->buf,
694 rec->u.octet_aligned->len,
699 YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
700 rr->errstring = "insert_record failed";
705 r = zebra_update_record(
711 (const char *) rec->u.octet_aligned->buf,
712 rec->u.octet_aligned->len,
717 YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
718 rr->errstring = "update_record failed";
722 r = zebra_delete_record(
728 (const char *) rec->u.octet_aligned->buf,
729 rec->u.octet_aligned->len,
734 YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
735 rr->errstring = "delete_record failed";
742 if (zebra_end_trans (zh) != ZEBRA_OK)
744 yaz_log(YLOG_WARN, "zebra_end_trans failed for"
745 " extended service operation");
752 yaz_log (YLOG_WARN, "Unknown Extended Service(%d)",
753 rr->esr->taskSpecificParameters->which);
754 rr->errcode = YAZ_BIB1_ES_EXTENDED_SERVICE_TYPE_UNSUPP;
760 static void bend_start (struct statserv_options_block *sob)
762 Res default_res = res_open(0, 0);
765 zebra_stop((ZebraService) sob->handle);
766 res_set(default_res, "profilePath", DEFAULT_PROFILE_PATH);
767 res_set(default_res, "modulePath", DEFAULT_MODULE_PATH);
768 sob->handle = zebra_start(sob->configname);
769 res_close(default_res);
772 yaz_log (YLOG_FATAL, "Failed to read config `%s'", sob->configname);
784 zebra_pidfname(sob->handle, pidfname);
786 fd = open (pidfname, O_EXCL|O_WRONLY|O_CREAT, 0666);
791 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
794 fd = open(pidfname, O_RDWR, 0666);
797 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
801 area.l_type = F_WRLCK;
802 area.l_whence = SEEK_SET;
803 area.l_len = area.l_start = 0L;
804 if (fcntl (fd, F_SETLK, &area) == -1)
806 yaz_log(YLOG_ERRNO|YLOG_FATAL, "Zebra server already running");
813 sprintf (pidstr, "%ld", (long) getpid ());
814 write (fd, pidstr, strlen(pidstr));
820 static void bend_stop(struct statserv_options_block *sob)
825 if (!sob->inetd && sob->handle)
828 zebra_pidfname(sob->handle, pidfname);
834 ZebraService service = sob->handle;
839 int main (int argc, char **argv)
841 struct statserv_options_block *sob;
843 sob = statserv_getcontrol ();
844 strcpy (sob->configname, "zebra.cfg");
845 sob->bend_start = bend_start;
846 sob->bend_stop = bend_stop;
848 strcpy (sob->service_display_name, "Zebra Server");
850 statserv_setcontrol (sob);
852 return statserv_main (argc, argv, bend_init, bend_close);
857 * indent-tabs-mode: nil
859 * vim: shiftwidth=4 tabstop=8 expandtab