src/srwutil.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data
   3  * See the file LICENSE for details.
   4  */
   5 /**
   6  * \file srwutil.c
   7  * \brief Implements SRW/SRU utilities.
   8  */
   9 #if HAVE_CONFIG_H
  10 #include <config.h>
  11 #endif
  12
  13 #include <stdlib.h>
  14 #include <assert.h>
  15 #include <yaz/srw.h>
  16 #include <yaz/matchstr.h>
  17 #include <yaz/base64.h>
  18 #include <yaz/yaz-iconv.h>
  19 #include "sru-p.h"
  20
  21 #define MAX_SRU_PARAMETERS 30
  22
  23 static char *yaz_decode_sru_dbpath_odr(ODR n, const char *uri, size_t len)
  24 {
  25     return odr_strdupn(n, uri, len);
  26 }
  27
  28 void yaz_encode_sru_dbpath_buf(char *dst, const char *db)
  29 {
  30     assert(db);
  31     *dst = '/';
  32     strcpy(dst+1, db);
  33 }
  34
  35 char *yaz_encode_sru_dbpath_odr(ODR out, const char *db)
  36 {
  37     char *dst = odr_malloc(out, 3 * strlen(db) + 2);
  38     yaz_encode_sru_dbpath_buf(dst, db);
  39     return dst;
  40 }
  41
  42 Z_AttributeList *yaz_use_attribute_create(ODR o, const char *name)
  43 {
  44     Z_AttributeList *attributes= (Z_AttributeList *)
  45         odr_malloc(o, sizeof(*attributes));
  46     Z_AttributeElement ** elements;
  47     attributes->num_attributes = 1;
  48     elements = (Z_AttributeElement**)
  49         odr_malloc(o, attributes->num_attributes * sizeof(*elements));
  50     elements[0] = (Z_AttributeElement*) odr_malloc(o,sizeof(**elements));
  51     elements[0]->attributeType = odr_intdup(o, 1);
  52     elements[0]->attributeSet = odr_nullval();
  53     elements[0]->which = Z_AttributeValue_complex;
  54     elements[0]->value.complex = (Z_ComplexAttribute *)
  55         odr_malloc(o, sizeof(Z_ComplexAttribute));
  56     elements[0]->value.complex->num_list = 1;
  57     elements[0]->value.complex->list = (Z_StringOrNumeric **)
  58         odr_malloc(o, 1 * sizeof(Z_StringOrNumeric *));
  59     elements[0]->value.complex->list[0] = (Z_StringOrNumeric *)
  60         odr_malloc(o, sizeof(Z_StringOrNumeric));
  61     elements[0]->value.complex->list[0]->which = Z_StringOrNumeric_string;
  62     elements[0]->value.complex->list[0]->u.string = odr_strdup(o, name);
  63     elements[0]->value.complex->semanticAction = 0;
  64     elements[0]->value.complex->num_semanticAction = 0;
  65     attributes->attributes = elements;
  66     return attributes;
  67 }
  68
  69 #if YAZ_HAVE_XML2
  70 const char *yaz_element_attribute_value_get(xmlNodePtr ptr,
  71                                             const char *node_name,
  72                                             const char *attribute_name)
  73 {
  74     struct _xmlAttr *attr;
  75     // check if the node name matches
  76     if (strcmp((const char*) ptr->name, node_name))
  77         return 0;
  78     // check if the attribute name and return the value
  79     for (attr = ptr->properties; attr; attr = attr->next)
  80         if (attr->children && attr->children->type == XML_TEXT_NODE)
  81         {
  82             if (!strcmp((const char *) attr->name, attribute_name))
  83                 return (const char *) attr->children->content;
  84         }
  85     return 0;
  86 }
  87 #endif
  88
  89 int yaz_srw_check_content_type(Z_HTTP_Response *hres)
  90 {
  91     const char *content_type = z_HTTP_header_lookup(hres->headers,
  92                                                     "Content-Type");
  93     if (content_type)
  94     {
  95         if (!yaz_strcmp_del("text/xml", content_type, "; "))
  96             return 1;
  97         if (!yaz_strcmp_del("application/xml", content_type, "; "))
  98             return 1;
  99     }
 100     return 0;
 101 }
 102
 103 /**
 104  * Look for authentication tokens in HTTP Basic parameters or in x-username/x-password
 105  * parameters. Added by SH.
 106  */
 107 static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq,
 108                                char *username, char *password, ODR decode)
 109 {
 110     const char *basic = z_HTTP_header_lookup(hreq->headers, "Authorization");
 111
 112     if (username)
 113         sr->username = username;
 114     if (password)
 115         sr->password = password;
 116
 117     if (basic)
 118     {
 119         int len;
 120         char out[256];
 121         char ubuf[256] = "", pbuf[256] = "", *p;
 122         if (strncmp(basic, "Basic ", 6))
 123             return;
 124         basic += 6;
 125         len = strlen(basic);
 126         if (!len || len > 256)
 127             return;
 128         yaz_base64decode(basic, out);
 129         /* Format of out should be username:password at this point */
 130         strcpy(ubuf, out);
 131         if ((p = strchr(ubuf, ':')))
 132         {
 133             *(p++) = '\0';
 134             if (*p)
 135                 strcpy(pbuf, p);
 136         }
 137         if (*ubuf)
 138             sr->username = odr_strdup(decode, ubuf);
 139         if (*pbuf)
 140             sr->password = odr_strdup(decode, pbuf);
 141     }
 142 }
 143
 144 void yaz_uri_val_int(const char *path, const char *name, ODR o, Odr_int **intp)
 145 {
 146     const char *v = yaz_uri_val(path, name, o);
 147     if (v)
 148         *intp = odr_intdup(o, atoi(v));
 149 }
 150
 151 void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d,
 152                            const char *uri, const char *message,
 153                            const char *details)
 154 {
 155     d->uri = odr_strdup(o, uri);
 156     if (message)
 157         d->message = odr_strdup(o, message);
 158     else
 159         d->message = 0;
 160     if (details)
 161         d->details = odr_strdup(o, details);
 162     else
 163         d->details = 0;
 164 }
 165
 166 void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
 167                            int code, const char *details)
 168 {
 169     char uri[40];
 170
 171     sprintf(uri, "info:srw/diagnostic/1/%d", code);
 172     yaz_mk_srw_diagnostic(o, d, uri, 0, details);
 173 }
 174
 175 void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
 176                                 int *num, const char *uri,
 177                                 const char *message, const char *details)
 178 {
 179     Z_SRW_diagnostic *d_new;
 180     d_new = (Z_SRW_diagnostic *) odr_malloc(o, (*num + 1)* sizeof(**d));
 181     if (*num)
 182         memcpy(d_new, *d, *num *sizeof(**d));
 183     *d = d_new;
 184
 185     yaz_mk_srw_diagnostic(o, *d + *num, uri, message, details);
 186     (*num)++;
 187 }
 188
 189 void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
 190                             int *num, int code, const char *addinfo)
 191 {
 192     char uri[40];
 193
 194     sprintf(uri, "info:srw/diagnostic/1/%d", code);
 195     yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
 196 }
 197
 198
 199 void yaz_add_sru_update_diagnostic(ODR o, Z_SRW_diagnostic **d,
 200                                    int *num, int code, const char *addinfo)
 201 {
 202     char uri[40];
 203
 204     sprintf(uri, "info:srw/diagnostic/12/%d", code);
 205     yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
 206 }
 207
 208
 209 void yaz_mk_sru_surrogate(ODR o, Z_SRW_record *record, int pos,
 210                           int code, const char *details)
 211 {
 212     const char *message = yaz_diag_srw_str(code);
 213     int len = 200;
 214     if (message)
 215         len += strlen(message);
 216     if (details)
 217         len += strlen(details);
 218
 219     record->recordData_buf = (char *) odr_malloc(o, len);
 220
 221     sprintf(record->recordData_buf, "<diagnostic "
 222             "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
 223             " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
 224     if (details)
 225         sprintf(record->recordData_buf + strlen(record->recordData_buf),
 226                 " <details>%s</details>\n", details);
 227     if (message)
 228         sprintf(record->recordData_buf + strlen(record->recordData_buf),
 229                 " <message>%s</message>\n", message);
 230     sprintf(record->recordData_buf + strlen(record->recordData_buf),
 231             "</diagnostic>\n");
 232     record->recordData_len = strlen(record->recordData_buf);
 233     record->recordPosition = odr_intdup(o, pos);
 234     record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
 235 }
 236
 237 static void grab_charset(ODR o, const char *content_type, char **charset)
 238 {
 239     if (charset)
 240     {
 241         const char *charset_p = 0;
 242         if (content_type && (charset_p = strstr(content_type, "; charset=")))
 243         {
 244             int i = 0;
 245             charset_p += 10;
 246             while (i < 20 && charset_p[i] &&
 247                    !strchr("; \n\r", charset_p[i]))
 248                 i++;
 249             *charset = (char*) odr_malloc(o, i+1);
 250             memcpy(*charset, charset_p, i);
 251             (*charset)[i] = '\0';
 252         }
 253     }
 254 }
 255
 256 int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 257                    Z_SOAP **soap_package, ODR decode, char **charset)
 258 {
 259     if (!strcmp(hreq->method, "POST"))
 260     {
 261         const char *content_type = z_HTTP_header_lookup(hreq->headers,
 262                                                         "Content-Type");
 263         if (content_type &&
 264             (!yaz_strcmp_del("text/xml", content_type, "; ") ||
 265              !yaz_strcmp_del("application/soap+xml", content_type, "; ") ||
 266              !yaz_strcmp_del("text/plain", content_type, "; ")))
 267         {
 268             char *db = "Default";
 269             const char *p0 = hreq->path, *p1;
 270             int ret = -1;
 271
 272             static Z_SOAP_Handler soap_handlers[5] = {
 273 #if YAZ_HAVE_XML2
 274                 { YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec },
 275                 { YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec },
 276                 { YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec },
 277                 { YAZ_XMLNS_SRU_v2_mask, 0, (Z_SOAP_fun) yaz_srw_codec },
 278 #endif
 279                 {0, 0, 0}
 280             };
 281
 282             if (*p0 == '/')
 283                 p0++;
 284             p1 = strchr(p0, '?');
 285             if (!p1)
 286                 p1 = p0 + strlen(p0);
 287             if (p1 != p0)
 288                 db = yaz_decode_sru_dbpath_odr(decode, p0, p1 - p0);
 289             grab_charset(decode, content_type, charset);
 290
 291             ret = z_soap_codec(decode, soap_package,
 292                                &hreq->content_buf, &hreq->content_len,
 293                                soap_handlers);
 294             if (ret == 0 && (*soap_package)->which == Z_SOAP_generic)
 295             {
 296                 *srw_pdu = (Z_SRW_PDU*) (*soap_package)->u.generic->p;
 297                 yaz_srw_decodeauth(*srw_pdu, hreq, 0, 0, decode);
 298
 299                 if ((*soap_package)->u.generic->no == 3) /* SRU 2 ! */
 300                     (*soap_package)->u.generic->no = 0;
 301                 if ((*srw_pdu)->which == Z_SRW_searchRetrieve_request &&
 302                     (*srw_pdu)->u.request->database == 0)
 303                     (*srw_pdu)->u.request->database = db;
 304
 305                 if ((*srw_pdu)->which == Z_SRW_explain_request &&
 306                     (*srw_pdu)->u.explain_request->database == 0)
 307                     (*srw_pdu)->u.explain_request->database = db;
 308
 309                 if ((*srw_pdu)->which == Z_SRW_scan_request &&
 310                     (*srw_pdu)->u.scan_request->database == 0)
 311                     (*srw_pdu)->u.scan_request->database = db;
 312
 313                 if ((*srw_pdu)->which == Z_SRW_update_request &&
 314                     (*srw_pdu)->u.update_request->database == 0)
 315                     (*srw_pdu)->u.update_request->database = db;
 316
 317                 return 0;
 318             }
 319             return 1;
 320         }
 321     }
 322     return 2;
 323 }
 324
 325 #if YAZ_HAVE_XML2
 326 static int yaz_sru_decode_integer(ODR odr, const char *pname,
 327                                   const char *valstr, Odr_int **valp,
 328                                   Z_SRW_diagnostic **diag, int *num_diag,
 329                                   int min_value)
 330 {
 331     int ival;
 332     if (!valstr)
 333         return 0;
 334     if (sscanf(valstr, "%d", &ival) != 1)
 335     {
 336         yaz_add_srw_diagnostic(odr, diag, num_diag,
 337                                YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname);
 338         return 0;
 339     }
 340     if (min_value >= 0 && ival < min_value)
 341     {
 342         yaz_add_srw_diagnostic(odr, diag, num_diag,
 343                                YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname);
 344         return 0;
 345     }
 346     *valp = odr_intdup(odr, ival);
 347     return 1;
 348 }
 349 #endif
 350
 351 /**
 352    http://www.loc.gov/z3950/agency/zing/srw/service.html
 353 */
 354 int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 355                    Z_SOAP **soap_package, ODR decode, char **charset,
 356                    Z_SRW_diagnostic **diag, int *num_diag)
 357 {
 358 #if YAZ_HAVE_XML2
 359     static Z_SOAP_Handler soap_handlers[2] = {
 360         {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
 361         {0, 0, 0}
 362     };
 363 #endif
 364     const char *content_type = z_HTTP_header_lookup(hreq->headers,
 365                                                     "Content-Type");
 366
 367     /*
 368       SRU GET: ignore content type.
 369       SRU POST: we support "application/x-www-form-urlencoded";
 370       not  "multipart/form-data" .
 371     */
 372     if (!strcmp(hreq->method, "GET")
 373         ||
 374         (!strcmp(hreq->method, "POST") && content_type &&
 375          !yaz_strcmp_del("application/x-www-form-urlencoded",
 376                          content_type, "; ")))
 377     {
 378         char *db = "Default";
 379         const char *p0 = hreq->path, *p1;
 380 #if YAZ_HAVE_XML2
 381         const char *operation = 0;
 382         char *version = 0;
 383         char *query = 0;
 384         char *queryType = "cql";
 385         char *username = 0;
 386         char *password = 0;
 387         char *sortKeys = 0;
 388         char *stylesheet = 0;
 389         char *scanClause = 0;
 390         char *recordXPath = 0;
 391         char *recordSchema = 0;
 392         char *recordXMLEscaping = 0;
 393         char *recordPacking = 0;
 394         char *maximumRecords = 0;
 395         char *startRecord = 0;
 396         char *maximumTerms = 0;
 397         char *responsePosition = 0;
 398         Z_SRW_extra_arg *extra_args = 0;
 399 #endif
 400         char **uri_name;
 401         char **uri_val;
 402
 403         grab_charset(decode, content_type, charset);
 404         if (charset && *charset == 0 && !strcmp(hreq->method, "GET"))
 405             *charset = "UTF-8";
 406
 407         if (*p0 == '/')
 408             p0++;
 409         p1 = strchr(p0, '?');
 410         if (!p1)
 411             p1 = p0 + strlen(p0);
 412         if (p1 != p0)
 413             db = yaz_decode_sru_dbpath_odr(decode, p0, p1 - p0);
 414         if (!strcmp(hreq->method, "POST"))
 415             p1 = hreq->content_buf;
 416         yaz_uri_to_array(p1, decode, &uri_name, &uri_val);
 417 #if YAZ_HAVE_XML2
 418         if (uri_name)
 419         {
 420             int i;
 421             for (i = 0; uri_name[i]; i++)
 422             {
 423                 char *n = uri_name[i];
 424                 char *v = uri_val[i];
 425                 if (!strcmp(n, "query"))
 426                     query = v;
 427                 else if (!strcmp(n, "x-pquery"))
 428                 {
 429                     query = v;
 430                     queryType = "pqf";
 431                 }
 432                 else if (!strcmp(n, "queryType"))
 433                     queryType = v;
 434                 else if (!strcmp(n, "x-username"))
 435                     username = v;
 436                 else if (!strcmp(n, "x-password"))
 437                     password = v;
 438                 else if (!strcmp(n, "operation"))
 439                     operation = v;
 440                 else if (!strcmp(n, "stylesheet"))
 441                     stylesheet = v;
 442                 else if (!strcmp(n, "sortKeys"))
 443                     sortKeys = v;
 444                 else if (!strcmp(n, "recordXPath"))
 445                     recordXPath = v;
 446                 else if (!strcmp(n, "recordSchema"))
 447                     recordSchema = v;
 448                 else if (!strcmp(n, "recordPacking"))
 449                     recordPacking = v;
 450                 else if (!strcmp(n, "recordXMLEscaping"))
 451                     recordXMLEscaping = v;
 452                 else if (!strcmp(n, "version"))
 453                     version = v;
 454                 else if (!strcmp(n, "scanClause"))
 455                     scanClause = v;
 456                 else if (!strcmp(n, "x-pScanClause"))
 457                 {
 458                     scanClause = v;
 459                     queryType = "pqf";
 460                 }
 461                 else if (!strcmp(n, "maximumRecords"))
 462                     maximumRecords = v;
 463                 else if (!strcmp(n, "startRecord"))
 464                     startRecord = v;
 465                 else if (!strcmp(n, "maximumTerms"))
 466                     maximumTerms = v;
 467                 else if (!strcmp(n, "responsePosition"))
 468                     responsePosition = v;
 469                 else if (!strcmp(n, "extraRequestData"))
 470                     ; /* ignoring extraRequestData */
 471                 else if (n[0] == 'x' && n[1] == '-')
 472                 {
 473                     Z_SRW_extra_arg **l = &extra_args;
 474                     while (*l)
 475                         l = &(*l)->next;
 476                     *l = (Z_SRW_extra_arg *) odr_malloc(decode, sizeof(**l));
 477                     (*l)->name = odr_strdup(decode, n);
 478                     (*l)->value = odr_strdup(decode, v);
 479                     (*l)->next = 0;
 480                 }
 481                 else
 482                 {
 483                     if (*num_diag < 10)
 484                         yaz_add_srw_diagnostic(decode, diag, num_diag,
 485                                                YAZ_SRW_UNSUPP_PARAMETER, n);
 486                 }
 487             }
 488         }
 489         if (!operation && query)
 490             operation = "searchRetrieve";
 491         version = yaz_negotiate_sru_version(version);
 492
 493         if (!version)
 494         {   /* negotiation failed. */
 495             yaz_add_srw_diagnostic(decode, diag, num_diag,
 496                                    YAZ_SRW_UNSUPP_VERSION, "2.0");
 497             version = "2.0";
 498         }
 499         if (!operation)
 500         {
 501             if (uri_name)
 502                 yaz_add_srw_diagnostic(
 503                     decode, diag, num_diag,
 504                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "operation");
 505             operation = "explain";
 506         }
 507         if (strcmp(version, "2.0"))
 508         {
 509             if (recordXMLEscaping)
 510             {
 511                 yaz_add_srw_diagnostic(decode, diag, num_diag,
 512                                        YAZ_SRW_UNSUPP_PARAMETER,
 513                                        "recordXMLEscaping");
 514
 515             }
 516             recordXMLEscaping = recordPacking;
 517             recordPacking = "packed";
 518         }
 519         if (!recordXMLEscaping)
 520             recordXMLEscaping = "xml";
 521         if (!strcmp(operation, "searchRetrieve"))
 522         {
 523             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_searchRetrieve_request);
 524
 525             sr->srw_version = version;
 526             sr->extra_args = extra_args;
 527             *srw_pdu = sr;
 528             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 529
 530             sr->u.request->queryType = queryType;
 531             sr->u.request->query = query;
 532
 533             if (!query)
 534                 yaz_add_srw_diagnostic(
 535                     decode, diag, num_diag,
 536                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "query");
 537
 538             if (sortKeys)
 539             {
 540                 sr->u.request->sort_type = Z_SRW_sort_type_sort;
 541                 sr->u.request->sort.sortKeys = sortKeys;
 542             }
 543             sr->u.request->recordXPath = recordXPath;
 544             sr->u.request->recordSchema = recordSchema;
 545             sr->u.request->recordPacking = recordXMLEscaping;
 546             sr->u.request->packing = recordPacking;
 547             sr->u.request->stylesheet = stylesheet;
 548
 549             yaz_sru_decode_integer(decode, "maximumRecords", maximumRecords,
 550                                    &sr->u.request->maximumRecords,
 551                                    diag, num_diag, 0);
 552
 553             yaz_sru_decode_integer(decode, "startRecord", startRecord,
 554                                    &sr->u.request->startRecord,
 555                                    diag, num_diag, 1);
 556
 557             sr->u.request->database = db;
 558
 559             (*soap_package) = (Z_SOAP *)
 560                 odr_malloc(decode, sizeof(**soap_package));
 561             (*soap_package)->which = Z_SOAP_generic;
 562
 563             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 564                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 565
 566             (*soap_package)->u.generic->p = sr;
 567             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 568             (*soap_package)->u.generic->no = 0;
 569
 570             (*soap_package)->ns = "SRU";
 571
 572             return 0;
 573         }
 574         else if (!strcmp(operation, "explain"))
 575         {
 576             /* Transfer SRU explain parameters to common struct */
 577             /* http://www.loc.gov/z3950/agency/zing/srw/explain.html */
 578             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 579
 580             sr->srw_version = version;
 581             sr->extra_args = extra_args;
 582             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 583             *srw_pdu = sr;
 584             sr->u.explain_request->recordPacking = recordXMLEscaping;
 585             sr->u.explain_request->packing = recordPacking;
 586             sr->u.explain_request->database = db;
 587
 588             sr->u.explain_request->stylesheet = stylesheet;
 589
 590             (*soap_package) = (Z_SOAP *)
 591                 odr_malloc(decode, sizeof(**soap_package));
 592             (*soap_package)->which = Z_SOAP_generic;
 593
 594             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 595                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 596
 597             (*soap_package)->u.generic->p = sr;
 598             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 599             (*soap_package)->u.generic->no = 0;
 600
 601             (*soap_package)->ns = "SRU";
 602
 603             return 0;
 604         }
 605         else if (!strcmp(operation, "scan"))
 606         {
 607             /* Transfer SRU scan parameters to common struct */
 608             /* http://www.loc.gov/z3950/agency/zing/srw/scan.html */
 609             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_scan_request);
 610
 611             sr->srw_version = version;
 612             sr->extra_args = extra_args;
 613             *srw_pdu = sr;
 614             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 615
 616             sr->u.scan_request->queryType = queryType;
 617             sr->u.scan_request->scanClause = scanClause;
 618
 619             if (!scanClause)
 620                 yaz_add_srw_diagnostic(
 621                     decode, diag, num_diag,
 622                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "scanClause");
 623             sr->u.scan_request->database = db;
 624
 625             yaz_sru_decode_integer(decode, "maximumTerms",
 626                                    maximumTerms,
 627                                    &sr->u.scan_request->maximumTerms,
 628                                    diag, num_diag, 0);
 629
 630             yaz_sru_decode_integer(decode, "responsePosition",
 631                                    responsePosition,
 632                                    &sr->u.scan_request->responsePosition,
 633                                    diag, num_diag, 0);
 634
 635             sr->u.scan_request->stylesheet = stylesheet;
 636
 637             (*soap_package) = (Z_SOAP *)
 638                 odr_malloc(decode, sizeof(**soap_package));
 639             (*soap_package)->which = Z_SOAP_generic;
 640
 641             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 642                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 643
 644             (*soap_package)->u.generic->p = sr;
 645             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 646             (*soap_package)->u.generic->no = 0;
 647
 648             (*soap_package)->ns = "SRU";
 649
 650             return 0;
 651         }
 652         else
 653         {
 654             /* unsupported operation ... */
 655             /* Act as if we received a explain request and throw diagnostic. */
 656
 657             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 658
 659             sr->srw_version = version;
 660             *srw_pdu = sr;
 661             sr->u.explain_request->recordPacking = recordPacking;
 662             sr->u.explain_request->database = db;
 663
 664             sr->u.explain_request->stylesheet = stylesheet;
 665
 666             (*soap_package) = (Z_SOAP *)
 667                 odr_malloc(decode, sizeof(**soap_package));
 668             (*soap_package)->which = Z_SOAP_generic;
 669
 670             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 671                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 672
 673             (*soap_package)->u.generic->p = sr;
 674             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 675             (*soap_package)->u.generic->no = 0;
 676
 677             (*soap_package)->ns = "SRU";
 678
 679             yaz_add_srw_diagnostic(decode, diag, num_diag,
 680                                    YAZ_SRW_UNSUPP_OPERATION, operation);
 681             return 0;
 682         }
 683 #else
 684         return 1;
 685 #endif
 686     }
 687     return 2;
 688 }
 689
 690 Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o)
 691 {
 692     Z_SRW_extra_record *res = (Z_SRW_extra_record *)
 693         odr_malloc(o, sizeof(*res));
 694
 695     res->extraRecordData_buf = 0;
 696     res->extraRecordData_len = 0;
 697     res->recordIdentifier = 0;
 698     return res;
 699 }
 700
 701
 702 Z_SRW_record *yaz_srw_get_records(ODR o, int n)
 703 {
 704     Z_SRW_record *res = (Z_SRW_record *) odr_malloc(o, n * sizeof(*res));
 705     int i;
 706
 707     for (i = 0; i<n; i++)
 708     {
 709         res[i].recordSchema = 0;
 710         res[i].recordPacking = Z_SRW_recordPacking_string;
 711         res[i].recordData_buf = 0;
 712         res[i].recordData_len = 0;
 713         res[i].recordPosition = 0;
 714     }
 715     return res;
 716 }
 717
 718 Z_SRW_record *yaz_srw_get_record(ODR o)
 719 {
 720     return yaz_srw_get_records(o, 1);
 721 }
 722
 723 static Z_SRW_PDU *yaz_srw_get_core_ver(ODR o, const char *version)
 724 {
 725     Z_SRW_PDU *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(*p));
 726     p->srw_version = odr_strdup(o, version);
 727     p->username = 0;
 728     p->password = 0;
 729     p->extra_args = 0;
 730     p->extraResponseData_buf = 0;
 731     p->extraResponseData_len = 0;
 732     return p;
 733 }
 734
 735 Z_SRW_PDU *yaz_srw_get_core_v_2_0(ODR o)
 736 {
 737     return yaz_srw_get_core_ver(o, "2.0");
 738 }
 739
 740 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 741 {
 742     return yaz_srw_get_pdu(o, which, "2.0");
 743 }
 744
 745 Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version)
 746 {
 747     Z_SRW_PDU *sr = yaz_srw_get_core_ver(o, version);
 748
 749     sr->which = which;
 750     switch(which)
 751     {
 752     case Z_SRW_searchRetrieve_request:
 753         sr->u.request = (Z_SRW_searchRetrieveRequest *)
 754             odr_malloc(o, sizeof(*sr->u.request));
 755         sr->u.request->queryType = "cql";
 756         sr->u.request->query = 0;
 757         sr->u.request->sort_type = Z_SRW_sort_type_none;
 758         sr->u.request->sort.none = 0;
 759         sr->u.request->startRecord = 0;
 760         sr->u.request->maximumRecords = 0;
 761         sr->u.request->recordSchema = 0;
 762         sr->u.request->recordPacking = 0;
 763         sr->u.request->recordXPath = 0;
 764         sr->u.request->database = 0;
 765         sr->u.request->resultSetTTL = 0;
 766         sr->u.request->stylesheet = 0;
 767         sr->u.request->facetList = 0;
 768         break;
 769     case Z_SRW_searchRetrieve_response:
 770         sr->u.response = (Z_SRW_searchRetrieveResponse *)
 771             odr_malloc(o, sizeof(*sr->u.response));
 772         sr->u.response->numberOfRecords = 0;
 773         sr->u.response->resultSetId = 0;
 774         sr->u.response->resultSetIdleTime = 0;
 775         sr->u.response->records = 0;
 776         sr->u.response->num_records = 0;
 777         sr->u.response->diagnostics = 0;
 778         sr->u.response->num_diagnostics = 0;
 779         sr->u.response->nextRecordPosition = 0;
 780         sr->u.response->extra_records = 0;
 781         sr->u.response->facetList = 0;
 782         sr->u.response->suggestions = 0;
 783         break;
 784     case Z_SRW_explain_request:
 785         sr->u.explain_request = (Z_SRW_explainRequest *)
 786             odr_malloc(o, sizeof(*sr->u.explain_request));
 787         sr->u.explain_request->recordPacking = 0;
 788         sr->u.explain_request->database = 0;
 789         sr->u.explain_request->stylesheet = 0;
 790         break;
 791     case Z_SRW_explain_response:
 792         sr->u.explain_response = (Z_SRW_explainResponse *)
 793             odr_malloc(o, sizeof(*sr->u.explain_response));
 794         sr->u.explain_response->record.recordData_buf = 0;
 795         sr->u.explain_response->record.recordData_len = 0;
 796         sr->u.explain_response->record.recordSchema = 0;
 797         sr->u.explain_response->record.recordPosition = 0;
 798         sr->u.explain_response->record.recordPacking =
 799             Z_SRW_recordPacking_string;
 800         sr->u.explain_response->diagnostics = 0;
 801         sr->u.explain_response->num_diagnostics = 0;
 802         sr->u.explain_response->extra_record = 0;
 803         break;
 804     case Z_SRW_scan_request:
 805         sr->u.scan_request = (Z_SRW_scanRequest *)
 806             odr_malloc(o, sizeof(*sr->u.scan_request));
 807         sr->u.scan_request->database = 0;
 808         sr->u.scan_request->stylesheet = 0;
 809         sr->u.scan_request->maximumTerms = 0;
 810         sr->u.scan_request->responsePosition = 0;
 811         sr->u.scan_request->queryType = "cql";
 812         sr->u.scan_request->scanClause = 0;
 813         break;
 814     case Z_SRW_scan_response:
 815         sr->u.scan_response = (Z_SRW_scanResponse *)
 816             odr_malloc(o, sizeof(*sr->u.scan_response));
 817         sr->u.scan_response->terms = 0;
 818         sr->u.scan_response->num_terms = 0;
 819         sr->u.scan_response->diagnostics = 0;
 820         sr->u.scan_response->num_diagnostics = 0;
 821         break;
 822     case Z_SRW_update_request:
 823         sr->u.update_request = (Z_SRW_updateRequest *)
 824             odr_malloc(o, sizeof(*sr->u.update_request));
 825         sr->u.update_request->database = 0;
 826         sr->u.update_request->stylesheet = 0;
 827         sr->u.update_request->record = 0;
 828         sr->u.update_request->recordId = 0;
 829         sr->u.update_request->recordVersions = 0;
 830         sr->u.update_request->num_recordVersions = 0;
 831         sr->u.update_request->extra_record = 0;
 832         sr->u.update_request->extraRequestData_buf = 0;
 833         sr->u.update_request->extraRequestData_len = 0;
 834         sr->u.request->database = 0;
 835         break;
 836     case Z_SRW_update_response:
 837         sr->u.update_response = (Z_SRW_updateResponse *)
 838             odr_malloc(o, sizeof(*sr->u.update_response));
 839         sr->u.update_response->operationStatus = 0;
 840         sr->u.update_response->recordId = 0;
 841         sr->u.update_response->recordVersions = 0;
 842         sr->u.update_response->num_recordVersions = 0;
 843         sr->u.update_response->record = 0;
 844         sr->u.update_response->extra_record = 0;
 845         sr->u.update_response->extraResponseData_buf = 0;
 846         sr->u.update_response->extraResponseData_len = 0;
 847         sr->u.update_response->diagnostics = 0;
 848         sr->u.update_response->num_diagnostics = 0;
 849     }
 850     return sr;
 851 }
 852
 853 void yaz_add_name_value_int(ODR o, char **name, char **value, int *i,
 854                             char *a_name, Odr_int *val)
 855 {
 856     if (val)
 857     {
 858         name[*i] = a_name;
 859         value[*i] = (char *) odr_malloc(o, 40);
 860         sprintf(value[*i], ODR_INT_PRINTF, *val);
 861         (*i)++;
 862     }
 863 }
 864
 865 void yaz_add_name_value_str(ODR o, char **name, char **value,  int *i,
 866                             char *a_name, char *val)
 867 {
 868     if (val)
 869     {
 870         name[*i] = a_name;
 871         value[*i] = val;
 872         (*i)++;
 873     }
 874 }
 875
 876 static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
 877                              char **name, char **value, int max_names)
 878 {
 879     int version2 = strcmp(srw_pdu->srw_version, "2.") > 0;
 880     int i = 0;
 881     char *queryType;
 882     if (!version2)
 883         yaz_add_name_value_str(encode, name, value, &i, "version", srw_pdu->srw_version);
 884     name[i] = "operation";
 885     switch (srw_pdu->which)
 886     {
 887     case Z_SRW_searchRetrieve_request:
 888         if (!version2)
 889             value[i++] = "searchRetrieve";
 890         queryType = srw_pdu->u.request->queryType;
 891         if (version2)
 892         {
 893             yaz_add_name_value_str(encode, name, value, &i, "queryType",
 894                                    queryType);
 895             yaz_add_name_value_str(encode, name, value, &i, "query",
 896                                    srw_pdu->u.request->query);
 897         }
 898         else
 899         {
 900             if (!strcmp(queryType, "cql"))
 901             {
 902                 yaz_add_name_value_str(encode, name, value, &i, "query",
 903                                        srw_pdu->u.request->query);
 904             }
 905             else if (!strcmp(queryType, "pqf"))
 906             {
 907                 yaz_add_name_value_str(encode, name, value, &i, "x-pquery",
 908                                        srw_pdu->u.request->query);
 909             }
 910             else if (!strcmp(queryType, "pqf"))
 911             {
 912                 yaz_add_name_value_str(encode, name, value, &i, "x-cql",
 913                                        srw_pdu->u.request->query);
 914             }
 915         }
 916         switch (srw_pdu->u.request->sort_type)
 917         {
 918         case Z_SRW_sort_type_none:
 919             break;
 920         case Z_SRW_sort_type_sort:
 921             yaz_add_name_value_str(encode, name, value, &i, "sortKeys",
 922                                    srw_pdu->u.request->sort.sortKeys);
 923             break;
 924         }
 925         yaz_add_name_value_int(encode, name, value, &i, "startRecord",
 926                                srw_pdu->u.request->startRecord);
 927         yaz_add_name_value_int(encode, name, value, &i, "maximumRecords",
 928                                srw_pdu->u.request->maximumRecords);
 929         yaz_add_name_value_str(encode, name, value, &i, "recordSchema",
 930                                srw_pdu->u.request->recordSchema);
 931         yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 932                                srw_pdu->u.request->recordPacking);
 933         yaz_add_name_value_str(encode, name, value, &i, "recordXPath",
 934                                srw_pdu->u.request->recordXPath);
 935         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 936                                srw_pdu->u.request->stylesheet);
 937         yaz_add_name_value_int(encode, name, value, &i, "resultSetTTL",
 938                                srw_pdu->u.request->resultSetTTL);
 939         break;
 940     case Z_SRW_explain_request:
 941         value[i++] = "explain";
 942         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 943                                srw_pdu->u.explain_request->stylesheet);
 944         break;
 945     case Z_SRW_scan_request:
 946         value[i++] = "scan";
 947         queryType = srw_pdu->u.request->queryType;
 948         if (version2)
 949         {
 950             if (queryType && strcmp(queryType, "cql"))
 951                 yaz_add_name_value_str(encode, name, value, &i, "queryType",
 952                                        queryType);
 953             yaz_add_name_value_str(encode, name, value, &i, "query",
 954                                    srw_pdu->u.request->query);
 955         }
 956         else
 957         {
 958             if (!queryType || !strcmp(queryType, "cql"))
 959                 yaz_add_name_value_str(encode, name, value, &i, "scanClause",
 960                                        srw_pdu->u.scan_request->scanClause);
 961             else if (!strcmp(queryType, "pqf"))
 962                 yaz_add_name_value_str(encode, name, value, &i, "x-pScanClause",
 963                                        srw_pdu->u.scan_request->scanClause);
 964             else if (!strcmp(queryType, "xcql"))
 965                 yaz_add_name_value_str(encode, name, value, &i,
 966                                        "x-cqlScanClause",
 967                                        srw_pdu->u.scan_request->scanClause);
 968         }
 969         yaz_add_name_value_int(encode, name, value, &i, "responsePosition",
 970                                srw_pdu->u.scan_request->responsePosition);
 971         yaz_add_name_value_int(encode, name, value, &i, "maximumTerms",
 972                                srw_pdu->u.scan_request->maximumTerms);
 973         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 974                                srw_pdu->u.scan_request->stylesheet);
 975         break;
 976     case Z_SRW_update_request:
 977         value[i++] = "update";
 978         break;
 979     default:
 980         return -1;
 981     }
 982     if (srw_pdu->extra_args)
 983     {
 984         Z_SRW_extra_arg *ea = srw_pdu->extra_args;
 985         for (; ea && i < max_names-1; ea = ea->next)
 986         {
 987             name[i] = ea->name;
 988             value[i] = ea->value;
 989             i++;
 990         }
 991     }
 992     name[i++] = 0;
 993
 994     return 0;
 995 }
 996
 997 int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
 998                        ODR encode, const char *charset)
 999 {
1000     char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
1001     char *uri_args;
1002     char *path;
1003
1004     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
1005                                  srw_pdu->username, srw_pdu->password);
1006     if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
1007         return -1;
1008     yaz_array_to_uri(&uri_args, encode, name, value);
1009
1010     hreq->method = "GET";
1011
1012     path = (char *)
1013         odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4);
1014
1015     sprintf(path, "%s?%s", hreq->path, uri_args);
1016     yaz_log(YLOG_DEBUG, "SRU HTTP Get Request %s", path);
1017     hreq->path = path;
1018
1019     z_HTTP_header_add_content_type(encode, &hreq->headers,
1020                                    "text/xml", charset);
1021     return 0;
1022 }
1023
1024 int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1025                         ODR encode, const char *charset)
1026 {
1027     char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
1028     char *uri_args;
1029
1030     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
1031                                  srw_pdu->username, srw_pdu->password);
1032     if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
1033         return -1;
1034
1035     yaz_array_to_uri(&uri_args, encode, name, value);
1036
1037     hreq->method = "POST";
1038
1039     hreq->content_buf = uri_args;
1040     hreq->content_len = strlen(uri_args);
1041
1042     z_HTTP_header_add_content_type(encode, &hreq->headers,
1043                                    "application/x-www-form-urlencoded",
1044                                    charset);
1045     return 0;
1046 }
1047
1048 int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1049                         ODR odr, const char *charset)
1050 {
1051     Z_SOAP_Handler handlers[3] = {
1052 #if YAZ_HAVE_XML2
1053         {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1054         {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1055 #endif
1056         {0, 0, 0}
1057     };
1058     Z_SOAP *p = (Z_SOAP*) odr_malloc(odr, sizeof(*p));
1059
1060     z_HTTP_header_add_basic_auth(odr, &hreq->headers,
1061                                  srw_pdu->username, srw_pdu->password);
1062     z_HTTP_header_add_content_type(odr,
1063                                    &hreq->headers,
1064                                    "text/xml", charset);
1065
1066     z_HTTP_header_add(odr, &hreq->headers,
1067                       "SOAPAction", "\"\"");
1068     p->which = Z_SOAP_generic;
1069     p->u.generic = (Z_SOAP_Generic *) odr_malloc(odr, sizeof(*p->u.generic));
1070     p->u.generic->no = 0;
1071     p->u.generic->ns = 0;
1072     p->u.generic->p = srw_pdu;
1073     p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1074
1075 #if YAZ_HAVE_XML2
1076     if (srw_pdu->which == Z_SRW_update_request ||
1077         srw_pdu->which == Z_SRW_update_response)
1078         p->u.generic->no = 1; /* second handler */
1079 #endif
1080     return z_soap_codec_enc(odr, &p,
1081                             &hreq->content_buf,
1082                             &hreq->content_len, handlers,
1083                             charset);
1084 }
1085
1086 Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR odr, int num)
1087 {
1088     Z_SRW_recordVersion *ver
1089         = (Z_SRW_recordVersion *) odr_malloc(odr,num * sizeof(*ver));
1090     int i;
1091     for (i = 0; i < num; ++i)
1092     {
1093         ver[i].versionType = 0;
1094         ver[i].versionValue = 0;
1095     }
1096     return ver;
1097 }
1098
1099 const char *yaz_srw_pack_to_str(int pack)
1100 {
1101     switch(pack)
1102     {
1103     case Z_SRW_recordPacking_string:
1104         return "string";
1105     case Z_SRW_recordPacking_XML:
1106         return "xml";
1107     case Z_SRW_recordPacking_URL:
1108         return "url";
1109     }
1110     return 0;
1111 }
1112
1113 int yaz_srw_str_to_pack(const char *str)
1114 {
1115     if (!yaz_matchstr(str, "string"))
1116         return Z_SRW_recordPacking_string;
1117     if (!yaz_matchstr(str, "xml"))
1118         return Z_SRW_recordPacking_XML;
1119     if (!yaz_matchstr(str, "url"))
1120         return Z_SRW_recordPacking_URL;
1121     return -1;
1122 }
1123
1124 void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args)
1125 {
1126     if (extra_args)
1127     {
1128         char **name;
1129         char **val;
1130         Z_SRW_extra_arg **ea = &sr->extra_args;
1131         yaz_uri_to_array(extra_args, odr, &name, &val);
1132
1133         while (*name)
1134         {
1135             *ea = (Z_SRW_extra_arg *) odr_malloc(odr, sizeof(**ea));
1136             (*ea)->name = *name;
1137             (*ea)->value = *val;
1138             ea = &(*ea)->next;
1139             val++;
1140             name++;
1141         }
1142         *ea = 0;
1143     }
1144 }
1145
1146
1147 /*
1148  * Local variables:
1149  * c-basic-offset: 4
1150  * c-file-style: "Stroustrup"
1151  * indent-tabs-mode: nil
1152  * End:
1153  * vim: shiftwidth=4 tabstop=8 expandtab
1154  */
1155