Add strictness to Schema::Validate()

components/policy/core/common/schema.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef COMPONENTS_POLICY_CORE_COMMON_SCHEMA_H_
 #define COMPONENTS_POLICY_CORE_COMMON_SCHEMA_H_
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "base/values.h"
 #include "components/policy/policy_export.h"
 
 namespace policy {
 namespace internal {
 
 struct POLICY_EXPORT SchemaData;
 struct POLICY_EXPORT SchemaNode;
 struct POLICY_EXPORT PropertyNode;
 struct POLICY_EXPORT PropertiesNode;
 
 }  // namespace internal
 
+// Option flags passed to Schema::Validate() and Schema::Normalize(), describing
+// the strategy to handle unknown or invalid properties for dict type. Note
+// that in Schema::Normalize() allowed errors will be dropped and thus
+// ignored.
+enum SchemaOnErrorStrategy {
+  SCHEMA_VERY_STRICT = 0,

[Joao da Silva, 2014/01/22 10:49:53]

just SCHEMA_STRICT. Add a documenting comment:

// No errors will be allowed.

[binjin, 2014/01/23 12:01:31]

Done.

+  SCHEMA_ALLOW_UNKNOWN_TOPLEVEL,

[Joao da Silva, 2014/01/22 10:49:53]

Add a comment:

// Unknown properties in the top-level dictionary will be ignored.

[binjin, 2014/01/23 12:01:31]

Done.

+  SCHEMA_ALLOW_UNKNOWN,

[Joao da Silva, 2014/01/22 10:49:53]

Add a comment:

// Unknown properties in any dictionary will be ignored.

[binjin, 2014/01/23 12:01:31]

Done.

+  SCHEMA_ALLOW_INVALID_TOPLEVEL,

[Joao da Silva, 2014/01/22 10:49:53]

Add a comment:

// Mismatched values will be ignored at the toplevel.

[binjin, 2014/01/23 12:01:31]

Done.

+  SCHEMA_ALLOW_INVALID_TOPLEVEL_AND_ALLOW_UNKNOWN,

[Joao da Silva, 2014/01/22 10:49:53]

Add a comment:

// Mismatched values will be ignored at the top-level dictionary.
// Unknown properties in any dictionary will be ignored.

[binjin, 2014/01/23 12:01:31]

Done.

+  SCHEMA_ALLOW_INVALID,

[Joao da Silva, 2014/01/22 10:49:53]

Add a comment:

// Mismatched values will be ignored.

[binjin, 2014/01/23 12:01:31]

Done.

+};
+
 // Describes the expected type of one policy. Also recursively describes the
 // types of inner elements, for structured types.
 // Objects of this class refer to external, immutable data and are cheap to
 // copy.
 class POLICY_EXPORT Schema {
  public:
   // Used internally to store shared data.
   class InternalStorage;
 
   // Builds an empty, invalid schema.
@@ skipping 15 matching lines @@
   // the internal representation. If |schema| is invalid then an invalid Schema
   // is returned and |error| contains a reason for the failure.
   static Schema Parse(const std::string& schema, std::string* error);
 
   // Returns true if this Schema is valid. Schemas returned by the methods below
   // may be invalid, and in those cases the other methods must not be used.
   bool valid() const { return node_ != NULL; }
 
   base::Value::Type type() const;
 
-  // Returns true if |value| conforms to this Schema.
-  bool Validate(const base::Value& value) const;
+  // Validate |value| against current schema, |strategy| is the strategy to
+  // handle unknown or invalid properties in dict type. Allowed errors will be
+  // ignored. If |value| don't conform the schema, false will be returned and
+  // |error| will contain a message state the detailed reason.

[Joao da Silva, 2014/01/22 10:49:53]

|error| will contain the detailed reason.

[binjin, 2014/01/23 12:01:31]

Done.

+  bool Validate(const base::Value& value,
+                SchemaOnErrorStrategy strategy,
+                std::string* error) const;
+
+  // Validate |value| against current schema, |strategy| is the strategy to
+  // handle unknown or invalid properties in dict type. Allowed errors will be
+  // dropped in place. If |value| don't conform the schema, false will be
+  // returned and |error| will contain a message state the detailed message.

[Joao da Silva, 2014/01/22 10:49:53]

returned and |error| will contain the detailed reason.

[binjin, 2014/01/23 12:01:31]

Done.

+  bool Normalize(base::Value* value,
+                 SchemaOnErrorStrategy strategy,
+                 std::string* error) const;
 
   // Used to iterate over the known properties of TYPE_DICTIONARY schemas.
   class POLICY_EXPORT Iterator {
    public:
     Iterator(const scoped_refptr<const InternalStorage>& storage,
              const internal::PropertiesNode* node);
     Iterator(const Iterator& iterator);
     ~Iterator();
 
     Iterator& operator=(const Iterator& iterator);
@@ skipping 49 matching lines @@
   bool ValidateIntegerRestriction(int index, int value) const;
   bool ValidateStringRestriction(int index, const char *str) const;
 
   scoped_refptr<const InternalStorage> storage_;
   const internal::SchemaNode* node_;
 };
 
 }  // namespace policy
 
 #endif  // COMPONENTS_POLICY_CORE_COMMON_SCHEMA_H_