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     ODR_MASK_SET(f_resp->options, Z_Options_scan);
 449
 450     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
 451     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
 452     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
 453
 454     int no_failed = 0;
 455     int no_succeeded = 0;
 456     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
 457     {
 458         PackagePtr p = (*bit)->m_package;
 459
 460         if (p->session().is_closed())
 461         {
 462             // failed. Remove from list and increment number of failed
 463             no_failed++;
 464             bit = m_backend_list.erase(bit);
 465             continue;
 466         }
 467         Z_GDU *gdu = p->response().get();
 468         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 469             Z_APDU_initResponse)
 470         {
 471             int i;
 472             Z_APDU *b_apdu = gdu->u.z3950;
 473             Z_InitResponse *b_resp = b_apdu->u.initResponse;
 474
 475             // common options for all backends
 476             for (i = 0; i <= Z_Options_stringSchema; i++)
 477             {
 478                 if (!ODR_MASK_GET(b_resp->options, i))
 479                     ODR_MASK_CLEAR(f_resp->options, i);
 480             }
 481             // common protocol version
 482             for (i = 0; i <= Z_ProtocolVersion_3; i++)
 483                 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
 484                     ODR_MASK_CLEAR(f_resp->protocolVersion, i);
 485             if (*b_resp->result)
 486                 no_succeeded++;
 487             else
 488                 no_failed++;
 489         }
 490         else
 491             no_failed++;
 492         bit++;
 493     }
 494     if (m_p->m_hide_unavailable)
 495     {
 496         if (no_succeeded == 0)
 497         {
 498             *f_resp->result = 0;
 499             package.session().close();
 500         }
 501     }
 502     else
 503     {
 504         if (no_failed)
 505         {
 506             *f_resp->result = 0;
 507             package.session().close();
 508         }
 509     }
 510     package.response() = f_apdu;
 511 }
 512
 513 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
 514 {
 515     // create search request
 516     Z_SearchRequest *req = apdu_req->u.searchRequest;
 517
 518     // save these for later
 519     int smallSetUpperBound = *req->smallSetUpperBound;
 520     int largeSetLowerBound = *req->largeSetLowerBound;
 521     int mediumSetPresentNumber = *req->mediumSetPresentNumber;
 522
 523     // they are altered now - to disable piggyback
 524     *req->smallSetUpperBound = 0;
 525     *req->largeSetLowerBound = 1;
 526     *req->mediumSetPresentNumber = 1;
 527
 528     int default_num_db = req->num_databaseNames;
 529     char **default_db = req->databaseNames;
 530
 531     std::list<BackendPtr>::const_iterator bit;
 532     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 533     {
 534         PackagePtr p = (*bit)->m_package;
 535         mp::odr odr;
 536
 537         if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
 538                                                 &req->num_databaseNames,
 539                                                 &req->databaseNames))
 540         {
 541             req->num_databaseNames = default_num_db;
 542             req->databaseNames = default_db;
 543         }
 544         p->request() = apdu_req;
 545         p->copy_filter(package);
 546     }
 547     multi_move(m_backend_list);
 548
 549     // look at each response
 550     FrontendSet resultSet(std::string(req->resultSetName));
 551
 552     int result_set_size = 0;
 553     Z_Records *z_records_diag = 0;  // no diagnostics (yet)
 554     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 555     {
 556         PackagePtr p = (*bit)->m_package;
 557
 558         if (p->session().is_closed()) // if any backend closes, close frontend
 559             package.session().close();
 560
 561         Z_GDU *gdu = p->response().get();
 562         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 563             Z_APDU_searchResponse)
 564         {
 565             Z_APDU *b_apdu = gdu->u.z3950;
 566             Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
 567
 568             // see we get any errors (AKA diagnstics)
 569             if (b_resp->records)
 570             {
 571                 if (b_resp->records->which == Z_Records_NSD
 572                     || b_resp->records->which == Z_Records_multipleNSD)
 573                     z_records_diag = b_resp->records;
 574                 // we may set this multiple times (TOO BAD!)
 575             }
 576             BackendSet backendSet;
 577             backendSet.m_backend = *bit;
 578             backendSet.m_count = *b_resp->resultCount;
 579             result_set_size += *b_resp->resultCount;
 580             resultSet.m_backend_sets.push_back(backendSet);
 581         }
 582         else
 583         {
 584             // if any target does not return search response - return that
 585             package.response() = p->response();
 586             return;
 587         }
 588     }
 589
 590     mp::odr odr;
 591     Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
 592     Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
 593
 594     *f_resp->resultCount = result_set_size;
 595     if (z_records_diag)
 596     {
 597         // search error
 598         f_resp->records = z_records_diag;
 599         package.response() = f_apdu;
 600         return;
 601     }
 602     // assume OK
 603     m_sets[resultSet.m_setname] = resultSet;
 604
 605     int number;
 606     mp::util::piggyback(smallSetUpperBound,
 607                          largeSetLowerBound,
 608                          mediumSetPresentNumber,
 609                          result_set_size,
 610                          number);
 611     Package pp(package.session(), package.origin());
 612     if (number > 0)
 613     {
 614         pp.copy_filter(package);
 615         Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
 616         Z_PresentRequest *p_req = p_apdu->u.presentRequest;
 617         p_req->preferredRecordSyntax = req->preferredRecordSyntax;
 618         p_req->resultSetId = req->resultSetName;
 619         *p_req->resultSetStartPoint = 1;
 620         *p_req->numberOfRecordsRequested = number;
 621         pp.request() = p_apdu;
 622         present(pp, p_apdu);
 623
 624         if (pp.session().is_closed())
 625             package.session().close();
 626
 627         Z_GDU *gdu = pp.response().get();
 628         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 629             Z_APDU_presentResponse)
 630         {
 631             Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
 632             f_resp->records = p_res->records;
 633             *f_resp->numberOfRecordsReturned =
 634                 *p_res->numberOfRecordsReturned;
 635             *f_resp->nextResultSetPosition =
 636                 *p_res->nextResultSetPosition;
 637         }
 638         else
 639         {
 640             package.response() = pp.response();
 641             return;
 642         }
 643     }
 644     package.response() = f_apdu; // in this scope because of p
 645 }
 646
 647 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
 648 {
 649     // create present request
 650     Z_PresentRequest *req = apdu_req->u.presentRequest;
 651
 652     Sets_it it;
 653     it = m_sets.find(std::string(req->resultSetId));
 654     if (it == m_sets.end())
 655     {
 656         mp::odr odr;
 657         Z_APDU *apdu =
 658             odr.create_presentResponse(
 659                 apdu_req,
 660                 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 661                 req->resultSetId);
 662         package.response() = apdu;
 663         return;
 664     }
 665     std::list<Multi::FrontendSet::PresentJob> jobs;
 666     int start = *req->resultSetStartPoint;
 667     int number = *req->numberOfRecordsRequested;
 668
 669     if (m_p->m_merge_type == round_robin)
 670         it->second.round_robin(start, number, jobs);
 671     else if (m_p->m_merge_type == serve_order)
 672         it->second.serve_order(start, number, jobs);
 673
 674     if (0)
 675     {
 676         std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
 677         for (jit = jobs.begin(); jit != jobs.end(); jit++)
 678         {
 679             yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
 680         }
 681     }
 682
 683     std::list<BackendPtr> present_backend_list;
 684
 685     std::list<BackendSet>::const_iterator bsit;
 686     bsit = it->second.m_backend_sets.begin();
 687     for (; bsit != it->second.m_backend_sets.end(); bsit++)
 688     {
 689         int start = -1;
 690         int end = -1;
 691         {
 692             std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
 693             for (jit = jobs.begin(); jit != jobs.end(); jit++)
 694             {
 695                 if (jit->m_backend == bsit->m_backend)
 696                 {
 697                     if (start == -1 || jit->m_pos < start)
 698                         start = jit->m_pos;
 699                     if (end == -1 || jit->m_pos > end)
 700                         end = jit->m_pos;
 701                 }
 702             }
 703         }
 704         if (start != -1)
 705         {
 706             std::list<Multi::FrontendSet::PresentJob>::iterator jit;
 707             for (jit = jobs.begin(); jit != jobs.end(); jit++)
 708             {
 709                 if (jit->m_backend == bsit->m_backend)
 710                 {
 711                     if (jit->m_pos >= start && jit->m_pos <= end)
 712                         jit->m_start = start;
 713                 }
 714             }
 715
 716             PackagePtr p = bsit->m_backend->m_package;
 717
 718             *req->resultSetStartPoint = start;
 719             *req->numberOfRecordsRequested = end - start + 1;
 720
 721             p->request() = apdu_req;
 722             p->copy_filter(package);
 723
 724             present_backend_list.push_back(bsit->m_backend);
 725         }
 726     }
 727     multi_move(present_backend_list);
 728
 729     // look at each response
 730     Z_Records *z_records_diag = 0;
 731
 732     std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
 733     for (; pbit != present_backend_list.end(); pbit++)
 734     {
 735         PackagePtr p = (*pbit)->m_package;
 736
 737         if (p->session().is_closed()) // if any backend closes, close frontend
 738             package.session().close();
 739
 740         Z_GDU *gdu = p->response().get();
 741         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 742             Z_APDU_presentResponse)
 743         {
 744             Z_APDU *b_apdu = gdu->u.z3950;
 745             Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
 746
 747             // see we get any errors (AKA diagnstics)
 748             if (b_resp->records)
 749             {
 750                 if (b_resp->records->which != Z_Records_DBOSD)
 751                     z_records_diag = b_resp->records;
 752                 // we may set this multiple times (TOO BAD!)
 753             }
 754         }
 755         else
 756         {
 757             // if any target does not return present response - return that
 758             package.response() = p->response();
 759             return;
 760         }
 761     }
 762
 763     mp::odr odr;
 764     Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
 765     Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
 766
 767     if (z_records_diag)
 768     {
 769         f_resp->records = z_records_diag;
 770         *f_resp->presentStatus = Z_PresentStatus_failure;
 771     }
 772     else if (number < 0 || (size_t) number > jobs.size())
 773     {
 774         f_apdu =
 775             odr.create_presentResponse(
 776                 apdu_req,
 777                 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
 778                 0);
 779     }
 780     else
 781     {
 782         f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 783         Z_Records * records = f_resp->records;
 784         records->which = Z_Records_DBOSD;
 785         records->u.databaseOrSurDiagnostics =
 786             (Z_NamePlusRecordList *)
 787             odr_malloc(odr, sizeof(Z_NamePlusRecordList));
 788         Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
 789         nprl->num_records = jobs.size();
 790         nprl->records = (Z_NamePlusRecord**)
 791             odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
 792         int i = 0;
 793         std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
 794         for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
 795         {
 796             PackagePtr p = jit->m_backend->m_package;
 797
 798             Z_GDU *gdu = p->response().get();
 799             Z_APDU *b_apdu = gdu->u.z3950;
 800             Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
 801
 802             nprl->records[i] = (Z_NamePlusRecord*)
 803                 odr_malloc(odr, sizeof(Z_NamePlusRecord));
 804             int inside_pos = jit->m_pos - jit->m_start;
 805             if (inside_pos >= b_resp->records->
 806                 u.databaseOrSurDiagnostics->num_records)
 807                 break;
 808             *nprl->records[i] = *b_resp->records->
 809                 u.databaseOrSurDiagnostics->records[inside_pos];
 810             nprl->records[i]->databaseName =
 811                     odr_strdup(odr, jit->m_backend->m_vhost.c_str());
 812         }
 813         nprl->num_records = i; // usually same as jobs.size();
 814         *f_resp->nextResultSetPosition = start + i;
 815         *f_resp->numberOfRecordsReturned = i;
 816     }
 817     package.response() = f_apdu;
 818 }
 819
 820 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
 821 {
 822     if (m_backend_list.size() > 1)
 823     {
 824         mp::odr odr;
 825         Z_APDU *f_apdu =
 826             odr.create_scanResponse(
 827                 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
 828         package.response() = f_apdu;
 829         return;
 830     }
 831     Z_ScanRequest *req = apdu_req->u.scanRequest;
 832
 833     int default_num_db = req->num_databaseNames;
 834     char **default_db = req->databaseNames;
 835
 836     std::list<BackendPtr>::const_iterator bit;
 837     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 838     {
 839         PackagePtr p = (*bit)->m_package;
 840         mp::odr odr;
 841
 842         if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
 843                                                 &req->num_databaseNames,
 844                                                 &req->databaseNames))
 845         {
 846             req->num_databaseNames = default_num_db;
 847             req->databaseNames = default_db;
 848         }
 849         p->request() = apdu_req;
 850         p->copy_filter(package);
 851     }
 852     multi_move(m_backend_list);
 853
 854     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 855     {
 856         PackagePtr p = (*bit)->m_package;
 857
 858         if (p->session().is_closed()) // if any backend closes, close frontend
 859             package.session().close();
 860
 861         Z_GDU *gdu = p->response().get();
 862         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 863             Z_APDU_scanResponse)
 864         {
 865             package.response() = p->response();
 866             break;
 867         }
 868         else
 869         {
 870             // if any target does not return scan response - return that
 871             package.response() = p->response();
 872             return;
 873         }
 874     }
 875 }
 876
 877 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
 878 {
 879     return m_norm_term < k.m_norm_term;
 880 }
 881
 882 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
 883 {
 884     return m_norm_term == k.m_norm_term;
 885 }
 886
 887 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
 888 {
 889     Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
 890     e->which = Z_Entry_termInfo;
 891     Z_TermInfo *t;
 892     t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
 893     t->suggestedAttributes = 0;
 894     t->displayTerm = 0;
 895     t->alternativeTerm = 0;
 896     t->byAttributes = 0;
 897     t->otherTermInfo = 0;
 898     t->globalOccurrences = odr_intdup(odr, m_count);
 899     t->term = (Z_Term *)
 900         odr_malloc(odr, sizeof(*t->term));
 901     t->term->which = Z_Term_general;
 902     Odr_oct *o;
 903     t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
 904
 905     o->len = o->size = m_norm_term.size();
 906     o->buf = (unsigned char *) odr_malloc(odr, o->len);
 907     memcpy(o->buf, m_norm_term.c_str(), o->len);
 908     return e;
 909 }
 910
 911 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
 912 {
 913     Z_ScanRequest *req = apdu_req->u.scanRequest;
 914
 915     int default_num_db = req->num_databaseNames;
 916     char **default_db = req->databaseNames;
 917
 918     std::list<BackendPtr>::const_iterator bit;
 919     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 920     {
 921         PackagePtr p = (*bit)->m_package;
 922         mp::odr odr;
 923
 924         if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
 925                                                 &req->num_databaseNames,
 926                                                 &req->databaseNames))
 927         {
 928             req->num_databaseNames = default_num_db;
 929             req->databaseNames = default_db;
 930         }
 931         p->request() = apdu_req;
 932         p->copy_filter(package);
 933     }
 934     multi_move(m_backend_list);
 935
 936     ScanTermInfoList entries_before;
 937     ScanTermInfoList entries_after;
 938     int no_before = 0;
 939     int no_after = 0;
 940
 941     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
 942     {
 943         PackagePtr p = (*bit)->m_package;
 944
 945         if (p->session().is_closed()) // if any backend closes, close frontend
 946             package.session().close();
 947
 948         Z_GDU *gdu = p->response().get();
 949         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 950             Z_APDU_scanResponse)
 951         {
 952             Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
 953
 954             if (res->entries && res->entries->nonsurrogateDiagnostics)
 955             {
 956                 // failure
 957                 mp::odr odr;
 958                 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
 959                 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
 960
 961                 f_res->entries->nonsurrogateDiagnostics =
 962                     res->entries->nonsurrogateDiagnostics;
 963                 f_res->entries->num_nonsurrogateDiagnostics =
 964                     res->entries->num_nonsurrogateDiagnostics;
 965
 966                 package.response() = f_apdu;
 967                 return;
 968             }
 969
 970             if (res->entries && res->entries->entries)
 971             {
 972                 Z_Entry **entries = res->entries->entries;
 973                 int num_entries = res->entries->num_entries;
 974                 int position = 1;
 975                 if (req->preferredPositionInResponse)
 976                     position = *req->preferredPositionInResponse;
 977                 if (res->positionOfTerm)
 978                     position = *res->positionOfTerm;
 979
 980                 // before
 981                 int i;
 982                 for (i = 0; i<position-1 && i<num_entries; i++)
 983                 {
 984                     Z_Entry *ent = entries[i];
 985
 986                     if (ent->which == Z_Entry_termInfo)
 987                     {
 988                         ScanTermInfo my;
 989
 990                         Odr_int *occur = ent->u.termInfo->globalOccurrences;
 991                         my.m_count = occur ? *occur : 0;
 992
 993                         if (ent->u.termInfo->term->which == Z_Term_general)
 994                         {
 995                             my.m_norm_term = std::string(
 996                                 (const char *)
 997                                 ent->u.termInfo->term->u.general->buf,
 998                                 ent->u.termInfo->term->u.general->len);
 999                         }
1000                         if (my.m_norm_term.length())
1001                         {
1002                             ScanTermInfoList::iterator it =
1003                                 entries_before.begin();
1004                             while (it != entries_before.end() && my <*it)
1005                                 it++;
1006                             if (my == *it)
1007                             {
1008                                 it->m_count += my.m_count;
1009                             }
1010                             else
1011                             {
1012                                 entries_before.insert(it, my);
1013                                 no_before++;
1014                             }
1015                         }
1016                     }
1017                 }
1018                 // after
1019                 if (position <= 0)
1020                     i = 0;
1021                 else
1022                     i = position-1;
1023                 for ( ; i<num_entries; i++)
1024                 {
1025                     Z_Entry *ent = entries[i];
1026
1027                     if (ent->which == Z_Entry_termInfo)
1028                     {
1029                         ScanTermInfo my;
1030
1031                         Odr_int *occur = ent->u.termInfo->globalOccurrences;
1032                         my.m_count = occur ? *occur : 0;
1033
1034                         if (ent->u.termInfo->term->which == Z_Term_general)
1035                         {
1036                             my.m_norm_term = std::string(
1037                                 (const char *)
1038                                 ent->u.termInfo->term->u.general->buf,
1039                                 ent->u.termInfo->term->u.general->len);
1040                         }
1041                         if (my.m_norm_term.length())
1042                         {
1043                             ScanTermInfoList::iterator it =
1044                                 entries_after.begin();
1045                             while (it != entries_after.end() && *it < my)
1046                                 it++;
1047                             if (my == *it)
1048                             {
1049                                 it->m_count += my.m_count;
1050                             }
1051                             else
1052                             {
1053                                 entries_after.insert(it, my);
1054                                 no_after++;
1055                             }
1056                         }
1057                     }
1058                 }
1059
1060             }
1061         }
1062         else
1063         {
1064             // if any target does not return scan response - return that
1065             package.response() = p->response();
1066             return;
1067         }
1068     }
1069
1070     if (false)
1071     {
1072         std::cout << "BEFORE\n";
1073         ScanTermInfoList::iterator it = entries_before.begin();
1074         for(; it != entries_before.end(); it++)
1075         {
1076             std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1077         }
1078
1079         std::cout << "AFTER\n";
1080         it = entries_after.begin();
1081         for(; it != entries_after.end(); it++)
1082         {
1083             std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1084         }
1085     }
1086
1087     if (false)
1088     {
1089         mp::odr odr;
1090         Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1091         package.response() = f_apdu;
1092     }
1093     else
1094     {
1095         mp::odr odr;
1096         Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1097         Z_ScanResponse *resp = f_apdu->u.scanResponse;
1098
1099         int number_returned = *req->numberOfTermsRequested;
1100         int position_returned = *req->preferredPositionInResponse;
1101
1102         resp->entries->num_entries = number_returned;
1103         resp->entries->entries = (Z_Entry**)
1104             odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1105         int i;
1106
1107         int lbefore = entries_before.size();
1108         if (lbefore < position_returned-1)
1109             position_returned = lbefore+1;
1110
1111         ScanTermInfoList::iterator it = entries_before.begin();
1112         for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1113         {
1114             resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1115         }
1116
1117         it = entries_after.begin();
1118
1119         if (position_returned <= 0)
1120             i = 0;
1121         else
1122             i = position_returned-1;
1123         for (; i<number_returned && it != entries_after.end(); i++, it++)
1124         {
1125             resp->entries->entries[i] = it->get_entry(odr);
1126         }
1127
1128         number_returned = i;
1129
1130         resp->positionOfTerm = odr_intdup(odr, position_returned);
1131         resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1132         resp->entries->num_entries = number_returned;
1133
1134         package.response() = f_apdu;
1135     }
1136 }
1137
1138
1139 void yf::Multi::process(mp::Package &package) const
1140 {
1141     FrontendPtr f = m_p->get_frontend(package);
1142
1143     Z_GDU *gdu = package.request().get();
1144
1145     if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1146         Z_APDU_initRequest && !f->m_is_multi)
1147     {
1148         f->init(package, gdu);
1149     }
1150     else if (!f->m_is_multi)
1151         package.move();
1152     else if (gdu && gdu->which == Z_GDU_Z3950)
1153     {
1154         Z_APDU *apdu = gdu->u.z3950;
1155         if (apdu->which == Z_APDU_initRequest)
1156         {
1157             mp::odr odr;
1158
1159             package.response() = odr.create_close(
1160                 apdu,
1161                 Z_Close_protocolError,
1162                 "double init");
1163
1164             package.session().close();
1165         }
1166         else if (apdu->which == Z_APDU_searchRequest)
1167         {
1168             f->search(package, apdu);
1169         }
1170         else if (apdu->which == Z_APDU_presentRequest)
1171         {
1172             f->present(package, apdu);
1173         }
1174         else if (apdu->which == Z_APDU_scanRequest)
1175         {
1176             f->scan2(package, apdu);
1177         }
1178         else
1179         {
1180             mp::odr odr;
1181
1182             package.response() = odr.create_close(
1183                 apdu, Z_Close_protocolError,
1184                 "unsupported APDU in filter multi");
1185
1186             package.session().close();
1187         }
1188     }
1189     m_p->release_frontend(package);
1190 }
1191
1192 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only)
1193 {
1194     for (ptr = ptr->children; ptr; ptr = ptr->next)
1195     {
1196         if (ptr->type != XML_ELEMENT_NODE)
1197             continue;
1198         if (!strcmp((const char *) ptr->name, "target"))
1199         {
1200             std::string route = mp::xml::get_route(ptr);
1201             std::string target = mp::xml::get_text(ptr);
1202             m_p->m_route_patterns.push_back(Multi::Map(target, route));
1203         }
1204         else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1205         {
1206             m_p->m_hide_unavailable = true;
1207         }
1208         else if (!strcmp((const char *) ptr->name, "mergetype"))
1209         {
1210             std::string mergetype = mp::xml::get_text(ptr);
1211             if (mergetype == "roundrobin")
1212                 m_p->m_merge_type = round_robin;
1213             else if (mergetype == "serveorder")
1214                 m_p->m_merge_type = serve_order;
1215             else
1216                 throw mp::filter::FilterException
1217                     ("Bad mergetype "  + mergetype + " in multi filter");
1218
1219         }
1220         else
1221         {
1222             throw mp::filter::FilterException
1223                 ("Bad element "
1224                  + std::string((const char *) ptr->name)
1225                  + " in multi filter");
1226         }
1227     }
1228 }
1229
1230 static mp::filter::Base* filter_creator()
1231 {
1232     return new mp::filter::Multi;
1233 }
1234
1235 extern "C" {
1236     struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1237         0,
1238         "multi",
1239         filter_creator
1240     };
1241 }
1242
1243
1244 /*
1245  * Local variables:
1246  * c-basic-offset: 4
1247  * c-file-style: "Stroustrup"
1248  * indent-tabs-mode: nil
1249  * End:
1250  * vim: shiftwidth=4 tabstop=8 expandtab
1251  */
1252