diff options
Diffstat (limited to 'src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp')
| -rw-r--r-- | src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp | 480 |
1 files changed, 0 insertions, 480 deletions
diff --git a/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp b/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp deleted file mode 100644 index a434654db..000000000 --- a/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp +++ /dev/null @@ -1,480 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Klaralvdalens Datakonsult AB (KDAB) -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the Qt Installer Framework. -** -** $QT_BEGIN_LICENSE:LGPL21$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 or version 3 as published by the Free -** Software Foundation and appearing in the file LICENSE.LGPLv21 and -** LICENSE.LGPLv3 included in the packaging of this file. Please review the -** following information to ensure the GNU Lesser General Public License -** requirements will be met: https://www.gnu.org/licenses/lgpl.html and -** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** As a special exception, The Qt Company gives you certain additional -** rights. These rights are described in The Qt Company LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include "kdupdaterupdatesourcesinfo.h" - -#include <QtXml/QDomElement> -#include <QtXml/QDomDocument> -#include <QtXml/QDomText> -#include <QtXml/QDomCDATASection> -#include <QFileInfo> -#include <QFile> -#include <QTextStream> - -using namespace KDUpdater; - -/*! - \inmodule kdupdater - \class KDUpdater::UpdateSourcesInfo - \brief The UpdateSourcesInfo class provides access to information about the update sources set - for the application. - - An update source is a repository that contains updates applicable for the application. - Applications can download updates from the update source and install them locally. - - Each application can have one or more update sources from which it can download updates. - Information about update source is stored in a file called UpdateSources.xml. This class helps - access and modify the UpdateSources.xml file. - - The complete file name of the UpdateSources.xml file can be specified via the setFileName() - method. The class then parses the XML file and makes available information contained in - that XML file through an easy to use API. You can: - - \list - \li Get update sources information via the updateSourceInfoCount() and updateSourceInfo() - methods. - \li Add or remove update source information via the addUpdateSourceInfo() and - removeUpdateSourceInfo() methods. - \endlist - - The class emits appropriate signals to inform listeners about changes in the update application. -*/ - -/*! - \fn KDUpdater::operator==(const UpdateSourceInfo &lhs, const UpdateSourceInfo &rhs) - - Returns \c true if \a lhs and \a rhs are equal; otherwise returns \c false. -*/ - -/*! - \fn KDUpdater::operator!=(const UpdateSourceInfo &lhs, const UpdateSourceInfo &rhs) - - Returns \c true if \a lhs and \a rhs are different; otherwise returns \c false. -*/ - -/*! - \enum UpdateSourcesInfo::Error - Error codes related to retrieving update sources. - - \value NoError No error occurred. - \value NotYetReadError The update source information was not parsed yet from the - XML file. - \value CouldNotReadSourceFileError The specified update source file could not be read - (does not exist or is not readable). - \value InvalidXmlError The source file contains invalid XML. - \value InvalidContentError The source file contains valid XML, but does not match the - expected format for source descriptions. - \value CouldNotSaveChangesError Changes made to the object could not be saved back to the - source file. -*/ - -/*! - \fn void UpdateSourcesInfo::reset() - - This signal is emitted whenever the contents of this UpdateSourcesInfo are refreshed, usually - from within the refresh() slot. -*/ - -/*! - \fn void UpdateSourcesInfo::updateSourceInfoAdded(const UpdateSourceInfo &info) - - This signal is emitted when \c UpdateSourceInfo \a info is added. -*/ - -/*! - \fn void UpdateSourcesInfo::updateSourceInfoRemoved(const UpdateSourceInfo &info) - - This signal is emitted when \c UpdateSourceInfo \a info is removed. -*/ - -struct UpdateSourceInfoPriorityHigherThan -{ - bool operator()(const UpdateSourceInfo &lhs, const UpdateSourceInfo &rhs) const - { - return lhs.priority > rhs.priority; - } -}; - - -struct UpdateSourcesInfo::UpdateSourcesInfoData -{ - UpdateSourcesInfoData() - : modified(false) - , error(UpdateSourcesInfo::NotYetReadError) - {} - - bool modified; - UpdateSourcesInfo::Error error; - - QString fileName; - QString errorMessage; - QList<UpdateSourceInfo> updateSourceInfoList; - - void addUpdateSourceFrom(const QDomElement &element); - void addChildElement(QDomDocument &doc, QDomElement &parentE, const QString &tagName, - const QString &text, bool htmlText = false); - void setInvalidContentError(const QString &detail); - void clearError(); - void saveChanges(); -}; - -void UpdateSourcesInfo::UpdateSourcesInfoData::setInvalidContentError(const QString &detail) -{ - error = UpdateSourcesInfo::InvalidContentError; - errorMessage = tr("%1 contains invalid content: %2").arg(fileName, detail); -} - -void UpdateSourcesInfo::UpdateSourcesInfoData::clearError() -{ - error = UpdateSourcesInfo::NoError; - errorMessage.clear(); -} - -/*! - \internal -*/ -UpdateSourcesInfo::UpdateSourcesInfo(QObject *parent) - : QObject(parent) - , d(new UpdateSourcesInfo::UpdateSourcesInfoData) -{ -} - -/*! - \internal -*/ -UpdateSourcesInfo::~UpdateSourcesInfo() -{ - d->saveChanges(); -} - -/*! - Returns \c true if UpdateSourcesInfo is valid; otherwise returns \c false. - You can use the errorString() method to receive a descriptive error message. -*/ -bool UpdateSourcesInfo::isValid() const -{ - return d->error == NoError; -} - -/*! - Returns a human-readable description of the last error that occurred. -*/ -QString UpdateSourcesInfo::errorString() const -{ - return d->errorMessage; -} - -/*! - Returns the error that was found during the processing of the update sources XML file. If no - error was found, returns NoError. -*/ -UpdateSourcesInfo::Error UpdateSourcesInfo::error() const -{ - return d->error; -} - -/*! - Returns the modified state of this object. The modified state defines if there where - modifications done to the update-sources that need to be written to the updates XML file - that will restore the update-sources on the next run. -*/ -bool UpdateSourcesInfo::isModified() const -{ - return d->modified; -} - -/*! - Sets the modified state of the object to \a modified. -*/ -void UpdateSourcesInfo::setModified(bool modified) -{ - d->modified = modified; -} - -/*! - Sets the complete file name of the update sources XML file to \a fileName. The function also - issues a call to refresh() to reload update sources from the XML file. - - \sa KDUpdater::Application::setUpdateSourcesXMLFileName() -*/ -void UpdateSourcesInfo::setFileName(const QString &fileName) -{ - if (d->fileName == fileName) - return; - - d->fileName = fileName; - refresh(); // load new file -} - -/*! - Returns the name of the update sources XML file that this class refers to. -*/ -QString UpdateSourcesInfo::fileName() const -{ - return d->fileName; -} - -/*! - Returns the number of update source info structures contained in this class. -*/ -int UpdateSourcesInfo::updateSourceInfoCount() const -{ - return d->updateSourceInfoList.count(); -} - -/*! - Returns the update source info structure at \a index. If an invalid index is passed, the - function returns a \l{default-constructed value}. -*/ -UpdateSourceInfo UpdateSourcesInfo::updateSourceInfo(int index) const -{ - if (index < 0 || index >= d->updateSourceInfoList.count()) - return UpdateSourceInfo(); - - return d->updateSourceInfoList[index]; -} - -/*! - Adds the given update source info \a info to this class. Upon successful addition, the class - emits an updateSourceInfoAdded() signal. -*/ -void UpdateSourcesInfo::addUpdateSourceInfo(const UpdateSourceInfo &info) -{ - if (d->updateSourceInfoList.contains(info)) - return; - d->updateSourceInfoList.push_back(info); - std::sort(d->updateSourceInfoList.begin(), d->updateSourceInfoList.end(), UpdateSourceInfoPriorityHigherThan()); - emit updateSourceInfoAdded(info); - d->modified = true; -} - -/*! - Removes the given update source info \a info from this class. Upon successful removal, the class - emits an updateSourceInfoRemoved() signal. -*/ -void UpdateSourcesInfo::removeUpdateSourceInfo(const UpdateSourceInfo &info) -{ - if (!d->updateSourceInfoList.contains(info)) - return; - d->updateSourceInfoList.removeAll(info); - emit updateSourceInfoRemoved(info); - d->modified = true; -} - -/*! - Reloads the update source information from update sources XML file. -*/ -void UpdateSourcesInfo::refresh() -{ - d->saveChanges(); // save changes done in the previous file - d->updateSourceInfoList.clear(); - - QFile file(d->fileName); - - // if the file does not exist then we just skip the reading - if (!file.exists()) { - d->clearError(); - emit reset(); - return; - } - - // Open the XML file - if (!file.open(QFile::ReadOnly)) { - d->errorMessage = tr("Could not read \"%1\"").arg(d->fileName); - d->error = CouldNotReadSourceFileError; - emit reset(); - return; - } - - QDomDocument doc; - QString parseErrorMessage; - int parseErrorLine, parseErrorColumn; - if (!doc.setContent(&file, &parseErrorMessage, &parseErrorLine, &parseErrorColumn)) { - d->error = InvalidXmlError; - d->errorMessage = tr("XML Parse error in %1 at %2, %3: %4").arg(d->fileName, - QString::number(parseErrorLine), QString::number(parseErrorColumn), parseErrorMessage); - emit reset(); - return; - } - - // Now parse the XML file. - const QDomElement rootE = doc.documentElement(); - if (rootE.tagName() != QLatin1String("UpdateSources")) { - d->setInvalidContentError(tr("Root element %1 unexpected, should be \"UpdateSources\"").arg(rootE.tagName())); - emit reset(); - return; - } - - const QDomNodeList childNodes = rootE.childNodes(); - for (int i = 0; i < childNodes.count(); i++) { - QDomElement childNodeE = childNodes.item(i).toElement(); - if ((!childNodeE.isNull()) && (childNodeE.tagName() == QLatin1String("UpdateSource"))) - d->addUpdateSourceFrom(childNodeE); - } - - d->clearError(); - emit reset(); -} - -void UpdateSourcesInfo::UpdateSourcesInfoData::saveChanges() -{ - if (!modified || fileName.isEmpty()) - return; - - const bool hadSaveError = (error == UpdateSourcesInfo::CouldNotSaveChangesError); - - QDomDocument doc; - QDomElement rootE = doc.createElement(QLatin1String("UpdateSources")); - doc.appendChild(rootE); - - foreach (const UpdateSourceInfo &info, updateSourceInfoList) { - QDomElement infoE = doc.createElement(QLatin1String("UpdateSource")); - rootE.appendChild(infoE); - addChildElement(doc, infoE, QLatin1String("Name"), info.name); - addChildElement(doc, infoE, QLatin1String("Title"), info.title); - addChildElement(doc, infoE, QLatin1String("Description"), info.description, - (info.description.length() && info.description.at(0) == QLatin1Char('<'))); - addChildElement(doc, infoE, QLatin1String("Url"), info.url.toString()); - } - - QFile file(fileName); - if (!file.open(QFile::WriteOnly)) { - error = UpdateSourcesInfo::CouldNotSaveChangesError; - errorMessage = tr("Could not save changes to \"%1\": %2").arg(fileName, file.errorString()); - return; - } - - QTextStream stream(&file); - doc.save(stream, 2); - stream.flush(); - file.close(); - - if (file.error() != QFile::NoError) { - error = UpdateSourcesInfo::CouldNotSaveChangesError; - errorMessage = tr("Could not save changes to \"%1\": %2").arg(fileName, file.errorString()); - return; - } - - //if there was a write error before, clear the error, as the write was successful now - if (hadSaveError) - clearError(); - - modified = false; -} - -void UpdateSourcesInfo::UpdateSourcesInfoData::addUpdateSourceFrom(const QDomElement &element) -{ - if (element.tagName() != QLatin1String("UpdateSource")) - return; - - const QDomNodeList childNodes = element.childNodes(); - if (!childNodes.count()) - return; - - UpdateSourceInfo info; - for (int i = 0; i < childNodes.count(); ++i) { - const QDomElement childNodeE = childNodes.item(i).toElement(); - if (childNodeE.isNull()) - continue; - - if (childNodeE.tagName() == QLatin1String("Name")) - info.name = childNodeE.text(); - else if (childNodeE.tagName() == QLatin1String("Title")) - info.title = childNodeE.text(); - else if (childNodeE.tagName() == QLatin1String("Description")) - info.description = childNodeE.text(); - else if (childNodeE.tagName() == QLatin1String("Url")) - info.url = childNodeE.text(); - } - this->updateSourceInfoList.append(info); -} - -void UpdateSourcesInfo::UpdateSourcesInfoData::addChildElement(QDomDocument &doc, QDomElement &parentE, - const QString &tagName, const QString &text, bool htmlText) -{ - QDomElement childE = doc.createElement(tagName); - parentE.appendChild(childE); - childE.appendChild(htmlText ? doc.createCDATASection(text) : doc.createTextNode(text)); -} - -/*! - \inmodule kdupdater - \class KDUpdater::UpdateSourceInfo - \brief The UpdateSourceInfo class specifies a single update source. - - An update source is a repository that contains updates applicable for the application. - This structure describes a single update source in terms of name, title, description, - url, and priority. -*/ - -/*! - \fn UpdateSourceInfo::UpdateSourceInfo() - - Constructs an empty update source info object. The object's priority is set to -1. All other - class members are initialized using a \l{default-constructed value}. -*/ - -/*! - \variable UpdateSourceInfo::name - \brief The name of the update source. -*/ - -/*! - \variable UpdateSourceInfo::title - \brief The title of the update source. -*/ - -/*! - \variable UpdateSourceInfo::description - \brief The description of the update source. -*/ - -/*! - \variable UpdateSourceInfo::url - \brief The URL of the update source. -*/ - -/*! - \variable UpdateSourceInfo::priority - \brief The priority of the update source. -*/ - -namespace KDUpdater { - -bool operator== (const UpdateSourceInfo &lhs, const UpdateSourceInfo &rhs) -{ - return lhs.name == rhs.name && lhs.title == rhs.title && lhs.description == rhs.description - && lhs.url == rhs.url; -} - -} // namespace KDUpdater |