Changeset 16717

Timestamp:

2008-08-12T12:37:34+12:00 (16 years ago)

Author:

mdewsnip

Message:

Tidied up the validateAction() function to be consistently structured.

File:

• gsdl/trunk/runtime-src/src/oaiservr/listsetsaction.cpp (modified) (2 diffs)

gsdl/trunk/runtime-src/src/oaiservr/listsetsaction.cpp

@@ -12 +12 @@
 bool listsetsaction::validateAction(recptproto *protocol, oaiargs &params)
 {
-  int params_size = params.getSize();
-
-  // Remove any parameters that aren't valid for this action
+  // ----------------------------------------------------------------------------
+  //  1. Check for invalid arguments
+  // ----------------------------------------------------------------------------
+  bool invalid_argument_supplied = false;
   text_tmap::const_iterator param_iterator = params.begin();
   while (param_iterator != params.end())
   {
-    if (param_iterator->first != "verb" && param_iterator->first != "resumptionToken")
-    {
+    // Check for arguments that aren't valid for this action
+    if (param_iterator->first != "verb" &&
+    param_iterator->first != "resumptionToken")
+    {
+      // We've found an invalid argument
+      invalid_argument_supplied = true;
+
+      // Delete the invalid argument from the list so it doesn't end up in the <request> tag that is returned
       params.erase(param_iterator->first);
     }
@@ -26 +33 @@
   }
 
-  if (params_size != params.getSize()) {
+  // If we found an invalid argument it's an error, so don't go any further 
+  if (invalid_argument_supplied)
+  {
     this->errorType = "badArgument";
     return false;
   }
 
-  if (params["resumptionToken"] != "") {
+  // ----------------------------------------------------------------------------
+  //  2. Handle any exclusive arguments
+  // ----------------------------------------------------------------------------
+
+  //  The resumptionToken argument is exclusive
+  if (params["resumptionToken"] != "")
+  {
+    // This argument is exclusive, so no other arguments are allowed (except "verb" of course)
+    if (params.getSize() != 2)
+    {
+      this->errorType = "badArgument";
+      return false;
+    }
+
+    // Check the resumption token is valid
     ResumptionToken token(params["resumptionToken"]);
-    // TO DO: Resumption token validation checking (the token.isValid() function is useless for ListSets)
-    // if (!token.isValid()) {
-    //   this->errorType = "badResumptionToken";
-    //   return false;
-    // }
-  }
-
+    if (true)  // TO DO: Fix this (the token.isValid() function is useless for ListSets)
+    {
+      // Everything is fine, and we don't continue further because this is an exclusive argument
+      this->errorType = "";
+      return true;
+    }
+    else
+    {
+      // There was an error with the resumption token
+      this->errorType = "badResumptionToken";
+      return false;
+    }
+  }
+
+  // ----------------------------------------------------------------------------
+  //  3. Handle any required arguments
+  // ----------------------------------------------------------------------------
+
+  // None!
+
+  // ----------------------------------------------------------------------------
+  // 4. Check any remaining arguments
+  // ----------------------------------------------------------------------------
+
+  // None!
+
+  // If we've reached here everything must be fine
+  this->errorType = "";
   return true;
 }