-
Notifications
You must be signed in to change notification settings - Fork 33
/
SeriesInfoExtractorServiceImpl.java
427 lines (342 loc) · 14 KB
/
SeriesInfoExtractorServiceImpl.java
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/*
* Copyright (C) 2009-2018 Slava Semushin <slava.semushin@gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package ru.mystamps.web.service;
import java.math.BigDecimal;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import java.util.stream.Stream;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.springframework.transaction.annotation.Transactional;
import lombok.RequiredArgsConstructor;
import ru.mystamps.web.dao.dto.Currency;
import ru.mystamps.web.service.dto.RawParsedDataDto;
import ru.mystamps.web.service.dto.SeriesExtractedInfo;
import ru.mystamps.web.validation.ValidationRules;
@RequiredArgsConstructor
@SuppressWarnings({ "PMD.TooManyMethods", "PMD.GodClass" })
public class SeriesInfoExtractorServiceImpl implements SeriesInfoExtractorService {
// Related to RELEASE_YEAR_REGEXP and used in unit tests.
protected static final int MAX_SUPPORTED_RELEASE_YEAR = 2099;
// Regular expression matches release year of the stamps (from 1840 till 2099).
private static final Pattern RELEASE_YEAR_REGEXP =
Pattern.compile("(18[4-9][0-9]|19[0-9]{2}|20[0-9]{2})г?");
// Regular expression matches number of the stamps in a series (from 1 to 99).
private static final Pattern NUMBER_OF_STAMPS_REGEXP = Pattern.compile(
"([1-9][0-9]?)( (беззубцовые|зубцовых))? (мар(ок|ки)|блоков)",
Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE
);
// Regular expression matches range of Michel catalog numbers (from 1 to 9999).
private static final Pattern MICHEL_NUMBERS_REGEXP =
Pattern.compile("#[ ]?([1-9][0-9]{0,3})-([1-9][0-9]{0,3})");
// CheckStyle: ignore LineLength for next 4 lines
private static final Pattern VALID_CATEGORY_NAME_EN = Pattern.compile(ValidationRules.CATEGORY_NAME_EN_REGEXP);
private static final Pattern VALID_CATEGORY_NAME_RU = Pattern.compile(ValidationRules.CATEGORY_NAME_RU_REGEXP);
private static final Pattern VALID_COUNTRY_NAME_EN = Pattern.compile(ValidationRules.COUNTRY_NAME_EN_REGEXP);
private static final Pattern VALID_COUNTRY_NAME_RU = Pattern.compile(ValidationRules.COUNTRY_NAME_RU_REGEXP);
// Max number of candidates that will be used in the SQL query within IN() statement.
private static final long MAX_CANDIDATES_FOR_LOOKUP = 50;
private final Logger log;
private final CategoryService categoryService;
private final CountryService countryService;
private final TransactionParticipantService transactionParticipantService;
// @todo #803 SeriesInfoExtractorServiceImpl.extract(): add unit tests
@Override
@Transactional(readOnly = true)
public SeriesExtractedInfo extract(RawParsedDataDto data) {
List<Integer> categoryIds = extractCategory(data.getCategoryName());
List<Integer> countryIds = extractCountry(data.getCountryName());
Integer releaseYear = extractReleaseYear(data.getReleaseYear());
Integer quantity = extractQuantity(data.getQuantity());
Boolean perforated = extractPerforated(data.getPerforated());
Set<String> michelNumbers = extractMichelNumbers(data.getMichelNumbers());
Integer sellerId = extractSeller(data.getSellerName(), data.getSellerUrl());
Integer sellerGroupId = extractSellerGroup(sellerId, data.getSellerUrl());
String sellerName = extractSellerName(sellerId, data.getSellerName());
String sellerUrl = extractSellerUrl(sellerId, data.getSellerUrl());
BigDecimal price = extractPrice(data.getPrice());
String currency = extractCurrency(data.getCurrency());
return new SeriesExtractedInfo(
categoryIds,
countryIds,
releaseYear,
quantity,
perforated,
michelNumbers,
sellerId,
sellerGroupId,
sellerName,
sellerUrl,
price,
currency
);
}
// CheckStyle: ignore LineLength for next 1 line
// @todo #821 SeriesInfoExtractorServiceImpl.extractCategory(): add unit tests for filtering invalid names
protected List<Integer> extractCategory(String fragment) {
if (StringUtils.isBlank(fragment)) {
return Collections.emptyList();
}
log.debug("Determining category from a fragment: '{}'", fragment);
String[] names = StringUtils.split(fragment, "\n\t ,.");
List<String> candidates = Arrays.stream(names)
.filter(SeriesInfoExtractorServiceImpl::validCategoryName)
.distinct()
.limit(MAX_CANDIDATES_FOR_LOOKUP)
.collect(Collectors.toList());
log.debug("Possible candidates: {}", candidates);
List<Integer> categories = categoryService.findIdsByNames(candidates);
log.debug("Found categories: {}", categories);
if (!categories.isEmpty()) {
return categories;
}
for (String candidate : candidates) {
log.debug("Possible candidate: '{}%'", candidate);
categories = categoryService.findIdsWhenNameStartsWith(candidate);
if (!categories.isEmpty()) {
log.debug("Found categories: {}", categories);
return categories;
}
}
log.debug("Could not extract category from a fragment");
return Collections.emptyList();
}
// CheckStyle: ignore LineLength for next 1 line
// @todo #821 SeriesInfoExtractorServiceImpl.extractCountry(): add unit tests for filtering invalid names
protected List<Integer> extractCountry(String fragment) {
if (StringUtils.isBlank(fragment)) {
return Collections.emptyList();
}
log.debug("Determining country from a fragment: '{}'", fragment);
String[] words = StringUtils.split(fragment, "\n\t ,.");
Stream<String> names = Arrays.stream(words);
// Generate more candidates by split their names by a hyphen.
// For example: "Minerals-Maldives" becomes [ "Minerals", "Maldives" ]
Stream<String> additionalNames = Arrays.stream(words)
.filter(el -> el.contains("-"))
.map(el -> StringUtils.split(el, '-'))
.flatMap(Arrays::stream);
List<String> candidates = Stream.concat(names, additionalNames)
.filter(SeriesInfoExtractorServiceImpl::validCountryName)
.distinct()
.limit(MAX_CANDIDATES_FOR_LOOKUP)
.collect(Collectors.toList());
log.debug("Possible candidates: {}", candidates);
List<Integer> countries = countryService.findIdsByNames(candidates);
log.debug("Found countries: {}", countries);
if (!countries.isEmpty()) {
return countries;
}
for (String candidate : candidates) {
log.debug("Possible candidate: '{}%'", candidate);
countries = countryService.findIdsWhenNameStartsWith(candidate);
if (!countries.isEmpty()) {
log.debug("Found countries: {}", countries);
return countries;
}
}
log.debug("Could not extract country from a fragment");
return Collections.emptyList();
}
protected Integer extractReleaseYear(String fragment) {
if (StringUtils.isBlank(fragment)) {
return null;
}
log.debug("Determining release year from a fragment: '{}'", fragment);
String[] candidates = StringUtils.split(fragment);
for (String candidate : candidates) {
Matcher matcher = RELEASE_YEAR_REGEXP.matcher(candidate);
if (!matcher.matches()) {
continue;
}
try {
Integer year = Integer.valueOf(matcher.group(1));
log.debug("Release year is {}", year);
return year;
} catch (NumberFormatException ignored) { // NOPMD: EmptyCatchBlock
// continue with the next element
}
}
log.debug("Could not extract release year from a fragment");
return null;
}
// @todo #781 SeriesInfoExtractorServiceImpl.extractQuantity() respect MAX_STAMPS_IN_SERIES
protected Integer extractQuantity(String fragment) {
if (StringUtils.isBlank(fragment)) {
return null;
}
log.debug("Determining quantity from a fragment: '{}'", fragment);
Matcher matcher = NUMBER_OF_STAMPS_REGEXP.matcher(fragment);
if (matcher.find()) {
String quantity = matcher.group(1);
log.debug("Quantity is {}", quantity);
return Integer.valueOf(quantity);
}
log.debug("Could not extract quantity from a fragment");
return null;
}
// @todo #782 Series import: add integration test for extracting perforation flag
protected Boolean extractPerforated(String fragment) {
if (StringUtils.isBlank(fragment)) {
return null;
}
log.debug("Determining perforation from a fragment: '{}'", fragment);
boolean withoutPerforation = StringUtils.containsIgnoreCase(fragment, "б/з")
|| StringUtils.containsIgnoreCase(fragment, "беззубцовые");
if (withoutPerforation) {
log.debug("Perforation is false");
return Boolean.FALSE;
}
log.debug("Could not extract perforation info from a fragment");
return null;
}
// @todo #694 SeriesInfoExtractorServiceImpl: support for a single Michel number
// @todo #694 SeriesInfoExtractorServiceImpl: support for a comma separated Michel numbers
protected Set<String> extractMichelNumbers(String fragment) {
if (StringUtils.isBlank(fragment)) {
return Collections.emptySet();
}
log.debug("Determining michel numbers from a fragment: '{}'", fragment);
Matcher matcher = MICHEL_NUMBERS_REGEXP.matcher(fragment);
if (matcher.find()) {
Integer begin = Integer.valueOf(matcher.group(1));
Integer end = Integer.valueOf(matcher.group(2));
if (begin < end) {
Set<String> numbers = IntStream.rangeClosed(begin, end)
.mapToObj(String::valueOf)
.collect(Collectors.toCollection(LinkedHashSet::new));
log.debug("Extracted michel numbers: {}", numbers);
return numbers;
}
}
log.debug("Could not extract michel numbers from a fragment");
return Collections.emptySet();
}
public Integer extractSeller(String name, String url) {
if (StringUtils.isBlank(name) || StringUtils.isBlank(url)) {
return null;
}
// @todo #695 SeriesInfoExtractorServiceImpl.extractSeller(): validate name/url (length etc)
log.debug("Determining seller by name '{}' and url '{}'", name, url);
Integer sellerId = transactionParticipantService.findSellerId(name, url);
if (sellerId != null) {
log.debug("Found seller: #{}", sellerId);
return sellerId;
}
log.debug("Could not extract seller based on name/url");
return null;
}
// @todo #857 SeriesInfoExtractorServiceImpl.extractSellerGroup(): add unit tests
public Integer extractSellerGroup(Integer id, String sellerUrl) {
// we need a group ony for a new seller (id == null)
if (id != null) {
return null;
}
log.debug("Determining seller group by seller url '{}'", sellerUrl);
try {
String name = new URL(sellerUrl).getHost();
log.debug("Determining seller group: looking for a group named '{}'", name);
Integer groupId = transactionParticipantService.findGroupIdByName(name);
if (groupId != null) {
log.debug("Found seller group: #{}", groupId);
}
return groupId;
} catch (MalformedURLException ex) {
log.debug("Could not extract seller group: {}", ex.getMessage());
return null;
}
}
// @todo #695 SeriesInfoExtractorServiceImpl.extractSellerName(): add unit tests
protected String extractSellerName(Integer id, String name) {
if (id != null) {
return null;
}
// @todo #695 SeriesInfoExtractorServiceImpl.extractSellerName(): filter out short names
// @todo #695 SeriesInfoExtractorServiceImpl.extractSellerName(): filter out long names
// we need a name ony if we couldn't find a seller in database (id == null)
return name;
}
// @todo #695 SeriesInfoExtractorServiceImpl.extractSellerUrl(): add unit tests
protected String extractSellerUrl(Integer id, String url) {
if (id != null) {
return null;
}
// @todo #695 SeriesInfoExtractorServiceImpl.extractSellerUrl(): filter out non-urls
// @todo #695 SeriesInfoExtractorServiceImpl.extractSellerUrl(): filter out too long urls
// we need a url ony if we couldn't find a seller in database (id == null)
return url;
}
public BigDecimal extractPrice(String fragment) {
if (StringUtils.isBlank(fragment)) {
return null;
}
log.debug("Determining price from a fragment: '{}'", fragment);
try {
BigDecimal price = new BigDecimal(fragment);
log.debug("Price is {}", price);
// @todo #695 SeriesInfoExtractorServiceImpl.extractPrice(): filter out values <= 0
return price;
} catch (NumberFormatException ex) {
log.debug("Could not extract price: {}", ex.getMessage());
return null;
}
}
public String extractCurrency(String fragment) {
if (StringUtils.isBlank(fragment)) {
return null;
}
log.debug("Determining currency from a fragment: '{}'", fragment);
try {
Currency currency = Enum.valueOf(Currency.class, fragment);
log.debug("Currency is {}", currency);
return currency.toString();
} catch (IllegalArgumentException ex) {
log.debug("Could not extract currency: {}", ex.getMessage());
return null;
}
}
private static boolean validCategoryName(String name) {
if (name.length() < ValidationRules.CATEGORY_NAME_MIN_LENGTH) {
return false;
}
if (name.length() > ValidationRules.CATEGORY_NAME_MAX_LENGTH) {
return false;
}
return VALID_CATEGORY_NAME_EN.matcher(name).matches()
|| VALID_CATEGORY_NAME_RU.matcher(name).matches();
}
private static boolean validCountryName(String name) {
if (name.length() < ValidationRules.COUNTRY_NAME_MIN_LENGTH) {
return false;
}
if (name.length() > ValidationRules.COUNTRY_NAME_MAX_LENGTH) {
return false;
}
return VALID_COUNTRY_NAME_EN.matcher(name).matches()
|| VALID_COUNTRY_NAME_RU.matcher(name).matches();
}
}