Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SCM to workaround Sync 3 bug with media capabilities #1987

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions SmartDeviceLink-iOS.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -7902,7 +7902,7 @@
attributes = {
CLASSPREFIX = SDL;
LastSwiftUpdateCheck = 0710;
LastUpgradeCheck = 1240;
LastUpgradeCheck = 1250;
ORGANIZATIONNAME = smartdevicelink;
TargetAttributes = {
5D4019AE1A76EC350006B0C2 = {
Expand Down Expand Up @@ -9433,7 +9433,7 @@
CLANG_WARN_OBJC_IMPLICIT_ATOMIC_PROPERTIES = YES;
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_IDENTITY = "";
"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "";
"CODE_SIGN_IDENTITY[sdk=macosx*]" = "Apple Development";
CODE_SIGN_STYLE = Automatic;
Expand Down Expand Up @@ -9489,7 +9489,7 @@
CLANG_WARN_OBJC_IMPLICIT_ATOMIC_PROPERTIES = YES;
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES;
CODE_SIGN_IDENTITY = "Apple Development";
CODE_SIGN_IDENTITY = "";
"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "";
"CODE_SIGN_IDENTITY[sdk=macosx*]" = "Apple Development";
CODE_SIGN_STYLE = Automatic;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "1240"
LastUpgradeVersion = "1250"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "1240"
LastUpgradeVersion = "1250"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "1240"
LastUpgradeVersion = "1250"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
Expand Down
6 changes: 5 additions & 1 deletion SmartDeviceLink/private/SDLConnectionManagerType.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#import "SDLNotificationConstants.h"
#import <Foundation/Foundation.h>

@class SDLConfiguration;
@class SDLRPCRequest;
@class SDLRPCMessage;
@class SDLRegisterAppInterfaceResponse;
Expand All @@ -18,8 +19,11 @@ NS_ASSUME_NONNULL_BEGIN

@protocol SDLConnectionManagerType <NSObject>

/// The configuration properties provided by the app to the SDL manager
@property (copy, nonatomic, readonly) SDLConfiguration *configuration;

/// An object describing the properties of the connected module
@property (strong, nonatomic, nullable) SDLSystemInfo *systemInfo;
@property (strong, nonatomic, readonly, nullable) SDLSystemInfo *systemInfo;

/**
* A special method on the connection manager which is used by managers that must bypass the default block on RPC sends before managers complete setup.
Expand Down
12 changes: 6 additions & 6 deletions SmartDeviceLink/private/SDLLifecycleManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@ typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error);
@property (strong, nonatomic, readonly) SDLStateMachine *lifecycleStateMachine;

@property (copy, nonatomic, readonly) SDLLifecycleState *lifecycleState;
@property (copy, nonatomic, nullable) SDLHMILevel hmiLevel;
@property (copy, nonatomic, nullable) SDLAudioStreamingState audioStreamingState;
@property (copy, nonatomic, nullable) SDLVideoStreamingState videoStreamingState;
@property (copy, nonatomic, nullable) SDLSystemContext systemContext;
@property (strong, nonatomic, nullable) SDLRegisterAppInterfaceResponse *registerResponse;
@property (strong, nonatomic, nullable) SDLSystemInfo *systemInfo;
@property (copy, nonatomic, readonly, nullable) SDLHMILevel hmiLevel;
@property (copy, nonatomic, readonly, nullable) SDLAudioStreamingState audioStreamingState;
@property (copy, nonatomic, readonly, nullable) SDLVideoStreamingState videoStreamingState;
@property (copy, nonatomic, readonly, nullable) SDLSystemContext systemContext;
@property (strong, nonatomic, readonly, nullable) SDLRegisterAppInterfaceResponse *registerResponse;
@property (strong, nonatomic, readonly, nullable) SDLSystemInfo *systemInfo;

@property (strong, nonatomic) NSOperationQueue *rpcOperationQueue;

Expand Down
55 changes: 25 additions & 30 deletions SmartDeviceLink/private/SDLLifecycleManager.m
Original file line number Diff line number Diff line change
Expand Up @@ -10,60 +10,33 @@

#import "SDLLifecycleManager.h"

#import <SmartDeviceLink/SmartDeviceLink.h>

#import "NSMapTable+Subscripting.h"
#import "SDLLifecycleRPCAdapter.h"
#import "SDLAsynchronousRPCOperation.h"
#import "SDLAsynchronousRPCRequestOperation.h"
#import "SDLChangeRegistration.h"
#import "SDLConfiguration.h"
#import "SDLConnectionManagerType.h"
#import "SDLEncryptionConfiguration.h"
#import "SDLLogMacros.h"
#import "SDLError.h"
#import "SDLEncryptionLifecycleManager.h"
#import "SDLFile.h"
#import "SDLFileManager.h"
#import "SDLFileManagerConfiguration.h"
#import "SDLGlobals.h"
#import "SDLIAPTransport.h"
#import "SDLLifecycleConfiguration.h"
#import "SDLLifecycleConfigurationUpdate.h"
#import "SDLLifecycleMobileHMIStateHandler.h"
#import "SDLLifecycleRPCAdapter.h"
#import "SDLLifecycleSyncPDataHandler.h"
#import "SDLLifecycleSystemRequestHandler.h"
#import "SDLLockScreenConfiguration.h"
#import "SDLLockScreenManager.h"
#import "SDLLockScreenPresenter.h"
#import "SDLLogConfiguration.h"
#import "SDLLogFileModuleMap.h"
#import "SDLLogManager.h"
#import "SDLManagerDelegate.h"
#import "SDLNotificationDispatcher.h"
#import "SDLOnAppInterfaceUnregistered.h"
#import "SDLOnHMIStatus.h"
#import "SDLOnHashChange.h"
#import "SDLPermissionManager.h"
#import "SDLPredefinedWindows.h"
#import "SDLProtocol.h"
#import "SDLLifecycleProtocolHandler.h"
#import "SDLRPCNotificationNotification.h"
#import "SDLRegisterAppInterface.h"
#import "SDLRegisterAppInterfaceResponse.h"
#import "SDLResponseDispatcher.h"
#import "SDLResult.h"
#import "SDLScreenManager.h"
#import "SDLSecondaryTransportManager.h"
#import "SDLSequentialRPCRequestOperation.h"
#import "SDLSetAppIcon.h"
#import "SDLStateMachine.h"
#import "SDLStreamingMediaConfiguration.h"
#import "SDLStreamingMediaManager.h"
#import "SDLSystemCapabilityManager.h"
#import "SDLSystemInfo.h"
#import "SDLTCPTransport.h"
#import "SDLUnregisterAppInterface.h"
#import "SDLVersion.h"
#import "SDLWindowCapability.h"

NS_ASSUME_NONNULL_BEGIN

Expand All @@ -88,6 +61,12 @@ @interface SDLStreamingMediaManager ()

@end

@interface SDLSystemCapabilityManager ()

@property (nullable, strong, nonatomic) NSString *lastDisplayLayoutRequestTemplate;

@end

#pragma mark - SDLLifecycleManager Private Interface

@interface SDLLifecycleManager () <SDLConnectionManagerType>
Expand All @@ -98,6 +77,12 @@ @interface SDLLifecycleManager () <SDLConnectionManagerType>
@property (strong, nonatomic, readwrite) SDLNotificationDispatcher *notificationDispatcher;
@property (strong, nonatomic, readwrite) SDLResponseDispatcher *responseDispatcher;
@property (strong, nonatomic, readwrite) SDLStateMachine *lifecycleStateMachine;
@property (copy, nonatomic, readwrite, nullable) SDLHMILevel hmiLevel;
@property (copy, nonatomic, readwrite, nullable) SDLAudioStreamingState audioStreamingState;
@property (copy, nonatomic, readwrite, nullable) SDLVideoStreamingState videoStreamingState;
@property (copy, nonatomic, readwrite, nullable) SDLSystemContext systemContext;
@property (strong, nonatomic, readwrite, nullable) SDLRegisterAppInterfaceResponse *registerResponse;
@property (strong, nonatomic, readwrite, nullable) SDLSystemInfo *systemInfo;

// Private Managers
@property (strong, nonatomic, nullable) SDLSecondaryTransportManager *secondaryTransportManager;
Expand Down Expand Up @@ -783,6 +768,16 @@ - (void)sdl_sendConnectionRequest:(__kindof SDLRPCMessage *)request withResponse
return;
}

// HAX: Issue #1152, Ford Sync bug returning incorrect display capabilities (https://github.com/smartdevicelink/sdl_ios/issues/1152).
// Inform the system capability manager of the next SetDisplayLayout type
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
if ([request.name isEqualToString:SDLRPCFunctionNameSetDisplayLayout]) {
SDLSetDisplayLayout *setDisplayLayoutRequest = (SDLSetDisplayLayout *)request;
self.systemCapabilityManager.lastDisplayLayoutRequestTemplate = setDisplayLayoutRequest.displayLayout;
}
#pragma clang diagnostic pop

// Before we send a message, we have to check if we need to adapt the RPC. When adapting the RPC, there could be multiple RPCs that need to be sent.
NSError *error = nil;
NSArray<SDLRPCMessage *> *messages = [SDLLifecycleRPCAdapter adaptRPC:request direction:SDLRPCDirectionOutgoing];
Expand Down
86 changes: 33 additions & 53 deletions SmartDeviceLink/public/SDLSystemCapabilityManager.m
Original file line number Diff line number Diff line change
Expand Up @@ -8,41 +8,16 @@

#import "SDLSystemCapabilityManager.h"

#import "SDLAppServiceCapability.h"
#import "SDLAppServiceRecord.h"
#import "SDLAppServicesCapabilities.h"
#import <SmartDeviceLink/SmartDeviceLink.h>

#import "SDLConnectionManagerType.h"
#import "SDLDisplayCapabilities.h"
#import "SDLDisplayCapability.h"
#import "SDLDriverDistractionCapability.h"
#import "SDLError.h"
#import "SDLGenericResponse.h"
#import "SDLGetSystemCapability.h"
#import "SDLGetSystemCapabilityResponse.h"
#import "SDLGlobals.h"
#import "SDLHMICapabilities.h"
#import "SDLImageField+ScreenManagerExtensions.h"
#import "SDLLogMacros.h"
#import "SDLNavigationCapability.h"
#import "SDLNotificationConstants.h"
#import "SDLOnHMIStatus.h"
#import "SDLOnSystemCapabilityUpdated.h"
#import "SDLPhoneCapability.h"
#import "SDLRegisterAppInterfaceResponse.h"
#import "SDLPredefinedWindows.h"
#import "SDLRemoteControlCapabilities.h"
#import "SDLRPCNotificationNotification.h"
#import "SDLRPCResponseNotification.h"
#import "SDLSeatLocationCapability.h"
#import "SDLSetDisplayLayoutResponse.h"
#import "SDLSystemCapability.h"
#import "SDLSystemCapabilityObserver.h"
#import "SDLTextField+ScreenManagerExtensions.h"
#import "SDLTextFieldName.h"
#import "SDLVersion.h"
#import "SDLVideoStreamingCapability.h"
#import "SDLWindowCapability.h"
#import "SDLWindowTypeCapabilities.h"

NS_ASSUME_NONNULL_BEGIN

Expand All @@ -56,7 +31,12 @@ @interface SDLSystemCapabilityManager ()
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
@property (nullable, strong, nonatomic, readwrite) SDLDisplayCapabilities *displayCapabilities;

// HAX: Issue #1152, Ford Sync bug returning incorrect display capabilities (https://github.com/smartdevicelink/sdl_ios/issues/1152)
@property (nullable, strong, nonatomic) SDLDisplayCapabilities *initialMediaCapabilities;
@property (nullable, strong, nonatomic) NSString *lastDisplayLayoutRequestTemplate;
#pragma clang diagnostic pop

@property (nullable, strong, nonatomic, readwrite) SDLHMICapabilities *hmiCapabilities;
@property (nullable, copy, nonatomic, readwrite) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities;
@property (nullable, copy, nonatomic, readwrite) NSArray<SDLButtonCapabilities *> *buttonCapabilities;
Expand Down Expand Up @@ -138,6 +118,8 @@ - (void)stop {
self.remoteControlCapability = nil;
self.seatLocationCapability = nil;
self.driverDistractionCapability = nil;
self.initialMediaCapabilities = nil;
self.lastDisplayLayoutRequestTemplate = nil;

self.supportsSubscriptions = NO;

Expand Down Expand Up @@ -187,62 +169,49 @@ - (nullable SDLWindowCapability *)defaultMainWindowCapability {

#pragma mark Convert Deprecated to New

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
/// Convert the capabilities from a `RegisterAppInterfaceResponse` into a new-style `DisplayCapability` for the main display.
/// @param rpc The `RegisterAppInterfaceResponse` RPC
- (NSArray<SDLDisplayCapability *> *)sdl_createDisplayCapabilityListFromRegisterResponse:(SDLRegisterAppInterfaceResponse *)rpc {
return [self sdl_createDisplayCapabilityListFromDeprecatedDisplayCapabilities:rpc.displayCapabilities buttons:rpc.buttonCapabilities softButtons:rpc.softButtonCapabilities];
}

- (NSArray<SDLDisplayCapability *> *)sdl_createDisplayCapabilityListFromSetDisplayLayoutResponse:(SDLSetDisplayLayoutResponse *)rpc {
return [self sdl_createDisplayCapabilityListFromDeprecatedDisplayCapabilities:rpc.displayCapabilities buttons:rpc.buttonCapabilities softButtons:rpc.softButtonCapabilities];
}
#pragma clang diagnostic pop

/// Creates a "new-style" display capability from the "old-style" `SDLDisplayCapabilities` object and other "old-style" objects that were returned in `RegisterAppInterfaceResponse` and `SetDisplayLayoutResponse`
/// @param display The old-style `SDLDisplayCapabilities` object to convert
/// @param buttons The old-style `SDLButtonCapabilities` object to convert
/// @param softButtons The old-style `SDLSoftButtonCapabilities` to convert
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
- (NSArray<SDLDisplayCapability *> *)sdl_createDisplayCapabilityListFromDeprecatedDisplayCapabilities:(SDLDisplayCapabilities *)display buttons:(NSArray<SDLButtonCapabilities *> *)buttons softButtons:(NSArray<SDLSoftButtonCapabilities *> *)softButtons {
- (NSArray<SDLDisplayCapability *> *)sdl_createDisplayCapabilityListFromDeprecatedDisplayCapabilities {
SDLLogV(@"Creating display capability from deprecated display capabilities");
// Based on deprecated Display capabilities we don't know if widgets are supported. The default MAIN window is the only window we know is supported, so it's the only one we will expose.
SDLWindowTypeCapabilities *windowTypeCapabilities = [[SDLWindowTypeCapabilities alloc] initWithType:SDLWindowTypeMain maximumNumberOfWindows:1];
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
NSString *displayName = display.displayName ?: display.displayType;
NSString *displayName = self.displayCapabilities.displayName ?: self.displayCapabilities.displayType;
#pragma clang diagnostic pop
SDLDisplayCapability *displayCapability = [[SDLDisplayCapability alloc] initWithDisplayName:displayName];
displayCapability.windowTypeSupported = @[windowTypeCapabilities];

// Create a window capability object for the default MAIN window
SDLWindowCapability *defaultWindowCapability = [[SDLWindowCapability alloc] init];
defaultWindowCapability.windowID = @(SDLPredefinedWindowsDefaultWindow);
defaultWindowCapability.buttonCapabilities = [buttons copy];
defaultWindowCapability.softButtonCapabilities = [softButtons copy];
defaultWindowCapability.buttonCapabilities = [self.buttonCapabilities copy];
defaultWindowCapability.softButtonCapabilities = [self.softButtonCapabilities copy];

// return if display capabilities don't exist.
if (display == nil) {
if (self.displayCapabilities == nil) {
defaultWindowCapability.textFields = [SDLTextField allTextFields];
defaultWindowCapability.imageFields = [SDLImageField allImageFields];
displayCapability.windowCapabilities = @[defaultWindowCapability];
return @[displayCapability];
}

// Copy all available display capability properties
defaultWindowCapability.templatesAvailable = [display.templatesAvailable copy];
defaultWindowCapability.numCustomPresetsAvailable = [display.numCustomPresetsAvailable copy];
defaultWindowCapability.textFields = [display.textFields copy];
defaultWindowCapability.imageFields = [display.imageFields copy];
defaultWindowCapability.templatesAvailable = [self.displayCapabilities.templatesAvailable copy];
defaultWindowCapability.numCustomPresetsAvailable = [self.displayCapabilities.numCustomPresetsAvailable copy];
defaultWindowCapability.textFields = [self.displayCapabilities.textFields copy];
defaultWindowCapability.imageFields = [self.displayCapabilities.imageFields copy];

/*
The description from the mobile API to "graphicSupported:
> The display's persistent screen supports referencing a static or dynamic image.
For backward compatibility (AppLink 2.0) static image type is always presented
*/
if (display.graphicSupported.boolValue) {
if (self.displayCapabilities.graphicSupported.boolValue) {
defaultWindowCapability.imageTypeSupported = @[SDLImageTypeStatic, SDLImageTypeDynamic];
} else {
defaultWindowCapability.imageTypeSupported = @[SDLImageTypeStatic];
Expand Down Expand Up @@ -731,6 +700,12 @@ - (void)sdl_registerResponse:(SDLRPCResponseNotification *)notification {
self.softButtonCapabilities = response.softButtonCapabilities;
self.buttonCapabilities = response.buttonCapabilities;
self.presetBankCapabilities = response.presetBankCapabilities;

// HAX: Issue #1152, Ford Sync bug returning incorrect display capabilities (https://github.com/smartdevicelink/sdl_ios/issues/1152). Store the initial capabilities if we are a media app so that we can use them in the future.
SDLLifecycleConfiguration *lifecycleConfig = self.connectionManager.configuration.lifecycleConfig;
if (lifecycleConfig.appType == SDLAppHMITypeMedia || [lifecycleConfig.additionalAppTypes containsObject:SDLAppHMITypeMedia]) {
self.initialMediaCapabilities = self.displayCapabilities;
}
#pragma clang diagnostic pop

self.hmiCapabilities = response.hmiCapabilities;
Expand All @@ -742,7 +717,7 @@ - (void)sdl_registerResponse:(SDLRPCResponseNotification *)notification {
self.pcmStreamCapability = response.pcmStreamCapabilities;

self.shouldConvertDeprecatedDisplayCapabilities = YES;
self.displays = [self sdl_createDisplayCapabilityListFromRegisterResponse:response];
self.displays = [self sdl_createDisplayCapabilityListFromDeprecatedDisplayCapabilities];

SDLLogV(@"Received RegisterAppInterface response, filled out display and other capabilities");

Expand All @@ -766,12 +741,17 @@ - (void)sdl_displayLayoutResponse:(SDLRPCResponseNotification *)notification {
// If we've received a display capability update then we should not convert our deprecated display capabilities and we should just return
if (!self.shouldConvertDeprecatedDisplayCapabilities) { return; }

self.displayCapabilities = response.displayCapabilities;
if (self.initialMediaCapabilities != nil && [self.lastDisplayLayoutRequestTemplate isEqualToString:SDLPredefinedLayoutMedia]) {
self.displayCapabilities = self.initialMediaCapabilities;
} else {
self.displayCapabilities = response.displayCapabilities;
}

self.buttonCapabilities = response.buttonCapabilities;
self.softButtonCapabilities = response.softButtonCapabilities;
self.presetBankCapabilities = response.presetBankCapabilities;

self.displays = [self sdl_createDisplayCapabilityListFromSetDisplayLayoutResponse:response];
self.displays = [self sdl_createDisplayCapabilityListFromDeprecatedDisplayCapabilities];

SDLLogV(@"Received SetDisplayLayout response, filled out display and other capabilities");

Expand Down
Loading