Skip to content

Commit

Permalink
Merge pull request #6250 from vector-im/ismail/6180_support_prov_links
Browse files Browse the repository at this point in the history
  • Loading branch information
@ismailgulek
ismailgulek authored Jun 7, 2022
2 parents 34a2787 + fc29e4b commit ceae4a4
Show file tree
Hide file tree
Showing 19 changed files with 398 additions and 343 deletions.
18 changes: 4 additions & 14 deletions Riot/Modules/Application/LegacyAppDelegate.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ UINavigationControllerDelegate
/**
Last handled universal link (url will be formatted for several hash keys).
*/
@property (nonatomic, readonly) UniversalLink *lastHandledUniversalLink;
@property (nonatomic, copy, readonly) UniversalLink *lastHandledUniversalLink;

// New message sound id.
@property (nonatomic, readonly) SystemSoundID messageSound;
Expand Down Expand Up @@ -162,6 +162,9 @@ UINavigationControllerDelegate
// Reload all running matrix sessions
- (void)reloadMatrixSessions:(BOOL)clearCache;

- (void)displayLogoutConfirmationForLink:(UniversalLink *)link
completion:(void (^)(BOOL loggedOut))completion;

/**
Log out all the accounts after asking for a potential confirmation.
Show the authentication screen on successful logout.
Expand Down Expand Up @@ -252,19 +255,6 @@ UINavigationControllerDelegate
*/
- (BOOL)handleUniversalLinkWithParameters:(UniversalLinkParameters*)parameters;

/**
Extract params from the URL fragment part (after '#') of a vector.im Universal link:
The fragment can contain a '?'. So there are two kinds of parameters: path params and query params.
It is in the form of /[pathParam1]/[pathParam2]?[queryParam1Key]=[queryParam1Value]&[queryParam2Key]=[queryParam2Value]
@note this method should be private but is used by RoomViewController. This should be moved to a univresal link parser class
@param fragment the fragment to parse.
@param outPathParams the decoded path params.
@param outQueryParams the decoded query params. If there is no query params, it will be nil.
*/
- (void)parseUniversalLinkFragment:(NSString*)fragment outPathParams:(NSArray<NSString*> **)outPathParams outQueryParams:(NSMutableDictionary **)outQueryParams;

/**
Open the dedicated space with the given ID.
Expand Down
211 changes: 38 additions & 173 deletions Riot/Modules/Application/LegacyAppDelegate.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1170,19 +1170,17 @@ - (BOOL)handleUniversalLink:(NSUserActivity*)userActivity
webURL = [Tools fixURLWithSeveralHashKeys:webURL];

// Extract required parameters from the link
NSArray<NSString*> *pathParams;
NSMutableDictionary *queryParams;
[self parseUniversalLinkFragment:webURL.absoluteString outPathParams:&pathParams outQueryParams:&queryParams];
UniversalLink *newLink = [[UniversalLink alloc] initWithUrl:webURL];
NSDictionary<NSString*, NSString*> *queryParams = newLink.queryParams;

UniversalLink *newLink = [[UniversalLink alloc] initWithUrl:webURL pathParams:pathParams queryParams:queryParams];
if (![_lastHandledUniversalLink isEqual:newLink])
{
_lastHandledUniversalLink = [[UniversalLink alloc] initWithUrl:webURL pathParams:pathParams queryParams:queryParams];
_lastHandledUniversalLink = newLink;
// notify this change
[[NSNotificationCenter defaultCenter] postNotificationName:AppDelegateUniversalLinkDidChangeNotification object:nil];
}

if ([self handleServerProvisioningLink:webURL])
if ([AuthenticationService.shared handleServerProvisioningLink:newLink])
{
return YES;
}
Expand Down Expand Up @@ -1281,28 +1279,27 @@ - (BOOL)handleUniversalLink:(NSUserActivity*)userActivity
return YES;
}

return [self handleUniversalLinkFragment:webURL.fragment fromURL:webURL];
return [self handleUniversalLinkFragment:webURL.fragment fromLink:newLink];
}

- (BOOL)handleUniversalLinkFragment:(NSString*)fragment fromURL:(NSURL*)universalLinkURL

- (BOOL)handleUniversalLinkFragment:(NSString*)fragment fromLink:(UniversalLink*)universalLink
{
if (!fragment || !universalLinkURL)
if (!fragment || !universalLink)
{
MXLogDebug(@"[AppDelegate] Cannot handle universal link with missing data: %@ %@", fragment, universalLinkURL);
MXLogDebug(@"[AppDelegate] Cannot handle universal link with missing data: %@ %@", fragment, universalLink.url);
return NO;
}
ScreenPresentationParameters *presentationParameters = [[ScreenPresentationParameters alloc] initWithRestoreInitialDisplay:YES stackAboveVisibleViews:NO];

UniversalLinkParameters *parameters = [[UniversalLinkParameters alloc] initWithFragment:fragment universalLinkURL:universalLinkURL presentationParameters:presentationParameters];
UniversalLinkParameters *parameters = [[UniversalLinkParameters alloc] initWithFragment:fragment universalLink:universalLink presentationParameters:presentationParameters];

return [self handleUniversalLinkWithParameters:parameters];
}

- (BOOL)handleUniversalLinkWithParameters:(UniversalLinkParameters*)universalLinkParameters
{
NSString *fragment = universalLinkParameters.fragment;
NSURL *universalLinkURL = universalLinkParameters.universalLinkURL;
UniversalLink *universalLink = universalLinkParameters.universalLink;
ScreenPresentationParameters *presentationParameters = universalLinkParameters.presentationParameters;
BOOL restoreInitialDisplay = presentationParameters.restoreInitialDisplay;

Expand All @@ -1320,9 +1317,8 @@ - (BOOL)handleUniversalLinkWithParameters:(UniversalLinkParameters*)universalLin
[self resetPendingUniversalLink];

// Extract params
NSArray<NSString*> *pathParams;
NSMutableDictionary *queryParams;
[self parseUniversalLinkFragment:fragment outPathParams:&pathParams outQueryParams:&queryParams];
NSArray<NSString*> *pathParams = universalLink.pathParams;
NSDictionary<NSString*, NSString*> *queryParams = universalLink.queryParams;

// Sanity check
if (!pathParams.count)
Expand Down Expand Up @@ -1506,7 +1502,7 @@ - (BOOL)handleUniversalLinkWithParameters:(UniversalLinkParameters*)universalLin
self->universalLinkFragmentPendingRoomAlias = @{resolution.roomId: roomIdOrAlias};

UniversalLinkParameters *newParameters = [[UniversalLinkParameters alloc] initWithFragment:newFragment
universalLinkURL:universalLinkURL
universalLink:universalLink
presentationParameters:presentationParameters];
[self handleUniversalLinkWithParameters:newParameters];
}
Expand Down Expand Up @@ -1692,14 +1688,6 @@ - (BOOL)handleUniversalLinkWithParameters:(UniversalLinkParameters*)universalLin
}];
}
}
// Check whether this is a registration links.
else if ([pathParams[0] isEqualToString:@"register"])
{
MXLogDebug(@"[AppDelegate] Universal link with registration parameters");
continueUserActivity = YES;

[_masterTabBarController showOnboardingFlowWithRegistrationParameters:queryParams];
}
else
{
// Unknown command: Do nothing except coming back to the main screen
Expand Down Expand Up @@ -1764,167 +1752,44 @@ - (void)peekInRoomWithNavigationParameters:(RoomPreviewNavigationParameters*)pre
}];
}

/**
Extract params from the URL fragment part (after '#') of a vector.im Universal link:
The fragment can contain a '?'. So there are two kinds of parameters: path params and query params.
It is in the form of /[pathParam1]/[pathParam2]?[queryParam1Key]=[queryParam1Value]&[queryParam2Key]=[queryParam2Value]
@param fragment the fragment to parse.
@param outPathParams the decoded path params.
@param outQueryParams the decoded query params. If there is no query params, it will be nil.
*/
- (void)parseUniversalLinkFragment:(NSString*)fragment outPathParams:(NSArray<NSString*> **)outPathParams outQueryParams:(NSMutableDictionary **)outQueryParams
{
NSParameterAssert(outPathParams && outQueryParams);

NSArray<NSString*> *pathParams;
NSMutableDictionary *queryParams;

NSArray<NSString*> *fragments = [fragment componentsSeparatedByString:@"?"];

// Extract path params
pathParams = [fragments[0] componentsSeparatedByString:@"/"];

// Remove the first empty path param string
pathParams = [pathParams filteredArrayUsingPredicate:[NSPredicate predicateWithFormat:@"length > 0"]];

// URL decode each path param
NSMutableArray<NSString*> *pathParams2 = [NSMutableArray arrayWithArray:pathParams];
for (NSInteger i = 0; i < pathParams.count; i++)
{
pathParams2[i] = [pathParams2[i] stringByRemovingPercentEncoding];
}
pathParams = pathParams2;

// Extract query params if any
// Query params are in the form [queryParam1Key]=[queryParam1Value], so the
// presence of at least one '=' character is mandatory
if (fragments.count == 2 && (NSNotFound != [fragments[1] rangeOfString:@"="].location))
{
queryParams = [[NSMutableDictionary alloc] init];
for (NSString *keyValue in [fragments[1] componentsSeparatedByString:@"&"])
{
// Get the parameter name
NSString *key = [keyValue componentsSeparatedByString:@"="][0];

// Get the parameter value
NSString *value = [keyValue componentsSeparatedByString:@"="][1];
if (value.length)
{
value = [value stringByReplacingOccurrencesOfString:@"+" withString:@" "];
value = [value stringByRemovingPercentEncoding];

if ([key isEqualToString:@"via"])
{
// Special case the via parameter
// As we can have several of them, store each value into an array
if (!queryParams[key])
{
queryParams[key] = [NSMutableArray array];
}

[queryParams[key] addObject:value];
}
else
{
queryParams[key] = value;
}
}
}
}

*outPathParams = pathParams;
*outQueryParams = queryParams;
}

/**
Parse and handle a server provisioning link. Returns `YES` if a provisioning link was detected and handled.
@param link A link such as https://mobile.element.io/?hs_url=matrix.example.com&is_url=identity.example.com
*/
- (BOOL)handleServerProvisioningLink:(NSURL*)link
{
MXLogDebug(@"[AppDelegate] handleServerProvisioningLink: %@", link);

NSString *homeserver, *identityServer;
[self parseServerProvisioningLink:link homeserver:&homeserver identityServer:&identityServer];

if (homeserver)
{
if ([MXKAccountManager sharedManager].activeAccounts.count)
{
[self displayServerProvisioningLinkBuyAlreadyLoggedInAlertWithCompletion:^(BOOL logout) {

MXLogDebug(@"[AppDelegate] handleServerProvisioningLink: logoutWithConfirmation: logout: %@", @(logout));
if (logout)
{
[self logoutWithConfirmation:NO completion:^(BOOL isLoggedOut) {
[self handleServerProvisioningLink:link];
}];
}
}];
}
else
{
[_masterTabBarController showOnboardingFlow];
[_masterTabBarController.onboardingCoordinatorBridgePresenter updateHomeserver:homeserver andIdentityServer:identityServer];
}

return YES;
}

return NO;
}

- (void)parseServerProvisioningLink:(NSURL*)link homeserver:(NSString**)homeserver identityServer:(NSString**)identityServer
{
if ([link.path isEqualToString:@"/"])
{
NSURLComponents *linkURLComponents = [NSURLComponents componentsWithURL:link resolvingAgainstBaseURL:NO];
for (NSURLQueryItem *item in linkURLComponents.queryItems)
{
if ([item.name isEqualToString:@"hs_url"])
{
*homeserver = item.value;
}
else if ([item.name isEqualToString:@"is_url"])
{
*identityServer = item.value;
break;
}
}
}
else
{
MXLogDebug(@"[AppDelegate] parseServerProvisioningLink: Error: Unknown path: %@", link.path);
}


MXLogDebug(@"[AppDelegate] parseServerProvisioningLink: homeserver: %@ - identityServer: %@", *homeserver, *identityServer);
}

- (void)displayServerProvisioningLinkBuyAlreadyLoggedInAlertWithCompletion:(void (^)(BOOL logout))completion
- (void)displayLogoutConfirmationForLink:(UniversalLink *)link
completion:(void (^)(BOOL loggedOut))completion
{
// Ask confirmation
self.logoutConfirmation = [UIAlertController alertControllerWithTitle:[VectorL10n errorUserAlreadyLoggedIn] message:nil preferredStyle:UIAlertControllerStyleAlert];
self.logoutConfirmation = [UIAlertController alertControllerWithTitle:[VectorL10n errorUserAlreadyLoggedIn]
message:nil
preferredStyle:UIAlertControllerStyleAlert];

[self.logoutConfirmation addAction:[UIAlertAction actionWithTitle:[VectorL10n settingsSignOut]
style:UIAlertActionStyleDefault
handler:^(UIAlertAction * action)
{
self.logoutConfirmation = nil;
completion(YES);
}]];
self.logoutConfirmation = nil;
[self logoutWithConfirmation:NO completion:^(BOOL isLoggedOut) {
if (isLoggedOut)
{
// process the link again after logging out
[AuthenticationService.shared handleServerProvisioningLink:link];
}
if (completion)
{
completion(YES);
}
}];
}]];

[self.logoutConfirmation addAction:[UIAlertAction actionWithTitle:[VectorL10n cancel]
style:UIAlertActionStyleCancel
handler:^(UIAlertAction * action)
{
self.logoutConfirmation = nil;
completion(NO);
}]];
self.logoutConfirmation = nil;
if (completion)
{
completion(NO);
}
}]];

[self.logoutConfirmation mxk_setAccessibilityIdentifier: @"AppDelegateLogoutConfirmationAlert"];
[self.logoutConfirmation mxk_setAccessibilityIdentifier:@"AppDelegateLogoutConfirmationAlert"];
[self showNotificationAlert:self.logoutConfirmation];
}

Expand Down
11 changes: 2 additions & 9 deletions Riot/Modules/Authentication/AuthenticationCoordinatorProtocol.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,10 @@ protocol AuthenticationCoordinatorProtocol: Coordinator, Presentable {

/// Update the screen to display registration or login.
func update(authenticationFlow: AuthenticationFlow)

/// Force a registration process based on a predefined set of parameters from a server provisioning link.
/// For more information see `AuthenticationViewController.externalRegistrationParameters`.
func update(externalRegistrationParameters: [AnyHashable: Any])


/// Update the screen to use any credentials to use after a soft logout has taken place.
func update(softLogoutCredentials: MXCredentials)

/// Set up the authentication screen with the specified homeserver and/or identity server.
func updateHomeserver(_ homeserver: String?, andIdentityServer identityServer: String?)


/// Indicates to the coordinator to display any pending screens if it was created with
/// the `canPresentAdditionalScreens` parameter set to `false`
func presentPendingScreensIfNecessary()
Expand Down
19 changes: 10 additions & 9 deletions Riot/Modules/Authentication/LegacyAuthenticationCoordinator.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,18 +87,10 @@ final class LegacyAuthenticationCoordinator: NSObject, AuthenticationCoordinator
authenticationViewController.authType = authenticationFlow.mxkType
}

func update(externalRegistrationParameters: [AnyHashable: Any]) {
authenticationViewController.externalRegistrationParameters = externalRegistrationParameters
}

func update(softLogoutCredentials: MXCredentials) {
authenticationViewController.softLogoutCredentials = softLogoutCredentials
}

func updateHomeserver(_ homeserver: String?, andIdentityServer identityServer: String?) {
authenticationViewController.showCustomHomeserver(homeserver, andIdentityServer: identityServer)
}


func presentPendingScreensIfNecessary() {
canPresentAdditionalScreens = true

Expand Down Expand Up @@ -150,6 +142,15 @@ extension LegacyAuthenticationCoordinator: AuthenticationServiceDelegate {
func authenticationService(_ service: AuthenticationService, didReceive ssoLoginToken: String, with transactionID: String) -> Bool {
authenticationViewController.continueSSOLogin(withToken: ssoLoginToken, txnId: transactionID)
}

func authenticationService(_ service: AuthenticationService, didUpdateStateWithLink link: UniversalLink) {
if link.pathParams.first == "register" && !link.queryParams.isEmpty {
authenticationViewController.externalRegistrationParameters = link.queryParams
} else if let homeserver = link.homeserverUrl {
let identityServer = link.identityServerUrl
authenticationViewController.showCustomHomeserver(homeserver, andIdentityServer: identityServer)
}
}
}

// MARK: - AuthenticationViewControllerDelegate
Expand Down
Loading

0 comments on commit ceae4a4

Please sign in to comment.