Bump copyright year
[yazpp-moved-to-github.git] / src / yaz-z-server.cpp
index ddc0bf0..7f135a2 100644 (file)
-/*
- * Copyright (c) 2000, Index Data.
+/* This file is part of the yazpp toolkit.
+ * Copyright (C) 1998-2010 Index Data and Mike Taylor
  * See the file LICENSE for details.
- * 
- * $Log: yaz-z-server.cpp,v $
- * Revision 1.2  2000-09-12 12:09:53  adam
- * More work on high-level server.
- *
- * Revision 1.1  2000/09/08 10:23:42  adam
- * Added skeleton of yaz-z-server.
- *
  */
 
 #include <yaz/log.h>
-#include <yaz-z-server.h>
+#include <yazpp/z-server.h>
+#include <yaz/oid_db.h>
 
+using namespace yazpp_1;
 
-Yaz_Z_Server::Yaz_Z_Server(IYaz_PDU_Observable *the_PDU_Observable)
-    : Yaz_Z_Assoc(the_PDU_Observable)
+Z_Server::Z_Server(IPDU_Observable *the_PDU_Observable)
+    : Z_Assoc(the_PDU_Observable)
 {
+    m_facilities = 0;
 }
 
-Z_Records *Yaz_Z_Server::pack_records (const char *resultSetName,
-                                      int start, int *num,
-                                      Z_RecordComposition *comp,
-                                      int *next, int *pres,
-                                      int *format)
+Z_Server::~Z_Server()
 {
-#if 0
-    int recno, total_length = 0, toget = *num, dumped_records = 0;
-    Z_Records *records =
-       (Z_Records *) odr_malloc (odr_encode(), sizeof(*records));
-    Z_NamePlusRecordList *reclist =
-       (Z_NamePlusRecordList *) odr_malloc (odr_encode(), sizeof(*reclist));
-    Z_NamePlusRecord **list =
-       (Z_NamePlusRecord **) odr_malloc (odr_encode(), sizeof(*list) * toget);
-
-    records->which = Z_Records_DBOSD;
-    records->u.databaseOrSurDiagnostics = reclist;
-    reclist->num_records = 0;
-    reclist->records = list;
-    *pres = Z_PRES_SUCCESS;
-    *num = 0;
-    *next = 0;
+    facility_reset();
+}
 
-    yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
-    yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", m_preferredMessageSize,
-       m_maximumRecordSize);
-    for (recno = start; reclist->num_records < toget; recno++)
+void Z_Server::facility_reset ()
+{
+    Z_Server_Facility_Info *p = m_facilities;
+    while (p)
     {
-       Z_NamePlusRecord *rec =
-           (Z_NamePlusRecord *) odr_malloc (odr_encode(), sizeof(*rec));
-       rec->databaseName = 0;
-       rec->which = Z_NamePlusRecord_databaseRecord;
-       rec->u.databaseRecord = 0;
+        Z_Server_Facility_Info *p_next = p->m_next;
 
-       Z_DefaultDiagFormat *diagnostics = (Z_DefaultDiagFormat *)
-           odr_malloc (odr_encode(), sizeof(*diagnostics));
-       diagnostics->diagnosticSetId = 0;
-       diagnostics->condition = 0;
-       diagnostics->which = Z_DefaultDiagFormat_v2Addinfo;
-       
-       recv_Z_record (resultSetName, recno, format, comp, rec, diagnostics);
+        delete [] p->m_name;
+        delete p;
+        p = p_next;
+    }
+    m_facilities = 0;
+}
 
-       bend_fetch_rr freq;
-       Z_NamePlusRecord *thisrec;
-       int this_length = 0;
-       /*
-        * we get the number of bytes allocated on the stream before any
-        * allocation done by the backend - this should give us a reasonable
-        * idea of the total size of the data so far.
-        */
-       total_length = odr_total(a->encode) - dumped_records;
-       freq.errcode = 0;
-       freq.errstring = 0;
-       freq.basename = 0;
-       freq.len = 0;
-       freq.record = 0;
-       freq.last_in_set = 0;
-       freq.setname = setname;
-       freq.surrogate_flag = 0;
-       freq.number = recno;
-       freq.comp = comp;
-       freq.request_format = format;
-       freq.request_format_raw = oid;
-       freq.output_format = format;
-       freq.output_format_raw = 0;
-       freq.stream = a->encode;
-       freq.print = a->print;
-       freq.surrogate_flag = 0;
-       freq.referenceId = referenceId;
-       (*a->init->bend_fetch)(a->backend, &freq);
-       /* backend should be able to signal whether error is system-wide
-          or only pertaining to current record */
-       if (freq.errcode)
-       {
-           if (!freq.surrogate_flag)
-           {
-               *pres = Z_PRES_FAILURE;
-               return diagrec(a, freq.errcode, freq.errstring);
-           }
-           reclist->records[reclist->num_records] =
-               surrogatediagrec(a, freq.basename, freq.errcode,
-                                freq.errstring);
-           reclist->num_records++;
-           *next = freq.last_in_set ? 0 : recno + 1;
-           continue;
-       }
-       if (freq.len >= 0)
-           this_length = freq.len;
-       else
-           this_length = odr_total(a->encode) - total_length;
-       yaz_log(LOG_DEBUG, "  fetched record, len=%d, total=%d",
-           this_length, total_length);
-       if (this_length + total_length > a->preferredMessageSize)
-       {
-           /* record is small enough, really */
-           if (this_length <= a->preferredMessageSize)
-           {
-               yaz_log(LOG_DEBUG, "  Dropped last normal-sized record");
-               *pres = Z_PRES_PARTIAL_2;
-               break;
-           }
-           /* record can only be fetched by itself */
-           if (this_length < a->maximumRecordSize)
-           {
-               yaz_log(LOG_DEBUG, "  Record > prefmsgsz");
-               if (toget > 1)
-               {
-                   yaz_log(LOG_DEBUG, "  Dropped it");
-                   reclist->records[reclist->num_records] =
-                        surrogatediagrec(a, freq.basename, 16, 0);
-                   reclist->num_records++;
-                   *next = freq.last_in_set ? 0 : recno + 1;
-                   dumped_records += this_length;
-                   continue;
-               }
-           }
-           else /* too big entirely */
-           {
-               yaz_log(LOG_DEBUG, "Record > maxrcdsz");
-               reclist->records[reclist->num_records] =
-                   surrogatediagrec(a, freq.basename, 17, 0);
-               reclist->num_records++;
-               *next = freq.last_in_set ? 0 : recno + 1;
-               dumped_records += this_length;
-               continue;
-           }
-       }
+void Z_Server::facility_add(IServer_Facility *facility,
+                            const char *name)
+{
+    Z_Server_Facility_Info **p = &m_facilities;
+    while (*p)
+        p = &(*p)->m_next;
 
-       if (!(thisrec = (Z_NamePlusRecord *)
-             odr_malloc(a->encode, sizeof(*thisrec))))
-           return 0;
-       if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
-           strlen(freq.basename) + 1)))
-           return 0;
-       strcpy(thisrec->databaseName, freq.basename);
-       thisrec->which = Z_NamePlusRecord_databaseRecord;
+    *p = new Z_Server_Facility_Info;
 
-       if (freq.output_format_raw)
-       {
-           struct oident *ident = oid_getentbyoid(freq.output_format_raw);
-           freq.output_format = ident->value;
-       }
-       thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
-                                                freq.record, freq.len);
-       if (!thisrec->u.databaseRecord)
-           return 0;
-       reclist->records[reclist->num_records] = thisrec;
-       reclist->num_records++;
-       *next = freq.last_in_set ? 0 : recno + 1;
-    }
-    *num = reclist->num_records;
-    return records;
-#endif
-    return 0;
+    (*p)->m_next = 0;
+    (*p)->m_name = new char [strlen(name)+1];
+    strcpy ((*p)->m_name, name);
+    (*p)->m_facility = facility;
 }
 
-void Yaz_Z_Server::piggyback (Z_SearchRequest *req,
-                             Z_SearchResponse *res)
+void Z_Server::recv_GDU (Z_GDU *apdu, int len)
 {
-    bool_t *sr = (bool_t *)odr_malloc (odr_encode(), sizeof(*sr));
-    *sr = 1;
-    
-    int *next = (int *)odr_malloc (odr_encode(), sizeof(*next));
-    *next = 0;
-    
-    int *toget = (int *)odr_malloc (odr_encode(), sizeof(*toget));
-    *toget = 0;
-    
-    int *presst = (int *)odr_malloc (odr_encode(), sizeof(*presst));
-    *presst = 0;
-    
-    Z_RecordComposition comp, *compp = 0;
-    int hits = *res->resultCount;
-    
-    int *nulint = (int *)odr_malloc (odr_encode(), sizeof(*nulint));
-    *nulint = 0;
-    
-    res->records = 0;
-    
-    comp.which = Z_RecordComp_simple;
-    /* how many records does the user agent want, then? */
-    if (hits <= *req->smallSetUpperBound)
-    {
-       *toget = hits;
-       if ((comp.u.simple = req->smallSetElementSetNames))
-           compp = &comp;
-    }
-    else if (hits < *req->largeSetLowerBound)
-    {
-       *toget = *req->mediumSetPresentNumber;
-       if (*toget > hits)
-           *toget = hits;
-       if ((comp.u.simple = req->mediumSetElementSetNames))
-           compp = &comp;
-    }
+    if (apdu->which == Z_GDU_Z3950)
+        recv_Z_PDU(apdu->u.z3950, len);
     else
-       *toget = 0;
+        delete this;
+}
+
+void Z_Server::recv_Z_PDU (Z_APDU *apdu_request, int len)
+{   
+    Z_Server_Facility_Info *f = m_facilities;
     
-    if (*toget && !res->records)
+    if (apdu_request->which == Z_APDU_initRequest)
     {
-       res->records =
-           pack_records(req->resultSetName, 1,
-                        toget, compp, next, presst,
-                        req->preferredRecordSyntax);
-       if (!res->records)
-           return;
-       res->numberOfRecordsReturned = toget;
-       res->nextResultSetPosition = next;
-       res->searchStatus = sr;
-       res->resultSetStatus = 0;
-       res->presentStatus = presst;
+        Z_APDU *apdu_response = create_Z_PDU(Z_APDU_initResponse);
+
+        Z_InitRequest *req = apdu_request->u.initRequest;
+        Z_InitResponse *resp = apdu_response->u.initResponse;
+        
+        if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
+        {
+            ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
+        }
+        if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
+        {
+            ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
+        }
+        if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
+        {
+            ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
+        }
+        while (f)
+        {
+            f->m_facility->init(this, req, resp);
+            f = f->m_next;
+        }
+        transfer_referenceId(apdu_request, apdu_response);
+        send_Z_PDU(apdu_response, 0);
     }
     else
     {
-       if (hits)
-           *next = 1;
-       res->numberOfRecordsReturned = nulint;
-       res->nextResultSetPosition = next;
-       res->searchStatus = sr;
-       res->resultSetStatus = 0;
-       res->presentStatus = 0;
+        f = m_facilities;
+        int taken = 0;
+        while (f)
+        {
+            taken = f->m_facility->recv(this, apdu_request);
+            if (taken)
+                break;
+            f = f->m_next;
+        }
+        if (!taken)
+        {
+            yaz_log (YLOG_WARN, "unhandled request = %d", apdu_request->which);
+            delete this;
+        }
     }
 }
 
-void Yaz_Z_Server::recv_Z_PDU (Z_APDU *apdu_request)
-{   
-    Z_APDU *apdu_response;
-    switch (apdu_request->which)
-    {
-    case Z_APDU_initRequest:
-        logf (LOG_LOG, "got InitRequest");
-       apdu_response = create_Z_PDU(Z_APDU_initResponse);
-       recv_Z_init (apdu_request->u.initRequest,
-                    apdu_response->u.initResponse);
-       send_Z_PDU(apdu_response);
-        break;
-    case Z_APDU_searchRequest:
-        logf (LOG_LOG, "got SearchRequest");
-       apdu_response = create_Z_PDU(Z_APDU_searchResponse);
-       recv_Z_search (apdu_request->u.searchRequest,
-                      apdu_response->u.searchResponse);
-       if (!apdu_response->u.searchResponse->records)
-       {
-           piggyback(apdu_request->u.searchRequest,
-                     apdu_response->u.searchResponse);
-       }
-       send_Z_PDU(apdu_response);
-        break;
-    case Z_APDU_presentRequest:
-        logf (LOG_LOG, "got PresentRequest");
-       apdu_response = create_Z_PDU(Z_APDU_presentResponse);
-       recv_Z_present (apdu_request->u.presentRequest,
-                       apdu_response->u.presentResponse);
-       send_Z_PDU(apdu_response);
-        break;
-    }
+/*
+ * database record.
+ */
+void Z_ServerUtility::create_databaseRecord (
+    ODR odr, Z_NamePlusRecord *rec, const char *dbname, const Odr_oid *format,
+    const void *buf, int len)
+{
+    Odr_oid *oid = odr_oiddup(odr, format);
+    rec->databaseName = dbname ? odr_strdup (odr, dbname) : 0;
+    rec->which = Z_NamePlusRecord_databaseRecord;
+    rec->u.databaseRecord = z_ext_record_oid(odr, oid,
+                                             (const char *) buf, len);
+}
+
+/*
+ * surrogate diagnostic.
+ */
+void Z_ServerUtility::create_surrogateDiagnostics(
+    ODR odr, Z_NamePlusRecord *rec, const char *dbname,
+    int error, char *const addinfo)
+{
+    Odr_int *err = (Odr_int *)odr_malloc (odr, sizeof(*err));
+    Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (odr, sizeof(*drec));
+    Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
+        odr_malloc (odr, sizeof(*dr));
+    
+    yaz_log(YLOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
+    *err = error;
+    rec->databaseName = dbname ? odr_strdup (odr, dbname) : 0;
+    rec->which = Z_NamePlusRecord_surrogateDiagnostic;
+    rec->u.surrogateDiagnostic = drec;
+    drec->which = Z_DiagRec_defaultFormat;
+    drec->u.defaultFormat = dr;
+    dr->diagnosticSetId = odr_oiddup(odr, yaz_oid_diagset_bib_1);
+
+    dr->condition = err;
+    dr->which = Z_DefaultDiagFormat_v2Addinfo;
+    dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
 }
 
+Z_Records *Z_ServerUtility::create_nonSurrogateDiagnostics (
+    ODR odr, int error, const char *addinfo)
+{
+    Z_Records *rec = (Z_Records *)
+        odr_malloc (odr, sizeof(*rec));
+    Odr_int *err = (Odr_int *)
+        odr_malloc (odr, sizeof(*err));
+    Z_DiagRec *drec = (Z_DiagRec *)
+        odr_malloc (odr, sizeof(*drec));
+    Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
+        odr_malloc (odr, sizeof(*dr));
+
+    *err = error;
+    rec->which = Z_Records_NSD;
+    rec->u.nonSurrogateDiagnostic = dr;
+    dr->diagnosticSetId = odr_oiddup(odr, yaz_oid_diagset_bib_1);
+
+    dr->condition = err;
+    dr->which = Z_DefaultDiagFormat_v2Addinfo;
+    dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
+    return rec;
+}
+
+void Z_ServerUtility::create_diagnostics (
+    ODR odr, int error, const char *addinfo,
+    Z_DiagRec ***dreca, int *num)
+{
+    Z_DiagRec *drec = (Z_DiagRec *) odr_malloc (odr, sizeof(*drec));
+    Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
+        odr_malloc (odr, sizeof(*dr));
+    
+    *num = 1;
+    *dreca = (Z_DiagRec **) odr_malloc (odr, sizeof(*dreca));
+    (*dreca)[0] = drec;
+        
+    drec->which = Z_DiagRec_defaultFormat;
+    drec->u.defaultFormat = dr;
+    dr->diagnosticSetId = odr_oiddup(odr, yaz_oid_diagset_bib_1);
+    dr->condition = odr_intdup (odr, error);
+    dr->which = Z_DefaultDiagFormat_v2Addinfo;
+    dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
+}
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+