+/*\r
+ * Copyright 2001-2005 Internet2\r
+ * \r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+\r
+/**\r
+ * MemoryStorageService.cpp\r
+ * \r
+ * In-memory "persistent" storage, suitable for simple applications.\r
+ */\r
+\r
+#include "internal.h"\r
+#include "util/NDC.h"\r
+#include "util/StorageService.h"\r
+#include "util/Threads.h"\r
+#include "util/XMLHelper.h"\r
+\r
+#include <log4cpp/Category.hh>\r
+#include <xercesc/util/XMLUniDefs.hpp>\r
+\r
+using namespace xmltooling;\r
+using namespace log4cpp;\r
+using namespace std;\r
+\r
+namespace xmltooling {\r
+ class XMLTOOL_DLLLOCAL MemoryStorageService : public StorageService\r
+ {\r
+ public:\r
+ MemoryStorageService(const DOMElement* e);\r
+ virtual ~MemoryStorageService();\r
+ \r
+ void createString(const char* key, const char* value, time_t expiration);\r
+ bool readString(const char* key, string& value, time_t modifiedSince=0);\r
+ bool updateString(const char* key, const char* value=NULL, time_t expiration=0);\r
+ bool deleteString(const char* key);\r
+ \r
+ void createText(const char* key, const char* value, time_t expiration) {\r
+ return createString(key, value, expiration);\r
+ }\r
+ bool readText(const char* key, string& value, time_t modifiedSince=0) {\r
+ return readString(key, value, modifiedSince);\r
+ }\r
+ bool updateText(const char* key, const char* value=NULL, time_t expiration=0) {\r
+ return updateString(key, value, expiration);\r
+ }\r
+ bool deleteText(const char* key) {\r
+ return deleteString(key);\r
+ }\r
+ \r
+ void reap() {\r
+ shutdown_wait->signal();\r
+ }\r
+\r
+ private:\r
+ void cleanup();\r
+ \r
+ struct XMLTOOL_DLLLOCAL Record {\r
+ Record() : modified(0), expiration(0) {}\r
+ Record(string s, time_t t1, time_t t2) : data(s), modified(t1), expiration(t2) {}\r
+ string data;\r
+ time_t modified, expiration;\r
+ };\r
+ \r
+ map<string,Record> m_dataMap;\r
+ multimap<time_t,string> m_expMap;\r
+ RWLock* m_lock;\r
+ CondWait* shutdown_wait;\r
+ Thread* cleanup_thread;\r
+ static void* cleanup_fn(void*);\r
+ bool shutdown;\r
+ int m_cleanupInterval;\r
+ Category& m_log;\r
+ };\r
+\r
+ StorageService* XMLTOOL_DLLLOCAL MemoryStorageServiceFactory(const DOMElement* const & e)\r
+ {\r
+ return new MemoryStorageService(e);\r
+ }\r
+\r
+};\r
+\r
+static const XMLCh cleanupInterval[] = UNICODE_LITERAL_15(c,l,e,a,n,u,p,I,n,t,e,r,v,a,l);\r
+\r
+MemoryStorageService::MemoryStorageService(const DOMElement* e)\r
+ : m_lock(NULL), shutdown_wait(NULL), cleanup_thread(NULL), shutdown(false), m_cleanupInterval(0),\r
+ m_log(Category::getInstance(XMLTOOLING_LOGCAT".StorageService"))\r
+{\r
+ m_lock = RWLock::create();\r
+ shutdown_wait = CondWait::create();\r
+ cleanup_thread = Thread::create(&cleanup_fn, (void*)this);\r
+\r
+ const XMLCh* tag=e ? e->getAttributeNS(NULL,cleanupInterval) : NULL;\r
+ if (tag && *tag) {\r
+ m_cleanupInterval = XMLString::parseInt(tag);\r
+ }\r
+ if (!m_cleanupInterval)\r
+ m_cleanupInterval=300;\r
+}\r
+\r
+MemoryStorageService::~MemoryStorageService()\r
+{\r
+ // Shut down the cleanup thread and let it know...\r
+ shutdown = true;\r
+ shutdown_wait->signal();\r
+ cleanup_thread->join(NULL);\r
+\r
+ delete m_lock;\r
+ delete shutdown_wait;\r
+}\r
+\r
+void* MemoryStorageService::cleanup_fn(void* cache_p)\r
+{\r
+ MemoryStorageService* cache = reinterpret_cast<MemoryStorageService*>(cache_p);\r
+\r
+#ifndef WIN32\r
+ // First, let's block all signals \r
+ Thread::mask_all_signals();\r
+#endif\r
+\r
+ // Now run the cleanup process.\r
+ cache->cleanup();\r
+ return NULL;\r
+}\r
+\r
+void MemoryStorageService::cleanup()\r
+{\r
+#ifdef _DEBUG\r
+ NDC ndc("cleanup");\r
+#endif\r
+ \r
+\r
+ Mutex* mutex = Mutex::create();\r
+ mutex->lock();\r
+\r
+ m_log.info("cleanup thread started...running every %d seconds", m_cleanupInterval);\r
+\r
+ while (!shutdown) {\r
+ shutdown_wait->timedwait(mutex, m_cleanupInterval);\r
+ if (shutdown)\r
+ break;\r
+\r
+ // Lock the "database".\r
+ m_lock->wrlock();\r
+ \r
+ // Garbage collect any expired entries.\r
+ unsigned int count=0;\r
+ time_t now=time(NULL)-XMLToolingConfig::getConfig().clock_skew_secs;\r
+ multimap<time_t,string>::iterator stop=m_expMap.upper_bound(now);\r
+ for (multimap<time_t,string>::iterator i=m_expMap.begin(); i!=stop; m_expMap.erase(i++)) {\r
+ m_dataMap.erase(i->second);\r
+ ++count;\r
+ }\r
+ \r
+ m_lock->unlock();\r
+ \r
+ if (count)\r
+ m_log.info("purged %d record(s) from storage", count);\r
+ }\r
+\r
+ m_log.info("cleanup thread finished");\r
+\r
+ mutex->unlock();\r
+ delete mutex;\r
+ Thread::exit(NULL);\r
+}\r
+\r
+void MemoryStorageService::createString(const char* key, const char* value, time_t expiration)\r
+{\r
+ // Lock the maps.\r
+ m_lock->wrlock();\r
+ SharedLock wrapper(m_lock, false);\r
+ \r
+ // Check for a duplicate.\r
+ map<string,Record>::iterator i=m_dataMap.find(key);\r
+ if (i!=m_dataMap.end())\r
+ throw IOException("attempted to insert a record with duplicate key ($1)", params(1,key));\r
+ \r
+ m_dataMap[key]=Record(value,time(NULL),expiration);\r
+ m_expMap.insert(multimap<time_t,string>::value_type(expiration,key));\r
+ \r
+ m_log.debug("inserted record (%s)", key);\r
+}\r
+\r
+bool MemoryStorageService::readString(const char* key, string& value, time_t modifiedSince)\r
+{\r
+ SharedLock wrapper(m_lock);\r
+ map<string,Record>::iterator i=m_dataMap.find(key);\r
+ if (i==m_dataMap.end())\r
+ return false;\r
+ else if (modifiedSince >= i->second.modified)\r
+ return false;\r
+ value = i->second.data;\r
+ return true;\r
+}\r
+\r
+bool MemoryStorageService::updateString(const char* key, const char* value, time_t expiration)\r
+{\r
+ // Lock the maps.\r
+ m_lock->wrlock();\r
+ SharedLock wrapper(m_lock, false);\r
+\r
+ map<string,Record>::iterator i=m_dataMap.find(key);\r
+ if (i==m_dataMap.end())\r
+ return false;\r
+ \r
+ if (value)\r
+ i->second.data = value;\r
+ \r
+ if (expiration && expiration != i->second.expiration) {\r
+ // Update secondary map.\r
+ pair<multimap<time_t,string>::iterator,multimap<time_t,string>::iterator> range=m_expMap.equal_range(i->second.expiration);\r
+ for (; range.first != range.second; ++range.first) {\r
+ if (range.first->second == i->first) {\r
+ m_expMap.erase(range.first);\r
+ break;\r
+ }\r
+ }\r
+ i->second.expiration = expiration;\r
+ m_expMap.insert(multimap<time_t,string>::value_type(expiration,key));\r
+ }\r
+\r
+ i->second.modified = time(NULL);\r
+ m_log.debug("updated record (%s)", key);\r
+ return true;\r
+}\r
+\r
+bool MemoryStorageService::deleteString(const char* key)\r
+{\r
+ // Lock the maps.\r
+ m_lock->wrlock();\r
+ SharedLock wrapper(m_lock, false);\r
+ \r
+ // Find the record.\r
+ map<string,Record>::iterator i=m_dataMap.find(key);\r
+ if (i!=m_dataMap.end()) {\r
+ // Now find the reversed index of expiration to key, so we can clear it.\r
+ pair<multimap<time_t,string>::iterator,multimap<time_t,string>::iterator> range=m_expMap.equal_range(i->second.expiration);\r
+ for (; range.first != range.second; ++range.first) {\r
+ if (range.first->second == i->first) {\r
+ m_expMap.erase(range.first);\r
+ break;\r
+ }\r
+ }\r
+ // And finally delete the record itself.\r
+ m_dataMap.erase(i);\r
+ m_log.debug("deleted record (%s)", key);\r
+ return true;\r
+ }\r
+\r
+ m_log.debug("deleting record (%s)....not found", key);\r
+ return false;\r
+}\r