KoResourceBundleManifest Class Reference

#include <KoResourceBundleManifest.h>

Classes
struct	ResourceReference

Public Member Functions
void	addResource (const QString &fileType, const QString &fileName, const QStringList &tagFileList, const QString &md5, const int resourceId=-1, const QString filenameInBundle="")
	addTag : Add a file tag as a child of the fileType tag.
QList< ResourceReference >	files (const QString &type=QString()) const
	KoResourceBundleManifest ()
	ResourceBundleManifest : Ctor.
bool	load (QIODevice *device)
	load the ResourceBundleManifest from the given device
void	removeFile (QString fileName)
	removeFile : remove a file from the manifest
void	removeResource (ResourceReference &resource)
bool	save (QIODevice *device)
	save the ResourceBundleManifest to the given device
QStringList	tags () const
QStringList	types () const
virtual	~KoResourceBundleManifest ()
	~ResourceBundleManifest : Dtor

Private Member Functions
bool	parseFileEntry (const QDomElement &e)

Private Attributes
QMap< QString, QMap< QString, ResourceReference > >	m_resources

Detailed Description

Definition at line 19 of file KoResourceBundleManifest.h.

Constructor & Destructor Documentation

KoResourceBundleManifest()

KoResourceBundleManifest::KoResourceBundleManifest

(

)

ResourceBundleManifest : Ctor.

Parameters

xmlName

the name of the XML file to be created

Definition at line 45 of file KoResourceBundleManifest.cpp.

{
}

~KoResourceBundleManifest()

KoResourceBundleManifest::~KoResourceBundleManifest ( )

virtual

~ResourceBundleManifest : Dtor

Definition at line 49 of file KoResourceBundleManifest.cpp.

{
}

Member Function Documentation

addResource()

void KoResourceBundleManifest::addResource	(	const QString &	fileType,
		const QString &	fileName,
		const QStringList &	tagFileList,
		const QString &	md5,
		const int	resourceId = -1,
		const QString	filenameInBundle = "" )

addTag : Add a file tag as a child of the fileType tag.

Parameters

fileType	the type of the file to be added
fileName	the name of the file to be added
emptyFile	true if the file is empty

Returns

the element corresponding to the created tag.

Definition at line 171 of file KoResourceBundleManifest.cpp.

{
    ResourceReference ref(fileName, fileTagList, fileTypeName, md5, resourceId, filenameInBundle);
    if (!m_resources.contains(fileTypeName)) {
        m_resources[fileTypeName] = QMap<QString, ResourceReference>();
    }
    m_resources[fileTypeName].insert(fileName, ref);
}

References m_resources.

files()

QList< KoResourceBundleManifest::ResourceReference > KoResourceBundleManifest::files

(

const QString &

type = QString()

)

const

Definition at line 205 of file KoResourceBundleManifest.cpp.

{
    QList<ResourceReference> resources;
 
    if (type.isEmpty()) {
        // If no type is specified we return all the resources.
        Q_FOREACH (const QString &type, m_resources.keys()) {
            resources += m_resources[type].values();
        }
    } else if (m_resources.contains(type)) {
        resources = m_resources[type].values();
    }
 
    return resources;
}

References m_resources.

load()

bool KoResourceBundleManifest::load

(

QIODevice *

device

)

load the ResourceBundleManifest from the given device

Definition at line 53 of file KoResourceBundleManifest.cpp.

{
    m_resources.clear();
    if (!device->isOpen()) {
        if (!device->open(QIODevice::ReadOnly)) {
            return false;
        }
    }
 
    QDomDocument manifestDocument;
#if QT_VERSION < QT_VERSION_CHECK(6, 5, 0)
    QString errorMessage;
    int errorLine;
    int errorColumn;
    if (!manifestDocument.setContent(device, true, &errorMessage, &errorLine, &errorColumn)) {
        warnKrita << "Error parsing manifest" << errorMessage
                  << "line" << errorLine
                  << "column" << errorColumn;
#else
    QDomDocument::ParseResult result = manifestDocument.setContent(device, QDomDocument::ParseOption::UseNamespaceProcessing);
    if (!result) {
        warnKrita << "Error parsing manifest" << result.errorMessage
                  << "line" << result.errorLine
                  << "column" << result.errorColumn;
#endif
        return false;
    }
 
    QDomElement root = manifestDocument.documentElement();
    if (root.localName() != "manifest" || root.namespaceURI() != KoXmlNS::manifest) {
        return false;
    }
 
    QDomElement e = root.firstChildElement("file-entry");
    for (; !e.isNull(); e = e.nextSiblingElement("file-entry")) {
        if (!parseFileEntry(e)) {
            warnKrita << "Skipping invalid manifest entry"
                      << "line" << e.lineNumber();
        }
    }
 
    return true;
}

References m_resources, KoXmlNS::manifest, parseFileEntry(), and warnKrita.

parseFileEntry()

bool KoResourceBundleManifest::parseFileEntry ( const QDomElement & e )

private

Definition at line 97 of file KoResourceBundleManifest.cpp.

{
    if (e.localName() != "file-entry" || e.namespaceURI() != KoXmlNS::manifest) {
        return false;
    }
 
    QString fullPath  = e.attributeNS(KoXmlNS::manifest, "full-path");
    QString mediaType = e.attributeNS(KoXmlNS::manifest, "media-type");
    QString md5sum    = e.attributeNS(KoXmlNS::manifest, "md5sum");
    QString version   = e.attributeNS(KoXmlNS::manifest, "version");
 
    if (fullPath == "/" && mediaType == "application/x-krita-resourcebundle") {
        // The manifest always contains an entry for the bundle root.
        // This is not a resource, so skip it without indicating failure.
        return true;
    } else if (fullPath.isNull() || mediaType.isNull() || md5sum.isNull()) {
        return false;
    }
 
    QStringList tagList;
    QDomElement t = e.firstChildElement("tags")
                     .firstChildElement("tag");
    for (; !t.isNull(); t = t.nextSiblingElement("tag")) {
        QString tag = t.text();
        if (!tag.isNull()) {
            tagList.append(tag);
        }
    }
 
    addResource(mediaType, fullPath, tagList, QByteArray::fromHex(md5sum.toLatin1()), -1);
    return true;
}

References addResource(), and KoXmlNS::manifest.

removeFile()

void KoResourceBundleManifest::removeFile

(

QString

fileName

)

removeFile : remove a file from the manifest

Parameters

fileName

: the name of the file to be removed

Returns

the list of resource tags to be removed from meta file.

Definition at line 221 of file KoResourceBundleManifest.cpp.

{
    QList<QString> tags;
    Q_FOREACH (const QString &type, m_resources.keys()) {
        if (m_resources[type].contains(fileName)) {
            m_resources[type].remove(fileName);
        }
    }
}

References m_resources, and tags().

removeResource()

void KoResourceBundleManifest::removeResource

(

KoResourceBundleManifest::ResourceReference &

resource

)

Definition at line 180 of file KoResourceBundleManifest.cpp.

{
    if (m_resources.contains(resource.fileTypeName)) {
        if (m_resources[resource.fileTypeName].contains(resource.resourcePath)) {
            m_resources[resource.fileTypeName].take(resource.resourcePath);
        }
    }
}

References KoResourceBundleManifest::ResourceReference::fileTypeName, m_resources, and KoResourceBundleManifest::ResourceReference::resourcePath.

save()

bool KoResourceBundleManifest::save

(

QIODevice *

device

)

save the ResourceBundleManifest to the given device

Definition at line 130 of file KoResourceBundleManifest.cpp.

{
       if (!device->isOpen()) {
           if (!device->open(QIODevice::WriteOnly)) {
               return false;
           }
       }
       KoXmlWriter manifestWriter(device);
       manifestWriter.startDocument("manifest:manifest");
       manifestWriter.startElement("manifest:manifest");
       manifestWriter.addAttribute("xmlns:manifest", KoXmlNS::manifest);
       manifestWriter.addAttribute("manifest:version", "1.2");
       manifestWriter.addManifestEntry("/", "application/x-krita-resourcebundle");
 
       Q_FOREACH (QString resourceType, m_resources.keys()) {
           Q_FOREACH (const ResourceReference &resource, m_resources[resourceType].values()) {
               manifestWriter.startElement("manifest:file-entry");
               manifestWriter.addAttribute("manifest:media-type", resourceTypeToManifestType(resourceType));
               // we cannot just use QFileInfo(resource.resourcePath).fileName() because it would cut off the subfolder
               // but the resourcePath is already correct, so let's just add the resourceType
               manifestWriter.addAttribute("manifest:full-path", resourceTypeToManifestType(resourceType) + "/" + resource.filenameInBundle);
               manifestWriter.addAttribute("manifest:md5sum", resource.md5sum);
               if (!resource.tagList.isEmpty()) {
                   manifestWriter.startElement("manifest:tags");
                   Q_FOREACH (const QString tag, resource.tagList) {
                       manifestWriter.startElement("manifest:tag");
                       manifestWriter.addTextNode(tag);
                       manifestWriter.endElement();
                   }
                   manifestWriter.endElement();
               }
               manifestWriter.endElement();
           }
       }
 
       manifestWriter.endElement();
       manifestWriter.endDocument();
 
       return true;
}

References KoXmlWriter::addAttribute(), KoXmlWriter::addManifestEntry(), KoXmlWriter::addTextNode(), KoXmlWriter::endDocument(), KoXmlWriter::endElement(), KoResourceBundleManifest::ResourceReference::filenameInBundle, m_resources, KoXmlNS::manifest, KoResourceBundleManifest::ResourceReference::md5sum, resourceTypeToManifestType(), KoXmlWriter::startDocument(), KoXmlWriter::startElement(), and KoResourceBundleManifest::ResourceReference::tagList.

tags()

QStringList KoResourceBundleManifest::tags

(

)

const

Definition at line 194 of file KoResourceBundleManifest.cpp.

{
    QSet<QString> tags;
    Q_FOREACH (const QString &type, m_resources.keys()) {
        Q_FOREACH (const ResourceReference &ref, m_resources[type].values()) {
            tags += QSet<QString>(ref.tagList.begin(), ref.tagList.end());
        }
    }
    return QStringList(tags.begin(), tags.end());
 }

References m_resources, KoResourceBundleManifest::ResourceReference::tagList, and tags().

types()

QStringList KoResourceBundleManifest::types

(

)

const

Definition at line 189 of file KoResourceBundleManifest.cpp.

{
    return m_resources.keys();
}

References m_resources.

Member Data Documentation

m_resources

QMap<QString, QMap<QString, ResourceReference> > KoResourceBundleManifest::m_resources

private

Definition at line 93 of file KoResourceBundleManifest.h.

---

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

• libs/resources/KoResourceBundleManifest.h
• libs/resources/KoResourceBundleManifest.cpp