Add logging when size limits exceeded.

[shibboleth/cpp-xmltooling.git] / xmltooling / impl / MemoryStorageService.cpp

diff --git a/xmltooling/impl/MemoryStorageService.cpp b/xmltooling/impl/MemoryStorageService.cpp
index 55a1f19..546db20 100644 (file)
--- a/xmltooling/impl/MemoryStorageService.cpp
+++ b/xmltooling/impl/MemoryStorageService.cpp
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2010 Internet2
+/**
+ * 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.
  *
- * Licensed 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
+ * 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
+ * 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.
+ * 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.
  */
 
 /**
@@ -43,24 +47,30 @@ namespace xmltooling {
         MemoryStorageService(const DOMElement* e);
         virtual ~MemoryStorageService();
 
-        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);
+        bool createString(const char* context, const char* key, const char* value, time_t expiration) {
+            if (m_log.isDebugEnabled() && value && strlen(value) > 255) {
+                m_log.debug("string value for key (%s) exceeded allowed length", key);
+            }
+            return createText(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 readString(const char* context, const char* key, string* pvalue=nullptr, time_t* pexpiration=nullptr, int version=0) {
+            return readText(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);
+        int updateString(const char* context, const char* key, const char* value=nullptr, time_t expiration=0, int version=0) {
+            if (m_log.isDebugEnabled() && value && strlen(value) > 255) {
+                m_log.debug("string value for key (%s) exceeded allowed length", key);
+            }
+            return updateText(context, key, value, expiration, version);
         }
-        bool deleteText(const char* context, const char* key) {
-            return deleteString(context, key);
+        bool deleteString(const char* context, const char* key) {
+            return deleteText(context, key);
         }
 
+        bool createText(const char* context, const char* key, const char* value, time_t expiration);
+        int readText(const char* context, const char* key, string* pvalue=nullptr, time_t* pexpiration=nullptr, int version=0);
+        int updateText(const char* context, const char* key, const char* value=nullptr, time_t expiration=0, int version=0);
+        bool deleteText(const char* context, const char* key);
+
         void reap(const char* context);
         void updateContext(const char* context, time_t expiration);
         void deleteContext(const char* context) {
@@ -208,8 +218,16 @@ unsigned long MemoryStorageService::Context::reap(time_t exp)
     return count;
 }
 
-bool MemoryStorageService::createString(const char* context, const char* key, const char* value, time_t expiration)
+bool MemoryStorageService::createText(const char* context, const char* key, const char* value, time_t expiration)
 {
+    // This doesn't matter for this implementation, but helps identify bugs that might break others.
+    if (m_log.isDebugEnabled()) {
+        if (strlen(context) > 255)
+            m_log.debug("context value (%s) exceeded allowed length", context);
+        if (strlen(key) > 255)
+            m_log.debug("key value (%s) in context (%s) exceeded allowed length", key, context);
+    }
+
     Context& ctx = writeContext(context);
     SharedLock locker(m_lock, false);
 
@@ -229,7 +247,7 @@ bool MemoryStorageService::createString(const char* context, const char* key, co
     return true;
 }
 
-int MemoryStorageService::readString(const char* context, const char* key, string* pvalue, time_t* pexpiration, int version)
+int MemoryStorageService::readText(const char* context, const char* key, string* pvalue, time_t* pexpiration, int version)
 {
     Context& ctx = readContext(context);
     SharedLock locker(m_lock, false);
@@ -248,7 +266,7 @@ int MemoryStorageService::readString(const char* context, const char* key, strin
     return i->second.version;
 }
 
-int MemoryStorageService::updateString(const char* context, const char* key, const char* value, time_t expiration, int version)
+int MemoryStorageService::updateText(const char* context, const char* key, const char* value, time_t expiration, int version)
 {
     Context& ctx = writeContext(context);
     SharedLock locker(m_lock, false);
@@ -274,7 +292,7 @@ int MemoryStorageService::updateString(const char* context, const char* key, con
     return i->second.version;
 }
 
-bool MemoryStorageService::deleteString(const char* context, const char* key)
+bool MemoryStorageService::deleteText(const char* context, const char* key)
 {
     Context& ctx = writeContext(context);
     SharedLock locker(m_lock, false);