// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef IOS_WEB_CONTENT_WEB_STATE_CONTENT_WEB_STATE_H_
#define IOS_WEB_CONTENT_WEB_STATE_CONTENT_WEB_STATE_H_
#import "ios/web/public/web_state.h"
#import <memory>
#import <optional>
#import <UIKit/UIKit.h>
#import "base/observer_list.h"
#import "build/blink_buildflags.h"
#import "content/public/browser/web_contents_delegate.h"
#import "content/public/browser/web_contents_observer.h"
#import "ios/web/content/js_messaging/content_web_frames_manager.h"
#import "ios/web/content/navigation/content_navigation_manager.h"
#import "ios/web/public/favicon/favicon_status.h"
#import "ios/web/public/session/session_certificate_policy_cache.h"
#import "ios/web/public/web_state_id.h"
@class CRCWebViewportContainerView;
@class CRWWebViewProxy;
#if !BUILDFLAG(USE_BLINK)
#error File can only be included when USE_BLINK is true
#endif
namespace blink {
namespace mojom {
class FileChooserParams;
}
} // namespace blink
namespace content {
class FileSelectListener;
class NavigationEntry;
class NavigationHandle;
class RenderFrameHost;
class WebContents;
} // namespace content
namespace web {
// ContentWebState is an implementation of WebState that's based on WebContents.
class ContentWebState : public WebState,
public content::WebContentsObserver,
public content::WebContentsDelegate {
public:
explicit ContentWebState(const CreateParams& params);
// Constructor for ContentWebState created for deserialized sessions.
ContentWebState(const CreateParams& params,
CRWSessionStorage* session_storage,
NativeSessionFetcher session_fetcher);
// Constructor for ContentWebState created for deserialized sessions.
ContentWebState(BrowserState* browser_state,
WebStateID unique_identifier,
proto::WebStateMetadataStorage metadata,
WebStateStorageLoader storage_loader,
NativeSessionFetcher session_fetcher);
~ContentWebState() override;
// Returns the WebContents owned by this ContentWebState.
content::WebContents* GetWebContents();
// WebState implementation.
void SerializeToProto(proto::WebStateStorage& storage) const override;
void SerializeMetadataToProto(
proto::WebStateMetadataStorage& storage) const override;
WebStateDelegate* GetDelegate() override;
void SetDelegate(WebStateDelegate* delegate) override;
std::unique_ptr<WebState> Clone() const override;
bool IsRealized() const final;
WebState* ForceRealized() final;
bool IsWebUsageEnabled() const override;
void SetWebUsageEnabled(bool enabled) override;
UIView* GetView() override;
void DidCoverWebContent() override;
void DidRevealWebContent() override;
base::Time GetLastActiveTime() const final;
base::Time GetCreationTime() const final;
void WasShown() override;
void WasHidden() override;
void SetKeepRenderProcessAlive(bool keep_alive) override;
BrowserState* GetBrowserState() const override;
base::WeakPtr<WebState> GetWeakPtr() override;
void OpenURL(const OpenURLParams& params) override;
void LoadSimulatedRequest(const GURL& url,
NSString* response_html_string) override
API_AVAILABLE(ios(15.0));
void LoadSimulatedRequest(const GURL& url,
NSData* response_data,
NSString* mime_type) override
API_AVAILABLE(ios(15.0));
void Stop() override;
const NavigationManager* GetNavigationManager() const override;
NavigationManager* GetNavigationManager() override;
WebFramesManager* GetPageWorldWebFramesManager() override;
const SessionCertificatePolicyCache* GetSessionCertificatePolicyCache()
const override;
SessionCertificatePolicyCache* GetSessionCertificatePolicyCache() override;
CRWSessionStorage* BuildSessionStorage() const override;
void LoadData(NSData* data, NSString* mime_type, const GURL& url) override;
void ExecuteUserJavaScript(NSString* javaScript) override;
NSString* GetStableIdentifier() const override;
WebStateID GetUniqueIdentifier() const override;
const std::string& GetContentsMimeType() const override;
bool ContentIsHTML() const override;
const std::u16string& GetTitle() const override;
bool IsLoading() const override;
double GetLoadingProgress() const override;
void SetLoadingProgress(double progress);
bool IsVisible() const override;
bool IsCrashed() const override;
bool IsEvicted() const override;
bool IsBeingDestroyed() const override;
bool IsWebPageInFullscreenMode() const override;
const FaviconStatus& GetFaviconStatus() const final;
void SetFaviconStatus(const FaviconStatus& favicon_status) final;
int GetNavigationItemCount() const override;
const GURL& GetVisibleURL() const override;
const GURL& GetLastCommittedURL() const override;
std::optional<GURL> GetLastCommittedURLIfTrusted() const override;
WebFramesManager* GetWebFramesManager(ContentWorld world) override;
CRWWebViewProxyType GetWebViewProxy() const override;
void AddObserver(WebStateObserver* observer) override;
void RemoveObserver(WebStateObserver* observer) override;
void CloseWebState() override;
bool SetSessionStateData(NSData* data) override;
NSData* SessionStateData() override;
PermissionState GetStateForPermission(Permission permission) const override
API_AVAILABLE(ios(15.0));
void SetStateForPermission(PermissionState state,
Permission permission) override
API_AVAILABLE(ios(15.0));
NSDictionary<NSNumber*, NSNumber*>* GetStatesForAllPermissions()
const override API_AVAILABLE(ios(15.0));
void DownloadCurrentPage(NSString* destination_file,
id<CRWWebViewDownloadDelegate> delegate,
void (^handler)(id<CRWWebViewDownload>)) override
API_AVAILABLE(ios(14.5));
bool IsFindInteractionSupported() final;
bool IsFindInteractionEnabled() final;
void SetFindInteractionEnabled(bool enabled) final;
id<CRWFindInteraction> GetFindInteraction() final API_AVAILABLE(ios(16));
id GetActivityItem() API_AVAILABLE(ios(16.4)) final;
UIColor* GetThemeColor() final;
UIColor* GetUnderPageBackgroundColor() final;
void AddPolicyDecider(WebStatePolicyDecider* decider) override;
void RemovePolicyDecider(WebStatePolicyDecider* decider) override;
void DidChangeVisibleSecurityState() override;
bool HasOpener() const override;
void SetHasOpener(bool has_opener) override;
bool CanTakeSnapshot() const override;
void TakeSnapshot(const CGRect rect, SnapshotCallback callback) override;
void CreateFullPagePdf(base::OnceCallback<void(NSData*)> callback) override;
void CloseMediaPresentations() override;
protected:
// WebContentsObserver
void DidStartNavigation(
content::NavigationHandle* navigation_handle) override;
void DidRedirectNavigation(
content::NavigationHandle* navigation_handle) override;
void DidFinishNavigation(
content::NavigationHandle* navigation_handle) override;
void DidStartLoading() override;
void DidStopLoading() override;
void DidFinishLoad(content::RenderFrameHost* render_frame_host,
const GURL& validated_url) override;
void DidFailLoad(content::RenderFrameHost* render_frame_host,
const GURL& validated_url,
int error_code) override;
void LoadProgressChanged(double progress) override;
void OnVisibilityChanged(content::Visibility visibility) override;
void TitleWasSet(content::NavigationEntry* entry) override;
void DidUpdateFaviconURL(
content::RenderFrameHost* render_frame_host,
const std::vector<blink::mojom::FaviconURLPtr>& candidates) override;
void RenderFrameCreated(content::RenderFrameHost* render_frame_host) override;
void RenderFrameDeleted(content::RenderFrameHost* render_frame_host) override;
void DocumentOnLoadCompletedInPrimaryMainFrame() override;
void RenderFrameHostStateChanged(
content::RenderFrameHost* render_frame_host,
content::RenderFrameHost::LifecycleState old_state,
content::RenderFrameHost::LifecycleState new_state) override;
void PrimaryMainFrameRenderProcessGone(
base::TerminationStatus status) override;
// WebContentsDelegate
content::WebContents* AddNewContents(
content::WebContents* source,
std::unique_ptr<content::WebContents> new_contents,
const GURL& target_url,
WindowOpenDisposition disposition,
const blink::mojom::WindowFeatures& window_features,
bool user_gesture,
bool* was_blocked) override;
int GetTopControlsHeight() override;
int GetTopControlsMinHeight() override;
int GetBottomControlsHeight() override;
int GetBottomControlsMinHeight() override;
bool ShouldAnimateBrowserControlsHeightChanges() override;
bool DoBrowserControlsShrinkRendererSize(
content::WebContents* web_contents) override;
int GetVirtualKeyboardHeight(content::WebContents* web_contents) override;
bool OnlyExpandTopControlsAtPageTop() override;
void SetTopControlsGestureScrollInProgress(bool in_progress) override;
std::unique_ptr<content::ColorChooser> OpenColorChooser(
content::WebContents* web_contents,
SkColor color,
const std::vector<blink::mojom::ColorSuggestionPtr>& suggestions)
override;
void RunFileChooser(content::RenderFrameHost* render_frame_host,
scoped_refptr<content::FileSelectListener> listener,
const blink::mojom::FileChooserParams& params) override;
private:
// Helper method to register notification observers.
void RegisterNotificationObservers();
void OnKeyboardShow(NSNotification* notification);
void OnKeyboardHide(NSNotification* notification);
WebStateDelegate* delegate_ = nullptr;
CRCWebViewportContainerView* web_view_;
CRWSessionStorage* session_storage_;
std::unique_ptr<content::WebContents> web_contents_;
std::unique_ptr<content::WebContents> child_web_contents_;
std::unique_ptr<web::SessionCertificatePolicyCache> certificate_policy_cache_;
id<CRWWebViewProxy> web_view_proxy_;
NSString* UUID_;
// The unique identifier. Stable across application restarts.
const WebStateID unique_identifier_;
base::ObserverList<WebStatePolicyDecider, true> policy_deciders_;
base::ObserverList<WebStateObserver, true> observers_;
std::unique_ptr<ContentNavigationManager> navigation_manager_;
std::unique_ptr<ContentWebFramesManager> web_frames_manager_;
FaviconStatus favicon_status_;
bool top_control_scroll_in_progress_ = false;
bool cached_shrink_controls_ = false;
bool created_with_opener_ = false;
id keyboard_showing_observer_;
id keyboard_hiding_observer_;
int keyboard_height_ = 0;
// The time that this ContentWebState was last made active. The initial value
// is the ContentWebState's creation time.
base::Time last_active_time_;
// The ContentWebState's creation time.
base::Time creation_time_;
base::WeakPtrFactory<ContentWebState> weak_factory_{this};
};
} // namespace web
#endif // IOS_WEB_CONTENT_WEB_STATE_CONTENT_WEB_STATE_H_
Codebase Browser
chromium