Support MTGJSONv5 format in Oracle downloader (#4162)

* Fix #4043, Support MTGJSONv5 format in Oracle downloader

* Auto redirect V4 downloads to V5, as we won't support V4 after this change

* clangify >_>

* Remove null values and account for IDs missing

* fix split cards and double faced cards somewhat

* do not consider double faced cards duplicates

* fix promo double sided cards

* typo

* fix alternative versions of cards with (letter)

* zach says this is more readable

* pre qt 5.10 compatibility

Co-authored-by: ebbit1q <ebbit1q@gmail.com>
This commit is contained in:
Zach H
2020-11-23 16:12:41 -05:00
committed by GitHub
parent f3cf1f0dde
commit 9f9581c2be
5 changed files with 118 additions and 76 deletions

View File

@@ -3,16 +3,15 @@
#include "carddbparser/cockatricexml4.h"
#include "qt-json/json.h"
#include <QDebug>
#include <QtWidgets>
#include <algorithm>
#include <climits>
SplitCardPart::SplitCardPart(const int _index,
SplitCardPart::SplitCardPart(const QString &_name,
const QString &_text,
const QVariantHash &_properties,
const CardInfoPerSet _setInfo)
: index(_index), text(_text), properties(_properties), setInfo(_setInfo)
: name(_name), text(_text), properties(_properties), setInfo(_setInfo)
{
}
@@ -25,7 +24,7 @@ bool OracleImporter::readSetsFromByteArray(const QByteArray &data)
QList<SetToDownload> newSetList;
bool ok;
setsMap = QtJson::Json::parse(QString(data), ok).toMap();
setsMap = QtJson::Json::parse(QString(data), ok).toMap().value("data").toMap();
if (!ok) {
qDebug() << "error: QtJson::Json::parse()";
return false;
@@ -162,14 +161,9 @@ CardInfoPtr OracleImporter::addCard(QString name,
// upsideDown (flip cards)
bool upsideDown = false;
QStringList additionalNames = properties.value("names").toStringList();
QString layout = properties.value("layout").toString();
if (layout == "flip") {
if (properties.value("side").toString() != "front") {
upsideDown = true;
}
// reset the side property, since the card has no back image
properties.insert("side", "front");
upsideDown = properties.value("side").toString() != "a";
}
// insert the card and its properties
@@ -179,36 +173,41 @@ CardInfoPtr OracleImporter::addCard(QString name,
CardInfoPtr newCard = CardInfo::newInstance(name, text, isToken, properties, relatedCards, reverseRelatedCards,
setsInfo, cipt, tableRow, upsideDown);
if (name.isEmpty()) {
qDebug() << "warning: an empty card was added to set" << setInfo.getPtr()->getShortName();
}
cards.insert(name, newCard);
return newCard;
}
QString OracleImporter::getStringPropertyFromMap(QVariantMap card, QString propertyName)
QString OracleImporter::getStringPropertyFromMap(const QVariantMap &card, const QString &propertyName)
{
return card.contains(propertyName) ? card.value(propertyName).toString() : QString("");
}
int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVariant> &cardsList, bool skipSpecialCards)
int OracleImporter::importCardsFromSet(const CardSetPtr &currentSet,
const QList<QVariant> &cardsList,
bool skipSpecialCards)
{
// mtgjson name => xml name
static const QMap<QString, QString> cardProperties{
// mtgjson name => xml name
{"manaCost", "manacost"}, {"convertedManaCost", "cmc"}, {"type", "type"},
{"loyalty", "loyalty"}, {"layout", "layout"}, {"side", "side"},
};
static const QMap<QString, QString> setInfoProperties{// mtgjson name => xml name
{"multiverseId", "muid"},
{"scryfallId", "uuid"},
{"number", "num"},
{"rarity", "rarity"}};
// mtgjson name => xml name
static const QMap<QString, QString> setInfoProperties{{"number", "num"}, {"rarity", "rarity"}};
// mtgjson name => xml name
static const QMap<QString, QString> identifierProperties{{"multiverseId", "muid"}, {"scryfallId", "uuid"}};
int numCards = 0;
QMultiMap<QString, SplitCardPart> splitCards;
QString ptSeparator("/");
QVariantMap card;
QString layout, name, text, colors, colorIdentity, maintype, power, toughness;
QString layout, name, text, colors, colorIdentity, maintype, power, toughness, faceName;
static const bool isToken = false;
QStringList additionalNames;
QVariantHash properties;
CardInfoPerSet setInfo;
QList<CardRelation *> relatedCards;
@@ -219,6 +218,11 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
for (const QVariant &cardVar : cardsList) {
card = cardVar.toMap();
// skip alternatives
if (getStringPropertyFromMap(card, "isAlternative") == "true") {
continue;
}
/* Currently used layouts are:
* augment, double_faced_token, flip, host, leveler, meld, normal, planar,
* saga, scheme, split, token, transform, vanguard
@@ -233,6 +237,10 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
// normal cards handling
name = getStringPropertyFromMap(card, "name");
text = getStringPropertyFromMap(card, "text");
faceName = getStringPropertyFromMap(card, "faceName");
if (faceName.isEmpty()) {
faceName = name;
}
// card properties
properties.clear();
@@ -258,21 +266,40 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
setInfo.setProperty(xmlPropertyName, propertyValue);
}
// skip alternatives
if (getStringPropertyFromMap(card, "isAlternative") == "true") {
continue;
// Identifiers
QMapIterator<QString, QString> it3(identifierProperties);
while (it3.hasNext()) {
it3.next();
auto mtgjsonProperty = it3.key();
auto xmlPropertyName = it3.value();
auto propertyValue = getStringPropertyFromMap(card.value("identifiers").toMap(), mtgjsonProperty);
if (!propertyValue.isEmpty()) {
setInfo.setProperty(xmlPropertyName, propertyValue);
}
}
QString numComponent{};
if (skipSpecialCards) {
// skip promo cards if it's not the only print
if (allNameProps.contains(name)) {
continue;
QString numProperty = setInfo.getProperty("num");
// skip promo cards if it's not the only print, cards with two faces are different cards
if (allNameProps.contains(faceName)) {
// check for alternative versions
if (layout != "normal")
continue;
// alternative versions have a letter in the end of num like abc
// note this will also catch p and s, those will get removed later anyway
QChar lastChar = numProperty.at(numProperty.size() - 1);
if (!lastChar.isLetter())
continue;
numComponent = " (" + QString(lastChar) + ")";
faceName += numComponent; // add to facename to make it unique
}
if (getStringPropertyFromMap(card, "isPromo") == "true") {
specialPromoCards.insert(name, cardVar);
specialPromoCards.insert(faceName, cardVar);
continue;
}
QString numProperty = setInfo.getProperty("num");
bool skip = false;
// skip cards containing special stuff in the collectors number like promo cards
for (const QString &specialChar : specialNumChars) {
@@ -282,10 +309,10 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
}
}
if (skip) {
specialPromoCards.insert(name, cardVar);
specialPromoCards.insert(faceName, cardVar);
continue;
} else {
allNameProps.append(name);
allNameProps.append(faceName);
}
}
@@ -314,8 +341,6 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
properties.insert("pt", power + ptSeparator + toughness);
}
additionalNames = card.value("names").toStringList();
auto legalities = card.value("legalities").toMap();
for (const QString &fmtName : legalities.keys()) {
properties.insert(QString("format-%1").arg(fmtName), legalities.value(fmtName).toString().toLower());
@@ -323,23 +348,33 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
// split cards are considered a single card, enqueue for later merging
if (layout == "split" || layout == "aftermath" || layout == "adventure") {
// get the position of this card part
int index = additionalNames.indexOf(name);
// construct full card name
name = additionalNames.join(QString(" // "));
SplitCardPart split(index, text, properties, setInfo);
auto faceName = getStringPropertyFromMap(card, "faceName");
SplitCardPart split(faceName, text, properties, setInfo);
splitCards.insert(name, split);
} else {
// relations
relatedCards.clear();
if (additionalNames.size() > 1) {
for (const QString &additionalName : additionalNames) {
if (additionalName != name)
// add other face for split cards as card relation
if (!getStringPropertyFromMap(card, "side").isEmpty()) {
properties["cmc"] = getStringPropertyFromMap(card, "faceConvertedManaCost");
if (layout == "meld") { // meld cards don't work
QRegularExpression meldNameRegex{"then meld them into ([\\.]*)"};
QString additionalName = meldNameRegex.match(text).captured(1);
if (!additionalName.isNull()) {
relatedCards.append(new CardRelation(additionalName, true));
}
} else {
for (const QString &additionalName : name.split(" // ")) {
if (additionalName != faceName) {
relatedCards.append(new CardRelation(additionalName, true));
}
}
}
name = faceName;
}
CardInfoPtr newCard = addCard(name, text, isToken, properties, relatedCards, setInfo);
CardInfoPtr newCard = addCard(name + numComponent, text, isToken, properties, relatedCards, setInfo);
numCards++;
}
}
@@ -350,21 +385,22 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
for (const QString &nameSplit : splitCards.uniqueKeys()) {
// get all parts for this specific card
QList<SplitCardPart> splitCardParts = splitCards.values(nameSplit);
// sort them by index (aka position)
// sort them by face name
std::sort(splitCardParts.begin(), splitCardParts.end(),
[](const SplitCardPart &a, const SplitCardPart &b) -> bool { return a.getIndex() < b.getIndex(); });
[](const SplitCardPart &a, const SplitCardPart &b) -> bool { return a.getName() < b.getName(); });
text = QString("");
properties.clear();
relatedCards.clear();
int lastIndex = -1;
QString lastName{};
for (const SplitCardPart &tmp : splitCardParts) {
// some sets have 2 different variations of the same split card,
// eg. Fire // Ice in WC02. Avoid adding duplicates.
if (lastIndex == tmp.getIndex())
if (lastName == tmp.getName())
continue;
lastIndex = tmp.getIndex();
lastName = tmp.getName();
if (!text.isEmpty())
text.append(splitCardTextSeparator);
@@ -375,7 +411,6 @@ int OracleImporter::importCardsFromSet(CardSetPtr currentSet, const QList<QVaria
setInfo = tmp.getSetInfo();
} else {
const QVariantHash &props = tmp.getProperties();
layout = properties.value("layout").toString();
for (const QString &prop : props.keys()) {
QString originalPropertyValue = properties.value(prop).toString();
QString thisCardPropertyValue = props.value(prop).toString();