1 // Copyright 2013 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef CHROME_BROWSER_SIGNIN_SIGNIN_PROMO_H_ 6 #define CHROME_BROWSER_SIGNIN_SIGNIN_PROMO_H_ 7 8 #include <string> 9 10 #include "base/basictypes.h" 11 12 class GURL; 13 class Profile; 14 15 namespace user_prefs { 16 class PrefRegistrySyncable; 17 } 18 19 // Utility functions for sign in promos. 20 namespace signin { 21 22 const char kSignInPromoQueryKeyAutoClose[] = "auto_close"; 23 const char kSignInPromoQueryKeyContinue[] = "continue"; 24 const char kSignInPromoQueryKeySource[] = "source"; 25 const char kSignInPromoQueryKeyConstrained[] = "constrained"; 26 const char kSignInPromoQueryKeyShowAccountManagement[] = 27 "showAccountManagement"; 28 29 enum Source { 30 SOURCE_START_PAGE = 0, // This must be first. 31 SOURCE_NTP_LINK, 32 SOURCE_MENU, 33 SOURCE_SETTINGS, 34 SOURCE_EXTENSION_INSTALL_BUBBLE, 35 SOURCE_WEBSTORE_INSTALL, 36 SOURCE_APP_LAUNCHER, 37 SOURCE_APPS_PAGE_LINK, 38 SOURCE_BOOKMARK_BUBBLE, 39 SOURCE_AVATAR_BUBBLE_SIGN_IN, 40 SOURCE_AVATAR_BUBBLE_ADD_ACCOUNT, 41 SOURCE_DEVICES_PAGE, 42 SOURCE_REAUTH, 43 SOURCE_UNKNOWN, // This must be last. 44 }; 45 46 // Returns true if the sign in promo should be visible. 47 // |profile| is the profile of the tab the promo would be shown on. 48 bool ShouldShowPromo(Profile* profile); 49 50 // Returns true if we should show the sign in promo at startup. 51 bool ShouldShowPromoAtStartup(Profile* profile, bool is_new_profile); 52 53 // Called when the sign in promo has been shown so that we can keep track 54 // of the number of times we've displayed it. 55 void DidShowPromoAtStartup(Profile* profile); 56 57 // Registers the fact that the user has skipped the sign in promo. 58 void SetUserSkippedPromo(Profile* profile); 59 60 // Gets the sign in landing page URL. 61 GURL GetLandingURL(const char* option, int value); 62 63 // Returns the sign in promo URL wth the given arguments in the query. 64 // |source| identifies from where the sign in promo is being called, and is 65 // used to record sync promo UMA stats in the context of the source. 66 // |auto_close| whether to close the sign in promo automatically when done. 67 // |is_constrained} whether to load the URL in a constrained window, false 68 // by default. 69 GURL GetPromoURL(Source source, bool auto_close); 70 GURL GetPromoURL(Source source, bool auto_close, bool is_constrained); 71 72 // As above, but also appends the |continue_url| as a parameter to the URL. 73 // A |continue_url| may be set only when not using the web-based sign-in flow. 74 GURL GetPromoURLWithContinueURL(Source source, 75 bool auto_close, 76 bool is_constrained, 77 GURL continue_url); 78 79 // Returns a sign in promo URL specifically for reauthenticating |account_id|. 80 GURL GetReauthURL(Profile* profile, const std::string& account_id); 81 82 // Gets the next page URL from the query portion of the sign in promo URL. 83 GURL GetNextPageURLForPromoURL(const GURL& url); 84 85 // Gets the source from the query portion of the sign in promo URL. 86 // The source identifies from where the sign in promo was opened. 87 Source GetSourceForPromoURL(const GURL& url); 88 89 // Returns true if the auto_close parameter in the given URL is set to true. 90 bool IsAutoCloseEnabledInURL(const GURL& url); 91 92 // Returns true if the showAccountManagement parameter in the given url is set 93 // to true. 94 bool ShouldShowAccountManagement(const GURL& url); 95 96 // Returns true if the given URL is the standard continue URL used with the 97 // sync promo when the web-based flow is enabled. The query parameters 98 // of the URL are ignored for this comparison. 99 bool IsContinueUrlForWebBasedSigninFlow(const GURL& url); 100 101 // Forces UseWebBasedSigninFlow() to return true when set; used in tests only. 102 void ForceWebBasedSigninFlowForTesting(bool force); 103 104 // Registers the preferences the Sign In Promo needs. 105 void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); 106 107 } // namespace signin 108 109 #endif // CHROME_BROWSER_SIGNIN_SIGNIN_PROMO_H_ 110