1 /* This file is part of the Zebra server.
2 Copyright (C) 1994-2011 Index Data
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
27 #include <sys/locking.h>
36 #include <yaz/yaz-util.h>
37 #include <yaz/diagbib1.h>
39 #include <sys/types.h>
41 #include <yaz/backend.h>
42 #include <yaz/charneg.h>
43 #include <idzebra/api.h>
45 static int bend_sort(void *handle, bend_sort_rr *rr);
46 static int bend_delete(void *handle, bend_delete_rr *rr);
47 static int bend_esrequest(void *handle, bend_esrequest_rr *rr);
48 static int bend_segment(void *handle, bend_segment_rr *rr);
49 static int bend_search(void *handle, bend_search_rr *r);
50 static int bend_fetch(void *handle, bend_fetch_rr *r);
51 static int bend_scan(void *handle, bend_scan_rr *r);
53 bend_initresult *bend_init(bend_initrequest *q)
55 bend_initresult *r = (bend_initresult *)
56 odr_malloc(q->stream, sizeof(*r));
58 struct statserv_options_block *sob;
65 q->bend_sort = bend_sort;
66 q->bend_delete = bend_delete;
67 q->bend_esrequest = bend_esrequest;
68 q->bend_segment = bend_segment;
69 q->bend_search = bend_search;
70 q->bend_fetch = bend_fetch;
71 q->bend_scan = bend_scan;
73 zebra_get_version(version_str, 0);
75 q->implementation_name = "Zebra Information Server";
76 q->implementation_version = odr_strdup(q->stream, version_str);
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;
89 q->query_charset = odr_strdup(q->stream, zebra_get_encoding(zh));
92 if (q->auth->which == Z_IdAuthentication_open)
94 char *openpass = xstrdup(q->auth->u.open);
95 char *cp = strchr(openpass, '/');
99 user = nmem_strdup(odr_getmem(q->stream), openpass);
100 passwd = nmem_strdup(odr_getmem(q->stream), cp+1);
104 else if (q->auth->which == Z_IdAuthentication_idPass)
106 Z_IdPass *idPass = q->auth->u.idPass;
108 user = idPass->userId;
109 passwd = idPass->password;
112 if (zebra_auth(zh, user, passwd) != ZEBRA_OK)
114 r->errcode = YAZ_BIB1_INIT_AC_BAD_USERID_AND_OR_PASSWORD;
118 if (q->charneg_request) /* characater set and language negotiation? */
126 NMEM nmem = nmem_create();
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 = odr_oiddup(r->stream,
201 yaz_oid_userinfo_searchresult_1);
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_booldup(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 se->subqueryCount = odr_intdup(r->stream, count);
257 se->subqueryWeight = 0;
263 static int break_handler(void *client_data)
265 bend_association assoc =(bend_association) client_data;
266 if (!bend_assoc_is_alive(assoc))
271 int bend_search(void *handle, bend_search_rr *r)
273 ZebraHandle zh = (ZebraHandle) handle;
277 res = zebra_select_databases(zh, r->num_bases,
278 (const char **) r->basenames);
281 zebra_result(zh, &r->errcode, &r->errstring);
284 zebra_set_break_handler(zh, break_handler, r->association);
285 yaz_log(YLOG_DEBUG, "ResultSet '%s'", r->setname);
286 switch (r->query->which)
288 case Z_Query_type_1: case Z_Query_type_101:
289 res = zebra_search_RPN_x(zh, r->stream, r->query->u.type_1,
291 &r->estimated_hit_count,
292 &r->partial_resultset);
294 zebra_result(zh, &r->errcode, &r->errstring);
302 r->errcode = YAZ_BIB1_QUERY_TYPE_UNSUPP;
303 r->errstring = "type-2";
306 r->errcode = YAZ_BIB1_QUERY_TYPE_UNSUPP;
308 zebra_set_break_handler(zh, 0, 0);
313 int bend_fetch(void *handle, bend_fetch_rr *r)
315 ZebraHandle zh = (ZebraHandle) handle;
316 ZebraRetrievalRecord retrievalRecord;
319 retrievalRecord.position = r->number;
322 res = zebra_records_retrieve(zh, r->stream, r->setname, r->comp,
323 r->request_format, 1, &retrievalRecord);
326 /* non-surrogate diagnostic */
327 zebra_result(zh, &r->errcode, &r->errstring);
329 else if (retrievalRecord.errCode)
331 /* surrogate diagnostic (diagnostic per record) */
332 r->surrogate_flag = 1;
333 r->errcode = retrievalRecord.errCode;
334 r->errstring = retrievalRecord.errString;
335 r->basename = retrievalRecord.base;
339 r->basename = retrievalRecord.base;
340 r->record = retrievalRecord.buf;
341 r->len = retrievalRecord.len;
342 r->output_format = odr_oiddup(r->stream, retrievalRecord.format);
347 static int bend_scan(void *handle, bend_scan_rr *r)
349 ZebraScanEntry *entries;
350 ZebraHandle zh = (ZebraHandle) handle;
354 res = zebra_select_databases(zh, r->num_bases,
355 (const char **) r->basenames);
358 zebra_result(zh, &r->errcode, &r->errstring);
361 if (r->step_size != 0 && *r->step_size != 0) {
362 r->errcode = YAZ_BIB1_ONLY_ZERO_STEP_SIZE_SUPPORTED_FOR_SCAN;
366 res = zebra_scan(zh, r->stream, r->term,
369 &r->num_entries, &entries, &is_partial,
374 r->status = BEND_SCAN_PARTIAL;
376 r->status = BEND_SCAN_SUCCESS;
377 for (i = 0; i < r->num_entries; i++)
379 r->entries[i].term = entries[i].term;
380 r->entries[i].display_term = entries[i].display_term;
381 r->entries[i].occurrences = entries[i].occurrences;
386 r->status = BEND_SCAN_PARTIAL;
387 zebra_result(zh, &r->errcode, &r->errstring);
392 void bend_close(void *handle)
394 zebra_close((ZebraHandle) handle);
395 xmalloc_trav("bend_close");
398 int bend_sort(void *handle, bend_sort_rr *rr)
400 ZebraHandle zh = (ZebraHandle) handle;
402 if (zebra_sort(zh, rr->stream,
403 rr->num_input_setnames, (const char **) rr->input_setnames,
404 rr->output_setname, rr->sort_sequence, &rr->sort_status)
406 zebra_result(zh, &rr->errcode, &rr->errstring);
410 int bend_delete(void *handle, bend_delete_rr *rr)
412 ZebraHandle zh = (ZebraHandle) handle;
414 rr->delete_status = zebra_deleteResultSet(zh, rr->function,
415 rr->num_setnames, rr->setnames,
420 static void es_admin_request(bend_esrequest_rr *rr, ZebraHandle zh, Z_AdminEsRequest *r)
422 ZEBRA_RES res = ZEBRA_OK;
423 if (r->toKeep->databaseName)
425 yaz_log(YLOG_LOG, "adm request database %s", r->toKeep->databaseName);
427 switch (r->toKeep->which)
429 case Z_ESAdminOriginPartToKeep_reIndex:
430 yaz_log(YLOG_LOG, "adm-reindex");
431 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
432 rr->errstring = "adm-reindex not implemented yet";
434 case Z_ESAdminOriginPartToKeep_truncate:
435 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
436 rr->errstring = "adm-reindex not implemented yet";
437 yaz_log(YLOG_LOG, "adm-truncate");
439 case Z_ESAdminOriginPartToKeep_drop:
440 yaz_log(YLOG_LOG, "adm-drop");
441 res = zebra_drop_database(zh, r->toKeep->databaseName);
443 case Z_ESAdminOriginPartToKeep_create:
444 yaz_log(YLOG_LOG, "adm-create %s", r->toKeep->databaseName);
445 res = zebra_create_database(zh, r->toKeep->databaseName);
447 case Z_ESAdminOriginPartToKeep_import:
448 yaz_log(YLOG_LOG, "adm-import");
449 res = zebra_admin_import_begin(zh, r->toKeep->databaseName,
450 r->toKeep->u.import->recordType);
452 case Z_ESAdminOriginPartToKeep_refresh:
453 yaz_log(YLOG_LOG, "adm-refresh");
455 case Z_ESAdminOriginPartToKeep_commit:
456 yaz_log(YLOG_LOG, "adm-commit");
457 if (r->toKeep->databaseName)
459 if (zebra_select_database(zh, r->toKeep->databaseName) !=
461 yaz_log(YLOG_WARN, "zebra_select_database failed in "
466 case Z_ESAdminOriginPartToKeep_shutdown:
467 yaz_log(YLOG_LOG, "shutdown");
468 res = zebra_admin_shutdown(zh);
470 case Z_ESAdminOriginPartToKeep_start:
471 yaz_log(YLOG_LOG, "start");
472 zebra_admin_start(zh);
475 yaz_log(YLOG_LOG, "unknown admin");
476 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
477 rr->errstring = "adm-reindex not implemented yet";
480 zebra_result(zh, &rr->errcode, &rr->errstring);
483 static void es_admin(bend_esrequest_rr *rr, ZebraHandle zh, Z_Admin *r)
487 case Z_Admin_esRequest:
488 es_admin_request(rr, zh, r->u.esRequest);
493 yaz_log(YLOG_WARN, "adm taskpackage (unhandled)");
494 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
495 rr->errstring = "adm-task package (unhandled)";
498 int bend_segment(void *handle, bend_segment_rr *rr)
500 ZebraHandle zh = (ZebraHandle) handle;
501 Z_Segment *segment = rr->segment;
503 if (segment->num_segmentRecords)
504 zebra_admin_import_segment(zh, rr->segment);
506 zebra_admin_import_end(zh);
510 int bend_esrequest(void *handle, bend_esrequest_rr *rr)
512 ZebraHandle zh = (ZebraHandle) handle;
514 yaz_log(YLOG_LOG, "function: " ODR_INT_PRINTF, *rr->esr->function);
515 if (rr->esr->packageName)
516 yaz_log(YLOG_LOG, "packagename: %s", rr->esr->packageName);
517 yaz_log(YLOG_LOG, "Waitaction: " ODR_INT_PRINTF, *rr->esr->waitAction);
519 if (!rr->esr->taskSpecificParameters)
521 yaz_log(YLOG_WARN, "No task specific parameters");
523 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
525 es_admin(rr, zh, rr->esr->taskSpecificParameters->u.adminService);
527 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
529 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
530 yaz_log(YLOG_LOG, "Received DB Update");
531 if (up->which == Z_IUUpdate_esRequest)
533 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
534 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
535 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
537 yaz_log(YLOG_LOG, "action");
540 switch (*toKeep->action)
542 case Z_IUOriginPartToKeep_recordInsert:
543 yaz_log(YLOG_LOG, "recordInsert");
545 case Z_IUOriginPartToKeep_recordReplace:
546 yaz_log(YLOG_LOG, "recordUpdate");
548 case Z_IUOriginPartToKeep_recordDelete:
549 yaz_log(YLOG_LOG, "recordDelete");
551 case Z_IUOriginPartToKeep_elementUpdate:
552 yaz_log(YLOG_LOG, "elementUpdate");
554 case Z_IUOriginPartToKeep_specialUpdate:
555 yaz_log(YLOG_LOG, "specialUpdate");
557 case Z_ESAdminOriginPartToKeep_shutdown:
558 yaz_log(YLOG_LOG, "shutDown");
560 case Z_ESAdminOriginPartToKeep_start:
561 yaz_log(YLOG_LOG, "start");
564 yaz_log(YLOG_LOG, " unknown (" ODR_INT_PRINTF ")",
568 if (toKeep->databaseName)
570 yaz_log(YLOG_LOG, "database: %s", toKeep->databaseName);
572 if (zebra_select_database(zh, toKeep->databaseName))
577 yaz_log(YLOG_WARN, "no database supplied for ES Update");
579 YAZ_BIB1_ES_MISSING_MANDATORY_PARAMETER_FOR_SPECIFIED_FUNCTION_;
580 rr->errstring = "database";
583 if (zebra_begin_trans(zh, 1) != ZEBRA_OK)
585 zebra_result(zh, &rr->errcode, &rr->errstring);
590 for (i = 0; notToKeep && i < notToKeep->num; i++)
592 Z_External *rec = notToKeep->elements[i]->record;
593 Odr_oct *opaque_recid = 0;
597 if (notToKeep->elements[i]->u.opaque)
599 switch(notToKeep->elements[i]->which)
601 case Z_IUSuppliedRecords_elem_opaque:
602 opaque_recid = notToKeep->elements[i]->u.opaque;
603 break; /* OK, recid already set */
604 case Z_IUSuppliedRecords_elem_number:
605 sysno_tmp = *notToKeep->elements[i]->u.number;
610 if (rec->direct_reference)
612 char oid_name_str[OID_STR_MAX];
613 const char *oid_name =
614 yaz_oid_to_string_buf(
615 rec->direct_reference,
618 yaz_log(YLOG_LOG, "record %d type %s", i,
623 case Z_External_sutrs:
624 if (rec->u.octet_aligned->len > 170)
625 yaz_log(YLOG_LOG, "%d bytes:\n%.168s ...",
629 yaz_log(YLOG_LOG, "%d bytes:\n%s",
633 case Z_External_octet:
634 if (rec->u.octet_aligned->len > 170)
635 yaz_log(YLOG_LOG, "%d bytes:\n%.168s ...",
636 rec->u.octet_aligned->len,
637 rec->u.octet_aligned->buf);
639 yaz_log(YLOG_LOG, "%d bytes\n%s",
640 rec->u.octet_aligned->len,
641 rec->u.octet_aligned->buf);
643 if (rec->which == Z_External_octet)
645 enum zebra_recctrl_action_t action = action_update;
647 const char *match_criteria = 0;
650 if (*toKeep->action ==
651 Z_IUOriginPartToKeep_recordInsert)
652 action = action_insert;
653 else if (*toKeep->action ==
654 Z_IUOriginPartToKeep_recordReplace)
655 action = action_replace;
656 else if (*toKeep->action ==
657 Z_IUOriginPartToKeep_recordDelete)
658 action = action_delete;
659 else if (*toKeep->action ==
660 Z_IUOriginPartToKeep_specialUpdate)
661 action = action_update;
665 YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
666 rr->errstring = "unsupported ES Update action";
672 size_t l = opaque_recid->len;
673 if (l >= sizeof(recid_str))
675 rr->errcode = YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
676 rr->errstring = "opaque record ID too large";
679 memcpy(recid_str, opaque_recid->buf, l);
681 match_criteria = recid_str;
683 res = zebra_update_record(
686 sysno, match_criteria, 0, /* fname */
687 (const char *) rec->u.octet_aligned->buf,
688 rec->u.octet_aligned->len);
689 if (res == ZEBRA_FAIL)
692 YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED;
693 rr->errstring = "update_record failed";
697 if (zebra_end_trans(zh) != ZEBRA_OK)
699 yaz_log(YLOG_WARN, "zebra_end_trans failed for"
700 " extended service operation");
707 yaz_log(YLOG_WARN, "Unknown Extended Service(%d)",
708 rr->esr->taskSpecificParameters->which);
709 rr->errcode = YAZ_BIB1_ES_EXTENDED_SERVICE_TYPE_UNSUPP;
715 static void bend_start(struct statserv_options_block *sob)
717 Res default_res = res_open(0, 0);
720 zebra_stop((ZebraService) sob->handle);
721 res_set(default_res, "profilePath", DEFAULT_PROFILE_PATH);
722 res_set(default_res, "modulePath", DEFAULT_MODULE_PATH);
723 sob->handle = zebra_start_res(sob->configname, default_res, 0);
724 res_close(default_res);
727 yaz_log(YLOG_FATAL, "Failed to read config `%s'", sob->configname);
733 if (!sob->inetd && !sob->background)
739 zebra_pidfname(sob->handle, pidfname);
741 fd = open(pidfname, O_EXCL|O_WRONLY|O_CREAT, 0666);
746 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
749 fd = open(pidfname, O_RDWR, 0666);
752 yaz_log(YLOG_FATAL|YLOG_ERRNO, "lock file %s", pidfname);
756 area.l_type = F_WRLCK;
757 area.l_whence = SEEK_SET;
758 area.l_len = area.l_start = 0L;
759 if (fcntl(fd, F_SETLK, &area) == -1)
761 yaz_log(YLOG_ERRNO|YLOG_FATAL, "Zebra server already running");
768 sprintf(pidstr, "%ld", (long) getpid());
769 if (write(fd, pidstr, strlen(pidstr)) != strlen(pidstr))
771 yaz_log(YLOG_ERRNO|YLOG_FATAL, "write fail %s", pidfname);
779 static void bend_stop(struct statserv_options_block *sob)
784 if (!sob->inetd && !sob->background && sob->handle)
787 zebra_pidfname(sob->handle, pidfname);
793 ZebraService service = sob->handle;
798 int main(int argc, char **argv)
800 struct statserv_options_block *sob;
802 sob = statserv_getcontrol();
803 strcpy(sob->configname, "zebra.cfg");
804 sob->bend_start = bend_start;
805 sob->bend_stop = bend_stop;
807 strcpy(sob->service_name, "zebrasrv");
808 strcpy(sob->service_display_name, "Zebra Server");
810 statserv_setcontrol(sob);
812 return statserv_main(argc, argv, bend_init, bend_close);
817 * c-file-style: "Stroustrup"
818 * indent-tabs-mode: nil
820 * vim: shiftwidth=4 tabstop=8 expandtab