aswi2022code-of-duty-gitlab/backend/src/main/java/cz/zcu/kiv/backendapi/catalog/CatalogItemServiceImpl.java @ 1c921b68

package cz.zcu.kiv.backendapi.catalog;

import cz.zcu.kiv.backendapi.alternativename.AlternativeName;
import cz.zcu.kiv.backendapi.bibliography.Bibliography;
import cz.zcu.kiv.backendapi.country.Country;
import cz.zcu.kiv.backendapi.exception.ApiRequestException;
import cz.zcu.kiv.backendapi.path.PathDto;
import cz.zcu.kiv.backendapi.type.ITypeService;
import cz.zcu.kiv.backendapi.type.Type;
import cz.zcu.kiv.backendapi.writtenform.WrittenForm;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.UUID;
import java.util.function.Predicate;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

/**
 * Catalog item service implementation
 */
@Service
@Transactional
@RequiredArgsConstructor
@Slf4j
public class CatalogItemServiceImpl implements ICatalogItemService {
    /**
     * Regex for one arbitrary character in string
     */
    private static final String WILDCARD_CHARACTER_REGEX = "\\?";

    /**
     * Regex for one arbitrary character in string used in Java
     */
    private static final String WILDCARD_CHARACTER_REGEX_JAVA = ".";

    /**
     * Regex for any number of arbitrary characters in string
     */
    private static final String WILDCARD_CHARACTERS_REGEX = "\\*";

    /**
     * Regex for any number of arbitrary characters in string used in Java
     */
    private static final String WILDCARD_CHARACTERS_REGEX_JAVA = ".*";

    /**
     * Regex for finding punctuation at the start of word
     */
    private static final String START_PUNCTUATION_REGEX = "^[\\p{Punct}\\p{IsPunctuation}]+";

    /**
     * Regex for finding punctuation at the end of word
     */
    private static final String END_PUNCTUATION_REGEX = "[\\p{Punct}\\p{IsPunctuation}]+$";

    /**
     * Pattern for finding punctuation at the start of word
     */
    private static final Pattern START_PUNCTUATION_PATTERN = Pattern.compile(START_PUNCTUATION_REGEX);

    /**
     * Pattern for finding punctuation at the end of word
     */
    private static final Pattern END_PUNCTUATION_PATTERN = Pattern.compile(END_PUNCTUATION_REGEX);

    /**
     * Message for exception when catalog item is not found by id
     */
    private static final String CATALOG_ITEM_NOT_FOUND = "Catalog item not found";


    /**
     * Catalog repository
     */
    private final CatalogItemRepository catalogItemRepository;

    /**
     * Type service
     */
    private final ITypeService typeService;

    @Override
    public void saveCatalog(List<CatalogItem> catalogItems) {
        log.info("Saving catalog");
        catalogItems.forEach(this::saveCatalogEntity);
    }

    @Override
    public void saveCatalogItem(CatalogItemDto catalogItemDto) {
        log.info("Saving catalog item");
        CatalogItem catalogItem = new CatalogItem();
        convertDtoToEntity(catalogItemDto, catalogItem);
        saveCatalogEntity(catalogItem);
    }

    @Override
    public void updateCatalogItem(UUID id, CatalogItemDto catalogItemDto) {
        CatalogItem catalogItem = catalogItemRepository.findById(id).orElseThrow(() -> {
            log.error(CATALOG_ITEM_NOT_FOUND);
            throw new ApiRequestException(CATALOG_ITEM_NOT_FOUND, HttpStatus.NOT_FOUND);
        });
        convertDtoToEntity(catalogItemDto, catalogItem);
        saveCatalogEntity(catalogItem);
        log.info("Catalog item updated");
    }

    @Override
    public void deleteCatalogItem(UUID id) {
        if (!catalogItemRepository.existsById(id)) {
            log.error(CATALOG_ITEM_NOT_FOUND);
            throw new ApiRequestException(CATALOG_ITEM_NOT_FOUND, HttpStatus.NOT_FOUND);
        }
        catalogItemRepository.deleteById(id);
        log.info("Catalog item deleted");
    }

    @Override
    public CatalogItemDto getCatalogItem(UUID id) {
        CatalogItem catalogItem = catalogItemRepository.findById(id).orElseThrow(() -> {
            log.error(CATALOG_ITEM_NOT_FOUND);
            throw new ApiRequestException(CATALOG_ITEM_NOT_FOUND, HttpStatus.NOT_FOUND);
        });

        return convertEntityToDto(catalogItem);
    }

    @Override
    public PathDto getPath(String text) {
        PathDto pathDto = new PathDto();
        StringBuilder highlightedText = new StringBuilder();
        List<List<CatalogItemDto>> foundCatalogItems = new ArrayList<>();

        Set<String> types = typeService.getAllTypesAsString();

        String[] tokens = text.split("\\s+");
        for (String token : tokens) {
            Matcher matcherStart = START_PUNCTUATION_PATTERN.matcher(token);
            Matcher matcherEnd = END_PUNCTUATION_PATTERN.matcher(token);
            String prefix = "";
            String suffix = "";
            String textToFind;
            int startTextIndex = 0;
            int endTextIndex = token.length();

            if (matcherStart.find()) {
                int start = matcherStart.start();
                startTextIndex = matcherStart.end();
                prefix = token.substring(start, startTextIndex);
            }
            if (matcherEnd.find()) {
                endTextIndex = matcherEnd.start();
                int end = matcherEnd.end();
                suffix = token.substring(endTextIndex, end);
            }

            if (endTextIndex < startTextIndex) {
                highlightedText.append(prefix).append(" ");
                continue;
            }

            textToFind = token.substring(startTextIndex, endTextIndex);

            if (types.contains(textToFind)) {
                textToFind = "<b>" + textToFind + "</b>";
            } else {
                List<CatalogItem> foundItems = catalogItemRepository.getItemsByName(textToFind);
                if (!foundItems.isEmpty()) {
                    if (foundItems.stream().anyMatch(c -> c.getLatitude() != null && c.getLongitude() != null)) {
                        textToFind = "<span style='color:green'>" + textToFind + "</span>";
                    } else {
                        textToFind = "<span style='color:red'>" + textToFind + "</span>";
                    }
                    foundCatalogItems.add(foundItems.stream().map(this::convertEntityToDto).collect(Collectors.toList()));
                }
            }
            highlightedText.append(prefix).append(textToFind).append(suffix).append(" ");
        }
        highlightedText.setLength(highlightedText.length() - 1);

        pathDto.setText(highlightedText.toString());
        pathDto.setFoundCatalogItems(foundCatalogItems);
        return pathDto;
    }

    @Override
    public List<CatalogItemDto> getCatalog(String name, String country, String type, String writtenForm) {
        log.info("Retrieving catalog");
        String finalName = name.replaceAll(WILDCARD_CHARACTER_REGEX, WILDCARD_CHARACTER_REGEX_JAVA).replaceAll(WILDCARD_CHARACTERS_REGEX, WILDCARD_CHARACTERS_REGEX_JAVA);
        String finalCountry = country.replaceAll(WILDCARD_CHARACTER_REGEX, WILDCARD_CHARACTER_REGEX_JAVA).replaceAll(WILDCARD_CHARACTERS_REGEX, WILDCARD_CHARACTERS_REGEX_JAVA);
        String finalType = type.replaceAll(WILDCARD_CHARACTER_REGEX, WILDCARD_CHARACTER_REGEX_JAVA).replaceAll(WILDCARD_CHARACTERS_REGEX, WILDCARD_CHARACTERS_REGEX_JAVA);
        String finalWrittenForm = writtenForm.replaceAll(WILDCARD_CHARACTER_REGEX, WILDCARD_CHARACTER_REGEX_JAVA).replaceAll(WILDCARD_CHARACTERS_REGEX, WILDCARD_CHARACTERS_REGEX_JAVA);

        Pattern patternName = Pattern.compile(finalName, Pattern.CASE_INSENSITIVE);
        Pattern patternCountry = Pattern.compile(finalCountry, Pattern.CASE_INSENSITIVE);
        Pattern patternType = Pattern.compile(finalType, Pattern.CASE_INSENSITIVE);
        Pattern patternWrittenForm = Pattern.compile(finalWrittenForm, Pattern.CASE_INSENSITIVE);

        List<CatalogItem> catalogItems = catalogItemRepository.findAll();

        Predicate<CatalogItem> predicateType = i -> finalType.equals("") || i.getTypes().stream().anyMatch(t -> patternType.matcher(t.getType()).matches());
        Predicate<CatalogItem> predicateCountry = i -> finalCountry.equals("") || i.getCountries().stream().anyMatch(t -> patternCountry.matcher(t.getName()).matches());
        Predicate<CatalogItem> predicateName = i -> finalName.equals("") || patternName.matcher(i.getName()).matches() || i.getAlternativeNames().stream().anyMatch(t -> patternName.matcher(t.getName()).matches());
        Predicate<CatalogItem> predicateWrittenForm = i -> finalWrittenForm.equals("") || i.getWrittenForms().stream().anyMatch(t -> patternWrittenForm.matcher(t.getForm()).matches());

        catalogItems = catalogItems.stream().filter(predicateName.and(predicateCountry).and(predicateType).and(predicateWrittenForm)).collect(Collectors.toList());
        return catalogItems.stream().map(this::convertEntityToDto).collect(Collectors.toList());
    }

    /**
     * Saves catalog entity to database
     *
     * @param catalogItem catalog entity
     */
    private void saveCatalogEntity(CatalogItem catalogItem) {
        for (Type type : catalogItem.getTypes()) {
            if (typeService.getTypeByName(type.getType()).isEmpty()) {
                typeService.saveType(type);
            }
        }
        catalogItemRepository.save(catalogItem);
    }

    /**
     * Converts catalog item DTO to catalog item entity
     *
     * @param catalogItemDto catalog item DTO
     * @param catalogItem    catalog item entity
     */
    private void convertDtoToEntity(CatalogItemDto catalogItemDto, CatalogItem catalogItem) {
        catalogItem.setName(catalogItemDto.getName());
        catalogItem.setCertainty(catalogItemDto.getCertainty());
        catalogItem.setLatitude(catalogItemDto.getLatitude());
        catalogItem.setLongitude(catalogItemDto.getLongitude());

        catalogItem.getBibliography().clear();
        catalogItem.getBibliography().addAll(catalogItemDto.getBibliography()
                .stream().map(s -> new Bibliography(s, catalogItem)).collect(Collectors.toSet()));

        catalogItem.getTypes().clear();
        catalogItem.getTypes().addAll(catalogItemDto.getTypes()
                .stream().map(Type::new).collect(Collectors.toSet()));

        catalogItem.getCountries().clear();
        catalogItem.getCountries().addAll(catalogItemDto.getCountries()
                .stream().map(s -> new Country(s, catalogItem)).collect(Collectors.toSet()));

        catalogItemDto.getAlternativeNames().add(catalogItemDto.getName());
        catalogItem.getAlternativeNames().clear();
        catalogItem.getAlternativeNames().addAll(catalogItemDto.getAlternativeNames()
                .stream().map(s -> new AlternativeName(s, catalogItem)).collect(Collectors.toSet()));

        catalogItem.getWrittenForms().clear();
        catalogItem.getWrittenForms().addAll(catalogItemDto.getWrittenForms()
                .stream().map(s -> new WrittenForm(s, catalogItem)).collect(Collectors.toSet()));

        catalogItem.setDescription(catalogItemDto.getDescription());
    }

    /**
     * Converts catalog item entity to catalog item DTO
     *
     * @param catalogItem catalog item entity
     * @return catalog item DTO
     */
    private CatalogItemDto convertEntityToDto(CatalogItem catalogItem) {
        CatalogItemDto catalogItemDto = new CatalogItemDto();
        catalogItemDto.setId(catalogItem.getId());
        catalogItemDto.setName(catalogItem.getName());
        catalogItemDto.setLatitude(catalogItem.getLatitude());
        catalogItemDto.setLongitude(catalogItem.getLongitude());
        catalogItemDto.setCertainty(catalogItem.getCertainty());
        catalogItemDto.setBibliography(catalogItem.getBibliography()
                .stream().map(Bibliography::getSource).collect(Collectors.toSet()));
        catalogItemDto.setTypes(catalogItem.getTypes()
                .stream().map(Type::getType).collect(Collectors.toSet()));
        catalogItemDto.setCountries(catalogItem.getCountries()
                .stream().map(Country::getName).collect(Collectors.toSet()));
        catalogItemDto.setAlternativeNames(catalogItem.getAlternativeNames()
                .stream().map(AlternativeName::getName).collect(Collectors.toSet()));
        catalogItemDto.setWrittenForms(catalogItem.getWrittenForms()
                .stream().map(WrittenForm::getForm).collect(Collectors.toSet()));
        catalogItemDto.setDescription(catalogItem.getDescription());
        return catalogItemDto;
    }

}