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
204
205
206
207
|
// 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.
//
// Download utilities.
#ifndef CHROME_BROWSER_DOWNLOAD_DOWNLOAD_UTIL_H_
#define CHROME_BROWSER_DOWNLOAD_DOWNLOAD_UTIL_H_
#include <string>
#include "base/basictypes.h"
#include "base/file_path.h"
#include "base/memory/ref_counted.h"
#include "base/string16.h"
#include "ui/gfx/native_widget_types.h"
#if defined(TOOLKIT_VIEWS)
#include "ui/views/view.h"
#endif
class GURL;
namespace base {
class DictionaryValue;
}
namespace content {
class DownloadItem;
}
namespace gfx {
class Canvas;
class Image;
}
namespace download_util {
// Download temporary file creation --------------------------------------------
// Return the default download directory.
const FilePath& GetDefaultDownloadDirectory();
// Return true if the |download_path| is dangerous path.
bool DownloadPathIsDangerous(const FilePath& download_path);
// Download progress animations ------------------------------------------------
// Arc sweep angle for use with downloads of unknown size
const int kUnknownAngleDegrees = 50;
// Rate of progress for use with downloads of unknown size
const int kUnknownIncrementDegrees = 12;
// Start angle for downloads with known size (midnight position)
const int kStartAngleDegrees = -90;
// A circle
const int kMaxDegrees = 360;
// Progress animation timer period, in milliseconds.
const int kProgressRateMs = 150;
// XP and Vista must support icons of this size.
const int kSmallIconSize = 16;
const int kBigIconSize = 32;
// Our progress halo around the icon.
int GetBigProgressIconSize();
const int kSmallProgressIconSize = 39;
const int kBigProgressIconSize = 52;
// The offset required to center the icon in the progress images.
int GetBigProgressIconOffset();
const int kSmallProgressIconOffset =
(kSmallProgressIconSize - kSmallIconSize) / 2;
enum PaintDownloadProgressSize {
SMALL = 0,
BIG
};
// Paint the common download animation progress foreground and background,
// clipping the foreground to 'percent' full. If percent is -1, then we don't
// know the total size, so we just draw a rotating segment until we're done.
//
// |containing_view| is the View subclass within which the progress animation
// is drawn (generally either DownloadItemTabView or DownloadItemView). We
// require the containing View in addition to the canvas because if we are
// drawing in a right-to-left locale, we need to mirror the position of the
// progress animation within the containing View.
void PaintDownloadProgress(gfx::Canvas* canvas,
#if defined(TOOLKIT_VIEWS)
views::View* containing_view,
#endif
int origin_x,
int origin_y,
int start_angle,
int percent,
PaintDownloadProgressSize size);
void PaintDownloadComplete(gfx::Canvas* canvas,
#if defined(TOOLKIT_VIEWS)
views::View* containing_view,
#endif
int origin_x,
int origin_y,
double animation_progress,
PaintDownloadProgressSize size);
void PaintDownloadInterrupted(gfx::Canvas* canvas,
#if defined(TOOLKIT_VIEWS)
views::View* containing_view,
#endif
int origin_x,
int origin_y,
double animation_progress,
PaintDownloadProgressSize size);
// Drag support ----------------------------------------------------------------
// Helper function for download views to use when acting as a drag source for a
// DownloadItem. If |icon| is NULL, no image will be accompany the drag. |view|
// is only required for Mac OS X, elsewhere it can be NULL.
void DragDownload(const content::DownloadItem* download,
gfx::Image* icon,
gfx::NativeView view);
// Helpers ---------------------------------------------------------------------
// Creates a representation of a download in a format that the downloads
// HTML page can understand.
base::DictionaryValue* CreateDownloadItemValue(content::DownloadItem* download,
int id);
// Get the localized status text for an in-progress download.
string16 GetProgressStatusText(content::DownloadItem* download);
// Update the application icon to indicate overall download progress.
// |download_count| is the number of downloads currently in progress. If
// |progress_known| is false, then at least one download is of indeterminate
// size and |progress| is invalid, otherwise |progress| indicates the overall
// download progress (float value from 0..1).
void UpdateAppIconDownloadProgress(int download_count,
bool progress_known,
float progress);
// Returns a .crdownload intermediate path for the |suggested_path|.
FilePath GetCrDownloadPath(const FilePath& suggested_path);
// Check whether we can do the saving page operation for the specified URL.
bool IsSavableURL(const GURL& url);
// Record the total number of items and the number of in-progress items showing
// in the shelf when it closes. Set |autoclose| to true when the shelf is
// closing itself, false when the user explicitly closed it.
void RecordShelfClose(int size, int in_progress, bool autoclose);
// Used for counting UMA stats. Similar to content's
// download_stats::DownloadCountTypes but from the chrome layer.
enum ChromeDownloadCountTypes {
// Stale enum values left around os that values passed to UMA don't
// change.
CHROME_DOWNLOAD_COUNT_UNUSED_0 = 0,
CHROME_DOWNLOAD_COUNT_UNUSED_1,
CHROME_DOWNLOAD_COUNT_UNUSED_2,
CHROME_DOWNLOAD_COUNT_UNUSED_3,
// A download *would* have been initiated, but it was blocked
// by the DownloadThrottlingResourceHandler.
BLOCKED_BY_THROTTLING,
CHROME_DOWNLOAD_COUNT_TYPES_LAST_ENTRY
};
// Used for counting UMA stats. Similar to content's
// download_stats::DownloadInitiattionSources but from the chrome layer.
enum ChromeDownloadSource {
// The download was initiated by navigating to a URL (e.g. by user click).
INITIATED_BY_NAVIGATION = 0,
// The download was initiated by invoking a context menu within a page.
INITIATED_BY_CONTEXT_MENU,
// The download was initiated by the WebStore installer.
INITIATED_BY_WEBSTORE_INSTALLER,
// The download was initiated by the ImageBurner (cros).
INITIATED_BY_IMAGE_BURNER,
// The download was initiated by the plugin installer.
INITIATED_BY_PLUGIN_INSTALLER,
CHROME_DOWNLOAD_SOURCE_LAST_ENTRY,
};
// Increment one of the above counts.
void RecordDownloadCount(ChromeDownloadCountTypes type);
// Record initiation of a download from a specific source.
void RecordDownloadSource(ChromeDownloadSource source);
} // namespace download_util
#endif // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_UTIL_H_
|
