|
| 1 | +/** |
| 2 | + * Copyright (c) 2025 Project CHIP Authors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +#import "MTRDeviceDataValidation.h" |
| 18 | +#import "MTRLogging_Internal.h" |
| 19 | +#import <Matter/Matter.h> |
| 20 | + |
| 21 | +@implementation MTRCommandWithExpectedResult |
| 22 | +- (instancetype)initWithPath:(MTRCommandPath *)path |
| 23 | + commandFields:(nullable NSDictionary<NSString *, id> *)commandFields |
| 24 | + expectedResult:(nullable NSDictionary<NSNumber *, NSDictionary<NSString *, id> *> *)expectedResult |
| 25 | +{ |
| 26 | + if (self = [super init]) { |
| 27 | + self.path = path; |
| 28 | + self.commandFields = commandFields; |
| 29 | + self.expectedResult = expectedResult; |
| 30 | + } |
| 31 | + |
| 32 | + return self; |
| 33 | +} |
| 34 | + |
| 35 | +- (id)copyWithZone:(NSZone *)zone |
| 36 | +{ |
| 37 | + return [[MTRCommandWithExpectedResult alloc] initWithPath:self.path commandFields:self.commandFields expectedResult:self.expectedResult]; |
| 38 | +} |
| 39 | + |
| 40 | +- (NSString *)description |
| 41 | +{ |
| 42 | + return [NSString stringWithFormat:@"<%@: %p, path: %@, fields: %@, expectedResult: %@", NSStringFromClass(self.class), self, self.path, self.commandFields, self.expectedResult]; |
| 43 | +} |
| 44 | + |
| 45 | +#pragma mark - MTRCommandWithExpectedResult NSSecureCoding implementation |
| 46 | + |
| 47 | +static NSString * const sPathKey = @"pathKey"; |
| 48 | +static NSString * const sFieldsKey = @"fieldsKey"; |
| 49 | +static NSString * const sExpectedResultKey = @"expectedResultKey"; |
| 50 | + |
| 51 | ++ (BOOL)supportsSecureCoding |
| 52 | +{ |
| 53 | + return YES; |
| 54 | +} |
| 55 | + |
| 56 | +- (nullable instancetype)initWithCoder:(NSCoder *)decoder |
| 57 | +{ |
| 58 | + self = [super init]; |
| 59 | + if (self == nil) { |
| 60 | + return nil; |
| 61 | + } |
| 62 | + |
| 63 | + _path = [decoder decodeObjectOfClass:MTRCommandPath.class forKey:sPathKey]; |
| 64 | + if (!_path || ![_path isKindOfClass:MTRCommandPath.class]) { |
| 65 | + MTR_LOG_ERROR("MTRCommandWithExpectedResult decoded %@ for endpoint, not MTRCommandPath.", _path); |
| 66 | + return nil; |
| 67 | + } |
| 68 | + |
| 69 | + _commandFields = [decoder decodeObjectOfClass:NSDictionary.class forKey:sFieldsKey]; |
| 70 | + if (_commandFields) { |
| 71 | + if (![_commandFields isKindOfClass:NSDictionary.class]) { |
| 72 | + MTR_LOG_ERROR("MTRCommandWithExpectedResult decoded %@ for commandFields, not NSDictionary.", _commandFields); |
| 73 | + return nil; |
| 74 | + } |
| 75 | + |
| 76 | + if (!MTRDataValueDictionaryIsWellFormed(_commandFields) || ![MTRStructureValueType isEqual:_commandFields[MTRTypeKey]]) { |
| 77 | + MTR_LOG_ERROR("MTRCommandWithExpectedResult decoded %@ for commandFields, not a structure-typed data-value dictionary.", _commandFields); |
| 78 | + return nil; |
| 79 | + } |
| 80 | + } |
| 81 | + |
| 82 | + _expectedResult = [decoder decodeObjectOfClass:NSDictionary.class forKey:sExpectedResultKey]; |
| 83 | + if (_expectedResult) { |
| 84 | + if (![_expectedResult isKindOfClass:NSDictionary.class]) { |
| 85 | + MTR_LOG_ERROR("MTRCommandWithExpectedResult decoded %@ for expectedResult, not NSDictionary.", _expectedResult); |
| 86 | + return nil; |
| 87 | + } |
| 88 | + |
| 89 | + for (id key in _expectedResult) { |
| 90 | + if (![key isKindOfClass:NSNumber.class]) { |
| 91 | + MTR_LOG_ERROR("MTRCommandWithExpectedResult decoded key %@ in expectedResult", key); |
| 92 | + return nil; |
| 93 | + } |
| 94 | + |
| 95 | + if (![_expectedResult[key] isKindOfClass:NSDictionary.class] || !MTRDataValueDictionaryIsWellFormed(_expectedResult[key])) { |
| 96 | + MTR_LOG_ERROR("MTRCommandWithExpectedResult decoded value %@ for key %@ in expectedResult", _expectedResult[key], key); |
| 97 | + return nil; |
| 98 | + } |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + return self; |
| 103 | +} |
| 104 | + |
| 105 | +- (void)encodeWithCoder:(NSCoder *)coder |
| 106 | +{ |
| 107 | + // In theory path is not nullable, but we don't really enforce that in init. |
| 108 | + if (self.path) { |
| 109 | + [coder encodeObject:self.path forKey:sPathKey]; |
| 110 | + } |
| 111 | + if (self.commandFields) { |
| 112 | + [coder encodeObject:self.commandFields forKey:sFieldsKey]; |
| 113 | + } |
| 114 | + if (self.expectedResult) { |
| 115 | + [coder encodeObject:self.expectedResult forKey:sExpectedResultKey]; |
| 116 | + } |
| 117 | +} |
| 118 | + |
| 119 | +@end |
0 commit comments