src/filter_multi.cpp

   1 /* This file is part of Metaproxy.
   2    Copyright (C) 2005-2011 Index Data
   3
   4 Metaproxy 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
   7 version.
   8
   9 Metaproxy 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
  12 for more details.
  13
  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
  17 */
  18
  19 #include <yaz/log.h>
  20
  21 #include "config.hpp"
  22
  23 #include <metaproxy/filter.hpp>
  24 #include <metaproxy/package.hpp>
  25
  26 #include <boost/thread/thread.hpp>
  27 #include <boost/thread/mutex.hpp>
  28 #include <boost/thread/condition.hpp>
  29 #include <boost/shared_ptr.hpp>
  30
  31 #include <metaproxy/util.hpp>
  32 #include "filter_multi.hpp"
  33
  34 #include <yaz/zgdu.h>
  35 #include <yaz/otherinfo.h>
  36 #include <yaz/diagbib1.h>
  37 #include <yaz/match_glob.h>
  38
  39 #include <vector>
  40 #include <algorithm>
  41 #include <map>
  42 #include <iostream>
  43
  44 namespace mp = metaproxy_1;
  45 namespace yf = mp::filter;
  46
  47 namespace metaproxy_1 {
  48     namespace filter {
  49         enum multi_merge_type {
  50             round_robin,
  51             serve_order
  52         };
  53         struct Multi::BackendSet {
  54             BackendPtr m_backend;
  55             int m_count;
  56             bool operator < (const BackendSet &k) const;
  57             bool operator == (const BackendSet &k) const;
  58         };
  59         struct Multi::ScanTermInfo {
  60             std::string m_norm_term;
  61             std::string m_display_term;
  62             int m_count;
  63             bool operator < (const ScanTermInfo &) const;
  64             bool operator == (const ScanTermInfo &) const;
  65             Z_Entry *get_entry(ODR odr);
  66         };
  67         struct Multi::FrontendSet {
  68             class PresentJob {
  69             public:
  70                 BackendPtr m_backend;
  71                 int m_pos; // position for backend (1=first, 2=second,..
  72                 int m_start; // present request start
  73                 PresentJob(BackendPtr ptr, int pos) :
  74                     m_backend(ptr), m_pos(pos), m_start(0) {};
  75             };
  76             FrontendSet(std::string setname);
  77             FrontendSet();
  78             ~FrontendSet();
  79
  80             void round_robin(int pos, int number, std::list<PresentJob> &job);
  81             void serve_order(int pos, int number, std::list<PresentJob> &job);
  82
  83             std::list<BackendSet> m_backend_sets;
  84             std::string m_setname;
  85         };
  86         struct Multi::Backend {
  87             PackagePtr m_package;
  88             std::string m_backend_database;
  89             std::string m_vhost;
  90             std::string m_route;
  91             void operator() (void);  // thread operation
  92         };
  93         struct Multi::Frontend {
  94             Frontend(Rep *rep);
  95             ~Frontend();
  96             bool m_is_multi;
  97             bool m_in_use;
  98             std::list<BackendPtr> m_backend_list;
  99             std::map<std::string,Multi::FrontendSet> m_sets;
 100
 101             void multi_move(std::list<BackendPtr> &blist);
 102             void init(Package &package, Z_GDU *gdu);
 103             void close(Package &package);
 104             void search(Package &package, Z_APDU *apdu);
 105             void present(Package &package, Z_APDU *apdu);
 106             void scan1(Package &package, Z_APDU *apdu);
 107             void scan2(Package &package, Z_APDU *apdu);
 108             Rep *m_p;
 109         };
 110         class Multi::Map {
 111             std::string m_target_pattern;
 112             std::string m_route;
 113         public:
 114             Map(std::string pattern, std::string route) :
 115                 m_target_pattern(pattern), m_route(route) {};
 116             bool match(const std::string target, std::string *ret) const {
 117                 if (yaz_match_glob(m_target_pattern.c_str(), target.c_str()))
 118                 {
 119                     *ret = m_route;
 120                     return true;
 121                 }
 122                 return false;
 123             };
 124         };
 125         class Multi::Rep {
 126             friend class Multi;
 127             friend struct Frontend;
 128
 129             Rep();
 130             FrontendPtr get_frontend(Package &package);
 131             void release_frontend(Package &package);
 132         private:
 133             std::list<Multi::Map> m_route_patterns;
 134             boost::mutex m_mutex;
 135             boost::condition m_cond_session_ready;
 136             std::map<mp::Session, FrontendPtr> m_clients;
 137             bool m_hide_unavailable;
 138             multi_merge_type m_merge_type;
 139         };
 140     }
 141 }
 142
 143 yf::Multi::Rep::Rep()
 144 {
 145     m_hide_unavailable = false;
 146     m_merge_type = round_robin;
 147 }
 148
 149 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
 150 {
 151     return m_count < k.m_count;
 152 }
 153
 154 yf::Multi::Frontend::Frontend(Rep *rep)
 155 {
 156     m_p = rep;
 157     m_is_multi = false;
 158 }
 159
 160 yf::Multi::Frontend::~Frontend()
 161 {
 162 }
 163
 164 yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(mp::Package &package)
 165 {
 166     boost::mutex::scoped_lock lock(m_mutex);
 167
 168     std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
 169
 170     while(true)
 171     {
 172         it = m_clients.find(package.session());
 173         if (it == m_clients.end())
 174             break;
 175
 176         if (!it->second->m_in_use)
 177         {
 178             it->second->m_in_use = true;
 179             return it->second;
 180         }
 181         m_cond_session_ready.wait(lock);
 182     }
 183     FrontendPtr f(new Frontend(this));
 184     m_clients[package.session()] = f;
 185     f->m_in_use = true;
 186     return f;
 187 }
 188
 189 void yf::Multi::Rep::release_frontend(mp::Package &package)
 190 {
 191     boost::mutex::scoped_lock lock(m_mutex);
 192     std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
 193
 194     it = m_clients.find(package.session());
 195     if (it != m_clients.end())
 196     {
 197         if (package.session().is_closed())
 198         {
 199             it->second->close(package);
 200             m_clients.erase(it);
 201         }
 202         else
 203         {
 204             it->second->m_in_use = false;
 205         }
 206         m_cond_session_ready.notify_all();
 207     }
 208 }
 209
 210 yf::Multi::FrontendSet::FrontendSet(std::string setname)
 211     :  m_setname(setname)
 212 {
 213 }
 214
 215
 216 yf::Multi::FrontendSet::FrontendSet()
 217 {
 218 }
 219
 220
 221 yf::Multi::FrontendSet::~FrontendSet()
 222 {
 223 }
 224
 225 yf::Multi::Multi() : m_p(new Multi::Rep)
 226 {
 227 }
 228
 229 yf::Multi::~Multi() {
 230 }
 231
 232
 233 void yf::Multi::Backend::operator() (void)
 234 {
 235     m_package->move(m_route);
 236 }
 237
 238
 239 void yf::Multi::Frontend::close(mp::Package &package)
 240 {
 241     std::list<BackendPtr>::const_iterator bit;
 242     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 243     {
 244         BackendPtr b = *bit;
 245
 246         b->m_package->copy_filter(package);
 247         b->m_package->request() = (Z_GDU *) 0;
 248         b->m_package->session().close();
 249         b->m_package->move(b->m_route);
 250     }
 251 }
 252
 253 void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
 254 {
 255     std::list<BackendPtr>::const_iterator bit;
 256     boost::thread_group g;
 257     for (bit = blist.begin(); bit != blist.end(); bit++)
 258     {
 259         g.add_thread(new boost::thread(**bit));
 260     }
 261     g.join_all();
 262 }
 263
 264 void yf::Multi::FrontendSet::serve_order(int start, int number,
 265                                          std::list<PresentJob> &jobs)
 266 {
 267     int i;
 268     for (i = 0; i < number; i++)
 269     {
 270         std::list<BackendSet>::const_iterator bsit;
 271         int voffset = 0;
 272         int offset = start + i - 1;
 273         for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end();
 274              bsit++)
 275         {
 276             if (offset >= voffset && offset < voffset + bsit->m_count)
 277             {
 278                 PresentJob job(bsit->m_backend, offset - voffset + 1);
 279                 jobs.push_back(job);
 280                 break;
 281             }
 282             voffset += bsit->m_count;
 283         }
 284     }
 285 }
 286
 287 void yf::Multi::FrontendSet::round_robin(int start, int number,
 288                                          std::list<PresentJob> &jobs)
 289 {
 290     std::list<int> pos;
 291     std::list<BackendSet>::const_iterator bsit;
 292     for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
 293     {
 294         pos.push_back(1);
 295     }
 296
 297     int p = 1;
 298 #if 1
 299     // optimization step!
 300     int omin = 0;
 301     while(true)
 302     {
 303         int min = 0;
 304         int no_left = 0;
 305         // find min count for each set which is > omin
 306         for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
 307         {
 308             if (bsit->m_count > omin)
 309             {
 310                 if (no_left == 0 || bsit->m_count < min)
 311                     min = bsit->m_count;
 312                 no_left++;
 313             }
 314         }
 315         if (no_left == 0) // if nothing greater than omin, bail out.
 316             break;
 317         int skip = no_left * min;
 318         if (p + skip > start)  // step gets us "into" present range?
 319         {
 320             // Yes. skip until start.. Rounding off is deliberate!
 321             min = (start-p) / no_left;
 322             p += no_left * min;
 323
 324             // update positions in each set..
 325             std::list<int>::iterator psit = pos.begin();
 326             for (psit = pos.begin(); psit != pos.end(); psit++)
 327                 *psit += min;
 328             break;
 329         }
 330         // skip on each set.. before "present range"..
 331         p = p + skip;
 332
 333         std::list<int>::iterator psit = pos.begin();
 334         for (psit = pos.begin(); psit != pos.end(); psit++)
 335             *psit += min;
 336
 337         omin = min; // update so we consider next class (with higher count)
 338     }
 339 #endif
 340     int fetched = 0;
 341     bool more = true;
 342     while (more)
 343     {
 344         more = false;
 345         std::list<int>::iterator psit = pos.begin();
 346         bsit = m_backend_sets.begin();
 347
 348         for (; bsit != m_backend_sets.end(); psit++,bsit++)
 349         {
 350             if (fetched >= number)
 351             {
 352                 more = false;
 353                 break;
 354             }
 355             if (*psit <= bsit->m_count)
 356             {
 357                 if (p >= start)
 358                 {
 359                     PresentJob job(bsit->m_backend, *psit);
 360                     jobs.push_back(job);
 361                     fetched++;
 362                 }
 363                 (*psit)++;
 364                 p++;
 365                 more = true;
 366             }
 367         }
 368     }
 369 }
 370
 371 void yf::Multi::Frontend::init(mp::Package &package, Z_GDU *gdu)
 372 {
 373     Z_InitRequest *req = gdu->u.z3950->u.initRequest;
 374
 375     std::list<std::string> targets;
 376
 377     mp::util::get_vhost_otherinfo(req->otherInfo, targets);
 378
 379     if (targets.size() < 1)
 380     {
 381         package.move();
 382         return;
 383     }
 384
 385     std::list<std::string>::const_iterator t_it = targets.begin();
 386     for (; t_it != targets.end(); t_it++)
 387     {
 388         Session s;
 389         Backend *b = new Backend;
 390         b->m_vhost = *t_it;
 391
 392         std::list<Multi::Map>::const_iterator it =
 393             m_p->m_route_patterns.begin();
 394         while (it != m_p->m_route_patterns.end()) {
 395             if (it->match(*t_it, &b->m_route))
 396                 break;
 397             it++;
 398         }
 399         // b->m_route = m_p->m_target_route[*t_it];
 400         // b->m_route unset
 401         b->m_package = PackagePtr(new Package(s, package.origin()));
 402
 403         m_backend_list.push_back(BackendPtr(b));
 404     }
 405     m_is_multi = true;
 406
 407     // create init request
 408     std::list<BackendPtr>::iterator bit;
 409     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 410     {
 411         mp::odr odr;
 412         BackendPtr b = *bit;
 413         Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
 414
 415         std::list<std::string>vhost_one;
 416         vhost_one.push_back(b->m_vhost);
 417         mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
 418                                        odr, vhost_one);
 419
 420         init_apdu->u.initRequest->idAuthentication = req->idAuthentication;
 421
 422         Z_InitRequest *req = init_apdu->u.initRequest;
 423
 424         ODR_MASK_SET(req->options, Z_Options_search);
 425         ODR_MASK_SET(req->options, Z_Options_present);
 426         ODR_MASK_SET(req->options, Z_Options_namedResultSets);
 427         ODR_MASK_SET(req->options, Z_Options_scan);
 428
 429         ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
 430         ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
 431         ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
 432
 433         b->m_package->request() = init_apdu;
 434
 435         b->m_package->copy_filter(package);
 436     }
 437     multi_move(m_backend_list);
 438
 439     // create the frontend init response based on each backend init response
 440     mp::odr odr;
 441
 442     Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
 443     Z_InitResponse *f_resp = f_apdu->u.initResponse;
 444
 445     ODR_MASK_SET(f_resp->options, Z_Options_search);
 446     ODR_MASK_SET(f_resp->options, Z_Options_present);
 447     ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
 448
 449     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
 450     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
 451     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
 452
 453     int no_failed = 0;
 454     int no_succeeded = 0;
 455     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
 456     {
 457         PackagePtr p = (*bit)->m_package;
 458
 459         if (p->session().is_closed())
 460         {
 461             // failed. Remove from list and increment number of failed
 462             no_failed++;
 463             bit = m_backend_list.erase(bit);
 464             continue;
 465         }
 466         Z_GDU *gdu = p->response().get();
 467         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 468             Z_APDU_initResponse)
 469         {
 470             int i;
 471             Z_APDU *b_apdu = gdu->u.z3950;
 472             Z_InitResponse *b_resp = b_apdu->u.initResponse;
 473
 474             // common options for all backends
 475             for (i = 0; i <= Z_Options_stringSchema; i++)
 476             {
 477                 if (!ODR_MASK_GET(b_resp->options, i))
 478                     ODR_MASK_CLEAR(f_resp->options, i);
 479             }
 480             // common protocol version
 481             for (i = 0; i <= Z_ProtocolVersion_3; i++)
 482                 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
 483                     ODR_MASK_CLEAR(f_resp->protocolVersion, i);
 484             if (*b_resp->result)
 485                 no_succeeded++;
 486             else
 487                 no_failed++;
 488         }
 489         else
 490             no_failed++;
 491         bit++;
 492     }
 493     if (m_p->m_hide_unavailable)
 494     {
 495         if (no_succeeded == 0)
 496         {
 497             *f_resp->result = 0;
 498             package.session().close();
 499         }
 500     }
 501     else
 502     {
 503         if (no_failed)
 504         {
 505             *f_resp->result = 0;
 506             package.session().close();
 507         }
 508     }
 509     package.response() = f_apdu;
 510 }
 511
 512 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
 513 {
 514     // create search request
 515     Z_SearchRequest *req = apdu_req->u.searchRequest;
 516
 517     // save these for later
 518     int smallSetUpperBound = *req->smallSetUpperBound;
 519     int largeSetLowerBound = *req->largeSetLowerBound;
 520     int mediumSetPresentNumber = *req->mediumSetPresentNumber;
 521
 522     // they are altered now - to disable piggyback
 523     *req->smallSetUpperBound = 0;
 524     *req->largeSetLowerBound = 1;
 525     *req->mediumSetPresentNumber = 1;
 526
 527     int default_num_db = req->num_databaseNames;
 528     char **default_db = req->databaseNames;
 529
 530     std::list<BackendPtr>::const_iterator bit;
 531     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 532     {
 533         PackagePtr p = (*bit)->m_package;
 534         mp::odr odr;
 535
 536         if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
 537                                                 &req->num_databaseNames,
 538                                                 &req->databaseNames))
 539         {
 540             req->num_databaseNames = default_num_db;
 541             req->databaseNames = default_db;
 542         }
 543         p->request() = apdu_req;
 544         p->copy_filter(package);
 545     }
 546     multi_move(m_backend_list);
 547
 548     // look at each response
 549     FrontendSet resultSet(std::string(req->resultSetName));
 550
 551     int result_set_size = 0;
 552     Z_Records *z_records_diag = 0;  // no diagnostics (yet)
 553     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 554     {
 555         PackagePtr p = (*bit)->m_package;
 556
 557         if (p->session().is_closed()) // if any backend closes, close frontend
 558             package.session().close();
 559
 560         Z_GDU *gdu = p->response().get();
 561         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 562             Z_APDU_searchResponse)
 563         {
 564             Z_APDU *b_apdu = gdu->u.z3950;
 565             Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
 566
 567             // see we get any errors (AKA diagnstics)
 568             if (b_resp->records)
 569             {
 570                 if (b_resp->records->which == Z_Records_NSD
 571                     || b_resp->records->which == Z_Records_multipleNSD)
 572                     z_records_diag = b_resp->records;
 573                 // we may set this multiple times (TOO BAD!)
 574             }
 575             BackendSet backendSet;
 576             backendSet.m_backend = *bit;
 577             backendSet.m_count = *b_resp->resultCount;
 578             result_set_size += *b_resp->resultCount;
 579             resultSet.m_backend_sets.push_back(backendSet);
 580         }
 581         else
 582         {
 583             // if any target does not return search response - return that
 584             package.response() = p->response();
 585             return;
 586         }
 587     }
 588
 589     mp::odr odr;
 590     Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
 591     Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
 592
 593     *f_resp->resultCount = result_set_size;
 594     if (z_records_diag)
 595     {
 596         // search error
 597         f_resp->records = z_records_diag;
 598         package.response() = f_apdu;
 599         return;
 600     }
 601     // assume OK
 602     m_sets[resultSet.m_setname] = resultSet;
 603
 604     int number;
 605     mp::util::piggyback(smallSetUpperBound,
 606                          largeSetLowerBound,
 607                          mediumSetPresentNumber,
 608                          result_set_size,
 609                          number);
 610     Package pp(package.session(), package.origin());
 611     if (number > 0)
 612     {
 613         pp.copy_filter(package);
 614         Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
 615         Z_PresentRequest *p_req = p_apdu->u.presentRequest;
 616         p_req->preferredRecordSyntax = req->preferredRecordSyntax;
 617         p_req->resultSetId = req->resultSetName;
 618         *p_req->resultSetStartPoint = 1;
 619         *p_req->numberOfRecordsRequested = number;
 620         pp.request() = p_apdu;
 621         present(pp, p_apdu);
 622
 623         if (pp.session().is_closed())
 624             package.session().close();
 625
 626         Z_GDU *gdu = pp.response().get();
 627         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 628             Z_APDU_presentResponse)
 629         {
 630             Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
 631             f_resp->records = p_res->records;
 632             *f_resp->numberOfRecordsReturned =
 633                 *p_res->numberOfRecordsReturned;
 634             *f_resp->nextResultSetPosition =
 635                 *p_res->nextResultSetPosition;
 636         }
 637         else
 638         {
 639             package.response() = pp.response();
 640             return;
 641         }
 642     }
 643     package.response() = f_apdu; // in this scope because of p
 644 }
 645
 646 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
 647 {
 648     // create present request
 649     Z_PresentRequest *req = apdu_req->u.presentRequest;
 650
 651     Sets_it it;
 652     it = m_sets.find(std::string(req->resultSetId));
 653     if (it == m_sets.end())
 654     {
 655         mp::odr odr;
 656         Z_APDU *apdu =
 657             odr.create_presentResponse(
 658                 apdu_req,
 659                 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 660                 req->resultSetId);
 661         package.response() = apdu;
 662         return;
 663     }
 664     std::list<Multi::FrontendSet::PresentJob> jobs;
 665     int start = *req->resultSetStartPoint;
 666     int number = *req->numberOfRecordsRequested;
 667
 668     if (m_p->m_merge_type == round_robin)
 669         it->second.round_robin(start, number, jobs);
 670     else if (m_p->m_merge_type == serve_order)
 671         it->second.serve_order(start, number, jobs);
 672
 673     if (0)
 674     {
 675         std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
 676         for (jit = jobs.begin(); jit != jobs.end(); jit++)
 677         {
 678             yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
 679         }
 680     }
 681
 682     std::list<BackendPtr> present_backend_list;
 683
 684     std::list<BackendSet>::const_iterator bsit;
 685     bsit = it->second.m_backend_sets.begin();
 686     for (; bsit != it->second.m_backend_sets.end(); bsit++)
 687     {
 688         int start = -1;
 689         int end = -1;
 690         {
 691             std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
 692             for (jit = jobs.begin(); jit != jobs.end(); jit++)
 693             {
 694                 if (jit->m_backend == bsit->m_backend)
 695                 {
 696                     if (start == -1 || jit->m_pos < start)
 697                         start = jit->m_pos;
 698                     if (end == -1 || jit->m_pos > end)
 699                         end = jit->m_pos;
 700                 }
 701             }
 702         }
 703         if (start != -1)
 704         {
 705             std::list<Multi::FrontendSet::PresentJob>::iterator jit;
 706             for (jit = jobs.begin(); jit != jobs.end(); jit++)
 707             {
 708                 if (jit->m_backend == bsit->m_backend)
 709                 {
 710                     if (jit->m_pos >= start && jit->m_pos <= end)
 711                         jit->m_start = start;
 712                 }
 713             }
 714
 715             PackagePtr p = bsit->m_backend->m_package;
 716
 717             *req->resultSetStartPoint = start;
 718             *req->numberOfRecordsRequested = end - start + 1;
 719
 720             p->request() = apdu_req;
 721             p->copy_filter(package);
 722
 723             present_backend_list.push_back(bsit->m_backend);
 724         }
 725     }
 726     multi_move(present_backend_list);
 727
 728     // look at each response
 729     Z_Records *z_records_diag = 0;
 730
 731     std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
 732     for (; pbit != present_backend_list.end(); pbit++)
 733     {
 734         PackagePtr p = (*pbit)->m_package;
 735
 736         if (p->session().is_closed()) // if any backend closes, close frontend
 737             package.session().close();
 738
 739         Z_GDU *gdu = p->response().get();
 740         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 741             Z_APDU_presentResponse)
 742         {
 743             Z_APDU *b_apdu = gdu->u.z3950;
 744             Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
 745
 746             // see we get any errors (AKA diagnstics)
 747             if (b_resp->records)
 748             {
 749                 if (b_resp->records->which != Z_Records_DBOSD)
 750                     z_records_diag = b_resp->records;
 751                 // we may set this multiple times (TOO BAD!)
 752             }
 753         }
 754         else
 755         {
 756             // if any target does not return present response - return that
 757             package.response() = p->response();
 758             return;
 759         }
 760     }
 761
 762     mp::odr odr;
 763     Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
 764     Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
 765
 766     if (z_records_diag)
 767     {
 768         f_resp->records = z_records_diag;
 769         *f_resp->presentStatus = Z_PresentStatus_failure;
 770     }
 771     else if (number < 0 || (size_t) number > jobs.size())
 772     {
 773         f_apdu =
 774             odr.create_presentResponse(
 775                 apdu_req,
 776                 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
 777                 0);
 778     }
 779     else
 780     {
 781         f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 782         Z_Records * records = f_resp->records;
 783         records->which = Z_Records_DBOSD;
 784         records->u.databaseOrSurDiagnostics =
 785             (Z_NamePlusRecordList *)
 786             odr_malloc(odr, sizeof(Z_NamePlusRecordList));
 787         Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
 788         nprl->num_records = jobs.size();
 789         nprl->records = (Z_NamePlusRecord**)
 790             odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
 791         int i = 0;
 792         std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
 793         for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
 794         {
 795             PackagePtr p = jit->m_backend->m_package;
 796
 797             Z_GDU *gdu = p->response().get();
 798             Z_APDU *b_apdu = gdu->u.z3950;
 799             Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
 800
 801             nprl->records[i] = (Z_NamePlusRecord*)
 802                 odr_malloc(odr, sizeof(Z_NamePlusRecord));
 803             int inside_pos = jit->m_pos - jit->m_start;
 804             if (inside_pos >= b_resp->records->
 805                 u.databaseOrSurDiagnostics->num_records)
 806                 break;
 807             *nprl->records[i] = *b_resp->records->
 808                 u.databaseOrSurDiagnostics->records[inside_pos];
 809             nprl->records[i]->databaseName =
 810                     odr_strdup(odr, jit->m_backend->m_vhost.c_str());
 811         }
 812         nprl->num_records = i; // usually same as jobs.size();
 813         *f_resp->nextResultSetPosition = start + i;
 814         *f_resp->numberOfRecordsReturned = i;
 815     }
 816     package.response() = f_apdu;
 817 }
 818
 819 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
 820 {
 821     if (m_backend_list.size() > 1)
 822     {
 823         mp::odr odr;
 824         Z_APDU *f_apdu =
 825             odr.create_scanResponse(
 826                 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
 827         package.response() = f_apdu;
 828         return;
 829     }
 830     Z_ScanRequest *req = apdu_req->u.scanRequest;
 831
 832     int default_num_db = req->num_databaseNames;
 833     char **default_db = req->databaseNames;
 834
 835     std::list<BackendPtr>::const_iterator bit;
 836     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 837     {
 838         PackagePtr p = (*bit)->m_package;
 839         mp::odr odr;
 840
 841         if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
 842                                                 &req->num_databaseNames,
 843                                                 &req->databaseNames))
 844         {
 845             req->num_databaseNames = default_num_db;
 846             req->databaseNames = default_db;
 847         }
 848         p->request() = apdu_req;
 849         p->copy_filter(package);
 850     }
 851     multi_move(m_backend_list);
 852
 853     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 854     {
 855         PackagePtr p = (*bit)->m_package;
 856
 857         if (p->session().is_closed()) // if any backend closes, close frontend
 858             package.session().close();
 859
 860         Z_GDU *gdu = p->response().get();
 861         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 862             Z_APDU_scanResponse)
 863         {
 864             package.response() = p->response();
 865             break;
 866         }
 867         else
 868         {
 869             // if any target does not return scan response - return that
 870             package.response() = p->response();
 871             return;
 872         }
 873     }
 874 }
 875
 876 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
 877 {
 878     return m_norm_term < k.m_norm_term;
 879 }
 880
 881 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
 882 {
 883     return m_norm_term == k.m_norm_term;
 884 }
 885
 886 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
 887 {
 888     Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
 889     e->which = Z_Entry_termInfo;
 890     Z_TermInfo *t;
 891     t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
 892     t->suggestedAttributes = 0;
 893     t->displayTerm = 0;
 894     t->alternativeTerm = 0;
 895     t->byAttributes = 0;
 896     t->otherTermInfo = 0;
 897     t->globalOccurrences = odr_intdup(odr, m_count);
 898     t->term = (Z_Term *)
 899         odr_malloc(odr, sizeof(*t->term));
 900     t->term->which = Z_Term_general;
 901     Odr_oct *o;
 902     t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
 903
 904     o->len = o->size = m_norm_term.size();
 905     o->buf = (unsigned char *) odr_malloc(odr, o->len);
 906     memcpy(o->buf, m_norm_term.c_str(), o->len);
 907     return e;
 908 }
 909
 910 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
 911 {
 912     Z_ScanRequest *req = apdu_req->u.scanRequest;
 913
 914     int default_num_db = req->num_databaseNames;
 915     char **default_db = req->databaseNames;
 916
 917     std::list<BackendPtr>::const_iterator bit;
 918     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 919     {
 920         PackagePtr p = (*bit)->m_package;
 921         mp::odr odr;
 922
 923         if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
 924                                                 &req->num_databaseNames,
 925                                                 &req->databaseNames))
 926         {
 927             req->num_databaseNames = default_num_db;
 928             req->databaseNames = default_db;
 929         }
 930         p->request() = apdu_req;
 931         p->copy_filter(package);
 932     }
 933     multi_move(m_backend_list);
 934
 935     ScanTermInfoList entries_before;
 936     ScanTermInfoList entries_after;
 937     int no_before = 0;
 938     int no_after = 0;
 939
 940     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 941     {
 942         PackagePtr p = (*bit)->m_package;
 943
 944         if (p->session().is_closed()) // if any backend closes, close frontend
 945             package.session().close();
 946
 947         Z_GDU *gdu = p->response().get();
 948         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 949             Z_APDU_scanResponse)
 950         {
 951             Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
 952
 953             if (res->entries && res->entries->nonsurrogateDiagnostics)
 954             {
 955                 // failure
 956                 mp::odr odr;
 957                 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
 958                 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
 959
 960                 f_res->entries->nonsurrogateDiagnostics =
 961                     res->entries->nonsurrogateDiagnostics;
 962                 f_res->entries->num_nonsurrogateDiagnostics =
 963                     res->entries->num_nonsurrogateDiagnostics;
 964
 965                 package.response() = f_apdu;
 966                 return;
 967             }
 968
 969             if (res->entries && res->entries->entries)
 970             {
 971                 Z_Entry **entries = res->entries->entries;
 972                 int num_entries = res->entries->num_entries;
 973                 int position = 1;
 974                 if (req->preferredPositionInResponse)
 975                     position = *req->preferredPositionInResponse;
 976                 if (res->positionOfTerm)
 977                     position = *res->positionOfTerm;
 978
 979                 // before
 980                 int i;
 981                 for (i = 0; i<position-1 && i<num_entries; i++)
 982                 {
 983                     Z_Entry *ent = entries[i];
 984
 985                     if (ent->which == Z_Entry_termInfo)
 986                     {
 987                         ScanTermInfo my;
 988
 989                         Odr_int *occur = ent->u.termInfo->globalOccurrences;
 990                         my.m_count = occur ? *occur : 0;
 991
 992                         if (ent->u.termInfo->term->which == Z_Term_general)
 993                         {
 994                             my.m_norm_term = std::string(
 995                                 (const char *)
 996                                 ent->u.termInfo->term->u.general->buf,
 997                                 ent->u.termInfo->term->u.general->len);
 998                         }
 999                         if (my.m_norm_term.length())
1000                         {
1001                             ScanTermInfoList::iterator it =
1002                                 entries_before.begin();
1003                             while (it != entries_before.end() && my <*it)
1004                                 it++;
1005                             if (my == *it)
1006                             {
1007                                 it->m_count += my.m_count;
1008                             }
1009                             else
1010                             {
1011                                 entries_before.insert(it, my);
1012                                 no_before++;
1013                             }
1014                         }
1015                     }
1016                 }
1017                 // after
1018                 if (position <= 0)
1019                     i = 0;
1020                 else
1021                     i = position-1;
1022                 for ( ; i<num_entries; i++)
1023                 {
1024                     Z_Entry *ent = entries[i];
1025
1026                     if (ent->which == Z_Entry_termInfo)
1027                     {
1028                         ScanTermInfo my;
1029
1030                         Odr_int *occur = ent->u.termInfo->globalOccurrences;
1031                         my.m_count = occur ? *occur : 0;
1032
1033                         if (ent->u.termInfo->term->which == Z_Term_general)
1034                         {
1035                             my.m_norm_term = std::string(
1036                                 (const char *)
1037                                 ent->u.termInfo->term->u.general->buf,
1038                                 ent->u.termInfo->term->u.general->len);
1039                         }
1040                         if (my.m_norm_term.length())
1041                         {
1042                             ScanTermInfoList::iterator it =
1043                                 entries_after.begin();
1044                             while (it != entries_after.end() && *it < my)
1045                                 it++;
1046                             if (my == *it)
1047                             {
1048                                 it->m_count += my.m_count;
1049                             }
1050                             else
1051                             {
1052                                 entries_after.insert(it, my);
1053                                 no_after++;
1054                             }
1055                         }
1056                     }
1057                 }
1058
1059             }
1060         }
1061         else
1062         {
1063             // if any target does not return scan response - return that
1064             package.response() = p->response();
1065             return;
1066         }
1067     }
1068
1069     if (false)
1070     {
1071         std::cout << "BEFORE\n";
1072         ScanTermInfoList::iterator it = entries_before.begin();
1073         for(; it != entries_before.end(); it++)
1074         {
1075             std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1076         }
1077
1078         std::cout << "AFTER\n";
1079         it = entries_after.begin();
1080         for(; it != entries_after.end(); it++)
1081         {
1082             std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1083         }
1084     }
1085
1086     if (false)
1087     {
1088         mp::odr odr;
1089         Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1090         package.response() = f_apdu;
1091     }
1092     else
1093     {
1094         mp::odr odr;
1095         Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1096         Z_ScanResponse *resp = f_apdu->u.scanResponse;
1097
1098         int number_returned = *req->numberOfTermsRequested;
1099         int position_returned = *req->preferredPositionInResponse;
1100
1101         resp->entries->num_entries = number_returned;
1102         resp->entries->entries = (Z_Entry**)
1103             odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1104         int i;
1105
1106         int lbefore = entries_before.size();
1107         if (lbefore < position_returned-1)
1108             position_returned = lbefore+1;
1109
1110         ScanTermInfoList::iterator it = entries_before.begin();
1111         for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1112         {
1113             resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1114         }
1115
1116         it = entries_after.begin();
1117
1118         if (position_returned <= 0)
1119             i = 0;
1120         else
1121             i = position_returned-1;
1122         for (; i<number_returned && it != entries_after.end(); i++, it++)
1123         {
1124             resp->entries->entries[i] = it->get_entry(odr);
1125         }
1126
1127         number_returned = i;
1128
1129         resp->positionOfTerm = odr_intdup(odr, position_returned);
1130         resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1131         resp->entries->num_entries = number_returned;
1132
1133         package.response() = f_apdu;
1134     }
1135 }
1136
1137
1138 void yf::Multi::process(mp::Package &package) const
1139 {
1140     FrontendPtr f = m_p->get_frontend(package);
1141
1142     Z_GDU *gdu = package.request().get();
1143
1144     if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1145         Z_APDU_initRequest && !f->m_is_multi)
1146     {
1147         f->init(package, gdu);
1148     }
1149     else if (!f->m_is_multi)
1150         package.move();
1151     else if (gdu && gdu->which == Z_GDU_Z3950)
1152     {
1153         Z_APDU *apdu = gdu->u.z3950;
1154         if (apdu->which == Z_APDU_initRequest)
1155         {
1156             mp::odr odr;
1157
1158             package.response() = odr.create_close(
1159                 apdu,
1160                 Z_Close_protocolError,
1161                 "double init");
1162
1163             package.session().close();
1164         }
1165         else if (apdu->which == Z_APDU_searchRequest)
1166         {
1167             f->search(package, apdu);
1168         }
1169         else if (apdu->which == Z_APDU_presentRequest)
1170         {
1171             f->present(package, apdu);
1172         }
1173         else if (apdu->which == Z_APDU_scanRequest)
1174         {
1175             f->scan2(package, apdu);
1176         }
1177         else
1178         {
1179             mp::odr odr;
1180
1181             package.response() = odr.create_close(
1182                 apdu, Z_Close_protocolError,
1183                 "unsupported APDU in filter multi");
1184
1185             package.session().close();
1186         }
1187     }
1188     m_p->release_frontend(package);
1189 }
1190
1191 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only)
1192 {
1193     for (ptr = ptr->children; ptr; ptr = ptr->next)
1194     {
1195         if (ptr->type != XML_ELEMENT_NODE)
1196             continue;
1197         if (!strcmp((const char *) ptr->name, "target"))
1198         {
1199             std::string route = mp::xml::get_route(ptr);
1200             std::string target = mp::xml::get_text(ptr);
1201             m_p->m_route_patterns.push_back(Multi::Map(target, route));
1202         }
1203         else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1204         {
1205             m_p->m_hide_unavailable = true;
1206         }
1207         else if (!strcmp((const char *) ptr->name, "mergetype"))
1208         {
1209             std::string mergetype = mp::xml::get_text(ptr);
1210             if (mergetype == "roundrobin")
1211                 m_p->m_merge_type = round_robin;
1212             else if (mergetype == "serveorder")
1213                 m_p->m_merge_type = serve_order;
1214             else
1215                 throw mp::filter::FilterException
1216                     ("Bad mergetype "  + mergetype + " in multi filter");
1217
1218         }
1219         else
1220         {
1221             throw mp::filter::FilterException
1222                 ("Bad element "
1223                  + std::string((const char *) ptr->name)
1224                  + " in multi filter");
1225         }
1226     }
1227 }
1228
1229 static mp::filter::Base* filter_creator()
1230 {
1231     return new mp::filter::Multi;
1232 }
1233
1234 extern "C" {
1235     struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1236         0,
1237         "multi",
1238         filter_creator
1239     };
1240 }
1241
1242
1243 /*
1244  * Local variables:
1245  * c-basic-offset: 4
1246  * c-file-style: "Stroustrup"
1247  * indent-tabs-mode: nil
1248  * End:
1249  * vim: shiftwidth=4 tabstop=8 expandtab
1250  */
1251