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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_DOWNLOAD_DOWNLOAD_QUERY_H_
#define CHROME_BROWSER_DOWNLOAD_DOWNLOAD_QUERY_H_
#include <stddef.h>
#include <map>
#include <string>
#include <vector>
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "components/download/public/common/download_item.h"
namespace base {
class Value;
}
// Filter and sort a vector of DownloadItem*s.
//
// The following example copies from |all_items| to |results| those
// DownloadItem*s whose start time is 0 and whose id is odd, sorts primarily by
// bytes received ascending and secondarily by url descending, and limits the
// results to 20 items. Any number of filters or sorters is allowed. If all
// sorters compare two DownloadItems equivalently, then they are sorted by their
// id ascending.
//
// DownloadQuery query;
// base::Value start_time(0);
// CHECK(query.AddFilter(FILTER_START_TIME, start_time));
// bool FilterOutOddDownloads(const DownloadItem& item) {
// return 0 == (item.GetId() % 2);
// }
// CHECK(query.AddFilter(base::BindRepeating(&FilterOutOddDownloads)));
// query.AddSorter(SORT_BYTES_RECEIVED, ASCENDING);
// query.AddSorter(SORT_URL, DESCENDING);
// query.Limit(20);
// DownloadVector all_items, results;
// query.Search(all_items.begin(), all_items.end(), &results);
class DownloadQuery {
public:
typedef std::vector<raw_ptr<download::DownloadItem, VectorExperimental>>
DownloadVector;
// FilterCallback is a Callback that takes a DownloadItem and returns true if
// the item matches the filter and false otherwise.
// query.AddFilter(base::BindRepeating(&YourFilterFunction));
typedef base::RepeatingCallback<bool(const download::DownloadItem&)>
FilterCallback;
// All times are ISO 8601 strings.
enum FilterType {
FILTER_BYTES_RECEIVED, // double
FILTER_DANGER_ACCEPTED, // bool
FILTER_ENDED_AFTER, // string
FILTER_ENDED_BEFORE, // string
FILTER_END_TIME, // string
FILTER_EXISTS, // bool
FILTER_FILENAME, // string
FILTER_FILENAME_REGEX, // string
FILTER_MIME, // string
FILTER_PAUSED, // bool
FILTER_QUERY, // vector<std::u16string>
FILTER_STARTED_AFTER, // string
FILTER_STARTED_BEFORE, // string
FILTER_START_TIME, // string
FILTER_TOTAL_BYTES, // double
FILTER_TOTAL_BYTES_GREATER, // double
FILTER_TOTAL_BYTES_LESS, // double
FILTER_ORIGINAL_URL, // string
FILTER_ORIGINAL_URL_REGEX, // string
FILTER_URL, // string
FILTER_URL_REGEX, // string
};
enum SortType {
SORT_BYTES_RECEIVED,
SORT_DANGER,
SORT_DANGER_ACCEPTED,
SORT_END_TIME,
SORT_EXISTS,
SORT_FILENAME,
SORT_MIME,
SORT_PAUSED,
SORT_START_TIME,
SORT_STATE,
SORT_TOTAL_BYTES,
SORT_ORIGINAL_URL,
SORT_URL,
};
enum SortDirection {
ASCENDING,
DESCENDING,
};
static bool MatchesQuery(const std::vector<std::u16string>& query_terms,
const download::DownloadItem& item);
DownloadQuery();
DownloadQuery(const DownloadQuery&) = delete;
DownloadQuery& operator=(const DownloadQuery&) = delete;
~DownloadQuery();
// Adds a new filter of type |type| with value |value| and returns true if
// |type| is valid and |value| is the correct Value-type and well-formed.
// Returns false if |type| is invalid or |value| is the incorrect Value-type
// or malformed. Search() will filter out all DownloadItem*s that do not
// match all filters. Multiple instances of the same FilterType are allowed,
// so you can pass two regexes to AddFilter(URL_REGEX,...) in order to
// Search() for items whose url matches both regexes. You can also pass two
// different DownloadStates to AddFilter(), which will cause Search() to
// filter out all items.
bool AddFilter(const FilterCallback& filter);
bool AddFilter(FilterType type, const base::Value& value);
void AddFilter(download::DownloadDangerType danger);
void AddFilter(download::DownloadItem::DownloadState state);
// Adds a new sorter of type |type| with direction |direction|. After
// filtering DownloadItem*s, Search() will sort the results primarily by the
// sorter from the first call to Sort(), secondarily by the sorter from the
// second call to Sort(), and so on. For example, if the InputIterator passed
// to Search() yields four DownloadItems {id:0, error:0, start_time:0}, {id:1,
// error:0, start_time:1}, {id:2, error:1, start_time:0}, {id:3, error:1,
// start_time:1}, and Sort is called twice, once with (SORT_ERROR, ASCENDING)
// then with (SORT_START_TIME, DESCENDING), then Search() will return items
// ordered 1,0,3,2.
void AddSorter(SortType type, SortDirection direction);
// Limit the size of search results to |limit|.
void Limit(size_t limit) { limit_ = limit; }
// Filters DownloadItem*s from |iter| to |last| into |results|, sorts
// |results|, and limits the size of |results|. |results| must be non-NULL.
template <typename InputIterator>
void Search(InputIterator iter, const InputIterator last,
DownloadVector* results) const {
results->clear();
for (; iter != last; ++iter) {
if (Matches(**iter)) results->push_back(*iter);
}
FinishSearch(results);
}
private:
struct Sorter;
class DownloadComparator;
typedef std::vector<FilterCallback> FilterCallbackVector;
typedef std::vector<Sorter> SorterVector;
bool FilterRegex(
const std::string& regex_str,
const base::RepeatingCallback<std::string(const download::DownloadItem&)>&
accessor);
bool Matches(const download::DownloadItem& item) const;
void FinishSearch(DownloadVector* results) const;
FilterCallbackVector filters_;
SorterVector sorters_;
size_t limit_;
};
#endif // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_QUERY_H_
|
