Update vCard cache on 'Show Profile' if cached vCard is older than 5 minutes.

Store last write time in memory in VCardStorage. VCardManager::getVCardAndRequestWhenNeeded will check an optional parameter and the last write time to determine if the cached vCard is fresh enough. Test-Information: ALl unit tests still run fine and tested that it fetches the vCard again when you open the 'Show Profile' dialog after 5 minutes. Change-Id: I27d7f931188a43aa090348014bcdbdf6d534c5a0
author: Tobias Markmann <tm@ayena.de> 2014-10-03 13:48:37 (GMT)
committer: Swift Review <review@swift.im> 2014-10-08 07:37:33 (GMT)
commit: 3e40b302af0e2abde3c002c7f25ec5276f68f230 (patch)
tree: cb73311e851d00364d22de1da978e45553b43912
parent: b67aba2e28e5fd716c18bef9c2826b482ef832ad (diff)
download: swift-contrib-3e40b302af0e2abde3c002c7f25ec5276f68f230.zip
swift-contrib-3e40b302af0e2abde3c002c7f25ec5276f68f230.tar.bz2
7 files changed, 50 insertions, 10 deletions
diff --git a/Swift/Controllers/ShowProfileController.cpp b/Swift/Controllers/ShowProfileController.cpp
index 15b7b26..d13e5a1 100644
--- a/Swift/Controllers/ShowProfileController.cpp
+++ b/Swift/Controllers/ShowProfileController.cpp
@@ -1,18 +1,25 @@
 /*
  * Copyright (c) 2012 Tobias Markmann
  * Licensed under the simplified BSD license.
  * See Documentation/Licenses/BSD-simplified.txt for more information.
  */
 
+/*
+ * Copyright (c) 2014 Kevin Smith and Remko Tronçon
+ * Licensed under the GNU General Public License v3.
+ * See Documentation/Licenses/GPLv3.txt for more information.
+ */
+
 #include "ShowProfileController.h"
 
 #include <boost/bind.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 
 #include <Swiften/Base/foreach.h>
 #include <Swiften/VCards/VCardManager.h>
 
 #include <Swift/Controllers/UIEvents/ShowProfileForRosterItemUIEvent.h>
 #include <Swift/Controllers/UIEvents/UIEventStream.h>
 #include <Swift/Controllers/UIInterfaces/ProfileWindowFactory.h>
 
 namespace Swift {
@@ -38,19 +45,19 @@ void ShowProfileController::handleUIEvent(UIEvent::ref event) {
 	if (!showProfileEvent) {
 		return;
 	}
 
 	if (openedProfileWindows.find(showProfileEvent->getJID()) == openedProfileWindows.end()) {
 		ProfileWindow* newProfileWindow = profileWindowFactory->createProfileWindow();
 		newProfileWindow->setJID(showProfileEvent->getJID());
 		newProfileWindow->onWindowAboutToBeClosed.connect(boost::bind(&ShowProfileController::handleProfileWindowAboutToBeClosed, this, _1));
 		openedProfileWindows[showProfileEvent->getJID()] = newProfileWindow;
-		VCard::ref vcard = vcardManager->getVCardAndRequestWhenNeeded(showProfileEvent->getJID());
+		VCard::ref vcard = vcardManager->getVCardAndRequestWhenNeeded(showProfileEvent->getJID(), boost::posix_time::minutes(5));
 		if (vcard) {
 			newProfileWindow->setVCard(vcard);
 		} else {
 			newProfileWindow->setProcessing(true);
 		}
 		newProfileWindow->show();
 	} else {
 		openedProfileWindows[showProfileEvent->getJID()]->show();
 	}
diff --git a/Swift/Controllers/Storages/VCardFileStorage.cpp b/Swift/Controllers/Storages/VCardFileStorage.cpp
index b22e235..876d642 100644
--- a/Swift/Controllers/Storages/VCardFileStorage.cpp
+++ b/Swift/Controllers/Storages/VCardFileStorage.cpp
@@ -1,11 +1,11 @@
 /*
- * Copyright (c) 2010 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
  */
 
 #include "Swift/Controllers/Storages/VCardFileStorage.h"
 
 #include <boost/filesystem/fstream.hpp>
 #include <boost/filesystem.hpp>
 #include <iostream>
@@ -52,19 +52,29 @@ VCardFileStorage::VCardFileStorage(boost::filesystem::path dir, CryptoProvider*
 	}
 }
 
 boost::shared_ptr<VCard> VCardFileStorage::getVCard(const JID& jid) const {
 	boost::shared_ptr<VCard> result = VCardPersister().loadPayloadGeneric(getVCardPath(jid));
 	getAndUpdatePhotoHash(jid, result);
 	return result;
 }
 
+boost::posix_time::ptime VCardFileStorage::getVCardWriteTime(const JID& jid) const {
+	if (vcardWriteTimes.find(jid) == vcardWriteTimes.end()) {
+		return boost::posix_time::ptime();
+	}
+	else {
+		return vcardWriteTimes.at(jid);
+	}
+}
+
 void VCardFileStorage::setVCard(const JID& jid, VCard::ref v) {
+	vcardWriteTimes[jid] = boost::posix_time::second_clock::universal_time();
 	VCardPersister().savePayload(v, getVCardPath(jid));
 	getAndUpdatePhotoHash(jid, v);
 }
 
 boost::filesystem::path VCardFileStorage::getVCardPath(const JID& jid) const {
 	try {
 		std::string file(jid.toString());
 		String::replaceAll(file, '/', "%2f");
 		return boost::filesystem::path(vcardsPath / stringToPath(file + ".xml"));
diff --git a/Swift/Controllers/Storages/VCardFileStorage.h b/Swift/Controllers/Storages/VCardFileStorage.h
index 2c3af3d..8ba001e 100644
--- a/Swift/Controllers/Storages/VCardFileStorage.h
+++ b/Swift/Controllers/Storages/VCardFileStorage.h
@@ -1,11 +1,11 @@
 /*
- * Copyright (c) 2010-2013 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
  */
 
 #pragma once
 
 #include <boost/shared_ptr.hpp>
 #include <boost/filesystem/path.hpp>
 #include <string>
@@ -15,27 +15,29 @@
 
 namespace Swift {
 	class CryptoProvider;
 
 	class VCardFileStorage : public VCardStorage {
 		public:
 			VCardFileStorage(boost::filesystem::path dir, CryptoProvider* crypto);
 
 			virtual VCard::ref getVCard(const JID& jid) const;
+			virtual boost::posix_time::ptime getVCardWriteTime(const JID& jid) const;
 			virtual void setVCard(const JID& jid, VCard::ref v);
 
 			virtual std::string getPhotoHash(const JID&) const;
 
 		private:
 			boost::filesystem::path getVCardPath(const JID&) const;
 
 			std::string getAndUpdatePhotoHash(const JID& jid, VCard::ref vcard) const;
 			void savePhotoHashes() const;
 
 		private:
 			boost::filesystem::path vcardsPath;
 			CryptoProvider* crypto;
 			boost::filesystem::path cacheFile;
 			typedef std::map<JID, std::string> PhotoHashMap;
 			mutable PhotoHashMap photoHashes;
+			std::map<JID, boost::posix_time::ptime> vcardWriteTimes;
 	};
 }
diff --git a/Swiften/VCards/VCardManager.cpp b/Swiften/VCards/VCardManager.cpp
index 52447a1..5a65dcd 100644
--- a/Swiften/VCards/VCardManager.cpp
+++ b/Swiften/VCards/VCardManager.cpp
@@ -1,39 +1,42 @@
 /*
- * Copyright (c) 2010 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
  */
 
 #include <Swiften/VCards/VCardManager.h>
 
 #include <boost/bind.hpp>
 
+#include <Swiften/Base/Log.h>
 #include <Swiften/JID/JID.h>
 #include <Swiften/VCards/VCardStorage.h>
 #include <Swiften/VCards/GetVCardRequest.h>
 
 
 namespace Swift {
 
 VCardManager::VCardManager(const JID& ownJID, IQRouter* iqRouter, VCardStorage* vcardStorage) : ownJID(ownJID), iqRouter(iqRouter), storage(vcardStorage) {
 }
 
 VCardManager::~VCardManager() {
 }
 
 VCard::ref VCardManager::getVCard(const JID& jid) const {
 	return storage->getVCard(jid);
 }
 
-VCard::ref VCardManager::getVCardAndRequestWhenNeeded(const JID& jid) {
+VCard::ref VCardManager::getVCardAndRequestWhenNeeded(const JID& jid, const boost::posix_time::time_duration& allowedAge) {
 	VCard::ref vcard = storage->getVCard(jid);
-	if (!vcard) {
+	boost::posix_time::ptime vcardFetchedTime = storage->getVCardWriteTime(jid);
+	bool vcardTooOld = vcard && (vcardFetchedTime.is_special() || ((boost::posix_time::second_clock::universal_time() - vcardFetchedTime) > allowedAge));
+	if (!vcard || vcardTooOld) {
 		requestVCard(jid);
 	}
 	return vcard;
 }
 
 void VCardManager::requestVCard(const JID& requestedJID) {
 	JID jid = requestedJID.equals(ownJID, JID::WithoutResource) ? JID() : requestedJID;
 	if (requestedVCards.find(jid) != requestedVCards.end()) {
 		return;
diff --git a/Swiften/VCards/VCardManager.h b/Swiften/VCards/VCardManager.h
index b7e3c32..78e0f3e 100644
--- a/Swiften/VCards/VCardManager.h
+++ b/Swiften/VCards/VCardManager.h
@@ -1,38 +1,40 @@
 /*
- * Copyright (c) 2010 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
  */
 
 #pragma once
 
 #include <set>
 
+#include <boost/date_time/posix_time/posix_time.hpp>
+
 #include <Swiften/Base/API.h>
 #include <Swiften/JID/JID.h>
 #include <Swiften/Elements/VCard.h>
 #include <Swiften/Elements/ErrorPayload.h>
 #include <Swiften/VCards/SetVCardRequest.h>
 #include <Swiften/Base/boost_bsignals.h>
 
 namespace Swift {
 	class JID;
 	class VCardStorage;
 	class IQRouter;
 
 	class SWIFTEN_API VCardManager : public boost::bsignals::trackable {
 		public:
 			VCardManager(const JID& ownJID, IQRouter* iqRouter, VCardStorage* vcardStorage);
 			~VCardManager();
 
 			VCard::ref getVCard(const JID& jid) const;
-			VCard::ref getVCardAndRequestWhenNeeded(const JID& jid);
+			VCard::ref getVCardAndRequestWhenNeeded(const JID& jid, const boost::posix_time::time_duration& allowedAge = boost::posix_time::time_duration(boost::date_time::pos_infin));
 			void requestVCard(const JID& jid);
 			void requestOwnVCard();
 
 			std::string getPhotoHash(const JID& jid) const;
 
 
 			SetVCardRequest::ref createSetVCardRequest(VCard::ref);
 
 		public:
diff --git a/Swiften/VCards/VCardMemoryStorage.h b/Swiften/VCards/VCardMemoryStorage.h
index 86ae1b2..f538fc1 100644
--- a/Swiften/VCards/VCardMemoryStorage.h
+++ b/Swiften/VCards/VCardMemoryStorage.h
@@ -1,18 +1,19 @@
 /*
- * Copyright (c) 2010-2013 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
  */
 
 #pragma once
 
 #include <boost/shared_ptr.hpp>
+
 #include <map>
 
 #include <Swiften/JID/JID.h>
 #include <Swiften/VCards/VCardStorage.h>
 
 namespace Swift {
 	class VCardMemoryStorage : public VCardStorage {
 		public:
 			VCardMemoryStorage(CryptoProvider* crypto) : VCardStorage(crypto) {}
@@ -21,18 +22,30 @@ namespace Swift {
 				VCardMap::const_iterator i = vcards.find(jid);
 				if (i != vcards.end()) {
 					return i->second;
 				}
 				else {
 					return VCard::ref();
 				}
 			}
 
+			virtual boost::posix_time::ptime getVCardWriteTime(const JID& jid) const {
+				if (vcardWriteTimes.find(jid) == vcardWriteTimes.end()) {
+					return boost::posix_time::ptime();
+				}
+				else {
+					return vcardWriteTimes.at(jid);
+				}
+			}
+
 			virtual void setVCard(const JID& jid, VCard::ref v) {
 				vcards[jid] = v;
+				vcardWriteTimes[jid] = boost::posix_time::second_clock::universal_time();
 			}
 
 		private:
 			typedef std::map<JID, VCard::ref> VCardMap;
+			typedef std::map<JID, boost::posix_time::ptime> VCardWriteTimeMap;
 			VCardMap vcards;
+			VCardWriteTimeMap vcardWriteTimes;
 	};
 }
diff --git a/Swiften/VCards/VCardStorage.h b/Swiften/VCards/VCardStorage.h
index 924204c..e6c84f4 100644
--- a/Swiften/VCards/VCardStorage.h
+++ b/Swiften/VCards/VCardStorage.h
@@ -1,32 +1,35 @@
 /*
- * Copyright (c) 2010-2013 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
  */
 
 #pragma once
 
 #include <string>
+
 #include <boost/shared_ptr.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 
 #include <Swiften/Base/API.h>
 #include <Swiften/Elements/VCard.h>
 
 namespace Swift {
 	class JID;
 	class CryptoProvider;
 
 	class SWIFTEN_API VCardStorage {
 		public:
 			VCardStorage(CryptoProvider*);
 			virtual ~VCardStorage();
 
 			virtual VCard::ref getVCard(const JID& jid) const = 0;
+			virtual boost::posix_time::ptime getVCardWriteTime(const JID& jid) const = 0;
 			virtual void setVCard(const JID&, VCard::ref) = 0;
 
 			virtual std::string getPhotoHash(const JID&) const;
 
 		private:
 			CryptoProvider* crypto;
 	};
 }
author	Tobias Markmann <tm@ayena.de>	2014-10-03 13:48:37 (GMT)
committer	Swift Review <review@swift.im>	2014-10-08 07:37:33 (GMT)
commit	3e40b302af0e2abde3c002c7f25ec5276f68f230 (patch)
tree	cb73311e851d00364d22de1da978e45553b43912
parent	b67aba2e28e5fd716c18bef9c2826b482ef832ad (diff)
download	swift-contrib-3e40b302af0e2abde3c002c7f25ec5276f68f230.zip swift-contrib-3e40b302af0e2abde3c002c7f25ec5276f68f230.tar.bz2