/**************************************************************************** ** ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** ** This file is part of the QtDeclarative module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** No Commercial Usage ** This file contains pre-release code and may not be distributed. ** You may use this file in accordance with the terms and conditions ** contained in the Technology Preview License Agreement accompanying ** this package. ** ** 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 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 2.1 requirements ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Nokia gives you certain additional ** rights. These rights are described in the Nokia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. ** ** ** ** ** ** ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qdeclarativexmllistmodel_p.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include QT_BEGIN_NAMESPACE typedef QPair QDeclarativeXmlListRange; /*! \qmlclass XmlRole QDeclarativeXmlListModelRole \since 4.7 \brief The XmlRole element allows you to specify a role for an XmlListModel. */ /*! \qmlproperty string XmlRole::name The name for the role. This name is used to access the model data for this role from Qml. \qml XmlRole { name: "title"; query: "title/string()" } ... Component { id: myDelegate Text { text: title } } \endqml */ /*! \qmlproperty string XmlRole::query The relative XPath query for this role. The query should not start with a '/' (i.e. it must be relative). \qml XmlRole { name: "title"; query: "title/string()" } \endqml */ /*! \qmlproperty bool XmlRole::isKey Defines whether this is a key role. Key roles are used to to determine whether a set of values should be updated or added to the XML list model when XmlListModel::reload() is called. \sa XmlListModel */ class QDeclarativeXmlQuery : public QThread { Q_OBJECT public: QDeclarativeXmlQuery(QObject *parent=0) : QThread(parent), m_quit(false), m_restart(false), m_abort(false), m_queryId(0) { } ~QDeclarativeXmlQuery() { m_mutex.lock(); m_quit = true; m_condition.wakeOne(); m_mutex.unlock(); wait(); } void abort() { QMutexLocker locker(&m_mutex); m_abort = true; } int doQuery(QString query, QString namespaces, QByteArray data, QList *roleObjects) { QMutexLocker locker(&m_mutex); m_size = 0; m_data = data; m_query = QLatin1String("doc($src)") + query; m_namespaces = namespaces; m_roleObjects = roleObjects; if (!isRunning()) { m_abort = false; start(); } else { m_restart = true; m_condition.wakeOne(); } m_queryId++; return m_queryId; } QList > modelData() { QMutexLocker locker(&m_mutex); return m_modelData; } QList insertedItemRanges() { QMutexLocker locker(&m_mutex); return m_insertedItemRanges; } QList removedItemRanges() { QMutexLocker locker(&m_mutex); return m_removedItemRanges; } Q_SIGNALS: void queryCompleted(int queryId, int size); protected: void run() { while (!m_quit) { m_mutex.lock(); int queryId = m_queryId; doQueryJob(); doSubQueryJob(); m_data.clear(); // no longer needed m_mutex.unlock(); m_mutex.lock(); if (!m_abort) emit queryCompleted(queryId, m_size); if (!m_restart) m_condition.wait(&m_mutex); m_abort = false; m_restart = false; m_mutex.unlock(); } } private: void doQueryJob(); void doSubQueryJob(); void getValuesOfKeyRoles(QStringList *values, QXmlQuery *query) const; void addIndexToRangeList(QList *ranges, int index) const; private: QMutex m_mutex; QWaitCondition m_condition; bool m_quit; bool m_restart; bool m_abort; QByteArray m_data; QString m_query; QString m_namespaces; QString m_prefix; int m_size; int m_queryId; const QList *m_roleObjects; QList > m_modelData; QStringList m_keysValues; QList m_insertedItemRanges; QList m_removedItemRanges; }; void QDeclarativeXmlQuery::doQueryJob() { QString r; QXmlQuery query; QBuffer buffer(&m_data); buffer.open(QIODevice::ReadOnly); query.bindVariable(QLatin1String("src"), &buffer); query.setQuery(m_namespaces + m_query); query.evaluateTo(&r); //qDebug() << r; //always need a single root element QByteArray xml = "\n" + r.toUtf8() + ""; QBuffer b(&xml); b.open(QIODevice::ReadOnly); //qDebug() << xml; QString namespaces = QLatin1String("declare namespace dummy=\"http://qtsotware.com/dummy\";\n") + m_namespaces; QString prefix = QLatin1String("doc($inputDocument)/dummy:items") + m_query.mid(m_query.lastIndexOf(QLatin1Char('/'))); //figure out how many items we are dealing with int count = -1; { QXmlResultItems result; QXmlQuery countquery; countquery.bindVariable(QLatin1String("inputDocument"), &b); countquery.setQuery(namespaces + QLatin1String("count(") + prefix + QLatin1Char(')')); countquery.evaluateTo(&result); QXmlItem item(result.next()); if (item.isAtomicValue()) count = item.toAtomicValue().toInt(); } //qDebug() << count; m_prefix = namespaces + prefix + QLatin1Char('/'); m_data = xml; if (count > 0) m_size = count; } void QDeclarativeXmlQuery::getValuesOfKeyRoles(QStringList *values, QXmlQuery *query) const { QStringList keysQueries; for (int i=0; icount(); i++) { if (m_roleObjects->at(i)->isKey()) keysQueries << m_roleObjects->at(i)->query(); } QString keysQuery; if (keysQueries.count() == 1) keysQuery = m_prefix + keysQueries[0]; else if (keysQueries.count() > 1) keysQuery = m_prefix + QLatin1String("concat(") + keysQueries.join(QLatin1String(",")) + QLatin1String(")"); if (!keysQuery.isEmpty()) { query->setQuery(keysQuery); QXmlResultItems resultItems; query->evaluateTo(&resultItems); QXmlItem item(resultItems.next()); while (!item.isNull()) { values->append(item.toAtomicValue().toString()); item = resultItems.next(); } } } void QDeclarativeXmlQuery::addIndexToRangeList(QList *ranges, int index) const { if (ranges->isEmpty()) ranges->append(qMakePair(index, 1)); else if (ranges->last().first + ranges->last().second == index) ranges->last().second += 1; else ranges->append(qMakePair(index, 1)); } void QDeclarativeXmlQuery::doSubQueryJob() { m_modelData.clear(); QBuffer b(&m_data); b.open(QIODevice::ReadOnly); QXmlQuery subquery; subquery.bindVariable(QLatin1String("inputDocument"), &b); QStringList keysValues; getValuesOfKeyRoles(&keysValues, &subquery); // See if any values of key roles have been inserted or removed. m_insertedItemRanges.clear(); m_removedItemRanges.clear(); if (m_keysValues.isEmpty()) { m_insertedItemRanges << qMakePair(0, m_size); } else { if (keysValues != m_keysValues) { QStringList temp; for (int i=0; isize(); ++i) { QDeclarativeXmlListModelRole *role = m_roleObjects->at(i); if (!role->isValid()) { QList resultList; for (int j = 0; j < m_size; ++j) resultList << QVariant(); m_modelData << resultList; continue; } subquery.setQuery(m_prefix + QLatin1String("(let $v := ") + role->query() + QLatin1String(" return if ($v) then ") + role->query() + QLatin1String(" else \"\")")); QXmlResultItems resultItems; subquery.evaluateTo(&resultItems); QXmlItem item(resultItems.next()); QList resultList; while (!item.isNull()) { resultList << item.toAtomicValue(); //### we used to trim strings item = resultItems.next(); } //### should warn here if things have gone wrong. while (resultList.count() < m_size) resultList << QVariant(); m_modelData << resultList; b.seek(0); } //this method is much slower, but works better for incremental loading /*for (int j = 0; j < m_size; ++j) { QList resultList; for (int i = 0; i < m_roleObjects->size(); ++i) { QDeclarativeXmlListModelRole *role = m_roleObjects->at(i); subquery.setQuery(m_prefix.arg(j+1) + role->query()); if (role->isStringList()) { QStringList data; subquery.evaluateTo(&data); resultList << QVariant(data); //qDebug() << data; } else { QString s; subquery.evaluateTo(&s); if (role->isCData()) { //un-escape s.replace(QLatin1String("<"), QLatin1String("<")); s.replace(QLatin1String(">"), QLatin1String(">")); s.replace(QLatin1String("&"), QLatin1String("&")); } resultList << s.trimmed(); //qDebug() << s; } b.seek(0); } m_modelData << resultList; }*/ } class QDeclarativeXmlListModelPrivate : public QObjectPrivate { Q_DECLARE_PUBLIC(QDeclarativeXmlListModel) public: QDeclarativeXmlListModelPrivate() : isComponentComplete(true), size(-1), highestRole(Qt::UserRole) , reply(0), status(QDeclarativeXmlListModel::Null), progress(0.0) , queryId(-1), roleObjects() {} bool isComponentComplete; QUrl src; QString xml; QString query; QString namespaces; int size; QList roles; QStringList roleNames; int highestRole; QNetworkReply *reply; QDeclarativeXmlListModel::Status status; qreal progress; QDeclarativeXmlQuery qmlXmlQuery; int queryId; QList roleObjects; static void append_role(QDeclarativeListProperty *list, QDeclarativeXmlListModelRole *role); static void clear_role(QDeclarativeListProperty *list); static void removeAt_role(QDeclarativeListProperty *list, int i); static void insert_role(QDeclarativeListProperty *list, int i, QDeclarativeXmlListModelRole *role); QList > data; }; void QDeclarativeXmlListModelPrivate::append_role(QDeclarativeListProperty *list, QDeclarativeXmlListModelRole *role) { QDeclarativeXmlListModel *_this = qobject_cast(list->object); if (_this) { int i = _this->d_func()->roleObjects.count(); _this->d_func()->roleObjects.append(role); if (_this->d_func()->roleNames.contains(role->name())) { qmlInfo(role) << QObject::tr("\"%1\" duplicates a previous role name and will be disabled.").arg(role->name()); return; } _this->d_func()->roles.insert(i, _this->d_func()->highestRole); _this->d_func()->roleNames.insert(i, role->name()); ++_this->d_func()->highestRole; } } //### clear needs to invalidate any cached data (in data table) as well // (and the model should emit the appropriate signals) void QDeclarativeXmlListModelPrivate::clear_role(QDeclarativeListProperty *list) { QDeclarativeXmlListModel *_this = static_cast(list->object); _this->d_func()->roles.clear(); _this->d_func()->roleNames.clear(); _this->d_func()->roleObjects.clear(); } /*! \class QDeclarativeXmlListModel \internal */ /*! \qmlclass XmlListModel QDeclarativeXmlListModel \since 4.7 \brief The XmlListModel element is used to specify a model using XPath expressions. XmlListModel is used to create a model from XML data that can be used as a data source for the view classes (such as ListView, PathView, GridView) and other classes that interact with model data (such as Repeater). Here is an example of a model containing news from a Yahoo RSS feed: \qml XmlListModel { id: feedModel source: "http://rss.news.yahoo.com/rss/oceania" query: "/rss/channel/item" XmlRole { name: "title"; query: "title/string()" } XmlRole { name: "pubDate"; query: "pubDate/string()" } XmlRole { name: "description"; query: "description/string()" } } \endqml You can also define certain roles as "keys" so that the model only adds data that contains new values for these keys when reload() is called. For example, if the roles above were defined like this: \qml XmlRole { name: "title"; query: "title/string()"; isKey: true } XmlRole { name: "pubDate"; query: "pubDate/string()"; isKey: true } \endqml Then when reload() is called, the model will only add new items with a "title" and "pubDate" value combination that is not already present in the model. This is useful to provide incremental updates and avoid repainting an entire model in a view. */ QDeclarativeXmlListModel::QDeclarativeXmlListModel(QObject *parent) : QListModelInterface(*(new QDeclarativeXmlListModelPrivate), parent) { Q_D(QDeclarativeXmlListModel); connect(&d->qmlXmlQuery, SIGNAL(queryCompleted(int,int)), this, SLOT(queryCompleted(int,int))); } QDeclarativeXmlListModel::~QDeclarativeXmlListModel() { } /*! \qmlproperty list XmlListModel::roles The roles to make available for this model. */ QDeclarativeListProperty QDeclarativeXmlListModel::roleObjects() { Q_D(QDeclarativeXmlListModel); QDeclarativeListProperty list(this, d->roleObjects); list.append = &QDeclarativeXmlListModelPrivate::append_role; list.clear = &QDeclarativeXmlListModelPrivate::clear_role; return list; } QHash QDeclarativeXmlListModel::data(int index, const QList &roles) const { Q_D(const QDeclarativeXmlListModel); QHash rv; for (int i = 0; i < roles.size(); ++i) { int role = roles.at(i); int roleIndex = d->roles.indexOf(role); rv.insert(role, roleIndex == -1 ? QVariant() : d->data.at(roleIndex).at(index)); } return rv; } QVariant QDeclarativeXmlListModel::data(int index, int role) const { Q_D(const QDeclarativeXmlListModel); int roleIndex = d->roles.indexOf(role); return (roleIndex == -1) ? QVariant() : d->data.at(roleIndex).at(index); } /*! \qmlproperty int XmlListModel::count The number of data entries in the model. */ int QDeclarativeXmlListModel::count() const { Q_D(const QDeclarativeXmlListModel); return d->size; } QList QDeclarativeXmlListModel::roles() const { Q_D(const QDeclarativeXmlListModel); return d->roles; } QString QDeclarativeXmlListModel::toString(int role) const { Q_D(const QDeclarativeXmlListModel); int index = d->roles.indexOf(role); if (index == -1) return QString(); return d->roleNames.at(index); } /*! \qmlproperty url XmlListModel::source The location of the XML data source. If both source and xml are set, xml will be used. */ QUrl QDeclarativeXmlListModel::source() const { Q_D(const QDeclarativeXmlListModel); return d->src; } void QDeclarativeXmlListModel::setSource(const QUrl &src) { Q_D(QDeclarativeXmlListModel); if (d->src != src) { d->src = src; reload(); } } /*! \qmlproperty string XmlListModel::xml This property holds XML text set directly. The text is assumed to be UTF-8 encoded. If both source and xml are set, xml will be used. */ QString QDeclarativeXmlListModel::xml() const { Q_D(const QDeclarativeXmlListModel); return d->xml; } void QDeclarativeXmlListModel::setXml(const QString &xml) { Q_D(QDeclarativeXmlListModel); d->xml = xml; reload(); } /*! \qmlproperty string XmlListModel::query An absolute XPath query representing the base query for the model items. The query should start with '/' or '//'. */ QString QDeclarativeXmlListModel::query() const { Q_D(const QDeclarativeXmlListModel); return d->query; } void QDeclarativeXmlListModel::setQuery(const QString &query) { Q_D(QDeclarativeXmlListModel); if (!query.startsWith(QLatin1Char('/'))) { qmlInfo(this) << QCoreApplication::translate("QDeclarativeXmlRoleList", "An XmlListModel query must start with '/' or \"//\""); return; } if (d->query != query) { d->query = query; reload(); } } /*! \qmlproperty string XmlListModel::namespaceDeclarations A set of declarations for the namespaces used in the query. */ QString QDeclarativeXmlListModel::namespaceDeclarations() const { Q_D(const QDeclarativeXmlListModel); return d->namespaces; } void QDeclarativeXmlListModel::setNamespaceDeclarations(const QString &declarations) { Q_D(QDeclarativeXmlListModel); if (d->namespaces != declarations) { d->namespaces = declarations; reload(); } } /*! \qmlproperty enum XmlListModel::status This property holds the status of data source loading. It can be one of: \list \o Null - no data source has been set \o Ready - the data source has been loaded \o Loading - the data source is currently being loaded \o Error - an error occurred while loading the data source \endlist Note that a change in the status property does not cause anything to happen (although it reflects what has happened to the XmlListModel internally). If you wish to react to the change in status you need to do it yourself, for example in one of the following ways: \list \o Create a state, so that a state change occurs, e.g. State{name: 'loaded'; when: xmlListModel.status = XmlListModel.Ready;} \o Do something inside the onStatusChanged signal handler, e.g. XmlListModel{id: xmlListModel; onStatusChanged: if(xmlListModel.status == XmlListModel.Ready) console.log('Loaded');} \o Bind to the status variable somewhere, e.g. Text{text: if(xmlListModel.status!=XmlListModel.Ready){'Not Loaded';}else{'Loaded';}} \endlist \sa progress */ QDeclarativeXmlListModel::Status QDeclarativeXmlListModel::status() const { Q_D(const QDeclarativeXmlListModel); return d->status; } /*! \qmlproperty real XmlListModel::progress This property holds the progress of data source loading, from 0.0 (nothing loaded) to 1.0 (finished). \sa status */ qreal QDeclarativeXmlListModel::progress() const { Q_D(const QDeclarativeXmlListModel); return d->progress; } void QDeclarativeXmlListModel::classBegin() { Q_D(QDeclarativeXmlListModel); d->isComponentComplete = false; } void QDeclarativeXmlListModel::componentComplete() { Q_D(QDeclarativeXmlListModel); d->isComponentComplete = true; reload(); } /*! \qmlmethod XmlListModel::reload() Reloads the model. If no key roles have been specified, all existing model data is removed, and the model is rebuilt from scratch. Otherwise, items are only added if the model does not already contain items with matching key role values. */ void QDeclarativeXmlListModel::reload() { Q_D(QDeclarativeXmlListModel); if (!d->isComponentComplete) return; d->qmlXmlQuery.abort(); d->queryId = -1; int count = d->size; if (count < 0) d->size = 0; bool hasKeys = false; for (int i=0; iroleObjects.count(); i++) { if (d->roleObjects[i]->isKey()) { hasKeys = true; break; } } if (!hasKeys) { d->data.clear(); d->size = 0; if (count > 0) { emit itemsRemoved(0, count); emit countChanged(); } } if (d->src.isEmpty() && d->xml.isEmpty()) return; if (d->reply) { d->reply->abort(); d->reply->deleteLater(); d->reply = 0; } if (!d->xml.isEmpty()) { d->queryId = d->qmlXmlQuery.doQuery(d->query, d->namespaces, d->xml.toUtf8(), &d->roleObjects); d->progress = 1.0; d->status = Ready; emit progressChanged(d->progress); emit statusChanged(d->status); return; } d->progress = 0.0; d->status = Loading; emit progressChanged(d->progress); emit statusChanged(d->status); QNetworkRequest req(d->src); d->reply = qmlContext(this)->engine()->networkAccessManager()->get(req); QObject::connect(d->reply, SIGNAL(finished()), this, SLOT(requestFinished())); QObject::connect(d->reply, SIGNAL(downloadProgress(qint64,qint64)), this, SLOT(requestProgress(qint64,qint64))); } void QDeclarativeXmlListModel::requestFinished() { Q_D(QDeclarativeXmlListModel); if (d->reply->error() != QNetworkReply::NoError) { disconnect(d->reply, 0, this, 0); d->reply->deleteLater(); d->reply = 0; d->status = Error; } else { d->status = Ready; QByteArray data = d->reply->readAll(); d->queryId = d->qmlXmlQuery.doQuery(d->query, d->namespaces, data, &d->roleObjects); disconnect(d->reply, 0, this, 0); d->reply->deleteLater(); d->reply = 0; } d->progress = 1.0; emit progressChanged(d->progress); emit statusChanged(d->status); } void QDeclarativeXmlListModel::requestProgress(qint64 received, qint64 total) { Q_D(QDeclarativeXmlListModel); if (d->status == Loading && total > 0) { d->progress = qreal(received)/total; emit progressChanged(d->progress); } } void QDeclarativeXmlListModel::queryCompleted(int id, int size) { Q_D(QDeclarativeXmlListModel); if (id != d->queryId) return; bool sizeChanged = size != d->size; d->size = size; d->data = d->qmlXmlQuery.modelData(); QList removed = d->qmlXmlQuery.removedItemRanges(); QList inserted = d->qmlXmlQuery.insertedItemRanges(); for (int i=0; i