-/*\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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+
+/**
+ * MemoryStorageService.cpp
+ *
+ * In-memory "persistent" storage, suitable for simple applications.
+ */
+
+#include "internal.h"
+#include "logging.h"
+#include "util/NDC.h"
+#include "util/StorageService.h"
+#include "util/Threads.h"
+#include "util/XMLHelper.h"
+
+#include <memory>
+#include <xercesc/util/XMLUniDefs.hpp>
+
+using namespace xmltooling::logging;
+using namespace xmltooling;
+using namespace std;
+
+using xercesc::DOMElement;
+
+namespace {
+ // Reasonably extended sizes to avoid callers needing to shrink unduly.
+ static const XMLTOOL_DLLLOCAL StorageService::Capabilities g_memCaps(0x4000, 0x4000, 0x4000);
+};
+
+namespace xmltooling {
+ class XMLTOOL_DLLLOCAL MemoryStorageService : public StorageService
+ {
+ public:
+ MemoryStorageService(const DOMElement* e);
+ virtual ~MemoryStorageService();
+
+ const Capabilities& getCapabilities() const {
+ return g_memCaps;
+ }
+
+ bool createString(const char* context, const char* key, const char* value, time_t expiration);
+ int readString(const char* context, const char* key, string* pvalue=nullptr, time_t* pexpiration=nullptr, int version=0);
+ int updateString(const char* context, const char* key, const char* value=nullptr, time_t expiration=0, int version=0);
+ bool deleteString(const char* context, const char* key);
+
+ bool createText(const char* context, const char* key, const char* value, time_t expiration) {
+ return createString(context, key, value, expiration);
+ }
+ int readText(const char* context, const char* key, string* pvalue=nullptr, time_t* pexpiration=nullptr, int version=0) {
+ return readString(context, key, pvalue, pexpiration, version);
+ }
+ int updateText(const char* context, const char* key, const char* value=nullptr, time_t expiration=0, int version=0) {
+ return updateString(context, key, value, expiration, version);
+ }
+ bool deleteText(const char* context, const char* key) {
+ return deleteString(context, key);
+ }
+
+ void reap(const char* context);
+ void updateContext(const char* context, time_t expiration);
+ void deleteContext(const char* context) {
+ m_lock->wrlock();
+ m_contextMap.erase(context);
+ m_lock->unlock();
+ }
+
+ private:
+ struct XMLTOOL_DLLLOCAL Record {
+ Record() : expiration(0), version(1) {}
+ Record(const string& s, time_t t) : data(s), expiration(t), version(1) {}
+ string data;
+ time_t expiration;
+ int version;
+ };
+
+ struct XMLTOOL_DLLLOCAL Context {
+ Context() {}
+ Context(const Context& src) {
+ m_dataMap = src.m_dataMap;
+ }
+ map<string,Record> m_dataMap;
+ unsigned long reap(time_t exp);
+ };
+
+ Context& readContext(const char* context) {
+ m_lock->rdlock();
+ map<string,Context>::iterator i = m_contextMap.find(context);
+ if (i != m_contextMap.end())
+ return i->second;
+ m_lock->unlock();
+ m_lock->wrlock();
+ return m_contextMap[context];
+ }
+
+ Context& writeContext(const char* context) {
+ m_lock->wrlock();
+ return m_contextMap[context];
+ }
+
+ map<string,Context> m_contextMap;
+ auto_ptr<RWLock> m_lock;
+ auto_ptr<CondWait> shutdown_wait;
+ auto_ptr<Thread> cleanup_thread;
+ static void* cleanup_fn(void*);
+ bool shutdown;
+ int m_cleanupInterval;
+ Category& m_log;
+ };
+
+ StorageService* XMLTOOL_DLLLOCAL MemoryStorageServiceFactory(const DOMElement* const & e)
+ {
+ return new MemoryStorageService(e);
+ }
+};
+
+static const XMLCh cleanupInterval[] = UNICODE_LITERAL_15(c,l,e,a,n,u,p,I,n,t,e,r,v,a,l);
+
+MemoryStorageService::MemoryStorageService(const DOMElement* e)
+ : m_lock(RWLock::create()), shutdown_wait(CondWait::create()), shutdown(false),
+ m_cleanupInterval(XMLHelper::getAttrInt(e, 900, cleanupInterval)),
+ m_log(Category::getInstance(XMLTOOLING_LOGCAT".StorageService"))
+{
+ cleanup_thread.reset(Thread::create(&cleanup_fn, (void*)this));
+}
+
+MemoryStorageService::~MemoryStorageService()
+{
+ // Shut down the cleanup thread and let it know...
+ shutdown = true;
+ shutdown_wait->signal();
+ cleanup_thread->join(nullptr);
+}
+
+void* MemoryStorageService::cleanup_fn(void* pv)
+{
+ MemoryStorageService* cache = reinterpret_cast<MemoryStorageService*>(pv);
+
+#ifndef WIN32
+ // First, let's block all signals
+ Thread::mask_all_signals();
+#endif
+
+#ifdef _DEBUG
+ NDC ndc("cleanup");
+#endif
+
+ auto_ptr<Mutex> mutex(Mutex::create());
+ mutex->lock();
+
+ cache->m_log.info("cleanup thread started...running every %d seconds", cache->m_cleanupInterval);
+
+ while (!cache->shutdown) {
+ cache->shutdown_wait->timedwait(mutex.get(), cache->m_cleanupInterval);
+ if (cache->shutdown)
+ break;
+
+ unsigned long count=0;
+ time_t now = time(nullptr);
+ cache->m_lock->wrlock();
+ SharedLock locker(cache->m_lock.get(), false);
+ for (map<string,Context>::iterator i=cache->m_contextMap.begin(); i!=cache->m_contextMap.end(); ++i)
+ count += i->second.reap(now);
+
+ if (count)
+ cache->m_log.info("purged %d expired record(s) from storage", count);
+ }
+
+ cache->m_log.info("cleanup thread finished");
+
+ mutex->unlock();
+ return nullptr;
+}
+
+void MemoryStorageService::reap(const char* context)
+{
+ Context& ctx = writeContext(context);
+ SharedLock locker(m_lock.get(), false);
+ ctx.reap(time(nullptr));
+}
+
+unsigned long MemoryStorageService::Context::reap(time_t exp)
+{
+ // Garbage collect any expired entries.
+ unsigned long count=0;
+ map<string,Record>::iterator cur = m_dataMap.begin();
+ map<string,Record>::iterator stop = m_dataMap.end();
+ while (cur != stop) {
+ if (cur->second.expiration <= exp) {
+ map<string,Record>::iterator tmp = cur++;
+ m_dataMap.erase(tmp);
+ ++count;
+ }
+ else {
+ cur++;
+ }
+ }
+ return count;
+}
+
+bool MemoryStorageService::createString(const char* context, const char* key, const char* value, time_t expiration)
+{
+ Context& ctx = writeContext(context);
+ SharedLock locker(m_lock.get(), false);
+
+ // Check for a duplicate.
+ map<string,Record>::iterator i=ctx.m_dataMap.find(key);
+ if (i!=ctx.m_dataMap.end()) {
+ // Not yet expired?
+ if (time(nullptr) < i->second.expiration)
+ return false;
+ // It's dead, so we can just remove it now and create the new record.
+ ctx.m_dataMap.erase(i);
+ }
+
+ ctx.m_dataMap[key]=Record(value,expiration);
+
+ m_log.debug("inserted record (%s) in context (%s) with expiration (%lu)", key, context, expiration);
+ return true;
+}
+
+int MemoryStorageService::readString(const char* context, const char* key, string* pvalue, time_t* pexpiration, int version)
+{
+ Context& ctx = readContext(context);
+ SharedLock locker(m_lock.get(), false);
+
+ map<string,Record>::iterator i=ctx.m_dataMap.find(key);
+ if (i==ctx.m_dataMap.end())
+ return 0;
+ else if (time(nullptr) >= i->second.expiration)
+ return 0;
+ if (pexpiration)
+ *pexpiration = i->second.expiration;
+ if (i->second.version == version)
+ return version; // nothing's changed, so just echo back the version
+ if (pvalue)
+ *pvalue = i->second.data;
+ return i->second.version;
+}
+
+int MemoryStorageService::updateString(const char* context, const char* key, const char* value, time_t expiration, int version)
+{
+ Context& ctx = writeContext(context);
+ SharedLock locker(m_lock.get(), false);
+
+ map<string,Record>::iterator i=ctx.m_dataMap.find(key);
+ if (i==ctx.m_dataMap.end())
+ return 0;
+ else if (time(nullptr) >= i->second.expiration)
+ return 0;
+
+ if (version > 0 && version != i->second.version)
+ return -1; // caller's out of sync
+
+ if (value) {
+ i->second.data = value;
+ ++(i->second.version);
+ }
+
+ if (expiration && expiration != i->second.expiration)
+ i->second.expiration = expiration;
+
+ m_log.debug("updated record (%s) in context (%s) with expiration (%lu)", key, context, i->second.expiration);
+ return i->second.version;
+}
+
+bool MemoryStorageService::deleteString(const char* context, const char* key)
+{
+ Context& ctx = writeContext(context);
+ SharedLock locker(m_lock.get(), false);
+
+ // Find the record.
+ map<string,Record>::iterator i=ctx.m_dataMap.find(key);
+ if (i!=ctx.m_dataMap.end()) {
+ ctx.m_dataMap.erase(i);
+ m_log.debug("deleted record (%s) in context (%s)", key, context);
+ return true;
+ }
+
+ m_log.debug("deleting record (%s) in context (%s)....not found", key, context);
+ return false;
+}
+
+void MemoryStorageService::updateContext(const char* context, time_t expiration)
+{
+ Context& ctx = writeContext(context);
+ SharedLock locker(m_lock.get(), false);
+
+ time_t now = time(nullptr);
+ map<string,Record>::iterator stop=ctx.m_dataMap.end();
+ for (map<string,Record>::iterator i = ctx.m_dataMap.begin(); i!=stop; ++i) {
+ if (now < i->second.expiration)
+ i->second.expiration = expiration;
+ }
+
+ m_log.debug("updated expiration of valid records in context (%s) to (%lu)", context, expiration);
+}