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
208
209
210
211
212
213
214
|
// Copyright 2014 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.
#include "feedback_common.h"
#include "base/strings/string_util.h"
#include "components/feedback/proto/common.pb.h"
#include "components/feedback/proto/dom.pb.h"
#include "components/feedback/proto/extension.pb.h"
#include "components/feedback/proto/math.pb.h"
namespace {
const char kMultilineIndicatorString[] = "<multiline>\n";
const char kMultilineStartString[] = "---------- START ----------\n";
const char kMultilineEndString[] = "---------- END ----------\n\n";
const size_t kFeedbackMaxLength = 4 * 1024;
const size_t kFeedbackMaxLineCount = 40;
const base::FilePath::CharType kLogsFilename[] =
FILE_PATH_LITERAL("system_logs.txt");
const char kLogsAttachmentName[] = "system_logs.zip";
const char kZipExt[] = ".zip";
const char kPngMimeType[] = "image/png";
const char kArbitraryMimeType[] = "application/octet-stream";
// Converts the system logs into a string that we can compress and send
// with the report. This method only converts those logs that we want in
// the compressed zip file sent with the report, hence it ignores any logs
// below the size threshold of what we want compressed.
std::string* LogsToString(const FeedbackCommon::SystemLogsMap& sys_info) {
std::string* syslogs_string = new std::string;
for (FeedbackCommon::SystemLogsMap::const_iterator it = sys_info.begin();
it != sys_info.end();
++it) {
std::string key = it->first;
std::string value = it->second;
if (FeedbackCommon::BelowCompressionThreshold(value))
continue;
base::TrimString(key, "\n ", &key);
base::TrimString(value, "\n ", &value);
if (value.find("\n") != std::string::npos) {
syslogs_string->append(key + "=" + kMultilineIndicatorString +
kMultilineStartString + value + "\n" +
kMultilineEndString);
} else {
syslogs_string->append(key + "=" + value + "\n");
}
}
return syslogs_string;
}
void AddFeedbackData(userfeedback::ExtensionSubmit* feedback_data,
const std::string& key,
const std::string& value) {
// Don't bother with empty keys or values.
if (key.empty() || value.empty())
return;
// Create log_value object and add it to the web_data object.
userfeedback::ProductSpecificData log_value;
log_value.set_key(key);
log_value.set_value(value);
userfeedback::WebData* web_data = feedback_data->mutable_web_data();
*(web_data->add_product_specific_data()) = log_value;
}
// Adds data as an attachment to feedback_data if the data is non-empty.
void AddAttachment(userfeedback::ExtensionSubmit* feedback_data,
const char* name,
const std::string& data) {
if (data.empty())
return;
userfeedback::ProductSpecificBinaryData* attachment =
feedback_data->add_product_specific_binary_data();
attachment->set_mime_type(kArbitraryMimeType);
attachment->set_name(name);
attachment->set_data(data);
}
} // namespace
FeedbackCommon::AttachedFile::AttachedFile(const std::string& filename,
scoped_ptr<std::string> data)
: name(filename), data(data.Pass()) {}
FeedbackCommon::AttachedFile::~AttachedFile() {}
FeedbackCommon::FeedbackCommon() : product_id_(0) {}
FeedbackCommon::~FeedbackCommon() {}
// static
bool FeedbackCommon::BelowCompressionThreshold(const std::string& content) {
if (content.length() > kFeedbackMaxLength)
return false;
const size_t line_count = std::count(content.begin(), content.end(), '\n');
if (line_count > kFeedbackMaxLineCount)
return false;
return true;
}
void FeedbackCommon::CompressFile(const base::FilePath& filename,
const std::string& zipname,
scoped_ptr<std::string> data) {
AttachedFile* file = new AttachedFile(
zipname, scoped_ptr<std::string>(new std::string()));
if (file->name.empty()) {
// We need to use the UTF8Unsafe methods here to accomodate Windows, which
// uses wide strings to store filepaths.
file->name = filename.BaseName().AsUTF8Unsafe();
file->name.append(kZipExt);
}
if (feedback_util::ZipString(filename, *(data.get()), file->data.get())) {
base::AutoLock lock(attachments_lock_);
attachments_.push_back(file);
} else {
delete file;
}
}
void FeedbackCommon::AddFile(const std::string& filename,
scoped_ptr<std::string> data) {
base::AutoLock lock(attachments_lock_);
attachments_.push_back(new AttachedFile(filename, data.Pass()));
}
void FeedbackCommon::AddLog(const std::string& name, const std::string& value) {
if (!logs_.get())
logs_ = scoped_ptr<SystemLogsMap>(new SystemLogsMap);
(*logs_.get())[name] = value;
}
void FeedbackCommon::AddLogs(scoped_ptr<SystemLogsMap> logs) {
if (logs_) {
logs_->insert(logs->begin(), logs->end());
} else {
logs_ = logs.Pass();
}
}
void FeedbackCommon::CompressLogs() {
if (!logs_)
return;
std::string* logs = LogsToString(*logs_.get());
if (!logs->empty())
CompressFile(
base::FilePath(kLogsFilename), kLogsAttachmentName,
scoped_ptr<std::string>(logs));
}
void FeedbackCommon::AddFilesAndLogsToReport(
userfeedback::ExtensionSubmit* feedback_data) const {
if (sys_info()) {
for (FeedbackCommon::SystemLogsMap::const_iterator i = sys_info()->begin();
i != sys_info()->end();
++i) {
if (BelowCompressionThreshold(i->second))
AddFeedbackData(feedback_data, i->first, i->second);
}
}
for (size_t i = 0; i < attachments(); i++) {
const AttachedFile* file = attachment(i);
AddAttachment(feedback_data, file->name.c_str(), *file->data.get());
}
}
void FeedbackCommon::PrepareReport(
userfeedback::ExtensionSubmit* feedback_data) const {
// Unused field, needs to be 0 though.
feedback_data->set_type_id(0);
feedback_data->set_product_id(product_id_);
userfeedback::CommonData* common_data = feedback_data->mutable_common_data();
// We're not using gaia ids, we're using the e-mail field instead.
common_data->set_gaia_id(0);
common_data->set_user_email(user_email());
common_data->set_description(description());
common_data->set_source_description_language(locale());
userfeedback::WebData* web_data = feedback_data->mutable_web_data();
web_data->set_url(page_url());
web_data->mutable_navigator()->set_user_agent(user_agent());
AddFilesAndLogsToReport(feedback_data);
if (image() && image()->size()) {
userfeedback::PostedScreenshot screenshot;
screenshot.set_mime_type(kPngMimeType);
// Set that we 'have' dimensions of the screenshot. These dimensions are
// ignored by the server but are a 'required' field in the protobuf.
userfeedback::Dimensions dimensions;
dimensions.set_width(0.0);
dimensions.set_height(0.0);
*(screenshot.mutable_dimensions()) = dimensions;
screenshot.set_binary_content(*image());
*(feedback_data->mutable_screenshot()) = screenshot;
}
if (category_tag().size())
feedback_data->set_bucket(category_tag());
}
|
