diff options
Diffstat (limited to 'src/fetch/srufetcher.cpp')
| -rw-r--r-- | src/fetch/srufetcher.cpp | 541 |
1 files changed, 541 insertions, 0 deletions
diff --git a/src/fetch/srufetcher.cpp b/src/fetch/srufetcher.cpp new file mode 100644 index 0000000..1d7289b --- /dev/null +++ b/src/fetch/srufetcher.cpp @@ -0,0 +1,541 @@ +/*************************************************************************** + copyright : (C) 2003-2006 by Robby Stephenson + email : [email protected] + ***************************************************************************/ + +/*************************************************************************** + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of version 2 of the GNU General Public License as * + * published by the Free Software Foundation; * + * * + ***************************************************************************/ + +#include "srufetcher.h" +#include "messagehandler.h" +#include "../field.h" +#include "../collection.h" +#include "../translators/tellico_xml.h" +#include "../translators/xslthandler.h" +#include "../translators/tellicoimporter.h" +#include "../translators/dcimporter.h" +#include "../tellico_kernel.h" +#include "../tellico_debug.h" +#include "../gui/lineedit.h" +#include "../gui/combobox.h" +#include "../latin1literal.h" +#include "../tellico_utils.h" +#include "../lccnvalidator.h" + +#include <klocale.h> +#include <kio/job.h> +#include <kstandarddirs.h> +#include <kconfig.h> +#include <kcombobox.h> +#include <kaccelmanager.h> +#include <knuminput.h> + +#include <qlabel.h> +#include <qlayout.h> +#include <qwhatsthis.h> + +//#define SRU_DEBUG + +namespace { + // 7090 was the old default port, but that wa sjust because LoC used it + // let's use default HTTP port of 80 now + static const int SRU_DEFAULT_PORT = 80; + static const int SRU_MAX_RECORDS = 25; +} + +using Tellico::Fetch::SRUFetcher; +using Tellico::Fetch::SRUConfigWidget; + +SRUFetcher::SRUFetcher(QObject* parent_, const char* name_) + : Fetcher(parent_, name_), m_job(0), m_MARCXMLHandler(0), m_MODSHandler(0), m_started(false) { +} + +SRUFetcher::SRUFetcher(const QString& name_, const QString& host_, uint port_, const QString& path_, + QObject* parent_) : Fetcher(parent_), + m_host(host_), m_port(port_), m_path(path_), + m_job(0), m_MARCXMLHandler(0), m_MODSHandler(0), m_started(false) { + m_name = name_; // m_name is protected in super class +} + +SRUFetcher::~SRUFetcher() { + delete m_MARCXMLHandler; + m_MARCXMLHandler = 0; + delete m_MODSHandler; + m_MODSHandler = 0; +} + +QString SRUFetcher::defaultName() { + return i18n("SRU Server"); +} + +QString SRUFetcher::source() const { + return m_name.isEmpty() ? defaultName() : m_name; +} + +bool SRUFetcher::canFetch(int type) const { + return type == Data::Collection::Book || type == Data::Collection::Bibtex; +} + +void SRUFetcher::readConfigHook(const KConfigGroup& config_) { + m_host = config_.readEntry("Host"); + int p = config_.readNumEntry("Port", SRU_DEFAULT_PORT); + if(p > 0) { + m_port = p; + } + m_path = config_.readEntry("Path"); + // used to be called Database + if(m_path.isEmpty()) { + m_path = config_.readEntry("Database"); + } + if(!m_path.startsWith(QChar('/'))) { + m_path.prepend('/'); + } + m_format = config_.readEntry("Format", QString::fromLatin1("mods")); + m_fields = config_.readListEntry("Custom Fields"); +} + +void SRUFetcher::search(FetchKey key_, const QString& value_) { + if(m_host.isEmpty() || m_path.isEmpty()) { + myDebug() << "SRUFetcher::search() - settings are not set!" << endl; + stop(); + return; + } + + m_started = true; + +#ifdef SRU_DEBUG + KURL u = KURL::fromPathOrURL(QString::fromLatin1("/home/robby/sru.xml")); +#else + KURL u; + u.setProtocol(QString::fromLatin1("http")); + u.setHost(m_host); + u.setPort(m_port); + u.setPath(m_path); + + u.addQueryItem(QString::fromLatin1("operation"), QString::fromLatin1("searchRetrieve")); + u.addQueryItem(QString::fromLatin1("version"), QString::fromLatin1("1.1")); + u.addQueryItem(QString::fromLatin1("maximumRecords"), QString::number(SRU_MAX_RECORDS)); + u.addQueryItem(QString::fromLatin1("recordSchema"), m_format); + + const int type = Kernel::self()->collectionType(); + QString str = QChar('"') + value_ + QChar('"'); + switch(key_) { + case Title: + u.addQueryItem(QString::fromLatin1("query"), QString::fromLatin1("dc.title=") + str); + break; + + case Person: + { + QString s; + if(type == Data::Collection::Book || type == Data::Collection::Bibtex) { + s = QString::fromLatin1("author=") + str + QString::fromLatin1(" or dc.author=") + str; + } else { + s = QString::fromLatin1("dc.creator=") + str + QString::fromLatin1(" or dc.editor=") + str; + } + u.addQueryItem(QString::fromLatin1("query"), s); + } + break; + + case ISBN: + // no validation here + str.remove('-'); + // limit to first isbn + str = str.section(';', 0, 0); + u.addQueryItem(QString::fromLatin1("query"), QString::fromLatin1("bath.isbn=") + str); + break; + + case LCCN: + { + // limit to first lccn + str.remove('-'); + str = str.section(';', 0, 0); + // also try formalized lccn + QString lccn = LCCNValidator::formalize(str); + u.addQueryItem(QString::fromLatin1("query"), + QString::fromLatin1("bath.lccn=") + str + + QString::fromLatin1(" or bath.lccn=") + lccn + ); + } + break; + + case Keyword: + u.addQueryItem(QString::fromLatin1("query"), str); + break; + + case Raw: + { + QString key = value_.section('=', 0, 0).stripWhiteSpace(); + QString str = value_.section('=', 1).stripWhiteSpace(); + u.addQueryItem(key, str); + } + break; + + default: + kdWarning() << "SRUFetcher::search() - key not recognized: " << key_ << endl; + stop(); + break; + } +#endif +// myDebug() << u.prettyURL() << endl; + + m_job = KIO::get(u, false, false); + connect(m_job, SIGNAL(data(KIO::Job*, const QByteArray&)), + SLOT(slotData(KIO::Job*, const QByteArray&))); + connect(m_job, SIGNAL(result(KIO::Job*)), + SLOT(slotComplete(KIO::Job*))); +} + +void SRUFetcher::stop() { + if(!m_started) { + return; + } + if(m_job) { + m_job->kill(); + m_job = 0; + } + m_data.truncate(0); + m_started = false; + emit signalDone(this); +} + +void SRUFetcher::slotData(KIO::Job*, const QByteArray& data_) { + QDataStream stream(m_data, IO_WriteOnly | IO_Append); + stream.writeRawBytes(data_.data(), data_.size()); +} + +void SRUFetcher::slotComplete(KIO::Job* job_) { + // since the fetch is done, don't worry about holding the job pointer + m_job = 0; + + if(job_->error()) { + job_->showErrorDialog(Kernel::self()->widget()); + stop(); + return; + } + + if(m_data.isEmpty()) { + stop(); + return; + } + + Data::CollPtr coll; + QString msg; + + const QString result = QString::fromUtf8(m_data, m_data.size()); + + // first check for SRU errors + const QString& diag = XML::nsZingDiag; + Import::XMLImporter xmlImporter(result); + QDomDocument dom = xmlImporter.domDocument(); + + QDomNodeList diagList = dom.elementsByTagNameNS(diag, QString::fromLatin1("diagnostic")); + for(uint i = 0; i < diagList.count(); ++i) { + QDomElement elem = diagList.item(i).toElement(); + QDomNodeList nodeList1 = elem.elementsByTagNameNS(diag, QString::fromLatin1("message")); + QDomNodeList nodeList2 = elem.elementsByTagNameNS(diag, QString::fromLatin1("details")); + for(uint j = 0; j < nodeList1.count(); ++j) { + QString d = nodeList1.item(j).toElement().text(); + if(!d.isEmpty()) { + QString d2 = nodeList2.item(j).toElement().text(); + if(!d2.isEmpty()) { + d += " (" + d2 + ')'; + } + myDebug() << "SRUFetcher::slotComplete() - " << d << endl; + if(!msg.isEmpty()) msg += '\n'; + msg += d; + } + } + } + + QString modsResult; + if(m_format == Latin1Literal("mods")) { + modsResult = result; + } else if(m_format == Latin1Literal("marcxml") && initMARCXMLHandler()) { + modsResult = m_MARCXMLHandler->applyStylesheet(result); + } + if(!modsResult.isEmpty() && initMODSHandler()) { + Import::TellicoImporter imp(m_MODSHandler->applyStylesheet(modsResult)); + coll = imp.collection(); + if(!msg.isEmpty()) msg += '\n'; + msg += imp.statusMessage(); + } else if(m_format == Latin1Literal("dc")) { + Import::DCImporter imp(dom); + coll = imp.collection(); + if(!msg.isEmpty()) msg += '\n'; + msg += imp.statusMessage(); + } else { + myDebug() << "SRUFetcher::slotComplete() - unrecognized format: " << m_format << endl; + stop(); + return; + } + + if(coll && !msg.isEmpty()) { + message(msg, coll->entryCount() == 0 ? MessageHandler::Warning : MessageHandler::Status); + } + + if(!coll) { + myDebug() << "SRUFetcher::slotComplete() - no collection pointer" << endl; + if(!msg.isEmpty()) { + message(msg, MessageHandler::Error); + } + stop(); + return; + } + + const StringMap customFields = SRUFetcher::customFields(); + for(StringMap::ConstIterator it = customFields.begin(); it != customFields.end(); ++it) { + if(!m_fields.contains(it.key())) { + coll->removeField(it.key()); + } + } + + Data::EntryVec entries = coll->entries(); + for(Data::EntryVec::Iterator entry = entries.begin(); entry != entries.end(); ++entry) { + QString desc; + switch(coll->type()) { + case Data::Collection::Book: + desc = entry->field(QString::fromLatin1("author")) + + QChar('/') + + entry->field(QString::fromLatin1("publisher")); + if(!entry->field(QString::fromLatin1("cr_year")).isEmpty()) { + desc += QChar('/') + entry->field(QString::fromLatin1("cr_year")); + } else if(!entry->field(QString::fromLatin1("pub_year")).isEmpty()){ + desc += QChar('/') + entry->field(QString::fromLatin1("pub_year")); + } + break; + + case Data::Collection::Video: + desc = entry->field(QString::fromLatin1("studio")) + + QChar('/') + + entry->field(QString::fromLatin1("director")) + + QChar('/') + + entry->field(QString::fromLatin1("year")); + break; + + case Data::Collection::Album: + desc = entry->field(QString::fromLatin1("artist")) + + QChar('/') + + entry->field(QString::fromLatin1("label")) + + QChar('/') + + entry->field(QString::fromLatin1("year")); + break; + + default: + break; + } + SearchResult* r = new SearchResult(this, entry->title(), desc, entry->field(QString::fromLatin1("isbn"))); + m_entries.insert(r->uid, entry); + emit signalResultFound(r); + } + stop(); +} + +Tellico::Data::EntryPtr SRUFetcher::fetchEntry(uint uid_) { + return m_entries[uid_]; +} + +void SRUFetcher::updateEntry(Data::EntryPtr entry_) { +// myDebug() << "SRUFetcher::updateEntry() - " << source() << ": " << entry_->title() << endl; + QString isbn = entry_->field(QString::fromLatin1("isbn")); + if(!isbn.isEmpty()) { + search(Fetch::ISBN, isbn); + return; + } + + QString lccn = entry_->field(QString::fromLatin1("lccn")); + if(!lccn.isEmpty()) { + search(Fetch::LCCN, lccn); + return; + } + + // optimistically try searching for title and rely on Collection::sameEntry() to figure things out + QString t = entry_->field(QString::fromLatin1("title")); + if(!t.isEmpty()) { + search(Fetch::Title, t); + return; + } + + myDebug() << "SRUFetcher::updateEntry() - insufficient info to search" << endl; + emit signalDone(this); // always need to emit this if not continuing with the search +} + +bool SRUFetcher::initMARCXMLHandler() { + if(m_MARCXMLHandler) { + return true; + } + + QString xsltfile = locate("appdata", QString::fromLatin1("MARC21slim2MODS3.xsl")); + if(xsltfile.isEmpty()) { + kdWarning() << "SRUFetcher::initHandlers() - can not locate MARC21slim2MODS3.xsl." << endl; + return false; + } + + KURL u; + u.setPath(xsltfile); + + m_MARCXMLHandler = new XSLTHandler(u); + if(!m_MARCXMLHandler->isValid()) { + kdWarning() << "SRUFetcher::initHandlers() - error in MARC21slim2MODS3.xsl." << endl; + delete m_MARCXMLHandler; + m_MARCXMLHandler = 0; + return false; + } + return true; +} + +bool SRUFetcher::initMODSHandler() { + if(m_MODSHandler) { + return true; + } + + QString xsltfile = locate("appdata", QString::fromLatin1("mods2tellico.xsl")); + if(xsltfile.isEmpty()) { + kdWarning() << "SRUFetcher::initHandlers() - can not locate mods2tellico.xsl." << endl; + return false; + } + + KURL u; + u.setPath(xsltfile); + + m_MODSHandler = new XSLTHandler(u); + if(!m_MODSHandler->isValid()) { + kdWarning() << "SRUFetcher::initHandlers() - error in mods2tellico.xsl." << endl; + delete m_MODSHandler; + m_MODSHandler = 0; + return false; + } + return true; +} + +Tellico::Fetch::Fetcher::Ptr SRUFetcher::libraryOfCongress(QObject* parent_) { + return new SRUFetcher(i18n("Library of Congress (US)"), QString::fromLatin1("z3950.loc.gov"), 7090, + QString::fromLatin1("voyager"), parent_); +} + +// static +Tellico::StringMap SRUFetcher::customFields() { + StringMap map; + map[QString::fromLatin1("address")] = i18n("Address"); + map[QString::fromLatin1("abstract")] = i18n("Abstract"); + return map; +} + +Tellico::Fetch::ConfigWidget* SRUFetcher::configWidget(QWidget* parent_) const { + return new SRUConfigWidget(parent_, this); +} + +SRUConfigWidget::SRUConfigWidget(QWidget* parent_, const SRUFetcher* fetcher_ /*=0*/) + : ConfigWidget(parent_) { + QGridLayout* l = new QGridLayout(optionsWidget(), 4, 2); + l->setSpacing(4); + l->setColStretch(1, 10); + + int row = -1; + QLabel* label = new QLabel(i18n("Hos&t: "), optionsWidget()); + l->addWidget(label, ++row, 0); + m_hostEdit = new GUI::LineEdit(optionsWidget()); + connect(m_hostEdit, SIGNAL(textChanged(const QString&)), SLOT(slotSetModified())); + connect(m_hostEdit, SIGNAL(textChanged(const QString&)), SIGNAL(signalName(const QString&))); + connect(m_hostEdit, SIGNAL(textChanged(const QString&)), SLOT(slotCheckHost())); + l->addWidget(m_hostEdit, row, 1); + QString w = i18n("Enter the host name of the server."); + QWhatsThis::add(label, w); + QWhatsThis::add(m_hostEdit, w); + label->setBuddy(m_hostEdit); + + label = new QLabel(i18n("&Port: "), optionsWidget()); + l->addWidget(label, ++row, 0); + m_portSpinBox = new KIntSpinBox(0, 999999, 1, SRU_DEFAULT_PORT, 10, optionsWidget()); + connect(m_portSpinBox, SIGNAL(valueChanged(int)), SLOT(slotSetModified())); + l->addWidget(m_portSpinBox, row, 1); + w = i18n("Enter the port number of the server. The default is %1.").arg(SRU_DEFAULT_PORT); + QWhatsThis::add(label, w); + QWhatsThis::add(m_portSpinBox, w); + label->setBuddy(m_portSpinBox); + + label = new QLabel(i18n("Path: "), optionsWidget()); + l->addWidget(label, ++row, 0); + m_pathEdit = new GUI::LineEdit(optionsWidget()); + connect(m_pathEdit, SIGNAL(textChanged(const QString&)), SLOT(slotSetModified())); + l->addWidget(m_pathEdit, row, 1); + w = i18n("Enter the path to the database used by the server."); + QWhatsThis::add(label, w); + QWhatsThis::add(m_pathEdit, w); + label->setBuddy(m_pathEdit); + + label = new QLabel(i18n("Format: "), optionsWidget()); + l->addWidget(label, ++row, 0); + m_formatCombo = new GUI::ComboBox(optionsWidget()); + m_formatCombo->insertItem(QString::fromLatin1("MODS"), QString::fromLatin1("mods")); + m_formatCombo->insertItem(QString::fromLatin1("MARCXML"), QString::fromLatin1("marcxml")); + m_formatCombo->insertItem(QString::fromLatin1("Dublin Core"), QString::fromLatin1("dc")); + connect(m_formatCombo, SIGNAL(activated(int)), SLOT(slotSetModified())); + l->addWidget(m_formatCombo, row, 1); + w = i18n("Enter the result format used by the server."); + QWhatsThis::add(label, w); + QWhatsThis::add(m_formatCombo, w); + label->setBuddy(m_formatCombo); + + l->setRowStretch(++row, 1); + + // now add additional fields widget + addFieldsWidget(SRUFetcher::customFields(), fetcher_ ? fetcher_->m_fields : QStringList()); + + if(fetcher_) { + m_hostEdit->setText(fetcher_->m_host); + m_portSpinBox->setValue(fetcher_->m_port); + m_pathEdit->setText(fetcher_->m_path); + m_formatCombo->setCurrentData(fetcher_->m_format); + } + KAcceleratorManager::manage(optionsWidget()); +} + +void SRUConfigWidget::saveConfig(KConfigGroup& config_) { + QString s = m_hostEdit->text().stripWhiteSpace(); + if(!s.isEmpty()) { + config_.writeEntry("Host", s); + } + int port = m_portSpinBox->value(); + if(port > 0) { + config_.writeEntry("Port", port); + } + s = m_pathEdit->text().stripWhiteSpace(); + if(!s.isEmpty()) { + config_.writeEntry("Path", s); + } + s = m_formatCombo->currentData().toString(); + if(!s.isEmpty()) { + config_.writeEntry("Format", s); + } + saveFieldsConfig(config_); + slotSetModified(false); +} + +QString SRUConfigWidget::preferredName() const { + QString s = m_hostEdit->text(); + return s.isEmpty() ? SRUFetcher::defaultName() : s; +} + +void SRUConfigWidget::slotCheckHost() { + QString s = m_hostEdit->text(); + // someone might be pasting a full URL, check that + if(s.find(':') > -1 || s.find('/') > -1) { + KURL u(s); + if(u.isValid()) { + m_hostEdit->setText(u.host()); + if(u.port() > 0) { + m_portSpinBox->setValue(u.port()); + } + if(!u.path().isEmpty()) { + m_pathEdit->setText(u.path()); + } + } + } +} + +#include "srufetcher.moc" |