KisIptcIO Class Reference

#include <kis_iptc_io.h>

Inheritance diagram for KisIptcIO:

Classes
struct	Private

Public Member Functions
bool	canSaveAllEntries (KisMetaData::Store *store) const override
QString	id () const override
	KisIptcIO ()
bool	loadFrom (KisMetaData::Store *store, QIODevice *ioDevice) const override
QString	name () const override
bool	saveTo (const KisMetaData::Store *store, QIODevice *ioDevice, HeaderType headerType=NoHeader) const override
bool	supportLoading () const override
bool	supportSaving () const override
BackendType	type () const override
	~KisIptcIO () override
Public Member Functions inherited from KisMetaData::IOBackend
virtual	~IOBackend ()

Private Member Functions
void	initMappingsTable () const

Private Attributes
Private *const	d

Additional Inherited Members
Public Types inherited from KisMetaData::IOBackend
enum	BackendType { Binary , Text }
enum	HeaderType { NoHeader , JpegHeader }

Detailed Description

Definition at line 15 of file kis_iptc_io.h.

Constructor & Destructor Documentation

KisIptcIO()

KisIptcIO::KisIptcIO

(

)

Definition at line 66 of file kis_iptc_io.cpp.

    : KisMetaData::IOBackend()
    , d(new Private)
{
}

~KisIptcIO()

KisIptcIO::~KisIptcIO ( )

override

Definition at line 72 of file kis_iptc_io.cpp.

{
    delete d;
}

References d.

Member Function Documentation

canSaveAllEntries()

bool KisIptcIO::canSaveAllEntries ( KisMetaData::Store * store ) const

overridevirtual

Parameters

store

the list of metadata

Returns

true if this backend is capable of saving all the metadata of the store

Implements KisMetaData::IOBackend.

Definition at line 160 of file kis_iptc_io.cpp.

{
    Q_UNUSED(store);
    return false;
}

id()

QString KisIptcIO::id ( ) const

inlineoverridevirtual

Implements KisMetaData::IOBackend.

Definition at line 20 of file kis_iptc_io.h.

    {
        return "iptc";
    }

initMappingsTable()

void KisIptcIO::initMappingsTable ( ) const

private

Definition at line 77 of file kis_iptc_io.cpp.

{
    // For some reason, initializing the tables in the constructor makes the it crash
    if (d->iptcToKMD.size() == 0) {
        for (int i = 0; !mappings[i].exivTag.isEmpty(); i++) {
            dbgKrita << "mapping[i] = " << mappings[i].exivTag << " " << mappings[i].namespaceUri << " "
                     << mappings[i].name;
            d->iptcToKMD[mappings[i].exivTag] = mappings[i];
            d->kmdToIPTC[KisMetaData::SchemaRegistry::instance()
                             ->schemaFromUri(mappings[i].namespaceUri)
                             ->generateQualifiedName(mappings[i].name)] = mappings[i];
        }
    }
}

References d, dbgKrita, IPTCToKMD::exivTag, KisMetaData::Schema::generateQualifiedName(), KisMetaData::SchemaRegistry::instance(), KisIptcIO::Private::iptcToKMD, KisIptcIO::Private::kmdToIPTC, mappings, IPTCToKMD::name, name(), IPTCToKMD::namespaceUri, and KisMetaData::SchemaRegistry::schemaFromUri().

loadFrom()

bool KisIptcIO::loadFrom ( KisMetaData::Store * store, QIODevice * ioDevice ) const

overridevirtual

Parameters

store	the list of metadata to load
ioDevice	the device from where the metadata will be loaded

Returns

true if the load was successful

Implements KisMetaData::IOBackend.

Definition at line 166 of file kis_iptc_io.cpp.

{
    initMappingsTable();
    dbgMetaData << "Loading IPTC Tags";
    ioDevice->open(QIODevice::ReadOnly);
    QByteArray arr = ioDevice->readAll();
    Exiv2::IptcData iptcData;
#if !EXIV2_TEST_VERSION(0, 18, 0)
    iptcData.load((const Exiv2::byte *)arr.data(), arr.size());
#else
    Exiv2::IptcParser::decode(iptcData, (const Exiv2::byte *)arr.data(), arr.size());
#endif
    dbgMetaData << "There are" << iptcData.count() << " entries in the IPTC section";
    for (Exiv2::IptcMetadata::const_iterator it = iptcData.begin(); it != iptcData.end(); ++it) {
        dbgMetaData << "Reading info for key" << it->key().c_str();
        if (d->iptcToKMD.contains(it->key().c_str())) {
            const IPTCToKMD &iptcToKMd = d->iptcToKMD[it->key().c_str()];
            const KisMetaData::Schema *schema =
                KisMetaData::SchemaRegistry::instance()->schemaFromUri(iptcToKMd.namespaceUri);
            KisMetaData::Value value;
            if (iptcToKMd.exivTag == "Iptc.Application2.Keywords") {
                Q_ASSERT(it->getValue()->typeId() == Exiv2::string);
                QString data = it->getValue()->toString().c_str();
 
                QStringList list = data.split(',');
                QList<KisMetaData::Value> values;
                Q_FOREACH (const QString &entry, list) {
                    values.push_back(KisMetaData::Value(entry));
                }
                value = KisMetaData::Value(values, KisMetaData::Value::UnorderedArray);
            } else {
                value = exivValueToKMDValue(it->getValue(), false);
            }
            store->addEntry(KisMetaData::Entry(schema, iptcToKMd.name, value));
        }
    }
    return false;
}

References KisMetaData::Store::addEntry(), d, dbgMetaData, IPTCToKMD::exivTag, exivValueToKMDValue(), initMappingsTable(), KisMetaData::SchemaRegistry::instance(), KisIptcIO::Private::iptcToKMD, IPTCToKMD::name, IPTCToKMD::namespaceUri, KisMetaData::SchemaRegistry::schemaFromUri(), KisMetaData::Value::UnorderedArray, and value().

name()

QString KisIptcIO::name ( ) const

inlineoverridevirtual

Implements KisMetaData::IOBackend.

Definition at line 24 of file kis_iptc_io.h.

    {
        return i18n("Iptc");
    }

saveTo()

bool KisIptcIO::saveTo ( const KisMetaData::Store * store, QIODevice * ioDevice, HeaderType headerType = NoHeader ) const

overridevirtual

Parameters

store	the list of metadata to save
ioDevice	the device to where the metadata will be saved
headerType	determine if an header must be prepend to the binary header, and if it does, which type of header

Returns

true if the save was successful (XXX: actually, all backends always return true...)

Implements KisMetaData::IOBackend.

Definition at line 92 of file kis_iptc_io.cpp.

{
    QStringList blockedEntries = QStringList() << "photoshop:DateCreated";
 
    initMappingsTable();
    ioDevice->open(QIODevice::WriteOnly);
    Exiv2::IptcData iptcData;
    for (const KisMetaData::Entry &entry : *store) {
        if (d->kmdToIPTC.contains(entry.qualifiedName())) {
            if (blockedEntries.contains(entry.qualifiedName())) {
                warnKrita << "skipping" << entry.qualifiedName() << entry.value();
                continue;
            }
            try {
                QString iptcKeyStr = d->kmdToIPTC[entry.qualifiedName()].exivTag;
                Exiv2::IptcKey iptcKey(qPrintable(iptcKeyStr));
                Exiv2::Value *v =
                    kmdValueToExivValue(entry.value(),
                                        Exiv2::IptcDataSets::dataSetType(iptcKey.tag(), iptcKey.record()));
 
                if (v && v->typeId() != Exiv2::invalidTypeId) {
                    iptcData.add(iptcKey, v);
                }
#if EXIV2_TEST_VERSION(0,28,0)
            } catch (Exiv2::Error &e) {
#else
            } catch (Exiv2::AnyError &e) {
#endif
                dbgMetaData << "exiv error " << e.what();
            }
        }
    }
#if !EXIV2_TEST_VERSION(0, 18, 0)
    Exiv2::DataBuf rawData = iptcData.copy();
#else
    Exiv2::DataBuf rawData = Exiv2::IptcParser::encode(iptcData);
#endif
 
    if (headerType == KisMetaData::IOBackend::JpegHeader) {
        QByteArray header;
        header.append(photoshopMarker);
        header.append(QByteArray(1, 0)); // Null terminated string
        header.append(photoshopBimId_);
        header.append(photoshopIptc_);
        header.append(QByteArray(2, 0));
#if EXIV2_TEST_VERSION(0, 28, 0)
        qint32 size = rawData.size();
#else
        qint32 size = rawData.size_;
#endif
        QByteArray sizeArray(4, 0);
        sizeArray[0] = (char)((size & 0xff000000) >> 24);
        sizeArray[1] = (char)((size & 0x00ff0000) >> 16);
        sizeArray[2] = (char)((size & 0x0000ff00) >> 8);
        sizeArray[3] = (char)(size & 0x000000ff);
        header.append(sizeArray);
        ioDevice->write(header);
    }
 
#if EXIV2_TEST_VERSION(0, 28, 0)
    ioDevice->write((const char *)rawData.data(), rawData.size());
#else
    ioDevice->write((const char *)rawData.pData_, rawData.size_);
#endif
    ioDevice->close();
    return true;
}

References d, dbgMetaData, initMappingsTable(), KisMetaData::IOBackend::JpegHeader, KisIptcIO::Private::kmdToIPTC, kmdValueToExivValue(), photoshopBimId_, photoshopIptc_(), photoshopMarker, v, and warnKrita.

supportLoading()

bool KisIptcIO::supportLoading ( ) const

inlineoverridevirtual

Returns

true if this backend support loading

Implements KisMetaData::IOBackend.

Definition at line 38 of file kis_iptc_io.h.

    {
        return true;
    }

supportSaving()

bool KisIptcIO::supportSaving ( ) const

inlineoverridevirtual

Returns

tell if this backend support saving

Implements KisMetaData::IOBackend.

Definition at line 32 of file kis_iptc_io.h.

    {
        return true;
    }

type()

BackendType KisIptcIO::type ( ) const

inlineoverridevirtual

Returns

the type of the backend

Implements KisMetaData::IOBackend.

Definition at line 28 of file kis_iptc_io.h.

    {
        return Binary;
    }

References KisMetaData::IOBackend::Binary.

Member Data Documentation

d

Private* const KisIptcIO::d

private

Definition at line 49 of file kis_iptc_io.h.

---

The documentation for this class was generated from the following files:

• plugins/metadata/iptc/kis_iptc_io.h
• plugins/metadata/iptc/kis_iptc_io.cpp