Kevin Kuehler
c5677c6be5
* Use NavigationEntryCommitted() instead of DidNavigationFinish(). We
have no guarantees about the next DidNavigationStart() being called
first.
* Fix throttle unit test
* Make several review requests to SpeedreaderBrowserTest
111 lines
3.8 KiB
C++
111 lines
3.8 KiB
C++
/* Copyright (c) 2020 The Brave Authors. All rights reserved.
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef BRAVE_BROWSER_SPEEDREADER_SPEEDREADER_TAB_HELPER_H_
|
|
#define BRAVE_BROWSER_SPEEDREADER_SPEEDREADER_TAB_HELPER_H_
|
|
|
|
#include "base/memory/weak_ptr.h"
|
|
#include "brave/components/speedreader/speedreader_result_delegate.h"
|
|
#include "brave/components/speedreader/speedreader_util.h"
|
|
#include "content/public/browser/web_contents_observer.h"
|
|
#include "content/public/browser/web_contents_user_data.h"
|
|
|
|
namespace content {
|
|
class NavigationEntry;
|
|
class NavigationHandle;
|
|
class WebContents;
|
|
} // namespace content
|
|
|
|
namespace speedreader {
|
|
|
|
class SpeedreaderBubbleView;
|
|
|
|
// Determines if speedreader should be active for a given top-level navigation.
|
|
class SpeedreaderTabHelper
|
|
: public content::WebContentsObserver,
|
|
public content::WebContentsUserData<SpeedreaderTabHelper>,
|
|
public SpeedreaderResultDelegate {
|
|
public:
|
|
~SpeedreaderTabHelper() override;
|
|
|
|
SpeedreaderTabHelper(const SpeedreaderTabHelper&) = delete;
|
|
SpeedreaderTabHelper& operator=(SpeedreaderTabHelper&) = delete;
|
|
|
|
base::WeakPtr<SpeedreaderTabHelper> GetWeakPtr();
|
|
|
|
// Returns |true| if Speedreader is turned on for all sites.
|
|
bool IsSpeedreaderEnabled() const;
|
|
|
|
// Returns |true| if the user has enabled Speedreader but the domain in the
|
|
// active web contents is blacklisted.
|
|
bool IsEnabledForSite();
|
|
|
|
DistillState PageDistillState() const { return distill_state_; }
|
|
|
|
// Allow or deny a site from being run through speedreader if |on| toggles
|
|
// the setting. Triggers page reload on toggle.
|
|
void MaybeToggleEnabledForSite(bool on);
|
|
|
|
// Reload the page and mark the next request to run through Speedreader,
|
|
// without turning it on. This mimics the standard reader mode.
|
|
void SingleShotSpeedreader();
|
|
|
|
// returns nullptr if no bubble currently shown
|
|
SpeedreaderBubbleView* speedreader_bubble_view() const;
|
|
|
|
// Displays speedreader information
|
|
void ShowSpeedreaderBubble();
|
|
|
|
// Displays reader mode information
|
|
void ShowReaderModeBubble();
|
|
|
|
// Hides speedreader information
|
|
void HideBubble();
|
|
|
|
// Handler for when the bubble is dismissed.
|
|
void OnBubbleClosed();
|
|
|
|
private:
|
|
friend class content::WebContentsUserData<SpeedreaderTabHelper>;
|
|
explicit SpeedreaderTabHelper(content::WebContents* web_contents);
|
|
|
|
// Called by ShowSpeedreaderBubble and ShowReaderModeBubble.
|
|
// |is_bubble_speedreader| will show a bubble for pages in Speedreader if set
|
|
// to true, otherwise pages in reader mode.
|
|
void ShowBubble(bool is_bubble_speedreader);
|
|
|
|
// Returns |true| if the user has enabled Speedreader but the URL is
|
|
// blacklisted. This method is used when the URL we want to check has not been
|
|
// committed to the WebContents.
|
|
bool IsEnabledForSite(const GURL& url);
|
|
|
|
bool MaybeUpdateCachedState(content::NavigationHandle* handle);
|
|
void UpdateActiveState(content::NavigationHandle* handle);
|
|
void SetNextRequestState(DistillState state);
|
|
|
|
// content::WebContentsObserver
|
|
void DidStartNavigation(
|
|
content::NavigationHandle* navigation_handle) override;
|
|
void DidRedirectNavigation(
|
|
content::NavigationHandle* navigation_handle) override;
|
|
void DidStopLoading() override;
|
|
|
|
// SpeedreaderResultDelegate:
|
|
void OnDistillComplete() override;
|
|
|
|
bool single_shot_next_request_ =
|
|
false; // run speedreader once on next page load
|
|
DistillState distill_state_ = DistillState::kNone;
|
|
SpeedreaderBubbleView* speedreader_bubble_ = nullptr;
|
|
|
|
base::WeakPtrFactory<SpeedreaderTabHelper> weak_factory_{this};
|
|
|
|
WEB_CONTENTS_USER_DATA_KEY_DECL();
|
|
};
|
|
|
|
} // namespace speedreader
|
|
|
|
#endif // BRAVE_BROWSER_SPEEDREADER_SPEEDREADER_TAB_HELPER_H_
|