You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tellico/src/collections/bibtexcollection.cpp

401 lines
18 KiB

/***************************************************************************
copyright : (C) 2003-2006 by Robby Stephenson
email : robby@periapsis.org
***************************************************************************/
/***************************************************************************
* *
* 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 "bibtexcollection.h"
#include "../latin1literal.h"
#include "../document.h"
#include "../tellico_debug.h"
#include <klocale.h>
using Tellico::Data::BibtexCollection;
namespace {
static const char* bibtex_general = I18N_NOOP("General");
static const char* bibtex_publishing = I18N_NOOP("Publishing");
static const char* bibtex_misc = I18N_NOOP("Miscellaneous");
}
BibtexCollection::BibtexCollection(bool addFields_, const TQString& title_ /*=null*/)
: Collection(title_.isEmpty() ? i18n("Bibliography") : title_) {
if(addFields_) {
addFields(defaultFields());
}
setDefaultGroupField(TQString::tqfromLatin1("author"));
// Bibtex has some default macros for the months
addMacro(TQString::tqfromLatin1("jan"), TQString());
addMacro(TQString::tqfromLatin1("feb"), TQString());
addMacro(TQString::tqfromLatin1("mar"), TQString());
addMacro(TQString::tqfromLatin1("apr"), TQString());
addMacro(TQString::tqfromLatin1("may"), TQString());
addMacro(TQString::tqfromLatin1("jun"), TQString());
addMacro(TQString::tqfromLatin1("jul"), TQString());
addMacro(TQString::tqfromLatin1("aug"), TQString());
addMacro(TQString::tqfromLatin1("sep"), TQString());
addMacro(TQString::tqfromLatin1("oct"), TQString());
addMacro(TQString::tqfromLatin1("nov"), TQString());
addMacro(TQString::tqfromLatin1("dec"), TQString());
}
Tellico::Data::FieldVec BibtexCollection::defaultFields() {
FieldVec list;
FieldPtr field;
/******************* General ****************************/
field = new Field(TQString::tqfromLatin1("title"), i18n("Title"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("title"));
field->setCategory(i18n("General"));
field->setFlags(Field::NoDelete);
field->setFormatFlag(Field::FormatTitle);
list.append(field);
TQStringList types;
types << TQString::tqfromLatin1("article") << TQString::tqfromLatin1("book")
<< TQString::tqfromLatin1("booklet") << TQString::tqfromLatin1("inbook")
<< TQString::tqfromLatin1("incollection") << TQString::tqfromLatin1("inproceedings")
<< TQString::tqfromLatin1("manual") << TQString::tqfromLatin1("mastersthesis")
<< TQString::tqfromLatin1("misc") << TQString::tqfromLatin1("phdthesis")
<< TQString::tqfromLatin1("proceedings") << TQString::tqfromLatin1("techreport")
<< TQString::tqfromLatin1("unpublished") << TQString::tqfromLatin1("periodical")
<< TQString::tqfromLatin1("conference");
field = new Field(TQString::tqfromLatin1("entry-type"), i18n("Entry Type"), types);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("entry-type"));
field->setCategory(i18n(bibtex_general));
field->setFlags(Field::AllowGrouped | Field::NoDelete);
field->setDescription(i18n("These entry types are specific to bibtex. See the bibtex documentation."));
list.append(field);
field = new Field(TQString::tqfromLatin1("author"), i18n("Author"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("author"));
field->setCategory(i18n(bibtex_general));
field->setFlags(Field::AllowCompletion | Field::AllowMultiple | Field::AllowGrouped);
field->setFormatFlag(Field::FormatName);
list.append(field);
field = new Field(TQString::tqfromLatin1("bibtex-key"), i18n("Bibtex Key"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("key"));
field->setCategory(i18n("General"));
field->setFlags(Field::NoDelete);
list.append(field);
field = new Field(TQString::tqfromLatin1("booktitle"), i18n("Book Title"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("booktitle"));
field->setCategory(i18n(bibtex_general));
field->setFormatFlag(Field::FormatTitle);
list.append(field);
field = new Field(TQString::tqfromLatin1("editor"), i18n("Editor"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("editor"));
field->setCategory(i18n(bibtex_general));
field->setFlags(Field::AllowCompletion | Field::AllowMultiple | Field::AllowGrouped);
field->setFormatFlag(Field::FormatName);
list.append(field);
field = new Field(TQString::tqfromLatin1("organization"), i18n("Organization"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("organization"));
field->setCategory(i18n(bibtex_general));
field->setFlags(Field::AllowCompletion | Field::AllowGrouped);
field->setFormatFlag(Field::FormatPlain);
list.append(field);
// field = new Field(TQString::tqfromLatin1("institution"), i18n("Institution"));
// field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("institution"));
// field->setCategory(i18n(bibtex_general));
// field->setFlags(Field::AllowDelete);
// field->setFormatFlag(Field::FormatTitle);
// list.append(field);
/******************* Publishing ****************************/
field = new Field(TQString::tqfromLatin1("publisher"), i18n("Publisher"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("publisher"));
field->setCategory(i18n(bibtex_publishing));
field->setFlags(Field::AllowCompletion | Field::AllowGrouped);
field->setFormatFlag(Field::FormatPlain);
list.append(field);
field = new Field(TQString::tqfromLatin1("address"), i18n("Address"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("address"));
field->setCategory(i18n(bibtex_publishing));
field->setFlags(Field::AllowCompletion | Field::AllowGrouped);
list.append(field);
field = new Field(TQString::tqfromLatin1("edition"), i18n("Edition"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("edition"));
field->setCategory(i18n(bibtex_publishing));
field->setFlags(Field::AllowCompletion);
list.append(field);
// don't make it a nuumber, it could have latex processing commands in it
field = new Field(TQString::tqfromLatin1("pages"), i18n("Pages"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("pages"));
field->setCategory(i18n(bibtex_publishing));
list.append(field);
field = new Field(TQString::tqfromLatin1("year"), i18n("Year"), Field::Number);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("year"));
field->setCategory(i18n(bibtex_publishing));
field->setFlags(Field::AllowGrouped);
list.append(field);
field = new Field(TQString::tqfromLatin1("isbn"), i18n("ISBN#"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("isbn"));
field->setCategory(i18n(bibtex_publishing));
field->setDescription(i18n("International Standard Book Number"));
list.append(field);
field = new Field(TQString::tqfromLatin1("journal"), i18n("Journal"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("journal"));
field->setCategory(i18n(bibtex_publishing));
field->setFlags(Field::AllowCompletion | Field::AllowGrouped);
field->setFormatFlag(Field::FormatPlain);
list.append(field);
field = new Field(TQString::tqfromLatin1("doi"), i18n("DOI"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("doi"));
field->setCategory(i18n(bibtex_publishing));
field->setDescription(i18n("Digital Object Identifier"));
list.append(field);
// could make this a string list, but since bibtex import could have funky values
// keep it an editbox
field = new Field(TQString::tqfromLatin1("month"), i18n("Month"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("month"));
field->setCategory(i18n(bibtex_publishing));
field->setFlags(Field::AllowCompletion);
list.append(field);
field = new Field(TQString::tqfromLatin1("number"), i18n("Number"), Field::Number);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("number"));
field->setCategory(i18n(bibtex_publishing));
list.append(field);
field = new Field(TQString::tqfromLatin1("howpublished"), i18n("How Published"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("howpublished"));
field->setCategory(i18n(bibtex_publishing));
list.append(field);
// field = new Field(TQString::tqfromLatin1("school"), i18n("School"));
// field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("school"));
// field->setCategory(i18n(bibtex_publishing));
// field->setFlags(Field::AllowCompletion | Field::AllowGrouped);
// list.append(field);
/******************* Classification ****************************/
field = new Field(TQString::tqfromLatin1("chapter"), i18n("Chapter"), Field::Number);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("chapter"));
field->setCategory(i18n(bibtex_misc));
list.append(field);
field = new Field(TQString::tqfromLatin1("series"), i18n("Series"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("series"));
field->setCategory(i18n(bibtex_misc));
field->setFlags(Field::AllowCompletion | Field::AllowGrouped);
field->setFormatFlag(Field::FormatTitle);
list.append(field);
field = new Field(TQString::tqfromLatin1("volume"), i18n("Volume"), Field::Number);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("volume"));
field->setCategory(i18n(bibtex_misc));
list.append(field);
field = new Field(TQString::tqfromLatin1("crossref"), i18n("Cross-Reference"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("crossref"));
field->setCategory(i18n(bibtex_misc));
list.append(field);
// field = new Field(TQString::tqfromLatin1("annote"), i18n("Annotation"));
// field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("annote"));
// field->setCategory(i18n(bibtex_misc));
// list.append(field);
field = new Field(TQString::tqfromLatin1("keyword"), i18n("Keywords"));
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("keywords"));
field->setCategory(i18n(bibtex_misc));
field->setFlags(Field::AllowCompletion | Field::AllowMultiple | Field::AllowGrouped);
list.append(field);
field = new Field(TQString::tqfromLatin1("url"), i18n("URL"), Field::URL);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("url"));
field->setCategory(i18n(bibtex_misc));
list.append(field);
field = new Field(TQString::tqfromLatin1("abstract"), i18n("Abstract"), Data::Field::Para);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("abstract"));
list.append(field);
field = new Field(TQString::tqfromLatin1("note"), i18n("Notes"), Field::Para);
field->setProperty(TQString::tqfromLatin1("bibtex"), TQString::tqfromLatin1("note"));
list.append(field);
return list;
}
bool BibtexCollection::addField(FieldPtr field_) {
if(!field_) {
return false;
}
// myDebug() << "BibtexCollection::addField()" << endl;
bool success = Collection::addField(field_);
if(success) {
TQString bibtex = field_->property(TQString::tqfromLatin1("bibtex"));
if(!bibtex.isEmpty()) {
m_bibtexFieldDict.insert(bibtex, field_);
}
}
return success;
}
bool BibtexCollection::modifyField(FieldPtr newField_) {
if(!newField_) {
return false;
}
// myDebug() << "BibtexCollection::modifyField()" << endl;
bool success = Collection::modifyField(newField_);
FieldPtr oldField = fieldByName(newField_->name());
TQString oldBibtex = oldField->property(TQString::tqfromLatin1("bibtex"));
TQString newBibtex = newField_->property(TQString::tqfromLatin1("bibtex"));
if(!oldBibtex.isEmpty()) {
success &= m_bibtexFieldDict.remove(oldBibtex);
}
if(!newBibtex.isEmpty()) {
oldField->setProperty(TQString::tqfromLatin1("bibtex"), newBibtex);
m_bibtexFieldDict.insert(newBibtex, oldField);
}
return success;
}
bool BibtexCollection::deleteField(FieldPtr field_, bool force_) {
if(!field_) {
return false;
}
// myDebug() << "BibtexCollection::deleteField()" << endl;
bool success = true;
TQString bibtex = field_->property(TQString::tqfromLatin1("bibtex"));
if(!bibtex.isEmpty()) {
success &= m_bibtexFieldDict.remove(bibtex);
}
return success && Collection::removeField(field_, force_);
}
Tellico::Data::FieldPtr BibtexCollection::fieldByBibtexName(const TQString& bibtex_) const {
return m_bibtexFieldDict.isEmpty() ? 0 : m_bibtexFieldDict.tqfind(bibtex_);
}
// same as BookCollection::sameEntry()
int BibtexCollection::sameEntry(Data::EntryPtr entry1_, Data::EntryPtr entry2_) const {
// equal isbn's or lccn's are easy, give it a weight of 100
if(Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("isbn"), this) > 0 ||
Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("lccn"), this) > 0 ||
Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("doi"), this) > 0 ||
Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("pmid"), this) > 0 ||
Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("arxiv"), this) > 0) {
return 100; // good match
}
int res = 3*Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("title"), this);
// if(res == 0) {
// myDebug() << "BookCollection::sameEntry() - different titles for " << entry1_->title() << " vs. "
// << entry2_->title() << endl;
// }
res += Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("author"), this);
res += Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("cr_year"), this);
res += Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("pub_year"), this);
res += Entry::compareValues(entry1_, entry2_, TQString::tqfromLatin1("binding"), this);
return res;
}
// static
Tellico::Data::CollPtr BibtexCollection::convertBookCollection(CollPtr coll_) {
const TQString bibtex = TQString::tqfromLatin1("bibtex");
KSharedPtr<BibtexCollection> coll = new BibtexCollection(false, coll_->title());
FieldVec fields = coll_->fields();
for(FieldVec::Iterator fIt = fields.begin(); fIt != fields.end(); ++fIt) {
FieldPtr field = new Data::Field(*fIt);
// if it already has a bibtex property, skip it
if(!field->property(bibtex).isEmpty()) {
coll->addField(field);
continue;
}
// be sure to set bibtex property before adding it though
TQString name = field->name();
// this first group has bibtex field names the same as their own field name
if(name == Latin1Literal("title")
|| name == Latin1Literal("author")
|| name == Latin1Literal("editor")
|| name == Latin1Literal("edition")
|| name == Latin1Literal("publisher")
|| name == Latin1Literal("isbn")
|| name == Latin1Literal("lccn")
|| name == Latin1Literal("url")
|| name == Latin1Literal("language")
|| name == Latin1Literal("pages")
|| name == Latin1Literal("series")) {
field->setProperty(bibtex, name);
} else if(name == Latin1Literal("series_num")) {
field->setProperty(bibtex, TQString::tqfromLatin1("number"));
} else if(name == Latin1Literal("pur_price")) {
field->setProperty(bibtex, TQString::tqfromLatin1("price"));
} else if(name == Latin1Literal("cr_year")) {
field->setProperty(bibtex, TQString::tqfromLatin1("year"));
} else if(name == Latin1Literal("bibtex-id")) {
field->setProperty(bibtex, TQString::tqfromLatin1("key"));
} else if(name == Latin1Literal("keyword")) {
field->setProperty(bibtex, TQString::tqfromLatin1("keywords"));
} else if(name == Latin1Literal("comments")) {
field->setProperty(bibtex, TQString::tqfromLatin1("note"));
}
coll->addField(field);
}
// also need to add required fields
FieldVec vec = defaultFields();
for(FieldVec::Iterator it = vec.begin(); it != vec.end(); ++it) {
if(!coll->hasField(it->name()) && (it->flags() & Field::NoDelete)) {
// but don't add a Bibtex Key if there's already a bibtex-id
if(it->property(bibtex) != Latin1Literal("key")
|| !coll->hasField(TQString::tqfromLatin1("bibtex-id"))) {
coll->addField(it);
}
}
}
// set the entry-type to book
FieldPtr field = coll->fieldByBibtexName(TQString::tqfromLatin1("entry-type"));
TQString entryTypeName;
if(field) {
entryTypeName = field->name();
} else {
kdWarning() << "BibtexCollection::convertBookCollection() - there must be an entry type field" << endl;
}
EntryVec newEntries;
for(EntryVec::ConstIterator entryIt = coll_->entries().begin(); entryIt != coll_->entries().end(); ++entryIt) {
Data::EntryPtr entry = new Entry(*entryIt);
entry->setCollection(coll.data());
if(!entryTypeName.isEmpty()) {
entry->setField(entryTypeName, TQString::tqfromLatin1("book"));
}
newEntries.append(entry);
}
coll->addEntries(newEntries);
// now need to make sure all images are transferred
Document::self()->loadAllImagesNow();
return coll.data();
}
#include "bibtexcollection.moc"