-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathquery.go
More file actions
320 lines (276 loc) · 7.78 KB
/
query.go
File metadata and controls
320 lines (276 loc) · 7.78 KB
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
package goarxiv
import (
"fmt"
"net/url"
"strconv"
"strings"
"time"
)
// SortBy enumerates supported sort keys.
type SortBy string
const (
SortByRelevance SortBy = "relevance"
SortByLastUpdatedDate SortBy = "lastUpdatedDate"
SortBySubmittedDate SortBy = "submittedDate"
)
// SortOrder enumerates valid ordering options.
type SortOrder string
const (
SortOrderAscending SortOrder = "ascending"
SortOrderDescending SortOrder = "descending"
)
// Query represents a fluent builder for arXiv query parameters.
type Query struct {
searchTerms []string
ids []string
start int
maxResults int
sortBy SortBy
sortOrder SortOrder
}
// NewQuery creates a Query with sane defaults.
func NewQuery() *Query {
return &Query{
maxResults: 25,
sortBy: SortByRelevance,
sortOrder: SortOrderDescending,
}
}
// Search adds a raw search clause.
func (q *Query) Search(clause string) *Query {
if clause != "" {
q.searchTerms = append(q.searchTerms, clause)
}
return q
}
// Where attaches the result of a QueryBuilder to this query.
func (q *Query) Where(builder *QueryBuilder) *Query {
if builder == nil {
return q
}
if clause := builder.Build(); clause != "" {
q.searchTerms = append(q.searchTerms, clause)
}
return q
}
// IDs filters the query to explicit identifiers.
func (q *Query) IDs(ids ...string) *Query {
q.ids = append(q.ids, ids...)
return q
}
// Start sets the pagination offset.
func (q *Query) Start(start int) *Query {
if start >= 0 {
q.start = start
}
return q
}
// MaxResults caps the number of results returned.
func (q *Query) MaxResults(limit int) *Query {
if limit > 0 {
if limit > 2000 {
limit = 2000
}
q.maxResults = limit
}
return q
}
// Sort configures sorting behavior.
func (q *Query) Sort(by SortBy, order SortOrder) *Query {
if by != "" {
q.sortBy = by
}
if order != "" {
q.sortOrder = order
}
return q
}
// Encode builds the query parameters expected by the API.
func (q *Query) Encode() url.Values {
params := url.Values{}
if len(q.searchTerms) > 0 {
params.Set("search_query", strings.Join(q.searchTerms, "+AND+"))
}
if len(q.ids) > 0 {
params.Set("id_list", strings.Join(q.ids, ","))
}
params.Set("start", strconv.Itoa(q.start))
params.Set("max_results", strconv.Itoa(q.maxResults))
params.Set("sortBy", string(q.sortBy))
params.Set("sortOrder", string(q.sortOrder))
return params
}
// QueryBuilder provides a fluent API for constructing search_query strings with field prefixes.
type QueryBuilder struct {
segments []string
categories []string
dateFilters []dateFilter
}
type dateFilter struct {
start time.Time
end time.Time
hasStart bool
hasEnd bool
}
// NewQueryBuilder constructs a builder with no clauses.
func NewQueryBuilder() *QueryBuilder {
return &QueryBuilder{segments: make([]string, 0, 4)}
}
// Title searches within the title field (ti: prefix).
func (b *QueryBuilder) Title(text string) *QueryBuilder {
return b.addFieldClause("ti", text, false)
}
// TitleExact searches for an exact phrase within the title.
func (b *QueryBuilder) TitleExact(text string) *QueryBuilder {
return b.addFieldClause("ti", text, true)
}
// Author searches within the author field (au: prefix).
func (b *QueryBuilder) Author(name string) *QueryBuilder {
return b.addFieldClause("au", name, false)
}
// Abstract searches within the abstract field (abs: prefix).
func (b *QueryBuilder) Abstract(text string) *QueryBuilder {
return b.addFieldClause("abs", text, false)
}
// Category filters results by arXiv subject category (cat: prefix).
func (b *QueryBuilder) Category(code string) *QueryBuilder {
code = strings.TrimSpace(code)
if code == "" {
return b
}
b.categories = append(b.categories, code)
return b.addFieldClause("cat", code, false)
}
// AllFields performs a generic search across title, abstract, and comments (all: prefix).
func (b *QueryBuilder) AllFields(text string) *QueryBuilder {
return b.addFieldClause("all", text, false)
}
// Comment searches within the comments field (co: prefix).
func (b *QueryBuilder) Comment(text string) *QueryBuilder {
return b.addFieldClause("co", text, false)
}
// JournalRef searches within the journal reference field (jr: prefix).
func (b *QueryBuilder) JournalRef(ref string) *QueryBuilder {
return b.addFieldClause("jr", ref, false)
}
// ReportNumber searches within the report number field (rn: prefix).
func (b *QueryBuilder) ReportNumber(rn string) *QueryBuilder {
return b.addFieldClause("rn", rn, false)
}
// And inserts a logical AND between clauses.
func (b *QueryBuilder) And() *QueryBuilder {
return b.addOperator("AND")
}
// Or inserts a logical OR between clauses.
func (b *QueryBuilder) Or() *QueryBuilder {
return b.addOperator("OR")
}
// AndNot inserts a logical AND NOT between clauses.
func (b *QueryBuilder) AndNot() *QueryBuilder {
return b.addOperator("ANDNOT")
}
// Raw appends a literal clause, useful for advanced filters.
func (b *QueryBuilder) Raw(clause string) *QueryBuilder {
clause = strings.TrimSpace(clause)
if clause == "" {
return b
}
b.segments = append(b.segments, clause)
return b
}
// Build returns the final query string (already URL-safe).
func (b *QueryBuilder) Build() string {
return strings.Join(b.segments, "+")
}
// HasClauses reports whether the builder contains any query clauses.
func (b *QueryBuilder) HasClauses() bool {
return len(b.segments) > 0
}
// addFieldClause appends a field-scoped clause.
func (b *QueryBuilder) addFieldClause(prefix, value string, exact bool) *QueryBuilder {
value = strings.TrimSpace(value)
if value == "" {
return b
}
clause := prefix + ":" + encodeQueryValue(value, exact)
b.segments = append(b.segments, clause)
return b
}
func (b *QueryBuilder) addOperator(op string) *QueryBuilder {
if len(b.segments) == 0 {
return b
}
b.segments = append(b.segments, op)
return b
}
var queryEscaper = strings.NewReplacer(
" ", "+",
"\"", "%22",
"(", "%28",
")", "%29",
)
func encodeQueryValue(value string, exact bool) string {
encoded := queryEscaper.Replace(value)
if exact {
return "%22" + encoded + "%22"
}
return encoded
}
// SubmittedBetween restricts submissions to a specific time window.
func (b *QueryBuilder) SubmittedBetween(start, end time.Time) *QueryBuilder {
if start.IsZero() || end.IsZero() {
return b
}
clause := "submittedDate:[" + formatArxivDate(start) + "+TO+" + formatArxivDate(end) + "]"
b.dateFilters = append(b.dateFilters, dateFilter{
start: start,
end: end,
hasStart: true,
hasEnd: true,
})
return b.Raw(clause)
}
// SubmittedAfter restricts submissions to those after the provided time.
func (b *QueryBuilder) SubmittedAfter(t time.Time) *QueryBuilder {
if t.IsZero() {
return b
}
clause := "submittedDate:[" + formatArxivDate(t) + "+TO+*)"
b.dateFilters = append(b.dateFilters, dateFilter{
start: t,
hasStart: true,
})
return b.Raw(clause)
}
// SubmittedBefore restricts submissions to those before the provided time.
func (b *QueryBuilder) SubmittedBefore(t time.Time) *QueryBuilder {
if t.IsZero() {
return b
}
clause := "submittedDate:[*+TO+" + formatArxivDate(t) + "]"
b.dateFilters = append(b.dateFilters, dateFilter{
end: t,
hasEnd: true,
})
return b.Raw(clause)
}
func formatArxivDate(t time.Time) string {
return t.UTC().Format("200601021504")
}
// Validate checks for empty queries, invalid categories, and malformed date ranges.
func (b *QueryBuilder) Validate() error {
if b == nil || len(b.segments) == 0 {
return fmt.Errorf("goarxiv: query builder has no clauses")
}
for _, cat := range b.categories {
if !IsValidCategory(cat) {
return fmt.Errorf("goarxiv: invalid category %q", cat)
}
}
for _, df := range b.dateFilters {
if df.hasStart && df.hasEnd && df.end.Before(df.start) {
return fmt.Errorf("goarxiv: submitted date range start %s is after end %s", df.start, df.end)
}
}
return nil
}