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
215
|
// 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 "components/omnibox/browser/suggestion_answer.h"
#include <stddef.h>
#include "base/i18n/rtl.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/values.h"
#include "net/base/escape.h"
#include "url/url_constants.h"
namespace {
// All of these are defined here (even though most are only used once each) so
// the format details are easy to locate and update or compare to the spec doc.
static const char kAnswerJsonLines[] = "l";
static const char kAnswerJsonImageLine[] = "il";
static const char kAnswerJsonText[] = "t";
static const char kAnswerJsonAdditionalText[] = "at";
static const char kAnswerJsonStatusText[] = "st";
static const char kAnswerJsonTextType[] = "tt";
static const char kAnswerJsonImage[] = "i";
static const char kAnswerJsonImageData[] = "i.d";
void AppendWithSpace(const SuggestionAnswer::TextField* text,
base::string16* output) {
if (!text)
return;
if (!output->empty() && !text->text().empty())
*output += ' ';
*output += text->text();
}
} // namespace
// SuggestionAnswer::TextField -------------------------------------------------
SuggestionAnswer::TextField::TextField() : type_(-1) {}
SuggestionAnswer::TextField::~TextField() {}
// static
bool SuggestionAnswer::TextField::ParseTextField(
const base::DictionaryValue* field_json, TextField* text_field) {
bool parsed = field_json->GetString(kAnswerJsonText, &text_field->text_) &&
!text_field->text_.empty() &&
field_json->GetInteger(kAnswerJsonTextType, &text_field->type_);
if (parsed)
text_field->text_ = net::UnescapeForHTML(text_field->text_);
return parsed;
}
bool SuggestionAnswer::TextField::Equals(const TextField& field) const {
return type_ == field.type_ && text_ == field.text_;
}
// SuggestionAnswer::ImageLine -------------------------------------------------
SuggestionAnswer::ImageLine::ImageLine() {}
SuggestionAnswer::ImageLine::ImageLine(const ImageLine& line)
: text_fields_(line.text_fields_),
additional_text_(line.additional_text_ ?
new TextField(*line.additional_text_) : nullptr),
status_text_(line.status_text_ ?
new TextField(*line.status_text_) : nullptr),
image_url_(line.image_url_) {}
SuggestionAnswer::ImageLine::~ImageLine() {}
// static
bool SuggestionAnswer::ImageLine::ParseImageLine(
const base::DictionaryValue* line_json, ImageLine* image_line) {
const base::DictionaryValue* inner_json;
if (!line_json->GetDictionary(kAnswerJsonImageLine, &inner_json))
return false;
const base::ListValue* fields_json;
if (!inner_json->GetList(kAnswerJsonText, &fields_json) ||
fields_json->GetSize() == 0)
return false;
for (size_t i = 0; i < fields_json->GetSize(); ++i) {
const base::DictionaryValue* field_json;
TextField text_field;
if (!fields_json->GetDictionary(i, &field_json) ||
!TextField::ParseTextField(field_json, &text_field))
return false;
image_line->text_fields_.push_back(text_field);
}
if (inner_json->HasKey(kAnswerJsonAdditionalText)) {
image_line->additional_text_.reset(new TextField());
const base::DictionaryValue* field_json;
if (!inner_json->GetDictionary(kAnswerJsonAdditionalText, &field_json) ||
!TextField::ParseTextField(field_json,
image_line->additional_text_.get()))
return false;
}
if (inner_json->HasKey(kAnswerJsonStatusText)) {
image_line->status_text_.reset(new TextField());
const base::DictionaryValue* field_json;
if (!inner_json->GetDictionary(kAnswerJsonStatusText, &field_json) ||
!TextField::ParseTextField(field_json, image_line->status_text_.get()))
return false;
}
if (inner_json->HasKey(kAnswerJsonImage)) {
base::string16 url_string;
if (!inner_json->GetString(kAnswerJsonImageData, &url_string) ||
url_string.empty())
return false;
// If necessary, concatenate scheme and host/path using only ':' as
// separator. This is due to the results delivering strings of the form
// "//host/path", which is web-speak for "use the enclosing page's scheme",
// but not a valid path of an URL. The GWS frontend commonly (always?)
// redirects to HTTPS so we just default to that here.
image_line->image_url_ =
GURL(base::StartsWith(url_string, base::ASCIIToUTF16("//"),
base::CompareCase::SENSITIVE)
? (base::ASCIIToUTF16(url::kHttpsScheme) +
base::ASCIIToUTF16(":") + url_string)
: url_string);
if (!image_line->image_url_.is_valid())
return false;
}
return true;
}
bool SuggestionAnswer::ImageLine::Equals(const ImageLine& line) const {
if (text_fields_.size() != line.text_fields_.size())
return false;
for (size_t i = 0; i < text_fields_.size(); ++i) {
if (!text_fields_[i].Equals(line.text_fields_[i]))
return false;
}
if (additional_text_ || line.additional_text_) {
if (!additional_text_ || !line.additional_text_)
return false;
if (!additional_text_->Equals(*line.additional_text_))
return false;
}
if (status_text_ || line.status_text_) {
if (!status_text_ || !line.status_text_)
return false;
if (!status_text_->Equals(*line.status_text_))
return false;
}
return image_url_ == line.image_url_;
}
// TODO(jdonnelly): When updating the display of answers in RTL languages,
// modify this to be consistent.
base::string16 SuggestionAnswer::ImageLine::AccessibleText() const {
base::string16 result;
for (const TextField& text_field : text_fields_)
AppendWithSpace(&text_field, &result);
AppendWithSpace(additional_text_.get(), &result);
AppendWithSpace(status_text_.get(), &result);
return result;
}
// SuggestionAnswer ------------------------------------------------------------
SuggestionAnswer::SuggestionAnswer() : type_(-1) {}
SuggestionAnswer::SuggestionAnswer(const SuggestionAnswer& answer)
: first_line_(answer.first_line_),
second_line_(answer.second_line_),
type_(answer.type_) {}
SuggestionAnswer::~SuggestionAnswer() {}
// static
scoped_ptr<SuggestionAnswer> SuggestionAnswer::ParseAnswer(
const base::DictionaryValue* answer_json) {
auto result = make_scoped_ptr(new SuggestionAnswer);
const base::ListValue* lines_json;
if (!answer_json->GetList(kAnswerJsonLines, &lines_json) ||
lines_json->GetSize() != 2)
return nullptr;
const base::DictionaryValue* first_line_json;
if (!lines_json->GetDictionary(0, &first_line_json) ||
!ImageLine::ParseImageLine(first_line_json, &result->first_line_))
return nullptr;
const base::DictionaryValue* second_line_json;
if (!lines_json->GetDictionary(1, &second_line_json) ||
!ImageLine::ParseImageLine(second_line_json, &result->second_line_))
return nullptr;
return result;
}
bool SuggestionAnswer::Equals(const SuggestionAnswer& answer) const {
return type_ == answer.type_ &&
first_line_.Equals(answer.first_line_) &&
second_line_.Equals(answer.second_line_);
}
void SuggestionAnswer::AddImageURLsTo(std::vector<GURL>* urls) const {
if (first_line_.image_url().is_valid())
urls->push_back(first_line_.image_url());
if (second_line_.image_url().is_valid())
urls->push_back(second_line_.image_url());
}
|
