Refactor callbacks for opening a new window.

ios/web/public/web_state/ui/crw_web_delegate.h

 // Copyright 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef IOS_WEB_PUBLIC_WEB_STATE_UI_CRW_WEB_DELEGATE_H_
 #define IOS_WEB_PUBLIC_WEB_STATE_UI_CRW_WEB_DELEGATE_H_
 
 #include <stdint.h>
 #import <UIKit/UIKit.h>
 #include <vector>
 
 #import "base/ios/block_types.h"
 #include "ios/web/public/favicon_url.h"
 #import "ios/web/public/navigation_manager.h"
 #include "ios/web/public/ssl_status.h"
 #import "ios/web/public/web_state/ui/crw_native_content.h"
 #import "ios/web/public/web_state/web_state.h"
 #include "ui/base/page_transition_types.h"
 
 class GURL;
 @class CRWSessionEntry;
 @class CRWWebController;
 
-namespace web {
-class BlockedPopupInfo;
-struct Referrer;
-}
-
 // Methods implemented by the delegate of the CRWWebController.
 // DEPRECATED, do not conform to this protocol and do not add any methods to it.
 // Use web::WebStateDelegate instead.
 // TODO(crbug.com/674991): Remove this protocol.
 @protocol CRWWebDelegate<NSObject>
 
-// Called when the page wants to open a new window by DOM (e.g. with
-// |window.open| JavaScript call or by clicking a link with |_blank| target) or
-// wants to open a window with a new tab. |inBackground| allows a page to force
-// a new window to open in the background. CRWSessionController's openedByDOM
-// property of the returned CRWWebController must be YES.
-- (CRWWebController*)webPageOrderedOpen:(const GURL&)url
-                               referrer:(const web::Referrer&)referrer
-                             windowName:(NSString*)windowName
-                           inBackground:(BOOL)inBackground;
-
-// Called when the page wants to open a new window by DOM.
-// CRWSessionController's openedByDOM property of the returned CRWWebController
-// must be YES.
-- (CRWWebController*)webPageOrderedOpen;
-
 // Called when the page calls window.close() on itself. Begin the shut-down
 // sequence for this controller.
 - (void)webPageOrderedClose;
 // Called when an external app needs to be opened, it also passes |linkClicked|
 // to track if this call was a result of user action or not. Returns YES iff
 // |URL| is launched in an external app.
 - (BOOL)openExternalURL:(const GURL&)URL linkClicked:(BOOL)linkClicked;
 
 // This method is invoked whenever the system believes the URL is about to
 // change, or immediately after any unexpected change of the URL, prior to
@@ skipping 36 matching lines @@
 // TODO(rohitrao): This is not a great API.  Clean it up.
 - (void)webWillInitiateLoadWithParams:
     (web::NavigationManager::WebLoadParams&)params;
 - (void)webDidUpdateSessionForLoadWithParams:
             (const web::NavigationManager::WebLoadParams&)params
                         wasInitialNavigation:(BOOL)initialNavigation;
 // Called from finishHistoryNavigationFromEntry.
 - (void)webWillFinishHistoryNavigationFromEntry:(CRWSessionEntry*)fromEntry;
 // ---------------------------------------------------------------------
 
+// Called when |webController| wants to open a new window. |URL| is the URL of
+// the new window; |openerURL| is the URL of the page which requested a window
+// to be open; |initiatedByUser| is YES if action was caused by the user.
+// |webController| will not open a window if this method returns nil. This
+// method can not return |webController|.
+- (CRWWebController*)webController:(CRWWebController*)webController
+         createWebControllerForURL:(const GURL&)URL

[marq (ping after 24h), 2017/02/15 10:34:10]

Naming nit: Delegate methods that return something don't usually include a verb
like 'create' -- compare to tableView:cellForRowAtIndexPath:. I think
webController:webControllerForURL:openerURL:initiatedByUser: is fine, and it
doesn't imply that the delegate necessarily has to "create" a new webController
(although they very likely will).

[Eugene But (OOO till 7-30), 2017/02/15 16:46:59]

Modeled from
|webView:createWebViewWithConfiguration:forNavigationAction:windowFeatures:|
which I think appropriately has "create" word, because there is a concrete side
effect for this action (creating a new UI window). In any case, this method will
be removed in subsequent CL in favor or WebStateDelegate method, so I would
prefer to leave it as it is.

[marq (ping after 24h), 2017/02/16 12:49:44]

Given that, I'm OK with leaving it as is.

+                         openerURL:(const GURL&)openerURL
+                   initiatedByUser:(BOOL)initiatedByUser;
+
 @optional
 
 // Called to ask CRWWebDelegate if |CRWWebController| should open the given URL.
 // CRWWebDelegate can intercept the request by returning NO and processing URL
 // in own way.
 - (BOOL)webController:(CRWWebController*)webController
         shouldOpenURL:(const GURL&)url
       mainDocumentURL:(const GURL&)mainDocumentURL
           linkClicked:(BOOL)linkClicked;
 
@@ skipping 17 matching lines @@
 // Called to ask the delegate for a controller to display the given url,
 // which contained content that the UIWebView couldn't display. Returns
 // the native controller to display if the delegate can handle the url,
 // or nil otherwise.
 - (id<CRWNativeContent>)controllerForUnhandledContentAtURL:(const GURL&)url;
 
 // Called when the page supplies a new title.
 - (void)webController:(CRWWebController*)webController
        titleDidChange:(NSString*)title;
 
-// Called when CRWWebController has detected a popup. If NO is returned then
-// popup will be shown, otherwise |webController:didBlockPopup:| will be called
-// and CRWWebDelegate will have a chance to unblock the popup later. NO is
-// assumed by default if this method is not implemented.
-- (BOOL)webController:(CRWWebController*)webController
-    shouldBlockPopupWithURL:(const GURL&)popupURL
-                  sourceURL:(const GURL&)sourceURL;
-
-// Called when CRWWebController has detected and blocked a popup. In order to
-// allow the blocked pop up CRWWebDelegate must call
-// |blockedPopupInfo.ShowPopup()| instead of attempting to open a new window.
-- (void)webController:(CRWWebController*)webController
-        didBlockPopup:(const web::BlockedPopupInfo&)blockedPopupInfo;
-
 // Called when CRWWebController did suppress a dialog (JavaScript, HTTP
 // authentication or window.open).
 // NOTE: Called only if CRWWebController.shouldSuppressDialogs is set to YES.
 - (void)webControllerDidSuppressDialog:(CRWWebController*)webController;
 
 // Called to retrieve the height of any header that is overlaying on top of the
 // web view. This can be used to implement, for e.g. a toolbar that changes
 // height dynamically. Returning a non-zero height affects the visible frame
 // shown by the CRWWebController. 0.0 is assumed if not implemented.
 - (CGFloat)headerHeightForWebController:(CRWWebController*)webController;
 
 // Called when CRWWebController updated the SSL status for the current
 // NagivationItem.
 - (void)webControllerDidUpdateSSLStatusForCurrentNavigationItem:
     (CRWWebController*)webController;
 
 // Called when a PassKit file is downloaded. |data| should be the data from a
 // PassKit file, but this is not guaranteed, and the delegate is responsible for
 // error handling non PassKit data using -[PKPass initWithData:error:]. If the
 // download does not successfully complete, |data| will be nil.
 - (void)webController:(CRWWebController*)webController
     didLoadPassKitObject:(NSData*)data;
 
 @end
 
 #endif  // IOS_WEB_PUBLIC_WEB_STATE_UI_CRW_WEB_DELEGATE_H_