aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/Source/API/FIRFieldPath.mm
blob: f4e532f0b70c387d3de7613f349b5b90f9d872fc (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
/*
 * Copyright 2017 Google
 *
 * 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
 *
 *      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.
 */

#import "Firestore/Source/API/FIRFieldPath+Internal.h"

#import "Firestore/Source/Model/FSTPath.h"
#import "Firestore/Source/Util/FSTUsageValidation.h"

NS_ASSUME_NONNULL_BEGIN

@implementation FIRFieldPath

- (instancetype)initWithFields:(NSArray<NSString *> *)fieldNames {
  if (fieldNames.count == 0) {
    FSTThrowInvalidArgument(@"Invalid field path. Provided names must not be empty.");
  }

  for (int i = 0; i < fieldNames.count; ++i) {
    if (fieldNames[i].length == 0) {
      FSTThrowInvalidArgument(@"Invalid field name at index %d. Field names must not be empty.", i);
    }
  }

  return [self initPrivate:[FSTFieldPath pathWithSegments:fieldNames]];
}

+ (instancetype)documentID {
  return [[FIRFieldPath alloc] initPrivate:FSTFieldPath.keyFieldPath];
}

- (instancetype)initPrivate:(FSTFieldPath *)fieldPath {
  if (self = [super init]) {
    _internalValue = fieldPath;
  }
  return self;
}

+ (instancetype)pathWithDotSeparatedString:(NSString *)path {
  if ([[FIRFieldPath reservedCharactersRegex]
          numberOfMatchesInString:path
                          options:0
                            range:NSMakeRange(0, path.length)] > 0) {
    FSTThrowInvalidArgument(
        @"Invalid field path (%@). Paths must not contain '~', '*', '/', '[', or ']'", path);
  }
  @try {
    return [[FIRFieldPath alloc] initWithFields:[path componentsSeparatedByString:@"."]];
  } @catch (NSException *exception) {
    FSTThrowInvalidArgument(
        @"Invalid field path (%@). Paths must not be empty, begin with '.', end with '.', or "
        @"contain '..'",
        path);
  }
}

/** Matches any characters in a field path string that are reserved. */
+ (NSRegularExpression *)reservedCharactersRegex {
  static NSRegularExpression *regex = nil;
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    regex = [NSRegularExpression regularExpressionWithPattern:@"[~*/\\[\\]]" options:0 error:nil];
  });
  return regex;
}

- (id)copyWithZone:(NSZone *__nullable)zone {
  return [[[self class] alloc] initPrivate:self.internalValue];
}

- (BOOL)isEqual:(nullable id)object {
  if (self == object) {
    return YES;
  }

  if (![object isKindOfClass:[FIRFieldPath class]]) {
    return NO;
  }

  return [self.internalValue isEqual:((FIRFieldPath *)object).internalValue];
}

- (NSUInteger)hash {
  return [self.internalValue hash];
}

@end

NS_ASSUME_NONNULL_END