chrome/browser/download/download_util.h - platform/external/chromium - Git at Google

 // Copyright (c) 2011 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_
 #pragma once

 #include <string>

 #include "base/basictypes.h"
 #include "base/file_path.h"
 #include "base/string16.h"
 #include "ui/gfx/native_widget_types.h"

 #if defined(TOOLKIT_VIEWS)
 #include "views/view.h"
 #endif

 namespace gfx {
 class Canvas;
 class Image;
 }

 class BaseDownloadItemModel;
 class DictionaryValue;
 class DownloadItem;
 class DownloadManager;
 class GURL;
 class Profile;
 class ResourceDispatcherHost;
 class SkBitmap;

 struct DownloadCreateInfo;
 struct DownloadSaveInfo;

 namespace net {
 class URLRequestContextGetter;
 }

 namespace download_util {

 // Download temporary file creation --------------------------------------------

 // Return the default download directory.
 const FilePath& GetDefaultDownloadDirectory();

 // Create a temporary file for a download in the user's default download
 // directory and return true if was successful in creating the file.
 bool CreateTemporaryFileForDownload(FilePath* path);

 // Return true if the |download_path| is dangerous path.
 bool DownloadPathIsDangerous(const FilePath& download_path);

 // Create an extension based on the file name and mime type.
 void GenerateExtension(const FilePath& file_name,
                        const std::string& mime_type,
                        FilePath::StringType* generated_extension);

 // Create a file name based on the response from the server.
 void GenerateFileNameFromInfo(DownloadCreateInfo* info,
                               FilePath* generated_name);

 // Create a file name based on the response from the server.
 void GenerateFileName(const GURL& url,
                       const std::string& content_disposition,
                       const std::string& referrer_charset,
                       const std::string& mime_type,
                       FilePath* generated_name);

 // Used to make sure we have a safe file extension and filename for a
 // download.  |file_name| can either be just the file name or it can be a
 // full path to a file.
 void GenerateSafeFileName(const std::string& mime_type, FilePath* file_name);

 // Opens downloaded Chrome extension file (*.crx).
 void OpenChromeExtension(Profile* profile,
                          DownloadManager* download_manager,
                          const DownloadItem& download_item);

 // 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 bitmaps.
 int GetBigProgressIconOffset();

 const int kSmallProgressIconOffset =
     (kSmallProgressIconSize - kSmallIconSize) / 2;

 enum PaintDownloadProgressSize {
   SMALL = 0,
   BIG
 };

 // We keep a count of how often various events occur in the
 // histogram "Download.Counts".
 enum DownloadCountTypes {
   // The download was initiated by navigating to a URL (e.g. by user
   // click).
   INITIATED_BY_NAVIGATION_COUNT = 0,

   // The download was initiated by invoking a context menu within a page.
   INITIATED_BY_CONTEXT_MENU_COUNT,

   // The download was initiated when the SavePackage system rejected
   // a Save Page As ... by returning false from
   // SavePackage::IsSaveableContents().
   INITIATED_BY_SAVE_PACKAGE_FAILURE_COUNT,

   // The download was initiated by a drag and drop from a drag-and-drop
   // enabled web application.
   INITIATED_BY_DRAG_N_DROP_COUNT,

   // The download was initiated by explicit RPC from the renderer process
   // (e.g. by Alt-click).
   INITIATED_BY_RENDERER_COUNT,

   // Downloads that made it to DownloadResourceHandler -- all of the
   // above minus those blocked by DownloadThrottlingResourceHandler.
   UNTHROTTLED_COUNT,

   // Downloads that actually complete.
   COMPLETED_COUNT,

   // Downloads that are cancelled before completion (user action or error).
   CANCELLED_COUNT,

   DOWNLOAD_COUNT_TYPES_LAST_ENTRY
 };

 // Increment one of the above counts.
 void RecordDownloadCount(DownloadCountTypes type);

 // 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 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.
 DictionaryValue* CreateDownloadItemValue(DownloadItem* download, int id);

 // Get the localized status text for an in-progress download.
 string16 GetProgressStatusText(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);

 // Appends the passed the number between parenthesis the path before the
 // extension.
 void AppendNumberToPath(FilePath* path, int number);

 // Attempts to find a number that can be appended to that path to make it
 // unique. If |path| does not exist, 0 is returned.  If it fails to find such
 // a number, -1 is returned.
 int GetUniquePathNumber(const FilePath& path);

 // Download the URL. Must be called on the IO thread.
 void DownloadUrl(const GURL& url,
                  const GURL& referrer,
                  const std::string& referrer_charset,
                  const DownloadSaveInfo& save_info,
                  ResourceDispatcherHost* rdh,
                  int render_process_host_id,
                  int render_view_id,
                  net::URLRequestContextGetter* request_context_getter);

 // Tells the resource dispatcher host to cancel a download request.
 // Must be called on the IO thread.
 void CancelDownloadRequest(ResourceDispatcherHost* rdh,
                            int render_process_id,
                            int request_id);

 // Sends a notification on downloads being initiated
 // Must be called on the UI thread.
 void NotifyDownloadInitiated(int render_process_id, int render_view_id);

 // Same as GetUniquePathNumber, except that it also checks the existence
 // of its .crdownload intermediate path.
 // If |path| does not exist, 0 is returned.  If it fails to find such
 // a number, -1 is returned.
 int GetUniquePathNumberWithCrDownload(const FilePath& path);

 // Erases all downloaded files with the specified path and name prefix.
 // Used by download UI tests to clean up the download directory.
 void EraseUniqueDownloadFiles(const FilePath& path_prefix);

 // Returns a .crdownload intermediate path for the |suggested_path|.
 FilePath GetCrDownloadPath(const FilePath& suggested_path);

 // Returns true if this download should show the "dangerous file" warning.
 // Various factors are considered, such as the type of the file, whether a
 // user action initiated the download, and whether the user has explictly
 // marked the file type as "auto open".
 bool IsDangerous(DownloadCreateInfo* info, Profile* profile, bool auto_open);

 }  // namespace download_util

 #endif  // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_UTIL_H_
	// Copyright (c) 2011 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_
	#pragma once

	#include <string>

	#include "base/basictypes.h"
	#include "base/file_path.h"
	#include "base/string16.h"
	#include "ui/gfx/native_widget_types.h"

	#if defined(TOOLKIT_VIEWS)
	#include "views/view.h"
	#endif

	namespace gfx {
	class Canvas;
	class Image;
	}

	class BaseDownloadItemModel;
	class DictionaryValue;
	class DownloadItem;
	class DownloadManager;
	class GURL;
	class Profile;
	class ResourceDispatcherHost;
	class SkBitmap;

	struct DownloadCreateInfo;
	struct DownloadSaveInfo;

	namespace net {
	class URLRequestContextGetter;
	}

	namespace download_util {

	// Download temporary file creation --------------------------------------------

	// Return the default download directory.
	const FilePath& GetDefaultDownloadDirectory();

	// Create a temporary file for a download in the user's default download
	// directory and return true if was successful in creating the file.
	bool CreateTemporaryFileForDownload(FilePath* path);

	// Return true if the \|download_path\| is dangerous path.
	bool DownloadPathIsDangerous(const FilePath& download_path);

	// Create an extension based on the file name and mime type.
	void GenerateExtension(const FilePath& file_name,
	const std::string& mime_type,
	FilePath::StringType* generated_extension);

	// Create a file name based on the response from the server.
	void GenerateFileNameFromInfo(DownloadCreateInfo* info,
	FilePath* generated_name);

	// Create a file name based on the response from the server.
	void GenerateFileName(const GURL& url,
	const std::string& content_disposition,
	const std::string& referrer_charset,
	const std::string& mime_type,
	FilePath* generated_name);

	// Used to make sure we have a safe file extension and filename for a
	// download. \|file_name\| can either be just the file name or it can be a
	// full path to a file.
	void GenerateSafeFileName(const std::string& mime_type, FilePath* file_name);

	// Opens downloaded Chrome extension file (*.crx).
	void OpenChromeExtension(Profile* profile,
	DownloadManager* download_manager,
	const DownloadItem& download_item);

	// 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 bitmaps.
	int GetBigProgressIconOffset();

	const int kSmallProgressIconOffset =
	(kSmallProgressIconSize - kSmallIconSize) / 2;

	enum PaintDownloadProgressSize {
	SMALL = 0,
	BIG
	};

	// We keep a count of how often various events occur in the
	// histogram "Download.Counts".
	enum DownloadCountTypes {
	// The download was initiated by navigating to a URL (e.g. by user
	// click).
	INITIATED_BY_NAVIGATION_COUNT = 0,

	// The download was initiated by invoking a context menu within a page.
	INITIATED_BY_CONTEXT_MENU_COUNT,

	// The download was initiated when the SavePackage system rejected
	// a Save Page As ... by returning false from
	// SavePackage::IsSaveableContents().
	INITIATED_BY_SAVE_PACKAGE_FAILURE_COUNT,

	// The download was initiated by a drag and drop from a drag-and-drop
	// enabled web application.
	INITIATED_BY_DRAG_N_DROP_COUNT,

	// The download was initiated by explicit RPC from the renderer process
	// (e.g. by Alt-click).
	INITIATED_BY_RENDERER_COUNT,

	// Downloads that made it to DownloadResourceHandler -- all of the
	// above minus those blocked by DownloadThrottlingResourceHandler.
	UNTHROTTLED_COUNT,

	// Downloads that actually complete.
	COMPLETED_COUNT,

	// Downloads that are cancelled before completion (user action or error).
	CANCELLED_COUNT,

	DOWNLOAD_COUNT_TYPES_LAST_ENTRY
	};

	// Increment one of the above counts.
	void RecordDownloadCount(DownloadCountTypes type);

	// 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 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.
	DictionaryValue* CreateDownloadItemValue(DownloadItem* download, int id);

	// Get the localized status text for an in-progress download.
	string16 GetProgressStatusText(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);

	// Appends the passed the number between parenthesis the path before the
	// extension.
	void AppendNumberToPath(FilePath* path, int number);

	// Attempts to find a number that can be appended to that path to make it
	// unique. If \|path\| does not exist, 0 is returned. If it fails to find such
	// a number, -1 is returned.
	int GetUniquePathNumber(const FilePath& path);

	// Download the URL. Must be called on the IO thread.
	void DownloadUrl(const GURL& url,
	const GURL& referrer,
	const std::string& referrer_charset,
	const DownloadSaveInfo& save_info,
	ResourceDispatcherHost* rdh,
	int render_process_host_id,
	int render_view_id,
	net::URLRequestContextGetter* request_context_getter);

	// Tells the resource dispatcher host to cancel a download request.
	// Must be called on the IO thread.
	void CancelDownloadRequest(ResourceDispatcherHost* rdh,
	int render_process_id,
	int request_id);

	// Sends a notification on downloads being initiated
	// Must be called on the UI thread.
	void NotifyDownloadInitiated(int render_process_id, int render_view_id);

	// Same as GetUniquePathNumber, except that it also checks the existence
	// of its .crdownload intermediate path.
	// If \|path\| does not exist, 0 is returned. If it fails to find such
	// a number, -1 is returned.
	int GetUniquePathNumberWithCrDownload(const FilePath& path);

	// Erases all downloaded files with the specified path and name prefix.
	// Used by download UI tests to clean up the download directory.
	void EraseUniqueDownloadFiles(const FilePath& path_prefix);

	// Returns a .crdownload intermediate path for the \|suggested_path\|.
	FilePath GetCrDownloadPath(const FilePath& suggested_path);

	// Returns true if this download should show the "dangerous file" warning.
	// Various factors are considered, such as the type of the file, whether a
	// user action initiated the download, and whether the user has explictly
	// marked the file type as "auto open".
	bool IsDangerous(DownloadCreateInfo* info, Profile* profile, bool auto_open);

	} // namespace download_util

	#endif // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_UTIL_H_