download_item_model.h revision 3551c9c881056c480085172ff9840cab31610854
1// Copyright (c) 2012 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_DOWNLOAD_DOWNLOAD_ITEM_MODEL_H_ 6#define CHROME_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_MODEL_H_ 7 8#include <string> 9 10#include "base/basictypes.h" 11#include "base/compiler_specific.h" 12#include "base/strings/string16.h" 13 14class SavePackage; 15 16namespace content { 17class DownloadItem; 18} 19 20namespace gfx { 21class Font; 22} 23 24// This class is an abstraction for common UI tasks and properties associated 25// with a DownloadItem. 26// 27// It is intended to be used as a thin wrapper around a |DownloadItem*|. As 28// such, the caller is expected to ensure that the |download| passed into the 29// constructor outlives this |DownloadItemModel|. In addition, multiple 30// DownloadItemModel objects could be wrapping the same DownloadItem. 31class DownloadItemModel { 32 public: 33 // Constructs a DownloadItemModel. The caller must ensure that |download| 34 // outlives this object. 35 explicit DownloadItemModel(content::DownloadItem* download); 36 ~DownloadItemModel(); 37 38 // Returns a long descriptive string for a download that's in the INTERRUPTED 39 // state. For other downloads, the returned string will be empty. 40 string16 GetInterruptReasonText() const; 41 42 // Returns a short one-line status string for the download. 43 string16 GetStatusText() const; 44 45 // Returns the localized status text for an in-progress download. This 46 // is the progress status used in the WebUI interface. 47 string16 GetTabProgressStatusText() const; 48 49 // Returns a string suitable for use as a tooltip. For a regular download, the 50 // tooltip is the filename. For an interrupted download, the string states the 51 // filename and a short description of the reason for interruption. For 52 // example: 53 // Report.pdf 54 // Network disconnected 55 // |font| and |max_width| are used to elide the filename and/or interrupt 56 // reason as necessary to keep the width of the tooltip text under 57 // |max_width|. The tooltip will be at most 2 lines. 58 string16 GetTooltipText(const gfx::Font& font, int max_width) const; 59 60 // Get the warning text to display for a dangerous download. The |base_width| 61 // is the maximum width of an embedded filename (if there is one). The metrics 62 // for the filename will be based on |font|. Should only be called if 63 // IsDangerous() is true. 64 string16 GetWarningText(const gfx::Font& font, int base_width) const; 65 66 // Get the caption text for a button for confirming a dangerous download 67 // warning. 68 string16 GetWarningConfirmButtonText() const; 69 70 // Get the number of bytes that has completed so far. Virtual for testing. 71 int64 GetCompletedBytes() const; 72 73 // Get the total number of bytes for this download. Should return 0 if the 74 // total size of the download is not known. Virual for testing. 75 int64 GetTotalBytes() const; 76 77 // Rough percent complete. Returns -1 if the progress is unknown. 78 int PercentComplete() const; 79 80 // Is this considered a dangerous download? 81 bool IsDangerous() const; 82 83 // Is this considered a malicious download? Implies IsDangerous(). 84 bool IsMalicious() const; 85 86 // Is safe browsing download feedback feature available for this download? 87 bool ShouldAllowDownloadFeedback() const; 88 89 // Returns |true| if this download is expected to complete successfully and 90 // thereafter be removed from the shelf. Downloads that are opened 91 // automatically or are temporary will be removed from the shelf on successful 92 // completion. 93 // 94 // Returns |false| if the download is not expected to complete (interrupted, 95 // cancelled, dangerous, malicious), or won't be removed on completion. 96 // 97 // Since the expectation of successful completion may change, the return value 98 // of this function will change over the course of a download. 99 bool ShouldRemoveFromShelfWhenComplete() const; 100 101 // Returns |true| if the download started animation (big download arrow 102 // animates down towards the shelf) should be displayed for this download. 103 // Downloads that were initiated via "Save As" or are extension installs don't 104 // show the animation. 105 bool ShouldShowDownloadStartedAnimation() const; 106 107 // Returns |true| if this download should be displayed in the downloads shelf. 108 bool ShouldShowInShelf() const; 109 110 // Change whether the download should be displayed on the downloads 111 // shelf. Setting this is only effective if the download hasn't already been 112 // displayed in the shelf. 113 void SetShouldShowInShelf(bool should_show); 114 115 // Returns |true| if the UI should be notified when the download is ready to 116 // be presented in the UI. By default, this value is |false| and should be 117 // changed explicitly using SetShouldNotifyUI(). Note that this is indpendent 118 // of ShouldShowInShelf() since there might be actions other than showing in 119 // the shelf that the UI must perform. 120 bool ShouldNotifyUI() const; 121 122 // Change what's returned by ShouldNotifyUI(). 123 void SetShouldNotifyUI(bool should_notify); 124 125 content::DownloadItem* download() { return download_; } 126 127 private: 128 // Returns a string representations of the current download progress sizes. If 129 // the total size of the download is known, this string looks like: "100/200 130 // MB" where the numerator is the transferred size and the denominator is the 131 // total size. If the total isn't known, returns the transferred size as a 132 // string (e.g.: "100 MB"). 133 string16 GetProgressSizesString() const; 134 135 // Returns a string indicating the status of an in-progress download. 136 string16 GetInProgressStatusString() const; 137 138 // The DownloadItem that this model represents. Note that DownloadItemModel 139 // itself shouldn't maintain any state since there can be more than one 140 // DownloadItemModel in use with the same DownloadItem. 141 content::DownloadItem* download_; 142 143 DISALLOW_COPY_AND_ASSIGN(DownloadItemModel); 144}; 145 146#endif // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_MODEL_H_ 147