summaryrefslogtreecommitdiff
path: root/src/components/smart_objects/src/array_schema_item.cc
blob: 6f1e65d2eba20f1800c896251a1c042ea62e3163 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// Copyright (c) 2013, Ford Motor Company
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following
// disclaimer in the documentation and/or other materials provided with the
// distribution.
//
// Neither the name of the Ford Motor Company nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 'A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#include "smart_objects/array_schema_item.h"

#include "smart_objects/enum_schema_item.h"
#include "smart_objects/smart_object.h"

namespace ns_smart_device_link {
namespace ns_smart_objects {

std::shared_ptr<CArraySchemaItem> CArraySchemaItem::create(
    const ISchemaItemPtr ElementSchemaItem,
    const TSchemaItemParameter<size_t>& MinSize,
    const TSchemaItemParameter<size_t>& MaxSize) {
  return std::shared_ptr<CArraySchemaItem>(
      new CArraySchemaItem(ElementSchemaItem, MinSize, MaxSize));
}

std::shared_ptr<CArraySchemaItem> CArraySchemaItem::create(
    ISchemaItem* ElementSchemaItem,
    const TSchemaItemParameter<size_t>& MinSize,
    const TSchemaItemParameter<size_t>& MaxSize) {
  return std::shared_ptr<CArraySchemaItem>(
      new CArraySchemaItem(ElementSchemaItem, MinSize, MaxSize));
}

errors::eType CArraySchemaItem::validate(
    const SmartObject& Object,
    rpc::ValidationReport* report,
    const utils::SemanticVersion& MessageVersion,
    const bool allow_unknown_enums) {
  if (SmartType_Array != Object.getType()) {
    std::string validation_info =
        "Incorrect type, expected: " +
        SmartObject::typeToString(SmartType_Array) +
        ", got: " + SmartObject::typeToString(Object.getType());
    report->set_validation_info(validation_info);
    return errors::INVALID_VALUE;
  }
  size_t sizeLimit;
  const size_t array_len = Object.length();

  if (mMinSize.getValue(sizeLimit) && (array_len < sizeLimit)) {
    std::stringstream stream;
    stream << "Got array of size: " << array_len
           << ", minimum allowed: " << sizeLimit;
    std::string validation_info = stream.str();
    report->set_validation_info(validation_info);
    return errors::OUT_OF_RANGE;
  }
  if (mMaxSize.getValue(sizeLimit) && (array_len > sizeLimit)) {
    std::stringstream stream;
    stream << "Got array of size: " << array_len
           << ", maximum allowed: " << sizeLimit;
    std::string validation_info = stream.str();
    report->set_validation_info(validation_info);
    return errors::OUT_OF_RANGE;
  }

  for (size_t i = 0u; i < array_len; ++i) {
    const errors::eType result = mElementSchemaItem->validate(
        Object.getElement(i),
        &report->ReportSubobject(std::to_string(i)),
        MessageVersion,
        allow_unknown_enums);
    if (errors::OK != result) {
      return result;
    }
  }
  return errors::OK;
}

bool CArraySchemaItem::filterInvalidEnums(
    SmartObject& Object,
    const utils::SemanticVersion& MessageVersion,
    rpc::ValidationReport* report) {
  if (SmartType_Array != Object.getType()) {
    return false;
  }

  int index = 0;
  auto array = Object.asArray();
  size_t initial_size = array->size();
  auto should_erase =
      [this, MessageVersion, report, &index](SmartObject& element) {
        // If filterInvalidEnums returns true, the checked element
        // is now invalid and should be filtered
        return mElementSchemaItem->filterInvalidEnums(
            element,
            MessageVersion,
            &report->ReportSubobject(std::to_string(index++)));
      };
  array->erase(std::remove_if(array->begin(), array->end(), should_erase),
               array->end());

  // Mark this container as invalid if it is below the minimum size after
  // filtering one or more elements
  size_t min_size;
  return array->size() < initial_size && mMinSize.getValue(min_size) &&
         array->size() < min_size;
}

void CArraySchemaItem::applySchema(
    SmartObject& Object,
    const bool remove_unknown_parameters,
    const utils::SemanticVersion& MessageVersion) {
  if (SmartType_Array == Object.getType()) {
    for (size_t i = 0U; i < Object.length(); ++i) {
      mElementSchemaItem->applySchema(
          Object[i], remove_unknown_parameters, MessageVersion);
    }
  }
}

void CArraySchemaItem::unapplySchema(SmartObject& Object,
                                     const bool remove_unknown_parameters) {
  if (SmartType_Array == Object.getType()) {
    for (size_t i = 0U; i < Object.length(); ++i) {
      mElementSchemaItem->unapplySchema(Object[i], remove_unknown_parameters);
    }
  }
}

void CArraySchemaItem::BuildObjectBySchema(const SmartObject& pattern_object,
                                           SmartObject& result_object) {
  if (SmartType_Array == pattern_object.getType()) {
    const size_t array_len = pattern_object.length();
    if (array_len > 0) {
      for (size_t i = 0u; i < array_len; ++i) {
        mElementSchemaItem->BuildObjectBySchema(pattern_object.getElement(i),
                                                result_object[i]);
      }
      return;
    }
  }
  // empty array
  result_object = SmartObject(SmartType_Array);
}

TypeID CArraySchemaItem::GetType() {
  return TYPE_ARRAY;
}

CArraySchemaItem::CArraySchemaItem(ISchemaItem* ElementSchemaItem,
                                   const TSchemaItemParameter<size_t>& MinSize,
                                   const TSchemaItemParameter<size_t>& MaxSize)
    : mElementSchemaItem(ElementSchemaItem)
    , mElementSchemaItemShared(nullptr)
    , mMinSize(MinSize)
    , mMaxSize(MaxSize) {}

CArraySchemaItem::CArraySchemaItem(const ISchemaItemPtr ElementSchemaItem,
                                   const TSchemaItemParameter<size_t>& MinSize,
                                   const TSchemaItemParameter<size_t>& MaxSize)
    : mElementSchemaItem(ElementSchemaItem.get())
    , mElementSchemaItemShared(ElementSchemaItem)
    , mMinSize(MinSize)
    , mMaxSize(MaxSize) {}

}  // namespace ns_smart_objects
}  // namespace ns_smart_device_link