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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
//
// SDLPreloadChoicesOperation.m
// SmartDeviceLink
//
// Created by Joel Fischer on 5/23/18.
// Copyright © 2018 smartdevicelink. All rights reserved.
//
#import "SDLPreloadChoicesOperation.h"
#import "SDLChoice.h"
#import "SDLChoiceCell.h"
#import "SDLConnectionManagerType.h"
#import "SDLCreateInteractionChoiceSet.h"
#import "SDLCreateInteractionChoiceSetResponse.h"
#import "SDLDisplayType.h"
#import "SDLError.h"
#import "SDLFileManager.h"
#import "SDLImage.h"
#import "SDLLogMacros.h"
#import "SDLWindowCapability.h"
#import "SDLWindowCapability+ScreenManagerExtensions.h"
NS_ASSUME_NONNULL_BEGIN
@interface SDLChoiceCell()
@property (assign, nonatomic) UInt16 choiceId;
@end
@interface SDLPreloadChoicesOperation()
@property (strong, nonatomic) NSUUID *operationId;
@property (strong, nonatomic) NSMutableSet<SDLChoiceCell *> *cellsToUpload;
@property (strong, nonatomic) SDLWindowCapability *windowCapability;
@property (strong, nonatomic) NSString *displayName;
@property (assign, nonatomic, getter=isVROptional) BOOL vrOptional;
@property (copy, nonatomic) SDLPreloadChoicesCompletionHandler completionHandler;
@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager;
@property (weak, nonatomic) SDLFileManager *fileManager;
@property (copy, nonatomic, nullable) NSError *internalError;
@property (strong, nonatomic) NSMutableArray<NSNumber *> *failedChoiceUploadIDs;
@end
@implementation SDLPreloadChoicesOperation
- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager displayName:(NSString *)displayName windowCapability:(SDLWindowCapability *)defaultMainWindowCapability isVROptional:(BOOL)isVROptional cellsToPreload:(NSOrderedSet<SDLChoiceCell *> *)cells updateCompletionHandler:(SDLPreloadChoicesCompletionHandler)completionHandler {
self = [super init];
if (!self) { return nil; }
_connectionManager = connectionManager;
_fileManager = fileManager;
_displayName = displayName;
_windowCapability = defaultMainWindowCapability;
_vrOptional = isVROptional;
_cellsToUpload = [cells mutableCopy];
_completionHandler = completionHandler;
_operationId = [NSUUID UUID];
_currentState = SDLPreloadChoicesOperationStateWaitingToStart;
_failedChoiceUploadIDs = [NSMutableArray array];
return self;
}
- (void)start {
[super start];
if (self.isCancelled) { return; }
[self sdl_preloadCellArtworksWithCompletionHandler:^(NSError * _Nullable error) {
self.internalError = error;
[self sdl_preloadCells];
}];
}
- (BOOL)removeChoicesFromUpload:(NSSet<SDLChoiceCell *> *)choices {
if (self.isExecuting) { return NO; }
[self.cellsToUpload minusSet:choices];
return YES;
}
#pragma mark - Sending Choice Data
- (void)sdl_preloadCellArtworksWithCompletionHandler:(void(^)(NSError *_Nullable))completionHandler {
_currentState = SDLPreloadChoicesOperationStateUploadingArtworks;
NSMutableArray<SDLArtwork *> *artworksToUpload = [NSMutableArray arrayWithCapacity:self.cellsToUpload.count];
for (SDLChoiceCell *cell in self.cellsToUpload) {
if ([self sdl_shouldSendChoicePrimaryImage] && [self.fileManager fileNeedsUpload:cell.artwork]) {
[artworksToUpload addObject:cell.artwork];
}
if ([self sdl_shouldSendChoiceSecondaryImage] && [self.fileManager fileNeedsUpload:cell.secondaryArtwork]) {
[artworksToUpload addObject:cell.secondaryArtwork];
}
}
if (artworksToUpload.count == 0) {
SDLLogD(@"No choice artworks to be uploaded");
completionHandler(nil);
return;
}
[self.fileManager uploadArtworks:[artworksToUpload copy] completionHandler:^(NSArray<NSString *> * _Nonnull artworkNames, NSError * _Nullable error) {
if (error != nil) {
SDLLogE(@"Error uploading choice artworks: %@", error);
} else {
SDLLogD(@"Finished uploading choice artworks");
SDLLogV(@"%@", artworkNames);
}
completionHandler(error);
}];
}
- (void)sdl_preloadCells {
_currentState = SDLPreloadChoicesOperationStatePreloadingChoices;
NSMutableArray<SDLCreateInteractionChoiceSet *> *choiceRPCs = [NSMutableArray arrayWithCapacity:self.cellsToUpload.count];
for (SDLChoiceCell *cell in self.cellsToUpload) {
SDLCreateInteractionChoiceSet *csCell = [self sdl_choiceFromCell:cell];
if (csCell != nil) {
[choiceRPCs addObject:csCell];
}
}
if (choiceRPCs.count == 0) {
SDLLogE(@"All choice cells to send are nil, so the choice set will not be shown");
self.internalError = [NSError sdl_choiceSetManager_failedToCreateMenuItems];
[self finishOperation];
return;
}
__weak typeof(self) weakSelf = self;
__block NSMutableDictionary<SDLRPCRequest *, NSError *> *errors = [NSMutableDictionary dictionary];
[self.connectionManager sendRequests:[choiceRPCs copy] progressHandler:^(__kindof SDLRPCRequest * _Nonnull request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error, float percentComplete) {
if (error != nil) {
errors[request] = error;
SDLCreateInteractionChoiceSet *sentRequest = (SDLCreateInteractionChoiceSet *)request;
[self.failedChoiceUploadIDs addObject:sentRequest.choiceSet.firstObject.choiceID];
}
} completionHandler:^(BOOL success) {
if (!success) {
SDLLogE(@"Error preloading choice cells: %@", errors);
weakSelf.internalError = [NSError sdl_choiceSetManager_choiceUploadFailed:errors];
}
SDLLogD(@"Finished preloading choice cells");
[weakSelf finishOperation];
}];
}
#pragma mark - Assembling Choice Data
- (nullable SDLCreateInteractionChoiceSet *)sdl_choiceFromCell:(SDLChoiceCell *)cell {
NSArray<NSString *> *vrCommands = nil;
if (cell.voiceCommands == nil) {
vrCommands = self.isVROptional ? nil : @[[NSString stringWithFormat:@"%hu", cell.choiceId]];
} else {
vrCommands = cell.voiceCommands;
}
NSString *menuName = nil;
if ([self sdl_shouldSendChoiceText]) {
menuName = cell.uniqueText;
}
if(!menuName) {
SDLLogE(@"Could not convert SDLChoiceCell to SDLCreateInteractionChoiceSet. It will not be shown. Cell: %@", cell);
return nil;
}
NSString *secondaryText = [self sdl_shouldSendChoiceSecondaryText] ? cell.secondaryText : nil;
NSString *tertiaryText = [self sdl_shouldSendChoiceTertiaryText] ? cell.tertiaryText : nil;
SDLImage *image = [self sdl_shouldSendChoicePrimaryImage] ? cell.artwork.imageRPC : nil;
SDLImage *secondaryImage = [self sdl_shouldSendChoiceSecondaryImage] ? cell.secondaryArtwork.imageRPC : nil;
SDLChoice *choice = [[SDLChoice alloc] initWithId:cell.choiceId menuName:(NSString *_Nonnull)menuName vrCommands:(NSArray<NSString *> * _Nonnull)vrCommands image:image secondaryText:secondaryText secondaryImage:secondaryImage tertiaryText:tertiaryText];
return [[SDLCreateInteractionChoiceSet alloc] initWithId:(UInt32)choice.choiceID.unsignedIntValue choiceSet:@[choice]];
}
/// Determine if we should send primary text. If textFields is nil, we don't know the capabilities and we will send everything.
- (BOOL)sdl_shouldSendChoiceText {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
if ([self.displayName isEqualToString:SDLDisplayTypeGen38Inch]) {
return YES;
}
#pragma clang diagnostic pop
return [self.windowCapability hasTextFieldOfName:SDLTextFieldNameMenuName];
}
/// Determine if we should send secondary text. If textFields is nil, we don't know the capabilities and we will send everything.
- (BOOL)sdl_shouldSendChoiceSecondaryText {
return [self.windowCapability hasTextFieldOfName:SDLTextFieldNameSecondaryText];
}
/// Determine if we should send teriary text. If textFields is nil, we don't know the capabilities and we will send everything.
- (BOOL)sdl_shouldSendChoiceTertiaryText {
return [self.windowCapability hasTextFieldOfName:SDLTextFieldNameTertiaryText];
}
/// Determine if we should send the primary image. If imageFields is nil, we don't know the capabilities and we will send everything.
- (BOOL)sdl_shouldSendChoicePrimaryImage {
return [self.windowCapability hasImageFieldOfName:SDLImageFieldNameChoiceImage];
}
/// Determine if we should send the secondary image. If imageFields is nil, we don't know the capabilities and we will send everything.
- (BOOL)sdl_shouldSendChoiceSecondaryImage {
return [self.windowCapability hasImageFieldOfName:SDLImageFieldNameChoiceSecondaryImage];
}
#pragma mark - Property Overrides
- (void)finishOperation {
_currentState = SDLPreloadChoicesOperationStateFinished;
self.completionHandler(self.failedChoiceUploadIDs);
[super finishOperation];
}
- (nullable NSString *)name {
return [NSString stringWithFormat:@"%@ - %@", self.class, self.operationId];
}
- (NSOperationQueuePriority)queuePriority {
return NSOperationQueuePriorityNormal;
}
- (nullable NSError *)error {
return self.internalError;
}
@end
NS_ASSUME_NONNULL_END
|
