1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
// Copyright (c) 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 CHROME_BROWSER_EXTENSIONS_WEBSTORE_STANDALONE_INSTALLER_H_
#define CHROME_BROWSER_EXTENSIONS_WEBSTORE_STANDALONE_INSTALLER_H_
#include <string>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "chrome/browser/extensions/extension_install_prompt.h"
#include "chrome/browser/extensions/webstore_data_fetcher_delegate.h"
#include "chrome/browser/extensions/webstore_install_helper.h"
#include "chrome/browser/extensions/webstore_installer.h"
#include "net/url_request/url_fetcher_delegate.h"
#include "third_party/skia/include/core/SkBitmap.h"
class GURL;
namespace base {
class DictionaryValue;
}
namespace net {
class URLFetcher;
}
namespace extensions {
class Extension;
class WebstoreDataFetcher;
// A a purely abstract base for concrete classes implementing various types of
// standalone installs:
// 1) Downloads and parses metadata from the webstore.
// 2) Optionally shows an install dialog.
// 3) Starts download once the user confirms (if confirmation was requested).
// 4) Optionally shows a post-install UI.
// Follows the Template Method pattern. Implementing subclasses must override
// the primitive hooks in the corresponding section below.
class WebstoreStandaloneInstaller
: public base::RefCountedThreadSafe<WebstoreStandaloneInstaller>,
public ExtensionInstallPrompt::Delegate,
public WebstoreDataFetcherDelegate,
public WebstoreInstaller::Delegate,
public WebstoreInstallHelper::Delegate {
public:
// A callback for when the install process completes, successfully or not. If
// there was a failure, |success| will be false and |error| may contain a
// developer-readable error message about why it failed.
typedef base::Callback<void(bool success, const std::string& error)> Callback;
WebstoreStandaloneInstaller(const std::string& webstore_item_id,
Profile* profile,
const Callback& callback);
void BeginInstall();
protected:
virtual ~WebstoreStandaloneInstaller();
void AbortInstall();
void CompleteInstall(const std::string& error);
// Template Method's hooks to be implemented by subclasses.
// Called at certain check points of the workflow to decide whether it makes
// sense to proceed with installation. A requestor can be a website that
// initiated an inline installation, or a command line option.
virtual bool CheckRequestorAlive() const = 0;
// Requestor's URL, if any. Should be an empty GURL if URL is meaningless
// (e.g. for a command line option).
virtual const GURL& GetRequestorURL() const = 0;
// Should a new tab be opened after installation to show the newly installed
// extension's icon?
virtual bool ShouldShowPostInstallUI() const = 0;
// Should pop up an "App installed" bubble after installation?
virtual bool ShouldShowAppInstalledBubble() const = 0;
// In the very least this should return a dummy WebContents (required
// by some calls even when no prompt or other UI is shown). A non-dummy
// WebContents is required if the prompt returned by CreateInstallPromt()
// contains a navigable link(s). Returned WebContents should correspond
// to |profile| passed into the constructor.
virtual content::WebContents* GetWebContents() const = 0;
// Should return an installation prompt with desired properties or NULL if
// no prompt should be shown.
virtual scoped_ptr<ExtensionInstallPrompt::Prompt>
CreateInstallPrompt() const = 0;
// Perform all necessary checks to make sure inline install is permitted,
// e.g. in the extension's properties in the store. The implementation may
// choose to ignore such properties.
virtual bool CheckInlineInstallPermitted(
const base::DictionaryValue& webstore_data,
std::string* error) const = 0;
// Perform all necessary checks to make sure that requestor is allowed to
// initiate this install (e.g. that the requestor's URL matches the verified
// author's site specified in the extension's properties in the store).
virtual bool CheckRequestorPermitted(
const base::DictionaryValue& webstore_data,
std::string* error) const = 0;
// Returns an install UI to be shown. By default, this returns an install UI
// that is a transient child of the host window for GetWebContents().
virtual scoped_ptr<ExtensionInstallPrompt> CreateInstallUI();
// Accessors to be used by subclasses.
bool show_user_count() const { return show_user_count_; }
const std::string& localized_user_count() const {
return localized_user_count_;
}
double average_rating() const { return average_rating_; }
int rating_count() const { return rating_count_; }
private:
friend class base::RefCountedThreadSafe<WebstoreStandaloneInstaller>;
FRIEND_TEST_ALL_PREFIXES(WebstoreStandaloneInstallerTest, DomainVerification);
// Several delegate/client interface implementations follow. The normal flow
// (for successful installs) is:
//
// 1. BeginInstall: starts the fetch of data from the webstore
// 2. OnURLFetchComplete: starts the parsing of data from the webstore
// 3. OnWebstoreResponseParseSuccess: starts the parsing of the manifest and
// fetching of icon data.
// 4. OnWebstoreParseSuccess: shows the install UI
// 5. InstallUIProceed: initiates the .crx download/install
//
// All flows (whether successful or not) end up in CompleteInstall, which
// informs our delegate of success/failure.
// WebstoreDataFetcherDelegate interface implementation.
virtual void OnWebstoreRequestFailure() OVERRIDE;
virtual void OnWebstoreResponseParseSuccess(
base::DictionaryValue* webstore_data) OVERRIDE;
virtual void OnWebstoreResponseParseFailure(
const std::string& error) OVERRIDE;
// WebstoreInstallHelper::Delegate interface implementation.
virtual void OnWebstoreParseSuccess(
const std::string& id,
const SkBitmap& icon,
base::DictionaryValue* parsed_manifest) OVERRIDE;
virtual void OnWebstoreParseFailure(
const std::string& id,
InstallHelperResultCode result_code,
const std::string& error_message) OVERRIDE;
// ExtensionInstallPrompt::Delegate interface implementation.
virtual void InstallUIProceed() OVERRIDE;
virtual void InstallUIAbort(bool user_initiated) OVERRIDE;
// WebstoreInstaller::Delegate interface implementation.
virtual void OnExtensionInstallSuccess(const std::string& id) OVERRIDE;
virtual void OnExtensionInstallFailure(
const std::string& id,
const std::string& error,
WebstoreInstaller::FailureReason reason) OVERRIDE;
void ShowInstallUI();
// Input configuration.
std::string id_;
Callback callback_;
Profile* profile_;
// Installation dialog and its underlying prompt.
scoped_ptr<ExtensionInstallPrompt> install_ui_;
scoped_ptr<ExtensionInstallPrompt::Prompt> install_prompt_;
// For fetching webstore JSON data.
scoped_ptr<WebstoreDataFetcher> webstore_data_fetcher_;
// Extracted from the webstore JSON data response.
std::string localized_name_;
std::string localized_description_;
bool show_user_count_;
std::string localized_user_count_;
double average_rating_;
int rating_count_;
scoped_ptr<DictionaryValue> webstore_data_;
scoped_ptr<DictionaryValue> manifest_;
SkBitmap icon_;
// Created by ShowInstallUI() when a prompt is shown (if
// the implementor returns a non-NULL in CreateInstallPrompt()).
scoped_refptr<Extension> localized_extension_for_display_;
DISALLOW_IMPLICIT_CONSTRUCTORS(WebstoreStandaloneInstaller);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_WEBSTORE_STANDALONE_INSTALLER_H_
|
