/* * Copyright 2006-2007 Aaron Seigo * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Library General Public License as * published by the Free Software Foundation; either version 2, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details * * You should have received a copy of the GNU Library General Public * License along with this program; if not, write to the * Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #include "datacontainer.h" #include "private/datacontainer_p.h" #include "private/storage_p.h" #include #include "plasma.h" namespace Plasma { DataContainer::DataContainer(QObject *parent) : QObject(parent), d(new DataContainerPrivate) { } DataContainer::~DataContainer() { delete d; } const DataEngine::Data DataContainer::data() const { return d->data; } void DataContainer::setData(const QString &key, const QVariant &value) { if (!value.isValid()) { d->data.remove(key); } else { d->data.insert(key, value); } d->dirty = true; d->updateTs.start(); //check if storage is enabled and if storage is needed. //If it is not set to be stored,then this is the first //setData() since the last time it was stored. This //gives us only one singleShot timer. if (isStorageEnabled() && !needsToBeStored()) { QTimer::singleShot(180000, this, SLOT(store())); } setNeedsToBeStored(true); } void DataContainer::removeAllData() { if (d->data.isEmpty()) { // avoid an update if we don't have any data anyways return; } d->data.clear(); d->dirty = true; d->updateTs.start(); } bool DataContainer::visualizationIsConnected(QObject *visualization) const { return d->relayObjects.contains(visualization); } void DataContainer::connectVisualization(QObject *visualization, uint pollingInterval, Plasma::IntervalAlignment alignment) { //kDebug() << "connecting visualization" << visualization << "at interval of" // << pollingInterval << "to" << objectName(); QMap::iterator objIt = d->relayObjects.find(visualization); bool connected = objIt != d->relayObjects.end(); if (connected) { // this visualization is already connected. just adjust the update // frequency if necessary SignalRelay *relay = objIt.value(); if (relay) { // connected to a relay //kDebug() << " already connected, but to a relay"; if (relay->m_interval == pollingInterval) { //kDebug() << " already connected to a relay of the same interval of" // << pollingInterval << ", nothing to do"; return; } if (relay->receiverCount() == 1) { //kDebug() << " removing relay, as it is now unused"; d->relays.remove(relay->m_interval); delete relay; } else { disconnect(relay, SIGNAL(dataUpdated(QString,Plasma::DataEngine::Data)), visualization, SLOT(dataUpdated(QString,Plasma::DataEngine::Data))); //relay->isUnused(); } } else if (pollingInterval < 1) { // the visualization was connected already, but not to a relay // and it still doesn't want to connect to a relay, so we have // nothing to do! //kDebug() << " already connected, nothing to do"; return; } else { disconnect(this, SIGNAL(dataUpdated(QString,Plasma::DataEngine::Data)), visualization, SLOT(dataUpdated(QString,Plasma::DataEngine::Data))); } } else { connect(visualization, SIGNAL(destroyed(QObject*)), this, SLOT(disconnectVisualization(QObject*)));//, Qt::QueuedConnection); } if (pollingInterval < 1) { //kDebug() << " connecting directly"; d->relayObjects[visualization] = 0; connect(this, SIGNAL(dataUpdated(QString,Plasma::DataEngine::Data)), visualization, SLOT(dataUpdated(QString,Plasma::DataEngine::Data))); } else { //kDebug() << " connecting to a relay"; // we only want to do an imediate update if this is not the first object to connect to us // if it is the first visualization, then the source will already have been populated // engine's sourceRequested method bool immediateUpdate = connected || d->relayObjects.count() > 1; SignalRelay *relay = d->signalRelay(this, visualization, pollingInterval, alignment, immediateUpdate); connect(relay, SIGNAL(dataUpdated(QString,Plasma::DataEngine::Data)), visualization, SLOT(dataUpdated(QString,Plasma::DataEngine::Data))); } } void DataContainer::setStorageEnable(bool store) { QTime time = QTime::currentTime(); qsrand((uint)time.msec()); d->enableStorage = store; if (store) { QTimer::singleShot(qrand() % (2000 + 1) , this, SLOT(retrieve())); } } bool DataContainer::isStorageEnabled() const { return d->enableStorage; } bool DataContainer::needsToBeStored() const { return !d->isStored; } void DataContainer::setNeedsToBeStored(bool store) { d->isStored = !store; } DataEngine* DataContainer::getDataEngine() { QObject *o = NULL; DataEngine *de = NULL; o = this; while (de == NULL) { o = dynamic_cast (o->parent()); if (o == NULL) { return NULL; } de = dynamic_cast (o); } return de; } void DataContainer::store() { if (!needsToBeStored()){ return; } DataEngine* de = getDataEngine(); if (de == NULL) { return; } setNeedsToBeStored(false); Storage* store = new Storage(de->name(), 0); KConfigGroup op = store->operationDescription("save"); op.writeEntry("source", objectName()); DataEngine::Data dataToStore = data(); DataEngine::Data::const_iterator it = dataToStore.constBegin(); while (it != dataToStore.constEnd() && dataToStore.constEnd() == data().constEnd()) { QVariant v = it.value(); if ((it.value().type() == QVariant::String) || (it.value().type() == QVariant::Int)) { op.writeEntry("key", it.key()); op.writeEntry("data", it.value()); } else { QByteArray b; QDataStream ds(&b, QIODevice::WriteOnly); ds << it.value(); op.writeEntry("key", "base64-" + it.key()); op.writeEntry("data", b.toBase64()); } ++it; ServiceJob* job = store->startOperationCall(op); job->start(); } //FIXME: this may result in the service being deleted before the jobs ... resulting in the //jobs potentially being terminated prematurely store->deleteLater(); } void DataContainer::retrieve() { DataEngine* de = getDataEngine(); if (de == NULL) { return; } Storage* store = new Storage(de->name(), 0); KConfigGroup retrieveGroup = store->operationDescription("retrieve"); retrieveGroup.writeEntry("source", objectName()); ServiceJob* retrieveJob = store->startOperationCall(retrieveGroup); connect(retrieveJob, SIGNAL(result(KJob*)), this, SLOT(populateFromStoredData(KJob*))); } void DataContainer::populateFromStoredData(KJob *job) { if (job->error()) { return; } DataEngine::Data dataToInsert; ServiceJob* ret = dynamic_cast(job); QHash h = ret->result().toHash(); foreach (QString key, h.keys()) { if (key.startsWith("base64-")) { QByteArray b = QByteArray::fromBase64(h[key].toString().toAscii()); QDataStream ds(&b, QIODevice::ReadOnly); QVariant v(ds); key.remove(0, 7); dataToInsert.insert(key, v); } else { dataToInsert.insert(key, h[key]); } } if (!(d->data.isEmpty())) { //Do not fill the source with old stored //data if it is already populated with new data. return; } d->data = dataToInsert; d->dirty = true; checkForUpdate(); } void DataContainer::disconnectVisualization(QObject *visualization) { QMap::iterator objIt = d->relayObjects.find(visualization); disconnect(visualization, SIGNAL(destroyed(QObject*)), this, SLOT(disconnectVisualization(QObject*)));//, Qt::QueuedConnection); if (objIt == d->relayObjects.end() || !objIt.value()) { // it is connected directly to the DataContainer itself disconnect(this, SIGNAL(dataUpdated(QString,Plasma::DataEngine::Data)), visualization, SLOT(dataUpdated(QString,Plasma::DataEngine::Data))); } else { SignalRelay *relay = objIt.value(); if (relay->receiverCount() == 1) { d->relays.remove(relay->m_interval); delete relay; } else { disconnect(relay, SIGNAL(dataUpdated(QString,Plasma::DataEngine::Data)), visualization, SLOT(dataUpdated(QString,Plasma::DataEngine::Data))); } } d->relayObjects.erase(objIt); checkUsage(); } void DataContainer::checkForUpdate() { //kDebug() << objectName() << d->dirty; if (d->dirty) { emit dataUpdated(objectName(), d->data); foreach (SignalRelay *relay, d->relays) { relay->checkQueueing(); } d->dirty = false; } } void DataContainer::forceImmediateUpdate() { if (d->dirty) { d->dirty = false; emit dataUpdated(objectName(), d->data); } foreach (SignalRelay *relay, d->relays) { relay->forceImmediateUpdate(); } } uint DataContainer::timeSinceLastUpdate() const { //FIXME: we still assume it's been <24h //and ignore possible daylight savings changes return d->updateTs.elapsed(); } void DataContainer::setNeedsUpdate(bool update) { d->cached = update; } void DataContainer::checkUsage() { if (d->relays.count() < 1 && receivers(SIGNAL(dataUpdated(QString, Plasma::DataEngine::Data))) < 1) { // DO NOT CALL ANYTHING AFTER THIS LINE AS IT MAY GET DELETED! emit becameUnused(objectName()); } } } // Plasma namespace #include "datacontainer.moc"