From: Dennis Schafroth Date: Tue, 31 Aug 2010 11:14:42 +0000 (+0200) Subject: Merge branch 'master' into solr_facets X-Git-Tag: v4.1.0~18^2 X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=cff93bfc3cff822251abf7687bb5791a81b2bf0c;hp=b8b750a84e0c9f7253d210f9604e385bd84a7569 Merge branch 'master' into solr_facets --- diff --git a/client/client.c b/client/client.c index 6bb6b5e..ba217e7 100644 --- a/client/client.c +++ b/client/client.c @@ -1455,7 +1455,7 @@ static int send_SRW_searchRequest(const char *arg) return 0; } sr->u.request->maximumRecords = odr_intdup(out, 0); - + sr->u.request->facetList = facet_list; if (record_schema) sr->u.request->recordSchema = record_schema; if (recordsyntax_size == 1 && !yaz_matchstr(recordsyntax_list[0], "xml")) @@ -2280,6 +2280,22 @@ static int only_z3950(void) return 0; } +static int is_SRW(void) +{ + if (!conn) + { + printf("Not connected yet\n"); + return 1; + } + if (protocol == PROTO_HTTP && yaz_matchstr(sru_method, "solr")) + { + printf("Not supported by SRW\n"); + return 1; + } + return 0; +} + + static int cmd_update_common(const char *arg, int version); static int cmd_update(const char *arg) @@ -2887,6 +2903,8 @@ static int cmd_find(const char *arg) static int cmd_facets(const char *arg) { + /* TODO Wrong odr. Loosing memory */ + ODR odr = odr_createmem(ODR_ENCODE); int size = 0; if (!*arg) { @@ -2895,25 +2913,17 @@ static int cmd_facets(const char *arg) return 0; } size = strlen(arg); - if (only_z3950()) - { - printf("Currently only supported for Z39.50.\n"); - return 0; + if (is_SRW()) { + printf("WARN: No supported for SRW/SRU.\n"); } - else - { - /* TODO Wrong odr. Loosing memory */ - ODR odr = odr_createmem(ODR_ENCODE); - facet_list = yaz_pqf_parse_facet_list(odr, arg); + facet_list = yaz_pqf_parse_facet_list(odr, arg); - if (!facet_list) - { - printf("Invalid facet list: %s", arg); - return 0; - } - return 1; + if (!facet_list) + { + printf("Invalid facet list: %s", arg); + return 0; } - return 2; + return 1; } @@ -4305,6 +4315,9 @@ static void handle_srw_response(Z_SRW_searchRetrieveResponse *res) } if (res->numberOfRecords) printf("Number of hits: " ODR_INT_PRINTF "\n", *res->numberOfRecords); + if (res->facetList) { + display_facets(res->facetList); + } for (i = 0; inum_records; i++) handle_srw_record(res->records + i); } diff --git a/include/yaz/srw.h b/include/yaz/srw.h index 7c2e575..bd0c782 100644 --- a/include/yaz/srw.h +++ b/include/yaz/srw.h @@ -37,6 +37,7 @@ #include #include #include +#include "facet.h" YAZ_BEGIN_CDECL @@ -92,6 +93,7 @@ typedef struct { char *database; char *stylesheet; Odr_int *resultSetTTL; + Z_FacetList *facetList; } Z_SRW_searchRetrieveRequest; typedef struct { @@ -107,6 +109,7 @@ typedef struct { Odr_int *nextRecordPosition; Z_SRW_extra_record **extra_records; /* of size num_records */ + Z_FacetList *facetList; } Z_SRW_searchRetrieveResponse; typedef struct { diff --git a/src/solr.c b/src/solr.c index a7cdb52..807326e 100644 --- a/src/solr.c +++ b/src/solr.c @@ -13,12 +13,207 @@ #include #include #include +#include +#include #include "sru-p.h" #if YAZ_HAVE_XML2 #include #include + +#define SOLR_MAX_PARAMETERS 100 + +const char *xml_node_attribute_value_get(xmlNodePtr ptr, const char *node_name, const char *attribute_name) { + + struct _xmlAttr *attr; + // check if the node name matches + if (strcmp((const char*) ptr->name, node_name)) + return 0; + // check if the attribute name and return the value + for (attr = ptr->properties; attr; attr = attr->next) + if (attr->children && attr->children->type == XML_TEXT_NODE) { + if (!strcmp((const char *) attr->name, attribute_name)) + return (const char *) attr->children->content; + } + return 0; +} + + +static int match_xml_node_attribute(xmlNodePtr ptr, const char *node_name, const char *attribute_name, const char *value) +{ + const char *attribute_value; + // check if the node name matches + if (strcmp((const char*) ptr->name, node_name)) + return 0; + attribute_value = xml_node_attribute_value_get(ptr, node_name, attribute_name); + if (attribute_value && !strcmp(attribute_value, value)) + return 1; + return 0; +} + +static void yaz_solr_decode_result_docs(ODR o, xmlNodePtr ptr, Odr_int start, Z_SRW_searchRetrieveResponse *sr) { + xmlNodePtr node; + int offset = 0; + int i = 0; + + sr->num_records = 0; + for (node = ptr->children; node; node = node->next) + if (node->type == XML_ELEMENT_NODE) + sr->num_records++; + + sr->records = odr_malloc(o, sizeof(*sr->records) * sr->num_records); + + for (node = ptr->children; node; node = node->next) + { + if (node->type == XML_ELEMENT_NODE) + { + Z_SRW_record *record = sr->records + i; + xmlBufferPtr buf = xmlBufferCreate(); + xmlNode *tmp = xmlCopyNode(node, 1); + + xmlNodeDump(buf, tmp->doc, tmp, 0, 0); + + xmlFreeNode(tmp); + + record->recordSchema = 0; + record->recordPacking = Z_SRW_recordPacking_XML; + record->recordData_len = buf->use; + record->recordData_buf = odr_malloc(o, buf->use + 1); + memcpy(record->recordData_buf, buf->content, buf->use); + record->recordData_buf[buf->use] = '\0'; + // TODO Solve the real problem in zoom-sru, that doesnt work with 0-based indexes. + // Work-around: Making the recordPosition 1-based. + record->recordPosition = odr_intdup(o, start + offset + 1); + + xmlBufferFree(buf); + + offset++; + i++; + } + } +} + +static int yaz_solr_decode_result(ODR o, xmlNodePtr ptr, Z_SRW_searchRetrieveResponse *sr) { + Odr_int start = 0; + struct _xmlAttr *attr; + for (attr = ptr->properties; attr; attr = attr->next) + if (attr->children && attr->children->type == XML_TEXT_NODE) { + if (!strcmp((const char *) attr->name, "numFound")) { + sr->numberOfRecords = odr_intdup(o, odr_atoi( + (const char *) attr->children->content)); + } + else if (!strcmp((const char *) attr->name, "start")) { + start = odr_atoi((const char *) attr->children->content); + } + } + if (sr->numberOfRecords && *sr->numberOfRecords > 0) + yaz_solr_decode_result_docs(o, ptr, start, sr); + if (sr->numberOfRecords) + return 0; + return -1; +} + +static Z_AttributeList *yaz_solr_use_atttribute_create(ODR o, const char *name) { + Z_AttributeList *attributes= (Z_AttributeList *) odr_malloc(o, sizeof(*attributes)); + Z_AttributeElement ** elements; + attributes->num_attributes = 1; + /* TODO check on name instead + if (!attributes->num_attributes) { + attributes->attributes = (Z_AttributeElement**)odr_nullval(); + return attributes; + } + */ + elements = (Z_AttributeElement**) odr_malloc (o, attributes->num_attributes * sizeof(*elements)); + elements[0] = (Z_AttributeElement*)odr_malloc(o,sizeof(**elements)); + elements[0]->attributeType = odr_malloc(o, sizeof(*elements[0]->attributeType)); + *elements[0]->attributeType = 1; + elements[0]->attributeSet = odr_nullval(); + elements[0]->which = Z_AttributeValue_complex; + elements[0]->value.complex = (Z_ComplexAttribute *) odr_malloc(o, sizeof(Z_ComplexAttribute)); + elements[0]->value.complex->num_list = 1; + elements[0]->value.complex->list = (Z_StringOrNumeric **) odr_malloc(o, 1 * sizeof(Z_StringOrNumeric *)); + elements[0]->value.complex->list[0] = (Z_StringOrNumeric *) odr_malloc(o, sizeof(Z_StringOrNumeric)); + elements[0]->value.complex->list[0]->which = Z_StringOrNumeric_string; + elements[0]->value.complex->list[0]->u.string = (Z_InternationalString *) odr_strdup(o, name); + elements[0]->value.complex->semanticAction = 0; + elements[0]->value.complex->num_semanticAction = 0; + attributes->attributes = elements; + return attributes; +} + + +static const char *get_facet_term_count(xmlNodePtr node, int *freq) { + + const char *term = xml_node_attribute_value_get(node, "int", "name"); + xmlNodePtr child; + WRBUF wrbuf = wrbuf_alloc(); + if (!term) + return term; + + for (child = node->children; child ; child = child->next) { + if (child->type == XML_TEXT_NODE) + wrbuf_puts(wrbuf, (const char *) child->content); + } + *freq = atoi(wrbuf_cstr(wrbuf)); + wrbuf_destroy(wrbuf); + return term; +} + +Z_FacetField *yaz_solr_decode_facet_field(ODR o, xmlNodePtr ptr, Z_SRW_searchRetrieveResponse *sr) +{ + // USE attribute + const char* name = xml_node_attribute_value_get(ptr, "lst", "name"); + Z_AttributeList *list = yaz_solr_use_atttribute_create(o, name); + Z_FacetField *facet_field; + int num_terms = 0; + int index = 0; + xmlNodePtr node; + for (node = ptr->children; node; node = node->next) { + num_terms++; + } + facet_field = facet_field_create(o, list, num_terms); + index = 0; + for (node = ptr->children; node; node = node->next) { + int count = 0; + const char *term = get_facet_term_count(node, &count); + facet_field_term_set(o, facet_field, facet_term_create(o, term_create(o, term), count), index); + index++; + } + return facet_field; +} + +static int yaz_solr_decode_facet_counts(ODR o, xmlNodePtr root, Z_SRW_searchRetrieveResponse *sr) { + xmlNodePtr ptr; + for (ptr = root->children; ptr; ptr = ptr->next) + { + if (match_xml_node_attribute(ptr, "lst", "name", "facet_fields")) + { + xmlNodePtr node; + Z_FacetList *facet_list; + int num_facets = 0; + for (node = ptr->children; node; node= node->next) + { + num_facets++; + } + facet_list = facet_list_create(o, num_facets); + num_facets = 0; + for (node = ptr->children; node; node= node->next) + { + facet_list_field_set(o, facet_list, yaz_solr_decode_facet_field(o, node, sr), num_facets); + num_facets++; + } + sr->facetList = facet_list; + break; + } + } + return 0; +} + +static void yaz_solr_decode_facets(ODR o, xmlNodePtr ptr, Z_SRW_searchRetrieveResponse *sr) { + if (match_xml_node_attribute(ptr, "lst", "name", "facet_counts")) + yaz_solr_decode_facet_counts(o, ptr->children, sr); +} #endif int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup) @@ -29,7 +224,6 @@ int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup) xmlDocPtr doc = xmlParseMemory(content_buf, content_len); int ret = 0; xmlNodePtr ptr = 0; - Odr_int start = 0; Z_SRW_PDU *pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response); Z_SRW_searchRetrieveResponse *sr = pdu->u.response; @@ -50,78 +244,18 @@ int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup) } else { - /** look for result node */ + /** look for result (required) and facets node (optional) */ + int rc_result = -1; + int rc_facets = 0; for (ptr = root->children; ptr; ptr = ptr->next) { if (ptr->type == XML_ELEMENT_NODE && !strcmp((const char *) ptr->name, "result")) - break; - } - if (!ptr) - { - ret = -1; - } - } - } - if (ptr) - { /* got result node */ - struct _xmlAttr *attr; - - for (attr = ptr->properties; attr; attr = attr->next) - if (attr->children && attr->children->type == XML_TEXT_NODE) - { - if (!strcmp((const char *) attr->name, "numFound")) - { - sr->numberOfRecords = - odr_intdup(o, - odr_atoi( - (const char *) attr->children->content)); - } - else if (!strcmp((const char *) attr->name, "start")) - { - start = odr_atoi((const char *) attr->children->content); - } - } - } - if (ptr) - { - xmlNodePtr node; - int offset = 0; - int i = 0; - - sr->num_records = 0; - for (node = ptr->children; node; node = node->next) - if (node->type == XML_ELEMENT_NODE) - sr->num_records++; - - sr->records = odr_malloc(o, sizeof(*sr->records) * sr->num_records); - - for (node = ptr->children; node; node = node->next) - { - if (node->type == XML_ELEMENT_NODE) - { - Z_SRW_record *record = sr->records + i; - xmlBufferPtr buf = xmlBufferCreate(); - xmlNode *tmp = xmlCopyNode(node, 1); - - xmlNodeDump(buf, tmp->doc, tmp, 0, 0); - - xmlFreeNode(tmp); - - record->recordSchema = 0; - record->recordPacking = Z_SRW_recordPacking_XML; - record->recordData_len = buf->use; - record->recordData_buf = odr_malloc(o, buf->use + 1); - memcpy(record->recordData_buf, buf->content, buf->use); - record->recordData_buf[buf->use] = '\0'; - // TODO Solve the real problem: Making the recordPosition 1-based due to "funny" code in zoom-sru - record->recordPosition = odr_intdup(o, start + offset + 1); - - xmlBufferFree(buf); - - offset++; - i++; + rc_result = yaz_solr_decode_result(o, ptr, sr); + if (match_xml_node_attribute(ptr, "lst", "name", "facet_counts")) + rc_facets = yaz_solr_decode_facet_counts(o, ptr, sr); } + ret = rc_result + rc_facets; } } if (doc) @@ -134,11 +268,37 @@ int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup) #endif } +static void yaz_solr_encode_facet_field(ODR encode, char **name, char **value, int *i, Z_FacetField *facet_field, int *limit) { + Z_AttributeList *attribute_list = facet_field->attributes; + struct yaz_facet_attr attr_values; + yaz_facet_attr_init(&attr_values); + yaz_facet_attr_get_z_attributes(attribute_list, &attr_values); + // TODO do we want to support server decided + if (!attr_values.errcode && attr_values.useattr) { + yaz_add_name_value_str(encode, name, value, i, "facet.field", (char *) attr_values.useattr); + // TODO max(attr_values, *limit); + if (attr_values.limit > 0 && attr_values.limit > *limit) { + *limit = attr_values.limit; + } + } +} + +static void yaz_solr_encode_facet_list(ODR encode, char **name, char **value, int *i, Z_FacetList *facet_list, int *limit) { + + int index; + for (index = 0; index < facet_list->num; index++) { + yaz_solr_encode_facet_field(encode, name, value, i, facet_list->elements[index], limit); + + } +} + + int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, ODR encode, const char *charset) { const char *solr_op = 0; - char *name[30], *value[30]; + //TODO Change. not a nice hard coded, unchecked limit. + char *name[SOLR_MAX_PARAMETERS], *value[SOLR_MAX_PARAMETERS]; char *uri_args; char *path; int i = 0; @@ -148,33 +308,45 @@ int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, switch (srw_pdu->which) { - case Z_SRW_searchRetrieve_request: + case Z_SRW_searchRetrieve_request: { + Z_SRW_searchRetrieveRequest *request = srw_pdu->u.request; solr_op = "select"; - switch(srw_pdu->u.request->query_type) { case Z_SRW_query_type_pqf: yaz_add_name_value_str(encode, name, value, &i, - "q", srw_pdu->u.request->query.pqf); + "q", request->query.pqf); break; case Z_SRW_query_type_cql: yaz_add_name_value_str(encode, name, value, &i, - "q", srw_pdu->u.request->query.cql); + "q", request->query.cql); break; default: return -1; } if (srw_pdu->u.request->startRecord) { - Odr_int start = *srw_pdu->u.request->startRecord - 1; + Odr_int start = *request->startRecord - 1; yaz_add_name_value_int(encode, name, value, &i, "start", &start); } yaz_add_name_value_int(encode, name, value, &i, - "rows", srw_pdu->u.request->maximumRecords); + "rows", request->maximumRecords); yaz_add_name_value_str(encode, name, value, &i, - "fl", srw_pdu->u.request->recordSchema); + "fl", request->recordSchema); + + if (request->facetList) { + Z_FacetList *facet_list = request->facetList; + int limit = 0; + Odr_int olimit; + yaz_add_name_value_str(encode, name, value, &i, "facet", "true"); + yaz_solr_encode_facet_list(encode, name, value, &i, facet_list, &limit); + olimit = limit; + yaz_add_name_value_int(encode, name, value, &i, "facet.limit", &olimit); + + } break; + } default: return -1; } diff --git a/src/srwutil.c b/src/srwutil.c index 9e71129..2746199 100644 --- a/src/srwutil.c +++ b/src/srwutil.c @@ -747,6 +747,7 @@ Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version) sr->u.request->database = 0; sr->u.request->resultSetTTL = 0; sr->u.request->stylesheet = 0; + sr->u.request->facetList = 0; break; case Z_SRW_searchRetrieve_response: sr->u.response = (Z_SRW_searchRetrieveResponse *) @@ -760,6 +761,7 @@ Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version) sr->u.response->num_diagnostics = 0; sr->u.response->nextRecordPosition = 0; sr->u.response->extra_records = 0; + sr->u.response->facetList = 0; break; case Z_SRW_explain_request: sr->u.explain_request = (Z_SRW_explainRequest *) diff --git a/src/zoom-sru.c b/src/zoom-sru.c index 57f02a3..433e871 100644 --- a/src/zoom-sru.c +++ b/src/zoom-sru.c @@ -13,6 +13,9 @@ #include "zoom-p.h" #include +#include + +void handle_facet_list(ZOOM_resultset r, Z_FacetList *fl); #if YAZ_HAVE_XML2 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d) @@ -138,7 +141,7 @@ zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c) Z_SRW_PDU *sr = 0; const char *option_val = 0; Z_Query *z_query; - + Z_FacetList *facet_list = 0; if (c->error) /* don't continue on error */ return zoom_complete; assert(c->tasks); @@ -151,6 +154,10 @@ zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c) ZOOM_options_set(resultset->options, "setname", resultset->setname); start = &c->tasks->u.search.start; count = &c->tasks->u.search.count; + const char *facets = ZOOM_options_get(resultset->options, "facets"); + if (facets) { + facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets); + } break; case ZOOM_TASK_RETRIEVE: resultset = c->tasks->u.retrieve.resultset; @@ -213,6 +220,7 @@ zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c) c->odr_out, (resultset->step > 0 && resultset->step < *count) ? resultset->step : *count); sr->u.request->recordSchema = resultset->schema; + sr->u.request->facetList = facet_list; option_val = ZOOM_resultset_option_get(resultset, "recordPacking"); if (option_val) @@ -258,6 +266,8 @@ static zoom_ret handle_srw_response(ZOOM_connection c, ZOOM_connection_put_event(c, event); c->tasks->u.search.recv_search_fired = 1; } + if (res->facetList) + handle_facet_list(resultset, res->facetList); break; case ZOOM_TASK_RETRIEVE: resultset = c->tasks->u.retrieve.resultset; diff --git a/src/zoom-z3950.c b/src/zoom-z3950.c index bbd2e2a..5fc7c25 100644 --- a/src/zoom-z3950.c +++ b/src/zoom-z3950.c @@ -1136,6 +1136,22 @@ static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) { return facet_field; } +/* Can be share with SOLR/SRU/SRW requests */ +void handle_facet_list(ZOOM_resultset r, Z_FacetList *fl) { + int j; + r->num_facets = fl->num; + yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num); + r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets)); + r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names)); + for (j = 0; j < fl->num; j++) + { + r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]); + if (!r->facets[j]) + yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j); + r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]); + } +} + static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r, Z_OtherInformation *o) { @@ -1147,19 +1163,7 @@ static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r, Z_External *ext = o->list[i]->information.externallyDefinedInfo; if (ext->which == Z_External_userFacets) { - int j; - Z_FacetList *fl = ext->u.facetList; - r->num_facets = fl->num; - yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num); - r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets)); - r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names)); - for (j = 0; j < fl->num; j++) - { - r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]); - if (!r->facets[j]) - yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j); - r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]); - } + handle_facet_list(r, ext->u.facetList); } } }