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
|
// 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 CONTENT_BROWSER_DOWNLOAD_BASE_FILE_H_
#define CONTENT_BROWSER_DOWNLOAD_BASE_FILE_H_
#pragma once
#include <string>
#include "base/file_path.h"
#include "base/gtest_prod_util.h"
#include "base/memory/linked_ptr.h"
#include "base/memory/scoped_ptr.h"
#include "base/time.h"
#include "content/browser/power_save_blocker.h"
#include "content/common/content_export.h"
#include "googleurl/src/gurl.h"
#include "net/base/file_stream.h"
#include "net/base/net_errors.h"
#include "net/base/net_log.h"
namespace crypto {
class SecureHash;
}
namespace net {
class FileStream;
}
// File being downloaded and saved to disk. This is a base class
// for DownloadFile and SaveFile, which keep more state information.
class CONTENT_EXPORT BaseFile {
public:
BaseFile(const FilePath& full_path,
const GURL& source_url,
const GURL& referrer_url,
int64 received_bytes,
bool calculate_hash,
const std::string& hash_state,
const linked_ptr<net::FileStream>& file_stream,
const net::BoundNetLog& bound_net_log);
virtual ~BaseFile();
// Returns net::OK on success, or a network error code on failure.
net::Error Initialize();
// Write a new chunk of data to the file.
// Returns net::OK on success (all bytes written to the file),
// or a network error code on failure.
net::Error AppendDataToFile(const char* data, size_t data_len);
// Rename the download file.
// Returns net::OK on success, or a network error code on failure.
virtual net::Error Rename(const FilePath& full_path);
// Detach the file so it is not deleted on destruction.
virtual void Detach();
// Abort the download and automatically close the file.
void Cancel();
// Indicate that the download has finished. No new data will be received.
void Finish();
// Informs the OS that this file came from the internet.
void AnnotateWithSourceInformation();
// Calculate and return the current speed in bytes per second.
int64 CurrentSpeed() const;
FilePath full_path() const { return full_path_; }
bool in_progress() const { return file_stream_ != NULL; }
int64 bytes_so_far() const { return bytes_so_far_; }
// Fills |hash| with the hash digest for the file.
// Returns true if digest is successfully calculated.
virtual bool GetHash(std::string* hash);
// Returns the current (intermediate) state of the hash as a byte string.
virtual std::string GetHashState();
// Returns true if the given hash is considered empty. An empty hash is
// a string of size kSha256HashLen that contains only zeros (initial value
// for the hash).
static bool IsEmptyHash(const std::string& hash);
virtual std::string DebugString() const;
protected:
virtual void CreateFileStream(); // For testing.
// Returns net::OK on success, or a network error code on failure.
net::Error Open();
void Close();
// Full path to the file including the file name.
FilePath full_path_;
private:
friend class BaseFileTest;
FRIEND_TEST_ALL_PREFIXES(BaseFileTest, IsEmptyHash);
// Split out from CurrentSpeed to enable testing.
int64 CurrentSpeedAtTime(base::TimeTicks current_time) const;
// Resets the current state of the hash to the contents of |hash_state_bytes|.
virtual bool SetHashState(const std::string& hash_state_bytes);
net::Error ClearStream(net::Error error);
static const size_t kSha256HashLen = 32;
static const unsigned char kEmptySha256Hash[kSha256HashLen];
// Source URL for the file being downloaded.
GURL source_url_;
// The URL where the download was initiated.
GURL referrer_url_;
// OS file stream for writing
linked_ptr<net::FileStream> file_stream_;
// Amount of data received up so far, in bytes.
int64 bytes_so_far_;
// Start time for calculating speed.
base::TimeTicks start_tick_;
// RAII handle to keep the system from sleeping while we're downloading.
PowerSaveBlocker power_save_blocker_;
// Indicates if hash should be calculated for the file.
bool calculate_hash_;
// Used to calculate hash for the file when calculate_hash_
// is set.
scoped_ptr<crypto::SecureHash> secure_hash_;
unsigned char sha256_hash_[kSha256HashLen];
// Indicates that this class no longer owns the associated file, and so
// won't delete it on destruction.
bool detached_;
net::BoundNetLog bound_net_log_;
DISALLOW_COPY_AND_ASSIGN(BaseFile);
};
#endif // CONTENT_BROWSER_DOWNLOAD_BASE_FILE_H_
|
